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 Source # show :: ModuleDoc -> String Source # showList :: [ModuleDoc] -> ShowS Source #
Eq ModuleDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods (==) :: ModuleDoc -> ModuleDoc -> Bool Source # (/=) :: ModuleDoc -> ModuleDoc -> Bool Source #
Ord ModuleDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods compare :: ModuleDoc -> ModuleDoc -> Ordering Source # (<) :: ModuleDoc -> ModuleDoc -> Bool Source # (<=) :: ModuleDoc -> ModuleDoc -> Bool Source # (>) :: ModuleDoc -> ModuleDoc -> Bool Source # (>=) :: ModuleDoc -> ModuleDoc -> Bool Source # max :: ModuleDoc -> ModuleDoc -> ModuleDoc Source # min :: ModuleDoc -> ModuleDoc -> ModuleDoc Source #
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 Source #

Lua metadata operation types.

Constructors

Add	the addition (`+`) operation. If any operand for an addition is not a number (nor a string coercible to a number), Lua will try to call a metamethod. First, Lua will check the first operand (even if it is valid). If that operand does not define a metamethod for `__add`, then Lua will check the second operand. If Lua can find a metamethod, it calls the metamethod with the two operands as arguments, and the result of the call (adjusted to one value) is the result of the operation. Otherwise, it raises an error.
Sub	the subtraction (`-`) operation. Behavior similar to the addition operation.
Mul	the multiplication (`*`) operation. Behavior similar to the addition operation.
Div	the division (`/`) operation. Behavior similar to the addition operation.
Mod	the modulo (`%`) operation. Behavior similar to the addition operation.
Pow	the exponentiation (`^`) operation. Behavior similar to the addition operation.
Unm	the negation (unary `-`) operation. Behavior similar to the addition operation.
Idiv	the floor division (`//`) operation. Behavior similar to the addition operation.
Band	the bitwise AND (`&`) operation. Behavior similar to the addition operation, except that Lua will try a metamethod if any operand is neither an integer nor a value coercible to an integer (see §3.4.3).
Bor	the bitwise OR (`\|`) operation. Behavior similar to the bitwise AND operation.
Bxor	the bitwise exclusive OR (binary `~`) operation. Behavior similar to the bitwise AND operation.
Bnot	the bitwise NOT (unary `~`) operation. Behavior similar to the bitwise AND operation.
Shl	the bitwise left shift (`<<`) operation. Behavior similar to the bitwise AND operation.
Shr	the bitwise right shift (`>>`) operation. Behavior similar to the bitwise AND operation.
Concat	the concatenation (`..`) operation. Behavior similar to the addition operation, except that Lua will try a metamethod if any operand is neither a string nor a number (which is always coercible to a string).
Len	the length (`#`) operation. If the object is not a string, Lua will try its metamethod. If there is a metamethod, Lua calls it with the object as argument, and the result of the call (always adjusted to one value) is the result of the operation. If there is no metamethod but the object is a table, then Lua uses the table length operation (see §3.4.7). Otherwise, Lua raises an error.
Eq	the equal (`==`) operation. Behavior similar to the addition operation, except that Lua will try a metamethod only when the values being compared are either both tables or both full userdata and they are not primitively equal. The result of the call is always converted to a boolean.
Lt	the less than (`<`) operation. Behavior similar to the addition operation, except that Lua will try a metamethod only when the values being compared are neither both numbers nor both strings. The result of the call is always converted to a boolean.
Le	the less equal (`<=`) operation. Unlike other operations, the less-equal operation can use two different events. First, Lua looks for the `__le` metamethod in both operands, like in the less than operation. If it cannot find such a metamethod, then it will try the `__lt` metamethod, assuming that a <= b is equivalent to not (b < a). As with the other comparison operators, the result is always a boolean. (This use of the `__lt` event can be removed in future versions; it is also slower than a real __le metamethod.)
Index	The indexing access operation `table[key]`. This event happens when table is not a table or when key is not present in table. The metamethod is looked up in table.
Newindex	The indexing assignment `table[key] = value`. Like the index event, this event happens when table is not a table or when key is not present in table. The metamethod is looked up in table.
Call	The call operation `func(args)`. This event happens when Lua tries to call a non-function value (that is, func is not a function). The metamethod is looked up in func. If present, the metamethod is called with func as its first argument, followed by the arguments of the original call (args). All results of the call are the result of the operation. (This is the only metamethod that allows multiple results.)
Tostring	The operation used to create a string representation of the object.
Pairs	the operation of iterating over the object's key-value pairs.
CustomOperation Name	a custom operation, with the metamethod name as parameter.

Instances

Instances details

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