Skip to content

Commit

Permalink
SWORD25: Move common functions to their own set of files so they can …
Browse files Browse the repository at this point in the history 
…be shared
  • Loading branch information
@RichieSams
RichieSams committed Dec 19, 2014
1 parent efcd619 commit dedfd7a
Show file tree
Hide file tree
Showing 3 changed files with 138 additions and 73 deletions.
77 changes: 77 additions & 0 deletions engines/sword25/util/lua_serialization_util.cpp
View file
@@ -0,0 +1,77 @@
/* 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 distri8buted 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.
*
*/

#include "sword25/util/lua_serialization_util.h"

#include "common/scummsys.h"

#include "lua/lobject.h"
#include "lua/lstate.h"
#include "lua/lgc.h"


namespace Lua {

void pushObject(lua_State *luaState, TValue *obj) {
setobj2s(luaState, luaState->top, obj);

api_check(luaState, luaState->top < luaState->ci->top);
luaState->top++;
}

void pushProto(lua_State *luaState, Proto *proto) {
TValue obj;
setptvalue(luaState, &obj, proto);

pushObject(luaState, &obj);
}

void pushUpValue(lua_State *luaState, UpVal *upval) {
TValue obj;

obj.value.gc = cast(GCObject *, upval);
obj.tt = LUA_TUPVAL;
checkliveness(G(L), obj);

pushObject(luaState, &obj);
}

void pushString(lua_State *luaState, TString *str) {
TValue o;
setsvalue(luaState, &o, str);

pushObject(luaState, &o);
}

/* A simple reimplementation of the unfortunately static function luaA_index.
* Does not support the global table, registry, or upvalues. */
StkId getObject(lua_State *luaState, int stackpos) {
if(stackpos > 0) {
lua_assert(luaState->base+stackpos-1 < luaState->top);
return luaState->base+stackpos-1;
} else {
lua_assert(L->top-stackpos >= L->base);
return luaState->top+stackpos;
}
}

} // End of namespace Lua
43 changes: 43 additions & 0 deletions engines/sword25/util/lua_serialization_util.h
View file
@@ -0,0 +1,43 @@
/* 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 distri8buted 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.
*
*/

#ifndef LUA_SERIALIZATION_UTIL_H
#define LUA_SERIALIZATION_UTIL_H


struct lua_State;

#include "lua/lobject.h"

typedef TValue *StkId;

namespace Lua {

void pushObject(lua_State *luaState, TValue *obj);
void pushProto(lua_State *luaState, Proto *proto);
void pushUpValue(lua_State *luaState, UpVal *upval);
void pushString(lua_State *luaState, TString *str);
StkId getObject(lua_State *luaState, int stackpos);

} // End of namespace Lua

#endif
91 changes: 18 additions & 73 deletions engines/sword25/util/lua_serializer.cpp
View file
Expand Up @@ -23,44 +23,19 @@
#include "sword25/util/lua_serialization.h"

#include "sword25/util/double_serializer.h"
#include "sword25/util/lua_serialization_util.h"

#include "common/stream.h"

#include "lua/lobject.h"
#include "lua/lstate.h"
#include "lua/lgc.h"


namespace Lua {

#define NUMTYPES 9

static const char* typenames[] = {
"nil",
"boolean",
"lightuserdata",
"number",
"string",
"table",
"function",
"userdata",
"thread"
};

#define PERMANENT_TYPE 101

/* A simple reimplementation of the unfortunately static function luaA_index.
* Does not support the global table, registry, or upvalues. */
static StkId getobject(lua_State *luaState, int stackpos) {
if(stackpos > 0) {
lua_assert(luaState->base+stackpos-1 < luaState->top);
return luaState->base+stackpos-1;
} else {
lua_assert(L->top-stackpos >= L->base);
return luaState->top+stackpos;
}
}


struct SerializationInfo {
lua_State *luaState;
Common::WriteStream *writeStream;
Expand All @@ -70,7 +45,6 @@ struct SerializationInfo {
static void serializeObject(SerializationInfo *info);

static void serializeBoolean(SerializationInfo *info);
static void serializeLightUserData(SerializationInfo *info);
static void serializeNumber(SerializationInfo *info);
static void serializeString(SerializationInfo *info);
static void serializeTable(SerializationInfo *info);
Expand Down Expand Up @@ -319,13 +293,15 @@ static bool serializeSpecialObject(SerializationInfo *info, bool defaction) {
// Check whether we should persist literally, or via the __persist metafunction
if (!lua_getmetatable(info->luaState, -1)) {
if (defaction) {
// Write out a flag declaring that the metatable doesn't exist
// Write out a flag declaring that the object isn't special and should be persisted normally
info->writeStream->writeSint32LE(0);

return false;
} else {
lua_pushstring(info->luaState, "Type not literally persistable by default");
lua_error(info->luaState);

return false; // Not reached
}
}

Expand All @@ -342,21 +318,21 @@ static bool serializeSpecialObject(SerializationInfo *info, bool defaction) {
// >>>>> permTbl indexTbl ...... obj

if (defaction) {
// Write out a flag declaring there is no persistence metafunction
// Write out a flag declaring that the object isn't special and should be persisted normally
info->writeStream->writeSint32LE(0);

return 0;
return false;
} else {
lua_pushstring(info->luaState, "Type not literally persistable by default");
lua_error(info->luaState);

return 0; /* not reached */
return false; // Return false
}

} else if (lua_isboolean(info->luaState, -1)) {
// >>>>> permTbl indexTbl ...... obj metaTbl bool
if (lua_toboolean(info->luaState, -1)) {
// Write out a flag declaring such
// Write out a flag declaring that the object isn't special and should be persisted normally
info->writeStream->writeSint32LE(0);

// >>>>> permTbl indexTbl ...... obj metaTbl true */
Expand All @@ -368,7 +344,7 @@ static bool serializeSpecialObject(SerializationInfo *info, bool defaction) {
lua_pushstring(info->luaState, "Metatable forbade persistence");
lua_error(info->luaState);

return false; /* not reached */
return false; // Not reached
}
} else if (!lua_isfunction(info->luaState, -1)) {
lua_pushstring(info->luaState, "__persist not nil, boolean, or function");
Expand Down Expand Up @@ -460,40 +436,9 @@ static void serializeTable(SerializationInfo *info) {
// >>>>> permTbl indexTbl ...... tbl
}

static void pushObject(lua_State *luaState, TValue *obj) {
setobj2s(luaState, luaState->top, obj);

api_check(luaState, luaState->top < luaState->ci->top);
luaState->top++;
}

static void pushProto(lua_State *luaState, Proto *proto) {
TValue obj;
setptvalue(luaState, &obj, proto);

pushObject(luaState, &obj);
}

static void pushUpVal(lua_State *luaState, UpVal *upval) {
TValue obj;

obj.value.gc = cast(GCObject *, upval);
obj.tt = LUA_TUPVAL;
checkliveness(G(L), obj);

pushObject(luaState, &obj);
}

static void pushString(lua_State *luaState, TString *str) {
TValue o;
setsvalue(luaState, &o, str);

pushObject(luaState, &o);
}

static void serializeFunction(SerializationInfo *info) {
// >>>>> permTbl indexTbl ...... func
Closure *cl = clvalue(getobject(info->luaState, -1));
Closure *cl = clvalue(getObject(info->luaState, -1));
lua_checkstack(info->luaState, 2);

if (cl->c.isC) {
Expand All @@ -520,7 +465,7 @@ static void serializeFunction(SerializationInfo *info) {
// Serialize upvalue values (not the upvalue objects themselves)
for (byte i=0; i<cl->l.p->nups; i++) {
// >>>>> permTbl indexTbl ...... func
pushUpVal(info->luaState, cl->l.upvals[i]);
pushUpValue(info->luaState, cl->l.upvals[i]);
// >>>>> permTbl indexTbl ...... func upval

serializeObject(info);
Expand Down Expand Up @@ -580,7 +525,7 @@ static void serializeThread(SerializationInfo *info) {
// Persist the stack

// We *could* have truncation here, but if we have more than 4 billion items on a stack, we have bigger problems
uint stackSize = static_cast<uint32>(appendStackToStack_rev(threadState, info->luaState));
uint32 stackSize = static_cast<uint32>(appendStackToStack_rev(threadState, info->luaState));
info->writeStream->writeUint32LE(stackSize);

// >>>>> permTbl indexTbl ...... thread (reversed contents of thread stack) */
Expand Down Expand Up @@ -644,7 +589,7 @@ static void serializeThread(SerializationInfo *info) {
/* Make sure upvalue is really open */
assert(upVal->v != &upVal->u.value);

pushUpVal(info->luaState, upVal);
pushUpValue(info->luaState, upVal);
// >>>>> permTbl indexTbl ...... thread upVal

serializeObject(info);
Expand All @@ -670,7 +615,7 @@ static void serializeThread(SerializationInfo *info) {

static void serializeProto(SerializationInfo *info) {
// >>>>> permTbl indexTbl ...... proto
Proto *proto = gco2p(getobject(info->luaState, -1)->value.gc);
Proto *proto = gco2p(getObject(info->luaState, -1)->value.gc);

// Make sure there is enough room on the stack
lua_checkstack(info->luaState, 2);
Expand Down Expand Up @@ -797,8 +742,8 @@ static void serializeProto(SerializationInfo *info) {
*/
static void serializeUpValue(SerializationInfo *info) {
// >>>>> permTbl indexTbl ...... upval
assert(ttype(getobject(info->luaState, -1)) == LUA_TUPVAL);
UpVal *upValue = gco2uv(getobject(info->luaState, -1)->value.gc);
assert(ttype(getObject(info->luaState, -1)) == LUA_TUPVAL);
UpVal *upValue = gco2uv(getObject(info->luaState, -1)->value.gc);

// Make sure there is enough room on the stack
lua_checkstack(info->luaState, 1);
Expand Down Expand Up @@ -831,7 +776,7 @@ static void serializeUserData(SerializationInfo *info) {

// Hard cast to a uint32 length
// This could lead to truncation, but if we have a 4gb block of data, we have bigger problems
uint32 length = static_cast<uint32>(uvalue(getobject(info->luaState, -1))->len);
uint32 length = static_cast<uint32>(uvalue(getObject(info->luaState, -1))->len);
info->writeStream->writeUint32LE(length);

info->writeStream->write(lua_touserdata(info->luaState, -1), length);
Expand Down

0 comments on commit dedfd7a

Please sign in to comment.