Merge pull request #26 from Atria1234/report-progress

Created permament gui elements for progress bar and show/hide them as needed

Author: tburrows13

control.lua

@@ -32,6 +32,8 @@ require "scripts.remote"
 ---@field include_requesters LuaGuiElement checkbox
 ---@field include_signals LuaGuiElement checkbox
 ---@field include_map_tags LuaGuiElement checkbox
+---@field searching_label LuaGuiElement label
+---@field search_progressbar LuaGuiElement progressbar
 ---@field result_flow LuaGuiElement flow
 ---@field highlighted_button? LuaGuiElement sprite-button
 
@@ -74,6 +76,8 @@ require "scripts.remote"
 ---@field not_started_surfaces LuaSurface[]
 ---@field search_complete boolean
 ---@field current_surface_search_data? CurrentSurfaceSearchData Used for non-blocking searches
+---@field total_chunk_count number
+---@field completed_chunk_count number
 
 ---@class (exact) EntityGroup
 ---@field count number

scripts/search-gui.lua

@@ -262,7 +262,8 @@ function SearchGui.build_results(data, statistics, frame, check_result_found, in
             column_count = 10,
             style = "slot_table",
             children = SearchGui.build_surface_results(surface_name, surface_data.logistics)
-          },          {
+          },
+          {
             type = "table",
             column_count = 10,
             style = "slot_table",
@@ -339,20 +340,29 @@ function SearchGui.build_invalid_state(frame)
   })
 end
 
----@param frame LuaGuiElement
-function SearchGui.add_loading_results(frame)
-  gui.add(frame,
-    {
-      type = "label",
-      caption = {"search-gui.searching"},
-      tooltip = {"search-gui.searching-tooltip", {"", "[font=default-semibold]", {"mod-setting-name.fs-non-blocking-search"}, "[/font]"}}
-    }
-  )
+---@param refs SearchGuiRefs
+---@param progress? double
+function SearchGui.show_search_progress(refs, progress)
+  refs.searching_label.visible = true
+  refs.search_progressbar.visible = progress ~= nil
+  
+  if progress ~= nil then
+    refs.search_progressbar.value = progress
+    refs.search_progressbar.tooltip = {'', math.floor(progress * 100), '%'}
+  end
 end
 
-function SearchGui.build_loading_results(frame)
-  frame.clear()
-  SearchGui.add_loading_results(frame)
+---@param refs SearchGuiRefs
+function SearchGui.hide_search_progress(refs)
+  refs.searching_label.visible = false
+  refs.search_progressbar.visible = false
+end
+
+---@param refs SearchGuiRefs
+---@param progress? double
+function SearchGui.build_loading_results(refs, progress)
+  refs.result_flow.clear()
+  SearchGui.show_search_progress(refs, progress)
 end
 
 ---@param player LuaPlayer
@@ -584,12 +594,37 @@ function SearchGui.build(player)
                   children = {
                     {
                       type = "flow",
-                      ref = {"result_flow"},
                       direction = "vertical",
                       children = {
                         {
-                          type = "label",
-                          caption = {"search-gui.explanation"},
+                          type = "flow",
+                          direction = "vertical",
+                          children = {
+                            {
+                              type = "label",
+                              ref = { "searching_label" },
+                              visible = false,
+                              caption = {"search-gui.searching"},
+                              tooltip = {"search-gui.searching-tooltip", {"", "[font=default-semibold]", {"mod-setting-name.fs-non-blocking-search"}, "[/font]"}}
+                            },
+                            {
+                              type = "progressbar",
+                              ref = { "search_progressbar" },
+                              visible = false,
+                              value = 0
+                            }
+                          }
+                        },
+                        {
+                          type = "flow",
+                          ref = {"result_flow"},
+                          direction = "vertical",
+                          children = {
+                            {
+                              type = "label",
+                              caption = {"search-gui.explanation"},
+                            }
+                          }
                         }
                       }
                     }
@@ -755,7 +790,11 @@ function SearchGui.start_search(player, player_data, _, _, immediate)
       search_started = Search.find_machines(item, force, state, player, immediate)
       refs.subheader_title.caption = get_signal_name(item) or ""
       if search_started then
-        SearchGui.build_loading_results(refs.result_flow)
+        if storage.current_searches[player.index].blocking then
+          SearchGui.build_loading_results(refs, nil)
+        else
+          SearchGui.build_loading_results(refs, 0)
+        end
       else
         SearchGui.build_results({}, {}, refs.result_flow)
       end

scripts/search.lua

@@ -780,6 +780,7 @@ function Search.blocking_search(force, state, target_item, surface_list, type_li
   local player_data = storage.players[player.index]
   local refs = player_data.refs
   SearchGui.build_results(data, statistics, refs.result_flow)
+  SearchGui.hide_search_progress(refs)
   storage.current_searches[player.index] = nil
 end
 
@@ -800,6 +801,7 @@ function on_tick()
     local player_data = storage.players[player_index]
     local refs = player_data.refs
     SearchGui.build_results(search_data.data, search_data.statistics, refs.result_flow)
+    SearchGui.hide_search_progress(refs)
     storage.current_searches[player_index] = nil
   end
 
@@ -832,7 +834,6 @@ function on_tick()
     local player_data = storage.players[player_index]
     local refs = player_data.refs
     SearchGui.build_results(search_data.data, search_data.statistics, refs.result_flow, false, true)
-    SearchGui.add_loading_results(refs.result_flow)
     return  -- Start next surface processing on next tick
   end
 
@@ -854,6 +855,9 @@ function on_tick()
       search_data.data[current_surface.name] = current_surface_search_data.surface_data
       search_data.statistics[current_surface.name] = current_surface_search_data.surface_statistics
       search_data.current_surface_search_data = nil
+
+      search_data.completed_chunk_count = search_data.completed_chunk_count + chunks_processed
+      SearchGui.show_search_progress(storage.players[player_index].refs, search_data.completed_chunk_count / search_data.total_chunk_count)
       return
     end
 
@@ -941,6 +945,9 @@ function on_tick()
     end
     ::continue::
   end
+
+  search_data.completed_chunk_count = search_data.completed_chunk_count + chunks_processed
+  SearchGui.show_search_progress(storage.players[player_index].refs, search_data.completed_chunk_count / search_data.total_chunk_count)
 end
 
 ---@param target_item SignalID
@@ -1020,9 +1027,18 @@ function Search.find_machines(target_item, force, state, player, immediate)
     surface_list = filtered_surfaces()
   end
 
+  local total_chunk_count = 0
   local non_blocking_setting = settings.global["fs-non-blocking-search"].value
   if non_blocking_setting == "on" or (non_blocking_setting == "multiplayer" and game.is_multiplayer()) then
     non_blocking_search = true
+
+    for _, surface in ipairs(surface_list) do
+      for chunk in surface.get_chunks() do
+        if force.is_chunk_charted(surface, chunk) then
+          total_chunk_count = total_chunk_count + 1
+        end
+      end
+    end
   else
     non_blocking_search = false
   end
@@ -1039,6 +1055,8 @@ function Search.find_machines(target_item, force, state, player, immediate)
     statistics = {},
     not_started_surfaces = surface_list,
     search_complete = false,
+    total_chunk_count = total_chunk_count,
+    completed_chunk_count = 0
   }
   storage.current_searches[player.index] = search_data
   return true