Pinchot.SyntaxTree.Instancer

Documentation

bifunctorInstances :: Seq (Rule t) -> DecsQ

Creates an instance of Bifunctor for every Rule in the Seq as well as their ancestors.

This function must be spliced in the same module as the module in which the syntax tree types are created. This avoids problems with orphan instances. Since ancestors are included, you can get the entire tree of instances that you need by applying this function to a single start symbol.

Example: Pinchot.Examples.SyntaxTrees.

semigroupInstances :: Seq (Rule t) -> DecsQ

Where possible, creates an instance of Semigroup for every Rule in the Seq as well as their ancestors. Only star and plus rules, as well as rules that through one or more layers of wrap ultimately wrap a star or plus rule, get a Semigroup instance.

This function must be spliced in the same module as the module in which the syntax tree types are created. This avoids problems with orphan instances. Since ancestors are included, you can get the entire tree of instances that you need by applying this function to a single start symbol.

Example: Pinchot.Examples.SyntaxTrees.

monoidInstances :: Seq (Rule t) -> DecsQ

Where possible, creates an instance of Monoid for every Rule in the Seq as well as their ancestors. Only star rules, as well as rules that through one or more layers of wrap ultimately wrap a star rule, get a Monoid instance.

This function must be spliced in the same module as the module in which the syntax tree types are created. This avoids problems with orphan instances. Since ancestors are included, you can get the entire tree of instances that you need by applying this function to a single start symbol.

Example: Pinchot.Examples.SyntaxTrees.

bimapExpression :: Qualifier -> Rule t -> ExpQ

bimapLetBinds

Arguments

:: Qualifier

-> Name

(a -> b)

-> Name

(c -> d)

-> Map RuleName Name

Looks up names for other let binds

-> Rule t

-> Q [DecQ]

bimapLetBind

Arguments

:: Qualifier

-> Name

(a -> b)

-> Name

(c -> d)

-> Map RuleName Name

-> Rule t

-> Q DecQ

terminalBimapLetBind :: Qualifier -> Name -> Name -> Map RuleName Name -> RuleName -> Q DecQ

nonTerminalBimapLetBind :: Qualifier -> Map RuleName Name -> RuleName -> [Branch a] -> DecQ

wrapBimapLetBind :: Qualifier -> Map RuleName Name -> RuleName -> RuleName -> Q DecQ

recordBimapLetBind :: Qualifier -> Map RuleName Name -> RuleName -> Seq (Rule t) -> Q DecQ

recordBimapClause :: Qualifier -> Map RuleName Name -> RuleName -> Seq (Rule t) -> ClauseQ

recordBimapLetBindField :: Map RuleName Name -> Rule t -> Q (PatQ, ExpQ)

optBimapLetBind

Arguments

:: Qualifier

-> Map RuleName Name

-> RuleName

Name of this rule

-> RuleName

Name of inner rule

-> Q DecQ

starBimapLetBind

Arguments

:: Qualifier

-> Map RuleName Name

-> RuleName

Name of this rule

-> RuleName

Name of inner rule

-> Q DecQ

plusBimapLetBind

Arguments

:: Qualifier

-> Map RuleName Name

-> RuleName

Name of this rule

-> RuleName

Name of inner rule

-> Q DecQ

errLookup :: (Ord a, Show a) => a -> Map a b -> b

nameMap :: Rule t -> Q (Map RuleName Name)

Creates a map of all ancestor rule names and a corresponding TH name.

memptyExpression :: Qualifier -> Rule t -> Maybe ExpQ

If possible, creates an expression of type

RuleData

which is a Monoid mempty.

wrappedMemptyExpression :: Qualifier -> Seq RuleName -> ExpQ

mappendExpression :: Qualifier -> Rule t -> Maybe ExpQ

If possible, creates an expression of type

RuleData -> RuleData -> RuleData

which is a Monoid mappend.

monoidCtors :: Rule t -> Maybe (Seq RuleName)

semigroupExpression :: Qualifier -> Rule t -> Maybe ExpQ

If possible, creates an expression of type

RuleData -> RuleData -> RuleData

which is a Semigroup <>.

semigroupCtors :: Rule t -> Maybe (Seq RuleName)

wrappedSemigroupExpression

Arguments

:: Name

mappend operator

-> Qualifier

-> Seq RuleName

Rule names, with the outermost name on the left side of the Seq.

-> ExpQ

An expression of type

RuleData -> RuleData -> RuleData

It unwraps the two argument types, uses the Semigroup <> operator to combine them, and rewraps the result.