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

Methods

(==) :: Code -> Code -> Bool

(/=) :: Code -> Code -> Bool

Show Code

Methods

showsPrec :: Int -> Code -> ShowS

show :: Code -> String

showList :: [Code] -> ShowS

Monoid Code

Methods

mempty :: Code

mappend :: Code -> Code -> Code

mconcat :: [Code] -> Code

data ModuleInfo

Information on a generated module.

Constructors

ModuleInfo

Fields

• modulePath :: ModulePath

  Full module name: [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.

• qualifiedImports :: Set ModulePath

  Qualified (source) imports

• 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.

Instances

Eq ModuleFlag

Methods

(==) :: ModuleFlag -> ModuleFlag -> Bool

(/=) :: ModuleFlag -> ModuleFlag -> Bool

Ord ModuleFlag

Methods

compare :: ModuleFlag -> ModuleFlag -> Ordering

(<) :: ModuleFlag -> ModuleFlag -> Bool

(<=) :: ModuleFlag -> ModuleFlag -> Bool

(>) :: ModuleFlag -> ModuleFlag -> Bool

(>=) :: ModuleFlag -> ModuleFlag -> Bool

max :: ModuleFlag -> ModuleFlag -> ModuleFlag

min :: ModuleFlag -> ModuleFlag -> ModuleFlag

Show ModuleFlag

Methods

showsPrec :: Int -> ModuleFlag -> ShowS

show :: ModuleFlag -> String

showList :: [ModuleFlag] -> ShowS

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

Methods

showsPrec :: Int -> CGError -> ShowS

show :: CGError -> String

showList :: [CGError] -> ShowS

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

Like evalCodeGen, but discard the resulting output value.

evalCodeGen :: Config -> Map Name API -> ModulePath -> 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. It returns the list of written modules.

listModuleTree :: ModuleInfo -> [Text]

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

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

Methods

(==) :: BaseVersion -> BaseVersion -> Bool

(/=) :: BaseVersion -> BaseVersion -> Bool

Ord BaseVersion

Methods

compare :: BaseVersion -> BaseVersion -> Ordering

(<) :: BaseVersion -> BaseVersion -> Bool

(<=) :: BaseVersion -> BaseVersion -> Bool

(>) :: BaseVersion -> BaseVersion -> Bool

(>=) :: BaseVersion -> BaseVersion -> Bool

max :: BaseVersion -> BaseVersion -> BaseVersion

min :: BaseVersion -> BaseVersion -> BaseVersion

Show BaseVersion

Methods

showsPrec :: Int -> BaseVersion -> ShowS

show :: BaseVersion -> String

showList :: [BaseVersion] -> ShowS

showBaseVersion :: BaseVersion -> Text

A Text representation of the given base version bound.

registerNSDependency :: Text -> CodeGen ()

Mark the given dependency as used by the module.

qualified :: ModulePath -> Name -> CodeGen Text

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

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 and C to Haskell map 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 :: ModulePath -> BaseCodeGen e () -> BaseCodeGen e ()

Run the given CodeGen in order to generate a submodule (specified an an ordered list) 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.

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)

getAPI :: Type -> CodeGen API

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

findAPIByName :: Name -> CodeGen API

getAPIs :: CodeGen (Map Name API)

Return the list of APIs available to the generator.

getC2HMap :: CodeGen (Map CRef Hyperlink)

Return the C -> Haskell 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.