Data.API.Tools.Combinators

Documentation

data Tool a

A Tool a is something that can generate TH declarations from a value of type a. Tools can be combined using the Monoid instance.

Instances

Monoid (Tool a)

type APITool = Tool API

type APINodeTool = Tool APINode

runTool :: Tool a -> ToolSettings -> a -> Q [Dec]

Execute a tool to generate some TH declarations.

Smart constructors and combinators

simpleTool :: (a -> Q [Dec]) -> Tool a

Construct a tool that does not depend on any settings

mkTool :: (ToolSettings -> a -> Q [Dec]) -> Tool a

Construct a tool that may depend on the settings

contramapTool :: (a -> b) -> Tool b -> Tool a

Tool is a contravariant functor

readTool :: (a -> Tool a) -> Tool a

Make a tool that reads its argument to decide what to do

subTools :: Tool a -> Tool [a]

Apply a tool that acts on elements of a list to the entire list

apiNodeTool :: Tool APINode -> Tool API

Apply a tool that acts on nodes to an entire API

apiDataTypeTool :: Tool APINode -> Tool API

Apply a tool that acts on datatype nodes (i.e. those that are not synonyms) to an entire API

apiSpecTool :: Tool (APINode, SpecNewtype) -> Tool (APINode, SpecRecord) -> Tool (APINode, SpecUnion) -> Tool (APINode, SpecEnum) -> Tool (APINode, APIType) -> Tool APINode

Create a tool that acts on nodes from its action on individual specs.

Tool settings

data ToolSettings

Settings to control the behaviour of API tools. This record may be extended in the future, so you should construct a value by overriding individual fields of defaultToolSettings.

warnOnOmittedInstance :: ToolSettings -> Bool

Generate a warning when an instance declaration is omitted because it already exists

newtypeSmartConstructors :: ToolSettings -> Bool

Rename the constructors of filtered newtypes and generate smart constructors that enforce the invariants

defaultToolSettings :: ToolSettings

Default settings designed to be overridden.