diff options
| -rw-r--r-- | ChangeLog | 6 | ||||
| -rw-r--r-- | configure.ac | 7 | ||||
| -rw-r--r-- | src/Makefile.am | 8 | ||||
| -rw-r--r-- | src/resourcemanager.cpp | 8 | ||||
| -rw-r--r-- | src/script.cpp | 7 | ||||
| -rw-r--r-- | src/script.h | 69 | ||||
| -rw-r--r-- | src/scripting/lua.cpp | 145 | ||||
| -rw-r--r-- | src/scripting/script.cpp | 67 | ||||
| -rw-r--r-- | src/scripting/script.hpp | 84 |
9 files changed, 319 insertions, 82 deletions
@@ -4,6 +4,12 @@ existing slot. * src/skill.h, src/net/connectionhandler.cpp: Removed useless references to script header. + * src/script.cpp, src/script.h: Removed old scripting interface. + * src/resourcemanager.cpp: Allowed binary files to be used as strings. + * src/scripting/script.cpp, src/scripting/script.hpp: Added new + scripting interface. + * src/configure.ac, src/Makefile.am, src/scripting/lua.cpp: Added Lua + scripting engine. 2007-08-08 Guillaume Melquiond <guillaume.melquiond@gmail.com> diff --git a/configure.ac b/configure.ac index 9a885651..203e126c 100644 --- a/configure.ac +++ b/configure.ac @@ -107,7 +107,7 @@ AC_ARG_WITH( [scripting-engine], AS_HELP_STRING( [--with-scripting-engine=ARG], - [use scripting engine [[ARG=ruby,squirrel]] [(default=squirrel)]] + [use scripting engine [[ARG=ruby,squirrel,lua]] [(default=no)]] ), [], [with_scripting_engine="no"] @@ -134,6 +134,10 @@ elif test "$with_scripting_engine" = "squirrel"; then # there is no need to append -lsquirrel as it is already done by # AC_CHECK_LIB LIBS="$LIBS -lsqstdlib" +elif test "$with_scripting_engine" = "lua"; then + PKG_CHECK_MODULES(LUA, [lua5.1 >= 5.1]) + CXXFLAGS="$CXXFLAGS -DSCRIPT_SUPPORT -DLUA_SUPPORT $LUA_CFLAGS" + LIBS="$LIBS $LUA_LIBS" elif test "$with_scripting_engine" != "no"; then AC_MSG_ERROR([unknown scripting engine: $with_scripting_engine]) fi @@ -145,6 +149,7 @@ AM_CONDITIONAL(BUILD_SQLITE, test "$with_storage_backend" = "sqlite") AM_CONDITIONAL(BUILD_RUBY, test "$with_scripting_engine" = "ruby") AM_CONDITIONAL(BUILD_SQUIRREL, test "$with_scripting_engine" = "squirrel") +AM_CONDITIONAL(BUILD_LUA, test "$with_scripting_engine" = "lua") AC_CONFIG_FILES([Makefile src/Makefile]) diff --git a/src/Makefile.am b/src/Makefile.am index 9826bb1d..bbc64b84 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -133,6 +133,8 @@ tmwserv_game_SOURCES = \ net/messageout.cpp \ net/netcomputer.hpp \ net/netcomputer.cpp \ + scripting/script.hpp \ + scripting/script.cpp \ serialize/characterdata.hpp \ utils/base64.h \ utils/base64.cpp \ @@ -186,3 +188,9 @@ bindings_wrap.cpp: bindings.i tmwserv_game_SOURCES += \ bindings_wrap.cpp endif + +if BUILD_LUA +tmwserv_game_SOURCES += \ + scripting/lua.cpp +endif + diff --git a/src/resourcemanager.cpp b/src/resourcemanager.cpp index 41039ab1..d45e96e4 100644 --- a/src/resourcemanager.cpp +++ b/src/resourcemanager.cpp @@ -161,12 +161,14 @@ ResourceManager::loadFile(const std::string &fileName, int &fileSize) fileSize = PHYSFS_fileLength(file); // Allocate memory and load the file - void *buffer = malloc(fileSize); + void *buffer = malloc(fileSize + 1); PHYSFS_read(file, buffer, 1, fileSize); // Close the file and let the user deallocate the memory PHYSFS_close(file); + // Add a trailing nul character, so that the file can be used as a string + ((char *)buffer)[fileSize] = 0; return buffer; } @@ -183,10 +185,6 @@ ResourceManager::loadTextFile(const std::string &fileName) return lines; } - // Reallocate and include terminating 0 character - fileContents = (char*)realloc(fileContents, contentsLength + 1); - fileContents[contentsLength] = '\0'; - // Tokenize and add each line separately char *line = strtok(fileContents, "\n"); while (line != NULL) diff --git a/src/script.cpp b/src/script.cpp deleted file mode 100644 index 9d761eb8..00000000 --- a/src/script.cpp +++ /dev/null @@ -1,7 +0,0 @@ -#include "script.h" - -#ifdef SCRIPT_SUPPORT - -Script *script; - -#endif diff --git a/src/script.h b/src/script.h deleted file mode 100644 index ab851f38..00000000 --- a/src/script.h +++ /dev/null @@ -1,69 +0,0 @@ -/* - * The Mana World Server - * Copyright 2004 The Mana World Development Team - * - * This file is part of The Mana World. - * - * The Mana World 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 - * any later version. - * - * The Mana World 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 The Mana World; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - * - * $Id$ - */ - -#ifndef SCRIPT_H -#define SCRIPT_H - -#ifdef SCRIPT_SUPPORT - -#include <string> - -/* - * Script - * Script provides a simple class which is a simple interface - * for defining a scripting backend. Each Script object consists - * of an independant scripting environment. - * - * Requirements of Script Object: - * - Each script object is independant from any other script object. - * - A script is to be executed upon instantiation. - * - A initialization and destruction function should be executed in - * the script if such a function is defined (the interface should - * provide default methods in case they are missing or not needed.) - */ -class Script -{ - protected: - // Filename of the script corresponding to the script object - std::string scriptName; - - public: - Script(const std::string &file):scriptName(file) { } - - virtual ~Script() { } - - //State update - virtual void update() = 0; - - //Execute specified function - virtual bool execute(const std::string &) = 0; - - //Script sent raw message - virtual void message(char *) = 0; -}; - -extern Script *script; // Global script (temporary? - -#endif - -#endif diff --git a/src/scripting/lua.cpp b/src/scripting/lua.cpp new file mode 100644 index 00000000..b22d2879 --- /dev/null +++ b/src/scripting/lua.cpp @@ -0,0 +1,145 @@ +/* + * The Mana World Server + * Copyright 2007 The Mana World Development Team + * + * This file is part of The Mana World. + * + * The Mana World 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 + * any later version. + * + * The Mana World 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 The Mana World; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * $Id$ + */ + +#include <cassert> + +extern "C" { +#include <lualib.h> +#include <lauxlib.h> +} + +#include "resourcemanager.h" +#include "scripting/script.hpp" +#include "utils/logger.h" + +/** + * Implementation of the Script class for Lua. + */ +class LuaScript: public Script +{ + public: + + LuaScript(lua_State *); + + ~LuaScript(); + + void prepare(std::string const &); + + void push(int); + + void push(Character *); + + int execute(); + + private: + + lua_State *mState; + int nbArgs; +}; + +LuaScript::LuaScript(lua_State *s): + mState(s), + nbArgs(-1) +{ + luaL_openlibs(mState); + // A Lua state is like a function, so "execute" it in order to initialize it. + int res = lua_pcall(mState, 0, 0, 0); + if (res) + { + LOG_ERROR("Failure while initializing Lua script: " + << lua_tostring(mState, 0)); + } +} + +LuaScript::~LuaScript() +{ + lua_close(mState); +} + +void LuaScript::prepare(std::string const &name) +{ + assert(nbArgs == -1); + lua_getglobal(mState, name.c_str()); + nbArgs = 0; +} + +void LuaScript::push(int v) +{ + assert(nbArgs >= 0); + lua_pushinteger(mState, v); + ++nbArgs; +} + +void LuaScript::push(Character *v) +{ +} + +int LuaScript::execute() +{ + assert(nbArgs >= 0); + int res = lua_pcall(mState, nbArgs, 1, 0); + nbArgs = -1; + if (res || !lua_isnumber(mState, 0)) + { + LOG_ERROR("Failure while calling Lua function: " + << lua_tostring(mState, 0)); + return 0; + } + res = lua_tointeger(mState, 0); + lua_pop(mState, 1); + return res; +} + +static Script *loadScript(std::string const &filename) +{ + // Load the file through resource manager. + ResourceManager *resman = ResourceManager::getInstance(); + int fileSize; + char *buffer = (char *)resman->loadFile(filename, fileSize); + if (!buffer) return NULL; + + lua_State *s = luaL_newstate(); + int res = luaL_loadstring(s, buffer); + free(buffer); + + switch(res) + { + case 0: + LOG_INFO("Successfully loaded script " << filename); + return new LuaScript(s); + case LUA_ERRSYNTAX: + LOG_ERROR("Syntax error while loading script " << filename); + } + + lua_close(s); + return NULL; +} + +struct LuaRegister +{ + LuaRegister() { Script::registerEngine("lua", loadScript); } +}; + +static LuaRegister dummy; + + diff --git a/src/scripting/script.cpp b/src/scripting/script.cpp new file mode 100644 index 00000000..4d917273 --- /dev/null +++ b/src/scripting/script.cpp @@ -0,0 +1,67 @@ +/* + * The Mana World Server + * Copyright 2007 The Mana World Development Team + * + * This file is part of The Mana World. + * + * The Mana World 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 + * any later version. + * + * The Mana World 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 The Mana World; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * $Id$ + */ + +#include <map> + +#include "utils/logger.h" +#include "scripting/script.hpp" + +typedef std::map< std::string, Script::Factory > Engines; + +static Engines *engines = NULL; + +void Script::registerEngine(std::string const &name, Factory f) +{ + if (!engines) + { + /* The "engines" variable is a pointer instead of an object, because + this file may not have been initialized at the time this function + is called. So we take care of the initialization by hand, in order + to ensure we will not segfault at startup. */ + engines = new Engines; + } + (*engines)[name] = f; +} + +Script *Script::create(std::string const &engine, std::string const &file) +{ + Engines::const_iterator i = engines->find(engine); + if (i == engines->end()) + { + LOG_ERROR("No scripting engine named " << engine); + return NULL; + } + Script *s = i->second(file); + if (!s) + { + LOG_ERROR("Failure while loading script " << file); + } + return s; +} + +void Script::update() +{ + prepare("update"); + execute(); +} + diff --git a/src/scripting/script.hpp b/src/scripting/script.hpp new file mode 100644 index 00000000..c167dda6 --- /dev/null +++ b/src/scripting/script.hpp @@ -0,0 +1,84 @@ +/* + * The Mana World Server + * Copyright 2007 The Mana World Development Team + * + * This file is part of The Mana World. + * + * The Mana World 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 + * any later version. + * + * The Mana World 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 The Mana World; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * $Id$ + */ + +#ifndef _TMWSERV_SCRIPTING_SCRIPT_HPP +#define _TMWSERV_SCRIPTING_SCRIPT_HPP + +#include <string> + +class Character; + +/** + * Abstract interface for calling functions written in an external language. + */ +class Script +{ + public: + + typedef Script *(*Factory)(std::string const &); + + /** + * Registers a new scripting engine. + */ + static void registerEngine(std::string const &, Factory); + + /** + * Creates a new script. + */ + static Script *create(std::string const &engine, std::string const &file); + + virtual ~Script() {} + + /** + * Called every tick for the script to manage its data. + * Calls the "update" function of the script by default. + */ + virtual void update(); + + /** + * Prepares a call to the given function. + * Only one function can be prepared at once. + */ + virtual void prepare(std::string const &name) = 0; + + /** + * Pushes an integer argument for the function being prepared. + */ + virtual void push(int) = 0; + + /** + * Pushes a pointer to Character for the function being prepared. + * It usually is the character doing the action. The interface can + * pass the pointer as an opaque value to the scripting engine, if + * needed. + */ + virtual void push(Character *) = 0; + + /** + * Executes the function being prepared. + * @return the value returned by the script. + */ + virtual int execute() = 0; +}; + +#endif |