Move vshook plugin to title-version and enable by default

NEWS

@@ -18,6 +18,7 @@ DFHack Future
     New plugins
         confirm: Adds confirmation dialogs for several potentially dangerous actions
         fix-unit-occupancy: Fixes issues with unit occupancy, such as faulty "unit blocking tile" messages (bug 3499)
+        title-version (formerly vshook): Display DFHack version on title screen
     New scripts
         burial:  sets all unowned coffins to allow burial ("-pets" to allow pets too)
         fix-ster:  changes fertility/sterility of animals or dwarves

dfhack.init-example

@@ -191,6 +191,9 @@ tweak tradereq-pet-gender
 # Globally acting plugins #
 ###########################
 
+# Display DFHack version on title screen
+enable title-version
+
 # Dwarf Manipulator (simple in-game Dwarf Therapist replacement)
 enable manipulator
 

plugins/CMakeLists.txt

@@ -161,6 +161,7 @@ if (BUILD_SUPPORTED)
     DFHACK_PLUGIN(stocks stocks.cpp)
     DFHACK_PLUGIN(strangemood strangemood.cpp)
     DFHACK_PLUGIN(tiletypes tiletypes.cpp Brushes.h)
+    DFHACK_PLUGIN(title-version title-version.cpp)
     DFHACK_PLUGIN(trackstop trackstop.cpp)
 #    DFHACK_PLUGIN(treefarm treefarm.cpp)
     DFHACK_PLUGIN(tubefill tubefill.cpp)

plugins/devel/CMakeLists.txt

@@ -19,7 +19,6 @@ DFHACK_PLUGIN(stepBetween stepBetween.cpp)
 DFHACK_PLUGIN(stockcheck stockcheck.cpp)
 DFHACK_PLUGIN(stripcaged stripcaged.cpp)
 DFHACK_PLUGIN(tilesieve tilesieve.cpp)
-DFHACK_PLUGIN(vshook vshook.cpp)
 DFHACK_PLUGIN(zoom zoom.cpp)
 
 IF(UNIX)

plugins/devel/vshook.cpp

@@ -1,71 +0,0 @@
-#include "Core.h"
-#include <Console.h>
-#include <Export.h>
-#include <PluginManager.h>
-#include <modules/Gui.h>
-#include <modules/Screen.h>
-#include <vector>
-#include <cstdio>
-#include <stack>
-#include <string>
-#include <cmath>
-
-#include <VTableInterpose.h>
-#include "df/graphic.h"
-#include "df/viewscreen_titlest.h"
-
-using std::vector;
-using std::string;
-using std::stack;
-using namespace DFHack;
-
-using df::global::gps;
-
-DFHACK_PLUGIN("vshook");
-
-DFHACK_PLUGIN_IS_ENABLED(is_enabled);
-
-struct title_hook : df::viewscreen_titlest {
-    typedef df::viewscreen_titlest interpose_base;
-
-    DEFINE_VMETHOD_INTERPOSE(void, render, ())
-    {
-        INTERPOSE_NEXT(render)();
-
-        Screen::Pen pen(' ',COLOR_WHITE,COLOR_BLACK);
-        Screen::paintString(pen, 0, 0, "DFHack ");
-        Screen::paintString(pen, 7, 0, Version::dfhack_version());
-    }
-};
-
-IMPLEMENT_VMETHOD_INTERPOSE(title_hook, render);
-
-DFhackCExport command_result plugin_enable ( color_ostream &out, bool enable)
-{
-    if (!gps)
-        return CR_FAILURE;
-
-    if (enable != is_enabled)
-    {
-        if (!INTERPOSE_HOOK(title_hook, render).apply(enable))
-            return CR_FAILURE;
-
-        is_enabled = enable;
-    }
-
-    return CR_OK;
-}
-
-DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
-{
-    // DON'T DO THIS IN NON-EXAMPLE PLUGINS
-    plugin_enable(out, true);
-
-    return CR_OK;
-}
-
-DFhackCExport command_result plugin_shutdown ( color_ostream &out )
-{
-    INTERPOSE_HOOK(title_hook, render).remove();
-    return CR_OK;
-}

plugins/title-version.cpp

@@ -0,0 +1,66 @@
+#include <vector>
+#include <cstdio>
+#include <stack>
+#include <string>
+#include <cmath>
+
+#include "Core.h"
+#include "Console.h"
+#include "Export.h"
+#include "PluginManager.h"
+#include "modules/Gui.h"
+#include "modules/Screen.h"
+#include "VTableInterpose.h"
+#include "DFHackVersion.h"
+
+#include "df/graphic.h"
+#include "df/viewscreen_titlest.h"
+#include "uicommon.h"
+
+using std::vector;
+using std::string;
+using namespace DFHack;
+
+DFHACK_PLUGIN("title-version");
+DFHACK_PLUGIN_IS_ENABLED(is_enabled);
+REQUIRE_GLOBAL(gps);
+
+struct title_version_hook : df::viewscreen_titlest {
+    typedef df::viewscreen_titlest interpose_base;
+
+    DEFINE_VMETHOD_INTERPOSE(void, render, ())
+    {
+        INTERPOSE_NEXT(render)();
+        int x = 0, y = 0;
+        OutputString(COLOR_WHITE, x, y, string("DFHack ") + DFHACK_VERSION);
+    }
+};
+
+IMPLEMENT_VMETHOD_INTERPOSE(title_version_hook, render);
+
+DFhackCExport command_result plugin_enable (color_ostream &out, bool enable)
+{
+    if (!gps)
+        return CR_FAILURE;
+
+    if (enable != is_enabled)
+    {
+        if (!INTERPOSE_HOOK(title_version_hook, render).apply(enable))
+            return CR_FAILURE;
+
+        is_enabled = enable;
+    }
+
+    return CR_OK;
+}
+
+DFhackCExport command_result plugin_init (color_ostream &out, vector<PluginCommand> &commands)
+{
+    return CR_OK;
+}
+
+DFhackCExport command_result plugin_shutdown (color_ostream &out)
+{
+    INTERPOSE_HOOK(title_version_hook, render).remove();
+    return CR_OK;
+}