option_details.h

/*
 * SPDX-FileCopyrightText: 2020~2020 CSSlayer <wengxt@gmail.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 */
#ifndef _FCITX_CONFIG_OPTION_DETAILS_H_
#define _FCITX_CONFIG_OPTION_DETAILS_H_

#include <memory>
#include <string>
#include <vector>
#include <fcitx-config/fcitxconfig_export.h>
#include <fcitx-config/rawconfig.h>

namespace fcitx {

class Configuration;

class FCITXCONFIG_EXPORT OptionBase {
public:
    OptionBase(Configuration *parent, std::string path,
               std::string description);
    virtual ~OptionBase();

    const std::string &path() const;
    const std::string &description() const;
    virtual std::string typeString() const = 0;
    virtual void reset() = 0;
    virtual bool isDefault() const = 0;

    virtual void marshall(RawConfig &config) const = 0;
    virtual bool unmarshall(const RawConfig &config, bool partial) = 0;
    virtual std::unique_ptr<Configuration> subConfigSkeleton() const = 0;

    virtual bool equalTo(const OptionBase &other) const = 0;
    virtual void copyFrom(const OptionBase &other) = 0;
    bool operator==(const OptionBase &other) const { return equalTo(other); }
    bool operator!=(const OptionBase &other) const {
        return !operator==(other);
    }

    virtual bool skipDescription() const = 0;
    virtual bool skipSave() const = 0;
    virtual void dumpDescription(RawConfig &config) const;

private:
    Configuration *parent_;
    std::string path_;
    std::string description_;
};

class FCITXCONFIG_EXPORT OptionBaseV2 : public OptionBase {
public:
    using OptionBase::OptionBase;
    virtual void syncDefaultValueToCurrent() = 0;
};

class FCITXCONFIG_EXPORT OptionBaseV3 : public OptionBaseV2 {
public:
    using OptionBaseV2::OptionBaseV2;
    ~OptionBaseV3() override;
};

template <typename T>
struct RemoveVector {
    using type = T;
};

template <typename T>
struct RemoveVector<std::vector<T>> {
    using type = typename RemoveVector<T>::type;
};

template <typename T>
void dumpDescriptionHelper(RawConfig & /*unused*/, T * /*unused*/) {}

} // namespace fcitx

#endif // _FCITX_CONFIG_OPTION_DETAILS_H_