refactor: moved dock/wharf runtime data from building class

Author: dalerank

src/building/building.cpp

@@ -95,9 +95,9 @@ void building::new_fill_in_data_for_type(e_building_type _tp, tile2i _tl, int or
 
     // subtype
     if (is_house()) {
-        subtype.house_level = (e_house_level)(type - BUILDING_HOUSE_VACANT_LOT);
+        data.house.level = (e_house_level)(type - BUILDING_HOUSE_VACANT_LOT);
     } else {
-        subtype.house_level = HOUSE_CRUDE_HUT;
+        data.house.level = HOUSE_CRUDE_HUT;
     }
 
     // unique data
@@ -995,7 +995,7 @@ bvariant building_impl::get_property(const xstring &domain, const xstring &name)
     return bvariant();
 }
 
-void building_impl::destroy_by_poof(bool clouds) { 
+void building_impl::destroy_by_poof(bool clouds) {
     building_destroy_by_poof(&base, clouds);
 }
 

src/building/building.h

@@ -87,6 +87,7 @@ struct tooltip_context;
 struct object_info;
 struct painter;
 struct mouse;
+struct water_access_tiles;
 class build_planner;
 
 constexpr uint32_t MAX_BUILDINGS = 4000;
@@ -166,10 +167,6 @@ class building {
     tile2i tile;
     uint8_t orientation;
     e_building_type type;
-    union {
-        e_house_level house_level;
-        uint16_t data;       
-    } subtype;
     short native_meeting_center_id;
     unsigned short road_network_id;
     //unsigned short creation_sequence_index;
@@ -214,19 +211,7 @@ class building {
     unsigned short tax_collector_id;
     short formation_id;
     union impl_data_t {
-        struct dock_t {
-            short queued_docker_id;
-            int dock_tiles[2];
-            sbitarray64 trading_goods;
-            uint8_t num_ships;
-            short docker_ids[3];
-            short trade_ship_id;
-            uint8_t docker_anim_frame;
-            e_figure_type process_type;
-            bool reparing;
-            short progress;
-            bool has_fish;
-        } dock;
+        char data[512] = { 0 };
         struct water_lift_t {
             int input_tiles[2];
             int output_tiles[2];
@@ -304,6 +289,7 @@ class building {
         } entertainment;
 
         struct {
+            e_house_level level;
             uint16_t foods[8];
             uint16_t inventory[8];
             uint8_t booth_juggler;
@@ -635,6 +621,7 @@ class building_impl {
     virtual bool add_resource(e_resource resource, int amount) { return false; }
     virtual int get_orientation() const { return base.orientation; }
     virtual void on_config_reload() {}
+    virtual void set_water_access_tiles(const water_access_tiles &tiles) {}
 
     virtual building_farm *dcast_farm() { return nullptr; }
     virtual building_brewery *dcast_brewery() { return nullptr; }
@@ -735,7 +722,7 @@ class building_impl {
     inline short distance_from_entry() const { return base.distance_from_entry; }
     inline int road_network() const { return base.road_network_id; }
     inline const animation_t &anim(const xstring &key) const { return params().anim[key]; }
-
+ 
     virtual bool is_workshop() const { return false; }
     virtual bool is_administration() const { return false; }
     virtual bool is_unique_building() const { return false; }

src/building/building_dock.cpp

@@ -44,7 +44,7 @@ void building_dock::static_params::planer_setup_preview_graphics(build_planner &
 
 void building_dock::on_create(int orientation) {
     base.orientation = orientation;
-    data.dock.trading_goods.one();
+    runtime_data().trading_goods.one();
 }
 
 void building_dock::on_place(int orientation, int variant) {
@@ -58,7 +58,7 @@ void building_dock::on_destroy() {
 }
 
 bool building_dock::can_play_animation() const {
-    if (data.dock.num_ships > 0) {
+    if (runtime_data().num_ships > 0) {
         return true;
     }
 
@@ -108,21 +108,22 @@ void building_dock::spawn_figure() {
     }
     // count existing dockers
     int existing_dockers = 0;
+    auto &d = runtime_data();
     for (int i = 0; i < 3; i++) {
-        if (data.dock.docker_ids[i]) {
-            if (figure_get(data.dock.docker_ids[i])->type == FIGURE_DOCKER) {
+        if (d.docker_ids[i]) {
+            if (figure_get(d.docker_ids[i])->type == FIGURE_DOCKER) {
                 existing_dockers++;
             } else {
-                data.dock.docker_ids[i] = 0;
+                d.docker_ids[i] = 0;
             }
         }
     }
 
     if (existing_dockers > max_dockers) {
         // too many dockers, poof one of them
         for (int i = 2; i >= 0; i--) {
-            if (data.dock.docker_ids[i]) {
-                figure_get(data.dock.docker_ids[i])->poof();
+            if (d.docker_ids[i]) {
+                figure_get(d.docker_ids[i])->poof();
                 return;
             }
         }
@@ -133,8 +134,8 @@ void building_dock::spawn_figure() {
         f->action_state = FIGURE_ACTION_132_DOCKER_IDLING;
         f->set_home(&base);
         for (int i = 0; i < 3; i++) {
-            if (!data.dock.docker_ids[i]) {
-                data.dock.docker_ids[i] = f->id;
+            if (!d.docker_ids[i]) {
+                d.docker_ids[i] = f->id;
                 return;
             }
         }
@@ -143,9 +144,10 @@ void building_dock::spawn_figure() {
 
 void building_dock::on_tick(bool refresh_only) {
     auto &anim_wharf = base.anim;
+    auto &d = runtime_data();
     if (anim_wharf.valid()) {
-        data.dock.docker_anim_frame++;
-        data.dock.docker_anim_frame %= (anim_wharf.max_frames * anim_wharf.frame_duration);
+        d.docker_anim_frame++;
+        d.docker_anim_frame %= (anim_wharf.max_frames * anim_wharf.frame_duration);
     }
 }
 
@@ -169,37 +171,39 @@ void building_dock::update_graphic() {
 
 bool building_dock::draw_ornaments_and_animations_height(painter &ctx, vec2i point, tile2i t, color color_mask) {
     auto &anim_dockers = base.anim;
-
+    auto &d = runtime_data();
     if (anim_dockers.valid()) {
-        int img_id = anim_dockers.start() + (data.dock.docker_anim_frame / anim_dockers.frame_duration) * 4;
+        int img_id = anim_dockers.start() + (d.docker_anim_frame / anim_dockers.frame_duration) * 4;
         ImageDraw::img_generic(ctx, img_id, point + anim_dockers.pos, color_mask, 1.f, ImgFlag_InternalOffset);
     }
     return false;
 }
 
 void building_dock::bind_dynamic(io_buffer *iob, size_t version) {
-    iob->bind(BIND_SIGNATURE_INT16, &data.dock.queued_docker_id);
-    iob->bind(BIND_SIGNATURE_INT32, &data.dock.dock_tiles[0]);
-    iob->bind(BIND_SIGNATURE_INT32, &data.dock.dock_tiles[1]);
-    iob->bind(BIND_SIGNATURE_UINT64, data.dock.trading_goods.data_ptr());
+    auto &d = runtime_data();
+    iob->bind(BIND_SIGNATURE_INT16, &d.queued_docker_id);
+    iob->bind(BIND_SIGNATURE_INT32, &d.dock_tiles[0]);
+    iob->bind(BIND_SIGNATURE_INT32, &d.dock_tiles[1]);
+    iob->bind(BIND_SIGNATURE_UINT64, d.trading_goods.data_ptr());
     iob->bind____skip(9);
-    iob->bind(BIND_SIGNATURE_UINT8, &data.dock.num_ships);
+    iob->bind(BIND_SIGNATURE_UINT8, &d.num_ships);
     iob->bind____skip(2);
     iob->bind(BIND_SIGNATURE_INT8, &base.orientation);
     iob->bind____skip(3);
 
-    iob->bind(BIND_SIGNATURE_INT16, &data.dock.docker_ids[0]);
-    iob->bind(BIND_SIGNATURE_INT16, &data.dock.docker_ids[1]);
-    iob->bind(BIND_SIGNATURE_INT16, &data.dock.docker_ids[2]);
-
-    iob->bind(BIND_SIGNATURE_INT16, &data.dock.trade_ship_id);
+    iob->bind(BIND_SIGNATURE_INT16, &d.docker_ids[0]);
+    iob->bind(BIND_SIGNATURE_INT16, &d.docker_ids[1]);
+    iob->bind(BIND_SIGNATURE_INT16, &d.docker_ids[2]);
+                                     
+    iob->bind(BIND_SIGNATURE_INT16, &d.trade_ship_id);
 }
 
 int building_dock::count_idle_dockers() const {
     int num_idle = 0;
+    auto &d = runtime_data();
     for (int i = 0; i < 3; i++) {
-        if (data.dock.docker_ids[i]) {
-            figure* f = figure_get(data.dock.docker_ids[i]);
+        if (d.docker_ids[i]) {
+            figure* f = figure_get(d.docker_ids[i]);
             if (f->action_state == FIGURE_ACTION_132_DOCKER_IDLING
                 || f->action_state == FIGURE_ACTION_133_DOCKER_IMPORT_QUEUE) {
                 num_idle++;
@@ -216,25 +220,26 @@ bool map_tile_is_connected_to_open_water(tile2i tile) {
 }
 
 void building_dock::unaccept_all_goods() {
-    data.dock.trading_goods.zeroes(64);
+    runtime_data().trading_goods.zeroes(64);
 }
 
 int building_dock::trader_id() {
-    return figure_get(data.dock.trade_ship_id)->trader_id;
+    return figure_get(runtime_data().trade_ship_id)->trader_id;
 }
 
 int building_dock::trader_city_id() {
-    return data.dock.trade_ship_id
-                ? figure_get(data.dock.trade_ship_id)->empire_city_id
+    auto &d = runtime_data();
+    return d.trade_ship_id
+                ? figure_get(d.trade_ship_id)->empire_city_id
                 : 0;
 }
 
 bool building_dock::is_trade_accepted(e_resource r) {
-    return data.dock.trading_goods.is_set(r);
+    return runtime_data().trading_goods.is_set(r);
 }
 
 void building_dock::toggle_good_accepted(e_resource r) {
-    data.dock.trading_goods.flip(r);
+    runtime_data().trading_goods.flip(r);
 }
 
 bool building_dock::accepts_ship(int ship_id) {
@@ -255,10 +260,16 @@ bool building_dock::accepts_ship(int ship_id) {
 void building_dock::highlight_waypoints() {
     building_impl::highlight_waypoints();
 
-    map_highlight_set(data.dock.dock_tiles[0], ehighligth_green);
-    map_highlight_set(data.dock.dock_tiles[1], ehighligth_green);
+    auto &d = runtime_data();
+    map_highlight_set(d.dock_tiles[0], ehighligth_green);
+    map_highlight_set(d.dock_tiles[1], ehighligth_green);
 }
 
+void building_dock::set_water_access_tiles(const water_access_tiles &tiles) {
+    auto &d = runtime_data();
+    d.dock_tiles[0] = tiles.point_a.grid_offset();
+    d.dock_tiles[1] = tiles.point_b.grid_offset();
+}
 
 tile2i building_dock::moor_tile() const {
     vec2i offset;
@@ -315,7 +326,8 @@ building_dest map_get_free_destination_dock(int ship_id) {
         }
 
         better_dock = dock;
-        if (!dock->data.dock.trade_ship_id || dock->data.dock.trade_ship_id == ship_id) {
+        auto &d = dock->runtime_data();
+        if (!d.trade_ship_id || d.trade_ship_id == ship_id) {
             break;
         }
     }
@@ -326,7 +338,7 @@ building_dest map_get_free_destination_dock(int ship_id) {
     }
 
     tile2i moor_tile = better_dock->moor_tile();
-    better_dock->data.dock.trade_ship_id = ship_id;
+    better_dock->runtime_data().trade_ship_id = ship_id;
     return {better_dock->id(), moor_tile };
 }
 

src/building/building_dock.h

@@ -6,6 +6,20 @@ class building_dock : public building_impl {
 public:
     BUILDING_METAINFO(BUILDING_DOCK, building_dock)
 
+    struct runtime_data_t {
+        short queued_docker_id;
+        int dock_tiles[2];
+        sbitarray64 trading_goods;
+        uint8_t num_ships;
+        short docker_ids[3];
+        short trade_ship_id;
+        uint8_t docker_anim_frame;
+        e_figure_type process_type;
+        bool reparing;
+        short progress;
+        bool has_fish;
+    };
+
     building_dock(building &b) : building_impl(b) {}
     virtual building_dock *dcast_dock() override { return this; }
 
@@ -30,6 +44,10 @@ class building_dock : public building_impl {
     virtual bool draw_ornaments_and_animations_height(painter &ctx, vec2i point, tile2i tile, color color_mask) override;
     virtual void bind_dynamic(io_buffer *iob, size_t version) override;
     virtual void highlight_waypoints() override;
+    virtual void set_water_access_tiles(const water_access_tiles &tiles);
+
+    runtime_data_t &runtime_data() { return *(runtime_data_t *)data.data; }
+    const runtime_data_t &runtime_data() const { return *(runtime_data_t *)data.data; }
 
     void unaccept_all_goods();
     int trader_id();

src/building/building_ferry.cpp

@@ -69,11 +69,19 @@ void building_ferry::highlight_waypoints() {
     map_highlight_set(fpoints.point_b, ehighligth_green);
 }
 
+void building_ferry::set_water_access_tiles(const water_access_tiles &tiles) {
+    auto &d = runtime_data();
+    d.dock_tiles[0] = tiles.point_a.grid_offset();
+    d.dock_tiles[1] = tiles.point_b.grid_offset();
+}
+
 void building_ferry::bind_dynamic(io_buffer *iob, size_t verrsion) {
+    auto &d = runtime_data();
+
     iob->bind____skip(88);
     iob->bind(BIND_SIGNATURE_UINT8, &base.orientation);
-    iob->bind(BIND_SIGNATURE_INT32, &data.dock.dock_tiles[0]);
-    iob->bind(BIND_SIGNATURE_INT32, &data.dock.dock_tiles[1]);
+    iob->bind(BIND_SIGNATURE_INT32, &d.dock_tiles[0]);
+    iob->bind(BIND_SIGNATURE_INT32, &d.dock_tiles[1]);
 }
 
 bool info_window_ferry::check(object_info &c) {

src/building/building_ferry.h

@@ -12,6 +12,10 @@ class building_ferry : public building_routeblock {
         virtual int planer_construction_update(build_planner &planer, tile2i start, tile2i end) const override;
     };
 
+    struct runtime_data_t {
+        int dock_tiles[2];
+    };
+
     virtual building_ferry *dcast_ferry() override { return this; }
     virtual building_routeblock *dcast_routeblock() override { return this; }
 
@@ -23,6 +27,10 @@ class building_ferry : public building_routeblock {
     virtual bool force_draw_top_tile(painter &ctx, tile2i tile, vec2i pixel, color mask) override;
     virtual void highlight_waypoints() override;
     virtual void bind_dynamic(io_buffer *iob, size_t verrsion) override;
+    virtual void set_water_access_tiles(const water_access_tiles &tiles) override;
+
+    runtime_data_t &runtime_data() { return *(runtime_data_t *)data.data; }
+    const runtime_data_t &runtime_data() const { return *(runtime_data_t *)data.data; }
 
     virtual bool get_permission(e_permission p) override { return false; }
 };