KisRecentFilesManager.cpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2022 Alvin Wong <alvin@alvinhc.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#include "KisRecentFilesManager.h"
 
#include <QApplication>
#include <QDir>
#include <QThread>
#include <QTimer>
#include <QDebug>
 
#include <kconfig.h>
#include <kconfiggroup.h>
#include <ksharedconfig.h>
#include <KisMpl.h>
 
class KisRecentFilesManager::Private
{
public:
    KisRecentFilesManager *m_q;
    int m_maxItems {10};
    QVector<KisRecentFilesEntry> m_entries;
 
private:
    QTimer m_saveOnIdleTimer;
 
public:
    Private(KisRecentFilesManager *q);
 
    bool containsUrl(const QUrl &url) const;
    int indexOfUrl(const QUrl &url) const;
 
    void requestSaveOnNextTick();
}; /* class KisRecentFilesEntry::Private */
 
KisRecentFilesManager::Private::Private(KisRecentFilesManager *q)
    : m_q(q)
    , m_saveOnIdleTimer(q)
{
    m_saveOnIdleTimer.setSingleShot(true);
    m_saveOnIdleTimer.setInterval(0);
    m_q->connect(&m_saveOnIdleTimer, &QTimer::timeout, [this]() {
        m_q->saveEntries(KSharedConfig::openConfig()->group("RecentFiles"));
    });
}
 
bool KisRecentFilesManager::Private::containsUrl(const QUrl &url) const
{
    return indexOfUrl(url) >= 0;
}
 
int KisRecentFilesManager::Private::indexOfUrl(const QUrl &url) const
{
    auto found = std::find_if(m_entries.constBegin(), m_entries.constEnd(),
                              kismpl::mem_equal_to(&KisRecentFilesEntry::m_url, url));
    if (found == m_entries.constEnd()) {
        return -1;
    } else {
        return found - m_entries.constBegin();
    }
}
 
void KisRecentFilesManager::Private::requestSaveOnNextTick()
{
    // If multiple saves are requested within the same tick, they will be
    // consolidated by the timer.
    m_saveOnIdleTimer.start();
}
 
 
KisRecentFilesManager::KisRecentFilesManager()
    : m_d(new Private(this))
{
    loadEntries(KSharedConfig::openConfig()->group("RecentFiles"));
}
 
KisRecentFilesManager::~KisRecentFilesManager()
{
    delete m_d;
}
 
KisRecentFilesManager *KisRecentFilesManager::instance()
{
    if (QThread::currentThread() != qApp->thread()) {
        qWarning() << "KisRecentFilesManager::instance() called from non-GUI thread!";
        return nullptr;
    }
    static KisRecentFilesManager s_instance;
    return &s_instance;
}
 
void KisRecentFilesManager::clear()
{
    m_d->m_entries.clear();
    Q_EMIT listRenewed();
    m_d->requestSaveOnNextTick();
}
 
void KisRecentFilesManager::remove(const QUrl &url)
{
    int removeIndex = m_d->indexOfUrl(url);
    if (removeIndex >= 0) {
        m_d->m_entries.removeAt(removeIndex);
        Q_EMIT fileRemoved(url);
        m_d->requestSaveOnNextTick();
    }
}
 
QVector<KisRecentFilesEntry> KisRecentFilesManager::recentFiles() const
{
    return m_d->m_entries;
}
 
QList<QUrl> KisRecentFilesManager::recentUrlsLatestFirst() const
{
    // switch order so last opened file is first
    QList<QUrl> sortedList;
    for (int i = m_d->m_entries.length() - 1; i >= 0; i--) {
        sortedList.append(m_d->m_entries[i].m_url);
    }
 
    return sortedList;
}
 
// The following file contains code copied and modified from LGPL-2.0-only
// source:
#include "KisRecentFilesManager_p.h"