From dc2a14c0c2d05ba1be2bc823312a0c875dfe523a Mon Sep 17 00:00:00 2001
From: Quietust <quietust@gmail.com>
Date: Tue, 26 Apr 2022 20:52:24 -0600
Subject: [PATCH] Add "partial-items" tweak.

When active, the displayed names of partially-consumed items (e.g.
hospital cloth) will display a percentage indicator at the end.

Also re-sort a few Tweaks so they're in alphabetical order again.
---
 docs/Plugins.rst                     |  1 +
 docs/changelog.txt                   |  3 +++
 plugins/tweak/tweak.cpp              | 24 ++++++++++++++++++++----
 plugins/tweak/tweaks/partial-items.h | 23 +++++++++++++++++++++++
 4 files changed, 47 insertions(+), 4 deletions(-)
 create mode 100644 plugins/tweak/tweaks/partial-items.h

diff --git a/docs/Plugins.rst b/docs/Plugins.rst
index b068e3c95..3b42bc16a 100644
--- a/docs/Plugins.rst
+++ b/docs/Plugins.rst
@@ -159,6 +159,7 @@ Subcommands that persist until disabled or DF quits:
                         i.e. stop the rightmost list of the Positions page of the military
                         screen from constantly resetting to the top.
 :nestbox-color:         Fixes the color of built nestboxes
+:partial-items:         Displays percentages on partially-consumed items such as hospital cloth
 :reaction-gloves:       Fixes reactions to produce gloves in sets with correct handedness (:bug:`6273`)
 :shift-8-scroll:        Gives Shift-8 (or :kbd:`*`) priority when scrolling menus, instead of scrolling the map
 :stable-cursor:         Saves the exact cursor position between t/q/k/d/b/etc menus of fortress mode, if the
diff --git a/docs/changelog.txt b/docs/changelog.txt
index 1a3bf64b4..05fe533ba 100644
--- a/docs/changelog.txt
+++ b/docs/changelog.txt
@@ -38,6 +38,9 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
 
 ## Removed
 
+## New Tweaks
+- `tweak` partial-items: displays percentages on partially-consumed items such as hospital cloth
+
 ## Fixes
 - `autofarm` removed restriction on only planting 'discovered' plants
 - `luasocket` (and others): return correct status code when closing socket connections
diff --git a/plugins/tweak/tweak.cpp b/plugins/tweak/tweak.cpp
index 1ea958f5b..38ece6970 100644
--- a/plugins/tweak/tweak.cpp
+++ b/plugins/tweak/tweak.cpp
@@ -49,11 +49,14 @@
 #include "df/item_glovesst.h"
 #include "df/item_shoesst.h"
 #include "df/item_pantsst.h"
+#include "df/item_drinkst.h"
+#include "df/item_globst.h"
 #include "df/item_liquid_miscst.h"
 #include "df/item_powder_miscst.h"
 #include "df/item_barst.h"
 #include "df/item_threadst.h"
 #include "df/item_clothst.h"
+#include "df/item_sheetst.h"
 #include "df/spatter.h"
 #include "df/layer_object.h"
 #include "df/reaction.h"
@@ -68,6 +71,7 @@
 #include "df/job.h"
 #include "df/general_ref_building_holderst.h"
 #include "df/unit_health_info.h"
+#include "df/caste_body_info.h"
 #include "df/activity_entry.h"
 #include "df/activity_event_combat_trainingst.h"
 #include "df/activity_event_individual_skill_drillst.h"
@@ -101,14 +105,15 @@
 #include "tweaks/kitchen-prefs-empty.h"
 #include "tweaks/max-wheelbarrow.h"
 #include "tweaks/military-assign.h"
-#include "tweaks/pausing-fps-counter.h"
 #include "tweaks/nestbox-color.h"
+#include "tweaks/partial-items.h"
+#include "tweaks/pausing-fps-counter.h"
+#include "tweaks/reaction-gloves.h"
 #include "tweaks/shift-8-scroll.h"
 #include "tweaks/stable-cursor.h"
 #include "tweaks/stone-status-all.h"
 #include "tweaks/title-start-rename.h"
 #include "tweaks/tradereq-pet-gender.h"
-#include "tweaks/reaction-gloves.h"
 
 using std::set;
 using std::vector;
@@ -244,6 +249,8 @@ 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 partial-items [disable]\n"
+        "    Displays percentages on partially-consumed items such as hospital cloth\n"
         "  tweak pausing-fps-counter [disable]\n"
         "    Replace fortress mode FPS counter with one that stops counting \n"
         "    when paused.\n"
@@ -329,9 +336,20 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector <Plugi
 
     TWEAK_HOOK("nestbox-color", nestbox_color_hook, drawBuilding);
 
+    TWEAK_HOOK("partial-items", partial_items_hook_bar, getItemDescription);
+    TWEAK_HOOK("partial-items", partial_items_hook_drink, getItemDescription);
+    TWEAK_HOOK("partial-items", partial_items_hook_glob, getItemDescription);
+    TWEAK_HOOK("partial-items", partial_items_hook_liquid_misc, getItemDescription);
+    TWEAK_HOOK("partial-items", partial_items_hook_powder_misc, getItemDescription);
+    TWEAK_HOOK("partial-items", partial_items_hook_cloth, getItemDescription);
+    TWEAK_HOOK("partial-items", partial_items_hook_sheet, getItemDescription);
+    TWEAK_HOOK("partial-items", partial_items_hook_thread, getItemDescription);
+
     TWEAK_HOOK("pausing-fps-counter", dwarfmode_pausing_fps_counter_hook, render);
     TWEAK_HOOK("pausing-fps-counter", title_pausing_fps_counter_hook, render);
 
+    TWEAK_HOOK("reaction-gloves", reaction_gloves_hook, produce);
+
     TWEAK_HOOK("shift-8-scroll", shift_8_scroll_hook, feed);
 
     TWEAK_HOOK("stable-cursor", stable_cursor_hook, feed);
@@ -344,8 +362,6 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector <Plugi
 
     TWEAK_HOOK("tradereq-pet-gender", pet_gender_hook, render);
 
-    TWEAK_HOOK("reaction-gloves", reaction_gloves_hook, produce);
-
     return CR_OK;
 }
 
diff --git a/plugins/tweak/tweaks/partial-items.h b/plugins/tweak/tweaks/partial-items.h
new file mode 100644
index 000000000..9bf94a9f0
--- /dev/null
+++ b/plugins/tweak/tweaks/partial-items.h
@@ -0,0 +1,23 @@
+// When displaying the names of partially-consumed items, show the percentage remaining
+// Potentially useful for revealing why random pieces of cloth or thread aren't suitable for jobs
+
+#define DEFINE_PARTIAL_ITEM_TWEAK(TYPE, DIM) \
+struct partial_items_hook_##TYPE : df::item_##TYPE##st { \
+    typedef df::item_##TYPE##st interpose_base; \
+    DEFINE_VMETHOD_INTERPOSE(void, getItemDescription, (std::string *str, int8_t plurality)) \
+    { \
+        INTERPOSE_NEXT(getItemDescription)(str, plurality); \
+        if (dimension != DIM) \
+            str->append(stl_sprintf(" (%i%%)", std::max(1, dimension * 100 / DIM))); \
+    } \
+}; \
+IMPLEMENT_VMETHOD_INTERPOSE(partial_items_hook_##TYPE, getItemDescription);
+
+DEFINE_PARTIAL_ITEM_TWEAK(bar, 150)
+DEFINE_PARTIAL_ITEM_TWEAK(drink, 150)
+DEFINE_PARTIAL_ITEM_TWEAK(glob, 150)
+DEFINE_PARTIAL_ITEM_TWEAK(liquid_misc, 150)
+DEFINE_PARTIAL_ITEM_TWEAK(powder_misc, 150)
+DEFINE_PARTIAL_ITEM_TWEAK(cloth, 10000)
+DEFINE_PARTIAL_ITEM_TWEAK(sheet, 10000)
+DEFINE_PARTIAL_ITEM_TWEAK(thread, 15000)