Implementation of global messages

Jamulus.pro

@@ -366,6 +366,7 @@ FORMS_GUI = src/aboutdlgbase.ui \
 HEADERS += src/buffer.h \
     src/channel.h \
     src/global.h \
+    src/messages.h \
     src/protocol.h \
     src/recorder/jamcontroller.h \
     src/threadpool.h \
@@ -477,6 +478,7 @@ HEADERS_OPUS_X86 = libs/opus/celt/x86/celt_lpc_sse.h \
 SOURCES += src/buffer.cpp \
     src/channel.cpp \
     src/main.cpp \
+    src/messages.cpp \
     src/protocol.cpp \
     src/recorder/jamcontroller.cpp \
     src/server.cpp \

src/main.cpp

@@ -26,9 +26,9 @@
 #include <QDir>
 #include <iostream>
 #include "global.h"
+#include "messages.h"
 #ifndef HEADLESS
 #    include <QApplication>
-#    include <QMessageBox>
 #    include "serverdlg.h"
 #    ifndef SERVER_ONLY
 #        include "clientdlg.h"
@@ -57,7 +57,7 @@ extern void qt_set_sequence_auto_mnemonic ( bool bEnable );
 
 int main ( int argc, char** argv )
 {
-
+    int exit_code = 0;
 #if defined( Q_OS_MACX )
     // Mnemonic keys are default disabled in Qt for MacOS. The following function enables them.
     // Qt will not show these with underline characters in the GUI on MacOS. (#1873)
@@ -901,20 +901,29 @@ int main ( int argc, char** argv )
                                        bEnableIPv6,
                                        nullptr );
 
+                // initialise message boxes
+                CMessages::init ( &ClientDlg, strClientName.isEmpty() ? QString ( APP_NAME ) : QString ( APP_NAME ) + " " + strClientName );
+
                 // show dialog
                 ClientDlg.show();
-                pApp->exec();
+                exit_code = pApp->exec();
             }
             else
 #    endif
             {
                 // only start application without using the GUI
                 qInfo() << qUtf8Printable ( GetVersionAndNameStr ( false ) );
 
-                pApp->exec();
+                // initialise message boxes
+                CMessages::init ( NULL, strClientName.isEmpty() ? QString ( APP_NAME ) : QString ( APP_NAME ) + " " + strClientName );
+
+                exit_code = pApp->exec();
             }
         }
         else
+#else
+        Q_UNUSED ( bUseTranslation )
+        Q_UNUSED ( bNoAutoJackConnect )
 #endif
         {
             // Server:
@@ -961,13 +970,16 @@ int main ( int argc, char** argv )
                 // GUI object for the server
                 CServerDlg ServerDlg ( &Server, &Settings, bStartMinimized, nullptr );
 
+                // initialise message boxes
+                CMessages::init ( &ServerDlg, strClientName.isEmpty() ? QString ( APP_NAME ) : QString ( APP_NAME ) + " " + strClientName );
+
                 // show dialog (if not the minimized flag is set)
                 if ( !bStartMinimized )
                 {
                     ServerDlg.show();
                 }
 
-                pApp->exec();
+                exit_code = pApp->exec();
             }
             else
 #endif
@@ -982,32 +994,33 @@ int main ( int argc, char** argv )
                     Server.SetDirectoryType ( AT_CUSTOM );
                 }
 
-                pApp->exec();
+                // initialise message boxes
+                CMessages::init ( NULL, strClientName.isEmpty() ? QString ( APP_NAME ) : QString ( APP_NAME ) + " " + strClientName );
+
+                exit_code = pApp->exec();
             }
         }
     }
 
     catch ( const CGenErr& generr )
     {
         // show generic error
-#ifndef HEADLESS
-        if ( bUseGUI )
-        {
-            QMessageBox::critical ( nullptr, APP_NAME, generr.GetErrorText(), "Quit", nullptr );
-        }
-        else
-#endif
-        {
-            qCritical() << qUtf8Printable ( QString ( "%1: %2" ).arg ( APP_NAME ).arg ( generr.GetErrorText() ) );
-            exit ( 1 );
-        }
+        CMessages::ShowErrorWait ( generr.GetErrorText(), QObject::tr ( "Exit" ) );
+        exit_code = 1;
+    }
+
+    catch ( ... )
+    {
+        // show generic error
+        CMessages::ShowErrorWait ( QObject::tr ( "Unhandled exception !" ), QObject::tr ( "Exit" ) );
+        exit_code = -1;
     }
 
 #if defined( Q_OS_MACX )
     activity.EndActivity();
 #endif
 
-    return 0;
+    return exit_code;
 }
 
 /******************************************************************************\

src/messages.cpp

@@ -0,0 +1,190 @@
+/******************************************************************************\
+ * Copyright (c) 2022
+ *
+ * Author(s):
+ *  Peter Goderie (pgScorpio)
+ *
+ ******************************************************************************
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 2 of the License, or (at your option) any later
+ * version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ *
+\******************************************************************************/
+
+#include "messages.h"
+
+#ifndef HEADLESS
+#    include <QTextEdit>
+#endif
+
+tMainform* CMessages::pMainForm = NULL;
+QString    CMessages::strMainFormName;
+
+QString CMessages::ToUtf8Printable ( const QString& text )
+{
+    QString plainText;
+
+#ifndef HEADLESS
+    {
+        QTextEdit textEdit;
+
+        textEdit.setText ( text );          // Text can be html...
+        plainText = textEdit.toPlainText(); // Text will be plain Text !
+    }
+#else
+    plainText = text;
+    // Remove htmlBold
+    plainText.replace ( "<b>", "" );
+    plainText.replace ( "</b>", "" );
+    // Translate htmlNewLine
+    plainText.replace ( "<br>", "\n" );
+
+    // no multiple newlines
+    while ( plainText.contains ( "\n\n" ) )
+    {
+        plainText.replace ( "\n\n", "\n" );
+    }
+#endif
+
+#ifdef _WIN32
+    // LF to CRLF
+    plainText.replace ( "\n", "\r\n" );
+#endif
+
+    return qUtf8Printable ( plainText );
+}
+
+/******************************************************************************\
+* Message Boxes                                                                *
+\******************************************************************************/
+
+void CMessages::ShowError ( QString strError )
+{
+#ifndef HEADLESS
+    QMessageBox::critical ( pMainForm, strMainFormName + ": " + QObject::tr ( "Error" ), strError, QObject::tr ( "Ok" ), nullptr );
+#else
+    qCritical().noquote() << "Error: " << ToUtf8Printable ( strError );
+#endif
+}
+
+void CMessages::ShowWarning ( QString strWarning )
+{
+#ifndef HEADLESS
+    QMessageBox::warning ( pMainForm, strMainFormName + ": " + QObject::tr ( "Warning" ), strWarning, QObject::tr ( "Ok" ), nullptr );
+#else
+    qWarning().noquote() << "Warning: " << ToUtf8Printable ( strWarning );
+#endif
+}
+
+void CMessages::ShowInfo ( QString strInfo )
+{
+#ifndef HEADLESS
+    QMessageBox::information ( pMainForm, strMainFormName + ": " + QObject::tr ( "Information" ), strInfo, QObject::tr ( "Ok" ), nullptr );
+#else
+    qInfo().noquote() << "Info: " << ToUtf8Printable ( strInfo );
+#endif
+}
+
+bool CMessages::ShowErrorWait ( QString strError, const QString strActionButtonText, const QString strAbortButtonText, bool bDefault )
+{
+#ifndef HEADLESS
+    QMessageBox  msgBox ( pMainForm );
+    QPushButton* actionButton = msgBox.addButton ( strActionButtonText, QMessageBox::ActionRole );
+    QPushButton* abortButton  = NULL;
+    if ( !strAbortButtonText.isEmpty() )
+    {
+        abortButton = msgBox.addButton ( strAbortButtonText, QMessageBox::ActionRole );
+        if ( bDefault )
+        {
+            msgBox.setDefaultButton ( actionButton );
+        }
+        else
+        {
+            msgBox.setDefaultButton ( abortButton );
+        }
+    }
+
+    msgBox.setIcon ( QMessageBox::Icon::Critical );
+    msgBox.setWindowTitle ( strMainFormName + ": " + QObject::tr ( "Error" ) );
+    msgBox.setText ( strError );
+    return ( msgBox.exec() == 0 );
+#else
+    Q_UNUSED ( strActionButtonText )
+    Q_UNUSED ( strAbortButtonText )
+    qCritical().noquote() << "Error: " << ToUtf8Printable ( strError );
+    return bDefault;
+#endif
+}
+
+bool CMessages::ShowWarningWait ( QString strWarning, const QString strActionButtonText, const QString strAbortButtonText, bool bDefault )
+{
+#ifndef HEADLESS
+    QMessageBox  msgBox ( pMainForm );
+    QPushButton* actionButton = msgBox.addButton ( strActionButtonText, QMessageBox::ActionRole );
+    QPushButton* abortButton  = NULL;
+    if ( !strAbortButtonText.isEmpty() )
+    {
+        abortButton = msgBox.addButton ( strAbortButtonText, QMessageBox::ActionRole );
+        if ( bDefault )
+        {
+            msgBox.setDefaultButton ( actionButton );
+        }
+        else
+        {
+            msgBox.setDefaultButton ( abortButton );
+        }
+    }
+
+    msgBox.setIcon ( QMessageBox::Icon::Warning );
+    msgBox.setWindowTitle ( strMainFormName + ": " + QObject::tr ( "Warning" ) );
+    msgBox.setText ( strWarning );
+    return ( msgBox.exec() == 0 );
+#else
+    Q_UNUSED ( strActionButtonText )
+    Q_UNUSED ( strAbortButtonText )
+    qWarning().noquote() << "Warning: " << ToUtf8Printable ( strWarning );
+    return bDefault;
+#endif
+}
+
+bool CMessages::ShowInfoWait ( QString strInfo, const QString strActionButtonText, const QString strAbortButtonText, bool bDefault )
+{
+#ifndef HEADLESS
+    QMessageBox  msgBox ( pMainForm );
+    QPushButton* actionButton = msgBox.addButton ( strActionButtonText, QMessageBox::ActionRole );
+    QPushButton* abortButton  = NULL;
+    if ( !strAbortButtonText.isEmpty() )
+    {
+        abortButton = msgBox.addButton ( strAbortButtonText, QMessageBox::ActionRole );
+        if ( bDefault )
+        {
+            msgBox.setDefaultButton ( actionButton );
+        }
+        else
+        {
+            msgBox.setDefaultButton ( abortButton );
+        }
+    }
+
+    msgBox.setIcon ( QMessageBox::Icon::Warning );
+    msgBox.setWindowTitle ( strMainFormName + ": " + QObject::tr ( "Info" ) );
+    msgBox.setText ( strInfo );
+    return ( msgBox.exec() == 0 );
+#else
+    Q_UNUSED ( strActionButtonText )
+    Q_UNUSED ( strAbortButtonText )
+    qInfo().noquote() << "Info: " << ToUtf8Printable ( strInfo );
+    return bDefault;
+#endif
+}

src/messages.h

@@ -0,0 +1,71 @@
+#pragma once
+
+/******************************************************************************\
+ * Copyright (c) 2022
+ * Author(s):
+ *  Peter Goderie (pgScorpio)
+ *
+ *  Use this static class to show basic Error, Warning and Info messages
+ *
+ *  For own created special message boxes you should always use
+ *      CMessages::MainForm() as parent parameter
+ *  and CMessages::MainFormName() as base of the title parameter
+\******************************************************************************/
+
+#include <QString>
+#ifndef HEADLESS
+#    include <QMessageBox>
+#    define tMainform QDialog
+#else
+#    include <QDebug>
+#    define tMainform void
+#endif
+
+// html text macro's (for use in message texts)
+#define htmlBold( T ) "<b>" + T + "</b>"
+#define htmlNewLine() "<br>"
+
+class CMessages
+{
+protected:
+    static tMainform* pMainForm;
+    static QString    strMainFormName;
+
+public:
+    static QString ToUtf8Printable ( const QString& text ); // Converts html to plain utf8 text
+
+    static void init ( tMainform* theMainForm, QString theMainFormName )
+    {
+        pMainForm       = theMainForm;
+        strMainFormName = theMainFormName;
+    }
+
+    static tMainform*     MainForm() { return pMainForm; }
+    static const QString& MainFormName() { return strMainFormName; }
+
+    static void ShowError ( QString strError );
+    static void ShowWarning ( QString strWarning );
+    static void ShowInfo ( QString strInfo );
+
+    // Modal message boxes (wait for user confirmation in gui mode)
+    // Returns true if action button is pressed
+    // Returns false if abort button is pressed
+    //
+    // NOTE: The abort button is only present if a non empty strAbortButtonText is given
+    //       if this is the case bDefault pre-selects the default Button.
+    //
+    // NOTE: In HEADLESS mode there is NO wait and always bDefault is returned.
+
+    static bool ShowErrorWait ( QString       strError,
+                                const QString strActionButtonText = "Ok",
+                                const QString strAbortButtonText  = "",
+                                bool          bDefault            = true );
+    static bool ShowWarningWait ( QString       strWarning,
+                                  const QString strActionButtonText = "Ok",
+                                  const QString strAbortButtonText  = "",
+                                  bool          bDefault            = true );
+    static bool ShowInfoWait ( QString       strInfo,
+                               const QString strActionButtonText = "Ok",
+                               const QString strAbortButtonText  = "",
+                               bool          bDefault            = true );
+};