Differential D28744 Diff 80398 kcms/keys/shortcutsmodel.cpp

Changeset View

Standalone View

View Options

kcms/keys/shortcutsmodel.cpp

  • This file was added.
1​/*
2​ * Copyright (C) 2020 David Redondo <david@david-redondo.de>
3​ *
4​ * This program is free software; you can redistribute it and/or modify
5​ * it under the terms of the GNU General Public License as published by
6​ * the Free Software Foundation; either version 2 of the License, or
7​ * (at your option) any later version.
8​ *
9​ * This program is distributed in the hope that it will be useful,
10​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
11​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12​ * GNU General Public License for more details.
13​ *
14​ * You should have received a copy of the GNU General Public License along
15​ * with this program; if not, write to the Free Software Foundation, Inc.,
16​ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17​ */
18​
19​#include "shortcutsmodel.h"
20​
21​#include <algorithm>
22​
23​#include <QIcon>
24​
25​#include <KDesktopFile>
26​#include <KConfigGroup>
27​#include <KGlobalAccel>
28​#include <kglobalaccel_interface.h>
29​#include <kglobalaccel_component_interface.h>
30​#include <KLocalizedString>
31​#include <KService>
32​#include <KServiceTypeTrader>
33​
34​#include "kcmkeys_debug.h"
35​
36​static QStringList buildActionId(const QString &componentUnique, const QString &componentFriendly,
37​ const QString &actionUnique, const QString &actionFriendly)
38​{
39​ QStringList actionId;
broulikUnsubmitted
Done

Hmm...
how about

QStringList actionId;
actionId.reserve(4);
broulik: Hmm... how about ``` QStringList actionId; actionId.reserve(4); ```
davidreAuthorUnsubmitted
Not Done

This actually crashes now

davidre: This actually crashes now
40​ actionId.reserve(4);
41​ actionId[KGlobalAccel::ComponentUnique] = componentUnique;
42​ actionId[KGlobalAccel::ComponentFriendly] = componentFriendly;
43​ actionId[KGlobalAccel::ActionUnique] = actionUnique;
44​ actionId[KGlobalAccel::ActionFriendly] = actionFriendly;
45​ return actionId;
46​}
47​
48​
49​ShortcutsModel::ShortcutsModel(KGlobalAccelInterface *interface, QObject *parent)
50​ : QAbstractItemModel(parent)
51​ , m_globalAccelInterface{interface}
52​{
53​}
54​
55​void ShortcutsModel::load()
56​{
57​ if (!m_globalAccelInterface->isValid()) {
58​ return;
59​ }
60​ beginResetModel();
61​ m_components.clear();
broulikUnsubmitted
Done

Do this asynchronously with QDBusPendingCallWatcher? Not sure if it really matters here

broulik: Do this asynchronously with `QDBusPendingCallWatcher`? Not sure if it really matters here
62​ QDBusReply<QList<QStringList>> componentsReply = m_globalAccelInterface->allMainComponents();
63​ if (!componentsReply.isValid()) {
64​ genericErrorOccured(QStringLiteral("Error while calling allMainComponents()"), componentsReply.error());
65​ return;
66​ }
67​ const auto components = componentsReply.value();
broulikUnsubmitted
Done

Coding style, space after for for (const auto &...)

broulik: Coding style, space after for `for (const auto &...)`
68​ for (const auto &component : components) {
69​ m_components.push_back(loadComponent(component));
70​ }
71​ QCollator collator;
broulikUnsubmitted
Done

for comparing friendlyName use QCollator?

broulik: for comparing `friendlyName` use `QCollator`?
72​ std::sort(m_components.begin(), m_components.end(), [&](const Component &c1, const Component &c2){
73​ return c1.type != c2.type ? c1.type < c2.type : collator.compare(c1.friendlyName, c2.friendlyName) < 0;
74​ });
75​ endResetModel();
76​}
77​
78​Component ShortcutsModel::loadComponent(const QStringList &componentId )
79​{
80​ const QString &componentUnique = componentId[KGlobalAccel::ComponentUnique];
81​ const QString &componentFriendly = componentId[KGlobalAccel::ComponentFriendly];
82​ KService::Ptr service = KService::serviceByStorageId(componentUnique);
83​ if (!service) {
84​ // Do we have an application with that name?
85​ const KService::List apps = KServiceTypeTrader::self()->query(QStringLiteral("Application"),
86​ QStringLiteral("Name == '%1' or Name == '%2'").arg(componentUnique, componentFriendly));
87​ if(!apps.isEmpty()) {
88​ service = apps[0];
89​ }
90​ }
91​ const QString type = service && service->isApplication() ? i18n("Applications") : i18n("System Services");
92​ const QString icon = service && !service->icon().isEmpty() ? service->icon() : componentUnique;
93​ Component c{componentUnique, componentFriendly, type, icon, QVector<Shortcut>(), false};
94​ QDBusReply<QList<QStringList>> actionsReply = m_globalAccelInterface->allActionsForComponent(componentId);
95​ if (!actionsReply.isValid()) {
96​ genericErrorOccured(QStringLiteral("Error while calling allActionsForComponent()"), actionsReply.error());
97​ return c;
98​ }
99​ const QList<QStringList> actions = actionsReply.value();
100​ for (const auto &action : actions) {
101​ const QString &actionUnique = action[KGlobalAccel::ActionUnique];
102​ const QString &actionFriendly = action[KGlobalAccel::ActionFriendly];
103​ Shortcut shortcut;
104​ shortcut.uniqueName = actionUnique;
broulikUnsubmitted
Done

I kinda feel this should be done on demand or asynchronously as it causes a significant load time of the KCM

broulik: I kinda feel this should be done on demand or asynchronously as it causes a significant load…
105​ shortcut.friendlyName = actionFriendly;
106​ QDBusReply<QList<int>> shortcutsReply = m_globalAccelInterface->shortcut(action);
107​ if (!shortcutsReply.isValid()) {
108​ genericErrorOccured(QStringLiteral("Error while querying shortcuts"), shortcutsReply.error());
109​ break;
110​ }
111​ QDBusReply<QList<int>> defaultShortcutReply = m_globalAccelInterface->defaultShortcut(action);
112​ if (!defaultShortcutReply.isValid()) {
113​ genericErrorOccured(QStringLiteral("Error while querying default shortcuts"), defaultShortcutReply.error());
114​ break;
115​ }
116​ const auto defaultShortcuts = defaultShortcutReply.value();
117​ for (const int i : defaultShortcutReply.value()) {
118​ QKeySequence keySequence (i);
119​ if (!keySequence.isEmpty()) {
120​ shortcut.defaultShortcuts.insert(keySequence);
121​ }
122​ }
123​ for (const int i : shortcutsReply.value()) {
124​ QKeySequence keySequence (i);
125​ if (!keySequence.isEmpty()) {
126​ shortcut.activeShortcuts.insert(keySequence);
127​ }
128​ }
129​ shortcut.initialShortcuts = shortcut.activeShortcuts;
130​ c.shortcuts.push_back(shortcut);
131​ }
broulikUnsubmitted
Done

Use QCollator

broulik: Use `QCollator`
132​ QCollator collator;
133​ std::sort(c.shortcuts.begin(), c.shortcuts.end(), [&] (const Shortcut &s1, const Shortcut &s2) {
134​ return collator.compare(s1.friendlyName, s2.friendlyName) < 0;
135​ });
136​ return c;
137​}
138​
139​void ShortcutsModel::save()
140​{
141​ for (auto& component : m_components) {
broulikUnsubmitted
Done

const

broulik: `const`
142​ for (auto& shortcut : component.shortcuts) {
143​ if (shortcut.initialShortcuts != shortcut.activeShortcuts) {
144​ const QStringList actionId = buildActionId(component.uniqueName, component.friendlyName,
145​ shortcut.uniqueName, shortcut.friendlyName);
146​ //operator int of QKeySequence
147​ QList<int> keys(shortcut.activeShortcuts.cbegin(), shortcut.activeShortcuts.cend());
148​ qCDebug(KCMKEYS) << "Saving" << actionId << shortcut.activeShortcuts << keys;
149​ QDBusReply<void> reply = m_globalAccelInterface->setForeignShortcut(actionId, keys);
150​ if (!reply.isValid()) {
151​ qCCritical(KCMKEYS) << "Error while saving";
152​ if (reply.error().isValid()) {
153​ qCCritical(KCMKEYS) << reply.error().name() << reply.error().message();
154​ }
155​ emit errorOccured(i18nc("%1 is the name of the component, %2 is the action for which saving failed",
156​ "Error while saving shortcut %1: %2", component.friendlyName, shortcut.friendlyName));
157​ return;
158​ }
159​ shortcut.initialShortcuts = shortcut.activeShortcuts;
160​ }
161​ }
162​ }
163​}
164​
165​void ShortcutsModel::defaults() {
166​ for (auto component = m_components.begin(); component != m_components.end(); ++component) {
ngrahamUnsubmitted
Done

Clicking the Defaults button does not seem to have any effect for me

ngraham: Clicking the {nav Defaults} button does not seem to have any effect for me
167​ auto componentIndex = index(component - m_components.begin(), 0);
168​ for (auto shortcut = component->shortcuts.begin(); shortcut != component->shortcuts.end(); ++shortcut) {
169​ shortcut->activeShortcuts = shortcut->defaultShortcuts;
170​ }
171​ emit dataChanged(index(0, 0, componentIndex), index(component->shortcuts.size(), 0, componentIndex),
172​ {ActiveShortcutsRole, CustomShortcutsRole});
173​ }
174​}
175​
176​bool ShortcutsModel::needsSave() const {
177​ for (const auto& component : m_components) {
178​ for (const auto& shortcut : component.shortcuts) {
179​ if (shortcut.initialShortcuts != shortcut.activeShortcuts) {
180​ return true;
181​ }
182​ }
183​ }
184​ return false;
185​}
186​
187​bool ShortcutsModel::isDefault() const
188​{
189​ for (const auto& component : m_components) {
190​ for (const auto& shortcut : component.shortcuts) {
191​ if (shortcut.defaultShortcuts != shortcut.activeShortcuts) {
192​ return false;
193​ }
194​ }
195​ }
broulikUnsubmitted
Done

Also check if (column != 0) {
(Also, coding style)

broulik: Also check `if (column != 0) {` (Also, coding style)
196​ return true;
197​}
198​
199​QModelIndex ShortcutsModel::index(int row, int column, const QModelIndex &parent) const
200​{
201​ if (row < 0 || column != 0) {
202​ return QModelIndex();
203​ }
204​ if (parent.isValid() && row < rowCount(parent) && column == 0) {
205​ return createIndex(row, column, parent.row() + 1);
206​ } else if (column == 0 && row < m_components.size()) {
207​ return createIndex(row, column, nullptr);
208​ }
209​ return QModelIndex();
210​}
211​
212​QModelIndex ShortcutsModel::parent(const QModelIndex &child) const
213​{
214​ if (child.internalId()) {
215​ return createIndex(child.internalId() - 1, 0, nullptr);
216​ }
217​ return QModelIndex();
218​}
219​
220​int ShortcutsModel::rowCount(const QModelIndex &parent) const
221​{
222​ if (parent.isValid()) {
223​ if (parent.parent().isValid()) {
224​ return 0;
225​ }
226​ return m_components[parent.row()].shortcuts.size();
227​ }
228​ return m_components.size();
229​}
230​
231​int ShortcutsModel::columnCount(const QModelIndex &parent) const
232​{
233​ Q_UNUSED(parent);
broulikUnsubmitted
Done

checkIndex()?

broulik: `checkIndex()`?
234​ return 1;
235​}
236​
237​QVariant ShortcutsModel::data(const QModelIndex &index, int role) const
238​{
239​ if (!checkIndex(index)) {
240​ return QVariant();
241​ }
242​
243​ if (index.parent().isValid()) {
244​ const Shortcut &shortcut = m_components[index.parent().row()].shortcuts[index.row()];
245​ switch (role) {
246​ case Qt::DisplayRole:
247​ return shortcut.friendlyName.isEmpty() ? shortcut.uniqueName : shortcut.friendlyName;
248​ case ActionRole:
249​ return shortcut.uniqueName;
250​ case ActiveShortcutsRole:
251​ return QVariant::fromValue(shortcut.activeShortcuts);
252​ case DefaultShortcutsRole:
broulikUnsubmitted
Done

No default case please in case we add new roles. Just return outside the switch, and below

broulik: No `default` case please in case we add new roles. Just `return` outside the `switch`, and below
253​ return QVariant::fromValue(shortcut.defaultShortcuts);
254​ case CustomShortcutsRole: {
255​ auto shortcuts = shortcut.activeShortcuts;
256​ return QVariant::fromValue(shortcuts.subtract(shortcut.defaultShortcuts));
257​ }
258​ }
259​ return QVariant();
260​ }
261​ const Component &component = m_components[index.row()];
broulikUnsubmitted
Done

Do we want a QIcon here? I guess just returning an iconName and using a Kirigami.Icon in the UI should suffice

broulik: Do we want a `QIcon` here? I guess just returning an `iconName` and using a `Kirigami.Icon` in…
262​ switch(role) {
263​ case Qt::DisplayRole:
264​ return component.friendlyName;
265​ case Qt::DecorationRole:
266​ return component.icon;
267​ case SectionRole:
268​ return component.type;
269​ case ComponentRole:
270​ return component.uniqueName;
271​ case CheckedRole:
272​ return component.checked;
273​ }
274​ return QVariant();
275​}
broulikUnsubmitted
Not Done

Makes me wonder if CheckedRole should be the Qt::EditableRole

broulik: Makes me wonder if `CheckedRole` should be the `Qt::EditableRole`
276​
277​bool ShortcutsModel::setData(const QModelIndex &index, const QVariant &value, int role)
278​{
279​ if (!checkIndex(index) || index.parent().isValid() || role != CheckedRole) {
280​ return false;
281​ }
282​ m_components[index.row()].checked = value.toBool();
283​ emit dataChanged(index, index, {CheckedRole});
284​ return true;
285​}
286​
287​QHash<int, QByteArray> ShortcutsModel::roleNames() const
288​{
289​ return {
290​ {Qt::DisplayRole, QByteArrayLiteral("display")},
291​ {Qt::DecorationRole, QByteArrayLiteral("decoration")},
292​ {SectionRole, QByteArrayLiteral("section")},
293​ {ComponentRole, QByteArrayLiteral("component")},
294​ {ActiveShortcutsRole, QByteArrayLiteral("activeShortcuts")},
295​ {DefaultShortcutsRole, QByteArrayLiteral("defaultShortcuts")},
296​ {CustomShortcutsRole, QByteArrayLiteral("customShortcuts")},
297​ {CheckedRole, QByteArrayLiteral("checked")}
298​ };
299​}
broulikUnsubmitted
Done

You can pass also ParentIsInvalid as flag to checkIndex

broulik: You can pass also `ParentIsInvalid` as flag to `checkIndex`
davidreAuthorUnsubmitted
Done

I think that's wrong way round here

davidre: I think that's wrong way round here
300​
301​void ShortcutsModel::toggleDefaultShortcut(const QModelIndex &index, const QKeySequence &shortcut, bool enabled)
302​{
303​ if (!checkIndex(index) || !index.parent().isValid()) {
304​ return;
305​ }
306​ qCDebug(KCMKEYS) << "Default shortcut" << index << shortcut << enabled;
307​ Shortcut &s = m_components[index.parent().row()].shortcuts[index.row()];
308​ if (enabled) {
309​ s.activeShortcuts.insert(shortcut);
310​ } else {
311​ s.activeShortcuts.remove(shortcut);
312​ }
313​ emit dataChanged(index, index, {ActiveShortcutsRole, DefaultShortcutsRole});
314​}
315​
316​void ShortcutsModel::addShortcut(const QModelIndex &index, const QKeySequence &shortcut)
317​{
318​ if (!checkIndex(index) || !index.parent().isValid()) {
319​ return;
320​ }
321​ if (shortcut.isEmpty()) {
322​ return;
323​ }
324​ qCDebug(KCMKEYS) << "Adding shortcut" << index << shortcut;
325​ Shortcut &s = m_components[index.parent().row()].shortcuts[index.row()];
326​ s.activeShortcuts.insert(shortcut);
327​ emit dataChanged(index, index, {ActiveShortcutsRole, CustomShortcutsRole});
328​}
329​
330​void ShortcutsModel::disableShortcut(const QModelIndex &index, const QKeySequence &shortcut)
331​{
332​ if (!checkIndex(index) || !index.parent().isValid()) {
333​ return;
334​ }
335​ qCDebug(KCMKEYS) << "Disabling shortcut" << index << shortcut;
336​ Shortcut &s = m_components[index.parent().row()].shortcuts[index.row()];
337​ s.activeShortcuts.remove(shortcut);
338​ emit dataChanged(index, index, {ActiveShortcutsRole, CustomShortcutsRole});
339​
340​}
341​
342​void ShortcutsModel::changeShortcut(const QModelIndex &index, const QKeySequence &oldShortcut, const QKeySequence &newShortcut)
343​{
344​ if (!checkIndex(index) || !index.parent().isValid()) {
345​ return;
346​ }
347​ if (newShortcut.isEmpty()) {
348​ return;
349​ }
350​ qCDebug(KCMKEYS) << "Changing Shortcut" << index << oldShortcut << " to " << newShortcut;
351​ Shortcut &s = m_components[index.parent().row()].shortcuts[index.row()];
352​ s.activeShortcuts.remove(oldShortcut);
353​ s.activeShortcuts.insert(newShortcut);
354​ emit dataChanged(index, index, {ActiveShortcutsRole, CustomShortcutsRole});
355​}
356​
357​void ShortcutsModel::setShortcuts(const KConfigBase &config)
358​{
359​ for (const auto componentGroupName : config.groupList()) {
360​ auto component = std::find_if(m_components.begin(), m_components.end(), [&] (const Component &c) {
361​ return c.uniqueName == componentGroupName;
362​ });
363​ if (component == m_components.end()) {
364​ qCWarning(KCMKEYS) << "Ignoring unknown component" << componentGroupName;
365​ continue;
366​ }
367​ KConfigGroup componentGroup(&config, componentGroupName);
368​ if (!componentGroup.hasGroup("Global Shortcuts")) {
369​ qCWarning(KCMKEYS) << "Group" << componentGroupName << "has no shortcuts group";
370​ continue;
371​ }
372​ KConfigGroup shortcutsGroup(&componentGroup, "Global Shortcuts");
373​ for (const auto& key : shortcutsGroup.keyList()) {
374​ auto shortcut = std::find_if(component->shortcuts.begin(), component->shortcuts.end(), [&] (const Shortcut &s) {
375​ return s.uniqueName == key;
376​ });
377​ if (shortcut == component->shortcuts.end()) {
378​ qCWarning(KCMKEYS) << "Ignoring unknown action" << key;
379​ }
380​ const auto shortcuts = QKeySequence::listFromString(shortcutsGroup.readEntry(key));
381​ shortcut->activeShortcuts = QSet<QKeySequence>(shortcuts.cbegin(), shortcuts.cend());
382​ }
383​ }
384​ emit dataChanged(index(0, 0), index(0, rowCount()), {ActiveShortcutsRole, CustomShortcutsRole});
385​}
386​
387​void ShortcutsModel::addApplication(const QString &desktopFileName, const QString &displayName)
388​{
389​ QStringList list{"", "", "", ""};
390​ list[KGlobalAccel::ComponentUnique] = desktopFileName;
391​ list[KGlobalAccel::ComponentFriendly] = displayName;
392​ m_globalAccelInterface->doRegister(list);
393​ QCollator collator;
394​ auto pos = std::lower_bound(m_components.begin(), m_components.end(), displayName, [&] (const Component &c, const QString &name) {
395​ return c.type != i18n("System Services") && collator.compare(c.friendlyName, name) < 0;
396​ });
397​ qCDebug(KCMKEYS) << "inserting at " << pos - m_components.begin();
398​ emit beginInsertRows(QModelIndex(), pos - m_components.begin(), pos - m_components.begin());
399​ Component c = loadComponent(list);
400​ m_components.insert(pos, c);
401​ emit endInsertRows();
402​}
403​
404​void ShortcutsModel::removeComponent(const QModelIndex &index)
broulikUnsubmitted
Done

perhaps "service" instead of "daemon"?

broulik: perhaps "service" instead of "daemon"?
405​{
406​ if (!checkIndex(index) || index.parent().isValid()) {
407​ qCWarning(KCMKEYS) << "Cannot remove component - index doesn't refer to a valid component" << index;
408​ }
409​ QDBusReply<QDBusObjectPath> objectPath = m_globalAccelInterface->getComponent(m_components[index.row()].uniqueName);
410​ KGlobalAccelComponentInterface component(m_globalAccelInterface->service(), objectPath.value().path(), m_globalAccelInterface->connection());
411​ beginRemoveRows(QModelIndex(), index.row(), index.row());
412​ qCDebug(KCMKEYS) << "Cleaning up component at" << objectPath.value();
413​ component.cleanUp();
414​ m_components.remove(index.row());
415​ endRemoveRows();
416​}
417​
418​void ShortcutsModel::genericErrorOccured(const QString &description, const QDBusError &error)
419​{
420​ qCCritical(KCMKEYS) << description;
421​ if (error.isValid()) {
422​ qCCritical(KCMKEYS) << error.name() << error.message();
423​ }
424​ emit this->errorOccured(i18n("Error while communicating with the global shortcuts service"));
425​}
ngrahamUnsubmitted
Done

compile error

ngraham: compile error