callable_objects.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2014 - 2025
    by David White <dave@whitevine.net>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#pragma once
 
#include "color.hpp"
#include "formula/callable.hpp"
#include "formula/formula.hpp"
#include "map/location.hpp"
#include "units/ptr.hpp"
 
class display_context;
class gamemap;
class team;
class terrain_type;
class unit;
class unit_type;
namespace game_events {struct queued_event;}
 
namespace wfl
{
 
/** An object representing the state of the game, providing access to the map and basic information */
class gamestate_callable : public formula_callable
{
public:
    // Currently it accesses all its state through the resources namespace, so nothing is passed into it.
 
    void get_inputs(formula_input_vector& inputs) const override;
    variant get_value(const std::string& key) const override;
};
 
/** An object representing the state of the current event; equivalent to Lua's wesnoth.current.event_context */
class event_callable : public formula_callable
{
public:
    event_callable(const game_events::queued_event& event) : event_info(event) {}
 
    void get_inputs(formula_input_vector& inputs) const override;
    variant get_value(const std::string& key) const override;
private:
    const game_events::queued_event& event_info;
    mutable std::shared_ptr<attack_type> first_weapon, second_weapon;
};
 
class terrain_callable : public formula_callable
{
public:
    terrain_callable(const display_context& m, const map_location& loc);
 
    variant get_value(const std::string& key) const override;
    void get_inputs(formula_input_vector& inputs) const override;
 
    int do_compare(const formula_callable* callable) const override;
 
    const terrain_type& get_terrain_type() const { return t_; }
 
private:
    const map_location loc_;
    const terrain_type& t_;
    const int owner_;
};
 
class gamemap_callable : public formula_callable
{
public:
    explicit gamemap_callable(const display_context& g) : board_(g)
    {}
 
    void get_inputs(formula_input_vector& inputs) const override;
    variant get_value(const std::string& key) const override;
 
    const gamemap& get_gamemap() const;
 
private:
    const display_context& board_;
};
 
class location_callable : public formula_callable
{
public:
    explicit location_callable(const map_location& loc) : loc_(loc)
    {
        type_ = LOCATION_C;
    }
 
    /** Inherited from formula_callable. */
    std::string serialize_to_string() const override;
 
    const map_location& loc() const { return loc_; }
 
private:
    map_location loc_;
 
    variant get_value(const std::string& key) const override;
 
    void get_inputs(formula_input_vector& inputs) const override;
    int do_compare(const formula_callable* callable) const override;
};
 
class attack_type_callable : public formula_callable
{
public:
    explicit attack_type_callable(const attack_type& attack);
 
    variant get_value(const std::string& key) const override;
    void get_inputs(formula_input_vector& inputs) const override;
 
    int do_compare(const formula_callable* callable) const override;
 
    const attack_type& get_attack_type() const { return *att_; }
 
private:
    const_attack_ptr att_;
};
 
class unit_callable : public formula_callable
{
public:
    unit_callable(const map_location& loc, const unit& u) : loc_(loc), u_(u)
    {
        type_ = UNIT_C;
    }
 
    explicit unit_callable(const unit &u);
 
    variant get_value(const std::string& key) const override;
    void get_inputs(formula_input_vector& inputs) const override;
 
    int do_compare(const formula_callable* callable) const override;
 
    const unit& get_unit() const { return u_; }
    const map_location& get_location() const { return loc_; }
 
private:
    const map_location& loc_;
    const unit& u_;
};
 
class unit_type_callable : public formula_callable
{
public:
    explicit unit_type_callable(const unit_type& u) : u_(u)
    {
        type_ = UNIT_TYPE_C;
    }
 
    variant get_value(const std::string& key) const override;
    void get_inputs(formula_input_vector& inputs) const override;
 
    int do_compare(const formula_callable* callable) const override;
 
    const unit_type& get_unit_type() const { return u_; }
 
private:
    const unit_type& u_;
};
 
class config_callable : public formula_callable
{
public:
    explicit config_callable(const config& c) : cfg_(c) {}
 
    variant get_value(const std::string& key) const override;
    void get_inputs(formula_input_vector& inputs) const override;
    int do_compare(const formula_callable* callable) const override;
 
    const config& get_config() const { return cfg_; }
 
private:
    const config& cfg_;
};
 
class team_callable : public formula_callable
{
public:
    explicit team_callable(const team& t) : team_(t) {}
 
    void get_inputs(formula_input_vector& inputs) const override;
    variant get_value(const std::string& key) const override;
 
    const team& get_team() const { return team_; }
 
private:
    const team& team_;
};
 
 
class color_callable : public formula_callable
{
public:
    color_callable(color_t clr)
        : clr_(clr)
    {}
 
    void get_inputs(formula_input_vector& inputs) const override;
    variant get_value(const std::string& key) const override;
 
    const color_t get_color() const { return clr_; }
 
private:
    color_t clr_;
};
 
 
 
class set_var_callable : public action_callable
{
public:
    set_var_callable(const std::string& key, const variant& value)
        : key_(key), value_(value)
    {}
 
    const std::string& key() const { return key_; }
    variant value() const { return value_; }
    variant execute_self(variant ctxt) override;
 
private:
    std::string key_;
    variant value_;
    variant get_value(const std::string& key) const override;
 
    void get_inputs(formula_input_vector& inputs) const override;
};
 
class safe_call_callable : public action_callable
{
 
public:
    safe_call_callable(const variant& main, const expression_ptr& backup)
        : main_(main)
        , backup_()
        , backup_formula_(backup)
    {}
 
    const variant& get_main() const { return main_; }
    const expression_ptr& get_backup() const { return backup_formula_; }
 
    void set_backup_result(const variant& v)
    {
        backup_ = v;
    }
 
    variant execute_self(variant ctxt) override;
 
private:
    variant main_;
    variant backup_;
    expression_ptr backup_formula_;
    variant get_value(const std::string& key) const override;
 
    void get_inputs(formula_input_vector& inputs) const override;
};
 
class safe_call_result : public formula_callable
{
public:
    safe_call_result(const_formula_callable_ptr callable, int status, const map_location& loc = map_location())
        : failed_callable_(callable)
        , current_unit_location_(loc)
        , status_(status)
    {}
 
private:
    const_formula_callable_ptr failed_callable_;
    const map_location current_unit_location_;
    const int status_;
 
    variant get_value(const std::string& key) const override;
 
    void get_inputs(formula_input_vector& inputs) const override;
};
 
} // namespace wfl