summaryrefslogtreecommitdiffstats
path: root/src/tclap/SwitchArg.h
blob: 78b8c0c4e1b58117ddc7084e23426687e3cd1326 (plain)
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
/******************************************************************************
 *
 *  file:  SwitchArg.h
 *
 *  Copyright (c) 2003, Michael E. Smoot .
 *  Copyright (c) 2004, Michael E. Smoot, Daniel Aarno.
 *  All rights reverved.
 *
 *  See the file COPYING in the top directory of this distribution for
 *  more information.
 *
 *  THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS
 *  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 *  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 *  DEALINGS IN THE SOFTWARE.
 *
 *****************************************************************************/


#ifndef TCLAP_SWITCH_ARG_H
#define TCLAP_SWITCH_ARG_H

#include <string>
#include <vector>

#include <tclap/Arg.h>

namespace TCLAP
{
	/**
	 * A simple switch argument.  If the switch is set on the command line, then
	 * the getValue method will return the opposite of the default value for the
	 * switch.
	 */
	class SwitchArg : public Arg
	{
		protected:
			/**
			 * The value of the switch.
			 */
			bool _value;

			/**
			 * Used to support the reset() method so that ValueArg can be
			 * reset to their constructed value.
			 */
			bool _default;

		public:
			/**
			* SwitchArg constructor.
			* \param flag - The one character flag that identifies this
			* argument on the command line.
			* \param name - A one word name for the argument.  Can be
			* used as a long flag on the command line.
			* \param desc - A description of what the argument is for or
			* does.
			* \param def - The default value for this Switch.
			* \param v - An optional visitor.  You probably should not
			* use this unless you have a very good reason.
			*/
			SwitchArg(const std::string &flag, const std::string &name, const std::string &desc,
			        bool def = false, Visitor *v = NULL);


			/**
			 * SwitchArg constructor.
			 * \param flag - The one character flag that identifies this
			 * argument on the command line.
			 * \param name - A one word name for the argument.  Can be
			 * used as a long flag on the command line.
			 * \param desc - A description of what the argument is for or
			 * does.
			 * \param parser - A CmdLine parser object to add this Arg to
			 * \param def - The default value for this Switch.
			 * \param v - An optional visitor.  You probably should not
			 * use this unless you have a very good reason.
			 */
			SwitchArg(const std::string &flag, const std::string &name, const std::string &desc,
			        CmdLineInterface &parser, bool def = false, Visitor *v = NULL);


			/**
			* Handles the processing of the argument.
			* This re-implements the Arg version of this method to set the
			* _value of the argument appropriately.
			* \param i - Pointer the the current argument in the list.
			* \param args - Mutable list of strings. Passed
			* in from main().
			*/
			virtual bool processArg(int *i, std::vector<std::string> &args);

			/**
			 * Checks a string to see if any of the chars in the string
			 * match the flag for this Switch.
			 */
			bool combinedSwitchesMatch(std::string &combined);

			/**
			 * Returns bool, whether or not the switch has been set.
			 */
			bool getValue();

			virtual void reset();
	};

	//////////////////////////////////////////////////////////////////////
	//BEGIN SwitchArg.cpp
	//////////////////////////////////////////////////////////////////////
	inline SwitchArg::SwitchArg(const std::string &flag, const std::string &name,
	        const std::string &desc, bool default_val, Visitor *v) :
			Arg(flag, name, desc, false, false, v), _value(default_val), _default(default_val)
	{
	}

	inline SwitchArg::SwitchArg(const std::string &flag, const std::string &name,
	        const std::string &desc, CmdLineInterface &parser, bool default_val,
	        Visitor *v) :
			Arg(flag, name, desc, false, false, v), _value(default_val), _default(default_val)
	{
		parser.add(this);
	}

	inline bool SwitchArg::getValue()
	{
		return _value;
	}

	inline bool SwitchArg::combinedSwitchesMatch(std::string &combinedSwitches)
	{
		// make sure this is actually a combined switch
		if (combinedSwitches.length() > 0 &&
		        combinedSwitches[0] != Arg::flagStartString()[0])
		{
			return false;
		}

		// make sure it isn't a long name
		if (combinedSwitches.substr(0, Arg::nameStartString().length()) == Arg::nameStartString())
		{
			return false;
		}

		// make sure the delimiter isn't in the string
		if (combinedSwitches.find_first_of(Arg::delimiter()) != std::string::npos)
		{
			return false;
		}

		// ok, we're not specifying a ValueArg, so we know that we have
		// a combined switch list.
		for (unsigned int i = 1; i < combinedSwitches.length(); i++)
		{
			if (_flag.length() > 0 &&
			        combinedSwitches[i] == _flag[0] &&
			        _flag[0] != Arg::flagStartString()[0])
			{
				// update the combined switches so this one is no longer present
				// this is necessary so that no unlabeled args are matched
				// later in the processing.
				//combinedSwitches.erase(i,1);
				combinedSwitches[i] = Arg::blankChar();
				return true;
			}
		}

		// none of the switches passed in the list match.
		return false;
	}

	inline bool SwitchArg::processArg(int *i, std::vector<std::string> &args)
	{
		if (_ignoreable && Arg::ignoreRest())
		{
			return false;
		}

		if (argMatches(args[*i]) || combinedSwitchesMatch(args[*i]))
		{
			// If we match on a combined switch, then we want to return false
			// so that other switches in the combination will also have a
			// chance to match.
			bool ret = false;
			if (argMatches(args[*i]))
			{
				ret = true;
			}

			if (_alreadySet || (!ret && combinedSwitchesMatch(args[*i])))
			{
				throw (CmdLineParseException("Argument already set!", toString()));
			}

			_alreadySet = true;

			if (_value == true)
			{
				_value = false;
			}
			else
			{
				_value = true;
			}

			_checkWithVisitor();

			return ret;
		}
		else
		{
			return false;
		}
	}

	inline void SwitchArg::reset()
	{
		Arg::reset();
		_value = _default;
	}

	//////////////////////////////////////////////////////////////////////
	//End SwitchArg.cpp
	//////////////////////////////////////////////////////////////////////
} //namespace TCLAP

#endif