expose range to callers

myk002 · myk002 · commit 05b8c01dd23f · 2024-03-22T00:17:34.000-07:00
so they can control their own for loops
diff --git a/library/include/modules/Units.h b/library/include/modules/Units.h
@@ -41,6 +41,8 @@ distribution.
 #include "df/unit_action.h"
 #include "df/unit_action_type_group.h"
 
+#include <ranges>
+
 namespace df
 {
     struct activity_entry;
@@ -159,6 +161,17 @@ DFHACK_EXPORT bool getUnitsInBox(std::vector<df::unit*> &units,
     int16_t x2, int16_t y2, int16_t z2);
 DFHACK_EXPORT bool getUnitsByNobleRole(std::vector<df::unit *> &units, std::string noble);
 DFHACK_EXPORT df::unit *getUnitByNobleRole(std::string noble);
+
+inline auto citizensRange(std::vector<df::unit *> &vec, bool exclude_residents = false, bool include_insane = false) {
+    return vec |
+        std::views::filter([=](df::unit * unit) {
+            if (isDead(unit) || !isActive(unit))
+                return false;
+            return isCitizen(unit, include_insane) ||
+                (!exclude_residents && isResident(unit, include_insane));
+        });
+}
+
 DFHACK_EXPORT void forCitizens(std::function<void(df::unit *)> fn, bool exclude_residents = false, bool include_insane = false);
 DFHACK_EXPORT bool getCitizens(std::vector<df::unit *> &citizens, bool exclude_residents = false, bool include_insane = false);
 
diff --git a/library/modules/Units.cpp b/library/modules/Units.cpp
@@ -89,7 +89,6 @@ distribution.
 #include <algorithm>
 #include <numeric>
 #include <functional>
-#include <ranges>
 
 using std::string;
 using std::vector;
@@ -921,23 +920,13 @@ df::unit *Units::getUnitByNobleRole(string noble) {
     return units[0];
 }
 
-static auto citizensRange(bool exclude_residents, bool include_insane) {
-    return world->units.active |
-        std::views::filter([=](df::unit * unit) {
-            if (Units::isDead(unit) || !Units::isActive(unit))
-                return false;
-            return Units::isCitizen(unit, include_insane) ||
-                (!exclude_residents && Units::isResident(unit, include_insane));
-        });
-}
-
 void Units::forCitizens(std::function<void(df::unit *)> fn, bool exclude_residents, bool include_insane) {
-    for (auto unit : citizensRange(exclude_residents, include_insane))
+    for (auto unit : citizensRange(world->units.active, exclude_residents, include_insane))
         fn(unit);
 }
 
-bool Units::getCitizens(std::vector<df::unit *> & citizens, bool exclude_residents, bool include_insane) {
-    for (auto unit : citizensRange(exclude_residents, include_insane))
+bool Units::getCitizens(vector<df::unit *> & citizens, bool exclude_residents, bool include_insane) {
+    for (auto unit : citizensRange(world->units.active, exclude_residents, include_insane))
         citizens.emplace_back(unit);
     return true;
 }
diff --git a/plugins/reveal.cpp b/plugins/reveal.cpp
@@ -445,9 +445,10 @@ command_result revflood(color_ostream &out, vector<string> & params) {
             pos = Units::getPosition(unit);
     }
     if (!pos.isValid()) {
-        Units::forCitizens([&](auto unit) {
+        for (auto unit : Units::citizensRange(world->units.active)) {
             pos = Units::getPosition(unit);
-        });
+            break;
+        }
     }
     if (!pos.isValid()) {
         out.printerr("Please select a unit or place the keyboard cursor at some empty space you want to be unhidden.\n");
diff --git a/plugins/tailor.cpp b/plugins/tailor.cpp
@@ -242,10 +242,10 @@ class Tailor {
 
     void scan_replacements()
     {
-        Units::forCitizens([&](auto u) {
+        for (auto u : Units::citizensRange(world->units.active)) {
             if (Units::isBaby(u) ||
                 !Units::casteFlagSet(u->race, u->caste, df::enums::caste_raw_flags::EQUIPS))
-                return; // skip units we don't control or that can't wear clothes
+                continue; // skip units we don't control or that can't wear clothes
 
             std::set <df::item_type> wearing;
             std::set <df::item_type> ordered;
@@ -326,7 +326,7 @@ class Tailor {
                     needed[std::make_pair(ty, usize)] += 1;
                 }
             }
-        });
+        }
     }
 
     void create_orders()

Original file line number	Diff line number	Diff line change
`@@ -445,9 +445,10 @@ command_result revflood(color_ostream &out, vector<string> & params) {`
`445`	`445`	`pos = Units::getPosition(unit);`
`446`	`446`	`}`
`447`	`447`	`if (!pos.isValid()) {`
`448`		`- Units::forCitizens([&](auto unit) {`
	`448`	`+ for (auto unit : Units::citizensRange(world->units.active)) {`
`449`	`449`	`pos = Units::getPosition(unit);`
`450`		`- });`
	`450`	`+ break;`
	`451`	`+ }`
`451`	`452`	`}`
`452`	`453`	`if (!pos.isValid()) {`
`453`	`454`	`out.printerr("Please select a unit or place the keyboard cursor at some empty space you want to be unhidden.\n");`
Original file line number	Diff line number	Diff line change
`@@ -242,10 +242,10 @@ class Tailor {`
`242`	`242`
`243`	`243`	`void scan_replacements()`
`244`	`244`	`{`
`245`		`- Units::forCitizens([&](auto u) {`
	`245`	`+ for (auto u : Units::citizensRange(world->units.active)) {`
`246`	`246`	`if (Units::isBaby(u) \|\|`
`247`	`247`	`!Units::casteFlagSet(u->race, u->caste, df::enums::caste_raw_flags::EQUIPS))`
`248`		`- return; // skip units we don't control or that can't wear clothes`
	`248`	`+ continue; // skip units we don't control or that can't wear clothes`
`249`	`249`
`250`	`250`	`std::set <df::item_type> wearing;`
`251`	`251`	`std::set <df::item_type> ordered;`
`@@ -326,7 +326,7 @@ class Tailor {`
`326`	`326`	`needed[std::make_pair(ty, usize)] += 1;`
`327`	`327`	`}`
`328`	`328`	`}`
`329`		`- });`
	`329`	`+ }`
`330`	`330`	`}`
`331`	`331`
`332`	`332`	`void create_orders()`