wowgetoffyourcellphone/0ad
1
0
Fork 0
forked from 0ad/0ad
Code Pull Requests Activity

Split ScriptRequest in its own header.

Browse Source 
We often only need to include ScriptRequest.h and not the full
ScriptInterface.h

Differential Revision: https://code.wildfiregames.com/D3920
This was SVN commit r25366.
This commit is contained in:
wraitii 2021-05-03 16:07:26 +00:00
parent 0406c4dfde
commit 34b1920e7b
20 changed files with 127 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
source/graphics/MapReader.h
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2020 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -24,7 +24,7 @@
#include "lib/res/handle.h"
#include "ps/CStr.h"
#include "ps/FileIo.h"
#include "scriptinterface/ScriptInterface.h"
#include "scriptinterface/ScriptTypes.h"
#include "simulation2/system/Entity.h"
class CObjectEntry;
@ -38,10 +38,11 @@ class CTriggerManager;
class CSimulation2;
class CSimContext;
class CTerrainTextureEntry;
class ScriptInterface;
class CGameView;
class CXMLReader;
class CMapGenerator;
class ScriptContext;
class ScriptInterface;
class CMapReader : public CMapIO
{

3
source/graphics/tests/test_LOSTexture.h
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2020 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -19,7 +19,6 @@
#include "graphics/LOSTexture.h"
#include "lib/timer.h"
#include "scriptinterface/ScriptInterface.h"
#include "simulation2/Simulation2.h"
#include "simulation2/helpers/Los.h"

3
source/gui/CGUI.h
View File

@ -32,7 +32,7 @@
#include "maths/Size2D.h"
#include "maths/Vector2D.h"
#include "ps/XML/Xeromyces.h"
#include "scriptinterface/ScriptInterface.h"
#include "scriptinterface/ScriptForward.h"
#include <map>
#include <unordered_map>
@ -47,7 +47,6 @@ class IGUIObject;
struct SGUIImageEffects;
struct SGUIScrollBarStyle;
namespace js { class BaseProxyHandler; }
class GUIProxyProps;
using map_pObjects = std::map<CStr, IGUIObject*>;

3
source/gui/CGUISetting.cpp
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2019 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -21,6 +21,7 @@
#include "gui/CGUI.h"
#include "ps/CLogger.h"
#include "scriptinterface/ScriptInterface.h"
template<typename T>

1
source/gui/ObjectTypes/CText.cpp
View File

@ -22,7 +22,6 @@
#include "gui/CGUI.h"
#include "gui/CGUIScrollBarVertical.h"
#include "gui/CGUIText.h"
#include "scriptinterface/ScriptInterface.h"
CText::CText(CGUI& pGUI)
: IGUIObject(pGUI),

2
source/i18n/scripting/JSInterface_L10n.cpp
View File

@ -23,7 +23,7 @@
#include "lib/utf8.h"
#include "ps/CLogger.h"
#include "scriptinterface/FunctionWrapper.h"
#include "scriptinterface/ScriptInterface.h"
#include "scriptinterface/ScriptRequest.h"
namespace JSI_L10n
{

2
source/network/StunClient.cpp
View File

@ -19,7 +19,6 @@
#include "precompiled.h"
#include "StunClient.h"
#include "scriptinterface/ScriptInterface.h"
#include <chrono>
#include <cstdio>
@ -44,7 +43,6 @@
#include "lib/sysdep/os/win/wposix/wtime.h"
#endif
#include "scriptinterface/ScriptInterface.h"
#include "ps/CLogger.h"
#include "ps/ConfigDB.h"
#include "ps/CStr.h"

3
source/pch/gui/precompiled.h
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2020 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -26,6 +26,5 @@
#include "gui/CGUI.h"
#include "gui/ObjectBases/IGUIObject.h"
#include "ps/CStr.h"
#include "scriptinterface/ScriptInterface.h"
#endif // CONFIG_ENABLE_PCH

4
source/ps/World.h
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2020 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -25,7 +25,6 @@
#define INCLUDED_WORLD
#include "ps/Errors.h"
#include "scriptinterface/ScriptInterface.h"
#ifndef ERROR_GROUP_GAME_DEFINED
#define ERROR_GROUP_GAME_DEFINED
@ -39,6 +38,7 @@ class CUnitManager;
class CTerrain;
class CStrW;
class CMapReader;
class ScriptContext;
/**
* CWorld is a general data class containing whatever is needed to accurately represent the world.

2
source/ps/scripting/JSInterface_ConfigDB.cpp
View File

@ -22,7 +22,7 @@
#include "ps/ConfigDB.h"
#include "ps/CLogger.h"
#include "scriptinterface/FunctionWrapper.h"
#include "scriptinterface/ScriptInterface.h"
#include "scriptinterface/ScriptRequest.h"
#include <string>
#include <unordered_set>

4
source/ps/scripting/JSInterface_Debug.cpp
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2020 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -23,7 +23,7 @@
#include "lib/svn_revision.h"
#include "lib/debug.h"
#include "scriptinterface/FunctionWrapper.h"
#include "scriptinterface/ScriptInterface.h"
#include "scriptinterface/ScriptRequest.h"
#include <ctime>
#include <string>

4
source/ps/scripting/JSInterface_UserReport.cpp
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2018 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -23,7 +23,7 @@
#include "ps/Pyrogenesis.h"
#include "ps/UserReport.h"
#include "scriptinterface/FunctionWrapper.h"
#include "scriptinterface/ScriptInterface.h"
#include "scriptinterface/ScriptRequest.h"
#include <string>

4
source/ps/scripting/JSInterface_VisualReplay.cpp
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2019 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -22,7 +22,7 @@
#include "ps/CStr.h"
#include "ps/VisualReplay.h"
#include "scriptinterface/FunctionWrapper.h"
#include "scriptinterface/ScriptInterface.h"
#include "scriptinterface/ScriptRequest.h"
namespace JSI_VisualReplay
{

1
source/renderer/Renderer.cpp
View File

@ -69,7 +69,6 @@
#include "renderer/TimeManager.h"
#include "renderer/VertexBufferManager.h"
#include "renderer/WaterManager.h"
#include "scriptinterface/ScriptInterface.h"
#include <algorithm>
#include <boost/algorithm/string.hpp>

13
source/scriptinterface/ScriptForward.h
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2020 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -36,6 +36,17 @@
#include "js/TypeDecls.h"
// Complete with a few additional ones.
namespace JS
{
class HandleValueArray;
}
namespace js {
class BaseProxyHandler;
}
class ScriptContext;
class ScriptInterface;
class ScriptRequest;

15
source/scriptinterface/ScriptInterface.cpp
View File

@ -71,11 +71,18 @@ struct ScriptInterface_impl
JS::PersistentRootedObject m_nativeScope; // native function scope object
};
/**
* Constructor for ScriptRequest - here because it needs access into ScriptInterface_impl.
*/
ScriptRequest::ScriptRequest(const ScriptInterface& scriptInterface) :
cx(scriptInterface.m->m_cx), nativeScope(scriptInterface.m->m_nativeScope)
cx(scriptInterface.m->m_cx), glob(scriptInterface.m->m_glob), nativeScope(scriptInterface.m->m_nativeScope)
{
m_formerRealm = JS::EnterRealm(cx, scriptInterface.m->m_glob);
glob = JS::CurrentGlobalOrNull(cx);
}
ScriptRequest::~ScriptRequest()
{
JS::LeaveRealm(cx, m_formerRealm);
}
JS::Value ScriptRequest::globalValue() const
@ -83,10 +90,6 @@ JS::Value ScriptRequest::globalValue() const
return JS::ObjectValue(*glob);
}
ScriptRequest::~ScriptRequest()
{
JS::LeaveRealm(cx, m_formerRealm);
}
namespace
{

29
source/scriptinterface/ScriptInterface.h
View File

@ -22,6 +22,7 @@
#include "maths/Fixed.h"
#include "ps/Errors.h"
#include "scriptinterface/ScriptExceptions.h"
#include "scriptinterface/ScriptRequest.h"
#include "scriptinterface/ScriptTypes.h"
#include <map>
@ -59,34 +60,6 @@ extern thread_local shared_ptr<ScriptContext> g_ScriptContext;
namespace boost { namespace random { class rand48; } }
/**
* RAII structure which encapsulates an access to the context and compartment of a ScriptInterface.
* This struct provides:
* - a pointer to the context, while acting like JSAutoRequest
* - a pointer to the global object of the compartment, while acting like JSAutoRealm
*
* This way, getting and using those pointers is safe with respect to the GC
* and to the separation of compartments.
*/
class ScriptRequest
{
public:
ScriptRequest() = delete;
ScriptRequest(const ScriptRequest& rq) = delete;
ScriptRequest& operator=(const ScriptRequest& rq) = delete;
ScriptRequest(const ScriptInterface& scriptInterface);
ScriptRequest(const ScriptInterface* scriptInterface) : ScriptRequest(*scriptInterface) {}
ScriptRequest(shared_ptr<ScriptInterface> scriptInterface) : ScriptRequest(*scriptInterface) {}
~ScriptRequest();
JS::Value globalValue() const;
JSContext* cx;
JSObject* glob;
JS::HandleObject nativeScope;
private:
JS::Realm* m_formerRealm;
};
/**
* Abstraction around a SpiderMonkey JS::Realm.
*

83
source/scriptinterface/ScriptRequest.h Normal file
View File

@ -0,0 +1,83 @@
/* Copyright (C) 2021 Wildfire Games.
* 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_SCRIPTREQUEST
#define INCLUDED_SCRIPTREQUEST
#include "scriptinterface/ScriptForward.h"
// Ignore warnings in SM headers.
#if GCC_VERSION || CLANG_VERSION
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wunused-parameter"
# pragma GCC diagnostic ignored "-Wnon-virtual-dtor"
#elif MSC_VERSION
# pragma warning(push, 1)
#endif
#include "js/RootingAPI.h"
#if GCC_VERSION || CLANG_VERSION
# pragma GCC diagnostic pop
#elif MSC_VERSION
# pragma warning(pop)
#endif
#include <memory>
class ScriptInterface;
/**
* Spidermonkey maintains some 'local' state via the JSContext* object.
* This object is an argument to most JSAPI functions.
* Furthermore, this state is Realm (~ global) dependent. For many reasons, including GC safety,
* The JSContext* Realm must be set up correctly when accessing it.
* 'Entering' and 'Leaving' realms must be done in a LIFO manner.
* SM recommends using JSAutoRealm, which provides an RAII option.
*
* ScriptRequest combines both of the above in a single convenient package,
* providing safe access to the JSContext*, the global object, and ensuring that the proper realm has been entered.
* Most scriptinterface/ functions will take a ScriptRequest, to ensure proper rooting. You may sometimes
* have to create one from a ScriptInterface.
*
* Be particularly careful when manipulating several script interfaces.
*/
class ScriptRequest
{
ScriptRequest() = delete;
ScriptRequest(const ScriptRequest& rq) = delete;
ScriptRequest& operator=(const ScriptRequest& rq) = delete;
public:
/**
* NB: the definitions are in scriptinterface.cpp, because these access members of the PImpled
* implementation of ScriptInterface, and that seemed more convenient.
*/
ScriptRequest(const ScriptInterface& scriptInterface);
ScriptRequest(const ScriptInterface* scriptInterface) : ScriptRequest(*scriptInterface) {}
ScriptRequest(std::shared_ptr<ScriptInterface> scriptInterface) : ScriptRequest(*scriptInterface) {}
~ScriptRequest();
JS::Value globalValue() const;
JSContext* cx;
JS::HandleObject glob;
JS::HandleObject nativeScope;
private:
JS::Realm* m_formerRealm;
};
#endif // INCLUDED_SCRIPTREQUEST

2
source/simulation2/system/ParamNode.cpp
View File

@ -24,7 +24,7 @@
#include "ps/CStr.h"
#include "ps/Filesystem.h"
#include "ps/XML/Xeromyces.h"
#include "scriptinterface/ScriptInterface.h"
#include "scriptinterface/ScriptRequest.h"
#include <sstream>

4
source/soundmanager/scripting/JSInterface_Sound.cpp
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2020 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -23,7 +23,7 @@
#include "maths/Vector3D.h"
#include "ps/Filesystem.h"
#include "scriptinterface/FunctionWrapper.h"
#include "scriptinterface/ScriptInterface.h"
#include "scriptinterface/ScriptRequest.h"
#include "soundmanager/SoundManager.h"
#include <sstream>