src/common/cliparser.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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
  21 #ifndef CLIPARSER_H
  22 #define CLIPARSER_H
  23
  24 #include <QString>
  25 #include <QStringList>
  26 #include <QHash>
  27
  28 class CliParser{
  29 public:
  30   inline CliParser() {};
  31
  32   bool parse(const QStringList &arguments);
  33   QString value(const QString &longName);
  34   bool isSet(const QString &longName);
  35   inline void addSwitch(const QString &longName, const char shortName = 0, const QString &help = QString()) {
  36     addArgument(longName, CliParserArg(CliParserArg::CliArgSwitch, shortName, help));
  37   }
  38   inline void addOption(const QString &longName, const char shortName = 0, const QString &help = QString(), const QString &def = QString()) {
  39     addArgument(longName, CliParserArg(CliParserArg::CliArgOption, shortName, help, def));
  40   }
  41   void usage();
  42
  43 private:
  44   struct CliParserArg {
  45     enum CliArgType {
  46       CliArgInvalid,
  47       CliArgSwitch,
  48       CliArgOption
  49     };
  50     CliParserArg(const CliArgType _type = CliArgInvalid, const char _shortName = 0, const QString _help = QString(), const QString _def = QString())
  51     : type(_type),
  52     shortName(_shortName),
  53     help(_help),
  54     def(_def),
  55     value(QString()),
  56     boolValue(false) {};
  57
  58     CliArgType type;
  59     char shortName;
  60     QString help;
  61     QString def;
  62     QString value;
  63     bool boolValue;
  64   };
  65
  66   void addArgument(const QString &longName, const CliParserArg &arg);
  67   bool addLongArg(const CliParserArg::CliArgType type, const QString &name, const QString &value = QString());
  68   bool addShortArg(const CliParserArg::CliArgType type, const char shortName, const QString &value = QString());
  69   QString escapedValue(const QString &value);
  70   QString lnameOfShortArg(const char arg);
  71
  72   QStringList argsRaw;
  73   QHash<QString, CliParserArg> argsHash;
  74 };
  75
  76 #endif