mirror of
https://gitea.wildfiregames.com/0ad/0ad.git
synced 2026-06-21 16:44:50 +00:00
wraitii
ee0d204bf6
JSAutoRequest is required before calling into most JSAPI methods, for GC reasons. Calling it is required and fragile as one must not forget. Further, SM52 and later make manipulating JSContext* dangerous as that can cross Compartment(Realm in SM68) barriers (and ScriptInterface now matches a Compartment). The solution to both problems is to avoid using JSContext* in 0 A.D. itself. To achieve this, a Request class is introduced, and must be used to access a JSContext* from a scriptInterface. Further, Request is passed to other ScriptInterface functions isntead of JSContext*, making it obvious that the caller has already called it, reducing errors and redundant JSAutoRequest calls. Only JSNative functions now get a naked JSContext* without protection, but the likelihood of forgetting a request is lower since many ScriptInterface functions now expect it. JSContext* is directly passed to JSAPI functions only. Part of the SM52 migration, stage: SM45 compatible Based on a patch by: Itms Tested By: Freagarach Refs #4893 Differential Revision: https://code.wildfiregames.com/D3088 This was SVN commit r24176.
126 lines
4.9 KiB
C++
126 lines
4.9 KiB
C++
/* Copyright (C) 2020 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/>.
|
|
*/
|
|
|
|
#include "precompiled.h"
|
|
|
|
#include "JSInterface_SavedGame.h"
|
|
|
|
#include "network/NetClient.h"
|
|
#include "network/NetServer.h"
|
|
#include "ps/CLogger.h"
|
|
#include "ps/Game.h"
|
|
#include "ps/SavedGame.h"
|
|
#include "scriptinterface/ScriptInterface.h"
|
|
#include "simulation2/Simulation2.h"
|
|
#include "simulation2/system/TurnManager.h"
|
|
|
|
JS::Value JSI_SavedGame::GetSavedGames(ScriptInterface::CxPrivate* pCxPrivate)
|
|
{
|
|
return SavedGames::GetSavedGames(*(pCxPrivate->pScriptInterface));
|
|
}
|
|
|
|
bool JSI_SavedGame::DeleteSavedGame(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), const std::wstring& name)
|
|
{
|
|
return SavedGames::DeleteSavedGame(name);
|
|
}
|
|
|
|
void JSI_SavedGame::SaveGame(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& filename, const std::wstring& description, JS::HandleValue GUIMetadata)
|
|
{
|
|
shared_ptr<ScriptInterface::StructuredClone> GUIMetadataClone = pCxPrivate->pScriptInterface->WriteStructuredClone(GUIMetadata);
|
|
if (SavedGames::Save(filename, description, *g_Game->GetSimulation2(), GUIMetadataClone) < 0)
|
|
LOGERROR("Failed to save game");
|
|
}
|
|
|
|
void JSI_SavedGame::SaveGamePrefix(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& prefix, const std::wstring& description, JS::HandleValue GUIMetadata)
|
|
{
|
|
shared_ptr<ScriptInterface::StructuredClone> GUIMetadataClone = pCxPrivate->pScriptInterface->WriteStructuredClone(GUIMetadata);
|
|
if (SavedGames::SavePrefix(prefix, description, *g_Game->GetSimulation2(), GUIMetadataClone) < 0)
|
|
LOGERROR("Failed to save game");
|
|
}
|
|
|
|
void JSI_SavedGame::QuickSave(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), JS::HandleValue GUIMetadata)
|
|
{
|
|
if (g_NetServer || g_NetClient)
|
|
LOGERROR("Can't store quicksave during multiplayer!");
|
|
else if (g_Game)
|
|
g_Game->GetTurnManager()->QuickSave(GUIMetadata);
|
|
else
|
|
LOGERROR("Can't store quicksave if game is not running!");
|
|
}
|
|
|
|
void JSI_SavedGame::QuickLoad(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
|
|
{
|
|
if (g_NetServer || g_NetClient)
|
|
LOGERROR("Can't load quicksave during multiplayer!");
|
|
else if (g_Game)
|
|
g_Game->GetTurnManager()->QuickLoad();
|
|
else
|
|
LOGERROR("Can't load quicksave if game is not running!");
|
|
}
|
|
|
|
JS::Value JSI_SavedGame::StartSavedGame(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& name)
|
|
{
|
|
// We need to be careful with different compartments and contexts.
|
|
// The GUI calls this function from the GUI context and expects the return value in the same context.
|
|
// The game we start from here creates another context and expects data in this context.
|
|
|
|
ScriptInterface::Request rqGui(pCxPrivate);
|
|
|
|
ENSURE(!g_NetServer);
|
|
ENSURE(!g_NetClient);
|
|
|
|
ENSURE(!g_Game);
|
|
|
|
// Load the saved game data from disk
|
|
JS::RootedValue guiContextMetadata(rqGui.cx);
|
|
std::string savedState;
|
|
Status err = SavedGames::Load(name, *(pCxPrivate->pScriptInterface), &guiContextMetadata, savedState);
|
|
if (err < 0)
|
|
return JS::UndefinedValue();
|
|
|
|
g_Game = new CGame(true);
|
|
|
|
{
|
|
CSimulation2* sim = g_Game->GetSimulation2();
|
|
ScriptInterface::Request rqGame(sim->GetScriptInterface());
|
|
|
|
JS::RootedValue gameContextMetadata(rqGame.cx,
|
|
sim->GetScriptInterface().CloneValueFromOtherContext(*(pCxPrivate->pScriptInterface), guiContextMetadata));
|
|
JS::RootedValue gameInitAttributes(rqGame.cx);
|
|
sim->GetScriptInterface().GetProperty(gameContextMetadata, "initAttributes", &gameInitAttributes);
|
|
|
|
int playerID;
|
|
sim->GetScriptInterface().GetProperty(gameContextMetadata, "playerID", playerID);
|
|
|
|
g_Game->SetPlayerID(playerID);
|
|
g_Game->StartGame(&gameInitAttributes, savedState);
|
|
}
|
|
|
|
return guiContextMetadata;
|
|
}
|
|
|
|
void JSI_SavedGame::RegisterScriptFunctions(const ScriptInterface& scriptInterface)
|
|
{
|
|
scriptInterface.RegisterFunction<JS::Value, &GetSavedGames>("GetSavedGames");
|
|
scriptInterface.RegisterFunction<bool, std::wstring, &DeleteSavedGame>("DeleteSavedGame");
|
|
scriptInterface.RegisterFunction<void, std::wstring, std::wstring, JS::HandleValue, &SaveGame>("SaveGame");
|
|
scriptInterface.RegisterFunction<void, std::wstring, std::wstring, JS::HandleValue, &SaveGamePrefix>("SaveGamePrefix");
|
|
scriptInterface.RegisterFunction<void, JS::HandleValue, &QuickSave>("QuickSave");
|
|
scriptInterface.RegisterFunction<void, &QuickLoad>("QuickLoad");
|
|
scriptInterface.RegisterFunction<JS::Value, std::wstring, &StartSavedGame>("StartSavedGame");
|
|
}
|