Files
vyordan ec8b420abc Move Script* classes to Script namespace
- Rename ScriptEngine, ScriptContext, ScriptInterface, ScriptRequest to
  Script::Engine, Script::Context, Script::Interface, Script::Request
- Remove 'Script' prefix from filenames:
  ScriptContext.* → Context.*
  ScriptInterface.* → Interface.*
  ScriptRequest.* → Request.*
  ScriptEngine.* → Engine.*
  ScriptConversions.* → Conversions.*
  ScriptExceptions.* → Exceptions.*
  ScriptForward.* → ForwardDeclarations.*
  ScriptStats.* → Stats.*
- Update all includes, forward declarations, and friend classes
- Use namespace Script { ... } in .cpp definitions to avoid repetitive
  Script:: prefix (keeping global callbacks outside)
- Rename internal implementation structs:
  ScriptInterface_impl → Interface_impl
  ScriptFunction → Function
- Update copyright year to 2026 in all touched files
- Suppress pre-existing cppcheck warnings (uninitvar, nullPointer, unknown
  macro) by adding them to suppressions-list.txt (these are not caused
  by this refactor)

Fixes #7516
2026-06-20 17:43:00 +02:00

72 lines
2.1 KiB
C++

/* Copyright (C) 2026 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_SCRIPT_ENGINE
#define INCLUDED_SCRIPT_ENGINE
#include "lib/debug.h"
#include "ps/Singleton.h"
#include <js/Initialization.h>
#include <list>
#if MOZJS_MAJOR_VERSION != 128
#error Your compiler is trying to use an incorrect major version of the \
SpiderMonkey library. The SpiderMonkey API is subject to changes, and the \
game will not build with the selected version of the library. Make sure \
you have got all the right files and include paths.
#endif
struct JSContext;
/**
* 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 contexts
* in order to validate the following constraints:
* 1. JS_Init must be called before any ScriptContexts are initialized
* 2. JS_Shutdown must be called after all ScriptContexts have been destroyed
*/
namespace Script
{
class Engine : public Singleton<Engine>
{
public:
Engine()
{
ENSURE(m_Contexts.empty() && "JS_Init must be called before any contexts are created!");
JS_Init();
}
~Engine()
{
ENSURE(m_Contexts.empty() && "All contexts must be destroyed before calling JS_ShutDown!");
JS_ShutDown();
}
void RegisterContext(const JSContext* cx) { m_Contexts.push_back(cx); }
void UnRegisterContext(const JSContext* cx) { m_Contexts.remove(cx); }
private:
std::list<const JSContext*> m_Contexts;
};
}
#endif // INCLUDED_SCRIPT_ENGINE