Copyright	© 2019-2026 Albert Krewinkel
License	MIT
Maintainer	Albert Krewinkel <tarleb@hslua.org>
Stability	alpha
Portability	Requires GHC 8 or later.
Safe Haskell	None
Language	Haskell2010

HsLua.Packaging.Module

Contents

Documented module
Constructors
Module Loading

Description

Utility functions for HsLua modules.

Synopsis

data Module e = Module {
- moduleName :: Name
- moduleDescription :: Text
- moduleFields :: [Field e]
- moduleFunctions :: [DocumentedFunction e]
- moduleOperations :: [(Operation, DocumentedFunction e)]
- moduleTypeInitializers :: [LuaE e Name]
- moduleTypeDocs :: [TypeDoc]
}
data ModuleDoc = ModuleDoc {
- moduleDocName :: Text
- moduleDocDescription :: Text
- moduleDocFields :: [FieldDoc]
- moduleDocFunctions :: [FunctionDoc]
- moduleDocTypes :: [TypeDoc]
}
data Field e = Field {
- fieldName :: Name
- fieldDoc :: FieldDoc
- fieldPushValue :: LuaE e ()
}
defmodule :: Name -> Module e
withFields :: Module e -> [Field e] -> Module e
withFunctions :: Module e -> [DocumentedFunction e] -> Module e
withOperations :: Module e -> [(Operation, DocumentedFunction e)] -> Module e
associateType :: LuaError e => Module e -> DocumentedType e a -> Module e
renameTo :: HasName a => a -> Name -> a
deffield :: Name -> Field e
withType :: Field e -> TypeSpec -> Field e
withDescription :: HasDescription a => a -> Text -> a
withValue :: Field e -> LuaE e () -> Field e
class HasName a where
- getName :: a -> Name
- setName :: a -> Name -> a
class HasDescription a where
- getDescription :: a -> Text
- setDescription :: a -> Text -> a
registerModule :: LuaError e => Module e -> LuaE e ()
preloadModule :: LuaError e => Module e -> LuaE e ()
preloadModuleWithName :: LuaError e => Module e -> Name -> LuaE e ()
pushModule :: LuaError e => Module e -> LuaE e ()
data Operation
- = Add
- | Sub
- | Mul
- | Div
- | Mod
- | Pow
- | Unm
- | Idiv
- | Band
- | Bor
- | Bxor
- | Bnot
- | Shl
- | Shr
- | Concat
- | Len
- | Eq
- | Lt
- | Le
- | Index
- | Newindex
- | Call
- | Tostring
- | Pairs
- | CustomOperation Name

Documented module

data Module e Source #

Named and documented Lua module.

Constructors

Module

Fields

moduleName :: Name
moduleDescription :: Text
moduleFields :: [Field e]
moduleFunctions :: [DocumentedFunction e]
moduleOperations :: [(Operation, DocumentedFunction e)]
moduleTypeInitializers :: [LuaE e Name]
Lua initializers for the types that come with this module. Useful to force full initialization of all metatables.
moduleTypeDocs :: [TypeDoc]
Documentation for the types that are associated with this module.

Instances

Instances details

HasDescription (Module e) Source #
Instance details Defined in HsLua.Packaging.Types Methods getDescription :: Module e -> Text Source # setDescription :: Module e -> Text -> Module e Source #
HasName (Module e) Source #
Instance details Defined in HsLua.Packaging.Types Methods getName :: Module e -> Name Source # setName :: Module e -> Name -> Module e Source #

data ModuleDoc Source #

Module documentation

Constructors

ModuleDoc
Fields moduleDocName :: Text module name moduleDocDescription :: Text textual module description moduleDocFields :: [FieldDoc] module fields moduleDocFunctions :: [FunctionDoc] module functions moduleDocTypes :: [TypeDoc] module-associated types

Instances

Instances details

Show ModuleDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> ModuleDoc -> ShowS show :: ModuleDoc -> String showList :: [ModuleDoc] -> ShowS
Eq ModuleDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods (==) :: ModuleDoc -> ModuleDoc -> Bool (/=) :: ModuleDoc -> ModuleDoc -> Bool
Ord ModuleDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods compare :: ModuleDoc -> ModuleDoc -> Ordering (<) :: ModuleDoc -> ModuleDoc -> Bool (<=) :: ModuleDoc -> ModuleDoc -> Bool (>) :: ModuleDoc -> ModuleDoc -> Bool (>=) :: ModuleDoc -> ModuleDoc -> Bool max :: ModuleDoc -> ModuleDoc -> ModuleDoc min :: ModuleDoc -> ModuleDoc -> ModuleDoc
HasDescription ModuleDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods getDescription :: ModuleDoc -> Text Source # setDescription :: ModuleDoc -> Text -> ModuleDoc Source #

data Field e Source #

Self-documenting module field

Constructors

Field
Fields fieldName :: Name fieldDoc :: FieldDoc fieldPushValue :: LuaE e ()

Instances

Instances details

HasDescription (Field e) Source #
Instance details Defined in HsLua.Packaging.Types Methods getDescription :: Field e -> Text Source # setDescription :: Field e -> Text -> Field e Source #
HasName (Field e) Source #
Instance details Defined in HsLua.Packaging.Types Methods getName :: Field e -> Name Source # setName :: Field e -> Name -> Field e Source #

Constructors

Module

defmodule :: Name -> Module e Source #

Define a Lua module.

withFields :: Module e -> [Field e] -> Module e infixl 0 Source #

Set the list of module fields.

withFunctions :: Module e -> [DocumentedFunction e] -> Module e infixl 0 Source #

Set the list of functions in the module.

withOperations :: Module e -> [(Operation, DocumentedFunction e)] -> Module e infixl 0 Source #

Set operations that can be performed on the module object.

associateType :: LuaError e => Module e -> DocumentedType e a -> Module e infixl 0 Source #

Associate a type with this module. An associated type is listed in the module documentation.

renameTo :: HasName a => a -> Name -> a Source #

Gives a different name

Field

deffield :: Name -> Field e Source #

Create a new module field.

withType :: Field e -> TypeSpec -> Field e infixl 0 Source #

Set a specific type for a field.

withDescription :: HasDescription a => a -> Text -> a infixl 0 Source #

Sets a textual description

withValue :: Field e -> LuaE e () -> Field e infixl 0 Source #

Add a value pusher to a field.

Type Classes

class HasName a where Source #

Named objects

Methods

getName :: a -> Name Source #

setName :: a -> Name -> a Source #

Instances

Instances details

HasName (DocumentedFunction e) Source #
Instance details Defined in HsLua.Packaging.Types Methods getName :: DocumentedFunction e -> Name Source # setName :: DocumentedFunction e -> Name -> DocumentedFunction e Source #
HasName (Field e) Source #
Instance details Defined in HsLua.Packaging.Types Methods getName :: Field e -> Name Source # setName :: Field e -> Name -> Field e Source #
HasName (Module e) Source #
Instance details Defined in HsLua.Packaging.Types Methods getName :: Module e -> Name Source # setName :: Module e -> Name -> Module e Source #

class HasDescription a where Source #

Objects that have descriptions.

Methods

getDescription :: a -> Text Source #

setDescription :: a -> Text -> a Source #

Instances

Instances details

HasDescription FieldDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods getDescription :: FieldDoc -> Text Source # setDescription :: FieldDoc -> Text -> FieldDoc Source #
HasDescription ModuleDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods getDescription :: ModuleDoc -> Text Source # setDescription :: ModuleDoc -> Text -> ModuleDoc Source #
HasDescription (Field e) Source #
Instance details Defined in HsLua.Packaging.Types Methods getDescription :: Field e -> Text Source # setDescription :: Field e -> Text -> Field e Source #
HasDescription (Module e) Source #
Instance details Defined in HsLua.Packaging.Types Methods getDescription :: Module e -> Text Source # setDescription :: Module e -> Text -> Module e Source #

Module Loading

registerModule :: LuaError e => Module e -> LuaE e () Source #

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

preloadModule :: LuaError e => Module e -> LuaE e () Source #

Preload self-documenting module using the module's default name.

preloadModuleWithName :: LuaError e => Module e -> Name -> LuaE e () Source #

Add the module under a different name to the table of preloaded packages.

pushModule :: LuaError e => Module e -> LuaE e () Source #

Pushes a documented module to the Lua stack.

data Operation #

Constructors

Add
Sub
Mul
Div
Mod
Pow
Unm
Idiv
Band
Bor
Bxor
Bnot
Shl
Shr
Concat
Len
Eq
Lt
Le
Index
Newindex
Call
Tostring
Pairs
CustomOperation Name

Instances

Instances details

Show Operation #
Instance details Defined in HsLua.ObjectOrientation.Operation Methods showsPrec :: Int -> Operation -> ShowS show :: Operation -> String showList :: [Operation] -> ShowS
Eq Operation #
Instance details Defined in HsLua.ObjectOrientation.Operation Methods (==) :: Operation -> Operation -> Bool (/=) :: Operation -> Operation -> Bool
Ord Operation #
Instance details Defined in HsLua.ObjectOrientation.Operation Methods compare :: Operation -> Operation -> Ordering (<) :: Operation -> Operation -> Bool (<=) :: Operation -> Operation -> Bool (>) :: Operation -> Operation -> Bool (>=) :: Operation -> Operation -> Bool max :: Operation -> Operation -> Operation min :: Operation -> Operation -> Operation