Ivory.Language.Module

Documentation

data Visible

Constructors

Public

Private

Instances

Show Visible

Methods

showsPrec :: Int -> Visible -> ShowS

show :: Visible -> String

showList :: [Visible] -> ShowS

ReaderM ModuleM Visible

Methods

ask :: ModuleM Visible

newtype ModuleM a

Constructors

Module

Fields

• unModule :: ReaderT Visible (WriterT Module Id) a

Instances

Monad ModuleM

Methods

(>>=) :: ModuleM a -> (a -> ModuleM b) -> ModuleM b

(>>) :: ModuleM a -> ModuleM b -> ModuleM b

return :: a -> ModuleM a

fail :: String -> ModuleM a

Functor ModuleM

Methods

fmap :: (a -> b) -> ModuleM a -> ModuleM b

(<$) :: a -> ModuleM b -> ModuleM a

Applicative ModuleM

Methods

pure :: a -> ModuleM a

(<*>) :: ModuleM (a -> b) -> ModuleM a -> ModuleM b

(*>) :: ModuleM a -> ModuleM b -> ModuleM b

(<*) :: ModuleM a -> ModuleM b -> ModuleM a

ReaderM ModuleM Visible

Methods

ask :: ModuleM Visible

WriterM ModuleM Module

Methods

put :: Module -> ModuleM ()

Monoid (ModuleM ())

Methods

mempty :: ModuleM ()

mappend :: ModuleM () -> ModuleM () -> ModuleM ()

mconcat :: [ModuleM ()] -> ModuleM ()

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.

inclSym :: IvoryExpr t => t -> ModuleDef

Import an externally-defined symbol.

depend :: Module -> ModuleDef

Add a dependency on another module.

dependByName :: String -> ModuleDef

Add a dependency on another module by name. Use the same name here that you use when you call package to build the target module. This function is particularly useful when building mutually dependent module structures.

defStruct :: forall sym. (IvoryStruct sym, ASymbol 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.

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