New module: Once. Intended to help prevent debug error message spam.

library/CMakeLists.txt

@@ -125,6 +125,7 @@ include/modules/Translation.h
 include/modules/Vermin.h
 include/modules/World.h
 include/modules/Graphic.h
+include/modules/Once.h
 )
 
 SET( MODULE_SOURCES
@@ -147,6 +148,7 @@ modules/Vermin.cpp
 modules/World.cpp
 modules/Graphic.cpp
 modules/Windows.cpp
+modules/Once.cpp
 )
 
 IF(WIN32)

library/include/modules/Once.h

@@ -0,0 +1,11 @@
+#pragma once
+#include "Export.h"
+#include <string>
+
+namespace DFHack {
+    namespace Once {
+        DFHACK_EXPORT bool alreadyDone(std::string);
+        DFHACK_EXPORT bool doOnce(std::string);
+    }
+}
+

library/modules/Once.cpp

@@ -0,0 +1,16 @@
+
+#include "modules/Once.h"
+#include <unordered_set>
+
+using namespace std;
+
+static unordered_set<string> thingsDone;
+
+bool DFHack::Once::alreadyDone(string bob) {
+    return thingsDone.find(bob) != thingsDone.end();
+}
+
+bool DFHack::Once::doOnce(string bob) {
+    return thingsDone.insert(bob).second;
+}
+

plugins/devel/CMakeLists.txt

@@ -21,6 +21,7 @@ DFHACK_PLUGIN(vshook vshook.cpp)
 DFHACK_PLUGIN(autolabor2 autolabor2.cpp)
 DFHACK_PLUGIN(eventExample eventExample.cpp)
 DFHACK_PLUGIN(printArgs printArgs.cpp)
+DFHACK_PLUGIN(onceExample onceExample.cpp)
 IF(UNIX)
 DFHACK_PLUGIN(ref-index ref-index.cpp)
 ENDIF()

plugins/devel/onceExample.cpp

@@ -0,0 +1,35 @@
+
+#include "Core.h"
+#include "Console.h"
+#include "DataDefs.h"
+#include "Export.h"
+#include "PluginManager.h"
+
+#include "modules/Once.h"
+
+using namespace DFHack;
+using namespace df::enums;
+
+command_result onceExample (color_ostream &out, std::vector <std::string> & parameters);
+
+DFHACK_PLUGIN("onceExample");
+
+DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
+{
+    commands.push_back(PluginCommand(
+        "onceExample", "Test the doOnce command.",
+        onceExample, false,
+        "  This command tests the doOnce command..\n"
+    ));
+    return CR_OK;
+}
+
+command_result onceExample (color_ostream &out, std::vector <std::string> & parameters)
+{
+    out.print("Already done = %d.\n", DFHack::Once::alreadyDone("onceExample_1"));
+    if ( DFHack::Once::doOnce("onceExample_1") ) {
+        out.print("Printing this message once!\n");
+    }
+    return CR_OK;
+}
+