Foreign.Lua.Module

Utility functions for HsLua modules.

Documentation

requirehs :: String -> Lua () -> Lua ()

Load a module, defined by a Haskell action, under the given name.

Similar to luaL_required: After checking "loaded" table, calls pushMod to push a module to the stack, and registers the result in package.loaded table.

The pushMod function must push exactly one element to the top of the stack. This is not checked, but failure to do so will lead to problems. Lua's package module must have been loaded by the time this function is invoked.

Leaves a copy of the module on the stack.

preloadhs :: String -> Lua NumResults -> Lua ()

Registers a preloading function. Takes an module name and the Lua operation which produces the package.

addfield :: Pushable a => String -> a -> Lua ()

Add a string-indexed field to the table at the top of the stack.

addfunction :: ToHaskellFunction a => String -> a -> Lua ()

Attach a function to the table at the top of the stack, using the given name.

create :: Lua ()

Create a new module (i.e., a Lua table).

Module

data Module

Named and documented Lua module.

Constructors

Module

Fields

• moduleName :: Text
• moduleDescription :: Text
• moduleFields :: [Field]
• moduleFunctions :: [(Text, HaskellFunction)]

data Field

Self-documenting module field

Constructors

Field

Fields

• fieldName :: Text
• fieldDescription :: Text
• fieldPushValue :: Lua ()

registerModule :: Module -> Lua ()

Registers a Module; leaves a copy of the module table on the stack.

preloadModule :: Module -> Lua ()

Preload self-documenting module.

pushModule :: Module -> Lua ()

Documentation

render :: Module -> Text

Renders module documentation as Markdown.