GetoptParser.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_PARSER_H_INCLUDED
#define ICL_CORE_CONFIG_GETOPT_PARSER_H_INCLUDED

#include "icl_core/BaseTypes.h"
#include "icl_core/Deprecate.h"
#include "icl_core/List.h"
#include "icl_core/Map.h"
#include "icl_core/Vector.h"
#include "icl_core_config/ImportExport.h"
#include "icl_core_config/GetoptParameter.h"
#include "icl_core_config/GetoptPositionalParameter.h"

namespace icl_core {
namespace config {

class ICL_CORE_CONFIG_IMPORT_EXPORT Getopt
{
public:
  enum ParameterRegistrationCheck
  {
    ePRC_Strict, 
    ePRC_Relaxed 
  };
  typedef ICL_CORE_VC_DEPRECATE ParameterRegistrationCheck tParameterRegistrationCheck ICL_CORE_GCC_DEPRECATE;

  enum CommandLineCleaning
  {
    eCLC_None,   
    eCLC_Cleanup 
  };
  typedef ICL_CORE_VC_DEPRECATE CommandLineCleaning tCommandLineCleaning ICL_CORE_GCC_DEPRECATE;

  struct KeyValue
  {
    KeyValue(const icl_core::String& key, const icl_core::String& value)
      : m_key(key),
        m_value(value)
    { }

    icl_core::String m_key;
    icl_core::String m_value;
  };
  typedef icl_core::List<KeyValue> KeyValueList;

  static Getopt& instance();

  void activateExtraCmdParams(const icl_core::String& delimiter = "--");

  void addParameter(const GetoptParameter& parameter);

  void addParameter(const GetoptParameterList& parameters);

  void addParameter(const GetoptPositionalParameter& parameter);

  void addParameter(const GetoptPositionalParameterList& parameters);

  bool initialize(int& argc, char *argv[], bool remove_read_arguments);

  bool initialize(int& argc, char *argv[], CommandLineCleaning cleanup = eCLC_None,
                  ParameterRegistrationCheck registration_check = ePRC_Strict);

  bool isInitialized() const { return m_initialized; }

  int &argc();

  char** argv() const;

  icl_core::String extraCmdParam(size_t index) const;

  size_t extraCmdParamCount() const;

  icl_core::String paramOpt(const icl_core::String& name) const;

  bool paramOptPresent(const icl_core::String& name) const;

  KeyValueList paramPrefixOpt(const icl_core::String& prefix) const;

  bool paramPrefixOptPresent(const icl_core::String& prefix) const;

  icl_core::String paramNonOpt(size_t index) const;

  size_t paramNonOptCount() const;

  icl_core::String programName() const;

  icl_core::String programVersion() const;

  void setProgramVersion(icl_core::String const & version);

  void setProgramDescription(icl_core::String const & description);

  icl_core::String programDescription() const;

  void printHelp() const;

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE static Getopt& Instance() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void ActivateExtraCmdParams(const icl_core::String& delimiter = "--")
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void AddParameter(const GetoptParameter& parameter)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void AddParameter(const GetoptParameterList& parameters)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Initialize(int& argc, char *argv[], bool remove_read_arguments)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Initialize(int& argc, char *argv[],
                                              CommandLineCleaning cleanup = eCLC_None,
                                              ParameterRegistrationCheck registration_check = ePRC_Strict)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool IsInitialized() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String ExtraCmdParam(size_t index) const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE size_t ExtraCmdParamCount() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String ParamOpt(const icl_core::String& name) const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool ParamOptPresent(const icl_core::String& name) const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE KeyValueList ParamPrefixOpt(const icl_core::String& prefix) const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool ParamPrefixOptPresent(const icl_core::String& prefix) const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String ParamNonOpt(size_t index) const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE size_t ParamNonOptCount() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String ProgramName() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void PrintHelp() const ICL_CORE_GCC_DEPRECATE_STYLE;

#endif


private:
  Getopt();

  typedef icl_core::Map<icl_core::String, GetoptParameter> ParameterMap;
  ParameterMap m_parameters;
  ParameterMap m_prefix_parameters;
  ParameterMap m_short_parameters;
  ParameterMap m_short_prefix_parameters;
  GetoptPositionalParameterList m_required_positional_parameters;
  GetoptPositionalParameterList m_optional_positional_parameters;
  bool m_extra_cmd_param_activated;
  icl_core::String m_extra_cmd_param_delimiter;

  bool m_initialized;

  int m_argc;
  char** m_argv;
  icl_core::String m_program_name;
  icl_core::String m_program_version;
  icl_core::String m_program_description;
  icl_core::Vector<icl_core::String> m_param_non_opt;
  icl_core::Map<icl_core::String, icl_core::String> m_param_opt;
  icl_core::Map<icl_core::String, KeyValueList> m_prefix_param_opt;
  icl_core::Vector<icl_core::String> m_extra_cmd_param;
};

}
}
#endif