Improve the performance and usability of the raw FSD message display

* Replaced QListView with QPlainTextEdit
* Added filter options for packet type and text
* Option to globally disable/enable the feature. Default disabled

Maniphest Tasks: Ref T240

src/blackgui/components/rawfsdmessagescomponent.cpp

@@ -15,6 +15,7 @@
 
 #include <QFileDialog>
 #include <QDir>
+#include <QStringList>
 #include <QtGlobal>
 
 using namespace BlackMisc;
@@ -30,37 +31,145 @@ namespace BlackGui
             QFrame(parent), ui(new Ui::CRawFsdMessagesComponent)
         {
             ui->setupUi(this);
+            ui->cb_FileWritingMode->addItem(QApplication::translate("CRawFsdMessagesComponent", "None", nullptr), QVariant::fromValue(CRawFsdMessageSettings::None));
             ui->cb_FileWritingMode->addItem(QApplication::translate("CRawFsdMessagesComponent", "Truncate", nullptr), QVariant::fromValue(CRawFsdMessageSettings::Truncate));
             ui->cb_FileWritingMode->addItem(QApplication::translate("CRawFsdMessagesComponent", "Append", nullptr), QVariant::fromValue(CRawFsdMessageSettings::Append));
             ui->cb_FileWritingMode->addItem(QApplication::translate("CRawFsdMessagesComponent", "Timestamped", nullptr), QVariant::fromValue(CRawFsdMessageSettings::Timestamped));
 
-            QMetaObject::Connection c = sGui->getIContextNetwork()->connectRawFsdMessageSignal(this, std::bind(&CRawFsdMessagesComponent::addFsdMessage, this, std::placeholders::_1));
-            if (!c)
-            {
-                ui->cb_EnableFileWriting->setEnabled(false);
-                ui->lw_RawFsdMessages->addItem(QStringLiteral("Could not connect to raw FSD message."));
-                ui->lw_RawFsdMessages->addItem(QStringLiteral("This is most likely because core is not running in this process."));
-                ui->lw_RawFsdMessages->addItem(QStringLiteral("Open this component again from the process running core."));
-            }
-            else
-            {
-                m_signalConnections.append(c);
-                readSettings();
-                connect(ui->cb_EnableFileWriting, &QCheckBox::toggled, this, &CRawFsdMessagesComponent::changeWritingToFile);
-                connect(ui->pb_SelectFileDir, &QPushButton::clicked, this, &CRawFsdMessagesComponent::selectFileDir);
-                connect(ui->cb_FileWritingMode, QOverload<int>::of(&QComboBox::currentIndexChanged), this, &CRawFsdMessagesComponent::changeFileWritingMode);
-            }
+            ui->cb_FilterPacketType->addItem("");
+            ui->cb_FilterPacketType->addItems(CRawFsdMessage::getAllPacketTypes());
+            ui->pte_RawFsdMessages->setMaximumBlockCount(m_maxDisplayedMessages);
+            ui->le_MaxDisplayedMessages->setText(QString::number(m_maxDisplayedMessages));
+
+            setupConnections();
+            expandFilters(false);
+            expandWritingToFile(false);
         }
 
         CRawFsdMessagesComponent::~CRawFsdMessagesComponent()
         { }
 
-        void CRawFsdMessagesComponent::changeWritingToFile(bool enable)
+        void CRawFsdMessagesComponent::setupConnections()
         {
+
+            connect(ui->le_FilterText, &QLineEdit::returnPressed, this, &CRawFsdMessagesComponent::changeStringFilter);
+            connect(ui->cb_FilterPacketType, &QComboBox::currentTextChanged, this, &CRawFsdMessagesComponent::changePacketTypeFilter);
+            connect(ui->gb_Filter, &QGroupBox::toggled, this, &CRawFsdMessagesComponent::expandFilters);
+            connect(ui->gb_WriteToFile , &QGroupBox::toggled, this, &CRawFsdMessagesComponent::expandWritingToFile);
+            connect(ui->pb_SelectFileDir, &QPushButton::clicked, this, &CRawFsdMessagesComponent::selectFileDir);
+            connect(ui->le_MaxDisplayedMessages, &QLineEdit::returnPressed, this, &CRawFsdMessagesComponent::changeMaxDisplayedMessages);
+
+            QValidator *validator = new QIntValidator(10, 200, this);
+            ui->le_MaxDisplayedMessages->setValidator(validator);
+
+            using namespace std::placeholders;
+            QMetaObject::Connection c = sGui->getIContextNetwork()->connectRawFsdMessageSignal(this, std::bind(&CRawFsdMessagesComponent::addFsdMessage, this, _1));
+            if (!c)
+            {
+                ui->pte_RawFsdMessages->appendPlainText(QStringLiteral("Could not connect to raw FSD message."));
+                ui->pte_RawFsdMessages->appendPlainText(QStringLiteral("This is most likely because core is not running in this process."));
+                ui->pte_RawFsdMessages->appendPlainText(QStringLiteral("Open this component again from the process running core."));
+                return;
+            }
+            m_signalConnections.append(c);
+
+            readSettings();
+            // Connect them after settings are read. Otherwise they get called.
+            connect(ui->cb_FileWritingMode, QOverload<int>::of(&QComboBox::currentIndexChanged), this, &CRawFsdMessagesComponent::changeFileWritingMode);
+            connect(ui->cb_EnableRawFsdMessages, &QCheckBox::toggled, this, &CRawFsdMessagesComponent::enableRawFsdMessages);
+        }
+
+        void CRawFsdMessagesComponent::enableRawFsdMessages(bool enable)
+        {
+            ui->cb_FilterPacketType->setEnabled(enable);
+            ui->le_FilterText->setEnabled(enable);
+            ui->le_MaxDisplayedMessages->setEnabled(enable);
             ui->le_FileDir->setEnabled(enable);
             ui->pb_SelectFileDir->setEnabled(enable);
             ui->cb_FileWritingMode->setEnabled(enable);
-            m_setting.setProperty(Vatsim::CRawFsdMessageSettings::IndexWriteEnabled, CVariant::fromValue(enable));
+            m_setting.setProperty(Vatsim::CRawFsdMessageSettings::IndexRawFsdMessagesEnabled, CVariant::fromValue(enable));
+        }
+
+        void CRawFsdMessagesComponent::expandFilters(bool expand)
+        {
+            if(expand)
+            {
+                ui->gl_Filters->setHorizontalSpacing(7);
+                ui->gl_Filters->setVerticalSpacing(7);
+                ui->gl_Filters->setContentsMargins(11, 11, 11, 11);
+            }
+            else
+            {
+                ui->gl_Filters->setHorizontalSpacing(0);
+                ui->gl_Filters->setVerticalSpacing(0);
+                ui->gl_Filters->setContentsMargins(0, 0, 0, 0);
+            }
+
+            for(int idx = 0; idx < ui->gl_Filters->count(); idx++)
+            {
+                QLayoutItem * const item = ui->gl_Filters->itemAt(idx);
+                if(item->widget()) { item->widget()->setVisible(expand); }
+            }
+        }
+
+        void CRawFsdMessagesComponent::expandWritingToFile(bool expand)
+        {
+            if(expand)
+            {
+                 ui->gl_WriteToFile->setHorizontalSpacing(7);
+                 ui->gl_WriteToFile->setVerticalSpacing(7);
+                 ui->gl_WriteToFile->setContentsMargins(11, 11, 11, 11);
+            }
+            else
+            {
+                ui->gl_WriteToFile->setHorizontalSpacing(0);
+                ui->gl_WriteToFile->setVerticalSpacing(0);
+                ui->gl_WriteToFile->setContentsMargins(0, 0, 0, 0);
+            }
+
+            for(int idx = 0; idx < ui->gl_WriteToFile->count(); idx++)
+            {
+                QLayoutItem * const item = ui->gl_WriteToFile->itemAt(idx);
+                if(item->widget()) { item->widget()->setVisible(expand); }
+            }
+        }
+
+        void CRawFsdMessagesComponent::changeStringFilter()
+        {
+            m_filterString = ui->le_FilterText->text();
+            filterDisplayedMessages();
+        }
+
+        void CRawFsdMessagesComponent::changePacketTypeFilter(const QString &type)
+        {
+            m_filterPacketType = type;
+            filterDisplayedMessages();
+        }
+
+        void CRawFsdMessagesComponent::changeMaxDisplayedMessages()
+        {
+            int maxDisplayedMessages = 0;
+            bool ok = false;
+            maxDisplayedMessages = ui->le_MaxDisplayedMessages->text().toInt(&ok);
+            if (ok)
+            {
+                m_maxDisplayedMessages = maxDisplayedMessages;
+                filterDisplayedMessages();
+            }
+        }
+
+        void CRawFsdMessagesComponent::filterDisplayedMessages()
+        {
+            CRawFsdMessageList filtered = m_buffer;
+            if (! m_filterString.isEmpty()) { filtered = filtered.findByContainsString(m_filterString); }
+            if (! m_filterPacketType.isEmpty()) { filtered = filtered.findByPacketType(m_filterPacketType); }
+            ui->pte_RawFsdMessages->clear();
+            // Append only the last messages up to maximum display size. Erase everything before.
+            filtered.erase(filtered.begin(), filtered.end() - std::min(filtered.size(), m_maxDisplayedMessages));
+            for (const CRawFsdMessage &rawFsdMessage : filtered)
+            {
+                ui->pte_RawFsdMessages->appendPlainText(rawFsdMessageToString(rawFsdMessage));
+            }
         }
 
         void CRawFsdMessagesComponent::selectFileDir()
@@ -74,38 +183,39 @@ namespace BlackGui
 
         void CRawFsdMessagesComponent::changeFileWritingMode()
         {
-            CRawFsdMessageSettings::FileWriteMode mode = ui->cb_FileWritingMode->currentData().value<CRawFsdMessageSettings::FileWriteMode>();
+            const CRawFsdMessageSettings::FileWriteMode mode = ui->cb_FileWritingMode->currentData().value<CRawFsdMessageSettings::FileWriteMode>();
             m_setting.setProperty(Vatsim::CRawFsdMessageSettings::IndexFileWriteMode, CVariant::fromValue(mode));
         }
 
-        void CRawFsdMessagesComponent::setFileWritingModeFromSettings(CRawFsdMessageSettings::FileWriteMode mode)
-        {
-            ui->cb_FileWritingMode->setCurrentIndex(static_cast<int>(mode));
-        }
-
         void CRawFsdMessagesComponent::addFsdMessage(const CRawFsdMessage &rawFsdMessage)
         {
-            ui->lw_RawFsdMessages->addItem(rawFsdMessage.toQString());
-            ui->lw_RawFsdMessages->scrollToBottom();
+            if (m_buffer.size() == m_maxDisplayedMessages) { m_buffer.pop_front(); }
+            m_buffer.push_back(rawFsdMessage.getRawMessage());
 
-            while (ui->lw_RawFsdMessages->count() > 100)
-            {
-                QListWidgetItem *item = ui->lw_RawFsdMessages->takeItem(0);
-                delete item;
-            }
+            if (! m_filterPacketType.isEmpty() && ! rawFsdMessage.isPacketType(m_filterPacketType)) { return; }
+            if (! m_filterString.isEmpty() && ! rawFsdMessage.containsString(m_filterString)) { return; }
+            ui->pte_RawFsdMessages->appendPlainText(rawFsdMessageToString(rawFsdMessage));
         }
 
         void CRawFsdMessagesComponent::readSettings()
         {
             const Vatsim::CRawFsdMessageSettings setting = m_setting.get();
-            ui->le_FileDir->setText(setting.getFileDir());
-            const bool enable = setting.isFileWritingEnabled();
-            ui->cb_EnableFileWriting->setChecked(enable);
+            const bool enable = setting.areRawFsdMessagesEnabled();
+            ui->cb_EnableRawFsdMessages->setChecked(enable);
+            ui->cb_FilterPacketType->setEnabled(enable);
+            ui->le_FilterText->setEnabled(enable);
+            ui->le_MaxDisplayedMessages->setEnabled(enable);
             ui->le_FileDir->setEnabled(enable);
+            ui->le_FileDir->setText(setting.getFileDir());
             ui->pb_SelectFileDir->setEnabled(enable);
             ui->cb_FileWritingMode->setEnabled(enable);
             const CRawFsdMessageSettings::FileWriteMode mode = setting.getFileWriteMode();
             ui->cb_FileWritingMode->setCurrentIndex(static_cast<int>(mode));
         }
+
+         QString CRawFsdMessagesComponent::rawFsdMessageToString(const BlackMisc::Network::CRawFsdMessage &rawFsdMessage)
+         {
+            return QString("%1 %2").arg(rawFsdMessage.getReceptionTime().toString("HH:mm:ss"), rawFsdMessage.getRawMessage());
+         }
     }
 } // namespace

src/blackgui/components/rawfsdmessagescomponent.h

@@ -14,15 +14,11 @@
 
 #include "blackgui/blackguiexport.h"
 #include "blackcore/vatsim/vatsimsettings.h"
-#include "blackmisc/network/rawfsdmessage.h"
+#include "blackmisc/network/rawfsdmessagelist.h"
 #include "blackmisc/connectionguard.h"
 
 #include <QFrame>
 
-class QAction;
-class QPoint;
-class QWidget;
-
 namespace Ui { class CRawFsdMessagesComponent; }
 namespace BlackGui
 {
@@ -41,17 +37,33 @@ namespace BlackGui
             virtual ~CRawFsdMessagesComponent();
 
         private:
-            void changeWritingToFile(bool enable);
+            void setupConnections();
+            void enableRawFsdMessages(bool enable);
+            void expandFilters(bool expand);
+            void expandWritingToFile(bool expand);
+            void changeStringFilter();
+            void changePacketTypeFilter(const QString &type);
+            void changeMaxDisplayedMessages();
+            void filterDisplayedMessages();
             void selectFileDir();
             void changeFileWritingMode();
-            void setFileWritingModeFromSettings(BlackCore::Vatsim::CRawFsdMessageSettings::FileWriteMode mode);
             void addFsdMessage(const BlackMisc::Network::CRawFsdMessage &rawFsdMessage);
             void readSettings();
 
+            static QString rawFsdMessageToString(const BlackMisc::Network::CRawFsdMessage &rawFsdMessage);
+
             BlackMisc::CSetting<BlackCore::Vatsim::TRawFsdMessageSetting> m_setting { this };
 
             QScopedPointer<Ui::CRawFsdMessagesComponent> ui;
             BlackMisc::CConnectionGuard m_signalConnections;  //!< connected signal/slots
+
+            QString m_filterString;
+            QString m_filterPacketType;
+
+            BlackMisc::Network::CRawFsdMessageList m_buffer;
+
+            int m_maxDisplayedMessages = 100;
+            int m_maxBufferSize = 1000;
         };
     } // ns
 } // ns

src/blackgui/components/rawfsdmessagescomponent.ui

@@ -6,8 +6,8 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>427</width>
-    <height>516</height>
+    <width>458</width>
+    <height>571</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -22,7 +22,7 @@
   <property name="lineWidth">
    <number>0</number>
   </property>
-  <layout class="QGridLayout" name="gridLayout">
+  <layout class="QGridLayout" name="gridLayout" rowstretch="1,0,0,0">
    <property name="leftMargin">
     <number>0</number>
    </property>
@@ -35,19 +35,113 @@
    <property name="bottomMargin">
     <number>0</number>
    </property>
-   <item row="0" column="0">
-    <widget class="QListWidget" name="lw_RawFsdMessages">
-     <property name="selectionMode">
-      <enum>QAbstractItemView::NoSelection</enum>
+   <item row="0" column="0" alignment="Qt::AlignRight">
+    <widget class="QCheckBox" name="cb_EnableRawFsdMessages">
+     <property name="text">
+      <string>Enable</string>
      </property>
     </widget>
    </item>
    <item row="1" column="0">
+    <widget class="QPlainTextEdit" name="pte_RawFsdMessages">
+     <property name="lineWrapMode">
+      <enum>QPlainTextEdit::NoWrap</enum>
+     </property>
+     <property name="readOnly">
+      <bool>true</bool>
+     </property>
+     <property name="maximumBlockCount">
+      <number>100</number>
+     </property>
+    </widget>
+   </item>
+   <item row="2" column="0">
+    <widget class="QGroupBox" name="gb_Filter">
+     <property name="title">
+      <string>Filter</string>
+     </property>
+     <property name="checkable">
+      <bool>true</bool>
+     </property>
+     <property name="checked">
+      <bool>false</bool>
+     </property>
+     <layout class="QGridLayout" name="gl_Filters">
+      <property name="sizeConstraint">
+       <enum>QLayout::SetMinimumSize</enum>
+      </property>
+      <item row="0" column="1">
+       <widget class="QLabel" name="lbl_FilterText">
+        <property name="text">
+         <string>Text:</string>
+        </property>
+       </widget>
+      </item>
+      <item row="1" column="0">
+       <widget class="QComboBox" name="cb_FilterPacketType">
+        <property name="enabled">
+         <bool>false</bool>
+        </property>
+        <property name="toolTip">
+         <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Packet Type Filter&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+        </property>
+       </widget>
+      </item>
+      <item row="1" column="1">
+       <widget class="QLineEdit" name="le_FilterText">
+        <property name="enabled">
+         <bool>false</bool>
+        </property>
+        <property name="toolTip">
+         <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Text Filter&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+        </property>
+        <property name="placeholderText">
+         <string/>
+        </property>
+       </widget>
+      </item>
+      <item row="0" column="0">
+       <widget class="QLabel" name="lbl_FilterPacketType">
+        <property name="text">
+         <string>Type:</string>
+        </property>
+       </widget>
+      </item>
+      <item row="1" column="2">
+       <widget class="QLineEdit" name="le_MaxDisplayedMessages">
+        <property name="enabled">
+         <bool>false</bool>
+        </property>
+        <property name="toolTip">
+         <string>Maximum No. of lines displayed</string>
+        </property>
+        <property name="text">
+         <string/>
+        </property>
+       </widget>
+      </item>
+      <item row="0" column="2">
+       <widget class="QLabel" name="lbl_MaxDisplayedMessages">
+        <property name="text">
+         <string>Max Displayed Messages:</string>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </widget>
+   </item>
+   <item row="3" column="0">
     <widget class="QGroupBox" name="gb_WriteToFile">
      <property name="title">
       <string>Write to File</string>
      </property>
-     <layout class="QGridLayout" name="gridLayout_2">
+     <property name="checkable">
+      <bool>true</bool>
+     </property>
+     <property name="checked">
+      <bool>false</bool>
+     </property>
+     <layout class="QGridLayout" name="gl_WriteToFile">
       <item row="4" column="0">
        <widget class="QLabel" name="lbl_FileDir">
         <property name="text">
@@ -55,13 +149,6 @@
         </property>
        </widget>
       </item>
-      <item row="1" column="1">
-       <widget class="QComboBox" name="cb_FileWritingMode">
-        <property name="enabled">
-         <bool>false</bool>
-        </property>
-       </widget>
-      </item>
       <item row="1" column="0">
        <widget class="QLabel" name="lbl_FileWriteMode">
         <property name="text">
@@ -69,13 +156,6 @@
         </property>
        </widget>
       </item>
-      <item row="1" column="2">
-       <widget class="QCheckBox" name="cb_EnableFileWriting">
-        <property name="text">
-         <string>Enable</string>
-        </property>
-       </widget>
-      </item>
       <item row="4" column="1">
        <widget class="QLineEdit" name="le_FileDir">
         <property name="enabled">
@@ -85,7 +165,7 @@
          <string/>
         </property>
         <property name="readOnly">
-         <bool>false</bool>
+         <bool>true</bool>
         </property>
        </widget>
       </item>
@@ -102,6 +182,13 @@
         </property>
        </widget>
       </item>
+      <item row="1" column="1" colspan="2">
+       <widget class="QComboBox" name="cb_FileWritingMode">
+        <property name="enabled">
+         <bool>false</bool>
+        </property>
+       </widget>
+      </item>
      </layout>
     </widget>
    </item>