scummvm/engines/sword25/script/luascript.h

103 lines
3.6 KiB
C
Raw Normal View History

// -----------------------------------------------------------------------------
// This file is part of Broken Sword 2.5
// Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsd<73>rfer
//
// Broken Sword 2.5 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.
//
// Broken Sword 2.5 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 Broken Sword 2.5; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
// -----------------------------------------------------------------------------
#ifndef LUASCRIPT_H
#define LUASCRIPT_H
// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------
#include "kernel/common.h"
#include "script.h"
// -----------------------------------------------------------------------------
// Forward declarations
// -----------------------------------------------------------------------------
class BS_Kernel;
struct lua_State;
// -----------------------------------------------------------------------------
// Class declaration
// -----------------------------------------------------------------------------
class BS_LuaScriptEngine : public BS_ScriptEngine
{
public:
// -----------------------------------------------------------------------------
// Konstruktion / Destruktion
// -----------------------------------------------------------------------------
BS_LuaScriptEngine(BS_Kernel * KernelPtr);
virtual ~BS_LuaScriptEngine();
/**
@brief Initialisiert die Scriptengine.
@return Gibt true bei Erfolg zur<EFBFBD>ck, ansonsten false.
*/
virtual bool Init();
/**
@brief L<EFBFBD>dt eine Skriptdatei und f<EFBFBD>hrt diese aus.
@param FileName der Dateiname der Skriptdatei
@return Gibt true bei Erfolg zur<EFBFBD>ck, ansonsten false.
*/
virtual bool ExecuteFile(const std::string & FileName);
/**
@brief F<EFBFBD>hrt einen String mit Skriptcode aus.
@param Code ein String der Skriptcode enth<EFBFBD>lt.
@return Gibt true bei Erfolg zur<EFBFBD>ck, ansonsten false.
*/
virtual bool ExecuteString(const std::string & Code);
/**
@brief Gibt einen Pointer auf das Hauptobjekt der Skriptsprache zur<EFBFBD>ck.
@remark Durch die Benutzung dieser Methode wird die Kapselung der Sprache aufgehoben.
*/
virtual void * GetScriptObject() { return m_State; }
/**
@brief Macht die Kommandozeilen-Parameter f<EFBFBD>r die Skriptumgebung zug<EFBFBD>nglich.
@param CommandLineParameters ein string vector der alle Kommandozeilenparameter enth<EFBFBD>lt.
@remark Auf welche Weise die Kommandozeilen-Parameter durch Skripte zugegriffen werden k<EFBFBD>nnen h<EFBFBD>ngt von der jeweiligen Implementierung ab.
*/
virtual void SetCommandLine(const std::vector<std::string> & CommandLineParameters);
/**
@remark Der Lua-Stack wird durch diese Methode geleert.
*/
virtual bool Persist(BS_OutputPersistenceBlock & Writer);
/**
@remark Der Lua-Stack wird durch diese Methode geleert.
*/
virtual bool Unpersist(BS_InputPersistenceBlock & Reader);
private:
lua_State * m_State;
int m_PcallErrorhandlerRegistryIndex;
bool RegisterStandardLibs();
bool RegisterStandardLibExtensions();
bool ExecuteBuffer(const char * Data, unsigned int Size, const std::string & Name) const;
};
#endif