mitkCommandLineParser.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkCommandLineParser_h
#define mitkCommandLineParser_h
 
#include <map>
#include <usAny.h>
 
#include <MitkCommandLineExports.h>
#include <mitkVersion.h>
 
class MITKCOMMANDLINE_EXPORT mitkCommandLineParser
{
public:
  enum Type
  {
    String = 0,    
    Bool = 1,      
    StringList = 2,
    Int = 3,       
    Float = 4,     
    Directory = 5, 
    File = 6,      
    Image = 7      
  };
 
  enum Channel
  {
    None = 0,   
    Input = 1,  
    Output = 2  
  };
 
  typedef std::vector<std::string> StringContainerType;
 
  mitkCommandLineParser();
 
  ~mitkCommandLineParser();
 
  std::map<std::string, us::Any> parseArguments(const StringContainerType &arguments, bool *ok = nullptr);
 
  std::map<std::string, us::Any> parseArguments(int argc, char **argv, bool *ok = nullptr);
 
  std::string errorString() const;
 
  const StringContainerType &unparsedArguments() const;
 
  bool argumentAdded(const std::string &argument) const;
 
  bool argumentParsed(const std::string &argument) const;
 
  void addArgument(const std::string &longarg,
                   const std::string &shortarg,
                   Type type,
                   const std::string &argLabel,
                   const std::string &argHelp = std::string(),
                   const us::Any &defaultValue = us::Any(),
                   bool optional = true,
                   bool ignoreRest = false,
                   bool deprecated = false,
                   mitkCommandLineParser::Channel channel = mitkCommandLineParser::Channel::None);
 
  void addDeprecatedArgument(const std::string &longarg,
                             const std::string &shortarg,
                             const std::string &argLabel,
                             const std::string &argHelp);
 
 
  std::vector < std::map<std::string, us::Any> > getArgumentList();
 
  bool setExactMatchRegularExpression(const std::string &argument,
                                      const std::string &expression,
                                      const std::string &exactMatchFailedMessage);
 
  std::string::size_type fieldWidth() const;
 
  std::string helpText() const;
 
  void setArgumentPrefix(const std::string &longPrefix, const std::string &shortPrefix);
 
  void beginGroup(const std::string &description);
 
  void endGroup();
 
  void setStrictModeEnabled(bool strictMode);
 
  void generateXmlOutput();
 
  void setTitle(std::string title);
  void setContributor(std::string contributor);
  void setCategory(std::string category);
  void setDescription(std::string description);
  void changeParameterGroup(std::string name, std::string tooltip);
 
protected:
  class ctkInternal;
  ctkInternal *Internal;
 
  std::string Title;
  std::string Contributor;
  std::string Category;
  std::string Description;
  std::string ParameterGroupName;
  std::string ParameterGroupDescription;
};
 
 
 
#endif