-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Generates Matchable instances using TemplateHaskell
--   
--   This package provides TemplateHaskell function to generate instances
--   of <tt>Matchable</tt> and <tt>Bimatchable</tt> type classes, which are
--   from "matchable" package.
@package matchable-th
@version 0.2

module Data.Matchable.TH

-- | This function transforms multiple instance declarations written in
--   <tt>StandaloneDeriving</tt> format to instances derived by
--   TemplateHaskell.
--   
--   <h4>Example</h4>
--   
--   <pre>
--   {-# LANGUAGE DeriveFunctor #-}
--   {-# LANGUAGE StandaloneDeriving #-}
--   [-# LANGUAGE TemplateHaskell #-}
--   data Foo a b = Foo a b (Either a b)
--      deriving (Show, Eq, Functor)
--   
--   </pre>
--   
--   To use <a>deriveInstances</a> for <tt>Foo</tt>, write as below:
--   
--   <pre>
--   deriveInstances [d|
--     deriving instance Eq a =&gt; Eq1 (Foo a)
--     deriving instance Eq a =&gt; Matchable (Foo a)
--     deriving instance Eq2 Foo
--     deriving instance Bifunctor Foo
--     deriving instance Bimatchable Foo
--     |]
--   
--   </pre>
deriveInstances :: Q [Dec] -> Q [Dec]

-- | Build an instance of <a>Matchable</a> for a data type.
--   
--   <i>e.g.</i>
--   
--   <pre>
--   data Exp a = Plus a a | Times a a
--   <a>deriveMatchable</a> ''Exp
--   </pre>
--   
--   will create
--   
--   <pre>
--   instance Matchable Exp where
--     zipMatchWith f (Plus  l1 l2) (Plus  r1 r2) = pure Plus  <a>*</a> f l1 r1 <a>*</a> f l2 r2
--     zipMatchWith f (Times l1 l2) (Times r1 r2) = pure Times <a>*</a> f l1 r1 <a>*</a> f l2 r2
--     zipMatchWith _ _ _ = Nothing
--   </pre>
deriveMatchable :: Name -> Q [Dec]
makeZipMatchWith :: Name -> ExpQ

-- | Build an instance of <a>Bimatchable</a> for a data type.
--   
--   <i>e.g.</i>
--   
--   <pre>
--   data Sum a b = InL a | InR b
--   <a>deriveMatchable</a> ''Sum
--   </pre>
--   
--   will create
--   
--   <pre>
--   instance Matchable Sum where
--     bizipMatchWith f _ (InL l1) (InL r1) = pure InL <a>$</a> f l1 r1
--     bizipMatchWith _ g (InR l1) (InR r1) = pure InR <a>$</a> g l1 r1
--   </pre>
deriveBimatchable :: Name -> Q [Dec]
makeBizipMatchWith :: Name -> ExpQ
makeLiftEq :: Name -> Q Exp
makeLiftEq2 :: Name -> Q Exp