command line

server/mainclass.cpp

@@ -2,7 +2,7 @@
 #include <QStringList>
 #include <iostream>
 #include <sysexits.h>
-#include <QCommandLineParser>
+#include "qcommandlineparser.h"
 #include "mainclass.h"
 #include "gpiomanager.h"
 #include "randommanager.h"
@@ -10,6 +10,9 @@
 MainClass::MainClass(QObject *parent)
     : QObject(parent)
     , m_input(nullptr)
+    , m_device(Gpio)
+    , m_address(QHostAddress::Any)
+    , m_port(39415)
 {
 }
 
@@ -43,10 +46,6 @@ void MainClass::main()
 
 void MainClass::getOpts()
 {
-    m_device = Gpio;
-    m_address = QHostAddress::Any;
-    m_port = 39415;
-
     QCommandLineParser parser;
     parser.setApplicationDescription("Server for GPIO monitoring");
     parser.addHelpOption();

server/qcommandlineoption.cpp

@@ -0,0 +1,365 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** Copyright (C) 2013 David Faure <faure@kde.org>
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtCore module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL21$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** As a special exception, The Qt Company gives you certain additional
+** rights. These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qcommandlineoption.h"
+
+#include "qset.h"
+
+QT_BEGIN_NAMESPACE
+
+class QCommandLineOptionPrivate : public QSharedData
+{
+public:
+    inline QCommandLineOptionPrivate()
+    { }
+
+    void setNames(const QStringList &nameList);
+
+    //! The list of names used for this option.
+    QStringList names;
+
+    //! The documentation name for the value, if one is expected
+    //! Example: "-o <file>" means valueName == "file"
+    QString valueName;
+
+    //! The description used for this option.
+    QString description;
+
+    //! The list of default values used for this option.
+    QStringList defaultValues;
+};
+
+/*!
+    \since 5.2
+    \class QCommandLineOption
+    \brief The QCommandLineOption class defines a possible command-line option.
+    \inmodule QtCore
+    \ingroup shared
+    \ingroup tools
+
+    This class is used to describe an option on the command line. It allows
+    different ways of defining the same option with multiple aliases possible.
+    It is also used to describe how the option is used - it may be a flag (e.g. \c{-v})
+    or take a value (e.g. \c{-o file}).
+
+    Examples:
+    \snippet code/src_corelib_tools_qcommandlineoption.cpp 0
+
+    \sa QCommandLineParser
+*/
+
+/*!
+    \fn QCommandLineOption &QCommandLineOption::operator=(QCommandLineOption &&other)
+
+    Move-assigns \a other to this QCommandLineOption instance.
+
+    \since 5.2
+*/
+
+/*!
+    Constructs a command line option object with the name \a name.
+
+    The name can be either short or long. If the name is one character in
+    length, it is considered a short name. Option names must not be empty,
+    must not start with a dash or a slash character, must not contain a \c{=}
+    and cannot be repeated.
+
+    \sa setDescription(), setValueName(), setDefaultValues()
+*/
+QCommandLineOption::QCommandLineOption(const QString &name)
+    : d(new QCommandLineOptionPrivate)
+{
+    d->setNames(QStringList(name));
+}
+
+/*!
+    Constructs a command line option object with the names \a names.
+
+    This overload allows to set multiple names for the option, for instance
+    \c{o} and \c{output}.
+
+    The names can be either short or long. Any name in the list that is one
+    character in length is a short name. Option names must not be empty,
+    must not start with a dash or a slash character, must not contain a \c{=}
+    and cannot be repeated.
+
+    \sa setDescription(), setValueName(), setDefaultValues()
+*/
+QCommandLineOption::QCommandLineOption(const QStringList &names)
+    : d(new QCommandLineOptionPrivate)
+{
+    d->setNames(names);
+}
+
+/*!
+    Constructs a command line option object with the given arguments.
+
+    The name of the option is set to \a name.
+    The name can be either short or long. If the name is one character in
+    length, it is considered a short name. Option names must not be empty,
+    must not start with a dash or a slash character, must not contain a \c{=}
+    and cannot be repeated.
+
+    The description is set to \a description. It is customary to add a "."
+    at the end of the description.
+
+    In addition, the \a valueName can be set if the option expects a value.
+    The default value for the option is set to \a defaultValue.
+
+    In Qt versions before 5.4, this constructor was \c explicit. In Qt 5.4
+    and later, it no longer is and can be used for C++11-style uniform
+    initialization:
+
+    \snippet code/src_corelib_tools_qcommandlineoption.cpp cxx11-init
+
+    \sa setDescription(), setValueName(), setDefaultValues()
+*/
+QCommandLineOption::QCommandLineOption(const QString &name, const QString &description,
+                                       const QString &valueName,
+                                       const QString &defaultValue)
+    : d(new QCommandLineOptionPrivate)
+{
+    d->setNames(QStringList(name));
+    setValueName(valueName);
+    setDescription(description);
+    setDefaultValue(defaultValue);
+}
+
+/*!
+    Constructs a command line option object with the given arguments.
+
+    This overload allows to set multiple names for the option, for instance
+    \c{o} and \c{output}.
+
+    The names of the option are set to \a names.
+    The names can be either short or long. Any name in the list that is one
+    character in length is a short name. Option names must not be empty,
+    must not start with a dash or a slash character, must not contain a \c{=}
+    and cannot be repeated.
+
+    The description is set to \a description. It is customary to add a "."
+    at the end of the description.
+
+    In addition, the \a valueName can be set if the option expects a value.
+    The default value for the option is set to \a defaultValue.
+
+    In Qt versions before 5.4, this constructor was \c explicit. In Qt 5.4
+    and later, it no longer is and can be used for C++11-style uniform
+    initialization:
+
+    \snippet code/src_corelib_tools_qcommandlineoption.cpp cxx11-init-list
+
+    \sa setDescription(), setValueName(), setDefaultValues()
+*/
+QCommandLineOption::QCommandLineOption(const QStringList &names, const QString &description,
+                                       const QString &valueName,
+                                       const QString &defaultValue)
+    : d(new QCommandLineOptionPrivate)
+{
+    d->setNames(names);
+    setValueName(valueName);
+    setDescription(description);
+    setDefaultValue(defaultValue);
+}
+
+/*!
+    Constructs a QCommandLineOption object that is a copy of the QCommandLineOption
+    object \a other.
+
+    \sa operator=()
+*/
+QCommandLineOption::QCommandLineOption(const QCommandLineOption &other)
+    : d(other.d)
+{
+}
+
+/*!
+    Destroys the command line option object.
+*/
+QCommandLineOption::~QCommandLineOption()
+{
+}
+
+/*!
+    Makes a copy of the \a other object and assigns it to this QCommandLineOption
+    object.
+*/
+QCommandLineOption &QCommandLineOption::operator=(const QCommandLineOption &other)
+{
+    d = other.d;
+    return *this;
+}
+
+/*!
+    \fn void QCommandLineOption::swap(QCommandLineOption &other)
+
+    Swaps option \a other with this option. This operation is very
+    fast and never fails.
+*/
+
+/*!
+    Returns the names set for this option.
+ */
+QStringList QCommandLineOption::names() const
+{
+    return d->names;
+}
+
+void QCommandLineOptionPrivate::setNames(const QStringList &nameList)
+{
+    QStringList newNames;
+    newNames.reserve(nameList.size());
+    if (nameList.isEmpty())
+        qWarning("QCommandLineOption: Options must have at least one name");
+    foreach (const QString &name, nameList) {
+        if (name.isEmpty()) {
+            qWarning("QCommandLineOption: Option names cannot be empty");
+        } else {
+            const QChar c = name.at(0);
+            if (c == QLatin1Char('-'))
+                qWarning("QCommandLineOption: Option names cannot start with a '-'");
+            else if (c == QLatin1Char('/'))
+                qWarning("QCommandLineOption: Option names cannot start with a '/'");
+            else if (name.contains(QLatin1Char('=')))
+                qWarning("QCommandLineOption: Option names cannot contain a '='");
+            else
+                newNames.append(name);
+        }
+    }
+    // commit
+    names.swap(newNames);
+}
+
+/*!
+    Sets the name of the expected value, for the documentation, to \a valueName.
+
+    Options without a value assigned have a boolean-like behavior:
+    either the user specifies --option or they don't.
+
+    Options with a value assigned need to set a name for the expected value,
+    for the documentation of the option in the help output. An option with names \c{o} and \c{output},
+    and a value name of \c{file} will appear as \c{-o, --output <file>}.
+
+    Call QCommandLineParser::value() if you expect the option to be present
+    only once, and QCommandLineParser::values() if you expect that option
+    to be present multiple times.
+
+    \sa valueName()
+ */
+void QCommandLineOption::setValueName(const QString &valueName)
+{
+    d->valueName = valueName;
+}
+
+/*!
+    Returns the name of the expected value.
+
+    If empty, the option doesn't take a value.
+
+    \sa setValueName()
+ */
+QString QCommandLineOption::valueName() const
+{
+    return d->valueName;
+}
+
+/*!
+    Sets the description used for this option to \a description.
+
+    It is customary to add a "." at the end of the description.
+
+    The description is used by QCommandLineParser::showHelp().
+
+    \sa description()
+ */
+void QCommandLineOption::setDescription(const QString &description)
+{
+    d->description = description;
+}
+
+/*!
+    Returns the description set for this option.
+
+    \sa setDescription()
+ */
+QString QCommandLineOption::description() const
+{
+    return d->description;
+}
+
+/*!
+    Sets the default value used for this option to \a defaultValue.
+
+    The default value is used if the user of the application does not specify
+    the option on the command line.
+
+    If \a defaultValue is empty, the option has no default values.
+
+    \sa defaultValues() setDefaultValues()
+ */
+void QCommandLineOption::setDefaultValue(const QString &defaultValue)
+{
+    QStringList newDefaultValues;
+    if (!defaultValue.isEmpty()) {
+        newDefaultValues.reserve(1);
+        newDefaultValues << defaultValue;
+    }
+    // commit:
+    d->defaultValues.swap(newDefaultValues);
+}
+
+/*!
+    Sets the list of default values used for this option to \a defaultValues.
+
+    The default values are used if the user of the application does not specify
+    the option on the command line.
+
+    \sa defaultValues() setDefaultValue()
+ */
+void QCommandLineOption::setDefaultValues(const QStringList &defaultValues)
+{
+    d->defaultValues = defaultValues;
+}
+
+/*!
+    Returns the default values set for this option.
+
+    \sa setDefaultValues()
+ */
+QStringList QCommandLineOption::defaultValues() const
+{
+    return d->defaultValues;
+}
+
+QT_END_NAMESPACE

server/qcommandlineoption.h

@@ -0,0 +1,83 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtCore module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL21$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** As a special exception, The Qt Company gives you certain additional
+** rights. These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QCOMMANDLINEOPTION_H
+#define QCOMMANDLINEOPTION_H
+
+#include <QtCore/qstringlist.h>
+#include <QtCore/qshareddata.h>
+
+class QCommandLineOptionPrivate;
+
+class Q_CORE_EXPORT QCommandLineOption
+{
+public:
+    explicit QCommandLineOption(const QString &name);
+    explicit QCommandLineOption(const QStringList &names);
+    /*implicit*/ QCommandLineOption(const QString &name, const QString &description,
+                                const QString &valueName = QString(),
+                                const QString &defaultValue = QString());
+    /*implicit*/ QCommandLineOption(const QStringList &names, const QString &description,
+                                const QString &valueName = QString(),
+                                const QString &defaultValue = QString());
+    QCommandLineOption(const QCommandLineOption &other);
+
+    ~QCommandLineOption();
+
+    QCommandLineOption &operator=(const QCommandLineOption &other);
+#ifdef Q_COMPILER_RVALUE_REFS
+    inline QCommandLineOption &operator=(QCommandLineOption &&other)
+    { qSwap(d, other.d); return *this; }
+#endif
+
+    inline void swap(QCommandLineOption &other)
+    { qSwap(d, other.d); }
+
+    QStringList names() const;
+
+    void setValueName(const QString &name);
+    QString valueName() const;
+
+    void setDescription(const QString &description);
+    QString description() const;
+
+    void setDefaultValue(const QString &defaultValue);
+    void setDefaultValues(const QStringList &defaultValues);
+    QStringList defaultValues() const;
+
+private:
+    QSharedDataPointer<QCommandLineOptionPrivate> d;
+};
+
+
+#endif // QCOMMANDLINEOPTION_H

server/qcommandlineparser.h

@@ -0,0 +1,96 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtCore module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL21$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** As a special exception, The Qt Company gives you certain additional
+** rights. These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QCOMMANDLINEPARSER_H
+#define QCOMMANDLINEPARSER_H
+
+#include <QtCore/qstringlist.h>
+
+#include <QtCore/qcoreapplication.h>
+#include "qcommandlineoption.h"
+
+class QCommandLineParserPrivate;
+class QCoreApplication;
+
+class Q_CORE_EXPORT QCommandLineParser
+{
+    Q_DECLARE_TR_FUNCTIONS(QCommandLineParser)
+public:
+    QCommandLineParser();
+    ~QCommandLineParser();
+
+    enum SingleDashWordOptionMode {
+        ParseAsCompactedShortOptions,
+        ParseAsLongOptions
+    };
+    void setSingleDashWordOptionMode(SingleDashWordOptionMode parsingMode);
+
+    bool addOption(const QCommandLineOption &commandLineOption);
+    bool addOptions(const QList<QCommandLineOption> &options);
+
+    QCommandLineOption addVersionOption();
+    QCommandLineOption addHelpOption();
+    void setApplicationDescription(const QString &description);
+    QString applicationDescription() const;
+    void addPositionalArgument(const QString &name, const QString &description, const QString &syntax = QString());
+    void clearPositionalArguments();
+
+    void process(const QStringList &arguments);
+    void process(const QCoreApplication &app);
+
+    bool parse(const QStringList &arguments);
+    QString errorText() const;
+
+    bool isSet(const QString &name) const;
+    QString value(const QString &name) const;
+    QStringList values(const QString &name) const;
+
+    bool isSet(const QCommandLineOption &option) const;
+    QString value(const QCommandLineOption &option) const;
+    QStringList values(const QCommandLineOption &option) const;
+
+    QStringList positionalArguments() const;
+    QStringList optionNames() const;
+    QStringList unknownOptionNames() const;
+
+    void showVersion();
+    void showHelp(int exitCode = 0);
+    QString helpText() const;
+
+private:
+    Q_DISABLE_COPY(QCommandLineParser)
+
+    QCommandLineParserPrivate * const d;
+};
+
+#endif // QCOMMANDLINEPARSER_H

server/server.pro

@@ -24,7 +24,9 @@ SOURCES += main.cpp \
     gpiomanager.cpp \
     servermanager.cpp \
     inputbusiness.cpp \
-    randommanager.cpp
+    randommanager.cpp \
+    qcommandlineoption.cpp \
+    qcommandlineparser.cpp
 
 HEADERS += \
     mainclass.h \
@@ -32,4 +34,6 @@ HEADERS += \
     gpiomanager.h \
     servermanager.h \
     inputbusiness.h \
-    randommanager.h
+    randommanager.h \
+    qcommandlineoption.h \
+    qcommandlineparser.h