-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Utilities to build Lua modules.
--   
--   Utilities to package up Haskell functions and values into a Lua
--   module.
--   
--   This package is part of HsLua, a Haskell framework built around the
--   embeddable scripting language <a>Lua</a>.
@package hslua-packaging
@version 2.0.0


-- | Marshaling and documenting Haskell functions.
module HsLua.Packaging.Types

-- | Named and documented Lua module.
data Module e
Module :: Name -> Text -> [Field e] -> [DocumentedFunction e] -> [(Operation, DocumentedFunction e)] -> Module e
[moduleName] :: Module e -> Name
[moduleDescription] :: Module e -> Text
[moduleFields] :: Module e -> [Field e]
[moduleFunctions] :: Module e -> [DocumentedFunction e]
[moduleOperations] :: Module e -> [(Operation, DocumentedFunction e)]

-- | Self-documenting module field
data Field e
Field :: Text -> Text -> LuaE e () -> Field e
[fieldName] :: Field e -> Text
[fieldDescription] :: Field e -> Text
[fieldPushValue] :: Field e -> LuaE e ()

-- | Haskell equivallent to CFunction, i.e., function callable from Lua.
data DocumentedFunction e
DocumentedFunction :: LuaE e NumResults -> Name -> FunctionDoc -> DocumentedFunction e
[callFunction] :: DocumentedFunction e -> LuaE e NumResults
[functionName] :: DocumentedFunction e -> Name
[functionDoc] :: DocumentedFunction e -> FunctionDoc

-- | Documentation for a Haskell function
data FunctionDoc
FunctionDoc :: Text -> [ParameterDoc] -> ResultsDoc -> Maybe Version -> FunctionDoc
[functionDescription] :: FunctionDoc -> Text
[parameterDocs] :: FunctionDoc -> [ParameterDoc]
[functionResultsDocs] :: FunctionDoc -> ResultsDoc

-- | Version in which the function was introduced.
[functionSince] :: FunctionDoc -> Maybe Version

-- | Documentation for function parameters.
data ParameterDoc
ParameterDoc :: Text -> Text -> Text -> Bool -> ParameterDoc
[parameterName] :: ParameterDoc -> Text
[parameterType] :: ParameterDoc -> Text
[parameterDescription] :: ParameterDoc -> Text
[parameterIsOptional] :: ParameterDoc -> Bool

-- | Documentation for the return values of a function.
data ResultsDoc

-- | List of individual results
ResultsDocList :: [ResultValueDoc] -> ResultsDoc

-- | Flexible results
ResultsDocMult :: Text -> ResultsDoc

-- | Documentation for a single return value of a function.
data ResultValueDoc
ResultValueDoc :: Text -> Text -> ResultValueDoc
[resultValueType] :: ResultValueDoc -> Text
[resultValueDescription] :: ResultValueDoc -> Text
instance GHC.Show.Show HsLua.Packaging.Types.ParameterDoc
instance GHC.Classes.Ord HsLua.Packaging.Types.ParameterDoc
instance GHC.Classes.Eq HsLua.Packaging.Types.ParameterDoc
instance GHC.Show.Show HsLua.Packaging.Types.ResultValueDoc
instance GHC.Classes.Ord HsLua.Packaging.Types.ResultValueDoc
instance GHC.Classes.Eq HsLua.Packaging.Types.ResultValueDoc
instance GHC.Show.Show HsLua.Packaging.Types.ResultsDoc
instance GHC.Classes.Ord HsLua.Packaging.Types.ResultsDoc
instance GHC.Classes.Eq HsLua.Packaging.Types.ResultsDoc
instance GHC.Show.Show HsLua.Packaging.Types.FunctionDoc
instance GHC.Classes.Ord HsLua.Packaging.Types.FunctionDoc
instance GHC.Classes.Eq HsLua.Packaging.Types.FunctionDoc


-- | Render function and module documentation.
module HsLua.Packaging.Rendering

-- | Alias for <a>renderModule</a>.
render :: Module e -> Text

-- | Renders module documentation as Markdown.
renderModule :: Module e -> Text

-- | Renders documentation of a function.
renderFunction :: DocumentedFunction e -> Text


-- | Marshaling and documenting Haskell functions.
module HsLua.Packaging.Function

-- | Haskell equivallent to CFunction, i.e., function callable from Lua.
data DocumentedFunction e
DocumentedFunction :: LuaE e NumResults -> Name -> FunctionDoc -> DocumentedFunction e
[callFunction] :: DocumentedFunction e -> LuaE e NumResults
[functionName] :: DocumentedFunction e -> Name
[functionDoc] :: DocumentedFunction e -> FunctionDoc

-- | Begin wrapping a monadic Lua function such that it can be turned into
--   a documented function exposable to Lua.
defun :: Name -> a -> HsFnPrecursor e a

-- | Just like <tt>defun</tt>, but uses an empty name for the documented
--   function. Should be used when defining methods or operators.
lambda :: a -> HsFnPrecursor e a

-- | Partially apply a parameter.
applyParameter :: HsFnPrecursor e (a -> b) -> Parameter e a -> HsFnPrecursor e b

-- | Like <tt><a>returnResult</a></tt>, but returns only a single result.
returnResult :: HsFnPrecursor e (LuaE e a) -> FunctionResult e a -> DocumentedFunction e

-- | Take a <a>HaskellFunction</a> precursor and convert it into a full
--   <a>HaskellFunction</a>, using the given <a>FunctionResult</a>s to
--   return the result to Lua.
returnResultsOnStack :: HsFnPrecursor e (LuaE e NumResults) -> Text -> DocumentedFunction e

-- | Turns a pure function into a monadic Lua function.
--   
--   The resulting function is strict.
liftPure :: (a -> b) -> a -> LuaE e b

-- | Turns a binary function into a Lua function.
--   
--   The resulting function is strict in both its arguments.
liftPure2 :: (a -> b -> c) -> a -> b -> LuaE e c

-- | Turns a ternary function into a Lua function.
--   
--   The resulting function is strict in all of its arguments.
liftPure3 :: (a -> b -> c -> d) -> a -> b -> c -> LuaE e d

-- | Turns a quarternary function into a Lua function.
--   
--   The resulting function is strict in all of its arguments.
liftPure4 :: (a -> b -> c -> d -> e) -> a -> b -> c -> d -> LuaE err e

-- | Turns a quinary function into a Lua function.
--   
--   The resulting function is strict in all of its arguments.
liftPure5 :: (a -> b -> c -> d -> e -> f) -> a -> b -> c -> d -> e -> LuaE err f

-- | Function parameter.
data Parameter e a
Parameter :: Peeker e a -> ParameterDoc -> Parameter e a
[parameterPeeker] :: Parameter e a -> Peeker e a
[parameterDoc] :: Parameter e a -> ParameterDoc

-- | Result of a call to a Haskell function.
data FunctionResult e a
FunctionResult :: Pusher e a -> ResultValueDoc -> FunctionResult e a
[fnResultPusher] :: FunctionResult e a -> Pusher e a
[fnResultDoc] :: FunctionResult e a -> ResultValueDoc

-- | List of function results in the order in which they are returned in
--   Lua.
type FunctionResults e a = [FunctionResult e a]

-- | Like <a>($)</a>, but left associative.
(###) :: (a -> HsFnPrecursor e a) -> a -> HsFnPrecursor e a
infixl 8 ###

-- | Inline version of <tt><a>applyParameter</a></tt>.
(<#>) :: HsFnPrecursor e (a -> b) -> Parameter e a -> HsFnPrecursor e b
infixl 8 <#>

-- | Inline version of <tt><a>returnResults</a></tt>.
(=#>) :: HsFnPrecursor e (LuaE e a) -> FunctionResults e a -> DocumentedFunction e
infixl 8 =#>

-- | Return a flexible number of results that have been pushed by the
--   function action.
(=?>) :: HsFnPrecursor e (LuaE e NumResults) -> Text -> DocumentedFunction e
infixl 8 =?>

-- | Inline version of <tt><a>updateFunctionDescription</a></tt>.
(#?) :: DocumentedFunction e -> Text -> DocumentedFunction e
infixl 8 #?

-- | Renames a documented function.
setName :: Name -> DocumentedFunction e -> DocumentedFunction e

-- | Sets the library version at which the function was introduced in its
--   current form.
since :: DocumentedFunction e -> Version -> DocumentedFunction e
infixl 8 `since`

-- | Pushes a documented Haskell function to the Lua stack, making it
--   usable as a normal function in Lua. At the same time, the function
--   docs are registered in the documentation table.
pushDocumentedFunction :: LuaError e => DocumentedFunction e -> LuaE e ()

-- | Name of the registry field holding the documentation table. The
--   documentation table is indexed by the documented objects, like module
--   tables and functions, and contains documentation strings as values.
--   
--   The table is an ephemeron table, i.e., an entry gets garbage collected
--   if the key is no longer reachable.
docsField :: Name

-- | Pushes the documentation of the object at the given index to the
--   stack, or just *nil* if no documentation is available.
pushDocumentation :: LuaError e => StackIndex -> LuaE e NumResults

-- | Creates a parameter.
parameter :: Peeker e a -> Text -> Text -> Text -> Parameter e a

-- | Creates an optional parameter.
optionalParameter :: Peeker e a -> Text -> Text -> Text -> Parameter e (Maybe a)

-- | Creates a function result.
functionResult :: Pusher e a -> Text -> Text -> FunctionResults e a

-- | Create a HaskellFunction precursor from a monadic function, selecting
--   the stack index after which the first function parameter will be
--   placed.
toHsFnPrecursor :: StackIndex -> Name -> a -> HsFnPrecursor e a
instance GHC.Base.Functor (HsLua.Packaging.Function.HsFnPrecursor e)


-- | Utility functions for HsLua modules.
module HsLua.Packaging.Module

-- | Named and documented Lua module.
data Module e
Module :: Name -> Text -> [Field e] -> [DocumentedFunction e] -> [(Operation, DocumentedFunction e)] -> Module e
[moduleName] :: Module e -> Name
[moduleDescription] :: Module e -> Text
[moduleFields] :: Module e -> [Field e]
[moduleFunctions] :: Module e -> [DocumentedFunction e]
[moduleOperations] :: Module e -> [(Operation, DocumentedFunction e)]

-- | Self-documenting module field
data Field e
Field :: Text -> Text -> LuaE e () -> Field e
[fieldName] :: Field e -> Text
[fieldDescription] :: Field e -> Text
[fieldPushValue] :: Field e -> LuaE e ()

-- | Registers a <a>Module</a>; leaves a copy of the module table on the
--   stack.
registerModule :: LuaError e => Module e -> LuaE e ()

-- | Preload self-documenting module using the module's default name.
preloadModule :: LuaError e => Module e -> LuaE e ()

-- | Add the module under a different name to the table of preloaded
--   packages.
preloadModuleWithName :: LuaError e => Module e -> Name -> LuaE e ()

-- | Pushes a documented module to the Lua stack.
pushModule :: LuaError e => Module e -> LuaE e ()

-- | Lua metadata operation types.
data Operation

-- | the addition (<tt>+</tt>) 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
--   <tt>__add</tt>, 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.
Add :: Operation

-- | the subtraction (<tt>-</tt>) operation. Behavior similar to the
--   addition operation.
Sub :: Operation

-- | the multiplication (<tt>*</tt>) operation. Behavior similar to the
--   addition operation.
Mul :: Operation

-- | the division (<tt>/</tt>) operation. Behavior similar to the addition
--   operation.
Div :: Operation

-- | the modulo (<tt>%</tt>) operation. Behavior similar to the addition
--   operation.
Mod :: Operation

-- | the exponentiation (<tt>^</tt>) operation. Behavior similar to the
--   addition operation.
Pow :: Operation

-- | the negation (unary <tt>-</tt>) operation. Behavior similar to the
--   addition operation.
Unm :: Operation

-- | the floor division (<tt>//</tt>) operation. Behavior similar to the
--   addition operation.
Idiv :: Operation

-- | the bitwise AND (<tt>&amp;</tt>) 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).
Band :: Operation

-- | the bitwise OR (<tt>|</tt>) operation. Behavior similar to the bitwise
--   AND operation.
Bor :: Operation

-- | the bitwise exclusive OR (binary <tt>~</tt>) operation. Behavior
--   similar to the bitwise AND operation.
Bxor :: Operation

-- | the bitwise NOT (unary <tt>~</tt>) operation. Behavior similar to the
--   bitwise AND operation.
Bnot :: Operation

-- | the bitwise left shift (<tt>&lt;&lt;</tt>) operation. Behavior similar
--   to the bitwise AND operation.
Shl :: Operation

-- | the bitwise right shift (<tt>&gt;&gt;</tt>) operation. Behavior
--   similar to the bitwise AND operation.
Shr :: Operation

-- | the concatenation (<tt>..</tt>) 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).
Concat :: Operation

-- | the length (<tt>#</tt>) 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.
Len :: Operation

-- | the equal (<tt>==</tt>) 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.
Eq :: Operation

-- | the less than (<tt>&lt;</tt>) 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.
Lt :: Operation

-- | the less equal (<tt>&lt;=</tt>) operation. Unlike other operations,
--   the less-equal operation can use two different events. First, Lua
--   looks for the <tt>__le</tt> metamethod in both operands, like in the
--   less than operation. If it cannot find such a metamethod, then it will
--   try the <tt>__lt</tt> metamethod, assuming that a &lt;= b is
--   equivalent to not (b &lt; a). As with the other comparison operators,
--   the result is always a boolean. (This use of the <tt>__lt</tt> event
--   can be removed in future versions; it is also slower than a real __le
--   metamethod.)
Le :: Operation

-- | The indexing access operation <tt>table[key]</tt>. This event happens
--   when table is not a table or when key is not present in table. The
--   metamethod is looked up in table.
Index :: Operation

-- | The indexing assignment <tt>table[key] = value</tt>. 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.
Newindex :: Operation

-- | The call operation <tt>func(args)</tt>. 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.)
Call :: Operation

-- | The operation used to create a string representation of the object.
Tostring :: Operation

-- | the operation of iterating over the object's key-value pairs.
Pairs :: Operation

-- | a custom operation, with the metamethod name as parameter.
CustomOperation :: Name -> Operation


-- | This module provides types and functions to use Haskell values as
--   userdata objects in Lua. These objects wrap a Haskell value and
--   provide methods and properties to interact with the Haskell value.
--   
--   The terminology in this module refers to the userdata values as /UD
--   objects<i>, and to their type as </i>UD type/.
module HsLua.Packaging.UDType

-- | Type definitions containing documented functions.
type DocumentedType e a = UDType e (DocumentedFunction e) a

-- | A userdata type, capturing the behavior of Lua objects that wrap
--   Haskell values. The type name must be unique; once the type has been
--   used to push or retrieve a value, the behavior can no longer be
--   modified through this type.
type DocumentedTypeWithList e a itemtype = UDTypeWithList e (DocumentedFunction e) a itemtype

-- | Defines a new type, defining the behavior of objects in Lua. Note that
--   the type name must be unique.
deftype :: LuaError e => Name -> [(Operation, DocumentedFunction e)] -> [Member e (DocumentedFunction e) a] -> DocumentedType e a

-- | Defines a new type that could also be treated as a list; defines the
--   behavior of objects in Lua. Note that the type name must be unique.
deftype' :: LuaError e => Name -> [(Operation, DocumentedFunction e)] -> [Member e (DocumentedFunction e) a] -> Maybe (ListSpec e a itemtype) -> DocumentedTypeWithList e a itemtype

-- | Use a documented function as an object method.
method :: DocumentedFunction e -> Member e (DocumentedFunction e) a

-- | Declares a new read- and writable property.
property :: LuaError e => Name -> Text -> (Pusher e b, a -> b) -> (Peeker e b, a -> b -> a) -> Member e fn a

-- | Declares a new read- and writable property which is not always
--   available.
possibleProperty :: LuaError e => Name -> Text -> (Pusher e b, a -> Possible b) -> (Peeker e b, a -> b -> Possible a) -> Member e fn a

-- | Creates a read-only object property. Attempts to set the value will
--   cause an error.
readonly :: Name -> Text -> (Pusher e b, a -> b) -> Member e fn a

-- | Define an alias for another, possibly nested, property.
alias :: Name -> Text -> [AliasIndex] -> Member e fn a

-- | Declares a new object operation from a documented function.
operation :: Operation -> DocumentedFunction e -> (Operation, DocumentedFunction e)

-- | Retrieves a userdata value of the given type.
peekUD :: LuaError e => UDTypeWithList e fn a itemtype -> Peeker e a

-- | Pushes a userdata value of the given type.
pushUD :: LuaError e => UDTypeWithList e fn a itemtype -> a -> LuaE e ()

-- | Defines a function parameter that takes the given type.
udparam :: LuaError e => DocumentedTypeWithList e a itemtype -> Text -> Text -> Parameter e a

-- | A type member, either a method or a variable.
data Member e fn a

-- | Lua metadata operation types.
data Operation

-- | the addition (<tt>+</tt>) 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
--   <tt>__add</tt>, 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.
Add :: Operation

-- | the subtraction (<tt>-</tt>) operation. Behavior similar to the
--   addition operation.
Sub :: Operation

-- | the multiplication (<tt>*</tt>) operation. Behavior similar to the
--   addition operation.
Mul :: Operation

-- | the division (<tt>/</tt>) operation. Behavior similar to the addition
--   operation.
Div :: Operation

-- | the modulo (<tt>%</tt>) operation. Behavior similar to the addition
--   operation.
Mod :: Operation

-- | the exponentiation (<tt>^</tt>) operation. Behavior similar to the
--   addition operation.
Pow :: Operation

-- | the negation (unary <tt>-</tt>) operation. Behavior similar to the
--   addition operation.
Unm :: Operation

-- | the floor division (<tt>//</tt>) operation. Behavior similar to the
--   addition operation.
Idiv :: Operation

-- | the bitwise AND (<tt>&amp;</tt>) 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).
Band :: Operation

-- | the bitwise OR (<tt>|</tt>) operation. Behavior similar to the bitwise
--   AND operation.
Bor :: Operation

-- | the bitwise exclusive OR (binary <tt>~</tt>) operation. Behavior
--   similar to the bitwise AND operation.
Bxor :: Operation

-- | the bitwise NOT (unary <tt>~</tt>) operation. Behavior similar to the
--   bitwise AND operation.
Bnot :: Operation

-- | the bitwise left shift (<tt>&lt;&lt;</tt>) operation. Behavior similar
--   to the bitwise AND operation.
Shl :: Operation

-- | the bitwise right shift (<tt>&gt;&gt;</tt>) operation. Behavior
--   similar to the bitwise AND operation.
Shr :: Operation

-- | the concatenation (<tt>..</tt>) 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).
Concat :: Operation

-- | the length (<tt>#</tt>) 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.
Len :: Operation

-- | the equal (<tt>==</tt>) 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.
Eq :: Operation

-- | the less than (<tt>&lt;</tt>) 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.
Lt :: Operation

-- | the less equal (<tt>&lt;=</tt>) operation. Unlike other operations,
--   the less-equal operation can use two different events. First, Lua
--   looks for the <tt>__le</tt> metamethod in both operands, like in the
--   less than operation. If it cannot find such a metamethod, then it will
--   try the <tt>__lt</tt> metamethod, assuming that a &lt;= b is
--   equivalent to not (b &lt; a). As with the other comparison operators,
--   the result is always a boolean. (This use of the <tt>__lt</tt> event
--   can be removed in future versions; it is also slower than a real __le
--   metamethod.)
Le :: Operation

-- | The indexing access operation <tt>table[key]</tt>. This event happens
--   when table is not a table or when key is not present in table. The
--   metamethod is looked up in table.
Index :: Operation

-- | The indexing assignment <tt>table[key] = value</tt>. 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.
Newindex :: Operation

-- | The call operation <tt>func(args)</tt>. 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.)
Call :: Operation

-- | The operation used to create a string representation of the object.
Tostring :: Operation

-- | the operation of iterating over the object's key-value pairs.
Pairs :: Operation

-- | a custom operation, with the metamethod name as parameter.
CustomOperation :: Name -> Operation

-- | A read- and writable property on a UD object.
data Property e a

-- | A property or method which may be available in some instances but not
--   in others.
data Possible a
Actual :: a -> Possible a
Absent :: Possible a


-- | Tools to create Lua modules.
module HsLua.Packaging