ConfigParameter.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_CONFIG_CONFIG_PARAMETER_H_INCLUDED
#define ICL_CORE_CONFIG_CONFIG_PARAMETER_H_INCLUDED

#include "icl_core/BaseTypes.h"
#include "icl_core/Vector.h"
#include "icl_core_config/ImportExport.h"
#include "icl_core_config/GetoptParameter.h"

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

namespace icl_core {
namespace config {

class ICL_CORE_CONFIG_IMPORT_EXPORT ConfigParameter : public GetoptParameter
{
public:
  ConfigParameter(const icl_core::String& option, const icl_core::String& short_option,
                  const icl_core::String& config_key, const icl_core::String& help,
                  const icl_core::String& default_value = "");

  icl_core::String configKey() const { return m_config_key; }

  bool hasDefaultValue() const { return !m_default_value.empty(); }

  icl_core::String defaultValue() const { return m_default_value; }

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String ConfigKey() const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool HasDefaultValue() const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String DefaultValue() const
    ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  icl_core::String m_config_key;
  icl_core::String m_default_value;
};

typedef icl_core::Vector<ConfigParameter> ConfigParameterList;

}
}

#endif