Modulehslua-packaging-2.4.1Haskell2010

HsLua.Packaging.Module

Utility functions for HsLua modules.

4 types
2 classes
14 values

Packagehslua-packaging-2.4.1
Exports20
LanguageHaskell2010
LicenceMIT
SourceModule.hs

Documented module

3 declarations

datadata Module e

Named and documented Lua module.

Constructors

Module
- 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.

Instances2HasDescription, HasName

HasDescription (Module e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasName (Module e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata ModuleDoc

Module documentation

Constructors

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

Instances4Eq, Ord, Show, HasDescription

Eq ModuleDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Ord ModuleDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Show ModuleDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasDescription ModuleDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata Field e

Self-documenting module field

Constructors

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

Instances2HasDescription, HasName

HasDescription (Field e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasName (Field e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

Constructors

0 declarations

Module

valuedefmodule :: Name -> Module e

Define a Lua module.

valuewithFields :: Module e -> [Field e] -> Module e

Set the list of module fields.

valuewithFunctions :: Module e -> [DocumentedFunction e] -> Module e

Set the list of functions in the module.

valuewithOperations

:: Module e
-> [(Operation, DocumentedFunction e)]
-> Module e

Set operations that can be performed on the module object.

valueassociateType :: LuaError e => Module e -> DocumentedType e a -> Module e

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

valuerenameTo :: HasName a => a -> Name -> a

Gives a different name

Field

valuedeffield :: Name -> Field e

Create a new module field.

valuewithType :: Field e -> TypeSpec -> Field e

Set a specific type for a field.

valuewithDescription :: HasDescription a => a -> Text -> a

Sets a textual description

valuewithValue :: Field e -> LuaE e () -> Field e

Add a value pusher to a field.

Type Classes

classclass HasName a where

Named objects

Methods

getName :: a -> Name
setName :: a -> Name -> a

Instances3HasName

HasName (DocumentedFunction e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasName (Field e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasName (Module e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

classclass HasDescription a where

Objects that have descriptions.

Methods

getDescription :: a -> Text
setDescription :: a -> Text -> a

Instances4HasDescription

HasDescription FieldDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasDescription ModuleDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasDescription (Field e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasDescription (Module e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

Module Loading

5 declarations

valueregisterModule :: LuaError e => Module e -> LuaE e ()

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

valuepreloadModule :: LuaError e => Module e -> LuaE e ()

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

valuepreloadModuleWithName :: LuaError e => Module e -> Name -> LuaE e ()

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

valuepushModule :: LuaError e => Module e -> LuaE e ()

Pushes a documented module to the Lua stack.

datadata Operation

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.

Instances3Eq, Ord, Show

Eq OperationDefined in hslua-objectorientation-2.5.0 · HsLua.ObjectOrientation.Operation
Ord OperationDefined in hslua-objectorientation-2.5.0 · HsLua.ObjectOrientation.Operation
Show OperationDefined in hslua-objectorientation-2.5.0 · HsLua.ObjectOrientation.Operation