orders: add search overlay for manager orders #5677

pajawojciech · 2025-12-02T20:30:42Z

Add search to manager orders

Adds search box to find orders by job name + arrow indicators to show which one you're looking at.

What it does

Search box appears on orders screen (Alt+S to focus)
Type keywords to filter (e.g. "iron picks" finds "forge iron picks")
Multi-word search works in any order ("picks iron" and "pi ir" also matches)
Alt+P/N to jump between matches. Also Enter and Shift+Enter works when focused
Shows "3 of 12" style counter
Arrow point at current match
Arrows hide when you: scroll view, edit search or add / remove from orders list

Implementation

Uses stockflow reaction names for search (see Fix user-friendly job names so that they are the same as in the manager menu scripts#1524 for upcoming names update to match in-game text)
Two overlays: OrdersSearchOverlay for search UI, OrderHighlightOverlay for arrows
Both disabled by default until stockflow names are updated to match in-game text
Moved importexport overlay position to make room for search (and make new version of config)

What didn't work

Tried to clear search input when exiting orders window - couldn't find reliable way to detect window exit

Related issues

order-search.mp4

Adds search overlay to find and navigate manager orders with arrow indicators showing current search result. Search uses Alt+S to focus, Alt+P/N for prev/next navigation. Overlays are disabled by default.

plugins/lua/orders.lua

ChrisJohnsen

This is a nice workaround for the inability to filter the view like in the other info panel search widgets.

I like the labeled magic numbers in OrderHighlightOverlay. DF's layout behavior is not fun thing to have to replicate, but I think this would be fairly clear to someone that hasn't looked at this stuff as much (at least as long as they have DF at hand to try out different window sizes).

Re: not being able to detect exiting the window: yeah, I have also wanted something
like a callback for "this overlay is no longer active (not going to be rendered)".

Would utils.search_text be useful here? The main SortOverlay uses it for searching.
Could the first match automatically be highlighted on Enter?
I can see how you might not want to highlight (thus likely move the scroll position) for each change in search input, but Enter seems like a nice place to jump to the first match.
The highlight should probably be cleared when the search text changes (especially when the highlighted order does not match the new search input).
It might just be my color vision being flaky, but I completely did not notice the highlight arrow at first. Now that I know what to look for, it isn't hard to spot. But my first cycling through the matches was confusing because it wasn't obvious which order was being indicated.

plugins/lua/orders.lua

Now there is 16 visible chars in search

pajawojciech · 2025-12-07T09:06:12Z

* Would utils.search_text be useful here? The main SortOverlay uses it for searching.

I switched to using utils.search_text instead of the custom search logic

* Could the first match automatically be highlighted on Enter?

Added Enter/Shift+Enter to cycle through matches using the default submit/submit2 methods.

* The highlight should probably be cleared when the search text changes (especially when the highlighted order does not match the new search input).

Fixed, now the highlight gets cleared whenever the search text changes.

* It might just be my color vision being flaky, but I completely did not notice the highlight arrow at first. Now that I know what to look for, it isn't hard to spot. But my first cycling through the matches was confusing because it wasn't obvious which order was being indicated.

I reshaped the arrow, moved it to the right side of icon and used more contrasting colors (black on white) to make it more visible.

@ChrisJohnsen Thanks for all the detailed feedback! I made each change in a separate commit to make the review easier. Let me know if there's anything else that needs adjusting.

…rders-search

ChrisJohnsen

Good spotting of the need to hide when job_details.open. The other functionality changes all seem good (with a new note about order deletion handling).

I've put some more thoughts on the specifics of the code in this review.

ChrisJohnsen · 2025-12-07T10:33:48Z

plugins/lua/orders.lua

+-- Shared state for search cursor visibility
+local search_cursor_visible = false
+local search_last_scroll_position = -1
+local order_count_at_highlight = 0


The first two of these are shadowed later by the locals declared at the top of the OrdersSearchOverlay section. Probably all these search/highlight locals should just be consolidated in that section.

ChrisJohnsen · 2025-12-07T12:11:29Z

plugins/lua/orders.lua

+    for i = 0, #orders - 1 do
+        local order = orders[i]
+        local search_key = get_order_search_key(order)
+        if search_key and utils.search_text(search_key, text) then


As it currently is, get_order_search_key has the following returns:

some non-falsy value from the reaction map

an empty string
(it can also throw an error if the reaction map couldn't be loaded)

All of the return values are currently "truthy", so they won't affect the if condition here.

Searching an empty search_key will only "succeed" when it is searched for an empty string, which won't happen here because of the guard before the loop. So it all works, but it indicates a misalignment with the definition of get_order_search_key.

Probably it makes the most sense to keep this check and change get_order_search_key to return nil if the reaction map isn't available (guarding against a potential "attempt to index a nil value" error there) or if the map didn't have an entry for the order.

ChrisJohnsen · 2025-12-07T12:32:39Z

plugins/lua/orders.lua

+    self.cached_list_start_y = nil
+    self.cached_viewport_size = nil
+    self.cached_screen_width = nil
+    self.cached_screen_height = nil


None of these appear to be used anywhere?

ChrisJohnsen · 2025-12-07T12:36:58Z

plugins/lua/orders.lua

+    self.ORDER_HEIGHT = 3
+    self.TABS_WIDTH_THRESHOLD = 155
+    self.LIST_START_Y_ONE_TABS_ROW = 8
+    self.LIST_START_Y_TWO_TABS_ROWS = 10
+    self.BOTTOM_MARGIN = 9
+    self.ARROW_X = 10


These constants don't need to be fields of the overlay. Probably just a collection of module-locals at the top of the OrderHighlightOverlay section would be fine.

ChrisJohnsen · 2025-12-07T12:41:32Z

plugins/lua/orders.lua

+    self.ARROW_FG = COLOR_BLACK
+    self.ARROW_BG = COLOR_WHITE


These values can probably just be inlined into the dfhack.pen.parse call. The table key names there will establish the fg/bg intentions.

plugins/lua/orders.lua

ChrisJohnsen · 2025-12-07T13:31:29Z

plugins/lua/orders.lua

+function OrderHighlightOverlay:render(dc)
+    if mi.job_details.open then return end
+
+    if search_cursor_visible then


The indentation isn't getting too bad here, but this might be better as a early-returning guard instead of having the rest of the body of the function tucked into the if block. It makes it clear that nothing else is going to happen for the guarded condition.

E.g.

if not search_cursor_visible then return end

ChrisJohnsen · 2025-12-07T13:48:20Z

plugins/lua/orders.lua

+    return selected_y
+end
+
+function OrderHighlightOverlay:render(dc)


It is a good idea bring back an unconditional call to the super render method here. It isn't technically necessary since there is nothing else that needs to be drawn in this overlay (e.g., a frame, sub-widgets, or onRenderFrame/onRenderBody methods), but having it can prevent hard-to-guess-at "why isn't this stuff isn't being drawn?" problems if any of those are added in the future.

ChrisJohnsen · 2025-12-07T14:01:42Z

plugins/lua/orders.lua

+        encrust_str)
+end
+
+local function build_reaction_map()


build_reaction_map could be inlined into get_cached_reaction_map (the only caller). I don't think there is any need to have the non-caching version available. An early return (if the map is already cached) can be used to limit the nesting in get_cached_reaction_map.

pajawojciech added 3 commits December 2, 2025 20:55

orders: add search overlay for manager orders

71a1a32

Adds search overlay to find and navigate manager orders with arrow indicators showing current search result. Search uses Alt+S to focus, Alt+P/N for prev/next navigation. Overlays are disabled by default.

Fix trailing whitespace

cfaa140

Newline at the end

16ab556

ab9rf reviewed Dec 4, 2025

View reviewed changes

plugins/lua/orders.lua Show resolved Hide resolved

ChrisJohnsen reviewed Dec 5, 2025

View reviewed changes

pajawojciech marked this pull request as draft December 6, 2025 13:06

pajawojciech added 11 commits December 6, 2025 17:49

orders: load cache reaction map on init

e368607

Add Enter/Shift+Enter navigation and refactor jump to match

b46eb7f

Hide search highlight when filter text changes

cde1477

Use full_interface for OrderHighlightOverlay to prevent repositioning

7fa03fb

Hide highlight when order list changes

c163d3c

Consolidate onRenderFrame into render method

f37e46a

Use utils.search_text instead of custom search

506ca40

Force new version of overlay position

7fabf2b

Narrow search overlay and adjust button positions

2cbf2d7

Now there is 16 visible chars in search

Reshape arrow and contrasting colors

1f2705d

Merge branch 'develop' into orders-search

0650a74

pajawojciech added 3 commits December 7, 2025 10:27

Hide overlay when job_details is open. Add author

93f6b1c

Merge branch 'orders-search' of github.com:pajawojciech/dfhack into o…

b184150

…rders-search

Remove trailing spaces

6bd16ad

pajawojciech marked this pull request as ready for review December 7, 2025 11:18

ChrisJohnsen reviewed Dec 7, 2025

View reviewed changes

pajawojciech marked this pull request as draft December 8, 2025 19:15

orders: add search overlay for manager orders #5677

Are you sure you want to change the base?

orders: add search overlay for manager orders #5677

Conversation

pajawojciech commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add search to manager orders

What it does

Implementation

What didn't work

Related issues

Uh oh!

Uh oh!

ChrisJohnsen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pajawojciech commented Dec 7, 2025

Uh oh!

ChrisJohnsen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pajawojciech commented Dec 2, 2025 •

edited

Loading