Fixes #3160: command line options support added to standalone simulator (radio type and eeprom file) (ported from master)

2015-12-18 22:44:17 +01:00
parent cf4fa51019
commit 0db5072bed
12 changed files with 2539 additions and 192 deletions
@@ -0,0 +1,124 @@
+/****************************************************************************
+ **
+ ** 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 <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)
+
+
+class QXT_CORE_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