Differential D3091 Diff 13906 ps/trunk/source/scriptinterface/ScriptEngine.h

Changeset View

Standalone View

ps/trunk/source/scriptinterface/ScriptEngine.h

	/* Copyright (C) 2019 Wildfire Games.			/* Copyright (C) 2020 Wildfire Games.
	* This file is part of 0 A.D.			* This file is part of 0 A.D.
	*			*
	* 0 A.D. is free software: you can redistribute it and/or modify			* 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			* it under the terms of the GNU General Public License as published by
	* the Free Software Foundation, either version 2 of the License, or			* the Free Software Foundation, either version 2 of the License, or
	* (at your option) any later version.			* (at your option) any later version.
	*			*
	* 0 A.D. is distributed in the hope that it will be useful,			* 0 A.D. is distributed in the hope that it will be useful,
	Show All 10 Lines

	#include "ScriptTypes.h"			#include "ScriptTypes.h"
	#include "ps/Singleton.h"			#include "ps/Singleton.h"

	#include "js/Initialization.h"			#include "js/Initialization.h"

	/**			/**
	* A class using the RAII (Resource Acquisition Is Initialization) idiom to manage initialization			* A class using the RAII (Resource Acquisition Is Initialization) idiom to manage initialization
	* and shutdown of the SpiderMonkey script engine. It also keeps a count of active script runtimes			* and shutdown of the SpiderMonkey script engine. It also keeps a count of active script contexts
	* in order to validate the following constraints:			* in order to validate the following constraints:
	* 1. JS_Init must be called before any ScriptRuntimes are initialized			* 1. JS_Init must be called before any ScriptContexts are initialized
	* 2. JS_Shutdown must be called after all ScriptRuntimes have been destroyed			* 2. JS_Shutdown must be called after all ScriptContexts have been destroyed
	*/			*/

	class ScriptEngine : public Singleton<ScriptEngine>			class ScriptEngine : public Singleton<ScriptEngine>
	{			{
	public:			public:
	ScriptEngine()			ScriptEngine()
	{			{
	ENSURE(m_Runtimes.empty() && "JS_Init must be called before any runtimes are created!");			ENSURE(m_Contexts.empty() && "JS_Init must be called before any contexts are created!");
	JS_Init();			JS_Init();
	}			}

	~ScriptEngine()			~ScriptEngine()
	{			{
	ENSURE(m_Runtimes.empty() && "All runtimes must be destroyed before calling JS_ShutDown!");			ENSURE(m_Contexts.empty() && "All contexts must be destroyed before calling JS_ShutDown!");
	JS_ShutDown();			JS_ShutDown();
	}			}

	void RegisterRuntime(const JSRuntime* rt) { m_Runtimes.push_back(rt); }			void RegisterContext(const JSContext* cx) { m_Contexts.push_back(cx); }
	void UnRegisterRuntime(const JSRuntime* rt) { m_Runtimes.remove(rt); }			void UnRegisterContext(const JSContext* cx) { m_Contexts.remove(cx); }

	private:			private:
	std::list<const JSRuntime*> m_Runtimes;			std::list<const JSContext*> m_Contexts;
	};			};

	#endif // INCLUDED_SCRIPTENGINE			#endif // INCLUDED_SCRIPTENGINE