File: ProgramParameters.cxx

package info (click to toggle)
caret 5.6.4~dfsg.1-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 31,904 kB
  • ctags: 28,901
  • sloc: cpp: 378,050; python: 6,718; ansic: 5,507; makefile: 333; sh: 46
file content (496 lines) | stat: -rw-r--r-- 14,813 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
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
/*LICENSE_START*/
/*
 *  Copyright 1995-2002 Washington University School of Medicine
 *
 *  http://brainmap.wustl.edu
 *
 *  This file is part of CARET.
 *
 *  CARET 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  CARET 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 CARET; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
/*LICENSE_END*/

#include <iostream>

#include <QStringList>

#include "DebugControl.h"
#include "FileUtilities.h"
#include "ProgramParameters.h"

/**
 * constructor.
 */
ProgramParameters::ProgramParameters(const int argc, char* argv[])
{
   parameters.clear();
   for (int i = 0; i < argc; i++) {
      parameters.push_back(argv[i]);
   }
   resetParametersIndex();
}

/**
 * constructor.
 */
ProgramParameters::ProgramParameters(const QString& programName,
                                     const QStringList& programParameters)
{
   parameters.clear();
   parameters.push_back(programName);
   for (int i = 0; i < programParameters.count(); i++) {
      parameters.push_back(programParameters.at(i));
   }
   resetParametersIndex();
}
      
/**
 * destructor.
 */
ProgramParameters::~ProgramParameters()
{
}

/**
 * get the number of parameters (value will change if splitUpRemainingParameters() called)
 */
int 
ProgramParameters::getNumberOfParameters() const throw (ProgramParametersException)
{
   return parameters.size();
}

/**
 * reset the parameters index.
 */
void 
ProgramParameters::resetParametersIndex() throw (ProgramParametersException)
{
   parametersIndex = 1;
}
      
/**
 * get the program name without the path.
 */
QString 
ProgramParameters::getProgramNameWithoutPath() const throw (ProgramParametersException)
{
   if (parameters.empty()) {
      throw ProgramParametersException("Parameters passed to constructor were empty.");
   }
   const QString name(FileUtilities::basename(parameters[0]));
   return name;
}

/**
 * get the program name with the path.
 */
QString 
ProgramParameters::getProgramNameWithPath() const throw (ProgramParametersException)
{
   if (parameters.empty()) {
      throw ProgramParametersException("Parameters passed to constructor were empty.");
   }
   const QString name(parameters[0]);
   return name;
}

/**
 * see if parameters are remaining.
 */
bool 
ProgramParameters::getParametersAvailable() const throw (ProgramParametersException)
{
   if (parametersIndex < static_cast<int>(parameters.size())) {
      return true;
   }
   return false;
}

/**
 * get next parameter as a string.
 */
QString 
ProgramParameters::getNextParameterAsString(const QString& parameterNameForErrorMessage) throw (ProgramParametersException)
{
   if (getParametersAvailable() == false) {
      const QString msg("Parameter named \""
                        + parameterNameForErrorMessage
                        + "\" is missing.");
      throw ProgramParametersException(msg);
   }
   
   const QString name(parameters[parametersIndex]);
   parametersIndex++;
   
   if (DebugControl::getDebugOn()) {
      if (parameterNameForErrorMessage.isEmpty() == false) {
         std::cout << "Parameter ("
                   << parameterNameForErrorMessage.toAscii().constData()
                   << ") "
                   << name.toAscii().constData()
                   << std::endl;
      }
   }
   
   return name;
}

/**
 * get next parameter as an int.
 */
int 
ProgramParameters::getNextParameterAsInt(const QString& parameterNameForErrorMessage) throw (ProgramParametersException)
{
   const QString s(getNextParameterAsString(parameterNameForErrorMessage));
   bool ok = false;
   const int i = s.toInt(&ok);
   if (ok == false) {
      throw ProgramParametersException("Error converting parameter named \""
                                       + parameterNameForErrorMessage
                                       + "\" with value \""
                                       + s
                                       + "\" to an integer");
   }
   return i;
}

/**
 * get next parameter as a float.
 */
float 
ProgramParameters::getNextParameterAsFloat(const QString& parameterNameForErrorMessage) throw (ProgramParametersException)
{
   const QString s(getNextParameterAsString(parameterNameForErrorMessage));
   bool ok = false;
   const float f = s.toFloat(&ok);
   if (ok == false) {
      throw ProgramParametersException("Error converting parameter named \""
                                       + parameterNameForErrorMessage
                                       + "\" with value \""
                                       + s
                                       + "\" to a float");
   }
   return f;
}

/**
 * get next parameter as a double
 */
double 
ProgramParameters::getNextParameterAsDouble(const QString& parameterNameForErrorMessage) throw (ProgramParametersException)
{
   const QString s(getNextParameterAsString(parameterNameForErrorMessage));
   bool ok = false;
   const double d = s.toDouble(&ok);
   if (ok == false) {
      throw ProgramParametersException("Error converting parameter named \""
                                       + parameterNameForErrorMessage
                                       + "\" with value \""
                                       + s
                                       + "\" to an double");
   }
   return d;
}

/**
 * get next parameter as boolean.
 */
bool 
ProgramParameters::getNextParameterAsBoolean(const QString& parameterNameForErrorMessage) throw (ProgramParametersException)
{
   const QString s(getNextParameterAsString(parameterNameForErrorMessage).toLower());

   if (s == "true") return true;
   if (s == "false") return false;
   
   throw ProgramParametersException("Error converting parameter named \""
                                       + parameterNameForErrorMessage
                                       + "\" with value \""
                                       + s
                                       + "\" to a boolean (\"true\" or \"false\").");
}
      
/**
 * unget the last parameter.
 */
void 
ProgramParameters::ungetLastParameter() throw (ProgramParametersException)
{
   if (parametersIndex <= 1) {
      throw ProgramParametersException("Cannot unget last parameter, already "
                                       "at first parameter");
   }
}

/**
 * get several parameters as strings.
 */
void 
ProgramParameters::getNextParametersAsStrings(const QString& parameterNameForErrorMessage,
                                              const int numberOfParametersToGet,
                                              std::vector<QString>& parametersOut) throw (ProgramParametersException)
{
   parametersOut.clear();
   for (int i = 0; i < numberOfParametersToGet; i++) {
      const QString paramName(parameterNameForErrorMessage
                              + "[" + QString::number(i) + "]");
      parametersOut.push_back(getNextParameterAsString(paramName));
   }
}

/**
 * get several parameters as ints.
 */
void 
ProgramParameters::getNextParametersAsInts(const QString& parameterNameForErrorMessage,
                                           const int numberOfParametersToGet,
                                           std::vector<int>& parametersOut) throw (ProgramParametersException)
{
   parametersOut.clear();
   for (int i = 0; i < numberOfParametersToGet; i++) {
      const QString paramName(parameterNameForErrorMessage
                              + "[" + QString::number(i) + "]");
      parametersOut.push_back(getNextParameterAsInt(paramName));
   }
}

/**
 * get several parameters as floats.
 */
void 
ProgramParameters::getNextParametersAsFloats(const QString& parameterNameForErrorMessage,
                                             const int numberOfParametersToGet,
                                             std::vector<float>& parametersOut) throw (ProgramParametersException)
{
   parametersOut.clear();
   for (int i = 0; i < numberOfParametersToGet; i++) {
      const QString paramName(parameterNameForErrorMessage
                              + "[" + QString::number(i) + "]");
      parametersOut.push_back(getNextParameterAsFloat(paramName));
   }
}

/**
 * get several parameters as doubles.
 */
void 
ProgramParameters::getNextParametersAsDoubles(const QString& parameterNameForErrorMessage,
                                              const int numberOfParametersToGet,
                                              std::vector<double>& parametersOut) throw (ProgramParametersException)
{
   parametersOut.clear();
   for (int i = 0; i < numberOfParametersToGet; i++) {
      const QString paramName(parameterNameForErrorMessage
                              + "[" + QString::number(i) + "]");
      parametersOut.push_back(getNextParameterAsDouble(paramName));
   }
}      

/**
 * get remaining parameters as strings.
 */
void 
ProgramParameters::getRemainingParametersAsStrings(const QString& parameterNameForErrorMessage,
                                     std::vector<QString>& parametersOut) throw (ProgramParametersException)
{
   parametersOut.clear();
   while (getParametersAvailable()) {
      parametersOut.push_back(getNextParameterAsString(parameterNameForErrorMessage));
   }
}

/**
 * get remaining parameters as ints.
 */
void 
ProgramParameters::getRemainingParametersAsInts(const QString& parameterNameForErrorMessage,
                                     std::vector<int>& parametersOut) throw (ProgramParametersException)
{
   parametersOut.clear();
   while (getParametersAvailable()) {
      parametersOut.push_back(getNextParameterAsInt(parameterNameForErrorMessage));
   }
}

/**
 * get remaining parameters as floats.
 */
void 
ProgramParameters::getRemainingParametersAsFloats(const QString& parameterNameForErrorMessage,
                                     std::vector<float>& parametersOut) throw (ProgramParametersException)
{
   parametersOut.clear();
   while (getParametersAvailable()) {
      parametersOut.push_back(getNextParameterAsFloat(parameterNameForErrorMessage));
   }
}

/**
 * get remaining parameters as doubles.
 */
void 
ProgramParameters::getRemainingParametersAsDoubles(const QString& parameterNameForErrorMessage,
                                     std::vector<double>& parametersOut) throw (ProgramParametersException)
{
   parametersOut.clear();
   while (getParametersAvailable()) {
      parametersOut.push_back(getNextParameterAsDouble(parameterNameForErrorMessage));
   }
}      

/**
 * get the next parameter as a volume file name and label separated by a semicolon.
 */
void 
ProgramParameters::getNextParameterAsVolumeFileNameAndLabel(const QString& parameterNameForErrorMessage,
                                                            QString& volumeFileNameOut,
                                                            QString& volumeFileLabelOut) throw (ProgramParametersException)
{
   volumeFileNameOut  = "";
   volumeFileLabelOut = "";
   
   volumeFileNameOut = getNextParameterAsString(parameterNameForErrorMessage);

   const QString delimeter = getVolumeFileNameAndLabelDelimeter();
   
   int colonPos = volumeFileNameOut.indexOf(delimeter);
   if (colonPos != -1) {
      volumeFileLabelOut = volumeFileNameOut.mid(0, colonPos);
      volumeFileNameOut = volumeFileNameOut.mid(colonPos + delimeter.length());
   }
   
   
}

/**
 * get the next parameter as structure.
 */
Structure 
ProgramParameters::getNextParameterAsStructure(const QString& parameterNameForErrorMessage) throw (ProgramParametersException)
{
   const QString name(getNextParameterAsString(parameterNameForErrorMessage));
   Structure structure;
   structure.setTypeFromString(name);
   if (structure.isInvalid()) {
      throw ProgramParametersException("Structure specified "
                                       + name
                                       + " is invalid.");
   }
   return structure;
}
      
/**
 * see if there is a parameter with specified name (does not affect "next parameter").
 */
bool 
ProgramParameters::getParameterWithValueExists(const QString& value) const
{
   const int indx = getIndexOfParameterWithValue(value);
   return (indx >= 0);
}

/**
 * get index of a parameter with specified name (returns -1 if not found).
 */
int 
ProgramParameters::getIndexOfParameterWithValue(const QString& value) const
{
   const int num = getNumberOfParameters();
   for (int i = 0; i < num; i++) {
      if (parameters[i] == value) {
         return i;
      }
   }
   
   return -1;
}

/**
 * get a parameter at a specified index (does not affect "next parameter").
 */
QString 
ProgramParameters::getParameterAtIndex(const int indx) const
{
   const int num = getNumberOfParameters();
   if ((indx >= 0) &&
       (indx < num)) {
      return parameters[indx];
   }
   
   return "";
}

/**
 * remove parameter at a specified index.
 */
void 
ProgramParameters::removeParameterAtIndex(const int indx)
{
   const int num = getNumberOfParameters();
   if ((indx >= 0) &&
       (indx < num)) {
      parameters.erase(parameters.begin() + indx);
   }
}      
      
/**
 * split up remaining parameters (may have more than one in single string).
 */
void 
ProgramParameters::splitUpRemainingParameters()
{
   const int savedParameterIndex = parametersIndex;
   
   std::vector<QString> paramsSplitUp;
   
   while (getParametersAvailable()) {
      //
      // Get the next parameter and split it up using whitespace
      //
      const QStringList sl = 
         getNextParameterAsString("").split(QRegExp("\\s+"), QString::SkipEmptyParts);
      for (int i = 0; i < sl.count(); i++) {
         const QString s = sl.at(i).trimmed();
         if (s.isEmpty() == false) {
            paramsSplitUp.push_back(s);
         }
      }
   }
   
   //
   // Were parameters split up?
   //
   if (paramsSplitUp.empty() == false) {
      //
      // Remove end of existing parameters
      //
      parameters.erase(parameters.begin() + savedParameterIndex,
                       parameters.end());
                       
      //
      // Add on split up parameters
      //
      parameters.insert(parameters.end(), 
                        paramsSplitUp.begin(), paramsSplitUp.end());
   
      //
      // Reset index of next parameter
      //
      parametersIndex = savedParameterIndex;
   }
}