2020-11-11 09:43:13 +01:00
|
|
|
/* Copyright (C) 2020 Wildfire Games.
|
2010-01-09 20:20:14 +01:00
|
|
|
* This file is part of 0 A.D.
|
|
|
|
*
|
|
|
|
* 0 A.D. 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.
|
|
|
|
*
|
|
|
|
* 0 A.D. 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 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef INCLUDED_STDDESERIALIZER
|
|
|
|
#define INCLUDED_STDDESERIALIZER
|
|
|
|
|
|
|
|
#include "IDeserializer.h"
|
|
|
|
|
2010-05-25 21:24:14 +02:00
|
|
|
#include "ps/utf16string.h"
|
|
|
|
|
2010-01-09 20:20:14 +01:00
|
|
|
#include <map>
|
2020-12-09 15:39:14 +01:00
|
|
|
#include <vector>
|
2010-01-09 20:20:14 +01:00
|
|
|
|
|
|
|
class CStdDeserializer : public IDeserializer
|
|
|
|
{
|
|
|
|
NONCOPYABLE(CStdDeserializer);
|
|
|
|
public:
|
2017-08-24 02:32:42 +02:00
|
|
|
CStdDeserializer(const ScriptInterface& scriptInterface, std::istream& stream);
|
2010-01-09 20:20:14 +01:00
|
|
|
virtual ~CStdDeserializer();
|
|
|
|
|
2014-07-31 21:18:40 +02:00
|
|
|
virtual void ScriptVal(const char* name, JS::MutableHandleValue out);
|
|
|
|
virtual void ScriptObjectAppend(const char* name, JS::HandleValue objVal);
|
2015-01-24 15:46:52 +01:00
|
|
|
virtual void ScriptString(const char* name, JS::MutableHandleString out);
|
2010-01-09 20:20:14 +01:00
|
|
|
|
2011-01-12 13:29:00 +01:00
|
|
|
virtual std::istream& GetStream();
|
2011-12-22 15:04:32 +01:00
|
|
|
virtual void RequireBytesInStream(size_t numBytes);
|
2013-05-26 23:57:24 +02:00
|
|
|
|
2015-01-24 15:46:52 +01:00
|
|
|
static void Trace(JSTracer *trc, void *data);
|
|
|
|
|
|
|
|
void TraceMember(JSTracer *trc);
|
|
|
|
|
2010-01-09 20:20:14 +01:00
|
|
|
protected:
|
2011-10-27 22:10:53 +02:00
|
|
|
virtual void Get(const char* name, u8* data, size_t len);
|
2010-01-09 20:20:14 +01:00
|
|
|
|
|
|
|
private:
|
2017-08-28 12:27:36 +02:00
|
|
|
JS::Value ReadScriptVal(const char* name, JS::HandleObject appendParent);
|
2016-09-02 18:51:09 +02:00
|
|
|
void ReadStringLatin1(const char* name, std::vector<JS::Latin1Char>& str);
|
2011-10-27 22:10:53 +02:00
|
|
|
void ReadStringUTF16(const char* name, utf16string& str);
|
2010-01-09 20:20:14 +01:00
|
|
|
|
2015-01-24 15:46:52 +01:00
|
|
|
virtual void AddScriptBackref(JS::HandleObject obj);
|
Use Symbols to store JS object references when serialising and delete ObjectIDCache
When serialising JS objects, we keep track of any encountered object,
and serialize it only once. Any further serialisation instead stores an
ID referring to the original object (essentially an opaque pointer).
The trouble of course is to have a unique, persistent identifier for
such an object.
svn uses an ObjectIDCache, essentially a "JS Object -> ID" map (which
internally is essentially a "JS heap pointer -> ID" map).
JS, since ES15, includes a "Symbol" primitive type, which is a unique,
immutable identifier. They are also not iterable by for..in or
GetOwnPropertyName or related.
This means they can be used to store the tag directly on the object
(since it's impossible overwrite a user property).
Thanks to this, we can forgo ObjectIDCache in the serializers, and since
following D2897 it becomes unused, we can delete it, along with the
Finalization code it used.
Part of SM52 migration, stage: SM45-compatible changes.
Patch by: Itms
Tested By: Freagarach
Refs #4893
Differential Revision: https://code.wildfiregames.com/D3085
This was SVN commit r24167.
2020-11-12 07:40:19 +01:00
|
|
|
virtual void GetScriptBackref(size_t tag, JS::MutableHandleObject ret);
|
2015-01-24 15:46:52 +01:00
|
|
|
std::vector<JS::Heap<JSObject*> > m_ScriptBackrefs;
|
|
|
|
|
2017-08-24 02:32:42 +02:00
|
|
|
const ScriptInterface& m_ScriptInterface;
|
2010-01-09 20:20:14 +01:00
|
|
|
|
|
|
|
std::istream& m_Stream;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // INCLUDED_STDDESERIALIZER
|