GetoptParameter.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_GETOPT_PARAMETER_H_INCLUDED
#define ICL_CORE_CONFIG_GETOPT_PARAMETER_H_INCLUDED

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

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

namespace icl_core {
namespace config {

class ICL_CORE_CONFIG_IMPORT_EXPORT GetoptParameter
{
public:
  GetoptParameter(const icl_core::String& option, const icl_core::String& short_option,
                  const icl_core::String& help, bool is_prefix = false);

  icl_core::String option() const { return m_option; }
  icl_core::String shortOption() const { return m_short_option; }
  bool hasValue() const { return m_has_value; }
  icl_core::String help() const { return m_help; }

  bool isPrefixOption() const { return m_is_prefix; }

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String Option() const ICL_CORE_GCC_DEPRECATE_STYLE;
  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String ShortOption() const ICL_CORE_GCC_DEPRECATE_STYLE;
  ICL_CORE_VC_DEPRECATE_STYLE bool HasValue() const ICL_CORE_GCC_DEPRECATE_STYLE;
  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String Help() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool IsPrefixOption() const ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  icl_core::String m_option;
  icl_core::String m_short_option;
  icl_core::String m_help;
  bool m_has_value;
  bool m_is_prefix;
};

typedef icl_core::Vector<GetoptParameter> GetoptParameterList;

}
}

#endif