aboutsummaryrefslogtreecommitdiff
path: root/extension/src/openvic2/Types.hpp
blob: f1ba639c4318b690f054846918ade33c52e25bde (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
#pragma once

#include <string>
#include <vector>
#include <cstdint>

#include "openvic2/Logger.hpp"

namespace OpenVic2 {
   //Represents a 24-bit RGB integer
   using colour_t = uint32_t;
   using index_t = uint16_t;

   static constexpr colour_t NULL_COLOUR = 0, MAX_COLOUR = 0xFFFFFF;
   static constexpr index_t NULL_INDEX = 0, MAX_INDEX = 0xFFFF;

   //TODO: price_t must be changed to a fixed-point numeric type before multiplayer
   using price_t = double;
   using return_t = bool;

   // This mirrors godot::Error, where `OK = 0` and `FAILED = 1`.
   static constexpr return_t SUCCESS = false, FAILURE = true;

   /*
    * Base class for objects with a non-empty string identifier,
    * uniquely named instances of which can be entered into an
    * IdentifierRegistry instance.
    */
   class HasIdentifier {
      const std::string identifier;
   protected:
      HasIdentifier(std::string const& new_identifier);
   public:
      HasIdentifier(HasIdentifier const&) = delete;
      HasIdentifier(HasIdentifier&&) = default;
      HasIdentifier& operator=(HasIdentifier const&) = delete;
      HasIdentifier& operator=(HasIdentifier&&) = delete;

      std::string const& get_identifier() const;
   };

   /*
    * Base class for objects with associated colour information
    */
   class HasColour {
      const colour_t colour;
   protected:
      HasColour(colour_t const new_colour);
   public:
      HasColour(HasColour const&) = delete;
      HasColour(HasColour&&) = default;
      HasColour& operator=(HasColour const&) = delete;
      HasColour& operator=(HasColour&&) = delete;

      colour_t get_colour() const;
      std::string colour_to_hex_string() const;
      static std::string colour_to_hex_string(colour_t const colour);
   };

   /*
    * Template for a list of objects with unique string identifiers that can
    * be locked to prevent any further additions. The template argument T is
    * the type of object that the registry will store, and the second part ensures
    * that HasIdentifier is a base class of T.
    */
   template<class T, typename std::enable_if<std::is_base_of<HasIdentifier, T>::value>::type* = nullptr>
   class IdentifierRegistry {
      const std::string name;
      std::vector<T> items;
      bool locked = false;
   public:
      IdentifierRegistry(std::string const& new_name) : name(new_name) {}
      return_t add_item(T&& item) {
         if (locked) {
            Logger::error("Cannot add item to the ", name, " registry - locked!");
            return FAILURE;
         }
         T const* old_item = get_item_by_identifier(item.get_identifier());
         if (old_item != nullptr) {
            Logger::error("Cannot add item to the ", name, " registry - an item with the identifier \"", item.get_identifier(), "\" already exists!");
            return FAILURE;
         }
         items.push_back(std::move(item));
         return SUCCESS;
      }
      void lock(bool log = true) {
         if (locked) {
            Logger::error("Failed to lock ", name, " registry - already locked!");
         } else {
            locked = true;
            if (log) Logger::info("Locked ", name, " registry after registering ", get_item_count(), " items");
         }
      }
      bool is_locked() const {
         return locked;
      }
      void reset() {
         items.clear();
         locked = false;
      }
      size_t get_item_count() const {
         return items.size();
      }
      T* get_item_by_identifier(std::string const& identifier) {
         if (!identifier.empty())
            for (T& item : items)
               if (item.get_identifier() == identifier) return &item;
         return nullptr;
      }
      T const* get_item_by_identifier(std::string const& identifier) const {
         if (!identifier.empty())
            for (T const& item : items)
               if (item.get_identifier() == identifier) return &item;
         return nullptr;
      }
      T* get_item_by_index(size_t index) {
         return index < items.size() ? &items[index] : nullptr;
      }
      T const* get_item_by_index(size_t index) const {
         return index < items.size() ? &items[index] : nullptr;
      }
      std::vector<T>& get_items() {
         return items;
      }
      std::vector<T> const& get_items() const {
         return items;
      }
   };
}