summaryrefslogtreecommitdiffstats
path: root/Common/QOptions.h
blob: 7e02867e4f3f0609fdbf7ae861b05d0c56dd167c (plain)
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
/******************************************************************************
    QOptions: make command line options easy. https://github.com/wang-bin/qoptions
    Copyright (C) 2011-2015 Wang Bin <wbsecg1@gmail.com>
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
******************************************************************************/

#ifndef QOPTIONS_H
#define QOPTIONS_H

#include <QtCore/QVariant>
#include <QtCore/QMap>
#include <QtCore/QList>

#if defined(BUILD_QOPT_LIB)
#  define QOPT_EXPORT Q_DECL_EXPORT
#elif defined(BUILD_QOPT_IMPORT)
#  define QOPT_EXPORT Q_DECL_IMPORT //only for vc?
#else
#  define QOPT_EXPORT
#endif


class QOPT_EXPORT QOption {
public:
    // TODO: MultiToken -name value1 -name value2 ...
	enum Type {
		NoToken, SingleToken, MultiToken
	};
    QOption();
	explicit QOption(const char* name, const QVariant& defaultValue, Type type, const QString& description);
	explicit QOption(const char* name, Type type, const QString& description);
    //explicit QOption(const char* name, const QVariant& value, Type type, const QString& description);

	QString shortName() const;
	QString longName() const;
	QString formatName() const;
	QString description() const;
	QVariant value() const;
	void setValue(const QVariant& value);
    bool isSet() const;
    bool isValid() const;

	void setType(QOption::Type type);
	QOption::Type type() const;

    QString help() const;
    void print() const;
    bool operator <(const QOption& o) const;
private:
    /*!
     * \brief setName
     * short/long name format:
     * "--long", "-short", "short"
     * "long,short", "--long,short", "--long,-short", "long,-short"
     * "short,--long", "-short,long", "-short,--long"
     * \param name
     */
	void setName(const QString& name);

	QOption::Type mType;
	QString mShortName, mLongName, mDescription;
	QVariant mDefaultValue;
    QVariant mValue;
};


class QOPT_EXPORT QOptions {
public:
	//e.g. application information, copyright etc.
	QOptions();
    //QOptions(const QOptions& o);
	~QOptions();
    //QOptions& operator=(const QOptions& o);

    /*!
     * \brief parse
     * \param argc
     * \param argv
     * \return false if invalid option found
     */
	bool parse(int argc, const char*const* argv);
	QOptions& add(const QString& group_description);
	QOptions& addDescription(const QString& description);

    QOptions& operator ()(const char* name, const QString& description = QString());
    QOptions& operator ()(const char* name, QOption::Type type, const QString& description = QString());
    QOptions& operator ()(const char* name, const QVariant& defaultValue, const QString& description);
    QOptions& operator ()(const char* name, const QVariant& defaultValue, QOption::Type type, const QString& description = QString());
    //QOptions& operator ()(const char* name, QVariant* value, QOption::Type type, const QString& description = QString());

    QOption option(const QString& name) const;
    QVariant value(const QString& name) const;
    QVariant operator [](const QString& name) const;

    QString help() const;
    void print() const;
private:
	QString mDescription, mCurrentDescription;
    QList<QOption> mOptions;
    QMap<QOption, QString/*group*/> mOptionGroupMap;
};

#endif // QOPTIONS_H