blob: b100bc770c93c77c7086e553e810ecfd97236184 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
#ifndef QApplicationArgumentParser_H
#define QApplicationArgumentParser_H
#include <QtCore/QVariant> /* Needed, because we can't forward declare QVariantList. */
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
class QApplicationArgument;
class QApplicationArgumentParserPrivate;
class QStringList;
template<typename A, typename B> struct QPair;
template<typename T> class QList;
template<typename Value> class QList;
class QApplicationArgumentParser
{
public:
enum ExitCode
{
Success = 0,
ParseError = 1
};
QApplicationArgumentParser(int argc, char **argv);
QApplicationArgumentParser(const QStringList &input);
virtual ~QApplicationArgumentParser();
void addArgument(const QApplicationArgument &argument);
void setDeclaredArguments(const QList<QApplicationArgument> &arguments);
QList<QApplicationArgument> declaredArguments() const;
int count(const QApplicationArgument &argument) const;
bool has(const QApplicationArgument &argument) const;
virtual bool parse();
ExitCode exitCode() const;
QVariant value(const QApplicationArgument &argument) const;
QVariantList values(const QApplicationArgument &argument) const;
void setApplicationDescription(const QString &description);
void setApplicationVersion(const QString &version);
virtual void message(const QString &message) const;
protected:
void setExitCode(ExitCode code);
void setUsedArguments(const QList<QPair<QApplicationArgument, QVariant> > &arguments);
QList<QPair<QApplicationArgument, QVariant> > usedArguments() const;
QStringList input() const;
virtual QVariant convertToValue(const QApplicationArgument &argument,
const QString &value) const;
virtual QString typeToName(const QApplicationArgument &argument) const;
virtual QVariant defaultValue(const QApplicationArgument &argument) const;
private:
friend class QApplicationArgumentParserPrivate;
QApplicationArgumentParserPrivate *d;
Q_DISABLE_COPY(QApplicationArgumentParser)
};
QT_END_NAMESPACE
QT_END_HEADER
#endif