1 /****************************************************************************
2 **
3 ** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtCore module 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 The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QCOMMANDLINEPARSER_H
41 #define QCOMMANDLINEPARSER_H
42 
43 #include <QtCore/qstringlist.h>
44 
45 #include <QtCore/qcoreapplication.h>
46 #include <QtCore/qcommandlineoption.h>
47 
48 QT_REQUIRE_CONFIG(commandlineparser);
49 
50 QT_BEGIN_NAMESPACE
51 
52 class QCommandLineParserPrivate;
53 class QCoreApplication;
54 
55 class Q_CORE_EXPORT QCommandLineParser
56 {
57     Q_DECLARE_TR_FUNCTIONS(QCommandLineParser)
58 public:
59     QCommandLineParser();
60     ~QCommandLineParser();
61 
62     enum SingleDashWordOptionMode {
63         ParseAsCompactedShortOptions,
64         ParseAsLongOptions
65     };
66     void setSingleDashWordOptionMode(SingleDashWordOptionMode parsingMode);
67 
68     enum OptionsAfterPositionalArgumentsMode {
69         ParseAsOptions,
70         ParseAsPositionalArguments
71     };
72     void setOptionsAfterPositionalArgumentsMode(OptionsAfterPositionalArgumentsMode mode);
73 
74     bool addOption(const QCommandLineOption &commandLineOption);
75     bool addOptions(const QList<QCommandLineOption> &options);
76 
77     QCommandLineOption addVersionOption();
78     QCommandLineOption addHelpOption();
79     void setApplicationDescription(const QString &description);
80     QString applicationDescription() const;
81     void addPositionalArgument(const QString &name, const QString &description, const QString &syntax = QString());
82     void clearPositionalArguments();
83 
84     void process(const QStringList &arguments);
85     void process(const QCoreApplication &app);
86 
87     bool parse(const QStringList &arguments);
88     QString errorText() const;
89 
90     bool isSet(const QString &name) const;
91     QString value(const QString &name) const;
92     QStringList values(const QString &name) const;
93 
94     bool isSet(const QCommandLineOption &option) const;
95     QString value(const QCommandLineOption &option) const;
96     QStringList values(const QCommandLineOption &option) const;
97 
98     QStringList positionalArguments() const;
99     QStringList optionNames() const;
100     QStringList unknownOptionNames() const;
101 
102     Q_NORETURN void showVersion();
103     Q_NORETURN void showHelp(int exitCode = 0);
104     QString helpText() const;
105 
106 private:
107     Q_DISABLE_COPY(QCommandLineParser)
108 
109     QCommandLineParserPrivate * const d;
110 };
111 
112 QT_END_NAMESPACE
113 
114 #endif // QCOMMANDLINEPARSER_H
115