submap.h

#pragma once
#ifndef CATA_SRC_SUBMAP_H
#define CATA_SRC_SUBMAP_H

#include <cstddef>
#include <cstdint>
#include <memory>
#include <vector>
#include <string>
#include <iterator>
#include <map>

#include "active_item_cache.h"
#include "active_tile_data.h"
#include "calendar.h"
#include "colony.h"
#include "computer.h"
#include "construction_partial.h"
#include "field.h"
#include "game_constants.h"
#include "item.h"
#include "type_id.h"
#include "point.h"
#include "poly_serialized.h"

class JsonIn;
class JsonOut;
class basecamp;
class map;
struct trap;
struct ter_t;
struct furn_t;
class vehicle;

struct spawn_point {
    point pos;
    int count;
    mtype_id type;
    int faction_id;
    int mission_id;
    bool friendly;
    std::string name;
    spawn_point( const mtype_id &T = mtype_id::NULL_ID(), int C = 0, point P = point_zero,
                 int FAC = -1, int MIS = -1, bool F = false,
                 const std::string &N = "NONE" ) :
        pos( P ), count( C ), type( T ), faction_id( FAC ),
        mission_id( MIS ), friendly( F ), name( N ) {}
};

template<int sx, int sy>
struct maptile_soa {
    ter_id             ter[sx][sy];  // Terrain on each square
    furn_id            frn[sx][sy];  // Furniture on each square
    std::uint8_t       lum[sx][sy];  // Number of items emitting light on each square
    cata::colony<item> itm[sx][sy];  // Items on each square
    field              fld[sx][sy];  // Field on each square
    trap_id            trp[sx][sy];  // Trap on each square
    int                rad[sx][sy];  // Irradiation of each square

    void swap_soa_tile( point p1, point p2 );
    void swap_soa_tile( point p, maptile_soa<1, 1> &other );
};

class submap : maptile_soa<SEEX, SEEY>
{
    public:
        submap();
        submap( submap && );
        ~submap();

        submap &operator=( submap && );

        trap_id get_trap( point p ) const {
            return trp[p.x][p.y];
        }

        void set_trap( point p, trap_id trap ) {
            is_uniform = false;
            trp[p.x][p.y] = trap;
        }

        void set_all_traps( const trap_id &trap ) {
            std::uninitialized_fill_n( &trp[0][0], elements, trap );
        }

        furn_id get_furn( point p ) const {
            return frn[p.x][p.y];
        }

        void set_furn( point p, furn_id furn ) {
            is_uniform = false;
            frn[p.x][p.y] = furn;
        }

        void set_all_furn( const furn_id &furn ) {
            std::uninitialized_fill_n( &frn[0][0], elements, furn );
        }

        ter_id get_ter( point p ) const {
            return ter[p.x][p.y];
        }

        void set_ter( point p, ter_id terr ) {
            is_uniform = false;
            ter[p.x][p.y] = terr;
        }

        void set_all_ter( const ter_id &terr ) {
            std::uninitialized_fill_n( &ter[0][0], elements, terr );
        }

        int get_radiation( point p ) const {
            return rad[p.x][p.y];
        }

        void set_radiation( point p, const int radiation ) {
            is_uniform = false;
            rad[p.x][p.y] = radiation;
        }

        uint8_t get_lum( point p ) const {
            return lum[p.x][p.y];
        }

        void set_lum( point p, uint8_t luminance ) {
            is_uniform = false;
            lum[p.x][p.y] = luminance;
        }

        void update_lum_add( point p, const item &i ) {
            is_uniform = false;
            if( i.is_emissive() && lum[p.x][p.y] < 255 ) {
                lum[p.x][p.y]++;
            }
        }

        void update_lum_rem( point p, const item &i );

        // TODO: Replace this as it essentially makes itm public
        cata::colony<item> &get_items( point p ) {
            return itm[p.x][p.y];
        }

        const cata::colony<item> &get_items( point p ) const {
            return itm[p.x][p.y];
        }

        // TODO: Replace this as it essentially makes fld public
        field &get_field( point p ) {
            return fld[p.x][p.y];
        }

        const field &get_field( point p ) const {
            return fld[p.x][p.y];
        }

        struct cosmetic_t {
            point pos;
            std::string type;
            std::string str;
        };

        void insert_cosmetic( point p, const std::string &type, const std::string &str );

        int get_temperature() const {
            return temperature;
        }

        void set_temperature( int new_temperature ) {
            temperature = new_temperature;
        }

        bool has_graffiti( point p ) const;
        const std::string &get_graffiti( point p ) const;
        void set_graffiti( point p, const std::string &new_graffiti );
        void delete_graffiti( point p );

        // Signage is a pretend union between furniture on a square and stored
        // writing on the square. When both are present, we have signage.
        // Its effect is meant to be cosmetic and atmospheric only.
        bool has_signage( point p ) const;
        // Dependent on furniture + cosmetics.
        std::string get_signage( point p ) const;
        // Can be used anytime (prevents code from needing to place sign first.)
        void set_signage( point p, const std::string &s );
        // Can be used anytime (prevents code from needing to place sign first.)
        void delete_signage( point p );

        bool has_computer( point p ) const;
        const computer *get_computer( point p ) const;
        computer *get_computer( point p );
        void set_computer( point p, const computer &c );
        void delete_computer( point p );

        bool contains_vehicle( vehicle * );

        void rotate( int turns );

        void store( JsonOut &jsout ) const;
        void load( JsonIn &jsin, const std::string &member_name, int version );

        // If is_uniform is true, this submap is a solid block of terrain
        // Uniform submaps aren't saved/loaded, because regenerating them is faster
        bool is_uniform;

        std::vector<cosmetic_t> cosmetics; // Textual "visuals" for squares

        active_item_cache active_items;

        int field_count = 0;
        time_point last_touched = calendar::turn_zero;
        std::vector<spawn_point> spawns;
        /**
         * Vehicles on this submap (their (0,0) point is on this submap).
         * This vehicle objects are deleted by this submap when it gets
         * deleted.
         */
        std::vector<std::unique_ptr<vehicle>> vehicles;
        std::map<tripoint, partial_con> partial_constructions;
        std::unique_ptr<basecamp> camp;  // only allowing one basecamp per submap
        std::map<point_sm_ms, cata::poly_serialized<active_tile_data>> active_furniture;

    private:
        std::map<point, computer> computers;
        std::unique_ptr<computer> legacy_computer;
        int temperature = 0;

        void update_legacy_computer();

        static constexpr size_t elements = SEEX * SEEY;
};

/**
 * A wrapper for a submap point. Allows getting multiple map features
 * (terrain, furniture etc.) without directly accessing submaps or
 * doing multiple bounds checks and submap gets.
 */
struct maptile {
    private:
        friend map; // To allow "sliding" the tile in x/y without bounds checks
        friend submap;
        submap *const sm;
        point pos_;

        inline point pos() const {
            return pos_;
        }

        maptile( submap *sub, point p ) :
            sm( sub ), pos_( p ) { }
    public:
        trap_id get_trap() const {
            return sm->get_trap( pos() );
        }

        furn_id get_furn() const {
            return sm->get_furn( pos() );
        }

        ter_id get_ter() const {
            return sm->get_ter( pos() );
        }

        const trap &get_trap_t() const {
            return sm->get_trap( pos() ).obj();
        }

        const furn_t &get_furn_t() const {
            return sm->get_furn( pos() ).obj();
        }
        const ter_t &get_ter_t() const {
            return sm->get_ter( pos() ).obj();
        }

        const field &get_field() const {
            return sm->get_field( pos() );
        }

        field_entry *find_field( const field_type_id &field_to_find ) {
            return sm->get_field( pos() ).find_field( field_to_find );
        }

        int get_radiation() const {
            return sm->get_radiation( pos() );
        }

        bool has_graffiti() const {
            return sm->has_graffiti( pos() );
        }

        const std::string &get_graffiti() const {
            return sm->get_graffiti( pos() );
        }

        bool has_signage() const {
            return sm->has_signage( pos() );
        }

        std::string get_signage() const {
            return sm->get_signage( pos() );
        }

        // For map::draw_maptile
        size_t get_item_count() const {
            return sm->get_items( pos() ).size();
        }

        // Assumes there is at least one item
        const item &get_uppermost_item() const {
            return *std::prev( sm->get_items( pos() ).cend() );
        }
};

#endif // CATA_SRC_SUBMAP_H