split plugin lua macros to separate header

ab9rf · ab9rf · commit e558da1b1941 · 2024-12-31T17:42:35.000-06:00
this will reduce the number of translation units that require the includes from the lua dependency
diff --git a/library/CMakeLists.txt b/library/CMakeLists.txt
@@ -71,6 +71,7 @@ set(MAIN_HEADERS
     include/Module.h
     include/MemAccess.h
     include/ModuleFactory.h
+    include/PluginLua.h
     include/PluginManager.h
     include/PluginStatics.h
     include/RemoteClient.h
diff --git a/library/VTableInterpose.cpp b/library/VTableInterpose.cpp
@@ -29,8 +29,9 @@ distribution.
 #include <vector>
 #include <map>
 
-#include "MemAccess.h"
 #include "Core.h"
+#include "DataFuncs.h"
+#include "MemAccess.h"
 #include "VersionInfo.h"
 #include "VTableInterpose.h"
 
diff --git a/library/include/PluginLua.h b/library/include/PluginLua.h
@@ -0,0 +1,19 @@
+/*
+ * Additional macros for calling Lua from a plugin
+ */
+
+#pragma once
+
+#include "DataFuncs.h"
+
+#define DFHACK_PLUGIN_LUA_COMMANDS \
+    DFhackCExport const DFHack::CommandReg plugin_lua_commands[] =
+#define DFHACK_PLUGIN_LUA_FUNCTIONS \
+    DFhackCExport const DFHack::FunctionReg plugin_lua_functions[] =
+#define DFHACK_PLUGIN_LUA_EVENTS \
+    DFhackCExport const DFHack::EventReg plugin_lua_events[] =
+
+#define DFHACK_LUA_COMMAND(name) { #name, name }
+#define DFHACK_LUA_FUNCTION(name) { #name, df::wrap_function(name,true) }
+#define DFHACK_LUA_EVENT(name) { #name, &name##_event }
+#define DFHACK_LUA_END { NULL, NULL }
diff --git a/library/include/PluginManager.h b/library/include/PluginManager.h
@@ -34,7 +34,6 @@ distribution.
 #include <vector>
 
 #include "Core.h"
-#include "DataFuncs.h"
 
 typedef struct lua_State lua_State;
 
@@ -324,19 +323,6 @@ extern "C" { \
     DFhackDataExport bool plugin_is_enabled = false; \
     bool &varname = plugin_is_enabled;
 
-#define DFHACK_PLUGIN_LUA_COMMANDS \
-    DFhackCExport const DFHack::CommandReg plugin_lua_commands[] =
-#define DFHACK_PLUGIN_LUA_FUNCTIONS \
-    DFhackCExport const DFHack::FunctionReg plugin_lua_functions[] =
-#define DFHACK_PLUGIN_LUA_EVENTS \
-    DFhackCExport const DFHack::EventReg plugin_lua_events[] =
-
-#define DFHACK_LUA_COMMAND(name) { #name, name }
-#define DFHACK_LUA_FUNCTION(name) { #name, df::wrap_function(name,true) }
-#define DFHACK_LUA_EVENT(name) { #name, &name##_event }
-#define DFHACK_LUA_END { NULL, NULL }
-
-
 #define REQUIRE_GLOBAL_NO_USE(global_name) \
     static int VARIABLE_IS_NOT_USED CONCAT_TOKENS(required_globals_, __LINE__) = \
         (plugin_globals->push_back(#global_name), 0);
diff --git a/plugins/aquifer.cpp b/plugins/aquifer.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Maps.h"
diff --git a/plugins/autobutcher.cpp b/plugins/autobutcher.cpp
@@ -7,6 +7,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Persistence.h"
 #include "modules/Units.h"
diff --git a/plugins/autochop.cpp b/plugins/autochop.cpp
@@ -3,6 +3,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Burrows.h"
diff --git a/plugins/autoclothing.cpp b/plugins/autoclothing.cpp
@@ -2,6 +2,7 @@
 
 #include "Debug.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Items.h"
 #include "modules/Materials.h"
diff --git a/plugins/autonestbox.cpp b/plugins/autonestbox.cpp
@@ -7,6 +7,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Buildings.h"
 #include "modules/Gui.h"
diff --git a/plugins/blueprint.cpp b/plugins/blueprint.cpp
@@ -15,6 +15,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Buildings.h"
diff --git a/plugins/buildingplan/buildingplan.cpp b/plugins/buildingplan/buildingplan.cpp
@@ -6,6 +6,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Burrows.h"
 #include "modules/World.h"
diff --git a/plugins/burrow.cpp b/plugins/burrow.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Burrows.h"
diff --git a/plugins/cxxrandom.cpp b/plugins/cxxrandom.cpp
@@ -25,11 +25,12 @@ Updated: Dec. 21 2017
 #include <stdio.h>
 #include <stdlib.h>
 
+#include "Console.h"
 #include "Error.h"
+#include "Export.h"
 #include "DataFuncs.h"
-#include <Console.h>
-#include <Export.h>
-#include <PluginManager.h>
+#include "PluginManager.h"
+#include "PluginLua.h"
 
 using namespace DFHack;
 DFHACK_PLUGIN("cxxrandom");
diff --git a/plugins/design.cpp b/plugins/design.cpp
@@ -9,6 +9,8 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
+
 #include "df/graphic_viewportst.h"
 #include "df/world.h"
 #include "modules/Gui.h"
diff --git a/plugins/dig-now.cpp b/plugins/dig-now.cpp
@@ -6,6 +6,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Buildings.h"
diff --git a/plugins/dig.cpp b/plugins/dig.cpp
@@ -2,6 +2,7 @@
 #include "LuaTools.h"
 #include "MemAccess.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/EventManager.h"
 #include "modules/Gui.h"
diff --git a/plugins/dwarfvet.cpp b/plugins/dwarfvet.cpp
@@ -23,6 +23,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Persistence.h"
 #include "modules/Units.h"
diff --git a/plugins/eventful.cpp b/plugins/eventful.cpp
@@ -4,6 +4,7 @@
 #include "LuaTools.h"
 #include "MiscUtils.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "VTableInterpose.h"
 
 #include "df/building.h"
diff --git a/plugins/fix-occupancy.cpp b/plugins/fix-occupancy.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Buildings.h"
 #include "modules/Maps.h"
diff --git a/plugins/hotkeys.cpp b/plugins/hotkeys.cpp
@@ -8,6 +8,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 DFHACK_PLUGIN("hotkeys");
 
diff --git a/plugins/infinite-sky.cpp b/plugins/infinite-sky.cpp
@@ -2,6 +2,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/EventManager.h"
 #include "modules/Maps.h"
diff --git a/plugins/liquids.cpp b/plugins/liquids.cpp
@@ -24,6 +24,7 @@
 #include "Export.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Gui.h"
diff --git a/plugins/logistics.cpp b/plugins/logistics.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Buildings.h"
 #include "modules/Job.h"
diff --git a/plugins/luasocket.cpp b/plugins/luasocket.cpp
@@ -1,6 +1,7 @@
 #include "Console.h"
 #include "Export.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "DataDefs.h"
 
 #include <vector>
diff --git a/plugins/misery.cpp b/plugins/misery.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Persistence.h"
 #include "modules/Units.h"
diff --git a/plugins/overlay.cpp b/plugins/overlay.cpp
@@ -22,6 +22,7 @@
 #include "LuaTools.h"
 #include "MemAccess.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "VTableInterpose.h"
 
 #include "modules/Gui.h"
diff --git a/plugins/pathable.cpp b/plugins/pathable.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "Error.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "df/building_type.h"
diff --git a/plugins/plant.cpp b/plugins/plant.cpp
@@ -4,6 +4,7 @@
 #include "Error.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Gui.h"
diff --git a/plugins/preserve-rooms.cpp b/plugins/preserve-rooms.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Buildings.h"
 #include "modules/EventManager.h"
diff --git a/plugins/prospector.cpp b/plugins/prospector.cpp
@@ -4,6 +4,7 @@
 #include "Export.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "MiscUtils.h"
 #include "DataDefs.h"
 
diff --git a/plugins/regrass.cpp b/plugins/regrass.cpp
@@ -5,6 +5,7 @@
 #include "Error.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Gui.h"
diff --git a/plugins/reveal.cpp b/plugins/reveal.cpp
@@ -1,4 +1,5 @@
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/EventManager.h"
diff --git a/plugins/seedwatch.cpp b/plugins/seedwatch.cpp
@@ -7,6 +7,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Items.h"
diff --git a/plugins/sort.cpp b/plugins/sort.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Gui.h"
 #include "modules/Units.h"
diff --git a/plugins/stockpiles/stockpiles.cpp b/plugins/stockpiles/stockpiles.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "StockpileUtils.h"
 #include "StockpileSerializer.h"
 
diff --git a/plugins/suspendmanager.cpp b/plugins/suspendmanager.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Buildings.h"
diff --git a/plugins/tailor.cpp b/plugins/tailor.cpp
@@ -5,6 +5,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/Materials.h"
 #include "modules/Persistence.h"
diff --git a/plugins/tiletypes.cpp b/plugins/tiletypes.cpp
@@ -38,6 +38,7 @@ using std::set;
 #include "Export.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "TileTypes.h"
 
 #include "modules/Gui.h"
diff --git a/plugins/timestream.cpp b/plugins/timestream.cpp
@@ -1,6 +1,7 @@
 #include "Debug.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 
 #include "modules/EventManager.h"
 #include "modules/Items.h"
diff --git a/plugins/tweak/tweak.cpp b/plugins/tweak/tweak.cpp
@@ -3,6 +3,7 @@
 
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "VTableInterpose.h"
 
 DFHACK_PLUGIN("tweak");
diff --git a/plugins/xlsxreader.cpp b/plugins/xlsxreader.cpp
@@ -9,6 +9,7 @@
 #include "Error.h"
 #include "LuaTools.h"
 #include "PluginManager.h"
+#include "PluginLua.h"
 #include "PluginStatics.h"
 
 using namespace DFHack;

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`#include "PluginManager.h"`
	`2`	`+#include "PluginLua.h"`
`2`	`3`	`#include "TileTypes.h"`
`3`	`4`
`4`	`5`	`#include "modules/EventManager.h"`