Ivory.Language.Module

Documentation

data Visible

Constructors

Public

Private

Instances

Show Visible

ReaderM ModuleM Visible

newtype ModuleM a

Constructors

Module

Fields

unModule :: ReaderT Visible (WriterT Module Id) a

Instances

Monad ModuleM

Functor ModuleM

ReaderM ModuleM Visible

WriterM ModuleM Module

type ModuleDef = ModuleM ()

visAcc :: Visible -> a -> Visible a

Add an element to the public/private list, depending on visibility

incl :: Def a -> ModuleDef

Include a defintion in the module.

inclHeader :: String -> ModuleDef

Add a dependency on an external header.

depend :: Module -> ModuleDef

Add a dependency on another module.

defStruct :: forall sym. (IvoryStruct sym, SingI sym) => Proxy sym -> ModuleDef

Include the definition of a structure in the module.

defStringType :: forall str. IvoryString str => Proxy str -> ModuleDef

Include the definition of a string type's structure.

defMemArea :: IvoryArea area => MemArea area -> ModuleDef

Include the definition of a memory area.

defConstMemArea :: IvoryArea area => ConstMemArea area -> ModuleDef

Include the definition of a constant memory area.

sourceDep :: FilePath -> ModuleDef

Depend on an existing (object language) source file which should be copied to the user build tree as part of code generation

package :: String -> ModuleDef -> Module

Package the module up. Default visibility is public.

private :: ModuleDef -> ModuleDef

Start a block of definitions that should not be put in the header.

public :: ModuleDef -> ModuleDef

Start a block of definitions should be put in the header. This is the default, and this function is just included to complement private.

moduleName :: Module -> String