{-# LANGUAGE OverloadedStrings #-}

module HsLua.Packaging.Module

( -- * Documented module

Module (..)

, Field (..)

, registerModule

, preloadModule

, preloadModuleWithName

, pushModule

, Operation (..)

)

import Control.Monad (forM_)

import HsLua.Core

import HsLua.Marshalling (Pusher, pushAsTable, pushList, pushName, pushText)

import HsLua.ObjectOrientation.Operation (Operation (..), metamethodName)

import HsLua.Packaging.Documentation

import HsLua.Packaging.Types

import qualified HsLua.Packaging.Function as Fun

-- | Create a new module (i.e., a Lua table).

create :: LuaE e ()

create = newtable

-- | Registers a 'Module'; leaves a copy of the module table on

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

registerModule mdl =

requirehs (moduleName mdl) (const (pushModule mdl))

-- | Add the module under a different name to the table of preloaded

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

preloadModuleWithName documentedModule name = preloadModule $

documentedModule { moduleName = name }

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

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

preloadModule mdl =

preloadhs (moduleName mdl) $ do

pushModule mdl

return (NumResults 1)

-- | Pushes a documented module to the Lua stack.

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

pushModule mdl = do

checkstack' 10 "pushModule"

pushAsTable

[ ("name", pushName . moduleName)

, ("description", pushText . moduleDescription)

, ("fields", pushList pushFieldDoc . moduleFields)

, ("types", pushTypesFunction . moduleTypeInitializers)

] mdl

create -- module table

pushvalue (nth 2) -- push documentation object

registerDocumentation (nth 2) -- set and pop doc

-- # Functions

--

-- module table now on top

-- documentation table in pos 2

newtable -- function documention

pushName "functions"

pushvalue (nth 2)

rawset (nth 5)

-- function documentation table now on top

-- module table in position 2

-- module documentation table in pos 3

forM_ (zip [1..] (moduleFunctions mdl)) $ \(i, fn) -> do

-- push documented function, thereby registering the function docs

Fun.pushDocumentedFunction fn

-- add function to module

pushName (functionName fn)

pushvalue (nth 2) -- C function

rawset (nth 5) -- module table

-- set documentation

_ <- getdocumentation top

rawseti (nth 3) i

pop 1 -- C Function

pop 1 -- function documentation table

remove (nth 2) -- module documentation table

-- # Fields

--

forM_ (moduleFields mdl) $ \field -> do

pushText (fieldName field)

fieldPushValue field

rawset (nth 3)

case moduleOperations mdl of

[] -> pure ()

ops -> do

-- create a metatable for this module and add operations

newtable

forM_ ops $ \(op, fn) -> do

pushName $ metamethodName op

Fun.pushDocumentedFunction $ Fun.setName "" fn

rawset (nth 3)

setmetatable (nth 2)

pushTypesFunction :: LuaError e => Pusher e [LuaE e Name]

pushTypesFunction initializers = pushHaskellFunction $ do

sequence initializers >>= pushList pushName

pure 1