Copyright	© 2020-2026 Albert Krewinkel
License	MIT
Maintainer	Albert Krewinkel <tarleb@hslua.org>
Stability	alpha
Portability	Portable
Safe Haskell	None
Language	Haskell2010

HsLua.Packaging.Types

Contents

Documented Lua objects
Documentation types
Type classes

Description

Marshaling and documenting Haskell functions.

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 Field e = Field {
- fieldName :: Name
- fieldDoc :: FieldDoc
- fieldPushValue :: LuaE e ()
}
data DocumentedFunction e = DocumentedFunction {
- callFunction :: LuaE e NumResults
- functionName :: Name
- functionDoc :: FunctionDoc
}
type DocumentedType e a = UDType e (DocumentedFunction e) a
data DocumentationObject
data ModuleDoc = ModuleDoc {
- moduleDocName :: Text
- moduleDocDescription :: Text
- moduleDocFields :: [FieldDoc]
- moduleDocFunctions :: [FunctionDoc]
- moduleDocTypes :: [TypeDoc]
}
data FunctionDoc = FunDoc {
- funDocName :: Text
- funDocDescription :: Text
- funDocParameters :: [ParameterDoc]
- funDocResults :: ResultsDoc
- funDocSince :: Maybe Version
}
data TypeDoc = TypeDoc {
- typeDocName :: Text
- typeDocDescription :: Text
- typeDocOperations :: [(Operation, FunctionDoc)]
- typeDocMethods :: [FunctionDoc]
}
data ParameterDoc = ParameterDoc {
- parameterName :: Text
- parameterType :: TypeSpec
- parameterDescription :: Text
- parameterIsOptional :: Bool
}
data ResultsDoc
- = ResultsDocList [ResultValueDoc]
- | ResultsDocMult Text
data ResultValueDoc = ResultValueDoc {
- resultValueType :: TypeSpec
- resultValueDescription :: Text
}
data FieldDoc = FieldDoc {
- fieldDocName :: Text
- fieldDocType :: TypeSpec
- fieldDocDescription :: Text
}
class HasName a where
- getName :: a -> Name
- setName :: a -> Name -> a
class HasDescription a where
- getDescription :: a -> Text
- setDescription :: a -> Text -> a

Documented Lua objects

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 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 #

data DocumentedFunction e Source #

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

Constructors

DocumentedFunction
Fields callFunction :: LuaE e NumResults functionName :: Name functionDoc :: FunctionDoc

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 #

type DocumentedType e a = UDType e (DocumentedFunction e) a Source #

Type definitions containing documented functions.

Documentation types

data DocumentationObject Source #

Documentation for any of the supported Lua objects.

Constructors

DocObjectFunction FunctionDoc
DocObjectModule ModuleDoc
DocObjectType TypeDoc

Instances

Instances details

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

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 FunctionDoc Source #

Documentation for a Haskell function

Constructors

FunDoc
Fields funDocName :: Text funDocDescription :: Text funDocParameters :: [ParameterDoc] funDocResults :: ResultsDoc funDocSince :: Maybe Version Version in which the function was introduced.

Instances

Instances details

Show FunctionDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> FunctionDoc -> ShowS show :: FunctionDoc -> String showList :: [FunctionDoc] -> ShowS
Eq FunctionDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods (==) :: FunctionDoc -> FunctionDoc -> Bool (/=) :: FunctionDoc -> FunctionDoc -> Bool
Ord FunctionDoc Source #
Instance details 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 TypeDoc Source #

Documentation of a data type.

Constructors

TypeDoc
Fields typeDocName :: Text typeDocDescription :: Text typeDocOperations :: [(Operation, FunctionDoc)] typeDocMethods :: [FunctionDoc]

Instances

Instances details

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

data ParameterDoc Source #

Documentation for function parameters.

Constructors

ParameterDoc
Fields parameterName :: Text parameterType :: TypeSpec parameterDescription :: Text parameterIsOptional :: Bool

Instances

Instances details

Show ParameterDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> ParameterDoc -> ShowS show :: ParameterDoc -> String showList :: [ParameterDoc] -> ShowS
Eq ParameterDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods (==) :: ParameterDoc -> ParameterDoc -> Bool (/=) :: ParameterDoc -> ParameterDoc -> Bool
Ord ParameterDoc Source #
Instance details 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 Source #

Documentation for the return values of a function.

Constructors

ResultsDocList [ResultValueDoc]	List of individual results
ResultsDocMult Text	Flexible results

Instances

Instances details

Show ResultsDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> ResultsDoc -> ShowS show :: ResultsDoc -> String showList :: [ResultsDoc] -> ShowS
Eq ResultsDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods (==) :: ResultsDoc -> ResultsDoc -> Bool (/=) :: ResultsDoc -> ResultsDoc -> Bool
Ord ResultsDoc Source #
Instance details 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 Source #

Documentation for a single return value of a function.

Constructors

ResultValueDoc
Fields resultValueType :: TypeSpec resultValueDescription :: Text

Instances

Instances details

Show ResultValueDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> ResultValueDoc -> ShowS show :: ResultValueDoc -> String showList :: [ResultValueDoc] -> ShowS
Eq ResultValueDoc Source #
Instance details Defined in HsLua.Packaging.Types Methods (==) :: ResultValueDoc -> ResultValueDoc -> Bool (/=) :: ResultValueDoc -> ResultValueDoc -> Bool
Ord ResultValueDoc Source #
Instance details 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

data FieldDoc Source #

Documentation for a module field.

Constructors

FieldDoc
Fields fieldDocName :: Text fieldDocType :: TypeSpec fieldDocDescription :: Text

Instances

Instances details

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

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 #