qt-everywhere-src-5.15.1/qttools/src/assistant/help/qhelpfiltersettings.cpp

/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Assistant 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 "qhelpfiltersettings_p.h"
#include "qhelpfilterdata.h"

#include <QtCore/QMap>
#include <QtHelp/QHelpFilterEngine>

QT_BEGIN_NAMESPACE

class QHelpFilterSettingsPrivate : public QSharedData
{
public:
    QHelpFilterSettingsPrivate() = default;
    QHelpFilterSettingsPrivate(const QHelpFilterSettingsPrivate &other) = default;
    ~QHelpFilterSettingsPrivate() = default;

    QMap<QString, QHelpFilterData> m_filterToData;
    QString m_currentFilter;
};

QHelpFilterSettings::QHelpFilterSettings()
    : d(new QHelpFilterSettingsPrivate)
{
}

QHelpFilterSettings::QHelpFilterSettings(const QHelpFilterSettings &) = default;

QHelpFilterSettings::QHelpFilterSettings(QHelpFilterSettings &&) = default;

QHelpFilterSettings::~QHelpFilterSettings() = default;

QHelpFilterSettings &QHelpFilterSettings::operator=(const QHelpFilterSettings &) = default;

QHelpFilterSettings &QHelpFilterSettings::operator=(QHelpFilterSettings &&) = default;

void QHelpFilterSettings::setFilter(const QString &filterName,
                                    const QHelpFilterData &filterData)
{
    d->m_filterToData.insert(filterName, filterData);
}

void QHelpFilterSettings::removeFilter(const QString &filterName)
{
    d->m_filterToData.remove(filterName);
}

QStringList QHelpFilterSettings::filterNames() const
{
    return d->m_filterToData.keys();
}

QHelpFilterData QHelpFilterSettings::filterData(const QString &filterName) const
{
    return d->m_filterToData.value(filterName);
}

QMap<QString, QHelpFilterData> QHelpFilterSettings::filters() const
{
    return d->m_filterToData;
}

void QHelpFilterSettings::setCurrentFilter(const QString &filterName)
{
    d->m_currentFilter = filterName;
}

QString QHelpFilterSettings::currentFilter() const
{
    return d->m_currentFilter;
}

QHelpFilterSettings QHelpFilterSettings::readSettings(const QHelpFilterEngine *filterEngine)
{
    QHelpFilterSettings filterSettings;

    const QStringList allFilters = filterEngine->filters();
    for (const QString &filter : allFilters)
        filterSettings.setFilter(filter, filterEngine->filterData(filter));

    filterSettings.setCurrentFilter(filterEngine->activeFilter());

    return filterSettings;
}

static QMap<QString, QHelpFilterData> subtract(const QMap<QString, QHelpFilterData> &minuend,
                                               const QMap<QString, QHelpFilterData> &subtrahend)
{
    QMap<QString, QHelpFilterData> result = minuend;

    for (auto itSubtrahend = subtrahend.cbegin(); itSubtrahend != subtrahend.cend(); ++itSubtrahend) {
        auto itResult = result.find(itSubtrahend.key());
        if (itResult != result.end() && itSubtrahend.value() == itResult.value())
            result.erase(itResult);
    }

    return result;
}

bool QHelpFilterSettings::applySettings(QHelpFilterEngine *filterEngine,
                                        const QHelpFilterSettings &settings)
{
    bool changed = false;
    const QHelpFilterSettings oldSettings = readSettings(filterEngine);

    const QMap<QString, QHelpFilterData> filtersToRemove = subtract(
                oldSettings.filters(),
                settings.filters());
    const QMap<QString, QHelpFilterData> filtersToAdd = subtract(
                settings.filters(),
                oldSettings.filters());

    const QString &currentFilter = filterEngine->activeFilter();

    for (const QString &filter : filtersToRemove.keys()) {
        filterEngine->removeFilter(filter);
        if (currentFilter == filter && !filtersToAdd.contains(filter))
            filterEngine->setActiveFilter(QString());
        changed = true;
    }

    for (auto it = filtersToAdd.cbegin(); it != filtersToAdd.cend(); ++it) {
        filterEngine->setFilterData(it.key(), it.value());
        changed = true;
    }

    if (changed)
        filterEngine->setActiveFilter(settings.currentFilter());

    return changed;
}

QT_END_NAMESPACE