HsLua.Packaging.Types

Marshaling and documenting Haskell functions.

Documented module

data Module e

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]

data Field e

Self-documenting module field

Constructors

Field

Fields

• fieldName :: Text
• fieldType :: TypeSpec
• fieldDescription :: Text
• fieldPushValue :: LuaE e ()

Documented functions

data DocumentedFunction e

Haskell equivallent to CFunction, i.e., function callable from Lua.

Constructors

DocumentedFunction

Fields

• callFunction :: LuaE e NumResults
• functionName :: Name
• functionDoc :: FunctionDoc

Documentation types

data FunctionDoc

Documentation for a Haskell function

Constructors

FunctionDoc

Fields

• functionDescription :: Text
• parameterDocs :: [ParameterDoc]
• functionResultsDocs :: ResultsDoc
• functionSince :: Maybe Version

  Version in which the function was introduced.

Instances

Show FunctionDoc

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> FunctionDoc -> ShowS

show :: FunctionDoc -> String

showList :: [FunctionDoc] -> ShowS

Eq FunctionDoc

Defined in HsLua.Packaging.Types

Methods

(==) :: FunctionDoc -> FunctionDoc -> Bool

(/=) :: FunctionDoc -> FunctionDoc -> Bool

Ord FunctionDoc

Defined in HsLua.Packaging.Types

Methods

compare :: FunctionDoc -> FunctionDoc -> Ordering

(<) :: FunctionDoc -> FunctionDoc -> Bool

(<=) :: FunctionDoc -> FunctionDoc -> Bool

(>) :: FunctionDoc -> FunctionDoc -> Bool

(>=) :: FunctionDoc -> FunctionDoc -> Bool

max :: FunctionDoc -> FunctionDoc -> FunctionDoc

min :: FunctionDoc -> FunctionDoc -> FunctionDoc

data ParameterDoc

Documentation for function parameters.

Constructors

ParameterDoc

Fields

• parameterName :: Text
• parameterType :: TypeSpec
• parameterDescription :: Text
• parameterIsOptional :: Bool

Instances

Show ParameterDoc

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> ParameterDoc -> ShowS

show :: ParameterDoc -> String

showList :: [ParameterDoc] -> ShowS

Eq ParameterDoc

Defined in HsLua.Packaging.Types

Methods

(==) :: ParameterDoc -> ParameterDoc -> Bool

(/=) :: ParameterDoc -> ParameterDoc -> Bool

Ord ParameterDoc

Defined in HsLua.Packaging.Types

Methods

compare :: ParameterDoc -> ParameterDoc -> Ordering

(<) :: ParameterDoc -> ParameterDoc -> Bool

(<=) :: ParameterDoc -> ParameterDoc -> Bool

(>) :: ParameterDoc -> ParameterDoc -> Bool

(>=) :: ParameterDoc -> ParameterDoc -> Bool

max :: ParameterDoc -> ParameterDoc -> ParameterDoc

min :: ParameterDoc -> ParameterDoc -> ParameterDoc

data ResultsDoc

Documentation for the return values of a function.

Constructors

ResultsDocList [ResultValueDoc]

List of individual results

ResultsDocMult Text

Flexible results

Instances

Show ResultsDoc

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> ResultsDoc -> ShowS

show :: ResultsDoc -> String

showList :: [ResultsDoc] -> ShowS

Eq ResultsDoc

Defined in HsLua.Packaging.Types

Methods

(==) :: ResultsDoc -> ResultsDoc -> Bool

(/=) :: ResultsDoc -> ResultsDoc -> Bool

Ord ResultsDoc

Defined in HsLua.Packaging.Types

Methods

compare :: ResultsDoc -> ResultsDoc -> Ordering

(<) :: ResultsDoc -> ResultsDoc -> Bool

(<=) :: ResultsDoc -> ResultsDoc -> Bool

(>) :: ResultsDoc -> ResultsDoc -> Bool

(>=) :: ResultsDoc -> ResultsDoc -> Bool

max :: ResultsDoc -> ResultsDoc -> ResultsDoc

min :: ResultsDoc -> ResultsDoc -> ResultsDoc

data ResultValueDoc

Documentation for a single return value of a function.

Constructors

ResultValueDoc

Fields

• resultValueType :: TypeSpec
• resultValueDescription :: Text

Instances

Show ResultValueDoc

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> ResultValueDoc -> ShowS

show :: ResultValueDoc -> String

showList :: [ResultValueDoc] -> ShowS

Eq ResultValueDoc

Defined in HsLua.Packaging.Types

Methods

(==) :: ResultValueDoc -> ResultValueDoc -> Bool

(/=) :: ResultValueDoc -> ResultValueDoc -> Bool

Ord ResultValueDoc

Defined in HsLua.Packaging.Types

Methods

compare :: ResultValueDoc -> ResultValueDoc -> Ordering

(<) :: ResultValueDoc -> ResultValueDoc -> Bool

(<=) :: ResultValueDoc -> ResultValueDoc -> Bool

(>) :: ResultValueDoc -> ResultValueDoc -> Bool

(>=) :: ResultValueDoc -> ResultValueDoc -> Bool

max :: ResultValueDoc -> ResultValueDoc -> ResultValueDoc

min :: ResultValueDoc -> ResultValueDoc -> ResultValueDoc