Core qt module for libs (#6278)

* Move logger and key signals from libcockatrice_utility to Cockatrice.

Took 9 minutes

* Only link Qt::Core instead of COCKATRICE_QT_MODULES to libraries, if possible.

Took 2 minutes

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>

cockatrice/src/interface/key_signals.cpp

@@ -0,0 +1,74 @@
+#include "key_signals.h"
+
+#include <QKeyEvent>
+
+bool KeySignals::eventFilter(QObject * /*object*/, QEvent *event)
+{
+    QKeyEvent *kevent;
+
+    if (event->type() != QEvent::KeyPress)
+        return false;
+
+    kevent = static_cast<QKeyEvent *>(event);
+    switch (kevent->key()) {
+        case Qt::Key_Return:
+        case Qt::Key_Enter:
+            if (kevent->modifiers().testFlag(Qt::AltModifier) && kevent->modifiers().testFlag(Qt::ControlModifier))
+                emit onCtrlAltEnter();
+            else if (kevent->modifiers() & Qt::ControlModifier)
+                emit onCtrlEnter();
+            else
+                emit onEnter();
+
+            break;
+        case Qt::Key_Right:
+            if (kevent->modifiers() & Qt::ShiftModifier)
+                emit onShiftRight();
+
+            break;
+        case Qt::Key_Left:
+            if (kevent->modifiers() & Qt::ShiftModifier)
+                emit onShiftLeft();
+
+            break;
+        case Qt::Key_Delete:
+        case Qt::Key_Backspace:
+            emit onDelete();
+
+            break;
+        case Qt::Key_Minus:
+            if (kevent->modifiers().testFlag(Qt::AltModifier) && kevent->modifiers().testFlag(Qt::ControlModifier))
+                emit onCtrlAltMinus();
+
+            break;
+        case Qt::Key_Equal:
+            if (kevent->modifiers().testFlag(Qt::AltModifier) && kevent->modifiers().testFlag(Qt::ControlModifier))
+                emit onCtrlAltEqual();
+
+            break;
+        case Qt::Key_BracketLeft:
+            if (kevent->modifiers().testFlag(Qt::AltModifier) && kevent->modifiers().testFlag(Qt::ControlModifier))
+                emit onCtrlAltLBracket();
+
+            break;
+        case Qt::Key_BracketRight:
+            if (kevent->modifiers().testFlag(Qt::AltModifier) && kevent->modifiers().testFlag(Qt::ControlModifier))
+                emit onCtrlAltRBracket();
+
+            break;
+        case Qt::Key_S:
+            if (kevent->modifiers() & Qt::ShiftModifier)
+                emit onShiftS();
+
+            break;
+        case Qt::Key_C:
+            if (kevent->modifiers() & Qt::ControlModifier)
+                emit onCtrlC();
+
+            break;
+        default:
+            return false;
+    }
+
+    return false;
+}

cockatrice/src/interface/key_signals.h

@@ -0,0 +1,36 @@
+/**
+ * @file key_signals.h
+ * @ingroup Core
+ * @ingroup UI
+ * @brief TODO: Document this.
+ */
+
+#ifndef KEYSIGNALS_H
+#define KEYSIGNALS_H
+
+#include <QEvent>
+#include <QObject>
+
+class KeySignals : public QObject
+{
+    Q_OBJECT
+
+signals:
+    void onEnter();
+    void onCtrlEnter();
+    void onCtrlAltEnter();
+    void onShiftLeft();
+    void onShiftRight();
+    void onDelete();
+    void onCtrlAltMinus();
+    void onCtrlAltEqual();
+    void onCtrlAltLBracket();
+    void onCtrlAltRBracket();
+    void onShiftS();
+    void onCtrlC();
+
+protected:
+    bool eventFilter(QObject *, QEvent *event) override;
+};
+
+#endif

cockatrice/src/interface/logger.cpp

@@ -0,0 +1,146 @@
+#include "logger.h"
+
+#include "version_string.h"
+
+#include <QApplication>
+#include <QDateTime>
+#include <QDebug>
+#include <QLocale>
+#include <QSysInfo>
+#include <iostream>
+
+#define LOGGER_MAX_ENTRIES 128
+#define LOGGER_FILENAME "qdebug.txt"
+
+Logger::Logger() : logToFileEnabled(false)
+{
+    logBuffer.append(getClientVersion());
+    logBuffer.append(getSystemArchitecture());
+    logBuffer.append(getSystemLocale());
+    logBuffer.append(getClientInstallInfo());
+    logBuffer.append(QString("-").repeated(75));
+    std::cerr << getClientVersion().toStdString() << std::endl;
+    std::cerr << getSystemArchitecture().toStdString() << std::endl;
+    std::cerr << getSystemLocale().toStdString() << std::endl;
+    std::cerr << getClientInstallInfo().toStdString() << std::endl;
+}
+
+Logger::~Logger()
+{
+    closeLogfileSession();
+    logBuffer.clear();
+}
+
+void Logger::logToFile(bool enabled)
+{
+    if (enabled) {
+        openLogfileSession();
+    } else {
+        closeLogfileSession();
+    }
+}
+
+QString Logger::getClientVersion()
+{
+    return "Client Version: " + QString::fromStdString(VERSION_STRING);
+}
+
+void Logger::openLogfileSession()
+{
+    if (logToFileEnabled) {
+        return;
+    }
+
+    fileHandle.setFileName(LOGGER_FILENAME);
+    if (!fileHandle.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
+        qWarning() << "Logger failed to open" << LOGGER_FILENAME << "for writing";
+        return;
+    }
+    fileStream.setDevice(&fileHandle);
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 14, 0))
+    fileStream << "Log session started at " << QDateTime::currentDateTime().toString() << Qt::endl;
+    fileStream << getClientVersion() << Qt::endl;
+    fileStream << getSystemArchitecture() << Qt::endl;
+    fileStream << getClientInstallInfo() << Qt::endl;
+#else
+    fileStream << "Log session started at " << QDateTime::currentDateTime().toString() << endl;
+    fileStream << getClientVersion() << endl;
+    fileStream << getSystemArchitecture() << endl;
+    fileStream << getClientInstallInfo() << endl;
+#endif
+    logToFileEnabled = true;
+}
+
+void Logger::closeLogfileSession()
+{
+    if (!logToFileEnabled)
+        return;
+
+    logToFileEnabled = false;
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 14, 0))
+    fileStream << "Log session closed at " << QDateTime::currentDateTime().toString() << Qt::endl;
+#else
+    fileStream << "Log session closed at " << QDateTime::currentDateTime().toString() << endl;
+#endif
+    fileHandle.close();
+}
+
+void Logger::log(QtMsgType /* type */, const QMessageLogContext & /* ctx */, const QString &message)
+{
+    QMetaObject::invokeMethod(this, "internalLog", Qt::QueuedConnection, Q_ARG(const QString &, message));
+}
+
+void Logger::internalLog(const QString &message)
+{
+    QMutexLocker locker(&mutex);
+
+    logBuffer.append(message);
+    if (logBuffer.size() > LOGGER_MAX_ENTRIES) {
+        logBuffer.removeAt(1);
+    }
+
+    emit logEntryAdded(message);
+    std::cerr << message.toStdString() << std::endl; // Print to stdout
+
+    if (logToFileEnabled) {
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 14, 0))
+        fileStream << message << Qt::endl; // Print to fileStream
+#else
+        fileStream << message << endl; // Print to fileStream
+#endif
+    }
+}
+
+QString Logger::getSystemArchitecture()
+{
+    QString result;
+
+    if (!getClientOperatingSystem().isEmpty()) {
+        // We don't want translatable strings in the 'Debug Log' for easier troubleshooting
+        result.append(QString("Client Operating System: ") + getClientOperatingSystem() + "\n");
+    }
+
+    result.append(QString("Build Architecture: ") + QString::fromStdString(BUILD_ARCHITECTURE) + "\n");
+    result.append(QString("Qt Version: ") + QT_VERSION_STR);
+
+    return result;
+}
+
+QString Logger::getClientOperatingSystem()
+{
+    return QSysInfo::prettyProductName();
+}
+
+QString Logger::getSystemLocale()
+{
+    QString result(QString("System Locale: ") + QLocale().name());
+    return result;
+}
+
+QString Logger::getClientInstallInfo()
+{
+    // don't rely on settingsCache->getIsPortableBuild() since the logger is initialized earlier
+    bool isPortable = QFile::exists(qApp->applicationDirPath() + "/portable.dat");
+    QString result(QString("Install Mode: ") + (isPortable ? "Portable" : "Standard"));
+    return result;
+}

cockatrice/src/interface/logger.h

@@ -0,0 +1,72 @@
+/**
+ * @file logger.h
+ * @ingroup Core
+ * @brief TODO: Document this.
+ */
+
+#ifndef LOGGER_H
+#define LOGGER_H
+
+#include <QFile>
+#include <QMutex>
+#include <QString>
+#include <QTextStream>
+#include <QVector>
+
+#if defined(Q_PROCESSOR_X86_32)
+#define BUILD_ARCHITECTURE "32-bit"
+#elif defined(Q_PROCESSOR_X86_64)
+#define BUILD_ARCHITECTURE "64-bit"
+#elif defined(Q_PROCESSOR_ARM)
+#define BUILD_ARCHITECTURE "ARM"
+#else
+#define BUILD_ARCHITECTURE "unknown"
+#endif
+
+class Logger : public QObject
+{
+    Q_OBJECT
+public:
+    static Logger &getInstance()
+    {
+        static Logger instance;
+        return instance;
+    }
+
+    void logToFile(bool enabled);
+    void log(QtMsgType type, const QMessageLogContext &ctx, const QString &message);
+    QString getClientVersion();
+    QString getClientOperatingSystem();
+    QString getSystemArchitecture();
+    QString getSystemLocale();
+    QString getClientInstallInfo();
+    QList<QString> getLogBuffer()
+    {
+        return logBuffer;
+    }
+
+private:
+    Logger();
+    ~Logger() override;
+    // Singleton - Don't implement copy constructor and assign operator
+    Logger(Logger const &);
+    void operator=(Logger const &);
+
+    bool logToFileEnabled;
+    QTextStream fileStream;
+    QFile fileHandle;
+    QList<QString> logBuffer;
+    QMutex mutex;
+
+protected:
+    void openLogfileSession();
+    void closeLogfileSession();
+
+protected slots:
+    void internalLog(const QString &message);
+
+signals:
+    void logEntryAdded(const QString &message);
+};
+
+#endif

cockatrice/src/interface/widgets/deck_editor/deck_editor_database_display_widget.h

@@ -9,13 +9,13 @@
 #define DECK_EDITOR_DATABASE_DISPLAY_WIDGET_H
 
 #include "../../../interface/widgets/tabs/abstract_tab_deck_editor.h"
+#include "../../key_signals.h"
 #include "../utility/custom_line_edit.h"
 
 #include <QHBoxLayout>
 #include <QWidget>
 #include <libcockatrice/models/database/card_database_display_model.h>
 #include <libcockatrice/models/database/card_database_model.h>
-#include <libcockatrice/utility/key_signals.h>
 
 class AbstractTabDeckEditor;
 class DeckEditorDatabaseDisplayWidget : public QWidget

cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.h

@@ -9,6 +9,7 @@
 #define DECK_EDITOR_DECK_DOCK_WIDGET_H
 
 #include "../../../interface/widgets/tabs/abstract_tab_deck_editor.h"
+#include "../../key_signals.h"
 #include "../utility/custom_line_edit.h"
 #include "../visual_deck_storage/deck_preview/deck_preview_deck_tags_display_widget.h"
 
@@ -18,7 +19,6 @@
 #include <QTextEdit>
 #include <QTreeView>
 #include <libcockatrice/card/card_info.h>
-#include <libcockatrice/utility/key_signals.h>
 
 class DeckListModel;
 class AbstractTabDeckEditor;

cockatrice/src/interface/widgets/deck_editor/deck_editor_filter_dock_widget.h

@@ -9,10 +9,10 @@
 #define DECK_EDITOR_FILTER_DOCK_WIDGET_H
 
 #include "../../../interface/widgets/tabs/abstract_tab_deck_editor.h"
+#include "../../key_signals.h"
 
 #include <QDockWidget>
 #include <QTreeView>
-#include <libcockatrice/utility/key_signals.h>
 
 class FilterTreeModel;
 class AbstractTabDeckEditor;

cockatrice/src/interface/widgets/dialogs/dlg_view_log.cpp

@@ -1,12 +1,13 @@
 #include "dlg_view_log.h"
 
+#include "../../logger.h"
+
 #include <QClipboard>
 #include <QPlainTextEdit>
 #include <QPushButton>
 #include <QRegularExpression>
 #include <QVBoxLayout>
 #include <libcockatrice/settings/cache_settings.h>
-#include <libcockatrice/utility/logger.h>
 
 DlgViewLog::DlgViewLog(QWidget *parent) : QDialog(parent)
 {

cockatrice/src/interface/widgets/tabs/tab_deck_editor.h

@@ -1,11 +1,11 @@
 #ifndef WINDOW_DECKEDITOR_H
 #define WINDOW_DECKEDITOR_H
 
+#include "../../key_signals.h"
 #include "../interface/widgets/visual_deck_storage/deck_preview/deck_preview_deck_tags_display_widget.h"
 #include "abstract_tab_deck_editor.h"
 
 #include <libcockatrice/card/card_info.h>
-#include <libcockatrice/utility/key_signals.h>
 
 class CardDatabaseModel;
 class CardDatabaseDisplayModel;

cockatrice/src/interface/widgets/visual_database_display/visual_database_display_widget.h

@@ -9,6 +9,7 @@
 
 #include "../../../filters/filter_tree_model.h"
 #include "../../../interface/widgets/tabs/abstract_tab_deck_editor.h"
+#include "../../key_signals.h"
 #include "../../layouts/flow_layout.h"
 #include "../cards/card_info_picture_with_text_overlay_widget.h"
 #include "../cards/card_size_widget.h"
@@ -30,7 +31,6 @@
 #include <libcockatrice/card/database/card_database.h>
 #include <libcockatrice/models/database/card_database_model.h>
 #include <libcockatrice/models/deck_list/deck_list_model.h>
-#include <libcockatrice/utility/key_signals.h>
 #include <qscrollarea.h>
 
 inline Q_LOGGING_CATEGORY(VisualDatabaseDisplayLog, "visual_database_display");

cockatrice/src/interface/window_main.cpp

@@ -36,6 +36,7 @@
 #include "../interface/widgets/tabs/tab_game.h"
 #include "../interface/widgets/tabs/tab_supervisor.h"
 #include "../main.h"
+#include "logger.h"
 #include "version_string.h"
 #include "widgets/utility/get_text_with_max.h"
 
@@ -71,7 +72,6 @@
 #include <libcockatrice/protocol/pb/game_replay.pb.h>
 #include <libcockatrice/protocol/pb/room_commands.pb.h>
 #include <libcockatrice/settings/cache_settings.h>
-#include <libcockatrice/utility/logger.h>
 
 #define GITHUB_PAGES_URL "https://cockatrice.github.io"
 #define GITHUB_CONTRIBUTORS_URL "https://github.com/Cockatrice/Cockatrice/graphs/contributors?type=c"