Merge remote-tracking branch 'lethosor/ui-tweaks' into develop

NEWS

@@ -19,6 +19,8 @@ DFHack Future
     New scripts
         modtools/reaction-product-trigger: triggers callbacks when products are produced (contrast with when reactions complete)
     New tweaks
+        fps-min: Fixes the in-game minimum FPS setting
+        shift-8-scroll: Gives Shift+8 (or *) priority when scrolling menus, instead of scrolling the map
         tradereq-pet-gender: Displays pet genders on the trade request screen
     New features
         autolabor: A negative pool size can be specified to use the most unskilled dwarves

Readme.rst

@@ -1292,40 +1292,40 @@ One-shot subcommands:
                  for slaughter. Grabbing wagons results in some funny spam, then
                  they are scuttled.
 
-Subcommands that persist until disabled or DF quit:
+Subcommands that persist until disabled or DF quits:
 
-:stable-cursor:  Saves the exact cursor position between t/q/k/d/etc menus of dwarfmode.
+:adamantine-cloth-wear: Prevents adamantine clothing from wearing out while being worn (bug 6481).
+:advmode-contained:   Works around bug 6202, i.e. custom reactions with container inputs
+                      in advmode. The issue is that the screen tries to force you to select
+                      the contents separately from the container. This forcefully skips child
+                      reagents.
+:civ-view-agreement:  Fixes overlapping text on the "view agreement" screen
+:craft-age-wear:      Fixes the behavior of crafted items wearing out over time (bug 6003).
+                      With this tweak, items made from cloth and leather will gain a level of wear every 20 years.
+:eggs-fertile:        Displays a fertility indicator on nestboxes
+:farm-plot-select:    Adds "Select all" and "Deselect all" options to farm plot menus
 :fast-heat:      Further improves temperature update performance by ensuring that 1 degree
                  of item temperature is crossed in no more than specified number of frames
                  when updating from the environment temperature. This reduces the time it
                  takes for stable-temp to stop updates again when equilibrium is disturbed.
-:advmode-contained: Works around bug 6202, i.e. custom reactions with container inputs
-                    in advmode. The issue is that the screen tries to force you to select
-                    the contents separately from the container. This forcefully skips child
-                    reagents.
 :fast-trade:     Makes Shift-Down in the Move Goods to Depot and Trade screens select
                  the current item (fully, in case of a stack), and scroll down one line.
+:fps-min:        Fixes the in-game minimum FPS setting
+:import-priority-category:  Allows changing the priority of all goods in a
+                            category when discussing an import agreement with the liaison
+:manager-quantity:          Removes the limit of 30 jobs per manager order
+:max-wheelbarrow:           Allows assigning more than 3 wheelbarrows to a stockpile
+:military-color-assigned:   Color squad candidates already assigned to other squads in yellow/green
+                            to make them stand out more in the list.
+
+                          .. image:: images/tweak-mil-color.png
 :military-stable-assign: Preserve list order and cursor position when assigning to squad,
                          i.e. stop the rightmost list of the Positions page of the military
                          screen from constantly resetting to the top.
-:military-color-assigned: Color squad candidates already assigned to other squads in yellow/green
-                          to make them stand out more in the list.
-
-                          .. image:: images/tweak-mil-color.png
-
-:craft-age-wear: Fixes the behavior of crafted items wearing out over time (bug 6003).
-                 With this tweak, items made from cloth and leather will gain a level of wear every 20 years.
-
-:adamantine-cloth-wear: Prevents adamantine clothing from wearing out while being worn (bug 6481).
 
-:farm-plot-select:          Adds "Select all" and "Deselect all" options to farm plot menus
-:import-priority-category:  Allows changing the priority of all goods in a
-                            category when discussing an import agreement with the liaison
-:manager-quantity:          Removes the limit of 30 jobs per manager order
-:civ-view-agreement:        Fixes overlapping text on the "view agreement" screen
 :nestbox-color:       Fixes the color of built nestboxes
-:eggs-fertile:        Displays a fertility indicator on nestboxes
+:shift-8-scroll:      Gives Shift-8 (or ``*``) priority when scrolling menus, instead of scrolling the map
-:max-wheelbarrow:     Allows assigning more than 3 wheelbarrows to a stockpile
+:stable-cursor:       Saves the exact cursor position between t/q/k/d/b/etc menus of fortress mode.
 :tradereq-pet-gender: Displays pet genders on the trade request screen
 
 fix-armory

dfhack.init-example

@@ -179,7 +179,9 @@ tweak import-priority-category
 
 # Misc. UI tweaks
 tweak civ-view-agreement
+tweak fps-min
 tweak max-wheelbarrow
+tweak shift-8-scroll
 tweak tradereq-pet-gender
 
 ###########################

plugins/tweak/tweak.cpp

@@ -81,11 +81,13 @@
 #include "tweaks/farm-plot-select.h"
 #include "tweaks/fast-heat.h"
 #include "tweaks/fast-trade.h"
+#include "tweaks/fps-min.h"
 #include "tweaks/import-priority-category.h"
 #include "tweaks/manager-quantity.h"
 #include "tweaks/max-wheelbarrow.h"
 #include "tweaks/military-assign.h"
 #include "tweaks/nestbox-color.h"
+#include "tweaks/shift-8-scroll.h"
 #include "tweaks/stable-cursor.h"
 #include "tweaks/tradereq-pet-gender.h"
 
@@ -97,6 +99,7 @@ using namespace DFHack;
 using namespace df::enums;
 
 DFHACK_PLUGIN("tweak");
+DFHACK_PLUGIN_IS_ENABLED(is_enabled);
 
 REQUIRE_GLOBAL(ui);
 REQUIRE_GLOBAL(ui_build_selector);
@@ -107,11 +110,23 @@ REQUIRE_GLOBAL(world);
 
 using namespace DFHack::Gui;
 
+class tweak_onupdate_hookst {
+public:
+    typedef void(*T_callback)(void);
+    tweak_onupdate_hookst(std::string name_, T_callback cb)
+        :name(name_), callback(cb), enabled(false) {}
+    bool enabled;
+    std::string name;
+    T_callback callback;
+};
 static command_result tweak(color_ostream &out, vector <string> & parameters);
 static std::multimap<std::string, VMethodInterposeLinkBase> tweak_hooks;
+static std::multimap<std::string, tweak_onupdate_hookst> tweak_onupdate_hooks;
 
 #define TWEAK_HOOK(tweak, cls, func) tweak_hooks.insert(std::pair<std::string, VMethodInterposeLinkBase>\
     (tweak, INTERPOSE_HOOK(cls, func)))
+#define TWEAK_ONUPDATE_HOOK(tweak, func) tweak_onupdate_hooks.insert(\
+    std::pair<std::string, tweak_onupdate_hookst>(tweak, tweak_onupdate_hookst(#func, func)))
 
 DFhackCExport command_result plugin_init (color_ostream &out, std::vector <PluginCommand> &commands)
 {
@@ -163,6 +178,8 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector <Plugi
         "  tweak fast-trade [disable]\n"
         "    Makes Shift-Enter in the Move Goods to Depot and Trade screens select\n"
         "    the current item (fully, in case of a stack), and scroll down one line.\n"
+        "  tweak fps-min [disable]\n"
+        "    Fixes the in-game minimum FPS setting (bug 6277)\n"
         "  tweak import-priority-category [disable]\n"
         "    When meeting with a liaison, makes Shift+Left/Right arrow adjust\n"
         "    the priority of an entire category of imports.\n"
@@ -179,6 +196,9 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector <Plugi
         "    Preserve list order and cursor position when assigning to squad,\n"
         "    i.e. stop the rightmost list of the Positions page of the military\n"
         "    screen from constantly jumping to the top.\n"
+        "  tweak shift-8-scroll [disable]\n"
+        "    Gives Shift+8 (or *) priority when scrolling menus, instead of \n"
+        "    scrolling the map\n"
         "  tweak tradereq-pet-gender [disable]\n"
         "    Displays the gender of pets in the trade request list\n"
 //        "  tweak military-training [disable]\n"
@@ -209,6 +229,8 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector <Plugi
     TWEAK_HOOK("fast-trade", fast_trade_assign_hook, feed);
     TWEAK_HOOK("fast-trade", fast_trade_select_hook, feed);
 
+    TWEAK_ONUPDATE_HOOK("fps-min", fps_min_hook);
+
     TWEAK_HOOK("import-priority-category", takerequest_hook, feed);
     TWEAK_HOOK("import-priority-category", takerequest_hook, render);
 
@@ -223,6 +245,8 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector <Plugi
 
     TWEAK_HOOK("nestbox-color", nestbox_color_hook, drawBuilding);
 
+    TWEAK_HOOK("shift-8-scroll", shift_8_scroll_hook, feed);
+
     TWEAK_HOOK("stable-cursor", stable_cursor_hook, feed);
 
     TWEAK_HOOK("tradereq-pet-gender", pet_gender_hook, render);
@@ -230,6 +254,16 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector <Plugi
     return CR_OK;
 }
 
+DFhackCExport command_result plugin_onupdate (color_ostream &out)
+{
+    for (auto it = tweak_onupdate_hooks.begin(); it != tweak_onupdate_hooks.end(); ++it)
+    {
+        tweak_onupdate_hookst hook = it->second;
+        if (hook.enabled)
+            hook.callback();
+    }
+}
+
 DFhackCExport command_result plugin_shutdown (color_ostream &out)
 {
     return CR_OK;
@@ -653,10 +687,22 @@ static command_result enable_tweak(string tweak, color_ostream &out, vector <str
             enable_hook(out, it->second, parameters);
         }
     }
+    for (auto it = tweak_onupdate_hooks.begin(); it != tweak_onupdate_hooks.end(); ++it)
+    {
+        if (it->first == cmd)
+        {
+            bool state = (vector_get(parameters, 1) != "disable");
+            recognized = true;
+            tweak_onupdate_hookst hook = it->second;
+            hook.enabled = state;
+            out.print("%s tweak %s (%s)\n", state ? "Enabled" : "Disabled", cmd.c_str(), hook.name.c_str());
+        }
+    }
     if (!recognized)
     {
         out.printerr("Unrecognized tweak: %s\n", cmd.c_str());
-        return CR_WRONG_USAGE;
+        out.print("Run 'help tweak' to display a full list\n");
+        return CR_FAILURE; // Avoid dumping usage information
     }
     return CR_OK;
 }

plugins/tweak/tweaks/fps-min.h

@@ -0,0 +1,7 @@
+#include "df/enabler.h"
+using df::global::enabler;
+
+void fps_min_hook() {
+    if (enabler->fps < 10)
+        enabler->fps = 10;
+}

plugins/tweak/tweaks/shift-8-scroll.h

@@ -0,0 +1,21 @@
+#include "df/viewscreen_dwarfmodest.h"
+
+using namespace df::enums;
+using df::global::ui;
+
+struct shift_8_scroll_hook : df::viewscreen_dwarfmodest {
+    typedef df::viewscreen_dwarfmodest interpose_base;
+    DEFINE_VMETHOD_INTERPOSE(void, feed, (std::set<df::interface_key>* input))
+    {
+        if (ui->main.mode != ui_sidebar_mode::Default &&
+            input->count(interface_key::CURSOR_UP_FAST) &&
+            input->count(interface_key::SECONDSCROLL_PAGEDOWN)
+            )
+        {
+            input->erase(interface_key::CURSOR_UP_FAST);
+        }
+        INTERPOSE_NEXT(feed)(input);
+    }
+};
+
+IMPLEMENT_VMETHOD_INTERPOSE(shift_8_scroll_hook, feed);