{-# LANGUAGE CPP, RankNTypes, ScopedTypeVariables, Trustworthy #-}
{- |
Module : GHC.Internal.TH.Quote
Description : Quasi-quoting support for Template Haskell

Template Haskell supports quasiquoting, which permits users to construct
program fragments by directly writing concrete syntax.  A quasiquoter is
essentially a function with takes a string to a Template Haskell AST.
This module defines the 'QuasiQuoter' datatype, which specifies a
quasiquoter @q@ which can be invoked using the syntax
@[q| ... string to parse ... |]@ when the @QuasiQuotes@ language
extension is enabled, and some utility functions for manipulating
quasiquoters.  Nota bene: this package does not define any parsers,
that is up to you.

This is an internal module. Please import 'Language.Haskell.TH.Quote' instead.
-}
module GHC.Internal.TH.Quote(
        QuasiQuoter(..),
    ) where

import GHC.Internal.TH.Syntax
import GHC.Internal.Base hiding (Type)


-- | The 'QuasiQuoter' type, a value @q@ of this type can be used
-- in the syntax @[q| ... string to parse ...|]@.  In fact, for
-- convenience, a 'QuasiQuoter' actually defines multiple quasiquoters
-- to be used in different splice contexts. In the usual case of a
-- @QuasiQuoter@ that is only intended to be used in certain splice
-- contexts, the unused fields should just 'fail'. This is most easily
-- accomplished using 'namedefaultQuasiQuoter' or 'defaultQuasiQuoter'.
data QuasiQuoter = QuasiQuoter {
    -- | Quasi-quoter for expressions, invoked by quotes like @lhs = $[q|...]@
    QuasiQuoter -> String -> Q Exp
quoteExp  :: String -> Q Exp,
    -- | Quasi-quoter for patterns, invoked by quotes like @f $[q|...] = rhs@
    QuasiQuoter -> String -> Q Pat
quotePat  :: String -> Q Pat,
    -- | Quasi-quoter for types, invoked by quotes like @f :: $[q|...]@
    QuasiQuoter -> String -> Q Type
quoteType :: String -> Q Type,
    -- | Quasi-quoter for declarations, invoked by top-level quotes
    QuasiQuoter -> String -> Q [Dec]
quoteDec  :: String -> Q [Dec]
    }