plan.h

#pragma once

#include "event_manager.h"
#include "room.h"
#include "stocks.h"
#include "plan_priorities.h"

#include <functional>
#include <list>

#include "df/coord.h"
#include "df/furnace_type.h"
#include "df/tile_dig_designation.h"
#include "df/tiletype.h"
#include "df/workshop_type.h"

namespace df
{
    struct building;
    struct building_stockpilest;
    struct item;
    struct plant;
    struct stockpile_settings;
}

class AI;

struct task
{
    task_type::type type;
    room *r;
    furniture *f;
    std::string last_status;
    int32_t item_id;

    task(task_type::type type, room *r = nullptr, furniture *f = nullptr, int32_t item_id = -1) :
        type(type), r(r), f(f), last_status(), item_id(item_id)
    {
    }
};

class Plan
{
    AI & ai;
    OnupdateCallback *onupdate_handle;
    std::map<int32_t, size_t> nrdig;
    std::list<task *> tasks_generic;
    std::list<task *> tasks_furniture;
    std::list<task *>::iterator bg_idx_generic;
    std::list<task *>::iterator bg_idx_furniture;
    std::vector<room *> rooms_and_corridors;
    std::vector<plan_priority_t> priorities;
    std::map<room_type::type, std::vector<room *>> room_category;
    std::map<int32_t, std::set<room *>> room_by_z;
    std::set<stock_item::item> cache_nofurnish;
    room *fort_entrance;
public:
    std::map<int32_t, std::vector<std::pair<df::coord, int32_t>>> map_veins;
private:
    std::vector<df::workshop_type> important_workshops;
    std::vector<df::furnace_type> important_workshops2;
    std::vector<df::workshop_type> important_workshops3;
    furniture *m_c_lever_in;
    furniture *m_c_lever_out;
    room *m_c_cistern;
    room *m_c_reserve;
    int32_t m_c_testgate_delay;
    size_t checkroom_idx;
    size_t trycistern_count;
    std::map<int32_t, std::vector<std::pair<df::coord, df::tile_dig_designation>>> map_vein_queue;
    std::set<df::coord> dug_veins;
    int32_t noblesuite;
    int16_t cavern_max_level;
    int32_t last_idle_year;
    bool allow_ice;
public:
    bool should_search_for_metal;
    bool past_initial_phase;
private:
    bool cistern_channel_requested;
    bool deconstructed_wagons;
    int32_t last_update_year;
    int32_t last_update_tick;

public:
    Plan(AI & ai);
    ~Plan();

    command_result startup(color_ostream & out);
    command_result onupdate_register(color_ostream & out);
    command_result onupdate_unregister(color_ostream & out);

    command_result persist(color_ostream & out);
    command_result unpersist(color_ostream & out);

    void update(color_ostream & out);

    void save(std::ostream & out);
    void load(std::istream & in);

    task *is_digging();
    bool is_idle();

    void new_citizen(color_ostream & out, int32_t uid);
    void del_citizen(color_ostream & out, int32_t uid);

    bool checkidle(color_ostream & out, std::ostream & reason);

    void checkrooms(color_ostream & out);
    void checkroom(color_ostream & out, room *r);

    void getbedroom(color_ostream & out, int32_t id);
    void getdiningroom(color_ostream & out, int32_t id);
    void attribute_noblerooms(color_ostream & out, const std::set<int32_t> & id_list);

    void getsoldierbarrack(color_ostream & out, int32_t id);
    void assign_barrack_squad(color_ostream & out, df::building *bld, int32_t squad_id);

    void getcoffin(color_ostream & out);

    void freebedroom(color_ostream & out, int32_t id);
    void freecommonrooms(color_ostream & out, int32_t id, room_type::type subtype);
    void freecommonrooms(color_ostream & out, int32_t id);
    void freesoldierbarrack(color_ostream & out, int32_t id);

    df::building *getpasture(color_ostream & out, int32_t pet_id);
    void freepasture(color_ostream & out, int32_t pet_id);
    bool pastures_ready(color_ostream & out);

    void set_owner(color_ostream & out, room *r, int32_t uid);

    bool wantdig(color_ostream & out, room *r, int32_t queue = 0);
    bool digroom(color_ostream & out, room *r, bool immediate = false);
    bool construct_room(color_ostream & out, room *r);
    bool furnish_room(color_ostream & out, room *r);
    bool try_furnish(color_ostream & out, room *r, furniture *f, std::ostream & reason);
    bool try_furnish_well(color_ostream & out, room *r, furniture *f, df::coord t, std::ostream & reason);
    bool try_furnish_archerytarget(color_ostream & out, room *r, furniture *f, df::coord t, std::ostream & reason);
    bool try_furnish_construction(color_ostream & out, df::construction_type ctype, df::coord t, std::ostream & reason);
    bool try_furnish_roller(color_ostream & out, room *r, furniture *f, df::coord t, std::ostream & reason);

    bool try_construct_tradedepot(color_ostream & out, room *r, std::ostream & reason);
    bool try_construct_workshop(color_ostream & out, room *r, std::ostream & reason);
    bool try_construct_furnace(color_ostream & out, room *r, std::ostream & reason);
    bool try_construct_stockpile(color_ostream & out, room *r, std::ostream & reason);
    bool try_construct_activityzone(color_ostream & out, room *r, std::ostream & reason);
    bool try_construct_windmill(color_ostream & out, room *r, std::ostream & reason);

    bool monitor_farm_irrigation(color_ostream & out, room *r, std::ostream & reason);
    bool can_place_farm(color_ostream & out, room *r, bool cheat, std::ostream & reason);
    bool try_construct_farmplot(color_ostream & out, room *r, std::ostream & reason);

    void move_dininghall_fromtemp(color_ostream & out, room *r, room *t);
    bool monitor_room_value(color_ostream & out, room *r, std::ostream & reason);
    bool rescue_caged(color_ostream & out, room *r, furniture *f, int32_t item_id, std::ostream & reason);

    bool smooth_room(color_ostream & out, room *r, bool engrave = false);
    void smooth_room_access(color_ostream & out, room *r);
    void smooth_cistern(color_ostream & out, room *r);
    void smooth_cistern_access(color_ostream & out, room *r);
    bool construct_cistern(color_ostream & out, room *r);
    bool dump_items_access(color_ostream & out, room *r);
    void room_items(color_ostream & out, room *r, std::function<void(df::item *)> f);
    bool smooth_xyz(df::coord min, df::coord max, bool engrave = false);
    bool smooth(std::set<df::coord> tiles, bool engrave = false);
    bool is_smooth(df::coord t, bool engrave = false);

    bool try_digcistern(color_ostream & out, room *r);
    bool try_setup_farmplot(color_ostream & out, room *r, std::ostream & reason);
    bool try_endfurnish(color_ostream & out, room *r, furniture *f, std::ostream & reason);

    bool setup_lever(color_ostream & out, room *r, furniture *f, std::ostream & reason);
    bool link_lever(color_ostream & out, furniture *src, furniture *dst, std::ostream & reason);
    bool pull_lever(color_ostream & out, furniture *f, std::ostream & reason);

    void monitor_cistern(color_ostream & out, std::ostream & reason);

    bool try_endconstruct(color_ostream & out, room *r, std::ostream & reason);

    df::coord scan_river(color_ostream & out);

    command_result make_map_walkable(color_ostream & out);
    command_result list_map_veins(color_ostream & out);

    int32_t can_dig_vein(int32_t mat);
    int32_t dig_vein(color_ostream & out, int32_t mat, int32_t want_boulders = 1);
    int32_t do_dig_vein(color_ostream & out, int32_t mat, df::coord b, bool plan_only = false);

    command_result setup_blueprint(color_ostream & out);
    command_result setup_blueprint_caverns(color_ostream & out);
    command_result setup_outdoor_gathering_zones(color_ostream & out);

    std::vector<room *> find_corridor_tosurface(color_ostream & out, corridor_type::type type, df::coord origin);
    room *find_typed_corridor(color_ostream & out, corridor_type::type type, df::coord origin, const std::set<room *> & no_attach_corridors = std::set<room *>());

    bool map_tile_in_rock(df::coord tile);
    bool map_tile_nocavern(df::coord tile);
    bool map_tile_cavernfloor(df::coord tile);
    bool map_tile_undiscovered_cavern(df::coord tile);

    static df::coord surface_tile_at(int16_t tx, int16_t ty, bool allow_trees = false);

    std::string status();
    void report_helper(std::ostream & out, bool html, const std::string & title, const std::list<task *> & tasks, const std::list<task *>::iterator & bg_idx, const std::set<task *> & seen_tasks);
    void report(std::ostream & out, bool html);

    void categorize_all();

    friend class AI;

    void weblegends_write_svg(std::ostream & out);
    bool find_building(df::building *bld, room * & r, furniture * & f);
    void add_task(task_type::type type, room* r = nullptr, furniture* f = nullptr, int32_t item_id = -1);

    static df::coord find_tree_base(df::coord t, df::plant **ptree = nullptr);

private:
    void fixup_open(color_ostream & out, room *r);
    void fixup_open_tile(color_ostream & out, room *r, df::coord t, df::tile_dig_designation d, furniture *f = nullptr);
    void fixup_open_helper(color_ostream & out, room *r, df::coord t, df::construction_type c, furniture *f, df::tiletype tt);

    bool corridor_include_hack(const room *r, df::coord t1, df::coord t2);
    friend struct room;
    friend struct plan_priority_t;
    friend class PlanSetup;
    friend class ConstructActivityZone;
};

struct farm_allowed_materials_t
{
    std::set<df::tiletype_material> set;
    farm_allowed_materials_t();
};
extern farm_allowed_materials_t farm_allowed_materials;

// vim: et:sw=4:ts=4