Sort cli options in --help output
[quassel.git] / src / common / cliparser.cpp
index 9fbcacf..5036e16 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  ***************************************************************************/
 #include "cliparser.h"
 
+#include <QDir>
+#include <QDebug>
 #include <QString>
 #include <QFileInfo>
-#include <QDebug>
 
-CliParser::CliParser(QStringList arguments)
-{
-  argsRaw = arguments;
-//   remove Qt internal debugging arguments 
-  argsRaw.removeOne("-sync");
-  argsRaw.removeOne("-nograb");
-  argsRaw.removeOne("-dograb");
+#include <iostream>
+
+CliParser::CliParser() : AbstractCliParser() {
+
 }
 
-void CliParser::addArgument(const QString &longName, const CliParserArg &arg) {
-  if(argsHash.contains(longName)) qWarning() << "Warning: Multiple definition of argument" << longName;
+void CliParser::addArgument(const QString &longName_, const CliParserArg &arg) {
+  QString longName = longName_;
+  longName.remove(QRegExp("\\s*<.*>\\s*")); // KCmdLineArgs takes args of the form "arg <defval>"
+  if(argsMap.contains(longName)) qWarning() << "Warning: Multiple definition of argument" << longName;
   if(arg.shortName != 0 && !lnameOfShortArg(arg.shortName).isNull())
     qWarning().nospace() << "Warning: Redefining shortName '" << arg.shortName << "' for " << longName << " previously defined for " << lnameOfShortArg(arg.shortName);
-  argsHash.insert(longName, arg);
+  argsMap.insert(longName, arg);
 }
 
 bool CliParser::addLongArg(const CliParserArg::CliArgType type, const QString &name, const QString &value) {
-  if(argsHash.contains(name)){
-    if(type == CliParserArg::CliArgOption && argsHash.value(name).type == type) {
-      argsHash[name].value = value;
+  if(argsMap.contains(name)){
+    if(type == CliParserArg::CliArgOption && argsMap.value(name).type == type) {
+      argsMap[name].value = escapedValue(value);
       return true;
     }
-    else if (type == CliParserArg::CliArgSwitch && argsHash.value(name).type == type) {
-      argsHash[name].boolValue = true;
+    else if (type == CliParserArg::CliArgSwitch && argsMap.value(name).type == type) {
+      argsMap[name].boolValue = true;
       return true;
     }
   }
+  qWarning() << "Warning: Unrecognized argument:" << name;
   return false;
 }
 
 bool CliParser::addShortArg(const CliParserArg::CliArgType type, const char shortName, const QString &value) {
   QString longName = lnameOfShortArg(shortName);
   if(!longName.isNull()) {
-    if(type == CliParserArg::CliArgOption && argsHash.value(longName).type == type) {
-      argsHash[longName].value = value;
+    if(type == CliParserArg::CliArgOption && argsMap.value(longName).type == type) {
+      argsMap[longName].value = escapedValue(value);
       return true;
     }
     else if (type == CliParserArg::CliArgSwitch) {
-      if(argsHash.value(longName).type == type) {
-        argsHash[longName].boolValue = true;
+      if(argsMap.value(longName).type == type) {
+        argsMap[longName].boolValue = true;
         return true;
       }
       // arg is an option but detected as a switch -> argument is missing
@@ -72,10 +73,20 @@ bool CliParser::addShortArg(const CliParserArg::CliArgType type, const char shor
       }
     }
   }
+  qWarning().nospace() << "Warning: Unrecognized argument: '" << shortName << "'";
   return false;
 }
 
-bool CliParser::parse() {
+QString CliParser::escapedValue(const QString &value) {
+  QString escapedValue = value;
+  if(escapedValue.startsWith("~"))
+    escapedValue.replace(0, 1, QDir::homePath());
+
+  return escapedValue;
+}
+
+bool CliParser::init(const QStringList &args) {
+  argsRaw = args;
   QStringList::const_iterator currentArg;
   for (currentArg = argsRaw.constBegin(); currentArg != argsRaw.constEnd(); ++currentArg) {
     if(currentArg->startsWith("--")) {
@@ -139,14 +150,14 @@ bool CliParser::parse() {
 }
 
 void CliParser::usage() {
-  qWarning() << "Usage:" << QFileInfo(argsRaw.at(0)).completeBaseName() << "[arguments]";
-  
+  std::cout << "Usage: " << qPrintable(QFileInfo(argsRaw.at(0)).completeBaseName()) << " [arguments]" << std::endl;
+
   // get size of longName field
-  QStringList keys = argsHash.keys();
+  QStringList keys = argsMap.keys();
   uint lnameFieldSize = 0;
   foreach (QString key, keys) {
     uint size = 0;
-    if(argsHash.value(key).type == CliParserArg::CliArgOption)
+    if(argsMap.value(key).type == CliParserArg::CliArgOption)
       size += key.size()*2;
     else
       size += key.size();
@@ -154,12 +165,12 @@ void CliParser::usage() {
     size += 8;
     if(size > lnameFieldSize) lnameFieldSize = size;
   }
-  
-  QHash<QString, CliParserArg>::const_iterator arg;
-  for(arg = argsHash.constBegin(); arg != argsHash.constEnd(); ++arg) {
+
+  QMap<QString, CliParserArg>::const_iterator arg;
+  for(arg = argsMap.constBegin(); arg != argsMap.constEnd(); ++arg) {
     QString output;
     QString lnameField;
-    
+
     if(arg.value().shortName) {
       output.append(" -").append(arg.value().shortName).append(",");
     }
@@ -175,16 +186,16 @@ void CliParser::usage() {
     if(arg.value().type == CliParserArg::CliArgOption && !arg.value().def.isNull()) {
       output.append(". Default is: ").append(arg.value().def);
     }
-    qWarning(output.toLatin1());
+    std::cout << qPrintable(output) << std::endl;
   }
 }
 
 QString CliParser::value(const QString &longName) {
-  if(argsHash.contains(longName) && argsHash.value(longName).type == CliParserArg::CliArgOption) {
-    if(!argsHash.value(longName).value.isNull())
-      return argsHash.value(longName).value;
+  if(argsMap.contains(longName) && argsMap.value(longName).type == CliParserArg::CliArgOption) {
+    if(!argsMap.value(longName).value.isNull())
+      return argsMap.value(longName).value;
     else
-      return argsHash.value(longName).def;
+      return argsMap.value(longName).def;
   }
   else {
     qWarning() << "Warning: Requested value of not defined argument" << longName << "or argument is a switch";
@@ -193,9 +204,9 @@ QString CliParser::value(const QString &longName) {
 }
 
 bool CliParser::isSet(const QString &longName) {
-  if(argsHash.contains(longName)) {
-    if(argsHash.value(longName).type == CliParserArg::CliArgOption) return !argsHash.value(longName).value.isNull();
-    else return argsHash.value(longName).boolValue;
+  if(argsMap.contains(longName)) {
+    if(argsMap.value(longName).type == CliParserArg::CliArgOption) return !argsMap.value(longName).value.isNull();
+    else return argsMap.value(longName).boolValue;
   }
   else {
     qWarning() << "Warning: Requested isSet of not defined argument" << longName;
@@ -204,8 +215,8 @@ bool CliParser::isSet(const QString &longName) {
 }
 
 QString CliParser::lnameOfShortArg(const char arg) {
-  QHash<QString, CliParserArg>::const_iterator cur;
-  for (cur = argsHash.constBegin(); cur != argsHash.constEnd(); ++cur) {
+  QMap<QString, CliParserArg>::const_iterator cur;
+  for (cur = argsMap.constBegin(); cur != argsMap.constEnd(); ++cur) {
     if(cur.value().shortName == arg) return cur.key();
   }
   return QString();