File: CommandLineArgumentParser.h

package info (click to toggle)
itksnap 3.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 10,196 kB
  • ctags: 9,196
  • sloc: cpp: 62,895; sh: 175; makefile: 13
file content (145 lines) | stat: -rw-r--r-- 4,754 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*=========================================================================

  Program:   ITK-SNAP
  Module:    $RCSfile: CommandLineArgumentParser.h,v $
  Language:  C++
  Date:      $Date: 2008/11/20 05:10:39 $
  Version:   $Revision: 1.4 $
  Copyright (c) 2007 Paul A. Yushkevich
  
  This file is part of ITK-SNAP 

  ITK-SNAP is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  -----

  Copyright (c) 2003 Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the above copyright notices for more information. 

=========================================================================*/
#ifndef __CommandLineArgumentParser_h_
#define __CommandLineArgumentParser_h_

#if defined(_MSC_VER)
#pragma warning ( disable : 4786 )
#pragma warning ( disable : 4503 )
#endif

#include <vector>
#include <string>
#include <list>
#include <map>

/**
 * \class CommandLineArgumentParseResult
 * \brief Object returned by CommandLineArgumentParser
 * \see CommandLineArgumentParser
 */
class CommandLineArgumentParseResult
{
public:
  /** Check whether the option was passed in or not */
  bool IsOptionPresent(const char *option);

  /** Get one of the parameters to the option */
  const char *GetOptionParameter(const char *option, unsigned int number = 0);

  /** Get the number of parameters for the option */
  int GetNumberOfOptionParameters(const char *option);

private:
  typedef std::vector< std::string > ParameterArrayType;
  typedef std::map< std::string, ParameterArrayType> OptionMapType;

  void Clear();

  /**
   * @brief Add an option with specified number of parameters. The number of
   * parameters may be negative, in which case all non-options trailing the
   * command are read as parameters.
   * @param option
   * @param nParms
   */
  void AddOption(const std::string &option, int nParms);
  void AddParameter(const std::string &option, const std::string &parameter);

  OptionMapType m_OptionMap;

  friend class CommandLineArgumentParser;
};

/**
 * \class CommandLineArgumentParser
 * \brief Used to parse command line arguments and come back with a list
 * of parameters.
 * Usage:
 * \code
 *    // Set up the parser
 *    CommandLineArgumentParser parser;
 *    parser.AddOption("-f",1);
 *    parser.AddSynonim("-f","--filename");
 *    parser.AddOption("-v",0);
 *    parser.AddSynonim("-v","--verbose");
 *
 *    // Use the parser
 *    CommandLineArgumentParseResult result;
 *    if(parser.TryParseCommandLine(argc,argv,result)) {
 *       if(result.IsOptionPresent("-f"))
 *          cout << "Filename " << result.GetOptionParameter("-f") << endl;
 *       ...
 *    } 
 * \endcode      
 */
class CommandLineArgumentParser
{
public:
  /** Add an option with 0 or more parameters (words that follow it) */
  void AddOption(const char *name, int nParameters);
  
  /** Add a different string that envokes the same option (--file and -f) */  
  void AddSynonim(const char *option, const char *synonim);

  /** Try processing a command line.  Returns false if something breaks */
  bool TryParseCommandLine(int argc, char *argv[], 
                           CommandLineArgumentParseResult &outResult,
                           bool failOnUnknownTrailingParameters)
    {
    int junk;
    return this->TryParseCommandLine(argc, argv, outResult, failOnUnknownTrailingParameters, junk);
    }

  /** This version returns the index to the first unparsed parameter */
  bool TryParseCommandLine(int argc, char *argv[], 
                           CommandLineArgumentParseResult &outResult,
                           bool failOnUnknownTrailingParameters,
                           int &argc_out);
private:
private:
  // Synonim list type
  typedef std::list< std::string > NameListType;
  typedef struct 
    {
    std::string CommonName;
    unsigned int NumberOfParameters;
    } OptionType;
  typedef std::map< std::string, OptionType> OptionMapType;

  OptionMapType m_OptionMap;
};

#endif // __CommandLineArgumentParser_h_