1 /***************************************************************************
2 * Copyright (C) 2005-08 by the Quassel IRC Team *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20 #include "cliparser.h"
26 CliParser::CliParser(QStringList arguments)
29 // remove Qt internal debugging arguments
30 argsRaw.removeOne("-sync");
31 argsRaw.removeOne("-nograb");
32 argsRaw.removeOne("-dograb");
35 void CliParser::addArgument(const QString &longName, const CliParserArg &arg) {
36 if(argsHash.contains(longName)) qWarning() << "Warning: Multiple definition of argument" << longName;
37 if(arg.shortName != 0 && !lnameOfShortArg(arg.shortName).isNull())
38 qWarning().nospace() << "Warning: Redefining shortName '" << arg.shortName << "' for " << longName << " previously defined for " << lnameOfShortArg(arg.shortName);
39 argsHash.insert(longName, arg);
42 bool CliParser::addLongArg(const CliParserArg::CliArgType type, const QString &name, const QString &value) {
43 if(argsHash.contains(name)){
44 if(type == CliParserArg::CliArgOption && argsHash.value(name).type == type) {
45 argsHash[name].value = value;
48 else if (type == CliParserArg::CliArgSwitch && argsHash.value(name).type == type) {
49 argsHash[name].boolValue = true;
56 bool CliParser::addShortArg(const CliParserArg::CliArgType type, const char shortName, const QString &value) {
57 QString longName = lnameOfShortArg(shortName);
58 if(!longName.isNull()) {
59 if(type == CliParserArg::CliArgOption && argsHash.value(longName).type == type) {
60 argsHash[longName].value = value;
63 else if (type == CliParserArg::CliArgSwitch) {
64 if(argsHash.value(longName).type == type) {
65 argsHash[longName].boolValue = true;
68 // arg is an option but detected as a switch -> argument is missing
70 qWarning().nospace() << "Warning: '" << shortName << "' is an option which needs an argument";
78 bool CliParser::parse() {
79 QStringList::const_iterator currentArg;
80 for (currentArg = argsRaw.constBegin(); currentArg != argsRaw.constEnd(); ++currentArg) {
81 if(currentArg->startsWith("--")) {
84 if(currentArg->contains("=")) {
86 QStringList tmp = currentArg->mid(2).split("=");
89 // this is needed to allow --option=""
90 if(tmp.at(1).isNull()) value = QString("");
91 else value = tmp.at(1);
92 if(!addLongArg(CliParserArg::CliArgOption, name, value)) return false;
96 name = currentArg->mid(2);
97 if(!addLongArg(CliParserArg::CliArgSwitch, name)) return false;
100 else if(currentArg->startsWith("-")) {
103 QStringList::const_iterator nextArg = currentArg+1;
104 // if next arg is a short/long option/switch the current arg is one too
105 if(nextArg == argsRaw.constEnd() || nextArg->startsWith("-")) {
107 for (int i = 0; i < currentArg->mid(1).toAscii().size(); i++) {
108 name = currentArg->mid(1).toAscii().at(i);
109 if(!addShortArg(CliParserArg::CliArgSwitch, name)) return false;
112 // if next arg is is no option/switch it's an argument to a shortoption
115 // short options are not freely mixable with other shortargs
116 if(currentArg->mid(1).toAscii().size() > 1) {
117 qWarning() << "Warning: Shortoptions may not be combined with other shortoptions or switches";
121 bool skipNext = false;
122 if(nextArg != argsRaw.constEnd()) {
123 value = nextArg->toLocal8Bit();
126 else value = currentArg->toLocal8Bit();
127 name = currentArg->mid(1).toAscii().at(0);
128 // we took one argument as argument to an option so skip it next time
129 if(skipNext) currentArg++;
130 if(!addShortArg(CliParserArg::CliArgOption, name, value)) return false;
134 // we don't support plain arguments without -/--
135 if(currentArg->toLatin1() != argsRaw.at(0)) return false;
141 void CliParser::usage() {
142 qWarning() << "Usage:" << QFileInfo(argsRaw.at(0)).completeBaseName() << "[arguments]";
144 // get size of longName field
145 QStringList keys = argsHash.keys();
146 uint lnameFieldSize = 0;
147 foreach (QString key, keys) {
149 if(argsHash.value(key).type == CliParserArg::CliArgOption)
150 size += key.size()*2;
153 // this is for " --...=[....] "
155 if(size > lnameFieldSize) lnameFieldSize = size;
158 QHash<QString, CliParserArg>::const_iterator arg;
159 for(arg = argsHash.constBegin(); arg != argsHash.constEnd(); ++arg) {
163 if(arg.value().shortName) {
164 output.append(" -").append(arg.value().shortName).append(",");
166 else output.append(" ");
167 lnameField.append(" --").append(arg.key());
168 if(arg.value().type == CliParserArg::CliArgOption) {
169 lnameField.append("=[").append(arg.key().toUpper()).append("]");
171 output.append(lnameField.leftJustified(lnameFieldSize));
172 if(!arg.value().help.isEmpty()) {
173 output.append(arg.value().help);
175 if(arg.value().type == CliParserArg::CliArgOption && !arg.value().def.isNull()) {
176 output.append(". Default is: ").append(arg.value().def);
178 qWarning(output.toLatin1());
182 QString CliParser::value(const QString &longName) {
183 if(argsHash.contains(longName) && argsHash.value(longName).type == CliParserArg::CliArgOption) {
184 if(!argsHash.value(longName).value.isNull())
185 return argsHash.value(longName).value;
187 return argsHash.value(longName).def;
190 qWarning() << "Warning: Requested value of not defined argument" << longName << "or argument is a switch";
195 bool CliParser::isSet(const QString &longName) {
196 if(argsHash.contains(longName)) {
197 if(argsHash.value(longName).type == CliParserArg::CliArgOption) return !argsHash.value(longName).value.isNull();
198 else return argsHash.value(longName).boolValue;
201 qWarning() << "Warning: Requested isSet of not defined argument" << longName;
206 QString CliParser::lnameOfShortArg(const char arg) {
207 QHash<QString, CliParserArg>::const_iterator cur;
208 for (cur = argsHash.constBegin(); cur != argsHash.constEnd(); ++cur) {
209 if(cur.value().shortName == arg) return cur.key();