tools/xmlpatterns/qapplicationargumentparser_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the tools applications of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52 #ifndef QApplicationArgumentParser_H
  53 #define QApplicationArgumentParser_H
  54
  55 #include <QtCore/QVariant> /* Needed, because we can't forward declare QVariantList. */
  56
  57 QT_BEGIN_HEADER
  58 QT_BEGIN_NAMESPACE
  59
  60 class QApplicationArgument;
  61 class QApplicationArgumentParserPrivate;
  62 class QStringList;
  63 template<typename A, typename B> struct QPair;
  64 template<typename T> class QList;
  65 template<typename Value> class QList;
  66
  67 class QApplicationArgumentParser
  68 {
  69 public:
  70     enum ExitCode
  71     {
  72         Success = 0,
  73         ParseError = 1
  74     };
  75
  76     QApplicationArgumentParser(int argc, char **argv);
  77     QApplicationArgumentParser(const QStringList &input);
  78     virtual ~QApplicationArgumentParser();
  79     void addArgument(const QApplicationArgument &argument);
  80     void setDeclaredArguments(const QList<QApplicationArgument> &arguments);
  81     QList<QApplicationArgument> declaredArguments() const;
  82
  83     int count(const QApplicationArgument &argument) const;
  84     bool has(const QApplicationArgument &argument) const;
  85
  86     virtual bool parse();
  87     ExitCode exitCode() const;
  88     QVariant value(const QApplicationArgument &argument) const;
  89     QVariantList values(const QApplicationArgument &argument) const;
  90     void setApplicationDescription(const QString &description);
  91     void setApplicationVersion(const QString &version);
  92     virtual void message(const QString &message) const;
  93
  94 protected:
  95     void setExitCode(ExitCode code);
  96     void setUsedArguments(const QList<QPair<QApplicationArgument, QVariant> > &arguments);
  97     QList<QPair<QApplicationArgument, QVariant> > usedArguments() const;
  98     QStringList input() const;
  99     virtual QVariant convertToValue(const QApplicationArgument &argument,
 100                                     const QString &value) const;
 101     virtual QString typeToName(const QApplicationArgument &argument) const;
 102     virtual QVariant defaultValue(const QApplicationArgument &argument) const;
 103
 104 private:
 105     friend class QApplicationArgumentParserPrivate;
 106     QApplicationArgumentParserPrivate *d;
 107     Q_DISABLE_COPY(QApplicationArgumentParser)
 108 };
 109
 110 QT_END_NAMESPACE
 111 QT_END_HEADER
 112 #endif