aboutsummaryrefslogtreecommitdiff
path: root/src/openvic-simulation/map/Map.cpp
blob: 1e68cc60edca5cd5911ad2cf1323428c346546f1 (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
#include "Map.hpp"

#include <cassert>
#include <unordered_set>

#include "openvic-simulation/economy/Good.hpp"
#include "openvic-simulation/history/ProvinceHistory.hpp"
#include "openvic-simulation/utility/BMP.hpp"
#include "openvic-simulation/utility/Logger.hpp"

using namespace OpenVic;
using namespace OpenVic::NodeTools;

Mapmode::Mapmode(
   std::string_view new_identifier, index_t new_index, colour_func_t new_colour_func
) : HasIdentifier { new_identifier }, index { new_index }, colour_func { new_colour_func } {
   assert(colour_func != nullptr);
}

const Mapmode Mapmode::ERROR_MAPMODE {
   "mapmode_error", 0, [](Map const& map, Province const& province) -> colour_t { return 0xFFFF0000; }
};

Mapmode::base_stripe_t Mapmode::get_base_stripe_colours(Map const& map, Province const& province) const {
   return colour_func ? colour_func(map, province) : NULL_COLOUR;
}

bool Map::add_province(std::string_view identifier, colour_t colour) {
   if (provinces.size() >= max_provinces) {
      Logger::error(
         "The map's province list is full - maximum number of provinces is ", max_provinces, " (this can be at most ",
         Province::MAX_INDEX, ")"
      );
      return false;
   }
   if (identifier.empty()) {
      Logger::error("Invalid province identifier - empty!");
      return false;
   }
   if (!valid_basic_identifier(identifier)) {
      Logger::error(
         "Invalid province identifier: ", identifier, " (can only contain alphanumeric characters and underscores)"
      );
      return false;
   }
   if (colour == NULL_COLOUR || colour > MAX_COLOUR_RGB) {
      Logger::error("Invalid province colour for ", identifier, ": ", colour_to_hex_string(colour));
      return false;
   }
   Province new_province { identifier, colour, static_cast<Province::index_t>(provinces.size() + 1) };
   const Province::index_t index = get_index_from_colour(colour);
   if (index != Province::NULL_INDEX) {
      Logger::error(
         "Duplicate province colours: ", get_province_by_index(index)->to_string(), " and ", new_province.to_string()
      );
      return false;
   }
   colour_index_map[new_province.get_colour()] = new_province.get_index();
   return provinces.add_item(std::move(new_province));
}

bool Map::set_water_province(std::string_view identifier) {
   if (water_provinces.is_locked()) {
      Logger::error("The map's water provinces have already been locked!");
      return false;
   }
   Province* province = get_province_by_identifier(identifier);
   if (province == nullptr) {
      Logger::error("Unrecognised water province identifier: ", identifier);
      return false;
   }
   if (province->get_water()) {
      Logger::warning("Province ", identifier, " is already a water province!");
      return true;
   }
   if (!water_provinces.add_province(province)) {
      Logger::error("Failed to add province ", identifier, " to water province set!");
      return false;
   }
   province->water = true;
   return true;
}

bool Map::set_water_province_list(std::vector<std::string_view> const& list) {
   if (water_provinces.is_locked()) {
      Logger::error("The map's water provinces have already been locked!");
      return false;
   }
   bool ret = true;
   water_provinces.reserve(water_provinces.size() + list.size());
   for (std::string_view const& identifier : list) {
      ret &= set_water_province(identifier);
   }
   lock_water_provinces();
   return ret;
}

void Map::lock_water_provinces() {
   water_provinces.lock();
   Logger::info("Locked water provinces after registering ", water_provinces.size());
}

bool Map::add_region(std::string_view identifier, std::vector<std::string_view> const& province_identifiers) {
   if (identifier.empty()) {
      Logger::error("Invalid region identifier - empty!");
      return false;
   }
   Region::provinces_t provinces;
   provinces.reserve(province_identifiers.size());
   bool meta = false, ret = true;
   for (const std::string_view province_identifier : province_identifiers) {
      Province* province = get_province_by_identifier(province_identifier);
      if (province != nullptr) {
         if (std::find(provinces.begin(), provinces.end(), province) != provinces.end()) {
            Logger::error("Duplicate province identifier ", province_identifier, " in region ", identifier);
            ret = false;
         } else {
            if (province->get_has_region()) {
               meta = true;
            }
            provinces.push_back(province);
         }
      } else {
         Logger::error("Invalid province identifier ", province_identifier, " for region ", identifier);
         ret = false;
      }
   }
   if (provinces.empty()) {
      Logger::warning("No valid provinces in list for ", identifier);
      return ret;
   }

   if (!meta) {
      for (Province* province : provinces) {
         province->has_region = true;
      }
   }
   ret &= regions.add_item({ identifier, std::move(provinces), meta });
   return ret;
}

Province::index_t Map::get_index_from_colour(colour_t colour) const {
   const colour_index_map_t::const_iterator it = colour_index_map.find(colour);
   if (it != colour_index_map.end()) {
      return it->second;
   }
   return Province::NULL_INDEX;
}

Province::index_t Map::get_province_index_at(size_t x, size_t y) const {
   if (x < width && y < height) {
      return province_shape_image[x + y * width].index;
   }
   return Province::NULL_INDEX;
}

bool Map::set_max_provinces(Province::index_t new_max_provinces) {
   if (new_max_provinces <= Province::NULL_INDEX) {
      Logger::error(
         "Trying to set max province count to an invalid value ", new_max_provinces, " (must be greater than ",
         Province::NULL_INDEX, ")"
      );
      return false;
   }
   if (!provinces.empty() || provinces.is_locked()) {
      Logger::error(
         "Trying to set max province count to ", new_max_provinces, " after provinces have already been added and/or locked"
      );
      return false;
   }
   max_provinces = new_max_provinces;
   return true;
}

Province::index_t Map::get_max_provinces() const {
   return max_provinces;
}

void Map::set_selected_province(Province::index_t index) {
   if (index > get_province_count()) {
      Logger::error(
         "Trying to set selected province to an invalid index ", index, " (max index is ", get_province_count(), ")"
      );
      selected_province = Province::NULL_INDEX;
   } else {
      selected_province = index;
   }
}

Province::index_t Map::get_selected_province_index() const {
   return selected_province;
}

Province const* Map::get_selected_province() const {
   return get_province_by_index(get_selected_province_index());
}

size_t Map::get_width() const {
   return width;
}

size_t Map::get_height() const {
   return height;
}

std::vector<Map::shape_pixel_t> const& Map::get_province_shape_image() const {
   return province_shape_image;
}

bool Map::add_mapmode(std::string_view identifier, Mapmode::colour_func_t colour_func) {
   if (identifier.empty()) {
      Logger::error("Invalid mapmode identifier - empty!");
      return false;
   }
   if (colour_func == nullptr) {
      Logger::error("Mapmode colour function is null for identifier: ", identifier);
      return false;
   }
   return mapmodes.add_item({ identifier, mapmodes.size(), colour_func });
}

bool Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) const {
   if (target == nullptr) {
      Logger::error("Mapmode colour target pointer is null!");
      return false;
   }
   bool ret = true;
   Mapmode const* mapmode = mapmodes.get_item_by_index(index);
   if (mapmode == nullptr) {
      // Not an error if mapmodes haven't yet been loaded,
      // e.g. if we want to allocate the province colour
      // texture before mapmodes are loaded.
      if (!(mapmodes.empty() && index == 0)) {
         Logger::error("Invalid mapmode index: ", index);
         ret = false;
      }
      mapmode = &Mapmode::ERROR_MAPMODE;
   }
   // Skip past Province::NULL_INDEX
   for (size_t i = 0; i < sizeof(Mapmode::base_stripe_t); ++i) {
      *target++ = 0;
   }
   for (Province const& province : provinces.get_items()) {
      const Mapmode::base_stripe_t base_stripe = mapmode->get_base_stripe_colours(*this, province);
      const colour_t base_colour = static_cast<colour_t>(base_stripe);
      const colour_t stripe_colour = static_cast<colour_t>(base_stripe >> (sizeof(colour_t) * 8));

      *target++ = (base_colour >> 16) & COLOUR_COMPONENT; // red
      *target++ = (base_colour >>  8) & COLOUR_COMPONENT; // green
      *target++ = (base_colour >>  0) & COLOUR_COMPONENT; // blue
      *target++ = (base_colour >> 24) & COLOUR_COMPONENT; // alpha

      *target++ = (stripe_colour >> 16) & COLOUR_COMPONENT; // red
      *target++ = (stripe_colour >>  8) & COLOUR_COMPONENT; // green
      *target++ = (stripe_colour >>  0) & COLOUR_COMPONENT; // blue
      *target++ = (stripe_colour >> 24) & COLOUR_COMPONENT; // alpha
   }
   return ret;
}

void Map::update_highest_province_population() {
   highest_province_population = 0;
   for (Province const& province : provinces.get_items()) {
      highest_province_population = std::max(highest_province_population, province.get_total_population());
   }
}

Pop::pop_size_t Map::get_highest_province_population() const {
   return highest_province_population;
}

void Map::update_total_map_population() {
   total_map_population = 0;
   for (Province const& province : provinces.get_items()) {
      total_map_population += province.get_total_population();
   }
}

Pop::pop_size_t Map::get_total_map_population() const {
   return total_map_population;
}

bool Map::reset(BuildingTypeManager const& building_type_manager) {
   bool ret = true;
   for (Province& province : provinces.get_items()) {
      ret &= province.reset(building_type_manager);
   }
   return ret;
}

bool Map::apply_history_to_provinces(ProvinceHistoryManager const& history_manager, Date date) {
   bool ret = true;
   for (Province& province : provinces.get_items()) {
      if (!province.get_water()) {
         ProvinceHistoryMap const* history_map = history_manager.get_province_history(&province);
         if (history_map != nullptr) {
            ProvinceHistoryEntry const* pop_history_entry = nullptr;
            for (ProvinceHistoryEntry const* entry : history_map->get_entries_up_to(date)) {
               province.apply_history_to_province(entry);
               if (!entry->get_pops().empty()) {
                  pop_history_entry = entry;
               }
            }
            if (pop_history_entry != nullptr) {
               province.add_pop_vec(pop_history_entry->get_pops());
            }
         }
      }
   }
   return ret;
}

void Map::update_state(Date today) {
   for (Province& province : provinces.get_items()) {
      province.update_state(today);
   }
   update_highest_province_population();
   update_total_map_population();
}

void Map::tick(Date today) {
   for (Province& province : provinces.get_items()) {
      province.tick(today);
   }
}

using namespace ovdl::csv;

static bool validate_province_definitions_header(LineObject const& header) {
   static const std::vector<std::string> standard_header { "province", "red", "green", "blue" };
   for (size_t i = 0; i < standard_header.size(); ++i) {
      const std::string_view val = header.get_value_for(i);
      if (i == 0 && val.empty()) {
         break;
      }
      if (val != standard_header[i]) {
         return false;
      }
   }
   return true;
}

static bool parse_province_colour(colour_t& colour, std::array<std::string_view, 3> components) {
   bool ret = true;
   colour = NULL_COLOUR;
   for (std::string_view& c : components) {
      colour <<= 8;
      if (c.ends_with('.')) {
         c.remove_suffix(1);
      }
      bool successful = false;
      uint64_t val = StringUtils::string_to_uint64(c, &successful, 10);
      if (successful && val <= 255) {
         colour |= val;
      } else {
         ret = false;
      }
   }
   return ret;
}

bool Map::load_province_definitions(std::vector<LineObject> const& lines) {
   if (lines.empty()) {
      Logger::error("No header or entries in province definition file!");
      return false;
   }
   {
      LineObject const& header = lines.front();
      if (!validate_province_definitions_header(header)) {
         Logger::error(
            "Non-standard province definition file header - make sure this is not a province definition: ", header
         );
      }
   }
   if (lines.size() <= 1) {
      Logger::error("No entries in province definition file!");
      return false;
   }
   provinces.reserve(lines.size() - 1);
   bool ret = true;
   std::for_each(lines.begin() + 1, lines.end(), [this, &ret](LineObject const& line) -> void {
      const std::string_view identifier = line.get_value_for(0);
      if (!identifier.empty()) {
         colour_t colour = NULL_COLOUR;
         if (!parse_province_colour(colour, { line.get_value_for(1), line.get_value_for(2), line.get_value_for(3) })) {
            Logger::error("Error reading colour in province definition: ", line);
            ret = false;
         }
         ret &= add_province(identifier, colour);
      }
   });
   lock_provinces();
   return ret;
}

bool Map::load_province_positions(BuildingTypeManager const& building_type_manager, ast::NodeCPtr root) {
   return expect_province_dictionary([&building_type_manager](Province& province, ast::NodeCPtr node) -> bool {
      return province.load_positions(building_type_manager, node);
   })(root);
}

bool Map::load_region_file(ast::NodeCPtr root) {
   const bool ret = expect_dictionary_reserve_length(regions,
      [this](std::string_view region_identifier, ast::NodeCPtr region_node) -> bool {
         std::vector<std::string_view> province_identifiers;
         bool ret = expect_list_reserve_length(
            province_identifiers, expect_identifier(vector_callback(province_identifiers))
         )(region_node);
         ret &= add_region(region_identifier, province_identifiers);
         return ret;
      }
   )(root);
   lock_regions();
   for (Region& region : regions.get_items()) {
      if (!region.meta) {
         for (Province* province : region.get_provinces()) {
            if (!province->get_has_region()) {
               Logger::error("Province in non-meta region without has_region set: ", province->get_identifier());
               province->has_region = true;
            }
            province->region = &region;
         }
      }
   }
   for (Province& province : provinces.get_items()) {
      const bool region_null = province.get_region() == nullptr;
      if (province.get_has_region() == region_null) {
         Logger::error(
            "Province has_region / region mismatch: has_region = ", province.get_has_region(),
            ", region = ", province.get_region()
         );
         province.has_region = !region_null;
      }
   }
   return ret;
}

static constexpr colour_t colour_at(uint8_t const* colour_data, int32_t idx) {
   /* colour_data is filled with BGR byte triplets - to get pixel idx as a
    * single RGB value, multiply idx by 3 to get the index of the corresponding
    * triplet, then combine the bytes in reverse order.
    */
   idx *= 3;
   return (colour_data[idx + 2] << 16) | (colour_data[idx + 1] << 8) | colour_data[idx];
}

bool Map::load_map_images(fs::path const& province_path, fs::path const& terrain_path, bool detailed_errors) {
   if (!provinces.is_locked()) {
      Logger::error("Province index image cannot be generated until after provinces are locked!");
      return false;
   }
   if (!terrain_type_manager.terrain_type_mappings_are_locked()) {
      Logger::error("Province index image cannot be generated until after terrain type mappings are locked!");
      return false;
   }

   BMP province_bmp;
   if (!(province_bmp.open(province_path) && province_bmp.read_header() && province_bmp.read_pixel_data())) {
      Logger::error("Failed to read BMP for compatibility mode province image: ", province_path);
      return false;
   }
   static constexpr uint16_t expected_province_bpp = 24;
   if (province_bmp.get_bits_per_pixel() != expected_province_bpp) {
      Logger::error(
         "Invalid province BMP bits per pixel: ", province_bmp.get_bits_per_pixel(), " (expected ", expected_province_bpp,
         ")"
      );
      return false;
   }

   BMP terrain_bmp;
   if (!(terrain_bmp.open(terrain_path) && terrain_bmp.read_header() && terrain_bmp.read_pixel_data())) {
      Logger::error("Failed to read BMP for compatibility mode terrain image: ", terrain_path);
      return false;
   }
   static constexpr uint16_t expected_terrain_bpp = 8;
   if (terrain_bmp.get_bits_per_pixel() != expected_terrain_bpp) {
      Logger::error(
         "Invalid terrain BMP bits per pixel: ", terrain_bmp.get_bits_per_pixel(), " (expected ", expected_terrain_bpp, ")"
      );
      return false;
   }

   if (province_bmp.get_width() != terrain_bmp.get_width() || province_bmp.get_height() != terrain_bmp.get_height()) {
      Logger::error(
         "Mismatched province and terrain BMP dims: ", province_bmp.get_width(), "x", province_bmp.get_height(), " vs ",
         terrain_bmp.get_width(), "x", terrain_bmp.get_height()
      );
      return false;
   }

   width = province_bmp.get_width();
   height = province_bmp.get_height();
   province_shape_image.resize(width * height);

   uint8_t const* province_data = province_bmp.get_pixel_data().data();
   uint8_t const* terrain_data = terrain_bmp.get_pixel_data().data();

   std::vector<bool> province_checklist(provinces.size());
   std::vector<fixed_point_map_t<TerrainType const*>> terrain_type_pixels_list(provinces.size());
   bool ret = true;
   std::unordered_set<colour_t> unrecognised_province_colours;
   
   std::vector<fixed_point_t> pixels_per_province(provinces.size());
   std::vector<fixed_point_t> x_sum_per_province(provinces.size());
   std::vector<fixed_point_t> y_sum_per_province(provinces.size());

   for (size_t y = 0; y < height; ++y) {
      for (size_t x = 0; x < width; ++x) {
         const size_t pixel_index = x + y * width;
         const colour_t province_colour = colour_at(province_data, pixel_index);

         if (x > 0) {
            const size_t jdx = pixel_index - 1;
            if (colour_at(province_data, jdx) == province_colour) {
               province_shape_image[pixel_index].index = province_shape_image[jdx].index;
               goto set_terrain;
            }
         }

         if (y > 0) {
            const size_t jdx = pixel_index - width;
            if (colour_at(province_data, jdx) == province_colour) {
               province_shape_image[pixel_index].index = province_shape_image[jdx].index;
               goto set_terrain;
            }
         }

         {
            const Province::index_t province_index = get_index_from_colour(province_colour);
            if (province_index != Province::NULL_INDEX) {
               province_checklist[province_index - 1] = true;
               province_shape_image[pixel_index].index = province_index;
               goto set_terrain;
            }
         }

         if (!unrecognised_province_colours.contains(province_colour)) {
            unrecognised_province_colours.insert(province_colour);
            if (detailed_errors) {
               Logger::warning(
                  "Unrecognised province colour ", colour_to_hex_string(province_colour), " at (", x, ", ", y, ")"
               );
            }
         }

         province_shape_image[pixel_index].index = Province::NULL_INDEX;

      set_terrain:
         const Province::index_t province_index = province_shape_image[pixel_index].index;         
         if (province_index != Province::NULL_INDEX) {
            const uint16_t array_index = province_index - 1;
            pixels_per_province[array_index]++;
            x_sum_per_province[array_index] += x;
            y_sum_per_province[array_index] += y;
         }

         const TerrainTypeMapping::index_t terrain = terrain_data[pixel_index];
         TerrainTypeMapping const* mapping = terrain_type_manager.get_terrain_type_mapping_for(terrain);
         if (mapping != nullptr) {

            if (province_index != Province::NULL_INDEX) {
               terrain_type_pixels_list[province_index - 1][&mapping->get_type()]++;
            }

            province_shape_image[pixel_index].terrain =
               mapping->get_has_texture() && terrain < terrain_type_manager.get_terrain_texture_limit() ? terrain + 1 : 0;
         } else {
            province_shape_image[pixel_index].terrain = 0;
         }
      }
   }

   if (!unrecognised_province_colours.empty()) {
      Logger::warning("Province image contains ", unrecognised_province_colours.size(), " unrecognised province colours");
   }

   size_t missing = 0;
   for (size_t array_index = 0; array_index < province_checklist.size(); ++array_index) {
      Province* province = provinces.get_item_by_index(array_index);
      const fixed_point_t pixel_count = pixels_per_province[array_index];
      if(pixel_count > 0) {
         const fixed_point_t x = x_sum_per_province[array_index] / pixel_count;
         const fixed_point_t y = y_sum_per_province[array_index] / pixel_count;
         const fvec2_t center { x, y };
         province->positions.center = center;
      }
      else {
         Logger::warning("Province ",province->index," has no pixels");
      }

      const fixed_point_map_const_iterator_t<TerrainType const*> largest = get_largest_item(terrain_type_pixels_list[array_index]);
      province->default_terrain_type = largest != terrain_type_pixels_list[array_index].end() ? largest->first : nullptr;
      province->on_map = province_checklist[array_index];
      if (!province->on_map) {
         if (detailed_errors) {
            Logger::warning("Province missing from shape image: ", province->to_string());
         }
         missing++;
      }
   }
   if (missing > 0) {
      Logger::warning("Province image is missing ", missing, " province colours");
   }

   return ret;
}

/* REQUIREMENTS:
 * MAP-19, MAP-84
 */
bool Map::_generate_province_adjacencies() {
   bool changed = false;

   auto generate_adjacency = [&](Province* current, size_t x, size_t y) -> bool {
      Province* neighbour = get_province_by_index(province_shape_image[x + y * width].index);
      if (neighbour != nullptr && current != neighbour) {
         const Province::distance_t distance = current->calculate_distance_to(neighbour);
         const Province::flags_t flags = 0;
         return current->add_adjacency(neighbour, distance, flags) | neighbour->add_adjacency(current, distance, flags);
      }
      return false;
   };

   for (size_t y = 0; y < height; ++y) {
      for (size_t x = 0; x < width; ++x) {
         Province* cur = get_province_by_index(province_shape_image[x + y * width].index);

         if (cur != nullptr) {
            changed |= generate_adjacency(cur, (x + 1) % width, y);
            if (y + 1 < height) {
               changed |= generate_adjacency(cur, x, y + 1);
            }
         }
      }
   }

   return changed;
}

bool Map::generate_and_load_province_adjacencies(std::vector<ovdl::csv::LineObject> const& additional_adjacencies) {
   bool ret = _generate_province_adjacencies();
   // TODO - DEV TASK: read additional adjacencies
   return ret;
}