home/src/option_manager.hh

#ifndef option_manager_hh_INCLUDED
#define option_manager_hh_INCLUDED

#include "completion.hh"
#include "exception.hh"
#include "option_types.hh"
#include "utils.hh"

#include <unordered_map>

namespace Kakoune
{

struct option_not_found : public runtime_error
{
    option_not_found(const String& name)
        : runtime_error("option not found: " + name) {}
};

class OptionManager;

enum class OptionFlags
{
    None   = 0,
    Hidden = 1,
};
constexpr OptionFlags operator|(OptionFlags lhs, OptionFlags rhs)
{ return (OptionFlags)((int)lhs | (int)rhs); }

constexpr bool operator&(OptionFlags lhs, OptionFlags rhs)
{ return (bool)((int)lhs & (int)rhs); }


class OptionDesc
{
public:
    OptionDesc(String name, String docstring, OptionFlags flags);

    const String& name() const { return m_name; }
    const String& docstring() const { return m_docstring; }

    OptionFlags flags() const { return m_flags; }

private:
    String m_name;
    String m_docstring;
    OptionFlags  m_flags;
};

class Option
{
public:
    virtual ~Option() = default;

    template<typename T> const T& get() const;
    template<typename T> void set(const T& val);
    template<typename T> bool is_of_type() const;

    virtual String get_as_string() const = 0;
    virtual void   set_from_string(const String& str) = 0;
    virtual void   add_from_string(const String& str) = 0;

    virtual Option* clone(OptionManager& manager) const = 0;
    OptionManager& manager() const { return m_manager; }

    const String& name() const { return m_desc.name(); }
    const String& docstring() const { return m_desc.docstring(); }
    OptionFlags flags() const { return m_desc.flags(); }

protected:
    Option(const OptionDesc& desc, OptionManager& manager);

    OptionManager& m_manager;
    const OptionDesc& m_desc;
};

class OptionManagerWatcher
{
public:
    virtual ~OptionManagerWatcher() {}

    virtual void on_option_changed(const Option& option) = 0;
};

class OptionManager : private OptionManagerWatcher
{
public:
    OptionManager(OptionManager& parent);
    ~OptionManager();

    const Option& operator[] (const String& name) const;
    Option& get_local_option(const String& name);

    CandidateList complete_option_name(StringView prefix,
                                       ByteCount cursor_pos);

    using OptionList = std::vector<const Option*>;
    OptionList flatten_options() const;

    void register_watcher(OptionManagerWatcher& watcher);
    void unregister_watcher(OptionManagerWatcher& watcher);

    void on_option_changed(const Option& option) override;
private:
    OptionManager()
        : m_parent(nullptr) {}
    // the only one allowed to construct a root option manager
    friend class GlobalOptions;

    template<typename MatchingFunc>
    CandidateList get_matching_names(MatchingFunc func);

    std::vector<std::unique_ptr<Option>> m_options;
    OptionManager* m_parent;

    std::vector<OptionManagerWatcher*> m_watchers;
};

template<typename T> using OptionChecker = std::function<void (const T&)>;

template<typename T>
class TypedOption : public Option
{
public:
    TypedOption(OptionManager& manager, const OptionDesc& desc,
                const T& value, OptionChecker<T> checker)
        : Option(desc, manager),
          m_value(value), m_checker(std::move(checker)) {}

    void set(T value)
    {
        if (m_value != value)
        {
            if (m_checker)
                m_checker(value);
            m_value = std::move(value);
            manager().on_option_changed(*this);
        }
    }
    const T& get() const { return m_value; }

    String get_as_string() const override
    {
        return option_to_string(m_value);
    }
    void set_from_string(const String& str) override
    {
        T val;
        option_from_string(str, val);
        set(std::move(val));
    }
    void add_from_string(const String& str) override
    {
        T val;
        option_from_string(str, val);
        if (m_checker)
            m_checker(val);
        if (option_add(m_value, val))
            m_manager.on_option_changed(*this);
    }

    Option* clone(OptionManager& manager) const override
    {
        return new TypedOption{manager, m_desc, m_value, m_checker};
    }
private:
    T m_value;
    OptionChecker<T> m_checker;
};

template<typename T> const T& Option::get() const
{
    auto* typed_opt = dynamic_cast<const TypedOption<T>*>(this);
    if (not typed_opt)
        throw runtime_error("option " + name() + " is not of type " + typeid(T).name());
    return typed_opt->get();
}

template<typename T> void Option::set(const T& val)
{
    auto* typed_opt = dynamic_cast<TypedOption<T>*>(this);
    if (not typed_opt)
        throw runtime_error("option " + name() + " is not of type " + typeid(T).name());
    return typed_opt->set(val);
}

template<typename T> bool Option::is_of_type() const
{
    return dynamic_cast<const TypedOption<T>*>(this) != nullptr;
}

template<typename T>
auto find_option(T& container, const String& name) -> decltype(container.begin())
{
    using ptr_type = decltype(*container.begin());
    return find_if(container, [&name](const ptr_type& opt) { return opt->name() == name; });
}

class GlobalOptions : public OptionManager,
                      public Singleton<GlobalOptions>
{
public:
    GlobalOptions();

    template<typename T>
    Option& declare_option(const String& name, const String& docstring,
                           const T& value,
                           OptionFlags flags = OptionFlags::None,
                           OptionChecker<T> checker = OptionChecker<T>{})
    {
        auto it = find_option(m_options, name);
        if (it != m_options.end())
        {
            if ((*it)->is_of_type<T>() and (*it)->flags() == flags)
                return **it;
            throw runtime_error("option " + name + " already declared with different type or flags");
        }
        m_descs.emplace_back(new OptionDesc{name, docstring, flags});
        m_options.emplace_back(new TypedOption<T>{*this, *m_descs.back(),
                                                  value, std::move(checker)});
        return *m_options.back();
    }

    bool option_exists(const String& name) const
    {
        return find_option(m_options, name) != m_options.end();
    }
private:
    std::vector<std::unique_ptr<OptionDesc>> m_descs;
};

struct OptionManagerRegisterFuncs
{
    static void insert(OptionManager& options, OptionManagerWatcher& watcher)
    {
        options.register_watcher(watcher);
    }
    static void remove(OptionManager& options, OptionManagerWatcher& watcher)
    {
        options.unregister_watcher(watcher);
    }
};

class OptionManagerWatcher_AutoRegister
    : public OptionManagerWatcher,
      public AutoRegister<OptionManagerWatcher_AutoRegister,
                          OptionManagerRegisterFuncs, OptionManager>
{
public:
    OptionManagerWatcher_AutoRegister(OptionManager& options)
        : AutoRegister(options) {}

    OptionManager& options() { return registry(); }
};


}

#endif // option_manager_hh_INCLUDED