reset overlay code to skeleton

plugins/overlay.cpp

@@ -51,6 +51,7 @@
 #include "df/viewscreen_locationsst.h"
 #include "df/viewscreen_meetingst.h"
 #include "df/viewscreen_movieplayerst.h"
+#include "df/viewscreen_new_regionst.h"
 #include "df/viewscreen_noblest.h"
 #include "df/viewscreen_optionst.h"
 #include "df/viewscreen_overallstatusst.h"
@@ -71,6 +72,7 @@
 #include "df/viewscreen_topicmeeting_takerequestsst.h"
 #include "df/viewscreen_tradeagreementst.h"
 #include "df/viewscreen_tradelistst.h"
+#include "df/viewscreen_tradegoodsst.h"
 #include "df/viewscreen_treasurelistst.h"
 #include "df/viewscreen_unitlist_page.h"
 #include "df/viewscreen_unitlistst.h"
@@ -82,64 +84,45 @@
 #include "df/viewscreen_workshop_profilest.h"
 
 #include "Debug.h"
+#include "LuaTools.h"
 #include "PluginManager.h"
 #include "VTableInterpose.h"
-#include "uicommon.h"
-
-#include "modules/Screen.h"
 
 using namespace DFHack;
 
 DFHACK_PLUGIN("overlay");
 DFHACK_PLUGIN_IS_ENABLED(is_enabled);
-REQUIRE_GLOBAL(enabler);
-REQUIRE_GLOBAL(gps);
 
 namespace DFHack {
-    DBG_DECLARE(overlay, log, DebugCategory::LINFO);
-}
-
-static const std::string button_text = "[ DFHack ]";
-static bool clicked = false;
-
-static bool handle_click() {
-    if (!enabler->mouse_lbut_down || clicked) {
-        return false;
-    }
-    df::coord2d pos = Screen::getMousePos();
-    DEBUG(log).print("clicked at screen coordinates (%d, %d)\n", pos.x, pos.y);
-    if (pos.y == gps->dimy - 1 && pos.x >= 1 && (size_t)pos.x <= button_text.size()) {
-        clicked = true;
-        Core::getInstance().setHotkeyCmd("gui/launcher");
-        return true;
-    }
-    return false;
-}
-
-static void draw_widgets() {
-    int x = 1;
-    int y = gps->dimy - 1;
-    OutputString(COLOR_GREEN, x, y, button_text);
+    DBG_DECLARE(overlay, control, DebugCategory::LINFO);
+    DBG_DECLARE(overlay, event, DebugCategory::LINFO);
 }
 
 template<class T>
 struct viewscreen_overlay : T {
     typedef T interpose_base;
 
-    DEFINE_VMETHOD_INTERPOSE(void, feed, (set<df::interface_key> *input)) {
-        if (!handle_click())
+    viewscreen_overlay() : vs_name(T::_identity.getName()) { }
+
+    DEFINE_VMETHOD_INTERPOSE(void, logic, ()) {
+        INTERPOSE_NEXT(logic)();
+    }
+    DEFINE_VMETHOD_INTERPOSE(void, feed, (std::set<df::interface_key> *input)) {
         INTERPOSE_NEXT(feed)(input);
     }
     DEFINE_VMETHOD_INTERPOSE(void, render, ()) {
         INTERPOSE_NEXT(render)();
-        draw_widgets();
     }
+
+    T *viewscreen;
+    const char *vs_name;
 };
 
 #define IMPLEMENT_HOOKS(screen) \
     typedef viewscreen_overlay<df::viewscreen_##screen##st> screen##_overlay; \
-    template<> IMPLEMENT_VMETHOD_INTERPOSE(screen##_overlay, feed); \
-    template<> IMPLEMENT_VMETHOD_INTERPOSE(screen##_overlay, render);
+    template<> IMPLEMENT_VMETHOD_INTERPOSE_PRIO(screen##_overlay, logic, 100); \
+    template<> IMPLEMENT_VMETHOD_INTERPOSE_PRIO(screen##_overlay, feed, 100); \
+    template<> IMPLEMENT_VMETHOD_INTERPOSE_PRIO(screen##_overlay, render, 100);
 
 IMPLEMENT_HOOKS(adopt_region)
 IMPLEMENT_HOOKS(adventure_log)
@@ -191,6 +174,7 @@ IMPLEMENT_HOOKS(loadgame)
 IMPLEMENT_HOOKS(locations)
 IMPLEMENT_HOOKS(meeting)
 IMPLEMENT_HOOKS(movieplayer)
+IMPLEMENT_HOOKS(new_region)
 IMPLEMENT_HOOKS(noble)
 IMPLEMENT_HOOKS(option)
 IMPLEMENT_HOOKS(overallstatus)
@@ -210,6 +194,7 @@ IMPLEMENT_HOOKS(topicmeeting_fill_land_holder_positions)
 IMPLEMENT_HOOKS(topicmeeting)
 IMPLEMENT_HOOKS(topicmeeting_takerequests)
 IMPLEMENT_HOOKS(tradeagreement)
+IMPLEMENT_HOOKS(tradegoods)
 IMPLEMENT_HOOKS(tradelist)
 IMPLEMENT_HOOKS(treasurelist)
 IMPLEMENT_HOOKS(unitlist)
@@ -222,15 +207,8 @@ IMPLEMENT_HOOKS(workshop_profile)
 
 #undef IMPLEMENT_HOOKS
 
-DFhackCExport command_result plugin_onstatechange(color_ostream &,
-                                                  state_change_event evt) {
-    if (evt == SC_VIEWSCREEN_CHANGED) {
-        clicked = false;
-    }
-    return CR_OK;
-}
-
 #define INTERPOSE_HOOKS_FAILED(screen) \
+    !INTERPOSE_HOOK(screen##_overlay, logic).apply(enable) || \
     !INTERPOSE_HOOK(screen##_overlay, feed).apply(enable) || \
     !INTERPOSE_HOOK(screen##_overlay, render).apply(enable)
 
@@ -238,7 +216,8 @@ DFhackCExport command_result plugin_enable(color_ostream &, bool enable) {
     if (is_enabled == enable)
         return CR_OK;
 
-    if (enable != is_enabled) {
+    DEBUG(control).print("%sing interpose hooks\n", enable ? "enabl" : "disabl");
+
     if (INTERPOSE_HOOKS_FAILED(adopt_region) ||
             INTERPOSE_HOOKS_FAILED(adventure_log) ||
             INTERPOSE_HOOKS_FAILED(announcelist) ||
@@ -289,6 +268,7 @@ DFhackCExport command_result plugin_enable(color_ostream &, bool enable) {
             INTERPOSE_HOOKS_FAILED(locations) ||
             INTERPOSE_HOOKS_FAILED(meeting) ||
             INTERPOSE_HOOKS_FAILED(movieplayer) ||
+            INTERPOSE_HOOKS_FAILED(new_region) ||
             INTERPOSE_HOOKS_FAILED(noble) ||
             INTERPOSE_HOOKS_FAILED(option) ||
             INTERPOSE_HOOKS_FAILED(overallstatus) ||
@@ -308,6 +288,7 @@ DFhackCExport command_result plugin_enable(color_ostream &, bool enable) {
             INTERPOSE_HOOKS_FAILED(topicmeeting) ||
             INTERPOSE_HOOKS_FAILED(topicmeeting_takerequests) ||
             INTERPOSE_HOOKS_FAILED(tradeagreement) ||
+            INTERPOSE_HOOKS_FAILED(tradegoods) ||
             INTERPOSE_HOOKS_FAILED(tradelist) ||
             INTERPOSE_HOOKS_FAILED(treasurelist) ||
             INTERPOSE_HOOKS_FAILED(unitlist) ||
@@ -320,16 +301,37 @@ DFhackCExport command_result plugin_enable(color_ostream &, bool enable) {
         return CR_FAILURE;
 
     is_enabled = enable;
-    }
     return CR_OK;
 }
 
 #undef INTERPOSE_HOOKS_FAILED
 
-DFhackCExport command_result plugin_init(color_ostream &out, std::vector <PluginCommand> &) {
+static command_result overlay_cmd(color_ostream &out, std::vector <std::string> & parameters) {
+    if (DBG_NAME(control).isEnabled(DebugCategory::LDEBUG)) {
+        DEBUG(control).print("interpreting command with %zu parameters:\n",
+                             parameters.size());
+        for (auto &param : parameters) {
+            DEBUG(control).print("  %s\n", param.c_str());
+        }
+    }
+
+    return CR_OK;
+}
+
+DFhackCExport command_result plugin_init(color_ostream &out, std::vector <PluginCommand> &commands) {
+    commands.push_back(
+        PluginCommand(
+            "overlay",
+            "Manage onscreen widgets.",
+            overlay_cmd));
+
     return plugin_enable(out, true);
 }
 
 DFhackCExport command_result plugin_shutdown(color_ostream &out) {
     return plugin_enable(out, false);
 }
+
+DFhackCExport command_result plugin_onupdate (color_ostream &out) {
+    return CR_OK;
+}