1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the tools applications of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    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