Data.GI.CodeGen.Code

Documentation

data Code

The generated Code is a sequence of CodeTokens.

Instances

Eq Code

Defined in Data.GI.CodeGen.Code

Methods

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

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

Ord Code

Defined in Data.GI.CodeGen.Code

Methods

compare :: Code -> Code -> Ordering

(<) :: Code -> Code -> Bool

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

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

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

max :: Code -> Code -> Code

min :: Code -> Code -> Code

Show Code

Defined in Data.GI.CodeGen.Code

Methods

showsPrec :: Int -> Code -> ShowS

show :: Code -> String

showList :: [Code] -> ShowS

Semigroup Code

Defined in Data.GI.CodeGen.Code

Methods

(<>) :: Code -> Code -> Code

sconcat :: NonEmpty Code -> Code

stimes :: Integral b => b -> Code -> Code

Monoid Code

Defined in Data.GI.CodeGen.Code

Methods

mempty :: Code

mappend :: Code -> Code -> Code

mconcat :: [Code] -> Code

data ModuleInfo

Information on a generated module.

data ModuleFlag

Flags for module code generation.

Constructors

ImplicitPrelude

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

Instances

Eq ModuleFlag

Defined in Data.GI.CodeGen.Code

Methods

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

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

Ord ModuleFlag

Defined in Data.GI.CodeGen.Code

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

Defined in Data.GI.CodeGen.Code

Methods

showsPrec :: Int -> ModuleFlag -> ShowS

show :: ModuleFlag -> String

showList :: [ModuleFlag] -> ShowS

type BaseCodeGen excType a = ReaderT CodeGenConfig (StateT (CGState, ModuleInfo) (Except excType)) a

The base type for the code generator monad.

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

Set of errors for the code generator.

Constructors

CGErrorNotImplemented Text

CGErrorBadIntrospectionInfo Text

CGErrorMissingInfo Text

Instances

Show CGError

Defined in Data.GI.CodeGen.Code

Methods

showsPrec :: Int -> CGError -> ShowS

show :: CGError -> String

showList :: [CGError] -> ShowS

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

Like evalCodeGen, but discard the resulting output value.

evalCodeGen :: Config -> Map Name API -> ModulePath -> CodeGen a -> (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

Defined in Data.GI.CodeGen.Code

Methods

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

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

Ord BaseVersion

Defined in Data.GI.CodeGen.Code

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

Defined in Data.GI.CodeGen.Code

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 recurseCG, 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.

increaseIndent :: CodeGen ()

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

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.

cppIf :: CPPGuard -> BaseCodeGen e a -> BaseCodeGen e a

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

data CPPGuard

Possible features to test via CPP.

Constructors

CPPOverloading

Enable overloading

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.

getFreshTypeVariable :: CodeGen Text

Get a type variable unused in the current scope.

resetTypeVariableScope :: CodeGen ()

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

exportModule :: SymbolName -> CodeGen ()

Reexport a whole module.

exportDecl :: SymbolName -> CodeGen ()

Add a type declaration-related export.

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

Export a symbol in the given haddock subsection.

data HaddockSection

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

Constructors

ToplevelSection

NamedSubsection NamedSection Text

Instances

Eq HaddockSection

Defined in Data.GI.CodeGen.Code

Methods

(==) :: HaddockSection -> HaddockSection -> Bool

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

Ord HaddockSection

Defined in Data.GI.CodeGen.Code

Methods

compare :: HaddockSection -> HaddockSection -> Ordering

(<) :: HaddockSection -> HaddockSection -> Bool

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

(>) :: HaddockSection -> HaddockSection -> Bool

(>=) :: HaddockSection -> HaddockSection -> Bool

max :: HaddockSection -> HaddockSection -> HaddockSection

min :: HaddockSection -> HaddockSection -> HaddockSection

Show HaddockSection

Defined in Data.GI.CodeGen.Code

Methods

showsPrec :: Int -> HaddockSection -> ShowS

show :: HaddockSection -> String

showList :: [HaddockSection] -> ShowS

data NamedSection

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

Constructors

MethodSection

PropertySection

SignalSection

EnumSection

FlagSection

Instances

Eq NamedSection

Defined in Data.GI.CodeGen.Code

Methods

(==) :: NamedSection -> NamedSection -> Bool

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

Ord NamedSection

Defined in Data.GI.CodeGen.Code

Methods

compare :: NamedSection -> NamedSection -> Ordering

(<) :: NamedSection -> NamedSection -> Bool

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

(>) :: NamedSection -> NamedSection -> Bool

(>=) :: NamedSection -> NamedSection -> Bool

max :: NamedSection -> NamedSection -> NamedSection

min :: NamedSection -> NamedSection -> NamedSection

Show NamedSection

Defined in Data.GI.CodeGen.Code

Methods

showsPrec :: Int -> NamedSection -> ShowS

show :: NamedSection -> String

showList :: [NamedSection] -> ShowS

addSectionFormattedDocs :: HaddockSection -> Text -> CodeGen ()

Add documentation for a 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.