Differential D28744 Diff 79907 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 <KLocalizedString>
30​#include <KService>
31​#include <KServiceTypeTrader>
32​
33​#include "kcmkeys_debug.h"
34​
35​static QStringList buildActionId(const QString &componentUnique, const QString &componentFriendly,
36​ const QString &actionUnique, const QString &actionFriendly)
37​{
38​ QStringList actionId{"", "", "", ""};
39​ actionId[KGlobalAccel::ComponentUnique] = componentUnique;
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[KGlobalAccel::ComponentFriendly] = componentFriendly;
41​ actionId[KGlobalAccel::ActionUnique] = actionUnique;
42​ actionId[KGlobalAccel::ActionFriendly] = actionFriendly;
43​ return actionId;
44​}
45​
46​
47​ShortcutsModel::ShortcutsModel(KGlobalAccelInterface *interface, QObject *parent)
48​ : QAbstractItemModel(parent)
49​ , m_globalAccelInterface{interface}
50​{
51​}
52​
53​void ShortcutsModel::load()
54​{
55​ if (!m_globalAccelInterface->isValid()) {
56​ return;
57​ }
58​ beginResetModel();
59​ m_components.clear();
60​ QDBusReply<QList<QStringList>> componentsReply = m_globalAccelInterface->allMainComponents();
61​ if (!componentsReply.isValid()) {
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​ genericErrorOccured(QStringLiteral("Error while calling allMainComponents()"), componentsReply.error());
63​ return;
64​ }
65​ const auto components = componentsReply.value();
66​ for(const auto &component : components) {
67​ m_components.push_back(loadComponent(component));
broulikUnsubmitted
Done

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

broulik: Coding style, space after for `for (const auto &...)`
68​ }
69​ std::sort(m_components.begin(), m_components.end(), [](const Component &c1, const Component &c2){
70​ return c1.type != c2.type ? c1.type < c2.type : c1.friendlyName < c2.friendlyName;
71​ });
broulikUnsubmitted
Done

for comparing friendlyName use QCollator?

broulik: for comparing `friendlyName` use `QCollator`?
72​ endResetModel();
73​}
74​
75​Component ShortcutsModel::loadComponent(const QStringList &componentId )
76​{
77​ const QString &componentUnique = componentId[KGlobalAccel::ComponentUnique];
78​ const QString &componentFriendly = componentId[KGlobalAccel::ComponentFriendly];
79​ KService::Ptr service = KService::serviceByStorageId(componentUnique);
80​ if (!service) {
81​ // Do we have an application with that name?
82​ const KService::List apps = KServiceTypeTrader::self()->query(QStringLiteral("Application"),
83​ QStringLiteral("Name == '%1' or Name == '%2'").arg(componentUnique, componentFriendly));
84​ if(!apps.isEmpty()) {
85​ service = apps[0];
86​ }
87​ }
88​ const QString type = service && service->isApplication() ? i18n("Applications") : i18n("System Services");
89​ const QString icon = service && !service->icon().isEmpty() ? service->icon() : componentUnique;
90​ Component c{componentUnique, componentFriendly, type, icon, QVector<Shortcut>(), false};
91​ QDBusReply<QList<QStringList>> actionsReply = m_globalAccelInterface->allActionsForComponent(componentId);
92​ if (!actionsReply.isValid()) {
93​ genericErrorOccured(QStringLiteral("Error while calling allActionsForComponent()"), actionsReply.error());
94​ return c;
95​ }
96​ const QList<QStringList> actions = actionsReply.value();
97​ for (const auto &action : actions) {
98​ const QString &actionUnique = action[KGlobalAccel::ActionUnique];
99​ const QString &actionFriendly = action[KGlobalAccel::ActionFriendly];
100​ Shortcut shortcut;
101​ shortcut.uniqueName = actionUnique;
102​ shortcut.friendlyName = actionFriendly;
103​ QDBusReply<QList<int>> shortcutsReply = m_globalAccelInterface->shortcut(action);
104​ if (!shortcutsReply.isValid()) {
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​ genericErrorOccured(QStringLiteral("Error while querying shortcuts"), shortcutsReply.error());
106​ break;
107​ }
108​ QDBusReply<QList<int>> defaultShortcutReply = m_globalAccelInterface->defaultShortcut(action);
109​ if (!defaultShortcutReply.isValid()) {
110​ genericErrorOccured(QStringLiteral("Error while querying default shortcuts"), defaultShortcutReply.error());
111​ break;
112​ }
113​ const auto defaultShortcuts = defaultShortcutReply.value();
114​ for (const int i : defaultShortcutReply.value()) {
115​ QKeySequence keySequence (i);
116​ if (!keySequence.isEmpty()) {
117​ shortcut.defaultShortcuts.insert(keySequence);
118​ }
119​ }
120​ for (const int i : shortcutsReply.value()) {
121​ QKeySequence keySequence (i);
122​ if (!keySequence.isEmpty()) {
123​ shortcut.activeShortcuts.insert(keySequence);
124​ }
125​ }
126​ shortcut.initialShortcuts = shortcut.activeShortcuts;
127​ c.shortcuts.push_back(shortcut);
128​ }
129​ std::sort(c.shortcuts.begin(), c.shortcuts.end(), [] (const Shortcut &s1, const Shortcut &s2) {
130​ return s1.friendlyName < s2.friendlyName;
131​ });
broulikUnsubmitted
Done

Use QCollator

broulik: Use `QCollator`
132​ return c;
133​}
134​
135​void ShortcutsModel::save()
136​{
137​ for (auto& component : m_components) {
138​ for (auto& shortcut : component.shortcuts) {
139​ if (shortcut.initialShortcuts != shortcut.activeShortcuts) {
140​ QStringList actionId = buildActionId(component.uniqueName, component.friendlyName,
141​ shortcut.uniqueName, shortcut.friendlyName);
broulikUnsubmitted
Done

const

broulik: `const`
142​ //operator int of QKeySequence
143​ QList<int> keys(shortcut.activeShortcuts.cbegin(), shortcut.activeShortcuts.cend());
144​ qCDebug(KCMKEYS) << "Saving" << actionId << shortcut.activeShortcuts << keys;
145​ QDBusReply<void> reply = m_globalAccelInterface->setForeignShortcut(actionId, keys);
146​ if (!reply.isValid()) {
147​ qCCritical(KCMKEYS) << "Error while saving";
148​ if (reply.error().isValid()) {
149​ qCCritical(KCMKEYS) << reply.error().name() << reply.error().message();
150​ }
151​ error(i18nc("%1 is the name of the component, %2 is the action for which saving failed",
152​ "Error while saving shortcut %1: %2", component.friendlyName, shortcut.friendlyName));
153​ return;
154​ }
155​ shortcut.initialShortcuts = shortcut.activeShortcuts;
156​ }
157​ }
158​ }
159​}
160​
161​void ShortcutsModel::defaults() {
162​ for (auto& component : m_components) {
163​ for (auto& shortcut : component.shortcuts) {
164​ shortcut.activeShortcuts = shortcut.defaultShortcuts;
165​ }
166​ }
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​}
168​
169​bool ShortcutsModel::needsSave() {
170​ for (const auto& component : m_components) {
171​ for (const auto& shortcut : component.shortcuts) {
172​ if (shortcut.initialShortcuts != shortcut.activeShortcuts) {
173​ return true;
174​ }
175​ }
176​ }
177​ return false;
178​}
179​
180​bool ShortcutsModel::isDefault()
181​{
182​ for (const auto& component : m_components) {
183​ for (const auto& shortcut : component.shortcuts) {
184​ if (shortcut.defaultShortcuts != shortcut.activeShortcuts) {
185​ return false;
186​ }
187​ }
188​ }
189​ return true;
190​}
191​
192​QModelIndex ShortcutsModel::index(int row, int column, const QModelIndex &parent) const
193​{
194​ if (row < 0 ) {
195​ return QModelIndex();
broulikUnsubmitted
Done

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

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

checkIndex()?

broulik: `checkIndex()`?
234​ }
235​
236​ if (index.parent().isValid()) {
237​ const Shortcut &shortcut = m_components[index.parent().row()].shortcuts[index.row()];
238​ switch (role) {
239​ case Qt::DisplayRole:
240​ return shortcut.friendlyName;
241​ case ActionRole:
242​ return shortcut.uniqueName;
243​ case ActiveShortcutsRole:
244​ return QVariant::fromValue(shortcut.activeShortcuts);
245​ case DefaultShortcutsRole:
246​ return QVariant::fromValue(shortcut.defaultShortcuts);
247​ case CustomShortcutsRole: {
248​ auto shortcuts = shortcut.activeShortcuts;
249​ return QVariant::fromValue(shortcuts.subtract(shortcut.defaultShortcuts));
250​ }
251​ default:
252​ return QVariant();
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​ }
254​ }
255​ const Component &component = m_components[index.row()];
256​ switch(role) {
257​ case Qt::DisplayRole:
258​ return component.friendlyName;
259​ case Qt::DecorationRole:
260​ return QIcon::fromTheme(component.icon);
261​ case SectionRole:
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​ return component.type;
263​ case ComponentRole:
264​ return component.uniqueName;
265​ case CheckedRole:
266​ return component.checked;
267​ default:
268​ return QVariant();
269​ }
270​}
271​
272​bool ShortcutsModel::setData(const QModelIndex &index, const QVariant &value, int role)
273​{
274​ if (!checkIndex(index) || index.parent().isValid() || role != CheckedRole) {
275​ return false;
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​ m_components[index.row()].checked = value.toBool();
278​ emit dataChanged(index, index, {CheckedRole});
279​ return true;
280​}
281​
282​QHash<int, QByteArray> ShortcutsModel::roleNames() const
283​{
284​ return {
285​ {Qt::DisplayRole, QByteArrayLiteral("display")},
286​ {Qt::DecorationRole, QByteArrayLiteral("decoration")},
287​ {SectionRole, QByteArrayLiteral("section")},
288​ {ComponentRole, QByteArrayLiteral("component")},
289​ {ActiveShortcutsRole, QByteArrayLiteral("activeShortcuts")},
290​ {DefaultShortcutsRole, QByteArrayLiteral("defaultShortcuts")},
291​ {CustomShortcutsRole, QByteArrayLiteral("customShortcuts")},
292​ {CheckedRole, QByteArrayLiteral("checked")}
293​ };
294​}
295​
296​void ShortcutsModel::toggleDefaultShortcut(const QModelIndex &index, const QKeySequence &shortcut, bool enabled)
297​{
298​ if (!checkIndex(index) || !index.parent().isValid()) {
299​ return;
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​ qCDebug(KCMKEYS) << "Default shortcut" << index << shortcut << enabled;
302​ Shortcut &s = m_components[index.parent().row()].shortcuts[index.row()];
303​ if (enabled) {
304​ s.activeShortcuts.insert(shortcut);
305​ } else {
306​ s.activeShortcuts.remove(shortcut);
307​ }
308​ emit dataChanged(index, index, {ActiveShortcutsRole, DefaultShortcutsRole});
309​}
310​
311​void ShortcutsModel::addShortcut(const QModelIndex &index, const QKeySequence &shortcut)
312​{
313​ if (!checkIndex(index) || !index.parent().isValid()) {
314​ return;
315​ }
316​ if (shortcut.isEmpty()) {
317​ return;
318​ }
319​ qCDebug(KCMKEYS) << "Adding shortcut" << index << shortcut;
320​ Shortcut &s = m_components[index.parent().row()].shortcuts[index.row()];
321​ s.activeShortcuts.insert(shortcut);
322​ emit dataChanged(index, index, {ActiveShortcutsRole, CustomShortcutsRole});
323​}
324​
325​void ShortcutsModel::disableShortcut(const QModelIndex &index, const QKeySequence &shortcut)
326​{
327​ if (!checkIndex(index) || !index.parent().isValid()) {
328​ return;
329​ }
330​ qCDebug(KCMKEYS) << "Disabling shortcut" << index << shortcut;
331​ Shortcut &s = m_components[index.parent().row()].shortcuts[index.row()];
332​ s.activeShortcuts.remove(shortcut);
333​ emit dataChanged(index, index, {ActiveShortcutsRole, CustomShortcutsRole});
334​
335​}
336​
337​void ShortcutsModel::changeShortcut(const QModelIndex &index, const QKeySequence &oldShortcut, const QKeySequence &newShortcut)
338​{
339​ if (!checkIndex(index) || !index.parent().isValid()) {
340​ return;
341​ }
342​ if (newShortcut.isEmpty()) {
343​ return;
344​ }
345​ qCDebug(KCMKEYS) << "Changing Shortcut" << index << oldShortcut << " to " << newShortcut;
346​ Shortcut &s = m_components[index.parent().row()].shortcuts[index.row()];
347​ s.activeShortcuts.remove(oldShortcut);
348​ s.activeShortcuts.insert(newShortcut);
349​ emit dataChanged(index, index, {ActiveShortcutsRole, CustomShortcutsRole});
350​}
351​
352​void ShortcutsModel::setShortcuts(const KConfigBase &config)
353​{
354​ for (const auto componentGroupName : config.groupList()) {
355​ auto component = std::find_if(m_components.begin(), m_components.end(), [&] (const Component &c) {
356​ return c.uniqueName == componentGroupName;
357​ });
358​ if (component == m_components.end()) {
359​ qCWarning(KCMKEYS) << "Ignoring unknown component" << componentGroupName;
360​ continue;
361​ }
362​ KConfigGroup componentGroup(&config, componentGroupName);
363​ if (!componentGroup.hasGroup("Global Shortcuts")) {
364​ qCWarning(KCMKEYS) << "Group" << componentGroupName << "has no shortcuts group";
365​ continue;
366​ }
367​ KConfigGroup shortcutsGroup(&componentGroup, "Global Shortcuts");
368​ for (const auto& key : shortcutsGroup.keyList()) {
369​ auto shortcut = std::find_if(component->shortcuts.begin(), component->shortcuts.end(), [&] (const Shortcut &s) {
370​ return s.uniqueName == key;
371​ });
372​ if (shortcut == component->shortcuts.end()) {
373​ qCWarning(KCMKEYS) << "Ignoring unknown action" << key;
374​ }
375​ const auto shortcuts = QKeySequence::listFromString(shortcutsGroup.readEntry(key));
376​ shortcut->activeShortcuts = QSet<QKeySequence>(shortcuts.cbegin(), shortcuts.cend());
377​ }
378​ }
379​ emit dataChanged(index(0, 0), index(0, rowCount()), {ActiveShortcutsRole, CustomShortcutsRole});
380​}
381​
382​void ShortcutsModel::addApplication(const QString &desktopFileName, const QString &displayName)
383​{
384​ QStringList list{"", "", "", ""};
385​ list[KGlobalAccel::ComponentUnique] = desktopFileName;
386​ list[KGlobalAccel::ComponentFriendly] = displayName;
387​ m_globalAccelInterface->doRegister(list);
388​ auto pos = std::lower_bound(m_components.begin(), m_components.end(), displayName,
389​ [] (const Component &c, const QString &name) {return c.type != i18n("System Services") && c.friendlyName < name;});
390​ qCDebug(KCMKEYS) << "inserting at " << pos - m_components.begin();
391​ emit beginInsertRows(QModelIndex(), pos - m_components.begin(), pos - m_components.begin());
392​ Component c = loadComponent(list);
393​ m_components.insert(pos, c);
394​ emit endInsertRows();
395​}
396​
397​void ShortcutsModel::genericErrorOccured(const QString &description, const QDBusError &error)
398​{
399​ qCCritical(KCMKEYS) << description;
400​ if (error.isValid()) {
401​ qCCritical(KCMKEYS) << error.name() << error.message();
402​ }
403​ emit this->error(i18n("Error while communicating with the global shortcuts daemon"));
404​}
broulikUnsubmitted
Done

perhaps "service" instead of "daemon"?

broulik: perhaps "service" instead of "daemon"?
ngrahamUnsubmitted
Done

compile error

ngraham: compile error