klammertext/mac/state.h

#pragma once

#include "util.h"
#include "locator.h"
//#include "argtype.h"
#include "argument_set.h"


namespace klammerstate {
inline std::string no_value = "\0";
}

class Var
{
public:
    Var() = default;
    Var(const std::string& name, const std::string& value=klammerstate::no_value,
        const std::string& delim=":", const std::string& desc="", const Locator& loc=Locator(),
        const Argtype& argtype=Argtype())
        : m_name(name)
        , m_value(value)
        , m_delim(delim)
        , m_desc(desc)
        , m_loc(loc)
        , m_argtype(argtype)
        {};
    bool defined() const;

    std::string m_name {};
    std::string m_value {};
    std::string m_delim {};
    std::string m_desc {};
    Locator m_loc {};
    Argtype m_argtype {};
};

namespace klammerstate {
inline std::string shell_environment_name = "Shell environment";
}

class Frame
{
public:
    Frame(const std::string& name)
        : m_name(name)
        {};

    std::vector<std::string> names() const;
    void set(const std::string& name, const std::string& value,
             const std::string& delim=":", const std::string& desc="", const Locator& loc=Locator(),
             const Argtype& argtype=Argtype());
    std::pair<Var, bool> get(const std::string& name) const;

    std::string m_name {};
    std::map<std::string, Var> m_vars {};
};

class State
{
public:
    static int class_id;
    void open_frame(const std::string& name);
    void close_frame();
    void set(const std::string& name, const std::string& value, bool update=false,
             const std::string& delim=" ", const std::string& desc="", const Locator& loc=Locator(),
             const Argtype& argtype=Argtype());
    void set(const std::map<std::string, std::string>& varmap);
    void set(const std::map<std::string, std::string>& varmap,
             const Parameter_set& parameters);
    void replace(const std::string& name, const std::string& value, bool error_if_not_defined=true);
    void add_environment_frame();
    Var get(const std::string& name, bool error_if_not_defined=false, const Locator& loc=Locator()) const;
    std::string value(const std::string& name, bool error_if_not_defined=true, const Locator& loc=Locator()) const;

    std::string subst(const std::string& text, bool quote_values=false) const;
    void subst(std::vector<Katom>::iterator begin, std::vector<Katom>::iterator end);

    void parse_state_katoms(std::vector<Katom>::iterator begin, std::vector<Katom>::iterator end, katom_list& katoms);
    std::vector<std::string> all_names() const;
    void add_search_dir(const std::string& dir);
    std::string python_code();
    std::string describe(bool show_environment=false, int margin_size=2) const;

    std::vector<Frame> m_frames {};
    // Directories of the files the Machine has read (input files, klammer
    // sets, @read targets), in reading order: @eval finds Python modules
    // and :cpp libraries next to the file that uses them (see python_code()
    // and Eval::eval_command).
    std::vector<std::string> m_search_dirs {};
    // @@@state Image_search_path :set :append :replace :argtype :desc
    // Parameter_set m_parameters = Parameter_set("name :set :append :replace :argtype :delim :desc");
    Parameter_set m_parameters = Parameter_set("name :value :append :replace :delim :desc");
};