cconfiguration.h

//==========================================================================
//  CCONFIGURATION.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 1992-2017 Andras Varga
  Copyright (C) 2006-2017 OpenSim Ltd.

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/

#ifndef __OMNETPP_CCONFIGURATION_H
#define __OMNETPP_CCONFIGURATION_H

#include <string>
#include <map>
#include <vector>
#include "simkerneldefs.h"
#include "cobject.h"

namespace omnetpp {

class cConfigOption;

#define CFGNAME_GENERAL "General"

#define CFGVAR_RUNID            "runid"
#define CFGVAR_INIFILE          "inifile"
#define CFGVAR_CONFIGNAME       "configname"
#define CFGVAR_RUNNUMBER        "runnumber"
#define CFGVAR_NETWORK          "network"
#define CFGVAR_EXPERIMENT       "experiment"
#define CFGVAR_MEASUREMENT      "measurement"
#define CFGVAR_REPLICATION      "replication"
#define CFGVAR_PROCESSID        "processid"
#define CFGVAR_DATETIME         "datetime"
#define CFGVAR_RESULTDIR        "resultdir"
#define CFGVAR_REPETITION       "repetition"
#define CFGVAR_SEEDSET          "seedset"
#define CFGVAR_ITERATIONVARS    "iterationvars"   // without $repetition
#define CFGVAR_ITERATIONVARSF   "iterationvarsf"  // same, sanitized for use in file names


class SIM_API cConfiguration : public cObject
{
  public:
    class KeyValue {
      public:
        virtual ~KeyValue() {}
        virtual const char *getKey() const = 0;
        virtual const char *getValue() const = 0;
        virtual const char *getBaseDirectory() const = 0;
    };

    struct RunInfo {
        std::string info; // concatenated
        std::map<std::string,std::string> runAttrs; // run attributes
        std::string configBrief; // config options that contain inifile variables (${foo}), expanded
    };

  public:
    virtual const char *getConfigValue(const char *key) const = 0;

    virtual const KeyValue& getConfigEntry(const char *key) const = 0;

    virtual const char *getPerObjectConfigValue(const char *objectFullPath, const char *keySuffix) const = 0;

    virtual const KeyValue& getPerObjectConfigEntry(const char *objectFullPath, const char *keySuffix) const = 0;

    static bool parseBool(const char *s, const char *defaultValue, bool fallbackValue=false);
    static long parseLong(const char *s, const char *defaultValue, long fallbackValue=0);
    static double parseDouble(const char *s, const char *unit, const char *defaultValue, double fallbackValue=0);
    static std::string parseString(const char *s, const char *defaultValue, const char *fallbackValue="");
    static std::string parseFilename(const char *s, const char *baseDir, const char *defaultValue);
    static std::vector<std::string> parseFilenames(const char *s, const char *baseDir, const char *defaultValue);
    static std::string adjustPath(const char *s, const char *baseDir, const char *defaultValue);

//FIXME why aren't these methods all const???
    virtual const char *getAsCustom(cConfigOption *option, const char *fallbackValue=nullptr) const;

    virtual bool getAsBool(cConfigOption *option, bool fallbackValue=false) const;

    virtual long getAsInt(cConfigOption *option, long fallbackValue=0) const;

    virtual double getAsDouble(cConfigOption *option, double fallbackValue=0) const;

    virtual std::string getAsString(cConfigOption *option, const char *fallbackValue="") const;

    virtual std::string getAsFilename(cConfigOption *option) const;

    virtual std::vector<std::string> getAsFilenames(cConfigOption *option) const;

    virtual std::string getAsPath(cConfigOption *option) const;

    virtual const char *getAsCustom(const char *objectFullPath, cConfigOption *option, const char *fallbackValue=nullptr) const;

    virtual bool getAsBool(const char *objectFullPath, cConfigOption *option, bool fallbackValue=false) const;

    virtual long getAsInt(const char *objectFullPath, cConfigOption *option, long fallbackValue=0) const;

    virtual double getAsDouble(const char *objectFullPath, cConfigOption *option, double fallbackValue=0) const;

    virtual std::string getAsString(const char *objectFullPath, cConfigOption *option, const char *fallbackValue="") const;

    virtual std::string getAsFilename(const char *objectFullPath, cConfigOption *option) const;

    virtual std::vector<std::string> getAsFilenames(const char *objectFullPath, cConfigOption *option) const;

    virtual std::string getAsPath(const char *objectFullPath, cConfigOption *option) const;

    virtual const char *substituteVariables(const char *value) const = 0;
};


class SIM_API cConfigurationEx : public cConfiguration
{
  public:
    virtual void initializeFrom(cConfiguration *bootConfig) = 0;

    virtual const char *getFileName() const = 0;

    virtual void validate(const char *ignorableConfigKeys=nullptr) const = 0;

    virtual std::vector<std::string> getConfigNames() = 0;

    virtual void activateConfig(const char *configName, int runNumber=0) = 0;

    virtual std::string getConfigDescription(const char *configName) const = 0;

    virtual std::vector<std::string> getBaseConfigs(const char *configName) const = 0;

    virtual std::vector<std::string> getConfigChain(const char * configName) const = 0;

    virtual int getNumRunsInConfig(const char *configName) const = 0;

    virtual std::vector<RunInfo> unrollConfig(const char *configName) const = 0;

    virtual const char *getActiveConfigName() const = 0;

    virtual int getActiveRunNumber() const = 0;

    virtual const char *getVariable(const char *varname) const = 0;

    virtual std::vector<const char *> getIterationVariableNames() const = 0;

    virtual std::vector<const char *> getPredefinedVariableNames() const = 0;

    virtual const char *getVariableDescription(const char *varname) const = 0;

    virtual void dump() const = 0;


    virtual std::vector<const char *> getMatchingConfigKeys(const char *pattern) const = 0;

    virtual const char *getParameterValue(const char *moduleFullPath, const char *paramName, bool hasDefaultValue) const = 0;

    virtual const KeyValue& getParameterEntry(const char *moduleFullPath, const char *paramName, bool hasDefaultValue) const = 0;

    virtual std::vector<const char *> getKeyValuePairs() const = 0;

    virtual std::vector<const char *> getParameterKeyValuePairs() const = 0;

    virtual std::vector<const char *> getMatchingPerObjectConfigKeys(const char *objectFullPath, const char *keySuffixPattern) const = 0;

    virtual std::vector<const char *> getMatchingPerObjectConfigKeySuffixes(const char *objectFullPath, const char *keySuffixPattern) const = 0;
};

}  // namespace omnetpp

#endif