aboutsummaryrefslogtreecommitdiff
path: root/engines/sword25/script/luascript.h
blob: dd0500a71003ae73658c6dd86311611d9e1fb462 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
// -----------------------------------------------------------------------------
// This file is part of Broken Sword 2.5
// Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsd�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�ck, ansonsten false.
	*/
	virtual bool Init();

	/**
		@brief L�dt eine Skriptdatei und f�hrt diese aus.
		@param FileName der Dateiname der Skriptdatei
		@return Gibt true bei Erfolg zur�ck, ansonsten false.
	*/
	virtual bool ExecuteFile(const std::string & FileName);

	/**
		@brief F�hrt einen String mit Skriptcode aus.
		@param Code ein String der Skriptcode enth�lt.
		@return Gibt true bei Erfolg zur�ck, ansonsten false.
	*/
	virtual bool ExecuteString(const std::string & Code);

	/**
		@brief Gibt einen Pointer auf das Hauptobjekt der Skriptsprache zur�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�r die Skriptumgebung zug�nglich.
		@param CommandLineParameters ein string vector der alle Kommandozeilenparameter enth�lt.
		@remark Auf welche Weise die Kommandozeilen-Parameter durch Skripte zugegriffen werden k�nnen h�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