qcommandlineoption.cpp

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
** Copyright (C) 2013 David Faure <faure@kde.org>
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
 
#include "qcommandlineoption.h"
 
#include "qset.h"
 
QT_BEGIN_NAMESPACE
 
class QCommandLineOptionPrivate : public QSharedData
{
public:
    Q_NEVER_INLINE
    explicit QCommandLineOptionPrivate(const QString &name)
        : names(removeInvalidNames(QStringList(name)))
    { }
 
    Q_NEVER_INLINE
    explicit QCommandLineOptionPrivate(const QStringList &names)
        : names(removeInvalidNames(names))
    { }
 
    static QStringList removeInvalidNames(QStringList nameList);
 
    QStringList names;
 
    QString valueName;
 
    QString description;
 
    QStringList defaultValues;
 
    QCommandLineOption::Flags flags;
};
 
QCommandLineOption::QCommandLineOption(const QString &name)
    : d(new QCommandLineOptionPrivate(name))
{
}
 
QCommandLineOption::QCommandLineOption(const QStringList &names)
    : d(new QCommandLineOptionPrivate(names))
{
}
 
QCommandLineOption::QCommandLineOption(const QString &name, const QString &description,
                                       const QString &valueName,
                                       const QString &defaultValue)
    : d(new QCommandLineOptionPrivate(name))
{
    setValueName(valueName);
    setDescription(description);
    setDefaultValue(defaultValue);
}
 
QCommandLineOption::QCommandLineOption(const QStringList &names, const QString &description,
                                       const QString &valueName,
                                       const QString &defaultValue)
    : d(new QCommandLineOptionPrivate(names))
{
    setValueName(valueName);
    setDescription(description);
    setDefaultValue(defaultValue);
}
 
QCommandLineOption::QCommandLineOption(const QCommandLineOption &other)
    : d(other.d)
{
}
 
QCommandLineOption::~QCommandLineOption()
{
}
 
QCommandLineOption &QCommandLineOption::operator=(const QCommandLineOption &other)
{
    d = other.d;
    return *this;
}
 
QStringList QCommandLineOption::names() const
{
    return d->names;
}
 
namespace {
    struct IsInvalidName
    {
        typedef bool result_type;
        typedef QString argument_type;
 
        Q_NEVER_INLINE
        result_type operator()(const QString &name) const noexcept
        {
            if (Q_UNLIKELY(name.isEmpty()))
                return warn("be empty");
 
            const QChar c = name.at(0);
            if (Q_UNLIKELY(c == QLatin1Char('-')))
                return warn("start with a '-'");
            if (Q_UNLIKELY(c == QLatin1Char('/')))
                return warn("start with a '/'");
            if (Q_UNLIKELY(name.contains(QLatin1Char('='))))
                return warn("contain a '='");
 
            return false;
        }
 
        Q_NEVER_INLINE
        static bool warn(const char *what) noexcept
        {
            qWarning("QCommandLineOption: Option names cannot %s", what);
            return true;
        }
    };
} // unnamed namespace
 
// static
QStringList QCommandLineOptionPrivate::removeInvalidNames(QStringList nameList)
{
    if (Q_UNLIKELY(nameList.isEmpty()))
        qWarning("QCommandLineOption: Options must have at least one name");
    else
        nameList.removeIf(IsInvalidName());
    return nameList;
}
 
void QCommandLineOption::setValueName(const QString &valueName)
{
    d->valueName = valueName;
}
 
QString QCommandLineOption::valueName() const
{
    return d->valueName;
}
 
void QCommandLineOption::setDescription(const QString &description)
{
    d->description = description;
}
 
QString QCommandLineOption::description() const
{
    return d->description;
}
 
void QCommandLineOption::setDefaultValue(const QString &defaultValue)
{
    QStringList newDefaultValues;
    if (!defaultValue.isEmpty()) {
        newDefaultValues.reserve(1);
        newDefaultValues << defaultValue;
    }
    // commit:
    d->defaultValues.swap(newDefaultValues);
}
 
void QCommandLineOption::setDefaultValues(const QStringList &defaultValues)
{
    d->defaultValues = defaultValues;
}
 
QStringList QCommandLineOption::defaultValues() const
{
    return d->defaultValues;
}
 
QCommandLineOption::Flags QCommandLineOption::flags() const
{
    return d->flags;
}
 
void QCommandLineOption::setFlags(Flags flags)
{
    d->flags = flags;
}
 
QT_END_NAMESPACE