Merge pull request #34 from Thaodan/qcdebug

Reduce logging output and refactor headers

CMakeLists.txt

@@ -12,6 +12,7 @@ set(KF_MAJOR_VERSION "6")
 
 set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${ECM_KDE_MODULE_DIR} ${CMAKE_MODULE_PATH})
 
+include(ECMQtDeclareLoggingCategory)
 include(KDEInstallDirs)
 include(KDECMakeSettings)
 include(KDECompilerSettings)

plasmoid/contents/config/config.qml

@@ -1,3 +1,8 @@
+/*  -*- qml -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
 import QtQuick 2.15
 import org.kde.plasma.configuration
 

plasmoid/contents/config/main.xml

@@ -1,4 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!-- -*- xml -*-
+    SPDX-License-Identifier: GPL-3.0-or-later
+!-->
 <kcfg xmlns="http://www.kde.org/standards/kcfg/1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.kde.org/standards/kcfg/1.0 http://www.kde.org/standards/kcfg/1.0/kcfg.xsd">
 	<kcfgfile name="" />
 	<group name="General">

plasmoid/contents/ui/configGeneral.qml

@@ -1,3 +1,8 @@
+/*  -*- qml -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
 import QtQuick 2.15
 import QtQuick.Controls
 import QtQuick.Layouts

plasmoid/contents/ui/configScreens.qml

@@ -1,3 +1,8 @@
+/*  -*- qml -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
 import QtQuick 2.15
 import QtQuick.Controls as QQC2
 import QtQuick.Dialogs

plasmoid/contents/ui/main.qml

@@ -1,3 +1,8 @@
+/*  -*- qml -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
 import QtQuick 2.15
 import QtQuick.Layouts
 import QtQuick.Controls

plasmoid/contents/ui/screens.js

@@ -1,3 +1,8 @@
+/*  -*- qml -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
 function saveConfig() {
     console.log("Saving config")
     cfg_screenNameList = [];

plasmoid/metadata.json

@@ -4,17 +4,22 @@
             {
                 "Email": "[email protected]",
                 "Name": "Christian duvholt"
+            },
+            {
+                "Email": "[email protected]",
+                "Name": "Björn Bidar"
             }
+
         ],
         "Description": "i3 Pager",
         "Id": "org.kde.I3Pager",
-        "License": "GPL",
+        "License": "GPL-3.0-or-later",
         "Name": "i3Pager",
         "ServiceTypes": [
             "Plasma/Applet"
         ],
         "Version": "1.0",
-        "Website": "plasma.kde.org"
+        "Website": "https://github.com/duvholt/i3-pager"
     },
     "X-Plasma-API": "declarativeappletscript",
     "X-Plasma-API-Minimum-Version": "6.0",

src/CMakeLists.txt

@@ -8,6 +8,14 @@ set(I3PagerPlugin_SRCS
         workspace.cpp
         workspace.h)
 
+ecm_qt_declare_logging_category(I3PagerPlugin_SRCS
+  HEADER i3pager_debug.h
+  IDENTIFIER I3PAGER
+  CATEGORY_NAME org.kde.I3Pager
+  DESCRIPTION "I3Pager Plasmoid"
+  EXPORT I3Pager
+)
+
 add_library(I3PagerPlugin SHARED ${I3PagerPlugin_SRCS})
 target_compile_options(I3PagerPlugin PRIVATE -fexceptions)
 
@@ -31,3 +39,6 @@ target_link_libraries(I3PagerPlugin
 # install plugin
 install(TARGETS  I3PagerPlugin DESTINATION ${KDE_INSTALL_QMLDIR}/org/kde/private/I3Pager)
 install(FILES qmldir DESTINATION ${KDE_INSTALL_QMLDIR}/org/kde/private/I3Pager)
+ecm_qt_install_logging_categories(EXPORT I3PAGER
+  FILE org.kde.i3pager.categories
+  DESTINATION ${KDE_INSTALL_LOGGINGCATEGORIESDIR})

src/i3listener.cpp

@@ -1,4 +1,14 @@
+/*  -*- c++ -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
 #include "i3listener.h"
+#include "i3pager_debug.h"
+#include <QDebug>
+#include <QLocalSocket>
+#include <QSocketNotifier>
+#include <i3ipc++/ipc.hpp>
 
 I3ListenerThread::I3ListenerThread(QObject* parent)
     : QThread(parent) {
@@ -19,25 +29,25 @@ void I3ListenerThread::handleI3Events() {
 
         // Workspace events handler
         conn.signal_workspace_event.connect([this](const i3ipc::workspace_event_t& ev) {
-            qDebug() << "workspace_event: " << (char)ev.type;
+            qCDebug(I3PAGER) << "workspace_event: " << (char)ev.type;
             if (ev.current) {
-                qDebug() << "\tSwitched to #" << ev.current->num << " - \"" << QString::fromStdString(ev.current->name) << '"';
+                qCDebug(I3PAGER) << "\tSwitched to #" << ev.current->num << " - \"" << QString::fromStdString(ev.current->name) << '"';
                 Q_EMIT workspacesChanged();
             }
         });
 
         // Mode events handler
         conn.signal_mode_event.connect([this](const i3ipc::mode_t& i3mode) {
             const auto mode = QString::fromStdString(i3mode.change);
-            qDebug() << "mode: " << mode;
+            qCDebug(I3PAGER) << "mode: " << mode;
             Q_EMIT modeChanged(mode);
         });
 
         while (!stopping) {
             conn.handle_event();
         }
     } catch (std::exception const& e) {
-        qWarning() << "Exception in i3listener handle events:" << e.what();
+        qCWarning(I3PAGER) << "Exception in i3listener handle events:" << e.what();
     }
 }
 

src/i3listener.h

@@ -1,12 +1,11 @@
-#ifndef I3LISTENER_H
-#define I3LISTENER_H
+/*  -*- c++ -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
+#pragma  once
 
-#include <QDebug>
-#include <QLocalSocket>
-#include <QSocketNotifier>
 #include <QThread>
-#include <QtCore/QObject>
-#include <i3ipc++/ipc.hpp>
 
 class I3ListenerThread : public QThread {
     Q_OBJECT
@@ -24,5 +23,3 @@ class I3ListenerThread : public QThread {
     bool stopping = false;
     void handleI3Events();
 };
-
-#endif //I3LISTENER_H

src/i3pager.cpp

@@ -1,11 +1,23 @@
+/*  -*- c++ -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
 #include "i3pager.h"
 
+#include <i3ipc++/ipc.hpp>
+#include "i3pager_debug.h"
+#include "i3listener.h"
+#include <future>
+#include <QDebug>
+
+
 I3Pager::I3Pager(QObject* parent)
     : QObject(parent) {
     currentScreenPrivate = QString();
     mode = "default";
 
-    qDebug() << "Starting i3 listener";
+    qCDebug(I3PAGER) << "Starting i3 listener";
     this->i3ListenerThread = new I3ListenerThread(this);
     connect(i3ListenerThread, &I3ListenerThread::modeChanged, this, [=](const QString& mode) {
         this->mode = mode;
@@ -16,14 +28,14 @@ I3Pager::I3Pager(QObject* parent)
     });
     connect(i3ListenerThread, &I3ListenerThread::finished, i3ListenerThread, &QObject::deleteLater);
     i3ListenerThread->start();
-    qDebug() << "i3 listener started";
+    qCDebug(I3PAGER) << "i3 listener started";
 }
 
 I3Pager::~I3Pager() {
-    qDebug() << "I3Pager destructor";
+    qCDebug(I3PAGER) << "I3Pager destructor";
     this->i3ListenerThread->stop();
     this->i3ListenerThread->wait();
-    qDebug() << "I3Pager destructor done";
+    qCDebug(I3PAGER) << "I3Pager destructor done";
 }
 
 QList<QString> I3Pager::getScreenNames() {
@@ -35,11 +47,11 @@ QList<QString> I3Pager::getScreenNames() {
         for (auto& screen : screens) {
             if (screen->active) {
                 screenList.append(QString::fromStdString(screen->name));
-                qDebug() << "Screen name:" << QString::fromStdString(screen->name);
+                qCDebug(I3PAGER) << "Screen name:" << QString::fromStdString(screen->name);
             }
         }
     } catch (std::exception const& e) {
-        qWarning() << "Exception while retrieving screen names: " << e.what();
+        qCWarning(I3PAGER) << "Exception while retrieving screen names: " << e.what();
     }
 
     return screenList;
@@ -50,7 +62,7 @@ QList<Workspace> I3Pager::getWorkspaces(bool filterByCurrentScreen, QString orde
     try {
         i3ipc::connection conn;
         auto i3workspaceList = conn.get_workspaces();
-        qDebug() << "Loading workspaces:";
+        qCDebug(I3PAGER) << "Loading workspaces:";
 
         for (auto& i3workspace : i3workspaceList) {
             Workspace workspace;
@@ -66,8 +78,8 @@ QList<Workspace> I3Pager::getWorkspaces(bool filterByCurrentScreen, QString orde
             workspace.visible = i3workspace->visible;
             workspace.urgent = i3workspace->urgent;
 
-            qDebug() << "i3Workspace name:" << QString::fromStdString(i3workspace->name);
-            qDebug() << "Workspace:"
+            qCDebug(I3PAGER) << "i3Workspace name:" << QString::fromStdString(i3workspace->name);
+            qCDebug(I3PAGER) << "Workspace:"
                     << "id:" << workspace.id
                     << "index:" << workspace.index
                     << "name:" << workspace.name
@@ -79,7 +91,7 @@ QList<Workspace> I3Pager::getWorkspaces(bool filterByCurrentScreen, QString orde
             workspaceList.append(workspace);
         }
     } catch (std::exception const& e) {
-        qWarning() << "Exception while retrieving workspaces:" << e.what();
+        qCWarning(I3PAGER) << "Exception while retrieving workspaces:" << e.what();
     }
 
     if (filterByCurrentScreen) {

src/i3pager.h

@@ -1,18 +1,15 @@
-#ifndef I3PAGER_PLASMOID_H
-#define I3PAGER_PLASMOID_H
+/*  -*- c++ -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
+#pragma once
 
-#include "i3listener.h"
 #include "workspace.h"
-#include <QApplication>
-#include <QDebug>
-#include <QGuiApplication>
-#include <QMetaType>
-#include <QScreen>
-#include <QVariant>
-#include <QtConcurrent/QtConcurrent>
-#include <QtCore/QObject>
-#include <future>
-#include <i3ipc++/ipc.hpp>
+#include <QObject>
+
+class I3ListenerThread;
+class Workspace;
 
 class I3Pager : public QObject {
     Q_OBJECT
@@ -42,5 +39,3 @@ public Q_SLOTS:
     QString currentScreenPrivate;
     QString mode;
 };
-
-#endif //I3PAGER_PLASMOID_H

src/plugin.cpp

@@ -1,5 +1,11 @@
-#include "plugin.h"
+/*  -*- c++ -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
 
+#include "plugin.h"
+#include "i3pager.h"
+#include "workspace.h"
 #include <QtQml>
 
 void Plugin::registerTypes(const char  *uri) {

src/plugin.h

@@ -1,8 +1,9 @@
-#ifndef I3PAGER_PLASMOID_PLUGIN_H
-#define I3PAGER_PLASMOID_PLUGIN_H
+/*  -*- c++ -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
 
-#include "i3pager.h"
-#include "workspace.h"
+#pragma once
 
 #include <QQmlExtensionPlugin>
 
@@ -14,5 +15,3 @@ class Plugin : public QQmlExtensionPlugin {
 public:
     void registerTypes(const char* uri) override;
 };
-
-#endif //I3PAGER_PLASMOID_PLUGIN_H

src/workspace.cpp

@@ -1,15 +1,22 @@
+/*  -*- c++ -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
 #include "workspace.h"
+#include "i3pager_debug.h"
 #include <algorithm>
+#include <QDebug>
 
 QList<Workspace> Workspace::filterByCurrentScreen(QList<Workspace> inputWorkspaces, QString currentScreen) {
     QList<Workspace> outputWorkspaces;
-    qDebug() << "Filtering by current screen:" << currentScreen;
+    qCDebug(I3PAGER) << "Filtering by current screen:" << currentScreen;
     for (auto workspace : inputWorkspaces) {
         if (currentScreen == workspace.output) {
-            qDebug() << "Added workspace:" << workspace.name << "output:" << workspace.output;
+            qCDebug(I3PAGER) << "Added workspace:" << workspace.name << "output:" << workspace.output;
             outputWorkspaces.append(workspace);
         } else {
-            qDebug() << "Removed workspace:" << workspace.name << "output:" << workspace.output;
+            qCDebug(I3PAGER) << "Removed workspace:" << workspace.name << "output:" << workspace.output;
         }
     }
     return outputWorkspaces;
@@ -24,11 +31,11 @@ QList<Workspace> Workspace::orderByName(QList<Workspace> inputWorkspaces) {
 
 QList<Workspace> Workspace::orderByOutput(QList<Workspace> inputWorkspaces, QList<QString> outputList) {
     QList<Workspace> outputWorkspaces;
-    qDebug() << "Ordering workspaces by screens:" << outputList;
+    qCDebug(I3PAGER) << "Ordering workspaces by screens:" << outputList;
     for (auto output : outputList) {
         for (auto workspace : inputWorkspaces) {
             if (workspace.output == output) {
-                qDebug() << "Added workspace:" << workspace.name << "output:" << workspace.output;
+                qCDebug(I3PAGER) << "Added workspace:" << workspace.name << "output:" << workspace.output;
                 outputWorkspaces.append(workspace);
             }
         }

src/workspace.h

@@ -1,8 +1,11 @@
-#ifndef WORKSPACE_H
-#define WORKSPACE_H
+/*  -*- c++ -*-
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
 
-#include <QDebug>
-#include <QtCore/QObject>
+#pragma once
+
+#include <QObject>
 
 class Workspace {
     Q_GADGET
@@ -29,5 +32,3 @@ class Workspace {
 };
 
 Q_DECLARE_METATYPE(Workspace)
-
-#endif //WORKSPACE_H