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


-- | Tree representations of datatypes
--   
--   <tt>type-tree</tt> provides TH splices for generating tree
--   representations of the types contained in datatypes. This is useful
--   for, for example, generating class instances for a deeply nested
--   datatype.
@package type-tree
@version 0.2.0.0

module Language.Haskell.TypeTree.ExampleDatatypes
data CondTree v c a
CondNode :: a -> c -> [CondBranch v c a] -> CondTree v c a
[condTreeData] :: CondTree v c a -> a
[condTreeConstraints] :: CondTree v c a -> c
[condTreeComponents] :: CondTree v c a -> [CondBranch v c a]
data CondBranch v c a
CondBranch :: Condition v -> CondTree v c a -> Maybe (CondTree v c a) -> CondBranch v c a
[condBranchCondition] :: CondBranch v c a -> Condition v
[condBranchIfTrue] :: CondBranch v c a -> CondTree v c a
[condBranchIfFalse] :: CondBranch v c a -> Maybe (CondTree v c a)
data Condition c
Var :: c -> Condition c
Lit :: Bool -> Condition c
CAnd :: (Condition c) -> (Condition c) -> Condition c

module Language.Haskell.TypeTree
data ReifyOpts
ReifyOpts :: Set Name -> Bool -> Bool -> ReifyOpts

-- | If a name in this set is encountered, stop recursing.
[stop] :: ReifyOpts -> Set Name

-- | Expand primitive type constructors (i.e. <a>Int</a> → <a>Int#</a>)?
[prim] :: ReifyOpts -> Bool

-- | If <a>True</a>, type synonyms are present in the resulting
--   <a>Forest</a>; if <a>False</a>, a synonym will be expanded and its RHS
--   will appear in the out-list instead.
[synonyms] :: ReifyOpts -> Bool

-- | <pre>
--   defaultOpts = ReifyOpts
--     { stop = S.fromList []
--     , prim = False
--     , synonyms = False
--     }
--   </pre>
defaultOpts :: ReifyOpts

-- | Build a <a>Forest</a> of constructor names contained in the given
--   type.
ttReifyOpts :: IsDatatype a => ReifyOpts -> a -> Q (Forest Leaf)

-- | <a>ttReifyOpts</a> with default options.
ttReify :: IsDatatype a => a -> Q (Forest Leaf)

-- | Embed the produced <a>Forest</a> as an expression.
ttLitOpts :: IsDatatype a => ReifyOpts -> a -> ExpQ

-- | <a>ttLitOpts</a> with default options.
ttLit :: IsDatatype a => a -> ExpQ

-- | Produce a string representation of the forest generated by
--   <tt>$(ttReifyOpts opts ''SomeName)</tt>. Useful for debugging
--   purposes.
ttDescribeOpts :: IsDatatype a => ReifyOpts -> a -> ExpQ

-- | <a>ttDescribeOpts</a> with default options.
ttDescribe :: IsDatatype a => a -> ExpQ

-- | <a>ttConnCompOpts</a> is useful for the usecase which I had in mind
--   when I originally wrote this package, namely:
--   
--   <i>Given some datatype, I need a topologically sorted list of all
--   types contained in that datatype for which an instance of some class
--   must be defined if I wish to define an instance for that datatype (and
--   likewise for each subtype, etc.)</i>
--   
--   Here's an example using <a>CondTree</a>, which is a useful datatype
--   for an example, as it's both mutually recursive and refers to other
--   recursive types.
--   
--   <pre>
--   &gt;&gt;&gt; :m +Language.Haskell.TypeTree.ExampleDatatypes
--   
--   &gt;&gt;&gt; mapM_ print $(ttConnComp ''CondTree)
--   AcyclicSCC ([] :: * -&gt; *,[])
--   AcyclicSCC (Bool :: *,[])
--   AcyclicSCC (Condition :: * -&gt; *,[Bool :: *])
--   AcyclicSCC (Maybe :: * -&gt; *,[])
--   CyclicSCC [(CondBranch :: * -&gt; * -&gt; * -&gt; *,[Condition :: * -&gt; *,CondTree :: * -&gt; * -&gt; * -&gt; *,Maybe :: * -&gt; *]),(CondTree :: * -&gt; * -&gt; * -&gt; *,[[] :: * -&gt; *,CondBranch :: * -&gt; * -&gt; * -&gt; *])]
--   </pre>
ttConnCompOpts :: IsDatatype a => ReifyOpts -> a -> ExpQ

-- | <a>ttConnCompOpts</a> with default opts
ttConnComp :: IsDatatype a => a -> ExpQ
data Leaf

-- | <tt>TypeL name arr</tt> represents the type constructor <tt>name</tt>,
--   which has arity <tt>arr</tt>.
TypeL :: Name -> Arity -> Leaf

-- | Recursive field.
Recursive :: Leaf -> Leaf
class IsDatatype a

-- | Produce a list of constructor names
asDatatype :: IsDatatype a => a -> Q [Name]