scummvm/engines/sword25/script/luabindhelper.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $URL$
 * $Id$
 *
 */

/* 
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#ifndef SWORD25_LUABINDHELPER_H
#define SWORD25_LUABINDHELPER_H

#include "sword25/kernel/common.h"

extern "C"
{
	#include "sword25/util/lua/lua.h"
	#include "sword25/util/lua/lauxlib.h"
}

#define lua_pushbooleancpp(L, b) (lua_pushboolean(L, b ? 1 : 0))
#define lua_tobooleancpp(L, i) (lua_toboolean(L, i) == 0 ? false : true)

struct lua_constant_reg
{
	const char *	Name;
	lua_Number		Value;
};

class BS_LuaBindhelper
{
public:
	/**
		@brief Registriert eine Menge von Funktionen und f<EFBFBD>gt dieser einer Lua-Library hinzu.
		@param L ein Pointer auf die Lua-VM in der die Funktionen registriert werden sollen
		@param LibName der Name der Library.<br>
					   Wenn dies ein Leerer String ist, werden die Funktionen zum globalen Namensraum hinzugef<EFBFBD>gt.
		@param Functions ein Array das die Funktionspointer mit ihren Namen enth<EFBFBD>lt.<br>
						 Das Array muss mit dem Eintrag {0, 0} terminiert sein.
		@return Gibt true bei Erfolg zur<EFBFBD>ck, ansonsten false.
	*/
	static bool AddFunctionsToLib(lua_State * L, const Common::String & LibName, const luaL_reg * Functions);

	/**
		@brief F<EFBFBD>gt eine Menge von Konstanten einer Lua-Library hinzu.
		@param L ein Pointer auf die Lua-VM in der die Konstanten registriert werden sollen
		@param LibName der Name der Library.<br>
					   Wenn dies ein Leerer String ist, werden die Konstanten zum globalen Namensraum hinzugef<EFBFBD>gt.
		@param Constants ein Array das die Werte der Konstanten mit ihren Namen enth<EFBFBD>lt.<br
						 Das Array muss mit dem Eintrag {0, 0} terminiert sein.
		@return Gibt true bei Erfolg zur<EFBFBD>ck, ansonsten false.
	*/
	static bool AddConstantsToLib(lua_State * L, const Common::String & LibName, const lua_constant_reg * Constants);

	/**
	    @brief F<EFBFBD>gt eine Menge von Methoden zu einer Lua-Klasse hinzu.
		@param L ein Pointer auf die Lua-VM in der die Methoden registriert werden sollen
		@param ClassName der Name der Metatable der Klasse.<br>
						 Wenn die Metatable noch nicht existiert, wird sie erstellt.
		@param Methods ein Array das die Funktionspointer der Methoden mit ihren Namen enth<EFBFBD>lt.<br>
					   Das Array muss mit dem Eintrag {0, 0} terminiert sein.
		@return Gibt true bei Erfolg zur<EFBFBD>ck, ansonsten false.
	*/
	static bool AddMethodsToClass(lua_State *L, const Common::String &ClassName, const luaL_reg *Methods);

	/**
	    @brief Legt eine Funktion fest, die aufgerufen wird, wenn Exemplare einer bestimmten Lua-Klasse vom Garbage-Collecter gel<EFBFBD>scht werden.
		@param L ein Pointer auf die Lua-VM
		@param ClassName der Name der Metatable der Klasse.<br>
						 Wenn die Metatable noch nicht existiert, wird sie erstellt.
		@param GCHandler ein Funktionspointer auf die Funktion.
		@return Gibt true bei Erfolg zur<EFBFBD>ck, ansonsten false.
	*/
	static bool SetClassGCHandler(lua_State *L, const Common::String &ClassName, lua_CFunction GCHandler);

	/**
		@brief Gibt einen String zur<EFBFBD>ck, der einen Stackdump des Lua-Stacks enth<EFBFBD>lt.

		@param L ein Pointer auf die Lua-VM.
	*/
	static Common::String StackDump(lua_State *L);

	/**
		@brief Gibt einen String zur<EFBFBD>ck, den den Inhalt einer Tabelle beschreibt.

        @param L ein Pointer auf die Lua-VM.
		@remark Auf dem Lua-Stack muss die Tabelle liegen, die ausgelesen werden soll.
	*/
	static Common::String TableDump(lua_State *L);

	static bool GetMetatable(lua_State *L, const Common::String &TableName);

private:
	static bool _CreateTable(lua_State *L, const Common::String &TableName);
};

#endif