Setting.hh

Go to the documentation of this file.

#ifndef SETTING_HH
#define SETTING_HH
 
#include "Subject.hh"
#include "TclObject.hh"
#include "static_string_view.hh"
#include "strCat.hh"
#include <cassert>
#include <functional>
#include <optional>
#include <string_view>
#include <vector>
 
namespace openmsx {
 
class CommandController;
class GlobalCommandController;
class Interpreter;
 
class BaseSetting
{
protected:
        explicit BaseSetting(std::string_view name);
        explicit BaseSetting(TclObject name);
        ~BaseSetting() = default;
 
public:
        [[nodiscard]] const TclObject& getFullNameObj() const { return fullName; }
        [[nodiscard]] const TclObject& getBaseNameObj() const { return baseName; }
        [[nodiscard]] std::string_view getFullName()    const { return fullName.getString(); }
        [[nodiscard]] std::string_view getBaseName()    const { return baseName.getString(); }
 
        void setPrefix(std::string_view prefix) {
                assert(prefix.starts_with("::"));
                fullName = tmpStrCat(prefix, getBaseName());
        }
 
        void info(TclObject& result) const;
 
 
        [[nodiscard]] virtual std::string_view getDescription() const = 0;
 
        [[nodiscard]] virtual std::string_view getTypeString() const = 0;
 
        virtual void additionalInfo(TclObject& result) const = 0;
 
        virtual void tabCompletion(std::vector<std::string>& tokens) const = 0;
 
        [[nodiscard]] virtual const TclObject& getValue() const = 0;
 
        [[nodiscard]] virtual std::optional<TclObject> getOptionalValue() const = 0;
 
        [[nodiscard]] virtual TclObject getDefaultValue() const = 0;
 
        [[nodiscard]] virtual TclObject getRestoreValue() const = 0;
 
        virtual void setValue(const TclObject& value) = 0;
 
        virtual void setValueDirect(const TclObject& value) = 0;
 
        [[nodiscard]] virtual bool needLoadSave() const = 0;
 
        [[nodiscard]] virtual bool needTransfer() const = 0;
 
        virtual void setDontSaveValue(const TclObject& dontSaveValue) = 0;
 
private:
              TclObject fullName;
        const TclObject baseName;
};
 
 
class Setting : public BaseSetting, public Subject<Setting>
{
public:
        Setting(const Setting&) = delete;
        Setting& operator=(const Setting&) = delete;
 
        enum SaveSetting {
                SAVE,          //    save,    transfer
                DONT_SAVE,     // no-save,    transfer
                DONT_TRANSFER, // no-save, no-transfer
        };
 
        virtual ~Setting();
 
        [[nodiscard]] const TclObject& getValue() const final { return value; }
        [[nodiscard]] std::optional<TclObject> getOptionalValue() const final { return value; }
 
        void setRestoreValue(const TclObject& newRestoreValue) {
                restoreValue = newRestoreValue;
        }
 
        void setChecker(std::function<void(TclObject&)> checkFunc_) {
                checkFunc = std::move(checkFunc_);
        }
 
        // BaseSetting
        void setValue(const TclObject& newValue) final;
        [[nodiscard]] std::string_view getDescription() const final;
        [[nodiscard]] TclObject getDefaultValue() const final { return defaultValue; }
        [[nodiscard]] TclObject getRestoreValue() const final { return restoreValue; }
        void setValueDirect(const TclObject& newValue) final;
        void tabCompletion(std::vector<std::string>& tokens) const override;
        [[nodiscard]] bool needLoadSave() const final;
        void additionalInfo(TclObject& result) const override;
        [[nodiscard]] bool needTransfer() const final;
        void setDontSaveValue(const TclObject& dontSaveValue) final;
 
        // convenience functions
        [[nodiscard]] CommandController& getCommandController() const { return commandController; }
        [[nodiscard]] Interpreter& getInterpreter() const;
 
protected:
        Setting(CommandController& commandController,
                std::string_view name, static_string_view description,
                const TclObject& initialValue, SaveSetting save = SAVE);
        void init();
        void notifyPropertyChange() const;
 
private:
        [[nodiscard]] GlobalCommandController& getGlobalCommandController() const;
        void notify() const;
 
private:
        CommandController& commandController;
        const static_string_view description;
        std::function<void(TclObject&)> checkFunc;
        TclObject value; // TODO can we share the underlying Tcl var storage?
        const TclObject defaultValue;
        TclObject restoreValue;
        std::optional<TclObject> dontSaveValue;
        const SaveSetting save;
};
 
} // namespace openmsx
 
#endif