Data.GI.CodeGen.Code

Documentation

data Code

Constructors

NoCode

No code

Line Text

A single line, indented to current indentation

Indent Code

Indented region

Sequence (Seq Code)

The basic sequence of code

Group Code

A grouped set of lines

Instances

Eq Code

Show Code

Monoid Code

data ModuleInfo

Information on a generated module.

Constructors

ModuleInfo

Fields

moduleName :: ModuleName

Full module name: [GI, Gtk, Label].

moduleCode :: Code

Generated code for the module.

bootCode :: Code

Interface going into the .hs-boot file.

submodules :: Map Text ModuleInfo

Indexed by the relative module name.

moduleDeps :: Deps

Set of dependencies for this module.

moduleExports :: Seq Export

Exports for the module.

modulePragmas :: Set Text

Set of language pragmas for the module.

moduleGHCOpts :: Set Text

GHC options for compiling the module.

moduleFlags :: Set ModuleFlag

Flags for the module.

moduleDoc :: Maybe Text

Documentation for the module.

moduleMinBase :: BaseVersion

Minimal version of base the module will work on.

data ModuleFlag

Flags for module code generation.

Constructors

ImplicitPrelude

Use the standard prelude, instead of the haskell-gi-base short one.

NoTypesImport

Do not import a Types submodule.

NoCallbacksImport

Do not import a Callbacks submodule.

Reexport

Reexport the module (as is) from .Types

Instances

Eq ModuleFlag

Ord ModuleFlag

Show ModuleFlag

type BaseCodeGen excType a = ReaderT CodeGenConfig (StateT ModuleInfo (ExceptT excType IO)) a

type CodeGen a = forall e. BaseCodeGen e a

The code generator monad, for generators that cannot throw errors. The fact that they cannot throw errors is encoded in the forall, which disallows any operation on the error, except discarding it or passing it along without inspecting. This last operation is useful in order to allow embedding CodeGen computations inside ExcCodeGen computations, while disallowing the opposite embedding without explicit error handling.

type ExcCodeGen a = BaseCodeGen CGError a

Code generators that can throw errors.

data CGError

Constructors

CGErrorNotImplemented Text

CGErrorBadIntrospectionInfo Text

CGErrorMissingInfo Text

Instances

Show CGError

genCode :: Config -> Map Name API -> ModuleName -> CodeGen () -> IO ModuleInfo

Like evalCodeGen, but discard the resulting output value.

evalCodeGen :: Config -> Map Name API -> ModuleName -> CodeGen a -> IO (a, ModuleInfo)

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

writeModuleTree :: Bool -> Maybe FilePath -> ModuleInfo -> IO [Text]

Write down the code for a module and its submodules to disk under the given base directory. This also writes the submodules, and a Types submodule reexporting all interfaces defined in .hs-boot files. It returns the list of written modules.

writeModuleCode :: Bool -> Maybe FilePath -> ModuleInfo -> IO [Text]

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

codeToText :: Code -> Text

Return a text representation of the Code.

transitiveModuleDeps :: ModuleInfo -> Deps

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

minBaseVersion :: ModuleInfo -> BaseVersion

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

data BaseVersion

Minimal version of base supported by a given module.

Constructors

Base47

1. 7.0

Base48

1. 8.0

Instances

Eq BaseVersion

Ord BaseVersion

Show BaseVersion

showBaseVersion :: BaseVersion -> Text

A Text representation of the given base version bound.

loadDependency :: Text -> CodeGen ()

Mark the given dependency as used by the module.

getDeps :: CodeGen Deps

Return the currently loaded set of dependencies.

recurseWithAPIs :: Map Name API -> CodeGen () -> CodeGen ()

Like recurse, giving explicitly the set of loaded APIs for the subgenerator.

handleCGExc :: (CGError -> CodeGen a) -> ExcCodeGen a -> CodeGen a

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

describeCGError :: CGError -> Text

Give a friendly textual description of the error for presenting to the user.

notImplementedError :: Text -> ExcCodeGen a

badIntroError :: Text -> ExcCodeGen a

missingInfoError :: Text -> ExcCodeGen a

indent :: BaseCodeGen e a -> BaseCodeGen e a

Increase the indent level for code generation.

bline :: Text -> CodeGen ()

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

line :: Text -> CodeGen ()

Print out a (newline-terminated) line.

blank :: CodeGen ()

A blank line

group :: BaseCodeGen e a -> BaseCodeGen e a

Group a set of related code.

hsBoot :: BaseCodeGen e a -> BaseCodeGen e a

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

submodule :: Text -> BaseCodeGen e () -> BaseCodeGen e ()

Run the given CodeGen in order to generate a submodule of the current module.

setLanguagePragmas :: [Text] -> CodeGen ()

Set the language pragmas for the current module.

setGHCOptions :: [Text] -> CodeGen ()

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

setModuleFlags :: [ModuleFlag] -> CodeGen ()

Set the given flags for the module.

setModuleMinBase :: BaseVersion -> CodeGen ()

Set the minimum base version supported by the current module.

addModuleDocumentation :: Maybe Documentation -> CodeGen ()

Add the given text to the module-level documentation for the module being generated.

exportToplevel :: SymbolName -> CodeGen ()

Export a toplevel (i.e. belonging to no section) symbol.

exportModule :: SymbolName -> CodeGen ()

Reexport a whole module.

exportDecl :: SymbolName -> CodeGen ()

Add a type declaration-related export.

exportMethod :: HaddockSection -> SymbolName -> CodeGen ()

Add a method export under the given section.

exportProperty :: HaddockSection -> SymbolName -> CodeGen ()

Add a property-related export under the given section.

exportSignal :: HaddockSection -> SymbolName -> CodeGen ()

Add a signal-related export under the given section.

findAPI :: Type -> CodeGen (Maybe API)

findAPIByName :: Name -> CodeGen API

getAPIs :: CodeGen (Map Name API)

Return the list of APIs available to the generator.

config :: CodeGen Config

Return the ambient configuration for the code generator.

currentModule :: CodeGen Text

Return the name of the current module.

(<>) :: Monoid m => m -> m -> m infixr 6

An infix synonym for mappend.

Since: 4.5.0.0