1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/****************************************************************************
**
** Copyright (C) Qxt Foundation. Some rights reserved.
**
** This file is part of the QxtCore module of the Qxt library.
**
** This library is free software; you can redistribute it and/or modify it
** under the terms of the Common Public License, version 1.0, as published
** by IBM, and/or under the terms of the GNU Lesser General Public License,
** version 2.1, as published by the Free Software Foundation.
**
** This file is provided "AS IS", without WARRANTIES OR CONDITIONS OF ANY
** KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY
** WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR
** FITNESS FOR A PARTICULAR PURPOSE.
**
** You should have received a copy of the CPL and the LGPL along with this
** file. See the LICENSE file and the cpl1.0.txt/lgpl-2.1.txt files
** included with the source distribution for more information.
** If you did not receive a copy of the licenses, contact the Qxt Foundation.
**
** <http://libqxt.org> <foundation@libqxt.org>
**
****************************************************************************/
#ifndef QXTCOMMANDOPTIONS_H
#define QXTCOMMANDOPTIONS_H
#include "actiontools_global.h"
#include "qxtglobal.h"
#include <QStringList>
#include <QVariant>
#include <QCoreApplication> // for Q_DECLARE_TR_FUNCTIONS
#include <QMultiHash>
#include <QFlags>
class QxtCommandOptionsPrivate;
QT_FORWARD_DECLARE_CLASS(QTextStream)
QT_FORWARD_DECLARE_CLASS(QIODevice)
#undef QT_USE_FAST_CONCATENATION
#undef QT_USE_FAST_OPERATOR_PLUS
class ACTIONTOOLSSHARED_EXPORT QxtCommandOptions
{
Q_DECLARE_TR_FUNCTIONS(QxtCommandOptions)
public:
/*!
* \enum QxtCommandOptions::FlagStyle
* This enum type defines which type of option prefix is used.
* Slash is the default on Windows.
* DoubleDash is the default on all other platforms.
*/
enum FlagStyle
{
DoubleDash, /*!< Two dashes (GNU-style) */
SingleDash, /*!< One dash (UNIX-style) */
Slash /*!< Forward slash (Windows-style) */
};
/*!
* \enum QxtCommandOptions::ParamStyle
* This enum type defines what syntax is used for options that
* require parameters. Equals is the default on Windows.
* SpaceAndEquals is the default on all other platforms.
*/
enum ParamStyle
{
Space = 1, /*!< Space ("-option value") */
Equals = 2, /*!< Equals sign ("/option=value") */
SpaceAndEquals = 3 /*!< Accept either */
};
/*!
* \enum QxtCommandOptions::ParamType
* \flags QxtCommandOptions::ParamTypes
* This enum type is used to specify flags that control the
* interpretation of an option.
*
* The ParamTypes type is a typedef for QFlags<ParamType>. It stores
* an OR combination of ParamType values.
*/
enum ParamType
{
NoValue = 0, /*!< The option does not accept a value. */
ValueOptional = 1, /*!< The option may accept a value. */
ValueRequired = 2, /*!< The option requires a value. */
Optional = ValueOptional, /*!< The option may accept a value. Deprecated in favor of ValueOptional. */
Required = ValueRequired, /*!< The option requires a value. Deprecated in favor of ValueRequired. */
AllowMultiple = 4, /*!< The option may be passed multiple times. */
Undocumented = 8 /*!< The option is not output in the help text. */
};
Q_DECLARE_FLAGS(ParamTypes, ParamType)
QxtCommandOptions();
void setFlagStyle(FlagStyle style);
FlagStyle flagStyle() const;
void setParamStyle(ParamStyle style);
ParamStyle paramStyle() const;
void setScreenWidth(quint16 width);
quint16 screenWidth() const;
void addSection(const QString& name);
void add(const QString& name, const QString& desc = QString(), ParamTypes paramType = NoValue, int group = -1);
void alias(const QString& from, const QString& to);
QStringList positional() const;
QStringList unrecognized() const;
int count(const QString& name) const;
QVariant value(const QString& name) const;
QMultiHash<QString, QVariant> parameters() const;
void parse(int argc, char** argv);
void parse(QStringList params);
void showUsage(bool showQtOptions = false, QIODevice* device = 0) const;
void showUsage(bool showQtOptions, QTextStream& stream) const;
QString getUsage(bool showQtOptions = false) const;
bool showUnrecognizedWarning(QIODevice* device = 0) const;
bool showUnrecognizedWarning(QTextStream& stream) const;
QString getUnrecognizedWarning() const;
private:
QXT_DECLARE_PRIVATE(QxtCommandOptions)
};
Q_DECLARE_OPERATORS_FOR_FLAGS(QxtCommandOptions::ParamTypes)
#endif // QXTCOMMANDOPTIONS_H
|
