runnersyntax.cpp

/*
    SPDX-FileCopyrightText: 2009 Aaron Seigo <[email protected]>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#include "runnersyntax.h"
 
#include <KLocalizedString>
 
namespace Plasma
{
class RunnerSyntaxPrivate
{
public:
    RunnerSyntaxPrivate(const QStringList &_exampleQueries, const QString &_description)
        : description(_description)
    {
        for (const QString &query : _exampleQueries) {
            addExampleQuery(query);
        }
    }
 
    void addExampleQuery(const QString &s)
    {
        Q_ASSERT_X(!s.isEmpty(), "KRunner::RunnerSyntax", "Example queries must not be empty!");
        const QString termDesc(QLatin1Char('<') + termDescription + QLatin1Char('>'));
        exampleQueries.append(QString(s).replace(QStringLiteral(":q:"), termDesc));
    }
 
    QStringList exampleQueries;
    QString description;
    QString termDescription = i18n("search term");
};
 
RunnerSyntax::RunnerSyntax(const QString &exampleQuery, const QString &description)
    : d(new RunnerSyntaxPrivate({exampleQuery}, description))
{
}
 
RunnerSyntax::RunnerSyntax(const QStringList &exampleQueries, const QString &description)
    : d(new RunnerSyntaxPrivate(exampleQueries, description))
{
    Q_ASSERT_X(!exampleQueries.isEmpty(), "KRunner::RunnerSyntax", "Example queries must not be empty");
}
 
RunnerSyntax::RunnerSyntax(const RunnerSyntax &other)
    : d(new RunnerSyntaxPrivate(*other.d))
{
}
 
RunnerSyntax::~RunnerSyntax() = default;
 
RunnerSyntax &RunnerSyntax::operator=(const RunnerSyntax &rhs)
{
    *d = *rhs.d;
    return *this;
}
 
#if KRUNNER_BUILD_DEPRECATED_SINCE(5, 106)
void RunnerSyntax::addExampleQuery(const QString &exampleQuery)
{
    d->addExampleQuery(exampleQuery);
}
#endif
 
QStringList RunnerSyntax::exampleQueries() const
{
    return d->exampleQueries;
}
 
#if KRUNNER_BUILD_DEPRECATED_SINCE(5, 76)
QStringList RunnerSyntax::exampleQueriesWithTermDescription() const
{
    QStringList queries;
    const QString termDesc(QLatin1Char('<') + searchTermDescription() + QLatin1Char('>'));
    for (QString query : std::as_const(d->exampleQueries)) {
        queries << query.replace(QStringLiteral(":q:"), termDesc);
    }
 
    return queries;
}
#endif
 
#if KRUNNER_BUILD_DEPRECATED_SINCE(5, 106)
void RunnerSyntax::setDescription(const QString &description)
{
    d->description = description;
}
#endif
 
QString RunnerSyntax::description() const
{
#if KRUNNER_BUILD_DEPRECATED_SINCE(5, 76)
    QString description = d->description;
    description.replace(QLatin1String(":q:"), QLatin1Char('<') + searchTermDescription() + QLatin1Char('>'));
    return description;
#else
    return d->description;
#endif
}
 
#if KRUNNER_BUILD_DEPRECATED_SINCE(5, 76)
void RunnerSyntax::setSearchTermDescription(const QString &description)
{
    d->termDescription = description;
}
#endif
 
#if KRUNNER_BUILD_DEPRECATED_SINCE(5, 76)
QString RunnerSyntax::searchTermDescription() const
{
    return d->termDescription;
}
#endif
 
} // Plasma namespace