Documentation

The generated Code is a sequence of CodeTokens.

Information on a generated module.

Flags for module code generation.

The base type for the code generator monad. Generators that cannot throw errors are parametric in the exception type excType.

Code generators that can throw errors.

Set of errors for the code generator.

Like evalCodeGen, but discard the resulting output value.

Run a code generator, and return the information for the generated module together with the return value of the generator.

Write down the code for a module and its submodules to disk under the given base directory. It returns the list of written modules.

Return the list of modules writeModuleTree would write, without actually writing anything to disk.

Return a text representation of the Code.

Return the transitive set of dependencies, i.e. the union of those of the module and (transitively) its submodules.

Return the minimal base version supported by the module and all its submodules.

Minimal version of base supported by a given module.

A Text representation of the given base version bound.

Mark the given dependency as used by the module.

Given a module name and a symbol in the module (including a proper namespace), return a qualified name for the symbol.

Return the currently loaded set of dependencies.

Like recurseCG, giving explicitly the set of loaded APIs and C to Haskell map for the subgenerator.

Try running the given action, and if it fails run fallback instead.

Print, as a comment, a friendly textual description of the error.

Increase the indent level for code generation.

Increase the indentation level for the rest of the lines in the current group.

Print out the given line both to the normal module, and to the HsBoot file.

Print out a (newline-terminated) line.

A blank line

Group a set of related code.

A (possibly multi line) comment, separated by newlines

Guard a code block with CPP code, such that it is included only if the specified feature is enabled.

Possible features to test via CPP.

Write the given code into the .hs-boot file for the current module.

Run the given CodeGen in order to generate a submodule (specified an an ordered list) of the current module.

Set the language pragmas for the current module.

Add a language pragma for the current module.

Set the GHC options for compiling this module (in a OPTIONS_GHC pragma).

Set the given flags for the module.

Set the minimum base version supported by the current module.

Get a type variable unused in the current scope.

Introduce a new scope for type variable naming: the next fresh variable will be called a.

Reexport a whole module.

Add a type declaration-related export.

Export a symbol in the given haddock subsection.

Subsection of the haddock documentation where the export should be located, or alternatively the toplevel section.

Known subsections. The ordering here is the ordering in which they will appear in the haddocks.

Add documentation for a given section.

Prepend documentation at the beginning of a given section.

Try to find the API associated with a given type, if known.

Find the API associated with a given type. If the API cannot be found this raises an error.

Return the list of APIs available to the generator.

Return the C -> Haskell available to the generator.

Return the ambient configuration for the code generator.

Return the name of the current module.