QtCommon: introduce QtCoreUtils::runJobOnMainThread()

Author: HuguesDelorme

src/app/commands_file.cpp

@@ -10,6 +10,7 @@
 #include "../base/task_manager.h"
 #include "../gui/gui_application.h"
 #include "../qtcommon/filepath_conv.h"
+#include "../qtcommon/qtcore_utils.h"
 #include "../qtcommon/qstring_conv.h"
 #include "app_module.h"
 #include "recent_files.h"
@@ -20,7 +21,6 @@
 #include <QtCore/QtDebug>
 #include <QtCore/QElapsedTimer>
 #include <QtCore/QMimeData>
-#include <QtCore/QTimer>
 #include <QtGui/QDragEnterEvent>
 #include <QtGui/QDropEvent>
 #include <QtWidgets/QApplication>
@@ -203,7 +203,7 @@ void FileCommandTools::openDocumentsFromList(IAppContext* context, Span<const Fi
                         .execute();
                 if (okImport) {
                     appModule->emitInfo(fmt::format(Command::textIdTr("Import time: {}ms"), chrono.elapsed()));
-                    QTimer::singleShot(0, context, [=]{
+                    QtCoreUtils::runJobOnMainThread([=]{
                         appModule->prependRecentFile(fp, context->guiApp()->findGuiDocument(newDocId));
                     });
                 }
@@ -234,18 +234,19 @@ void FileCommandTools::importInDocument(
         chrono.start();
 
         auto doc = appModule->application()->findDocumentByIdentifier(targetDocId);
-        const bool okImport = appModule->ioSystem()->importInDocument()
-                                  .targetDocument(doc)
-                                  .withFilepaths(listFilePaths)
-                                  .withParametersProvider(appModule)
-                                  .withEntityPostProcess([=](TDF_Label labelEntity, TaskProgress* progress) {
-                                      appModule->computeBRepMesh(labelEntity, progress);
-                                  })
-                                  .withEntityPostProcessRequiredIf(&IO::formatProvidesBRep)
-                                  .withEntityPostProcessInfoProgress(20, Command::textIdTr("Mesh BRep shapes"))
-                                  .withMessenger(appModule)
-                                  .withTaskProgress(progress)
-                                  .execute();
+        const bool okImport =
+                appModule->ioSystem()->importInDocument()
+                .targetDocument(doc)
+                .withFilepaths(listFilePaths)
+                .withParametersProvider(appModule)
+                .withEntityPostProcess([=](TDF_Label labelEntity, TaskProgress* progress) {
+                    appModule->computeBRepMesh(labelEntity, progress);
+                })
+                .withEntityPostProcessRequiredIf(&IO::formatProvidesBRep)
+                .withEntityPostProcessInfoProgress(20, Command::textIdTr("Mesh BRep shapes"))
+                .withMessenger(appModule)
+                .withTaskProgress(progress)
+                .execute();
         if (okImport)
             appModule->emitInfo(fmt::format(Command::textIdTr("Import time: {}ms"), chrono.elapsed()));
     });

src/app/main.cpp

@@ -28,6 +28,7 @@
 #include "../qtcommon/filepath_conv.h"
 #include "../qtcommon/log_message_handler.h"
 #include "../qtcommon/qstring_conv.h"
+#include "../qtcommon/qtcore_utils.h"
 #include "app_module.h"
 #include "commands_help.h"
 #include "document_tree_node_properties_providers.h"
@@ -46,7 +47,6 @@
 #include <QtCore/QCommandLineParser>
 #include <QtCore/QDir>
 #include <QtCore/QSettings>
-#include <QtCore/QTimer>
 #include <QtCore/QTranslator>
 #include <QtCore/QVersionNumber>
 #include <QtGui/QOffscreenSurface>
@@ -440,7 +440,9 @@ static int runApp(QCoreApplication* qtApp)
     mainWindow.setWindowTitle(QCoreApplication::applicationName());
     mainWindow.show();
     if (!args.listFilepathToOpen.empty()) {
-        QTimer::singleShot(0, qtApp, [&]{ mainWindow.openDocumentsFromList(args.listFilepathToOpen); });
+        QtCoreUtils::runJobOnMainThread([&]{
+            mainWindow.openDocumentsFromList(args.listFilepathToOpen);
+        });
     }
 
     appModule->settings()->resetAll();

src/app/widget_main_control.cpp

@@ -12,6 +12,7 @@
 #include "../gui/gui_application.h"
 #include "../qtcommon/filepath_conv.h"
 #include "../qtcommon/qstring_conv.h"
+#include "../qtcommon/qtcore_utils.h"
 
 #include "app_module.h"
 #include "commands_api.h"
@@ -30,7 +31,6 @@
 #include "widget_properties_editor.h"
 
 #include <QtCore/QDir>
-#include <QtCore/QTimer>
 #include <QtWidgets/QMenu>
 #include <QtWidgets/QMessageBox>
 #include <cassert>
@@ -423,7 +423,7 @@ void WidgetMainControl::onGuiDocumentAdded(GuiDocument* guiDoc)
 
     m_ui->stack_GuiDocuments->addWidget(widget);
     const int newDocIndex = m_guiApp->application()->documentCount() - 1;
-    QTimer::singleShot(0, this, [=]{ this->setCurrentDocumentIndex(newDocIndex); });
+    QtCoreUtils::runJobOnMainThread([=]{ this->setCurrentDocumentIndex(newDocIndex); });
 }
 
 int WidgetMainControl::currentDocumentIndex() const

src/cli/main.cpp

@@ -29,6 +29,7 @@
 #include "../qtcommon/filepath_conv.h"
 #include "../qtcommon/log_message_handler.h"
 #include "../qtcommon/qstring_conv.h"
+#include "../qtcommon/qtcore_utils.h"
 #include "cli_export.h"
 #include "console.h"
 #include <common/mayo_version.h>
@@ -38,7 +39,6 @@
 #include <QtCore/QDir>
 #include <QtCore/QLibraryInfo>
 #include <QtCore/QSettings>
-#include <QtCore/QTimer>
 #include <QtCore/QTranslator>
 
 #include <OpenGl_GraphicDriver.hxx>
@@ -470,7 +470,7 @@ static int runApp(QCoreApplication* qtApp)
         }
     }
     else {
-        QTimer::singleShot(0, qtApp, [=]{
+        QtCoreUtils::runJobOnMainThread([=]{
             CliExportArgs cliArgs;
             cliArgs.progressReport = args.progressReport;
             cliArgs.filesToOpen = args.listFilepathToOpen;

src/qtcommon/qtcore_utils.cpp

@@ -0,0 +1,52 @@
+/****************************************************************************
+** Copyright (c) 2024, Fougue Ltd. <https://www.fougue.pro>
+** All rights reserved.
+** See license at https://github.com/fougue/mayo/blob/master/LICENSE.txt
+****************************************************************************/
+
+#include "qtcore_utils.h"
+
+#include <QtCore/QCoreApplication>
+#include <QtCore/QTimer>
+
+namespace Mayo::QtCoreUtils {
+
+QByteArray QByteArray_frowRawData(const QByteArray& bytes)
+{
+    return QByteArray::fromRawData(bytes.data(), bytes.size());
+}
+
+QByteArray QByteArray_frowRawData(std::string_view str)
+{
+    return QByteArray::fromRawData(str.data(), int(str.size()));
+}
+
+Qt::CheckState toQtCheckState(Mayo::CheckState state)
+{
+    switch (state) {
+    case CheckState::Off: return Qt::Unchecked;
+    case CheckState::Partially: return Qt::PartiallyChecked;
+    case CheckState::On: return Qt::Checked;
+    }
+
+    return Qt::Unchecked;
+}
+
+// Converts Qt::CheckState -> Mayo::CheckState
+Mayo::CheckState toCheckState(Qt::CheckState state)
+{
+    switch (state) {
+    case Qt::Unchecked: return CheckState::Off;
+    case Qt::PartiallyChecked: return CheckState::Partially;
+    case Qt::Checked: return CheckState::On;
+    }
+
+    return CheckState::Off;
+}
+
+void runJobOnMainThread(const std::function<void()>& fn)
+{
+    QTimer::singleShot(0, QCoreApplication::instance(), fn);
+}
+
+} // namespace Mayo::QtCoreUtils

src/qtcommon/qtcore_utils.h

@@ -8,24 +8,17 @@
 
 #include "../base/global.h"
 #include <QtCore/QByteArray>
+#include <functional>
 #include <string_view>
 
-namespace Mayo {
-
 // Provides a collection of tools for the QtCore module
-namespace QtCoreUtils {
+namespace Mayo::QtCoreUtils {
 
 // Convenience function over QByteArray::fromRawData() taking a QByteArray object
-inline QByteArray QByteArray_frowRawData(const QByteArray& bytes)
-{
-    return QByteArray::fromRawData(bytes.data(), bytes.size());
-}
+QByteArray QByteArray_frowRawData(const QByteArray& bytes);
 
 // Convenience function over QByteArray::fromRawData() taking a std::string_view object
-inline QByteArray QByteArray_frowRawData(std::string_view str)
-{
-    return QByteArray::fromRawData(str.data(), int(str.size()));
-}
+QByteArray QByteArray_frowRawData(std::string_view str);
 
 // Convenience function over QByteArray::fromRawData() taking a C array of characters
 template<size_t N>
@@ -35,28 +28,12 @@ QByteArray QByteArray_frowRawData(const char (&str)[N])
 }
 
 // Converts Mayo::CheckState -> Qt::CheckState
-inline Qt::CheckState toQtCheckState(Mayo::CheckState state)
-{
-    switch (state) {
-    case CheckState::Off: return Qt::Unchecked;
-    case CheckState::Partially: return Qt::PartiallyChecked;
-    case CheckState::On: return Qt::Checked;
-    }
-
-    return Qt::Unchecked;
-}
+Qt::CheckState toQtCheckState(Mayo::CheckState state);
 
 // Converts Qt::CheckState -> Mayo::CheckState
-inline Mayo::CheckState toCheckState(Qt::CheckState state)
-{
-    switch (state) {
-    case Qt::Unchecked: return CheckState::Off;
-    case Qt::PartiallyChecked: return CheckState::Partially;
-    case Qt::Checked: return CheckState::On;
-    }
+Mayo::CheckState toCheckState(Qt::CheckState state);
 
-    return CheckState::Off;
-}
+// Enqueues function 'fn' to be executed on main thread
+void runJobOnMainThread(const std::function<void()>& fn);
 
-} // namespace QtCoreUtils
-} // namespace Mayo
+} // namespace Mayo::QtCoreUtils