Template Haskellには以下に述べる新しい構文要素がある。これらの構文的拡張を有効にするにはフラグ-XTemplateHaskellを使う必要がある。(-XTemplateHaskellは、-fglasgow-extsを使っていても、もはや自動的に有効にならない)

Template Haskellはどのモード(--make、--interactive、ファイル毎)でも動作する。過去には前者二つについて制限があったが、これは撤廃された。

自信障壁(confidence barrier)を乗り越えるために、以下の、枠組を理解してもらうための例を試してみてほしい。まず、下の二つのモジュールを「Main.hs」と「Printf.hs」とにコピペする。

{- Main.hs -}
module Main where

-- 後で定義する「pr」というテンプレートをインポートする。
import Printf ( pr )

-- 接合演算子$は、prによってコンパイル時に生成された
-- Haskellのソースコードをとり、これをputStrLnの引数とし
-- て接合する。
main = putStrLn ( $(pr "Hello") )


{- Printf.hs -}
module Printf where

-- printfの枠組。論文より。
-- 使うモジュールとは別の場所で定義されていなければなら
-- ない。

-- Template Haskellの構文をインポートする
import Language.Haskell.TH

-- 書式文字列を記述する
data Format = D | S | L String

-- 書式文字列をパースする。ここでの目的は我々の最初の
-- Template Haskellのプログラムを組み上げることであり、
-- printfを組むことではないので、大部分未実装のまま残し
-- てある。
parse :: String -> [Format]
parse s   = [ L s ]

-- パースされた書式文字列の表現からHaskellのソースコー
-- ドを生成する。生成されたコードは、「pr」を呼んだモジ
-- ュールにコンパイル時に接合される。
gen :: [Format] -> Q Exp
gen [D]   = [| \n -> show n |]
gen [S]   = [| \s -> s |]
gen [L s] = stringE s

-- 入力の書式文字列から、接合するHaskellコードを生成する。
pr :: String -> Q Exp
pr s = gen (parse s)

次にコンパイラを走らせる。(これはWindows上のCygwinプロンプトである)

$ ghc --make -XTemplateHaskell main.hs -o main.exe

「main.exe」を走らせれば出力が得られる。

$ ./main
Hello

Template Haskellは、接合する式を走らせるのに、GHCの組込みのバイトコードコンパイラと解釈実行器に依存している。バイトコードの解釈実行器は、コンパイルされた式を実行する際、GHC自身が土台としているのと同じランタイムを使う。従って、解釈される式から参照されるコンパイル済みコードは、このランタイムと互換性がなければならない。特に、プロファイルのためにコンパイルされたオブジェクトコードを接合式からロードして実行することはできない。プロファイル版のオブジェクトコードはプロファイル版のランタイムとしか互換性がないからである。

Template Haskellのコードを含む、複数のモジュールからなるプログラムがあって、それをプロファイル用にコンパイルする必要があるとき、このことが問題になる。接合を実行するときにプロファイル用オブジェクトコードをロードして用いることができないからである。幸運にも、GHCは回避策を提供している。基本的な考え方は、プログラムを二回コンパイルするというものである。

準クォートは、パターンおよび式をプログラマが定義した具象構文を使って書くことを可能にする。この拡張の背後にある動機といくつかの例が"Why It's Nice to be Quoted: Quasiquoting for Haskell" (Proc Haskell Workshop 2007)に述べられている。以下の例では、単純な式言語のための準クォータをどうやって書くかを紹介する。

目立つ特徴を挙げる。

下の例は、準クォートを実際に使っているところを示すものである。クォート子exprは、Exprモジュールで定義されており、QuasiQuoter型の値に束縛されている。この例では、'int:nという構文を使って、変数nを逆クォートしたものを表している(逆クォートにこの構文を使うことはこのパーサの作者が決めたことであり、GHCによって決められたことではない)。パターン照合の際、これはnを構築子IntExprの整数引数に束縛する。逆クォートに関する更なる詳細については参照した論文を見てほしい。この論文にはString -> aという型の単一のパーサを活用して、Q Exp型の値を返す式パーサと、Q Pat型の値を返すパターンパーサの両方を生成するためのSYBを使ったテクニックの説明もある。

準クォータはTemplate Haskellと同じステージ制限に従わねばならない。たとえば、この例においてexprはMain.hsで使われているので、そこで定義されることはできず、インポートされねばならない。

{- ------------- Main.hsというファイル --------------- -}
module Main where

import Expr

main :: IO ()
main = do { print $ eval [expr|1 + 2|]
          ; case IntExpr 1 of
              { [expr|'int:n|] -> print n
              ;  _              -> return ()
              }
          }


{- ------------- Expr.hsというファイル --------------- -}
module Expr where

import qualified Language.Haskell.TH as TH
import Language.Haskell.TH.Quote

data Expr  =  IntExpr Integer
           |  AntiIntExpr String
           |  BinopExpr BinOp Expr Expr
           |  AntiExpr String
    deriving(Show, Typeable, Data)

data BinOp  =  AddOp
            |  SubOp
            |  MulOp
            |  DivOp
    deriving(Show, Typeable, Data)

eval :: Expr -> Integer
eval (IntExpr n)        = n
eval (BinopExpr op x y) = (opToFun op) (eval x) (eval y)
  where
    opToFun AddOp = (+)
    opToFun SubOp = (-)
    opToFun MulOp = (*)
    opToFun DivOp = div

expr = QuasiQuoter { quoteExp = parseExprExp, quotePat =  parseExprPat }

-- Exprをパースし、その表現をQ ExpまたはQ Patとして返す。
-- SYBを使うことによって、二つのパーサを別々に書くことなく
-- 一つのString -> Exprという型のパーサを書くだけで済ます
-- 方法については、参照先の論文を見よ。

parseExprExp :: String -> Q Exp
parseExprExp ...

parseExprPat :: String -> Q Pat
parseExprPat ...

ではコンパイラを走らせよう。

$ ghc --make -XQuasiQuotes Main.hs -o main

"main"を走らせれば次のような出力になる。

$ ./main
3
1