aboutsummaryrefslogtreecommitdiff
path: root/src/openvic-simulation/map/MapDefinition.hpp
blob: bd3b5aea226941c2e420dbfd017ebd9129dda85a (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
#pragma once

#include <cstdint>
#include <filesystem>
#include <string_view>
#include <vector>

#include <openvic-dataloader/csv/LineObject.hpp>

#include "openvic-simulation/map/ProvinceDefinition.hpp"
#include "openvic-simulation/map/Region.hpp"
#include "openvic-simulation/map/TerrainType.hpp"
#include "openvic-simulation/types/Colour.hpp"
#include "openvic-simulation/types/IdentifierRegistry.hpp"
#include "openvic-simulation/types/OrderedContainers.hpp"
#include "openvic-simulation/types/Vector.hpp"

namespace OpenVic {
   namespace fs = std::filesystem;

   struct BuildingTypeManager;
   struct ModifierManager;

   struct RiverSegment {
      friend struct MapDefinition;

   private:
         const uint8_t PROPERTY(size);
         const std::vector<ivec2_t> PROPERTY(points);

         RiverSegment(uint8_t new_size, std::vector<ivec2_t> new_points);
   };

   /* REQUIREMENTS:
    * MAP-4
    */
   struct MapDefinition {

#pragma pack(push, 1)
      /* Used to represent tightly packed 3-byte integer pixel information. */
      struct shape_pixel_t {
         ProvinceDefinition::index_t index;
         TerrainTypeMapping::index_t terrain;
      };
#pragma pack(pop)

   private:
      using colour_index_map_t = ordered_map<colour_t, ProvinceDefinition::index_t>;
      using river_t = std::vector<RiverSegment>;

      IdentifierRegistry<ProvinceDefinition> IDENTIFIER_REGISTRY_CUSTOM_INDEX_OFFSET(province_definition, 1);
      IdentifierRegistry<Region> IDENTIFIER_REGISTRY(region);
      IdentifierRegistry<Climate> IDENTIFIER_REGISTRY(climate);
      IdentifierRegistry<Continent> IDENTIFIER_REGISTRY(continent);
      ProvinceSet water_provinces;
      TerrainTypeManager PROPERTY_REF(terrain_type_manager);

      std::vector<river_t> PROPERTY(rivers); // TODO: calculate provinces affected by crossing
      ivec2_t PROPERTY(dims);
      std::vector<shape_pixel_t> PROPERTY(province_shape_image);
      colour_index_map_t colour_index_map;

      ProvinceDefinition::index_t PROPERTY(max_provinces);

      ProvinceDefinition::index_t get_index_from_colour(colour_t colour) const;
      bool _generate_standard_province_adjacencies();

      inline constexpr int32_t get_pixel_index_from_pos(ivec2_t pos) const {
         return pos.x + pos.y * dims.x;
      }

      IDENTIFIER_REGISTRY_NON_CONST_ACCESSORS_CUSTOM_INDEX_OFFSET(province_definition, 1);

   public:
      MapDefinition();

      inline constexpr int32_t get_width() const { return dims.x; }
      inline constexpr int32_t get_height() const { return dims.y; }

      bool add_province_definition(std::string_view identifier, colour_t colour);

      ProvinceDefinition::distance_t calculate_distance_between(
         ProvinceDefinition const& from, ProvinceDefinition const& to
      ) const;
      bool add_standard_adjacency(ProvinceDefinition& from, ProvinceDefinition& to) const;
      bool add_special_adjacency(
         ProvinceDefinition& from, ProvinceDefinition& to, ProvinceDefinition::adjacency_t::type_t type,
         ProvinceDefinition const* through, ProvinceDefinition::adjacency_t::data_t data
      ) const;

      bool set_water_province(std::string_view identifier);
      bool set_water_province_list(std::vector<std::string_view> const& list);
      void lock_water_provinces();

      ProvinceDefinition::index_t get_province_index_at(ivec2_t pos) const;

   private:
      ProvinceDefinition* get_province_definition_at(ivec2_t pos);

      /* This provides a safe way to remove the const qualifier of a ProvinceDefinition const*, via a non-const Map.
       * It uses a const_cast (the fastest/simplest solution), but this could also be done without it by looking up the
       * ProvinceDefinition* using the ProvinceDefinition const*'s index. Requiring a non-const Map ensures that this
       * function can only be used where the ProvinceDefinition* could already be accessed by other means, such as the
       * index method, preventing misleading code, or in the worst case undefined behaviour. */
      constexpr ProvinceDefinition* remove_province_definition_const(ProvinceDefinition const* province) {
         return const_cast<ProvinceDefinition*>(province);
      }

   public:
      ProvinceDefinition const* get_province_definition_at(ivec2_t pos) const;
      bool set_max_provinces(ProvinceDefinition::index_t new_max_provinces);

      bool add_region(std::string_view identifier, std::vector<ProvinceDefinition const*>&& provinces, colour_t colour);

      bool load_province_definitions(std::vector<ovdl::csv::LineObject> const& lines);
      /* Must be loaded after adjacencies so we know what provinces are coastal, and so can have a port */
      bool load_province_positions(BuildingTypeManager const& building_type_manager, ast::NodeCPtr root);
      static bool load_region_colours(ast::NodeCPtr root, std::vector<colour_t>& colours);
      bool load_region_file(ast::NodeCPtr root, std::vector<colour_t> const& colours);
      bool load_map_images(fs::path const& province_path, fs::path const& terrain_path, fs::path const& rivers_path, bool detailed_errors);
      bool generate_and_load_province_adjacencies(std::vector<ovdl::csv::LineObject> const& additional_adjacencies);
      bool load_climate_file(ModifierManager const& modifier_manager, ast::NodeCPtr root);
      bool load_continent_file(ModifierManager const& modifier_manager, ast::NodeCPtr root);
   };
}