Remove ScriptTypes and ScriptExtraHeaders headers

The first header was used to include the SpiderMonkey JS API at once, with safeguards and preprocessor defines. Nowadays, SpiderMonkey provides modular headers allowing us to include what we use, refs #8086. Some defines have to be moved to compiler options but it is apparently a mistake from the SM developers: https://bugzilla.mozilla.org/show_bug.cgi?id=1987876
2026-06-16 05:13:58 -07:00 · 2025-09-10 12:18:16 +02:00 · 2025-09-10 12:18:16 +02:00 · 9150c20818
commit 9150c20818
parent c4762e22cc
43 changed files with 35 additions and 138 deletions
--- a/build/premake/extern_libs5.lua
+++ b/build/premake/extern_libs5.lua
@ -643,6 +643,17 @@ extern_lib_defs = {
 	},
 	spidermonkey = {
 		compile_settings = function()
+			-- This define is not supposed to be needed anymore, but it leaks into the
+			-- SpiderMonkey headers, and is necessary to build with ESR140 at the time
+			-- of writing (https://bugzilla.mozilla.org/show_bug.cgi?id=1987876).
+			filter "system:windows"
+				defines { "XP_WIN" }
+			filter { }
+
+			filter "Debug"
+				defines { "MOZ_DIAGNOSTIC_ASSERT_ENABLED" }
+			filter {}
+
 			if _OPTIONS["with-system-mozjs"] then
 				if not _OPTIONS["android"] then
 					pkgconfig.add_includes_after("mozjs-128")
--- a/source/dapinterface/DapInterface.cpp
+++ b/source/dapinterface/DapInterface.cpp
@ -31,7 +31,6 @@
 #include "scriptinterface/Object.h"
 #include "scriptinterface/ScriptContext.h"
 #include "scriptinterface/ScriptExceptions.h"
-#include "scriptinterface/ScriptExtraHeaders.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "scriptinterface/ScriptRequest.h"

--- a/source/graphics/MapGenerator.h
+++ b/source/graphics/MapGenerator.h
@ -20,7 +20,6 @@

 #include "lib/file/vfs/vfs_path.h"
 #include "lib/types.h"
-#include "scriptinterface/ScriptTypes.h"
 #include "scriptinterface/StructuredClone.h"

 #include <atomic>
--- a/source/graphics/MapReader.h
+++ b/source/graphics/MapReader.h
@ -28,7 +28,6 @@
 #include "ps/CStr.h"
 #include "ps/Errors.h"
 #include "ps/FileIo.h"
-#include "scriptinterface/ScriptTypes.h"
 #include "simulation2/system/Entity.h"

 #include <cstddef>
--- a/source/gui/ObjectBases/IGUIObject.cpp
+++ b/source/gui/ObjectBases/IGUIObject.cpp
@ -31,7 +31,6 @@
 #include "ps/CLogger.h"
 #include "ps/Profiler2.h"
 #include "scriptinterface/Object.h"
-#include "scriptinterface/ScriptExtraHeaders.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "soundmanager/ISoundManager.h"

--- a/source/gui/ObjectBases/IGUIObject.h
+++ b/source/gui/ObjectBases/IGUIObject.h
@ -33,7 +33,6 @@
 #include "lib/input.h"
 #include "maths/Rect.h"
 #include "ps/CStr.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <js/RootingAPI.h>
 #include <js/TypeDecls.h>
--- a/source/gui/Scripting/JSInterface_CGUISize.cpp
+++ b/source/gui/Scripting/JSInterface_CGUISize.cpp
@ -33,7 +33,6 @@
 #include "scriptinterface/ScriptConversions.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "scriptinterface/ScriptRequest.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <fmt/format.h>
 #include <js/CallArgs.h>
--- a/source/gui/Scripting/JSInterface_GUIProxy.h
+++ b/source/gui/Scripting/JSInterface_GUIProxy.h
@ -20,10 +20,10 @@

 #include "gui/ObjectBases/IGUIObject.h"
 #include "lib/sysdep/compiler.h"
-#include "scriptinterface/ScriptExtraHeaders.h"

 #include <js/GCVector.h>
 #include <js/Id.h>
+#include <js/PropertyDescriptor.h>
 #include <js/Proxy.h>
 #include <js/RootingAPI.h>
 #include <js/TypeDecls.h>
--- a/source/gui/Scripting/JSInterface_GUIProxy_impl.h
+++ b/source/gui/Scripting/JSInterface_GUIProxy_impl.h
@ -26,7 +26,6 @@
 #include "scriptinterface/FunctionWrapper.h"
 #include "scriptinterface/Object.h"
 #include "scriptinterface/ScriptConversions.h"
-#include "scriptinterface/ScriptExtraHeaders.h"
 #include "scriptinterface/ScriptRequest.h"

 #include <js/CallAndConstruct.h>
--- a/source/gui/Scripting/JSInterface_GUISize.h
+++ b/source/gui/Scripting/JSInterface_GUISize.h
@ -22,7 +22,6 @@
 #include "lib/posix/posix_types.h"
 #include "lib/types.h"
 #include "ps/CStr.h"
-#include "scriptinterface/ScriptTypes.h"

 class ScriptInterface;
 namespace JS { class Value; }
--- a/source/lobby/IXmppClient.h
+++ b/source/lobby/IXmppClient.h
@ -19,8 +19,10 @@
 #define IXMPPCLIENT_H

 #include "lib/types.h"
-#include "scriptinterface/ScriptTypes.h"

+#include <js/Value.h>
+
+class ScriptInterface;
 class ScriptRequest;

 class IXmppClient
--- a/source/network/NetMessages.h
+++ b/source/network/NetMessages.h
@ -1,4 +1,4 @@
-/* Copyright (C) 2024 Wildfire Games.
+/* Copyright (C) 2025 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,6 @@
 #define NETMESSAGES_H

 #include "ps/CStr.h"
-#include "scriptinterface/ScriptTypes.h"

 #define PS_PROTOCOL_MAGIC                         0x5073013f	// 'P', 's', 0x01, '?'
 #define PS_PROTOCOL_MAGIC_RESPONSE                0x50630121	// 'P', 'c', 0x01, '!'
--- a/source/network/NetServer.h
+++ b/source/network/NetServer.h
@ -23,7 +23,6 @@
 #include "lib/types.h"
 #include "network/NetHost.h"
 #include "ps/CStr.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <ctime>
 #include <js/RootingAPI.h>
--- a/source/pch/engine/precompiled.h
+++ b/source/pch/engine/precompiled.h
@ -26,7 +26,6 @@
 #include "ps/Errors.h"
 #include "lib/file/vfs/vfs_path.h"
 #include "lib/file/vfs/vfs_util.h"
-#include "scriptinterface/ScriptTypes.h"
 #endif // CONFIG_ENABLE_PCH

 // IWYU pragma: end_keep
--- a/source/pch/graphics/precompiled.h
+++ b/source/pch/graphics/precompiled.h
@ -1,4 +1,4 @@
-/* Copyright (C) 2023 Wildfire Games.
+/* Copyright (C) 2025 Wildfire Games.
 * This file is part of 0 A.D.
 *
 * 0 A.D. is free software: you can redistribute it and/or modify
@ -18,6 +18,5 @@
 #include "lib/precompiled.h"	// common precompiled header

 // "graphics"-specific PCH:
-#include "scriptinterface/ScriptTypes.h"
 #include "ps/CStr.h"
 #include "maths/Matrix3D.h"
--- a/source/ps/Game.h
+++ b/source/ps/Game.h
@ -23,7 +23,6 @@
 #include "lib/types.h"
 #include "ps/CStr.h"
 #include "ps/Errors.h"
-#include "scriptinterface/ScriptTypes.h"
 #include "simulation2/helpers/Player.h"

 #include <algorithm>
--- a/source/ps/Replay.cpp
+++ b/source/ps/Replay.cpp
@ -42,7 +42,6 @@
 #include "scriptinterface/JSON.h"
 #include "scriptinterface/Object.h"
 #include "scriptinterface/ScriptContext.h"
-#include "scriptinterface/ScriptConversions.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "scriptinterface/ScriptRequest.h"
 #include "scriptinterface/ScriptStats.h"
@ -55,7 +54,6 @@

 #include <ctime>
 #include <fstream>
-#include <js/Value.h>
 #include <memory>

 /**
--- a/source/ps/Replay.h
+++ b/source/ps/Replay.h
@ -21,11 +21,11 @@
 #include "lib/code_annotation.h"
 #include "lib/os_path.h"
 #include "lib/types.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <iosfwd>
 #include <js/RootingAPI.h>
 #include <js/TypeDecls.h>
+#include <js/Value.h>
 #include <string>
 #include <vector>

--- a/source/ps/SavedGame.h
+++ b/source/ps/SavedGame.h
@ -19,7 +19,6 @@
 #define INCLUDED_SAVEDGAME

 #include "lib/status.h"
-#include "scriptinterface/ScriptTypes.h"
 #include "scriptinterface/StructuredClone.h"

 #include <js/Value.h>
--- a/source/ps/VisualReplay.h
+++ b/source/ps/VisualReplay.h
@ -19,7 +19,6 @@
 #define INCLUDED_VISUAL_REPLAY

 #include "lib/os_path.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <js/TypeDecls.h>

--- a/source/ps/scripting/JSInterface_VFS.h
+++ b/source/ps/scripting/JSInterface_VFS.h
@ -19,7 +19,6 @@
 #define INCLUDED_JSI_VFS

 #include "lib/types.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <js/PropertyDescriptor.h>

--- a/source/scriptinterface/JSON.cpp
+++ b/source/scriptinterface/JSON.cpp
@ -30,7 +30,6 @@
 #include "scriptinterface/FunctionWrapper.h"
 #include "scriptinterface/ScriptExceptions.h"
 #include "scriptinterface/ScriptRequest.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <js/Exception.h>
 #include <js/JSON.h>
--- a/source/scriptinterface/ModuleLoader.h
+++ b/source/scriptinterface/ModuleLoader.h
@ -20,7 +20,6 @@

 #include "lib/file/vfs/vfs_path.h"
 #include "lib/path.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <cstddef>
 #include <exception>
--- a/source/scriptinterface/Object.h
+++ b/source/scriptinterface/Object.h
@ -23,12 +23,12 @@
 #include "ps/CLogger.h"
 #include "scriptinterface/ScriptConversions.h"
 #include "scriptinterface/ScriptRequest.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <cwchar>
 #include <js/Array.h>
 #include <js/GCVector.h>
 #include <js/Id.h>
+#include <js/Object.h>
 #include <js/PropertyAndElement.h>
 #include <js/PropertyDescriptor.h>
 #include <js/RootingAPI.h>
--- a/source/scriptinterface/ScriptContext.cpp
+++ b/source/scriptinterface/ScriptContext.cpp
@ -29,7 +29,6 @@
 #include "scriptinterface/ModuleLoader.h"
 #include "scriptinterface/Promises.h"
 #include "scriptinterface/ScriptEngine.h"
-#include "scriptinterface/ScriptExtraHeaders.h"

 #include <js/Context.h>
 #include <js/GCAPI.h>
--- a/source/scriptinterface/ScriptContext.h
+++ b/source/scriptinterface/ScriptContext.h
@ -18,9 +18,6 @@
 #ifndef INCLUDED_SCRIPTCONTEXT
 #define INCLUDED_SCRIPTCONTEXT

-#include "scriptinterface/ScriptExtraHeaders.h"
-#include "scriptinterface/ScriptTypes.h"
-
 #include <cstdint>
 #include <list>
 #include <memory>
--- a/source/scriptinterface/ScriptConversions.cpp
+++ b/source/scriptinterface/ScriptConversions.cpp
@ -23,7 +23,6 @@
 #include "lib/path.h"
 #include "ps/CStr.h"
 #include "scriptinterface/ScriptExceptions.h"
-#include "scriptinterface/ScriptExtraHeaders.h"
 #include "scriptinterface/ScriptRequest.h"

 #include <cstddef>
--- a/source/scriptinterface/ScriptConversions.h
+++ b/source/scriptinterface/ScriptConversions.h
@ -23,7 +23,6 @@
 #include "lib/types.h"
 #include "ps/CStr.h"
 #include "scriptinterface/ScriptExceptions.h"
-#include "scriptinterface/ScriptExtraHeaders.h"
 #include "scriptinterface/ScriptRequest.h"

 #include <js/Array.h>
--- a/source/scriptinterface/ScriptEngine.h
+++ b/source/scriptinterface/ScriptEngine.h
@ -20,11 +20,17 @@

 #include "lib/debug.h"
 #include "ps/Singleton.h"
-#include "scriptinterface/ScriptTypes.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/source/scriptinterface/ScriptExtraHeaders.h
+++ b/source/scriptinterface/ScriptExtraHeaders.h
@ -1,48 +0,0 @@
-/* Copyright (C) 2025 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_SCRIPTEXTRAHEADERS
-#define INCLUDED_SCRIPTEXTRAHEADERS
-
-// Includes occasionally-used SpiderMonkey headers for typed arrays and debug API,
-// with appropriate tweaks to fix warnings and build errors. (Most code should
-// just include ScriptTypes.h directly to get the standard jsapi.h.)
-
-#include "scriptinterface/ScriptTypes.h"
-
-#include "jsfriendapi.h"
-
-#include "js/AllocPolicy.h"
-#include "js/Array.h"
-#include "js/ArrayBuffer.h"
-#include "js/CompilationAndEvaluation.h"
-#include "js/Conversions.h"
-#include "js/ContextOptions.h"
-#include "js/ForOfIterator.h"
-#include "js/GCAPI.h"
-#include "js/GCHashTable.h"
-#include "js/SourceText.h"
-#include "js/Proxy.h"
-#include "js/Warnings.h"
-
-#include "js/experimental/TypedData.h"
-
-#include "js/friend/ErrorMessages.h"
-
-#undef signbit
-
-#endif // INCLUDED_SCRIPTEXTRAHEADERS
--- a/source/scriptinterface/ScriptInterface.cpp
+++ b/source/scriptinterface/ScriptInterface.cpp
@ -33,7 +33,6 @@
 #include "scriptinterface/ModuleLoader.h"
 #include "scriptinterface/Object.h"
 #include "scriptinterface/ScriptContext.h"
-#include "scriptinterface/ScriptExtraHeaders.h"
 #include "scriptinterface/ScriptStats.h"
 #include "scriptinterface/StructuredClone.h"

--- a/source/scriptinterface/ScriptInterface.h
+++ b/source/scriptinterface/ScriptInterface.h
@ -24,7 +24,6 @@
 #include "scriptinterface/ScriptConversions.h"
 #include "scriptinterface/ScriptExceptions.h"
 #include "scriptinterface/ScriptRequest.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <functional>
 #include <js/CallArgs.h>
--- a/source/scriptinterface/ScriptTypes.h
+++ b/source/scriptinterface/ScriptTypes.h
@ -1,44 +0,0 @@
-/* Copyright (C) 2025 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_SCRIPTTYPES
-#define INCLUDED_SCRIPTTYPES
-
-#ifdef DEBUG
-#define MOZ_DIAGNOSTIC_ASSERT_ENABLED
-#endif
-
-#ifdef _WIN32
-# define XP_WIN
-# ifndef WIN32
-#  define WIN32 // SpiderMonkey expects this
-# endif
-#endif
-
-#include "jspubtd.h"
-#include "jsapi.h"
-
-#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
-
-class ScriptInterface;
-
-#endif // INCLUDED_SCRIPTTYPES
--- a/source/simulation2/components/ICmpAIManager.cpp
+++ b/source/simulation2/components/ICmpAIManager.cpp
@ -27,7 +27,6 @@
 #include "ps/Filesystem.h"
 #include "scriptinterface/JSON.h"
 #include "scriptinterface/Object.h"
-#include "scriptinterface/ScriptExtraHeaders.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "scriptinterface/ScriptRequest.h"
 #include "simulation2/system/InterfaceScripted.h"
--- a/source/simulation2/helpers/SimulationCommand.h
+++ b/source/simulation2/helpers/SimulationCommand.h
@ -18,7 +18,6 @@
 #ifndef INCLUDED_SIMULATIONCOMMAND
 #define INCLUDED_SIMULATIONCOMMAND

-#include "scriptinterface/ScriptTypes.h"
 #include "simulation2/helpers/Player.h"

 #include <js/RootingAPI.h>
--- a/source/simulation2/serialization/BinarySerializer.cpp
+++ b/source/simulation2/serialization/BinarySerializer.cpp
@ -23,7 +23,6 @@
 #include "ps/CLogger.h"
 #include "scriptinterface/FunctionWrapper.h"
 #include "scriptinterface/JSON.h"
-#include "scriptinterface/ScriptExtraHeaders.h"
 #include "scriptinterface/ScriptRequest.h"
 #include "simulation2/serialization/SerializedScriptTypes.h"

--- a/source/simulation2/serialization/BinarySerializer.h
+++ b/source/simulation2/serialization/BinarySerializer.h
@ -25,7 +25,6 @@
 #include "lib/debug.h"
 #include "lib/types.h"
 #include "maths/Fixed.h"
-#include "scriptinterface/ScriptExtraHeaders.h"
 #include "simulation2/system/Component.h"

 #include <cstddef>
--- a/source/simulation2/serialization/IDeserializer.h
+++ b/source/simulation2/serialization/IDeserializer.h
@ -21,7 +21,6 @@
 #include "lib/types.h"
 #include "maths/Fixed.h"
 #include "ps/Errors.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <cstddef>
 #include <cstdint>
--- a/source/simulation2/serialization/ISerializer.h
+++ b/source/simulation2/serialization/ISerializer.h
@ -21,7 +21,6 @@
 #include "lib/types.h"
 #include "maths/Fixed.h"
 #include "ps/Errors.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <cstddef>
 #include <cstdint>
--- a/source/simulation2/serialization/StdDeserializer.cpp
+++ b/source/simulation2/serialization/StdDeserializer.cpp
@ -25,7 +25,6 @@
 #include "lib/utf8.h"
 #include "ps/CStr.h"
 #include "scriptinterface/FunctionWrapper.h"
-#include "scriptinterface/ScriptExtraHeaders.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "scriptinterface/ScriptRequest.h"
 #include "simulation2/serialization/ISerializer.h"
--- a/source/simulation2/system/Message.h
+++ b/source/simulation2/system/Message.h
@ -19,7 +19,6 @@
 #define INCLUDED_MESSAGE

 #include "lib/code_annotation.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <js/RootingAPI.h>
 #include <js/TypeDecls.h>
--- a/source/simulation2/system/ParamNode.h
+++ b/source/simulation2/system/ParamNode.h
@ -22,7 +22,6 @@
 #include "lib/types.h"
 #include "maths/Fixed.h"
 #include "ps/Errors.h"
-#include "scriptinterface/ScriptTypes.h"

 #include <cstddef>
 #include <iosfwd>
--- a/source/tools/lint/cppcheck/suppressions-list.txt
+++ b/source/tools/lint/cppcheck/suppressions-list.txt
@ -6,6 +6,15 @@ cppcheckError:./source/lib/file/file_system.cpp

 *:source/third_party/*

+// Ignore SpiderMonkey version compile check
+
+preprocessorErrorDirective:source/scriptinterface/ScriptEngine.h
+
+// Lists of network/simulation messages are included in other files which define macros
+
+unknownMacro:source/network/NetMessages.h
+unknownMacro:source/simulation2/TypeList.h
+
 // Issues reported by cppcheck and not yet fixed

 danglingLifetime:source/lib/sysdep/os/unix/ufilesystem.cpp
@ -34,7 +43,6 @@ preprocessorErrorDirective:source/lib/sysdep/arch.h
 preprocessorErrorDirective:source/lib/sysdep/arch/x86_x64/x86_x64.h
 preprocessorErrorDirective:source/lib/sysdep/os/win/win.h
 preprocessorErrorDirective:source/network/NMTCreator.h
-preprocessorErrorDirective:source/scriptinterface/ScriptTypes.h
 preprocessorErrorDirective:source/tools/atlas/AtlasUI/CustomControls/Windows/AtlasWindow.h

 returnDanglingLifetime:source/lib/file/vfs/vfs_tree.cpp
@ -53,4 +61,3 @@ unknownMacro:source/lib/sysdep/os/win/wdbg_sym.cpp
 unknownMacro:source/lib/sysdep/os/win/wfirmware.cpp
 unknownMacro:source/lib/sysdep/os/win/wposix/wutsname.cpp
 unknownMacro:source/ps/CStr.cpp
-unknownMacro:source/simulation2/TypeList.h