recoll/src/qtgui/scbase.cpp

/* Copyright (C) 2021 J.F.Dockes
 *
 * License: GPL 2.1
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
#include "scbase.h"

#include <map>
#include <string>

#include <QSettings>
#define LOGGER_LOCAL_LOGINC 2


#include "recoll.h"
#include "smallut.h"
#include "log.h"

struct SCDef {
    QString id;
    QString ctxt;
    QString desc;
    QKeySequence val;
    QKeySequence dflt;
};

class SCBase::Internal {
public:
    QStringList getAll(const std::map<QString, SCDef>&);
    std::map<QString, SCDef> scdefs;
    std::map<QString, SCDef> scvalues;
    QString scBaseSettingsKey() {
        return "/Recoll/prefs/sckeys";
    }
};

SCBase::SCBase()
{
    m = new Internal();

    QSettings settings;
    auto sl = settings.value(m->scBaseSettingsKey()).toStringList();

    for (int i = 0; i < sl.size(); ++i) {
        auto ssc = qs2utf8s(sl.at(i));
        std::vector<std::string> co_des_val;
        stringToStrings(ssc, co_des_val);
        if (co_des_val.size() != 4) {
            LOGERR("Bad shortcut def in prefs: [" << ssc << "]\n");
            continue;
        }
        QString id = u8s2qs(co_des_val[0]);
        QString ctxt = u8s2qs(co_des_val[1]);
        QString desc = u8s2qs(co_des_val[2]);
        QString val = u8s2qs(co_des_val[3]);
        auto it = m->scvalues.find(id);
        if (it == m->scvalues.end()) {
            m->scvalues[id] = SCDef{id, ctxt, desc, QKeySequence(val), QKeySequence()};
        } else {
            it->second.val = QKeySequence(val);
        }
    }
}

SCBase::~SCBase()
{
    delete m;
}

QKeySequence SCBase::get(const QString& id, const QString& ctxt,
                         const QString& desc, const QString& defks)
{
    LOGDEB0("SCBase::get: id "<< qs2utf8s(id) << " ["<<qs2utf8s(ctxt) << "]/[" <<
            qs2utf8s(desc) << "], [" << qs2utf8s(defks) << "]\n");
    m->scdefs[id] = SCDef{id, ctxt, desc, QKeySequence(defks),
                          QKeySequence(defks)};
    auto it = m->scvalues.find(id);
    if (it == m->scvalues.end()) {
        if (defks.isEmpty()) {
            return QKeySequence();
        }
        QKeySequence qks(defks);
        m->scvalues[id] = SCDef{id, ctxt, desc, qks, qks};
        LOGDEB0("get(" << qs2utf8s(ctxt) << ", " << qs2utf8s(desc) <<
            ", " << qs2utf8s(defks) << ") -> " <<
                qs2utf8s(qks.toString()) << "\n");
        return qks;
    }
    LOGDEB0("SCBase::get(" << qs2utf8s(ctxt) << ", " << qs2utf8s(desc) <<
        ", " << qs2utf8s(defks) << ") -> " <<
            qs2utf8s(it->second.val.toString()) << "\n");
    it->second.dflt = QKeySequence(defks);
    return it->second.val;
}

void SCBase::set(const QString& id, const QString& ctxt, const QString& desc,
                 const QString& newks)
{
    LOGDEB0("SCBase::set: id "<< qs2utf8s(id) << "["<< qs2utf8s(ctxt) << "]/[" <<
            qs2utf8s(desc) << "], [" << qs2utf8s(newks) << "]\n");
    auto it = m->scvalues.find(id);
    if (it == m->scvalues.end()) {
        QKeySequence qks(newks);
        m->scvalues[id] = SCDef{id, ctxt, desc, qks, QKeySequence()};
        return;
    }
    it->second.val = newks;
}

QStringList SCBase::Internal::getAll(const std::map<QString, SCDef>& mp)
{
    QStringList result;
    for (const auto& entry : mp) {
        result.push_back(entry.second.id);
        result.push_back(entry.second.ctxt);
        result.push_back(entry.second.desc);
        result.push_back(entry.second.val.toString());
        result.push_back(entry.second.dflt.toString());
    }
    return result;
}

QStringList SCBase::getAll()
{
    return m->getAll(m->scvalues);
}

QStringList SCBase::getAllDefaults()
{
    return m->getAll(m->scdefs);
}

void SCBase::store()
{
    QStringList slout;
    for (const auto& entry : m->scvalues) {
        const SCDef& def = entry.second;
        if (def.val != def.dflt) {
            std::string e = 
                stringsToString(std::vector<std::string>{
                        qs2utf8s(def.id), qs2utf8s(def.ctxt), qs2utf8s(def.desc),
                            qs2utf8s(def.val.toString())});
            LOGDEB0("SCBase::store: storing: [" << e << "]\n");
            slout.append(u8s2qs(e));
        }
    }
    // Note: we emit even if the non-default values are not really
    // changed, just not worth the trouble doing otherwise.
    emit shortcutsChanged();
    QSettings settings;
    settings.setValue(m->scBaseSettingsKey(), slout);
}

static SCBase *theBase;

SCBase& SCBase::scBase()
{
    if (nullptr == theBase) {
        theBase = new SCBase();
    }
    return *theBase;
}