ctkCommandLineParser.cpp 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759
  1. // STL includes
  2. #include <stdexcept>
  3. // Qt includes
  4. #include <QHash>
  5. #include <QStringList>
  6. #include <QTextStream>
  7. #include <QDebug>
  8. #include <QSettings>
  9. #include <QPointer>
  10. // CTK includes
  11. #include "ctkCommandLineParser.h"
  12. namespace
  13. {
  14. // --------------------------------------------------------------------------
  15. class CommandLineParserArgumentDescription
  16. {
  17. public:
  18. CommandLineParserArgumentDescription(
  19. const QString& longArg, const QString& longArgPrefix,
  20. const QString& shortArg, const QString& shortArgPrefix,
  21. QVariant::Type type, const QString& argHelp,
  22. const QVariant& defaultValue, bool ignoreRest,
  23. bool deprecated)
  24. : LongArg(longArg), LongArgPrefix(longArgPrefix),
  25. ShortArg(shortArg), ShortArgPrefix(shortArgPrefix),
  26. ArgHelp(argHelp), IgnoreRest(ignoreRest), NumberOfParametersToProcess(0),
  27. Deprecated(deprecated), DefaultValue(defaultValue), Value(type), ValueType(type)
  28. {
  29. if (defaultValue.isValid())
  30. {
  31. Value = defaultValue;
  32. }
  33. switch (type)
  34. {
  35. case QVariant::String:
  36. {
  37. NumberOfParametersToProcess = 1;
  38. RegularExpression = ".*";
  39. }
  40. break;
  41. case QVariant::Bool:
  42. {
  43. NumberOfParametersToProcess = 0;
  44. RegularExpression = "";
  45. }
  46. break;
  47. case QVariant::StringList:
  48. {
  49. NumberOfParametersToProcess = -1;
  50. RegularExpression = ".*";
  51. }
  52. break;
  53. case QVariant::Int:
  54. {
  55. NumberOfParametersToProcess = 1;
  56. RegularExpression = "-?[0-9]+";
  57. ExactMatchFailedMessage = "A negative or positive integer is expected.";
  58. }
  59. break;
  60. default:
  61. ExactMatchFailedMessage = QString("Type %1 not supported.").arg(static_cast<int>(type));
  62. }
  63. }
  64. ~CommandLineParserArgumentDescription(){}
  65. bool addParameter(const QString& value);
  66. QString helpText(int fieldWidth, const char charPad);
  67. QString LongArg;
  68. QString LongArgPrefix;
  69. QString ShortArg;
  70. QString ShortArgPrefix;
  71. QString ArgHelp;
  72. bool IgnoreRest;
  73. int NumberOfParametersToProcess;
  74. QString RegularExpression;
  75. QString ExactMatchFailedMessage;
  76. bool Deprecated;
  77. QVariant DefaultValue;
  78. QVariant Value;
  79. QVariant::Type ValueType;
  80. };
  81. // --------------------------------------------------------------------------
  82. bool CommandLineParserArgumentDescription::addParameter(const QString& value)
  83. {
  84. if (!RegularExpression.isEmpty())
  85. {
  86. // Validate value
  87. QRegExp regexp(this->RegularExpression);
  88. if (!regexp.exactMatch(value))
  89. {
  90. return false;
  91. }
  92. }
  93. switch (Value.type())
  94. {
  95. case QVariant::String:
  96. {
  97. Value.setValue(value);
  98. }
  99. break;
  100. case QVariant::Bool:
  101. {
  102. Value.setValue(!QString::compare(value, "true", Qt::CaseInsensitive));
  103. }
  104. break;
  105. case QVariant::StringList:
  106. {
  107. if (Value.isNull())
  108. {
  109. QStringList list;
  110. list << value;
  111. Value.setValue(list);
  112. }
  113. else
  114. {
  115. QStringList list = Value.toStringList();
  116. list << value;
  117. Value.setValue(list);
  118. }
  119. }
  120. break;
  121. case QVariant::Int:
  122. {
  123. Value.setValue(value.toInt());
  124. }
  125. break;
  126. default:
  127. return false;
  128. }
  129. return true;
  130. }
  131. // --------------------------------------------------------------------------
  132. QString CommandLineParserArgumentDescription::helpText(int fieldWidth, const char charPad)
  133. {
  134. QString text;
  135. QTextStream stream(&text);
  136. stream.setFieldAlignment(QTextStream::AlignLeft);
  137. stream.setPadChar(charPad);
  138. QString shortAndLongArg;
  139. if (!this->ShortArg.isEmpty())
  140. {
  141. shortAndLongArg += QString(" %1%2").arg(this->ShortArgPrefix).arg(this->ShortArg);
  142. }
  143. if (!this->LongArg.isEmpty())
  144. {
  145. if (this->ShortArg.isEmpty())
  146. {
  147. shortAndLongArg.append(" ");
  148. }
  149. else
  150. {
  151. shortAndLongArg.append(", ");
  152. }
  153. shortAndLongArg += QString("%1%2").arg(this->LongArgPrefix).arg(this->LongArg);
  154. }
  155. if(!this->ArgHelp.isEmpty())
  156. {
  157. stream.setFieldWidth(fieldWidth);
  158. }
  159. stream << shortAndLongArg;
  160. stream.setFieldWidth(0);
  161. stream << this->ArgHelp;
  162. if (!this->DefaultValue.isNull())
  163. {
  164. stream << " (default: " << this->DefaultValue.toString() << ")";
  165. }
  166. stream << "\n";
  167. return text;
  168. }
  169. }
  170. // --------------------------------------------------------------------------
  171. // ctkCommandLineParser::ctkInternal class
  172. // --------------------------------------------------------------------------
  173. class ctkCommandLineParser::ctkInternal
  174. {
  175. public:
  176. ctkInternal(QSettings* settings)
  177. : Debug(false), FieldWidth(0), UseQSettings(false),
  178. Settings(settings), MergeSettings(true), StrictMode(false)
  179. {}
  180. ~ctkInternal() { qDeleteAll(ArgumentDescriptionList); }
  181. CommandLineParserArgumentDescription* argumentDescription(const QString& argument);
  182. QList<CommandLineParserArgumentDescription*> ArgumentDescriptionList;
  183. QHash<QString, CommandLineParserArgumentDescription*> ArgNameToArgumentDescriptionMap;
  184. QMap<QString, QList<CommandLineParserArgumentDescription*> > GroupToArgumentDescriptionListMap;
  185. QStringList UnparsedArguments;
  186. QStringList ProcessedArguments;
  187. QString ErrorString;
  188. bool Debug;
  189. int FieldWidth;
  190. QString LongPrefix;
  191. QString ShortPrefix;
  192. QString CurrentGroup;
  193. bool UseQSettings;
  194. QPointer<QSettings> Settings;
  195. QString DisableQSettingsLongArg;
  196. QString DisableQSettingsShortArg;
  197. bool MergeSettings;
  198. bool StrictMode;
  199. };
  200. // --------------------------------------------------------------------------
  201. // ctkCommandLineParser::ctkInternal methods
  202. // --------------------------------------------------------------------------
  203. CommandLineParserArgumentDescription*
  204. ctkCommandLineParser::ctkInternal::argumentDescription(const QString& argument)
  205. {
  206. QString unprefixedArg = argument;
  207. if (!LongPrefix.isEmpty() && argument.startsWith(LongPrefix))
  208. {
  209. unprefixedArg = argument.mid(LongPrefix.length());
  210. }
  211. else if (!ShortPrefix.isEmpty() && argument.startsWith(ShortPrefix))
  212. {
  213. unprefixedArg = argument.mid(ShortPrefix.length());
  214. }
  215. else if (!LongPrefix.isEmpty() && !ShortPrefix.isEmpty())
  216. {
  217. return 0;
  218. }
  219. if (this->ArgNameToArgumentDescriptionMap.contains(unprefixedArg))
  220. {
  221. return this->ArgNameToArgumentDescriptionMap[unprefixedArg];
  222. }
  223. return 0;
  224. }
  225. // --------------------------------------------------------------------------
  226. // ctkCommandLineParser methods
  227. // --------------------------------------------------------------------------
  228. ctkCommandLineParser::ctkCommandLineParser(QSettings* settings)
  229. {
  230. this->Internal = new ctkInternal(settings);
  231. }
  232. // --------------------------------------------------------------------------
  233. ctkCommandLineParser::~ctkCommandLineParser()
  234. {
  235. delete this->Internal;
  236. }
  237. // --------------------------------------------------------------------------
  238. QHash<QString, QVariant> ctkCommandLineParser::parseArguments(const QStringList& arguments,
  239. bool* ok)
  240. {
  241. // Reset
  242. this->Internal->UnparsedArguments.clear();
  243. this->Internal->ProcessedArguments.clear();
  244. this->Internal->ErrorString.clear();
  245. foreach (CommandLineParserArgumentDescription* desc,
  246. this->Internal->ArgumentDescriptionList)
  247. {
  248. desc->Value = QVariant(desc->ValueType);
  249. if (desc->DefaultValue.isValid())
  250. {
  251. desc->Value = desc->DefaultValue;
  252. }
  253. }
  254. bool error = false;
  255. bool ignoreRest = false;
  256. bool useSettings = this->Internal->UseQSettings;
  257. CommandLineParserArgumentDescription * currentArgDesc = 0;
  258. QList<CommandLineParserArgumentDescription*> parsedArgDescriptions;
  259. for(int i = 1; i < arguments.size(); ++i)
  260. {
  261. QString argument = arguments.at(i);
  262. if (this->Internal->Debug) { qDebug() << "Processing" << argument; }
  263. // should argument be ignored ?
  264. if (ignoreRest)
  265. {
  266. this->Internal->UnparsedArguments << argument;
  267. continue;
  268. }
  269. // Skip if the argument does not start with the defined prefix
  270. if (!(argument.startsWith(this->Internal->LongPrefix)
  271. || argument.startsWith(this->Internal->ShortPrefix)))
  272. {
  273. if (this->Internal->StrictMode)
  274. {
  275. this->Internal->ErrorString = QString("Unknown argument %1").arg(argument);
  276. error = true;
  277. break;
  278. }
  279. this->Internal->UnparsedArguments << argument;
  280. continue;
  281. }
  282. // Skip if argument has already been parsed ...
  283. if (this->Internal->ProcessedArguments.contains(argument))
  284. {
  285. if (this->Internal->StrictMode)
  286. {
  287. this->Internal->ErrorString = QString("Argument %1 already processed !").arg(argument);
  288. error = true;
  289. break;
  290. }
  291. qDebug() << "Skipping argument" << argument << " - Already processed !";
  292. continue;
  293. }
  294. // Retrieve corresponding argument description
  295. currentArgDesc = this->Internal->argumentDescription(argument);
  296. // Is there a corresponding argument description ?
  297. if (currentArgDesc)
  298. {
  299. // If the argument is deprecated, print the help text but continue processing
  300. if (currentArgDesc->Deprecated)
  301. {
  302. qWarning().nospace() << "Deprecated argument " << argument << ": " << currentArgDesc->ArgHelp;
  303. }
  304. else
  305. {
  306. parsedArgDescriptions.push_back(currentArgDesc);
  307. }
  308. // Is the argument the special "disable QSettings" argument?
  309. if ((!currentArgDesc->LongArg.isEmpty() && currentArgDesc->LongArg == this->Internal->DisableQSettingsLongArg)
  310. || (!currentArgDesc->ShortArg.isEmpty() && currentArgDesc->ShortArg == this->Internal->DisableQSettingsShortArg))
  311. {
  312. useSettings = false;
  313. }
  314. this->Internal->ProcessedArguments << currentArgDesc->ShortArg << currentArgDesc->LongArg;
  315. int numberOfParametersToProcess = currentArgDesc->NumberOfParametersToProcess;
  316. ignoreRest = currentArgDesc->IgnoreRest;
  317. // Is the number of parameters associated with the argument being processed known ?
  318. if (numberOfParametersToProcess == 0)
  319. {
  320. currentArgDesc->addParameter("true");
  321. }
  322. else if (numberOfParametersToProcess > 0)
  323. {
  324. QString missingParameterError =
  325. "Argument %1 has %2 value(s) associated whereas exacly %3 are expected.";
  326. for(int j=1; j <= numberOfParametersToProcess; ++j)
  327. {
  328. if (i + j >= arguments.size())
  329. {
  330. this->Internal->ErrorString =
  331. missingParameterError.arg(argument).arg(j-1).arg(numberOfParametersToProcess);
  332. if (this->Internal->Debug) { qDebug() << this->Internal->ErrorString; }
  333. if (ok) *ok = false;
  334. return QHash<QString, QVariant>();
  335. }
  336. QString parameter = arguments.at(i + j);
  337. if (this->Internal->Debug)
  338. {
  339. qDebug() << "Processing parameter" << j << ", value:" << parameter;
  340. }
  341. if (this->argumentAdded(parameter))
  342. {
  343. this->Internal->ErrorString =
  344. missingParameterError.arg(argument).arg(j-1).arg(numberOfParametersToProcess);
  345. if (this->Internal->Debug) { qDebug() << this->Internal->ErrorString; }
  346. if (ok) *ok = false;
  347. return QHash<QString, QVariant>();
  348. }
  349. if (!currentArgDesc->addParameter(parameter))
  350. {
  351. this->Internal->ErrorString = QString(
  352. "Value(s) associated with argument %1 are incorrect. %2").
  353. arg(argument).arg(currentArgDesc->ExactMatchFailedMessage);
  354. if (this->Internal->Debug) { qDebug() << this->Internal->ErrorString; }
  355. if (ok) *ok = false;
  356. return QHash<QString, QVariant>();
  357. }
  358. }
  359. // Update main loop increment
  360. i = i + numberOfParametersToProcess;
  361. }
  362. else if (numberOfParametersToProcess == -1)
  363. {
  364. if (this->Internal->Debug)
  365. {
  366. qDebug() << "Proccessing StringList ...";
  367. }
  368. int j = 1;
  369. while(j + i < arguments.size())
  370. {
  371. if (this->argumentAdded(arguments.at(j + i)))
  372. {
  373. if (this->Internal->Debug)
  374. {
  375. qDebug() << "No more parameter for" << argument;
  376. }
  377. break;
  378. }
  379. QString parameter = arguments.at(j + i);
  380. if (this->Internal->Debug)
  381. {
  382. qDebug() << "Processing parameter" << j << ", value:" << parameter;
  383. }
  384. if (!currentArgDesc->addParameter(parameter))
  385. {
  386. this->Internal->ErrorString = QString(
  387. "Value(s) associated with argument %1 are incorrect. %2").
  388. arg(argument).arg(currentArgDesc->ExactMatchFailedMessage);
  389. if (this->Internal->Debug) { qDebug() << this->Internal->ErrorString; }
  390. if (ok) *ok = false;
  391. return QHash<QString, QVariant>();
  392. }
  393. j++;
  394. }
  395. // Update main loop increment
  396. i = i + j;
  397. }
  398. }
  399. else
  400. {
  401. if (this->Internal->StrictMode)
  402. {
  403. this->Internal->ErrorString = QString("Unknown argument %1").arg(argument);
  404. error = true;
  405. break;
  406. }
  407. this->Internal->UnparsedArguments << argument;
  408. }
  409. }
  410. if (ok)
  411. {
  412. *ok = !error;
  413. }
  414. QSettings* settings = 0;
  415. if (this->Internal->UseQSettings && useSettings)
  416. {
  417. if (this->Internal->Settings)
  418. {
  419. settings = this->Internal->Settings;
  420. }
  421. else
  422. {
  423. // Use a default constructed QSettings instance
  424. settings = new QSettings();
  425. }
  426. }
  427. QHash<QString, QVariant> parsedArguments;
  428. QListIterator<CommandLineParserArgumentDescription*> it(this->Internal->ArgumentDescriptionList);
  429. while (it.hasNext())
  430. {
  431. QString key;
  432. CommandLineParserArgumentDescription* desc = it.next();
  433. if (!desc->LongArg.isEmpty())
  434. {
  435. key = desc->LongArg;
  436. }
  437. else
  438. {
  439. key = desc->ShortArg;
  440. }
  441. if (parsedArgDescriptions.contains(desc))
  442. {
  443. // The argument was supplied on the command line, so use the given value
  444. if (this->Internal->MergeSettings && settings)
  445. {
  446. // Merge with QSettings
  447. QVariant settingsVal = settings->value(key);
  448. if (desc->ValueType == QVariant::StringList &&
  449. settingsVal.canConvert(QVariant::StringList))
  450. {
  451. QStringList stringList = desc->Value.toStringList();
  452. stringList.append(settingsVal.toStringList());
  453. parsedArguments.insert(key, stringList);
  454. }
  455. else
  456. {
  457. // do a normal insert
  458. parsedArguments.insert(key, desc->Value);
  459. }
  460. }
  461. else
  462. {
  463. // No merging, just insert all user values
  464. parsedArguments.insert(key, desc->Value);
  465. }
  466. }
  467. else
  468. {
  469. if (settings)
  470. {
  471. // If there is a valid QSettings entry for the argument, use the value
  472. QVariant settingsVal = settings->value(key, desc->Value);
  473. if (!settingsVal.isNull())
  474. {
  475. parsedArguments.insert(key, settingsVal);
  476. }
  477. }
  478. else
  479. {
  480. // Just insert the arguments with valid default values
  481. if (!desc->Value.isNull())
  482. {
  483. parsedArguments.insert(key, desc->Value);
  484. }
  485. }
  486. }
  487. }
  488. // If we created a default QSettings instance, delete it
  489. if (settings && !this->Internal->Settings)
  490. delete settings;
  491. return parsedArguments;
  492. }
  493. // -------------------------------------------------------------------------
  494. QHash<QString, QVariant> ctkCommandLineParser::parseArguments(int argc, char** argv, bool* ok)
  495. {
  496. QStringList arguments;
  497. // Create a QStringList of arguments
  498. for(int i = 0; i < argc; ++i)
  499. {
  500. arguments << argv[i];
  501. }
  502. return this->parseArguments(arguments, ok);
  503. }
  504. // -------------------------------------------------------------------------
  505. QString ctkCommandLineParser::errorString() const
  506. {
  507. return this->Internal->ErrorString;
  508. }
  509. // -------------------------------------------------------------------------
  510. const QStringList& ctkCommandLineParser::unparsedArguments() const
  511. {
  512. return this->Internal->UnparsedArguments;
  513. }
  514. // --------------------------------------------------------------------------
  515. void ctkCommandLineParser::addArgument(const QString& longarg, const QString& shortarg,
  516. QVariant::Type type, const QString& argHelp,
  517. const QVariant& defaultValue, bool ignoreRest,
  518. bool deprecated)
  519. {
  520. Q_ASSERT_X(!(longarg.isEmpty() && shortarg.isEmpty()), "addArgument",
  521. "both long and short argument names are empty");
  522. if (longarg.isEmpty() && shortarg.isEmpty()) { return; }
  523. Q_ASSERT_X(!defaultValue.isValid() || defaultValue.type() == type, "addArgument",
  524. "defaultValue type does not match");
  525. if (defaultValue.isValid() && defaultValue.type() != type)
  526. throw std::logic_error("The QVariant type of defaultValue does not match the specified type");
  527. /* Make sure it's not already added */
  528. bool added = this->Internal->ArgNameToArgumentDescriptionMap.contains(longarg);
  529. Q_ASSERT_X(!added, "addArgument", "long argument already added");
  530. if (added) { return; }
  531. added = this->Internal->ArgNameToArgumentDescriptionMap.contains(shortarg);
  532. Q_ASSERT_X(!added, "addArgument", "short argument already added");
  533. if (added) { return; }
  534. CommandLineParserArgumentDescription* argDesc =
  535. new CommandLineParserArgumentDescription(longarg, this->Internal->LongPrefix,
  536. shortarg, this->Internal->ShortPrefix, type,
  537. argHelp, defaultValue, ignoreRest, deprecated);
  538. int argWidth = 0;
  539. if (!longarg.isEmpty())
  540. {
  541. this->Internal->ArgNameToArgumentDescriptionMap[longarg] = argDesc;
  542. argWidth += longarg.length() + this->Internal->LongPrefix.length();
  543. }
  544. if (!shortarg.isEmpty())
  545. {
  546. this->Internal->ArgNameToArgumentDescriptionMap[shortarg] = argDesc;
  547. argWidth += shortarg.length() + this->Internal->ShortPrefix.length() + 2;
  548. }
  549. argWidth += 5;
  550. // Set the field width for the arguments
  551. if (argWidth > this->Internal->FieldWidth)
  552. {
  553. this->Internal->FieldWidth = argWidth;
  554. }
  555. this->Internal->ArgumentDescriptionList << argDesc;
  556. this->Internal->GroupToArgumentDescriptionListMap[this->Internal->CurrentGroup] << argDesc;
  557. }
  558. // --------------------------------------------------------------------------
  559. void ctkCommandLineParser::addDeprecatedArgument(
  560. const QString& longarg, const QString& shortarg, const QString& argHelp)
  561. {
  562. addArgument(longarg, shortarg, QVariant::StringList, argHelp, QVariant(), false, true);
  563. }
  564. // --------------------------------------------------------------------------
  565. bool ctkCommandLineParser::setExactMatchRegularExpression(
  566. const QString& argument, const QString& expression, const QString& exactMatchFailedMessage)
  567. {
  568. CommandLineParserArgumentDescription * argDesc =
  569. this->Internal->argumentDescription(argument);
  570. if (!argDesc)
  571. {
  572. return false;
  573. }
  574. if (argDesc->Value.type() == QVariant::Bool)
  575. {
  576. return false;
  577. }
  578. argDesc->RegularExpression = expression;
  579. argDesc->ExactMatchFailedMessage = exactMatchFailedMessage;
  580. return true;
  581. }
  582. // --------------------------------------------------------------------------
  583. int ctkCommandLineParser::fieldWidth() const
  584. {
  585. return this->Internal->FieldWidth;
  586. }
  587. // --------------------------------------------------------------------------
  588. void ctkCommandLineParser::beginGroup(const QString& description)
  589. {
  590. this->Internal->CurrentGroup = description;
  591. }
  592. // --------------------------------------------------------------------------
  593. void ctkCommandLineParser::endGroup()
  594. {
  595. this->Internal->CurrentGroup.clear();
  596. }
  597. // --------------------------------------------------------------------------
  598. void ctkCommandLineParser::enableSettings(const QString& disableLongArg, const QString& disableShortArg)
  599. {
  600. this->Internal->UseQSettings = true;
  601. this->Internal->DisableQSettingsLongArg = disableLongArg;
  602. this->Internal->DisableQSettingsShortArg = disableShortArg;
  603. }
  604. // --------------------------------------------------------------------------
  605. void ctkCommandLineParser::mergeSettings(bool merge)
  606. {
  607. this->Internal->MergeSettings = merge;
  608. }
  609. // --------------------------------------------------------------------------
  610. bool ctkCommandLineParser::settingsEnabled() const
  611. {
  612. return this->Internal->UseQSettings;
  613. }
  614. // --------------------------------------------------------------------------
  615. QString ctkCommandLineParser::helpText(const char charPad) const
  616. {
  617. QString text;
  618. QTextStream stream(&text);
  619. QList<CommandLineParserArgumentDescription*> deprecatedArgs;
  620. // Loop over grouped argument descriptions
  621. QMapIterator<QString, QList<CommandLineParserArgumentDescription*> > it(
  622. this->Internal->GroupToArgumentDescriptionListMap);
  623. while(it.hasNext())
  624. {
  625. it.next();
  626. if (!it.key().isEmpty())
  627. {
  628. stream << "\n" << it.key() << "\n";
  629. }
  630. foreach(CommandLineParserArgumentDescription* argDesc, it.value())
  631. {
  632. if (argDesc->Deprecated)
  633. {
  634. deprecatedArgs << argDesc;
  635. }
  636. else
  637. {
  638. stream << argDesc->helpText(this->Internal->FieldWidth, charPad);
  639. }
  640. }
  641. }
  642. if (!deprecatedArgs.empty())
  643. {
  644. stream << "\nDeprecated arguments:\n";
  645. foreach(CommandLineParserArgumentDescription* argDesc, deprecatedArgs)
  646. {
  647. stream << argDesc->helpText(this->Internal->FieldWidth, charPad);
  648. }
  649. }
  650. return text;
  651. }
  652. // --------------------------------------------------------------------------
  653. bool ctkCommandLineParser::argumentAdded(const QString& argument) const
  654. {
  655. return this->Internal->ArgNameToArgumentDescriptionMap.contains(argument);
  656. }
  657. // --------------------------------------------------------------------------
  658. bool ctkCommandLineParser::argumentParsed(const QString& argument) const
  659. {
  660. return this->Internal->ProcessedArguments.contains(argument);
  661. }
  662. // --------------------------------------------------------------------------
  663. void ctkCommandLineParser::setArgumentPrefix(const QString& longPrefix, const QString& shortPrefix)
  664. {
  665. this->Internal->LongPrefix = longPrefix;
  666. this->Internal->ShortPrefix = shortPrefix;
  667. }
  668. // --------------------------------------------------------------------------
  669. void ctkCommandLineParser::setStrictModeEnabled(bool strictMode)
  670. {
  671. this->Internal->StrictMode = strictMode;
  672. }