Struct Type & Editor/Window by Jahorta (#181)

* Implement Struct Type and create Editor/Window for Struct editing/creation

Author: jahorta

Source/CMakeLists.txt

@@ -66,6 +66,12 @@ set(SRCS ${DolphinProcessSrc}
          GUI/MemViewer/MemViewerWidget.cpp
          GUI/MainWindow.cpp
          GUI/Widgets/AddressInputWidget.cpp
+				 GUI/StructEditor/StructEditorWidget.cpp
+				 GUI/StructEditor/StructDetailModel.cpp
+				 GUI/StructEditor/StructSelectModel.cpp
+				 Structs/StructTreeNode.cpp
+				 Structs/StructDef.cpp
+				 Structs/FieldDef.cpp
          Resources/resource.qrc
          ${ExeIconSrc}
          main.cpp)

Source/Common/MemoryCommon.cpp

@@ -73,6 +73,8 @@ size_t getSizeForType(const MemType type, const size_t length)
     return length;
   case MemType::type_byteArray:
     return length;
+  case MemType::type_struct:
+    return length;
   default:
     return 0;
   }
@@ -96,6 +98,8 @@ bool shouldBeBSwappedForType(const MemType type)
     return false;
   case MemType::type_byteArray:
     return false;
+  case MemType::type_struct:
+    return false;
   default:
     return false;
   }
@@ -119,6 +123,8 @@ int getNbrBytesAlignmentForType(const MemType type)
     return 1;
   case MemType::type_byteArray:
     return 1;
+  case MemType::type_struct:
+    return 1;
   default:
     return 1;
   }
@@ -455,6 +461,12 @@ char* formatStringToMemory(MemOperationReturnCode& returnCode, size_t& actualLen
       index++;
     }
     actualLength = bytes.size();
+    break;
+  }
+
+  default:
+  {
+    break;
   }
   }
   return buffer;

Source/Common/MemoryCommon.h

@@ -34,6 +34,8 @@ enum class MemType
   type_double,
   type_string,
   type_byteArray,
+  type_struct,
+  type_none  // Placeholder for the entry of a child node of a collapsed container
 };
 
 enum class MemBase

Source/GUI/GUICommon.cpp

@@ -15,7 +15,8 @@ QStringList g_memTypeNames =
                  QCoreApplication::translate("Common", "Float"),
                  QCoreApplication::translate("Common", "Double"),
                  QCoreApplication::translate("Common", "String"),
-                 QCoreApplication::translate("Common", "Array of bytes")});
+                 QCoreApplication::translate("Common", "Array of bytes"),
+                 QCoreApplication::translate("Common", "Struct")});
 
 QStringList g_memBaseNames = QStringList({QCoreApplication::translate("Common", "Decimal"),
                                           QCoreApplication::translate("Common", "Hexadecimal"),
@@ -46,6 +47,7 @@ QString getStringFromType(const Common::MemType type, const size_t length)
   case Common::MemType::type_word:
   case Common::MemType::type_float:
   case Common::MemType::type_double:
+  case Common::MemType::type_struct:
     return GUICommon::g_memTypeNames.at(static_cast<int>(type));
   case Common::MemType::type_string:
     return QString::fromStdString("string[" + std::to_string(length) + "]");
@@ -73,6 +75,17 @@ QString getNameFromBase(const Common::MemBase base)
   }
 }
 
+bool isContainerType(const Common::MemType type)
+{
+  switch (type)
+  {
+  case Common::MemType::type_struct:
+    return true;
+  default:
+    return false;
+  }
+}
+
 void changeApplicationStyle(const ApplicationStyle style)
 {
   QApplication::setStyle(QStringLiteral("fusion"));

Source/GUI/GUICommon.h

@@ -13,6 +13,7 @@ extern QStringList g_memBaseNames;
 
 QString getStringFromType(Common::MemType type, size_t length = 0);
 QString getNameFromBase(Common::MemBase base);
+bool isContainerType(Common::MemType type);
 
 enum class ApplicationStyle
 {

Source/GUI/MainWindow.cpp

@@ -29,6 +29,7 @@ MainWindow::MainWindow()
   makeMenus();
   DolphinComm::DolphinAccessor::init();
   makeMemViewer();
+  makeStructEditor();
 
   m_autoHookTimer.setInterval(1000);
   connect(&m_autoHookTimer, &QTimer::timeout, this, &MainWindow::onHookIfNotHooked);
@@ -40,20 +41,36 @@ MainWindow::MainWindow()
 
   GUICommon::changeApplicationStyle(
       static_cast<GUICommon::ApplicationStyle>(SConfig::getInstance().getTheme()));
-
   m_actAutoloadLastFile->setChecked(SConfig::getInstance().getAutoloadLastFile());
 
+  // Connect struct updates to mem watch widget
+  connect(m_structEditor, &StructEditorWidget::updateStructName, m_watcher,
+          &MemWatchWidget::onUpdateStructName);
+  connect(m_structEditor, &StructEditorWidget::updateStructDetails, m_watcher,
+          &MemWatchWidget::onUpdateStructDetails);
+  connect(m_structEditor, &StructEditorWidget::structAddedRemoved, m_watcher,
+          &MemWatchWidget::onStructDefAddRemove);
+
+  // Connect load/save structs on load/save watch file
+  connect(m_watcher, &MemWatchWidget::loadStructDefsFromJson, m_structEditor,
+          &StructEditorWidget::readStructTreeFromFile);
+  connect(m_watcher, &MemWatchWidget::writeStructDefTreeToJson, m_structEditor,
+          &StructEditorWidget::writeStructDefTreeToJson);
+
   if (m_actAutoloadLastFile->isChecked() && !SConfig::getInstance().getLastLoadedFile().isEmpty())
   {
     m_watcher->openWatchFile(SConfig::getInstance().getLastLoadedFile());
+    m_watcher->setStructDefs(m_structEditor->getStructDefs(), m_structEditor->getStructMap());
   }
   else
   {
+    m_structEditor->restoreStructTreeFromSettings(SConfig::getInstance().getStructDefs());
+    m_watcher->setStructDefs(m_structEditor->getStructDefs(), m_structEditor->getStructMap());
     m_watcher->restoreWatchModel(SConfig::getInstance().getWatchModel());
   }
 
   m_actCollapseGroupsOnSave->setChecked(SConfig::getInstance().getCollapseGroupsOnSave());
-
+  m_viewer->setStructDefs(m_structEditor->getStructDefs());
   m_actAutoHook->setChecked(SConfig::getInstance().getAutoHook());
 
   if (m_actAutoHook->isChecked())
@@ -67,6 +84,7 @@ MainWindow::~MainWindow()
   delete m_copier;
   delete m_viewer;
   delete m_watcher;
+  delete m_structEditor;
   DolphinComm::DolphinAccessor::free();
 }
 
@@ -105,6 +123,7 @@ void MainWindow::makeMenus()
     QSignalBlocker signalBlocker(m_actScanner);
     m_actScanner->setChecked(m_splitter->sizes()[0] > 0);
   });
+  m_actStructEditor = new QAction(tr("Struct &Editor"), this);
 
   m_actQuit = new QAction(tr("&Quit"), this);
   m_actAbout = new QAction(tr("&About"), this);
@@ -136,6 +155,7 @@ void MainWindow::makeMenus()
   connect(m_actMemoryViewer, &QAction::triggered, this, &MainWindow::onOpenMenViewer);
   connect(m_actCopyMemory, &QAction::triggered, this, &MainWindow::onCopyMemory);
   connect(m_actScanner, &QAction::toggled, this, &MainWindow::onScannerActionToggled);
+  connect(m_actStructEditor, &QAction::triggered, this, &MainWindow::onOpenStructEditor);
 
   connect(m_actQuit, &QAction::triggered, this, &MainWindow::onQuit);
   connect(m_actAbout, &QAction::triggered, this, &MainWindow::onAbout);
@@ -169,6 +189,7 @@ void MainWindow::makeMenus()
   m_menuView->addAction(m_actMemoryViewer);
   m_menuView->addAction(m_actCopyMemory);
   m_menuView->addAction(m_actScanner);
+  m_menuView->addAction(m_actStructEditor);
 
   m_menuHelp = menuBar()->addMenu(tr("&Help"));
   m_menuHelp->addAction(m_actAbout);
@@ -587,6 +608,12 @@ void MainWindow::onQuit()
   close();
 }
 
+void MainWindow::onOpenStructEditor()
+{
+  m_structEditor->show();
+  m_structEditor->raise();
+}
+
 void MainWindow::closeEvent(QCloseEvent* event)
 {
   SConfig::getInstance().setAutoHook(m_actAutoHook->isChecked());
@@ -596,6 +623,7 @@ void MainWindow::closeEvent(QCloseEvent* event)
   if (!m_actAutoloadLastFile->isChecked() || m_watcher->m_watchListFile.isEmpty())
   {
     SConfig::getInstance().setWatchModel(m_watcher->saveWatchModel());
+    SConfig::getInstance().setStructDefs(m_structEditor->saveStructTreeToSettings());
   }
   SConfig::getInstance().setMainWindowGeometry(saveGeometry());
   SConfig::getInstance().setMainWindowState(saveState());
@@ -612,6 +640,7 @@ void MainWindow::closeEvent(QCloseEvent* event)
   }
 
   m_viewer->close();
+  m_structEditor->close();
   event->accept();
 }
 
@@ -719,3 +748,9 @@ void MainWindow::updateStatusBar()
   const QString toolTip{toolTipLines.join("\n\n")};
   m_statusLabel->parentWidget()->setToolTip(toolTip);
 }
+
+void MainWindow::makeStructEditor()
+{
+  m_structEditor = new StructEditorWidget(nullptr);
+  m_structEditor->setWindowIcon(windowIcon());
+}

Source/GUI/MainWindow.h

@@ -13,6 +13,7 @@
 #include "MemScanner/MemScanWidget.h"
 #include "MemViewer/MemViewerWidget.h"
 #include "MemWatcher/MemWatchWidget.h"
+#include "StructEditor/StructEditorWidget.h"
 
 class MainWindow : public QMainWindow
 {
@@ -58,20 +59,23 @@ class MainWindow : public QMainWindow
   void onQuit();
 
   void onAutoLoadLastFileTriggered(bool checked);
+  void onOpenStructEditor();
 
 private:
   void makeMenus();
   void initialiseWidgets();
   void makeLayouts();
   void makeMemViewer();
   void updateStatusBar();
+  void makeStructEditor();
 
   QSplitter* m_splitter{};
 
   MemWatchWidget* m_watcher{};
   MemScanWidget* m_scanner{};
   MemViewerWidget* m_viewer{};
   DlgCopy* m_copier{};
+  StructEditorWidget* m_structEditor{};
 
   QTimer m_autoHookTimer;
 
@@ -95,6 +99,7 @@ class MainWindow : public QMainWindow
   QAction* m_actMemoryViewer{};
   QAction* m_actCopyMemory{};
   QAction* m_actScanner{};
+  QAction* m_actStructEditor{};
   QAction* m_actQuit{};
   QAction* m_actAbout{};
   QLabel* m_statusIcon{};

Source/GUI/MemViewer/MemViewer.cpp

@@ -95,6 +95,11 @@ void MemViewer::memoryValidityChanged(const bool valid)
   viewport()->update();
 }
 
+void MemViewer::setStructDefs(StructTreeNode* baseNode)
+{
+  m_structDefs = baseNode;
+}
+
 void MemViewer::updateMemoryData()
 {
   std::swap(m_updatedRawMemoryData, m_lastRawMemoryData);
@@ -499,7 +504,8 @@ void MemViewer::addByteIndexAsWatch(int index)
 {
   MemWatchEntry* entry = new MemWatchEntry();
   entry->setConsoleAddress(m_currentFirstAddress + index);
-  DlgAddWatchEntry dlg(true, entry, this);
+  DlgAddWatchEntry dlg(true, entry, m_structDefs->getStructNames(), this);
+
   if (dlg.exec() == QDialog::Accepted)
   {
     emit addWatch(dlg.stealEntry());

Source/GUI/MemViewer/MemViewer.h

@@ -12,6 +12,7 @@
 #include "../../Common/CommonTypes.h"
 #include "../../Common/MemoryCommon.h"
 #include "../../MemoryWatch/MemWatchEntry.h"
+#include "../../Structs/StructTreeNode.h"
 
 class MemViewer : public QAbstractScrollArea
 {
@@ -38,6 +39,7 @@ class MemViewer : public QAbstractScrollArea
   void jumpToAddress(u32 address);
   void updateViewer();
   void memoryValidityChanged(bool valid);
+  void setStructDefs(StructTreeNode* baseNode);
 
 signals:
   void memErrorOccured();
@@ -119,4 +121,6 @@ class MemViewer : public QAbstractScrollArea
   QRect* m_curosrRect{};
   QShortcut* m_copyShortcut{};
   QElapsedTimer m_elapsedTimer;
+
+  StructTreeNode* m_structDefs;
 };

Source/GUI/MemViewer/MemViewerWidget.cpp

@@ -105,3 +105,8 @@ void MemViewerWidget::goToAddress(u32 address)
 {
   m_memViewer->jumpToAddress(address);
 }
+
+void MemViewerWidget::setStructDefs(StructTreeNode* baseNode)
+{
+  m_memViewer->setStructDefs(baseNode);
+}