hslua-packaging
Copyright© 2019-2026 Albert Krewinkel
LicenseMIT
MaintainerAlbert Krewinkel <tarleb@hslua.org>
Safe HaskellNone
LanguageHaskell2010

HsLua.Packaging

Description

Tools to create documented Lua functions and modules.

Synopsis

Modules

module HsLua.Packaging.Module

module HsLua.Packaging.Function

module HsLua.Packaging.Convenience

Object oriented marshalling

module HsLua.Packaging.UDType

Register and access docs in Lua

module HsLua.Packaging.Documentation

Types

module HsLua.Packaging.Types

(#|#) :: TypeSpec -> TypeSpec -> TypeSpec #

anyType :: TypeSpec #

booleanType :: TypeSpec #

functionType :: TypeSpec #

integerType :: TypeSpec #

lightUserdataType :: TypeSpec #

nilType :: TypeSpec #

numberType :: TypeSpec #

peekTypeSpec :: LuaError e => Peeker e TypeSpec #

pushTypeSpec :: LuaError e => TypeSpec -> LuaE e () #

recType :: [(Name, TypeSpec)] -> TypeSpec #

seqType :: TypeSpec -> TypeSpec #

stringType :: TypeSpec #

tableType :: TypeSpec #

threadType :: TypeSpec #

typeSpecFromString :: String -> TypeSpec #

typeSpecToString :: TypeSpec -> String #

userdataType :: TypeSpec #

voidType :: TypeSpec #

data TypeSpec #

Constructors

BasicType Type 
NamedType Name 
SeqType TypeSpec 
SumType [TypeSpec] 
RecType (Map Name TypeSpec) 
FunType [TypeSpec] [TypeSpec] 
AnyType 

Instances

Instances details
IsString TypeSpec # 
Instance details

Defined in HsLua.Typing

Methods

fromString :: String -> TypeSpec

Generic TypeSpec # 
Instance details

Defined in HsLua.Typing

Associated Types

type Rep TypeSpec 
Instance details

Defined in HsLua.Typing

type Rep TypeSpec = D1 ('MetaData "TypeSpec" "HsLua.Typing" "hslua-typing-0.2.0-HwVvWDb2JBKBM3T8rZUuAT" 'False) ((C1 ('MetaCons "BasicType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type)) :+: (C1 ('MetaCons "NamedType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name)) :+: C1 ('MetaCons "SeqType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TypeSpec)))) :+: ((C1 ('MetaCons "SumType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TypeSpec])) :+: C1 ('MetaCons "RecType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Name TypeSpec)))) :+: (C1 ('MetaCons "FunType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TypeSpec]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TypeSpec])) :+: C1 ('MetaCons "AnyType" 'PrefixI 'False) (U1 :: Type -> Type))))

Methods

from :: TypeSpec -> Rep TypeSpec x

to :: Rep TypeSpec x -> TypeSpec

Show TypeSpec # 
Instance details

Defined in HsLua.Typing

Methods

showsPrec :: Int -> TypeSpec -> ShowS

show :: TypeSpec -> String

showList :: [TypeSpec] -> ShowS

Eq TypeSpec # 
Instance details

Defined in HsLua.Typing

Methods

(==) :: TypeSpec -> TypeSpec -> Bool

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

Ord TypeSpec # 
Instance details

Defined in HsLua.Typing

Methods

compare :: TypeSpec -> TypeSpec -> Ordering

(<) :: TypeSpec -> TypeSpec -> Bool

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

(>) :: TypeSpec -> TypeSpec -> Bool

(>=) :: TypeSpec -> TypeSpec -> Bool

max :: TypeSpec -> TypeSpec -> TypeSpec

min :: TypeSpec -> TypeSpec -> TypeSpec

type Rep TypeSpec # 
Instance details

Defined in HsLua.Typing

type Rep TypeSpec = D1 ('MetaData "TypeSpec" "HsLua.Typing" "hslua-typing-0.2.0-HwVvWDb2JBKBM3T8rZUuAT" 'False) ((C1 ('MetaCons "BasicType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type)) :+: (C1 ('MetaCons "NamedType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name)) :+: C1 ('MetaCons "SeqType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TypeSpec)))) :+: ((C1 ('MetaCons "SumType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TypeSpec])) :+: C1 ('MetaCons "RecType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Name TypeSpec)))) :+: (C1 ('MetaCons "FunType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TypeSpec]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TypeSpec])) :+: C1 ('MetaCons "AnyType" 'PrefixI 'False) (U1 :: Type -> Type))))