Pinchot.SyntaxTree.Optics

Documentation

rulesToOptics

Arguments

:: Lift t

=> Qualifier

Qualifier for module containing the data types that will get optics

-> Name

Type name for the terminal

-> Seq (Rule t)

-> Q [Dec]

Creates optics declarations for a Rule, if optics can be made for the Rule:

• terminal gets a single Prism
• nonTerminal gets a Prism for each constructor
• record gets a single Lens
• wrap, opt, star, and plus do not get optics.

Each rule in the sequence of Rule, as well as all ancestors of those Rules, will be handled.

Example: Pinchot.Examples.RulesToOptics.

ruleToOptics

Arguments

:: Lift t

=> Qualifier

Qualifier for module containing the data type that will get optics

-> Name

Type name for the terminal

-> Rule t

-> Q [Dec]

Creates optics declarations for a single Rule, if optics can be made for the Rule:

• Terminal gets a single Prism
• NonTerminal gets a Prism for each constructor
• Terminals gets a single Prism
• Record gets a single Lens
• Wrap, Opt, Star, and Plus do not get optics.

terminalToOptics

Arguments

:: Lift t

=> Qualifier

Qualifier for module containing the data type that will get optics

-> Name

Terminal type name

-> String

Rule name

-> Intervals t

-> Q [Dec]

Creates a prism for a terminal type. Although a newtype wraps each terminal, do not make a Wrapped or an Iso, because the relationship between the outer type and the type that it wraps typically is not isometric. Thus, use a Prism instead, which captures this relationship properly.

nonTerminalToOptics

Arguments

:: Qualifier

Qualifier for module containing the data type that will get optics

-> String

Rule name

-> NonEmptySeq (Branch t)

-> [Q Dec]

Creates prisms for each Branch.

recordsToOptics

Arguments

:: Qualifier

Qualifier for module containing the data type that will get optics

-> String

Rule name

-> Seq (Rule t)

-> [Q Dec]

forallA :: TypeQ -> TypeQ