aboutsummaryrefslogtreecommitdiff
path: root/extension/src/openvic-extension/singletons/PopulationMenu.cpp
blob: 271068bc7ee92959c2daefd06566a2884e460d9d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
#include "MenuSingleton.hpp"

#include <godot_cpp/variant/utility_functions.hpp>

#include <openvic-simulation/DefinitionManager.hpp>
#include <openvic-simulation/InstanceManager.hpp>

#include "openvic-extension/classes/GFXPieChartTexture.hpp"
#include "openvic-extension/classes/GUINode.hpp"
#include "openvic-extension/singletons/GameSingleton.hpp"
#include "openvic-extension/utility/Utilities.hpp"

using namespace godot;
using namespace OpenVic;

/* POPULATION MENU */

Error MenuSingleton::_population_menu_update_provinces() {
   GameSingleton const* game_singleton = GameSingleton::get_singleton();
   ERR_FAIL_NULL_V(game_singleton, FAILED);
   InstanceManager const* instance_manager = game_singleton->get_instance_manager();
   ERR_FAIL_NULL_V(instance_manager, FAILED);

   population_menu.province_list_entries.clear();
   population_menu.visible_province_list_entries = 0;
   ERR_FAIL_COND_V(_population_menu_generate_pop_filters() != OK, FAILED);

   MapInstance const& map_instance = instance_manager->get_map_instance();
   ERR_FAIL_COND_V(!map_instance.province_instances_are_locked(), FAILED);

   for (CountryInstance const* country : {
      // Example country
      instance_manager->get_country_instance_manager().get_country_instance_by_identifier("ENG")
   }) {
      ERR_CONTINUE(country == nullptr);

      population_menu.province_list_entries.emplace_back(population_menu_t::country_entry_t { *country });
      population_menu.visible_province_list_entries++;

      for (StateSet const& state_set : map_instance.get_state_manager().get_state_sets()) {
         for (State const& state : state_set.get_states()) {

            population_menu.province_list_entries.emplace_back(population_menu_t::state_entry_t { state });
            population_menu.visible_province_list_entries++;

            for (ProvinceInstance const* province : state.get_provinces()) {
               population_menu.province_list_entries.emplace_back(population_menu_t::province_entry_t { *province });
            }
         }
      }
   }

   population_menu.sort_key = population_menu_t::NONE;

   emit_signal(_signal_population_menu_province_list_changed());

   // TODO - may need to emit population_menu_province_list_selected_changed if _update_info cannot be guaranteed

   return _population_menu_update_pops();
}

int32_t MenuSingleton::get_population_menu_province_list_row_count() const {
   return population_menu.visible_province_list_entries;
}

TypedArray<Dictionary> MenuSingleton::get_population_menu_province_list_rows(int32_t start, int32_t count) const {
   if (population_menu.province_list_entries.empty()) {
      return {};
   }

   ERR_FAIL_INDEX_V_MSG(
      start, population_menu.visible_province_list_entries, {},
      vformat("Invalid start for population menu province list rows: %d", start)
   );
   ERR_FAIL_COND_V_MSG(count <= 0, {}, vformat("Invalid count for population menu province list rows: %d", count));

   static const StringName type_key = "type";
   static const StringName index_key = "index";
   static const StringName name_key = "name";
   static const StringName size_key = "size";
   static const StringName change_key = "change";
   static const StringName selected_key = "selected";
   /* State-only keys */
   static const StringName expanded_key = "expanded";
   static const StringName colonial_status_key = "colony";
   // TODO - national focus

   struct entry_visitor_t {

      MenuSingleton const& menu_singleton;

      int32_t& start_counter;
      int32_t& count_counter;

      /* This is the index among all entries, not just visible ones unlike start and count. */
      int32_t index = 0;

      bool is_expanded = true;

      TypedArray<Dictionary> array {};

      /* Overloads return false if count_counter reaches 0 and the function should return,
       * otherwise true indicating the province list loop should continue. */

      bool operator()(population_menu_t::country_entry_t const& country_entry) {
         if (start_counter-- <= 0) {
            Dictionary country_dict;

            country_dict[type_key] = population_menu_t::LIST_ENTRY_COUNTRY;
            country_dict[index_key] = index;
            country_dict[name_key] = menu_singleton.get_country_name(country_entry.country);
            country_dict[size_key] = country_entry.country.get_total_population();
            country_dict[change_key] = 0;
            country_dict[selected_key] = country_entry.selected;

            array.push_back(country_dict);

            return --count_counter > 0;
         }

         return true;
      }

      bool operator()(population_menu_t::state_entry_t const& state_entry) {
         is_expanded = state_entry.expanded;

         if (start_counter-- <= 0) {
            Dictionary state_dict;

            state_dict[type_key] = population_menu_t::LIST_ENTRY_STATE;
            state_dict[index_key] = index;
            state_dict[name_key] = menu_singleton.get_state_name(state_entry.state);
            state_dict[size_key] = state_entry.state.get_total_population();
            state_dict[change_key] = 0;
            state_dict[selected_key] = state_entry.selected;
            state_dict[expanded_key] = state_entry.expanded;
            state_dict[colonial_status_key] = false;

            array.push_back(state_dict);

            return --count_counter > 0;
         }

         return true;
      }

      bool operator()(population_menu_t::province_entry_t const& province_entry) {
         if (is_expanded && start_counter-- <= 0) {
            Dictionary province_dict;

            province_dict[type_key] = population_menu_t::LIST_ENTRY_PROVINCE;
            province_dict[index_key] = index;
            province_dict[name_key] = Utilities::std_to_godot_string(province_entry.province.get_identifier());
            province_dict[size_key] = province_entry.province.get_total_population();
            province_dict[change_key] = 0;
            province_dict[selected_key] = province_entry.selected;

            array.push_back(province_dict);

            return --count_counter > 0;
         }

         return  true;
      }
   } entry_visitor { *this, start, count };

   while (entry_visitor.index < population_menu.province_list_entries.size()
      && std::visit(entry_visitor, population_menu.province_list_entries[entry_visitor.index])) {
      entry_visitor.index++;
   }

   return entry_visitor.array;
}

Error MenuSingleton::population_menu_select_province_list_entry(int32_t select_index, bool set_scroll_index) {
   ERR_FAIL_INDEX_V(select_index, population_menu.province_list_entries.size(), FAILED);

   struct entry_visitor_t {

      const int32_t _select_index;

      int32_t index = 0, visible_index = 0;
      bool is_expanded = true;

      int32_t selected_visible_index = -1;

      using enum population_menu_t::ProvinceListEntry;
      population_menu_t::ProvinceListEntry select_level = LIST_ENTRY_NONE;

      void operator()(population_menu_t::country_entry_t& country_entry) {
         if (index == _select_index) {
            select_level = LIST_ENTRY_COUNTRY;

            country_entry.selected = true;

            selected_visible_index = visible_index;
         } else {
            select_level = LIST_ENTRY_NONE;

            country_entry.selected = false;
         }

         visible_index++;
      }

      void operator()(population_menu_t::state_entry_t& state_entry) {
         if (select_level == LIST_ENTRY_COUNTRY) {
            state_entry.selected = true;
         } else if (index == _select_index) {
            select_level = LIST_ENTRY_STATE;

            state_entry.selected = true;

            selected_visible_index = visible_index;
         } else {
            select_level = LIST_ENTRY_NONE;
            state_entry.selected = false;
         }

         visible_index++;

         is_expanded = state_entry.expanded;
      }

      void operator()(population_menu_t::province_entry_t& province_entry) {
         if (select_level == LIST_ENTRY_COUNTRY || select_level == LIST_ENTRY_STATE) {
            province_entry.selected = true;
         } else if (index == _select_index) {
            province_entry.selected = true;

            selected_visible_index = visible_index;
         } else {
            province_entry.selected = false;
         }

         if (is_expanded) {
            visible_index++;
         }
      }

   } entry_visitor { select_index };

   while (entry_visitor.index < population_menu.province_list_entries.size()) {
      std::visit(entry_visitor, population_menu.province_list_entries[entry_visitor.index]);
      entry_visitor.index++;
   }

   emit_signal(
      _signal_population_menu_province_list_selected_changed(),
      set_scroll_index ? entry_visitor.selected_visible_index : -1
   );

   return _population_menu_update_pops();
}

Error MenuSingleton::population_menu_select_province(int32_t province_index) {
   GameSingleton const* game_singleton = GameSingleton::get_singleton();
   ERR_FAIL_NULL_V(game_singleton, FAILED);
   InstanceManager const* instance_manager = game_singleton->get_instance_manager();
   ERR_FAIL_NULL_V(instance_manager, FAILED);

   ERR_FAIL_COND_V(
      province_index <= 0 || province_index > instance_manager->get_map_instance().get_province_instance_count(), FAILED
   );

   struct entry_visitor_t {

      MenuSingleton& menu_singleton;

      const int32_t _province_index;

      int32_t index = 0;

      int32_t state_entry_to_expand = -1;

      bool ret = true;

      /* Overloads return false if the province entry is found and the loop can stop, true otherwise. */

      bool operator()(population_menu_t::country_entry_t& country_entry) {
         return true;
      }

      bool operator()(population_menu_t::state_entry_t& state_entry) {
         if (state_entry.expanded) {
            state_entry_to_expand = -1;
         } else {
            state_entry_to_expand = index;
         }
         return true;
      }

      bool operator()(population_menu_t::province_entry_t& province_entry) {
         if (province_entry.province.get_province_definition().get_index() == _province_index) {

            if (state_entry_to_expand >= 0) {
               ret &= menu_singleton.population_menu_toggle_expanded(state_entry_to_expand, false) == OK;
            }

            ret &= menu_singleton.population_menu_select_province_list_entry(index, true) == OK;

            return false;
         }
         return true;
      }

   } entry_visitor { *this, province_index };

   while (entry_visitor.index < population_menu.province_list_entries.size()
      && std::visit(entry_visitor, population_menu.province_list_entries[entry_visitor.index])) {
      entry_visitor.index++;
   }

   ERR_FAIL_COND_V_MSG(
      entry_visitor.index >= population_menu.province_list_entries.size(), FAILED,
      vformat("Cannot select province index %d - not found in population menu province list!", province_index)
   );

   return ERR(entry_visitor.ret);
}

Error MenuSingleton::population_menu_toggle_expanded(int32_t toggle_index, bool emit_selected_changed) {
   ERR_FAIL_INDEX_V(toggle_index, population_menu.province_list_entries.size(), FAILED);

   population_menu_t::state_entry_t* state_entry =
      std::get_if<population_menu_t::state_entry_t>(&population_menu.province_list_entries[toggle_index]);

   ERR_FAIL_NULL_V_MSG(state_entry, FAILED, vformat("Cannot toggle expansion of a non-state entry! (%d)", toggle_index));

   int32_t provinces = 0;

   while (++toggle_index < population_menu.province_list_entries.size()
      && std::holds_alternative<population_menu_t::province_entry_t>(population_menu.province_list_entries[toggle_index])) {
      provinces++;
   }

   if (state_entry->expanded) {
      state_entry->expanded = false;
      population_menu.visible_province_list_entries -= provinces;
   } else {
      state_entry->expanded = true;
      population_menu.visible_province_list_entries += provinces;
   }

   emit_signal(_signal_population_menu_province_list_changed());

   if (emit_selected_changed) {
      emit_signal(_signal_population_menu_province_list_selected_changed(), -1);
   }

   return OK;
}

Error MenuSingleton::_population_menu_update_pops() {
   for (auto [pop_type, filter] : mutable_iterator(population_menu.pop_filters)) {
      filter.count = 0;
      filter.promotion_demotion_change = 0;
   }

   population_menu.pops.clear();

   for (int32_t index = 0; index < population_menu.province_list_entries.size(); index++) {
      population_menu_t::province_entry_t const* province_entry =
         std::get_if<population_menu_t::province_entry_t>(&population_menu.province_list_entries[index]);

      if (province_entry != nullptr && province_entry->selected) {
         for (Pop const& pop : province_entry->province.get_pops()) {
            population_menu.pops.push_back(&pop);
            population_menu_t::pop_filter_t& filter = population_menu.pop_filters[&pop.get_type()];
            filter.count += pop.get_size();
            // TODO - set filter.promotion_demotion_change
         }
      }
   }

   return _population_menu_update_filtered_pops();
}

Error MenuSingleton::_population_menu_update_filtered_pops() {
   population_menu.filtered_pops.clear();

   for (fixed_point_map_t<HasIdentifierAndColour const*>& distribution : population_menu.distributions) {
      distribution.clear();
   }

   for (Pop const* pop : population_menu.pops) {
      if (population_menu.pop_filters[&pop->get_type()].selected) {
         population_menu.filtered_pops.push_back(pop);
      }
   }

   for (Pop const* pop : population_menu.filtered_pops) {
      population_menu.distributions[0][&pop->get_type()] += pop->get_size();
      population_menu.distributions[1][&pop->get_religion()] += pop->get_size();
      population_menu.distributions[2] +=
         pop->get_ideologies() * static_cast<fixed_point_t>(static_cast<int32_t>(pop->get_size()));
      population_menu.distributions[3][&pop->get_culture()] += pop->get_size();
      population_menu.distributions[4] +=
         cast_map<HasIdentifierAndColour>(pop->get_issues() * static_cast<int32_t>(pop->get_size()));
      population_menu.distributions[5] +=
         pop->get_votes() * static_cast<fixed_point_t>(static_cast<int32_t>(pop->get_size()));
   }

   for (fixed_point_map_t<HasIdentifierAndColour const*>& distribution : population_menu.distributions) {
      normalise_fixed_point_map(distribution);
   }

   return _population_menu_sort_pops();
}

template<typename T>
static constexpr bool indexed_map_lookup_less_than(IndexedMap<T, size_t> const& map, T const& lhs, T const& rhs) {
   return map[lhs] < map[rhs];
}

template<typename T>
static constexpr bool indexed_map_lookup_less_than(IndexedMap<T, size_t> const& map, T const* lhs, T const* rhs) {
   return lhs != nullptr && rhs != nullptr && map[*lhs] < map[*rhs];
}

MenuSingleton::sort_func_t MenuSingleton::_get_population_menu_sort_func(population_menu_t::PopSortKey sort_key) const {
   using enum population_menu_t::PopSortKey;
   switch (sort_key) {
   case SORT_SIZE:
      return [](Pop const* a, Pop const* b) -> bool {
         return a->get_size() < b->get_size();
      };
   case SORT_TYPE:
      return [this](Pop const* a, Pop const* b) -> bool {
         return indexed_map_lookup_less_than(population_menu.pop_type_sort_cache, a->get_type(), b->get_type());
      };
   case SORT_CULTURE:
      return [this](Pop const* a, Pop const* b) -> bool {
         return indexed_map_lookup_less_than(population_menu.culture_sort_cache, a->get_culture(), b->get_culture());
      };
   case SORT_RELIGION:
      return [this](Pop const* a, Pop const* b) -> bool {
         return indexed_map_lookup_less_than(population_menu.religion_sort_cache, a->get_religion(), b->get_religion());
      };
   case SORT_LOCATION:
      return [this](Pop const* a, Pop const* b) -> bool {
         return indexed_map_lookup_less_than(population_menu.province_sort_cache, a->get_location(), b->get_location());
      };
   case SORT_MILITANCY:
      return [](Pop const* a, Pop const* b) -> bool {
         return a->get_militancy() < b->get_militancy();
      };
   case SORT_CONSCIOUSNESS:
      return [](Pop const* a, Pop const* b) -> bool {
         return a->get_consciousness() < b->get_consciousness();
      };
   case SORT_IDEOLOGY:
      return [](Pop const* a, Pop const* b) -> bool {
         return sorted_indexed_map_less_than(a->get_ideologies(), b->get_ideologies());
      };
   case SORT_ISSUES:
      return [](Pop const* a, Pop const* b) -> bool {
         return sorted_fixed_map_less_than(a->get_issues(), b->get_issues());
      };
   case SORT_UNEMPLOYMENT:
      return [](Pop const* a, Pop const* b) -> bool {
         return a->get_unemployment() < b->get_unemployment();
      };
   case SORT_CASH:
      return [](Pop const* a, Pop const* b) -> bool {
         return a->get_cash() < b->get_cash();
      };
   case SORT_LIFE_NEEDS:
      return [](Pop const* a, Pop const* b) -> bool {
         return a->get_life_needs_fulfilled() < b->get_life_needs_fulfilled();
      };
   case SORT_EVERYDAY_NEEDS:
      return [](Pop const* a, Pop const* b) -> bool {
         return a->get_everyday_needs_fulfilled() < b->get_everyday_needs_fulfilled();
      };
   case SORT_LUXURY_NEEDS:
      return [](Pop const* a, Pop const* b) -> bool {
         return a->get_luxury_needs_fulfilled() < b->get_luxury_needs_fulfilled();
      };
   case SORT_REBEL_FACTION:
      return [this](Pop const* a, Pop const* b) -> bool {
         // TODO - include country adjective for [pan-]nationalist rebels
         // TODO - handle social/political reform movements
         return indexed_map_lookup_less_than(
            population_menu.rebel_type_sort_cache, a->get_rebel_type(), b->get_rebel_type()
         );
      };
   case SORT_SIZE_CHANGE:
      return [](Pop const* a, Pop const* b) -> bool {
         return a->get_total_change() < b->get_total_change();
      };
   case SORT_LITERACY:
      return [](Pop const* a, Pop const* b) -> bool {
         return a->get_literacy() < b->get_literacy();
      };
   default:
      UtilityFunctions::push_error("Invalid population menu sort key: ", sort_key);
      return [](Pop const* a, Pop const* b) -> bool { return false; };
   }
}

Error MenuSingleton::_population_menu_sort_pops() {
   if (population_menu.sort_key != population_menu_t::NONE) {
      if (
         !population_menu.pop_type_sort_cache.has_keys() || !population_menu.culture_sort_cache.has_keys() ||
         !population_menu.religion_sort_cache.has_keys() || !population_menu.province_sort_cache.has_keys() ||
         !population_menu.rebel_type_sort_cache.has_keys()
      ) {
         ERR_FAIL_COND_V(population_menu_update_locale_sort_cache() != OK, FAILED);
      }

      const sort_func_t base_sort_func = _get_population_menu_sort_func(population_menu.sort_key);

      const sort_func_t sort_func = population_menu.sort_descending
         ? base_sort_func
         : [base_sort_func](Pop const* a, Pop const* b) { return base_sort_func(b, a); };

      std::sort(population_menu.filtered_pops.begin(), population_menu.filtered_pops.end(), sort_func);
   }

   emit_signal(_signal_population_menu_pops_changed());

   return OK;
}

Error MenuSingleton::population_menu_update_locale_sort_cache() {
   GameSingleton const* game_singleton = GameSingleton::get_singleton();
   ERR_FAIL_NULL_V(game_singleton, FAILED);
   InstanceManager const* instance_manager = game_singleton->get_instance_manager();
   ERR_FAIL_NULL_V(instance_manager, FAILED);

   std::vector<String> localised_items;
   std::vector<size_t> sorted_items;

   const auto generate_sort_cache = [this, &localised_items, &sorted_items]<HasGetIdentifier T>(
      IndexedMap<T, size_t>& cache, std::vector<T> const& items
   ) {
      localised_items.resize(items.size());
      sorted_items.resize(items.size());

      for (size_t idx = 0; idx < items.size(); ++idx) {
         String identifier = Utilities::std_to_godot_string(items[idx].get_identifier());
         if constexpr (std::is_same_v<T, ProvinceInstance>) {
            identifier = GUINode::format_province_name(identifier);
         }
         localised_items[idx] = tr(identifier).to_lower();
         sorted_items[idx] = idx;
      }

      std::sort(
         sorted_items.begin(), sorted_items.end(), [&localised_items](size_t a, size_t b) -> bool {
            return localised_items[a] < localised_items[b];
         }
      );

      cache.set_keys(&items);
      for (size_t idx = 0; idx < sorted_items.size(); ++idx) {
         cache[sorted_items[idx]] = idx;
      }
   };

   generate_sort_cache(
      population_menu.pop_type_sort_cache,
      game_singleton->get_definition_manager().get_pop_manager().get_pop_types()
   );
   generate_sort_cache(
      population_menu.culture_sort_cache,
      game_singleton->get_definition_manager().get_pop_manager().get_culture_manager().get_cultures()
   );
   generate_sort_cache(
      population_menu.religion_sort_cache,
      game_singleton->get_definition_manager().get_pop_manager().get_religion_manager().get_religions()
   );
   generate_sort_cache(
      population_menu.province_sort_cache,
      instance_manager->get_map_instance().get_province_instances()
   );
   generate_sort_cache(
      population_menu.rebel_type_sort_cache,
      game_singleton->get_definition_manager().get_politics_manager().get_rebel_manager().get_rebel_types()
   );

   return OK;
}

Error MenuSingleton::population_menu_select_sort_key(population_menu_t::PopSortKey sort_key) {
   using enum population_menu_t::PopSortKey;
   /* sort_key must be cast here to avoid causing clang to segfault during compilation. */
   ERR_FAIL_INDEX_V_MSG(
      static_cast<int32_t>(sort_key), static_cast<int32_t>(MAX_SORT_KEY), FAILED,
      vformat("Invalid population menu sort key: %d (must be under %d)", sort_key, MAX_SORT_KEY)
   );

   if (sort_key == population_menu.sort_key) {
      /* Re-selecting the current sort key reverses sort order. */
      population_menu.sort_descending = !population_menu.sort_descending;
   } else {
      /* Selecting a new sort key switches sorting to that key, preserving the existing sort order. */
      population_menu.sort_key = sort_key;
   }

   return _population_menu_sort_pops();
}

TypedArray<Dictionary> MenuSingleton::get_population_menu_pop_rows(int32_t start, int32_t count) const {
   if (population_menu.filtered_pops.empty()) {
      return {};
   }
   ERR_FAIL_INDEX_V_MSG(
      start, population_menu.filtered_pops.size(), {}, vformat("Invalid start for population menu pop rows: %d", start)
   );
   ERR_FAIL_COND_V_MSG(count <= 0, {}, vformat("Invalid count for population menu pop rows: %d", count));

   if (start + count > population_menu.filtered_pops.size()) {
      count = population_menu.filtered_pops.size() - start;
   }

   static const StringName pop_size_key = "size";

   static const StringName pop_type_icon_key = "pop_type_icon";
   // TODO - pop type name
   // TODO - promotions (target pop type and count)
   // TODO - demotions (target pop type and count)
   // TODO - good being produced (artisans, farmers, labourers, slaves)
   // TODO - military unit and army (soldiers)

   static const StringName pop_culture_key = "culture";
   // TODO - cultural assimilation (primary/accepted, or number, target culture, and conditional weights breakdown)

   static const StringName pop_religion_icon_key = "religion_icon";
   // TODO - religion name
   // TODO - religious conversion (accepted, or number, target religion, and conditional weights breakdown)

   static const StringName pop_location_key = "location";
   // TODO - internal, external and colonial migration

   static const StringName pop_militancy_key = "militancy";
   // TODO - monthly militancy change and modifier breakdown

   static const StringName pop_consciousness_key = "consciousness";
   // TODO - monthly consciousness change and modifier breakdown

   static const StringName pop_ideology_key = "ideology";

   static const StringName pop_issues_key = "issues";

   static const StringName pop_unemployment_key = "unemployment";

   static const StringName pop_cash_key = "cash";
   // TODO - daily income, needs, salary and savings

   static const StringName pop_life_needs_key = "life_needs";
   static const StringName pop_everyday_needs_key = "everyday_needs";
   static const StringName pop_luxury_needs_key = "luxury_needs";
   // TODO - goods not available on market or goods not affordale + price (for all 3 needs types)

   static const StringName pop_rebel_icon_key = "rebel_icon";
   // TODO - rebel faction name/description
   // TODO - icons for social/political reform movements
   // TODO - flags for country-related rebels

   static const StringName pop_size_change_key = "size_change";
   // TODO - size change breakdown

   static const StringName pop_literacy_key = "literacy";
   // TODO - monthly change

   TypedArray<Dictionary> array;
   ERR_FAIL_COND_V(array.resize(count) != OK, {});

   for (int32_t idx = 0; idx < count; ++idx) {
      Pop const* pop = population_menu.filtered_pops[start + idx];
      Dictionary pop_dict;

      pop_dict[pop_size_key] = pop->get_size();
      pop_dict[pop_type_icon_key] = pop->get_type().get_sprite();
      pop_dict[pop_culture_key] = Utilities::std_to_godot_string(pop->get_culture().get_identifier());
      pop_dict[pop_religion_icon_key] = pop->get_religion().get_icon();
      if (pop->get_location() != nullptr) {
         pop_dict[pop_location_key] = Utilities::std_to_godot_string(pop->get_location()->get_identifier());
      }
      pop_dict[pop_militancy_key] = pop->get_militancy().to_float();
      pop_dict[pop_consciousness_key] = pop->get_consciousness().to_float();
      pop_dict[pop_ideology_key] = GFXPieChartTexture::distribution_to_slices_array(pop->get_ideologies());
      pop_dict[pop_issues_key] = GFXPieChartTexture::distribution_to_slices_array(pop->get_issues());
      pop_dict[pop_unemployment_key] = pop->get_unemployment().to_float();
      pop_dict[pop_cash_key] = pop->get_cash().to_float();
      pop_dict[pop_life_needs_key] = pop->get_life_needs_fulfilled().to_float();
      pop_dict[pop_everyday_needs_key] = pop->get_everyday_needs_fulfilled().to_float();
      pop_dict[pop_luxury_needs_key] = pop->get_luxury_needs_fulfilled().to_float();
      if (pop->get_rebel_type() != nullptr) {
         pop_dict[pop_rebel_icon_key] = pop->get_rebel_type()->get_icon();
      }
      pop_dict[pop_size_change_key] = pop->get_total_change();
      pop_dict[pop_literacy_key] = pop->get_literacy().to_float();

      array[idx] = std::move(pop_dict);
   }

   return array;
}

int32_t MenuSingleton::get_population_menu_pop_row_count() const {
   return population_menu.filtered_pops.size();
}

Error MenuSingleton::_population_menu_generate_pop_filters() {
   if (population_menu.pop_filters.empty()) {
      GameSingleton const* game_singleton = GameSingleton::get_singleton();
      ERR_FAIL_NULL_V(game_singleton, FAILED);

      for (PopType const& pop_type : game_singleton->get_definition_manager().get_pop_manager().get_pop_types()) {
         population_menu.pop_filters.emplace(&pop_type, population_menu_t::pop_filter_t { 0, 0, true });
      }

      ERR_FAIL_COND_V_MSG(population_menu.pop_filters.empty(), FAILED, "Failed to generate population menu pop filters!");
   }

   return OK;
}

PackedInt32Array MenuSingleton::get_population_menu_pop_filter_setup_info() {
   ERR_FAIL_COND_V(_population_menu_generate_pop_filters() != OK, {});

   PackedInt32Array array;
   ERR_FAIL_COND_V(array.resize(population_menu.pop_filters.size()) != OK, {});

   for (int32_t idx = 0; idx < array.size(); ++idx) {
      array[idx] = population_menu.pop_filters.data()[idx].first->get_sprite();
   }

   return array;
}

TypedArray<Dictionary> MenuSingleton::get_population_menu_pop_filter_info() const {
   static const StringName pop_filter_count_key = "count";
   static const StringName pop_filter_change_key = "change";
   static const StringName pop_filter_selected_key = "selected";

   TypedArray<Dictionary> array;
   ERR_FAIL_COND_V(array.resize(population_menu.pop_filters.size()) != OK, {});

   for (int32_t idx = 0; idx < array.size(); ++idx) {
      population_menu_t::pop_filter_t const& filter = population_menu.pop_filters.data()[idx].second;

      Dictionary filter_dict;

      filter_dict[pop_filter_count_key] = filter.count;
      filter_dict[pop_filter_change_key] = filter.promotion_demotion_change;
      filter_dict[pop_filter_selected_key] = filter.selected;

      array[idx] = std::move(filter_dict);
   }

   return array;
}

Error MenuSingleton::population_menu_toggle_pop_filter(int32_t index) {
   ERR_FAIL_COND_V_MSG(
      index < 0 || index >= population_menu.pop_filters.size(), FAILED, vformat("Invalid pop filter index: %d", index)
   );

   population_menu_t::pop_filter_t& filter = mutable_iterator(population_menu.pop_filters).begin()[index].second;
   filter.selected = !filter.selected;

   return _population_menu_update_filtered_pops();
}

Error MenuSingleton::population_menu_select_all_pop_filters() {
   bool changed = false;

   for (auto [pop_type, filter] : mutable_iterator(population_menu.pop_filters)) {
      if (!filter.selected) {
         filter.selected = true;
         changed = true;
      }
   }

   if (changed) {
      return _population_menu_update_filtered_pops();
   }

   return OK;
}

Error MenuSingleton::population_menu_deselect_all_pop_filters() {
   bool changed = false;
   for (auto [pop_type, filter] : mutable_iterator(population_menu.pop_filters)) {
      if (filter.selected) {
         filter.selected = false;
         changed = true;
      }
   }

   if (changed) {
      return _population_menu_update_filtered_pops();
   }

   return OK;
}

PackedStringArray MenuSingleton::get_population_menu_distribution_setup_info() const {
   static const PackedStringArray distribution_names = []() -> PackedStringArray {
      constexpr std::array<char const*, population_menu_t::DISTRIBUTION_COUNT> NAMES {
         /* Workforce (PopType)   */       "WORKFORCE_DISTTITLE",
         /* Religion              */        "RELIGION_DISTTITLE",
         /* Ideology              */        "IDEOLOGY_DISTTITLE",
         /* Nationality (Culture) */     "NATIONALITY_DISTTITLE",
         /* Issues                */ "DOMINANT_ISSUES_DISTTITLE",
         /* Vote                  */      "ELECTORATE_DISTTITLE"
      };

      PackedStringArray array;
      ERR_FAIL_COND_V(array.resize(NAMES.size()) != OK, {});

      for (int32_t idx = 0; idx < array.size(); ++idx) {
         array[idx] = NAMES[idx];
      }

      return array;
   }();

   return distribution_names;
}

TypedArray<Array> MenuSingleton::get_population_menu_distribution_info() const {
   TypedArray<Array> array;
   ERR_FAIL_COND_V(array.resize(population_menu.distributions.size()) != OK, {});

   for (int32_t idx = 0; idx < array.size(); ++idx) {
      array[idx] = GFXPieChartTexture::distribution_to_slices_array(population_menu.distributions[idx]);
   }

   return array;
}