ConfigurationProvider.h

Go to the documentation of this file.

 
#pragma once
 
#include <string>
 
#include <miktex/Configuration/config.h>
 
#include <miktex/Util/PathName>
 
#include "ConfigValue.h"
#include "HasNamedValues.h"

MIKTEX_CONFIG_BEGIN_NAMESPACE;

enum class SpecialPath
{
    UserConfigRoot,

    UserDataRoot,

    UserInstallRoot,

    UserLogDirectory,

    CommonConfigRoot,

    CommonDataRoot,

    CommonInstallRoot,

    CommonLogDirectory,

    PortableRoot,

    PortableMount,

    DistRoot,
 
    #if defined(MIKTEX_MACOS_BUNDLE)
    MacOsDirectory,
    #endif

    ConfigRoot,

    DataRoot,

    InstallRoot,

    BinDirectory,

    InternalBinDirectory,

    LinkTargetDirectory,

    LogDirectory,    
};

class MIKTEXNOVTABLE ConfigurationProvider
{
 
public:

    virtual bool MIKTEXTHISCALL TryGetConfigValue(const std::string& sectionName, const std::string& valueName, HasNamedValues* callback, std::string& value) = 0;

    virtual bool MIKTEXTHISCALL TryGetConfigValue(const std::string& sectionName, const std::string& valueName, std::string& value) = 0;

    virtual ConfigValue MIKTEXTHISCALL GetConfigValue(const std::string& sectionName, const std::string& valueName, const ConfigValue& defaultValue, HasNamedValues* callback) = 0;

    virtual ConfigValue MIKTEXTHISCALL GetConfigValue(const std::string& sectionName, const std::string& valueName, const ConfigValue& defaultValue) = 0;

    virtual ConfigValue MIKTEXTHISCALL GetConfigValue(const std::string& sectionName, const std::string& valueName, HasNamedValues* callback) = 0;

    virtual ConfigValue MIKTEXTHISCALL GetConfigValue(const std::string& sectionName, const std::string& valueName) = 0;

    virtual void MIKTEXTHISCALL SetConfigValue(const std::string& sectionName, const std::string& valueName, const ConfigValue& value) = 0;

    virtual MiKTeX::Util::PathName MIKTEXTHISCALL GetSpecialPath(SpecialPath specialPath) = 0;
};
 
MIKTEX_CONFIG_END_NAMESPACE;