Update src/Utilities/QGCLogging.cc

Co-authored-by: Copilot <[email protected]>

Author: HTRamsey

src/Utilities/Platform.cc

@@ -1,22 +1,112 @@
+/****************************************************************************
+ *
+ * (c) 2009-2024 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
+ *
+ * QGroundControl is licensed according to the terms in the file
+ * COPYING.md in the root of the source code directory.
+ *
+ ****************************************************************************/
+
 #include "Platform.h"
 
+#include <QtCore/QCoreApplication>
+
 #ifdef Q_OS_MAC
+
 #include <CoreFoundation/CoreFoundation.h>
 
 void Platform::disableAppNapViaInfoDict()
 {
     CFBundleRef bundle = CFBundleGetMainBundle();
-    if (!bundle) return;
+    if (!bundle) {
+        return;
+    }
 
-    // CFBundleGetInfoDictionary returns the dictionary the OS already
-    // parsed from Info.plist.  Cast it to mutable so we can tweak it.
     CFMutableDictionaryRef infoDict = (CFMutableDictionaryRef) CFBundleGetInfoDictionary(bundle);
-
-    // Inject the key → true
     if (infoDict) {
-        CFDictionarySetValue(infoDict,
-                             CFSTR("NSAppSleepDisabled"),
-                             kCFBooleanTrue);
+        CFDictionarySetValue(infoDict, CFSTR("NSAppSleepDisabled"), kCFBooleanTrue);
+    }
+}
+
+#elif defined(Q_OS_WIN)
+
+#include <qt_windows.h>
+
+#ifdef Q_CC_MSVC
+#include <crtdbg.h>
+
+static int __cdecl WindowsCrtReportHook(int reportType, char *message, int *returnValue)
+{
+    Q_UNUSED(message);
+
+    // For asserts, suppress any interactive break/GUI. Keep process running.
+    if (reportType == _CRT_ASSERT) {
+        if (returnValue) {
+            *returnValue = 0; // continue execution
+        }
+        return TRUE; // handled: no further CRT processing
     }
+
+    // For warnings/errors, let CRT continue with our non-GUI report mode.
+    return FALSE;
 }
+
+#endif
+
+static void WindowsInvalidParameterHandler(const wchar_t *expression,
+                                           const wchar_t *function,
+                                           const wchar_t *file,
+                                           unsigned int line,
+                                           uintptr_t pReserved)
+{
+    Q_UNUSED(expression);
+    Q_UNUSED(function);
+    Q_UNUSED(file);
+    Q_UNUSED(line);
+    Q_UNUSED(pReserved);
+    // Do nothing
+}
+
+static void WindowsSigIntHandler()
+{
+    qDebug() << "Ctrl-C received.";
+    QCoreApplication::quit();
+}
+
+static BOOL WINAPI WindowsConsoleCtrlHandler(DWORD CEvent)
+{
+    switch (CEvent) {
+    case CTRL_C_EVENT:
+        WindowsSigIntHandler();
+        return TRUE;
+    default:
+        break;
+    }
+
+    return FALSE;
+}
+
+void Platform::setWindowsNativeFunctions(bool quietWindowsAsserts)
+{
+    if (quietWindowsAsserts) {
+        (void) _set_invalid_parameter_handler(WindowsInvalidParameterHandler);
+        (void) SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOGPFAULTERRORBOX | SEM_NOOPENFILEERRORBOX);
+#ifdef Q_CC_MSVC
+        (void) _CrtSetReportMode(_CRT_ASSERT, _CRTDBG_MODE_DEBUG);
+        (void) _CrtSetReportHook2(_CRT_RPTHOOK_INSTALL, WindowsCrtReportHook);
+#endif
+    }
+
+    (void) SetConsoleCtrlHandler((PHANDLER_ROUTINE) WindowsConsoleCtrlHandler, TRUE);
+
+    // TODO: Consider SetUnhandledExceptionFilter(windowsFaultHandler), _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT), etc.
+    // (void) _CrtSetReportMode(_CRT_ASSERT, _CRTDBG_MODE_FILE);
+    // (void) _CrtSetReportFile(_CRT_ASSERT, _CRTDBG_FILE_STDERR);
+    // (void) _CrtSetReportMode(_CRT_ERROR, _CRTDBG_MODE_FILE);
+    // (void) _CrtSetReportFile(_CRT_ERROR, _CRTDBG_FILE_STDERR);
+    // (void) _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_DEBUG);
+    // (void) _CrtSetReportFile(_CRT_WARN, _CRTDBG_FILE_STDERR);
+    // (void) _CrtSetReportHook2(_CRT_RPTHOOK_REMOVE, WindowsCrtReportHook);
+}
+
 #endif

src/Utilities/Platform.h

@@ -1,11 +1,20 @@
+/****************************************************************************
+ *
+ * (c) 2009-2024 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
+ *
+ * QGroundControl is licensed according to the terms in the file
+ * COPYING.md in the root of the source code directory.
+ *
+ ****************************************************************************/
+
 #pragma once
 
 #include <QtCore/QtSystemDetection>
 
 namespace Platform {
 #ifdef Q_OS_MAC
-    /// Prevent Apple's app nap from screwing us over
-    /// tip: the domain can be cross-checked on the command line with <defaults domains>
     void disableAppNapViaInfoDict();
+#elif defined(Q_OS_WIN)
+    void setWindowsNativeFunctions(bool quietWindowsAsserts);
 #endif
 }

src/Utilities/QGCLogging.cc

@@ -12,6 +12,7 @@
 #include "QGCApplication.h"
 #include "QGCLoggingCategory.h"
 #include "SettingsManager.h"
+#include "Platform.h"
 
 #include <QtConcurrent/QtConcurrentRun>
 #include <QtCore/QGlobalStatic>
@@ -20,51 +21,6 @@
 
 QGC_LOGGING_CATEGORY(QGCLoggingLog, "qgc.utilities.qgclogging")
 
-#ifdef Q_OS_WIN
-
-#include <crtdbg.h>
-#include <windows.h>
-#include <iostream>
-
-/// CRT Report Hook installed using _CrtSetReportHook. We install this hook when
-/// we don't want asserts to pop a dialog on windows.
-static int __cdecl WindowsCrtReportHook(int reportType, char *message, int *returnValue)
-{
-    int nRet = FALSE;
-
-    printf("CRT report hook 1.\n");
-    printf("CRT report type is \"");
-
-    switch (reportType) {
-        case _CRT_ASSERT:
-            printf("_CRT_ASSERT");
-            // nRet = TRUE;   // Always stop for this type of report
-            break;
-        case _CRT_WARN:
-            printf("_CRT_WARN");
-            break;
-        case _CRT_ERROR:
-            printf("_CRT_ERROR");
-            break;
-        default:
-            printf("???Unknown???");
-            break;
-    }
-
-    printf("\".\nCRT report message is:\n\t");
-    printf("%s", message);
-
-    std::cerr << message << std::endl;
-
-    if (returnValue) {
-        *returnValue = 0;
-    }
-
-    return nRet;
-}
-
-#endif
-
 Q_GLOBAL_STATIC(QGCLogging, _qgcLogging)
 
 static QtMessageHandler defaultHandler = nullptr;
@@ -114,16 +70,8 @@ QGCLogging::~QGCLogging()
     qCDebug(QGCLoggingLog) << this;
 }
 
-void QGCLogging::installHandler(bool quietWindowsAsserts)
+void QGCLogging::installHandler()
 {
-#ifdef Q_OS_WIN
-    if (quietWindowsAsserts) {
-        _CrtSetReportHook(WindowsCrtReportHook);
-    }
-#else
-    Q_UNUSED(quietWindowsAsserts)
-#endif
-
     // Define the format for qDebug/qWarning/etc output
     qSetMessagePattern(QStringLiteral("%{category}:: %{time process} - %{type}: %{message} (%{function}:%{line})"));
 

src/Utilities/QGCLogging.h

@@ -28,7 +28,7 @@ class QGCLogging : public QStringListModel
     static QGCLogging *instance();
 
     /// Install Qt message handler to route logs through this class
-    static void installHandler(bool quietWindowsAsserts);
+    static void installHandler();
 
     /// Write current log messages to a file asynchronously
     Q_INVOKABLE void writeMessages(const QString &destFile);

src/main.cc

@@ -17,10 +17,6 @@
 #include "MavlinkSettings.h"
 #include "Platform.h"
 
-#ifdef Q_OS_WIN
-    #include <windows.h>
-#endif
-
 #if !defined(Q_OS_ANDROID) && !defined(Q_OS_IOS)
     #include <QtWidgets/QMessageBox>
     #include "RunGuard.h"
@@ -75,6 +71,17 @@ int main(int argc, char *argv[])
 
     ParseCmdLineOptions(argc, argv, rgCmdLineOptions, std::size(rgCmdLineOptions), false);
 
+#ifdef QGC_UNITTEST_BUILD
+    if (stressUnitTests) {
+        runUnitTests = true;
+    }
+#ifdef Q_OS_WIN
+    if (runUnitTests) {
+        quietWindowsAsserts = true;
+    }
+#endif
+#endif
+
 #if !defined(Q_OS_ANDROID) && !defined(Q_OS_IOS)
     // We make the runguard key different for custom and non custom
     // builds, so they can be executed together in the same device.
@@ -114,23 +121,19 @@ int main(int argc, char *argv[])
     }
 #endif
 
+#ifdef Q_OS_MACOS
+    Platform::disableAppNapViaInfoDict();
+#endif
+
 #ifdef Q_OS_WIN
     if (!qEnvironmentVariableIsSet("QT_WIN_DEBUG_CONSOLE")) {
         (void) qputenv("QT_WIN_DEBUG_CONSOLE", "attach"); // new
     }
-#endif
-
-    QGCLogging::installHandler(quietWindowsAsserts);
 
-#ifdef QGC_UNITTEST_BUILD
-    if (stressUnitTests) {
-        runUnitTests = true;
-    }
+    Platform::setWindowsNativeFunctions(quietWindowsAsserts);
 #endif
 
-#ifdef Q_OS_MACOS
-    Platform::disableAppNapViaInfoDict();
-#endif
+    QGCLogging::installHandler();
 
 #ifdef Q_OS_WIN
     // Set our own OpenGL buglist
@@ -147,18 +150,7 @@ int main(int argc, char *argv[])
             break;
         }
     }
-
-#ifdef QGC_UNITTEST_BUILD
-    if (runUnitTests) {
-        // Don't pop up Windows Error Reporting dialog when app crashes.
-        const DWORD dwMode = SetErrorMode(SEM_NOGPFAULTERRORBOX);
-        SetErrorMode(dwMode | SEM_NOGPFAULTERRORBOX);
-        (void) _CrtSetReportMode(_CRT_ASSERT, _CRTDBG_MODE_DEBUG);
-        (void) _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_DEBUG);
-        (void) _CrtSetReportMode(_CRT_ERROR, _CRTDBG_MODE_DEBUG);
-    }
 #endif
-#endif // Q_OS_WIN
 
     QGCApplication app(argc, argv, runUnitTests, simpleBootTest);