Merge pull request #5677 from pajawojciech/orders-search

orders: add search overlay for manager orders

Author: ab9rf

docs/about/Authors.rst

@@ -163,6 +163,7 @@ Omniclasm
 Ong Ying Gao            ong-yinggao98
 oorzkws                 oorzkws
 OwnageIsMagic           OwnageIsMagic
+pajawojciech            pajawojciech
 palenerd                dlmarquis
 PassionateAngler        PassionateAngler
 Patrik Lundell          PatrikLundell

docs/changelog.txt

@@ -57,6 +57,7 @@ Template for new versions:
 ## New Tools
 
 ## New Features
+- `orders`: added search overlay to find and navigate to matching manager orders with arrow indicators
 - `sort`: Add death cause button to dead/missing tab in the creatures screen
 
 ## Fixes
@@ -115,6 +116,7 @@ Template for new versions:
 ## Documentation
 
 ## API
+- ``dfhack.job.getManagerOrderName``: New function to get the display name of a manager order
 
 ## Lua
 

docs/dev/Lua API.rst

@@ -1430,6 +1430,10 @@ Job module
 
   Returns the job's description, as seen in the Units and Jobs screens.
 
+* ``dfhack.job.getManagerOrderName(manager_order)``
+
+  Returns the manager order's description, as seen in the Work orders screen.
+
 Hotkey module
 -------------
 

library/LuaApi.cpp

@@ -92,6 +92,7 @@ distribution.
 #include "df/job_item.h"
 #include "df/job_material_category.h"
 #include "df/language_word_table.h"
+#include "df/manager_order.h"
 #include "df/material.h"
 #include "df/map_block.h"
 #include "df/nemesis_record.h"
@@ -2018,6 +2019,7 @@ static const LuaWrapper::FunctionReg dfhack_job_module[] = {
     WRAPM(Job,isSuitableItem),
     WRAPM(Job,isSuitableMaterial),
     WRAPM(Job,getName),
+    WRAPM(Job,getManagerOrderName),
     WRAPM(Job,linkIntoWorld),
     WRAPM(Job,removePostings),
     WRAPM(Job,disconnectJobItem),

library/include/modules/Job.h

@@ -41,6 +41,7 @@ namespace df
     struct job_item_filter;
     struct building;
     struct unit;
+    struct manager_order;
 }
 
 namespace DFHack
@@ -117,6 +118,7 @@ namespace DFHack
                                               int mat_index,
                                               df::item_type itype);
         DFHACK_EXPORT std::string getName(df::job *job);
+        DFHACK_EXPORT std::string getManagerOrderName(df::manager_order *order);
 
         struct JobDeleter {
             void operator()(df::job *ptr) const {

library/modules/Job.cpp

@@ -49,6 +49,7 @@ distribution.
 #include "df/job_list_link.h"
 #include "df/job_postingst.h"
 #include "df/job_restrictionst.h"
+#include "df/manager_order.h"
 #include "df/plotinfost.h"
 #include "df/specific_ref.h"
 #include "df/unit.h"
@@ -686,3 +687,27 @@ std::string Job::getName(df::job *job)
 
     return desc;
 }
+
+std::string Job::getManagerOrderName(df::manager_order *order)
+{
+    CHECK_NULL_POINTER(order);
+
+    std::string desc;
+    auto button = df::allocate<df::interface_button_building_new_jobst>();
+    button->mstring = order->reaction_name;
+    button->jobtype = order->job_type;
+    button->itemtype = order->item_type;
+    button->subtype = order->item_subtype;
+    button->material = order->mat_type;
+    button->matgloss = order->mat_index;
+    button->specflag = order->specflag;
+    button->job_item_flag = order->material_category;
+    button->specdata = order->specdata;
+    button->art_specifier_id1 = order->art_spec.id;
+    button->art_specifier_id2 = order->art_spec.subid;
+
+    button->text(&desc);
+    delete button;
+
+    return desc;
+}