Pass mutex to tools window (unsafe reads, safe writes)

Author: jcm93

Diff for: desktop-ui/desktop-ui.cpp

@@ -156,10 +156,10 @@ auto nall::main(Arguments arguments) -> void {
 
   Instances::presentation.construct();
   Instances::settingsWindow.construct();
-  Instances::toolsWindow.construct();
   Instances::gameBrowserWindow.construct();
 
   program.create();
+  Instances::toolsWindow.construct(&program.programMutex);
   Application::onMain({&Program::main, &program});
   Application::run();
 

Diff for: desktop-ui/tools/cheats.cpp

@@ -16,14 +16,16 @@ auto CheatEditor::Cheat::update(string description, string code, bool enabled) -
   return *this;
 }
 
-auto CheatEditor::construct() -> void {
+auto CheatEditor::construct(std::recursive_mutex *programMutexIn) -> void {
+  this->programMutex = programMutexIn;
   setCollapsible();
   setVisible(false);
   cheatsLabel.setText("Cheats").setFont(Font().setBold());
 
   descriptionLabel.setText("Description:");
   codeLabel.setText("Code:");
   deleteButton.setText("Delete").onActivate([&] {
+    lock_guard<recursive_mutex> lock(*programMutex);
     if(auto item = cheatList.selected()) {
       if(auto cheat = item.attribute<Cheat*>("cheat")) {
         if(auto c = cheats.find([cheat](auto& c) { return &c == cheat; })) {
@@ -38,6 +40,7 @@ auto CheatEditor::construct() -> void {
   }).setEnabled(false);
 
   saveButton.setText("Save").onActivate([&] {
+    lock_guard<recursive_mutex> lock(*programMutex);
     string description = descriptionEdit.text();
     string code = codeEdit.text();
 
@@ -51,6 +54,7 @@ auto CheatEditor::construct() -> void {
   });
 
   cheatList.onToggle([&](auto cell) {
+    lock_guard<recursive_mutex> lock(*programMutex);
     if(auto item = cheatList.selected()) {
       if(auto cheat = item.attribute<Cheat*>("cheat")) {
         cheat->enabled = cell.checked();
@@ -59,6 +63,7 @@ auto CheatEditor::construct() -> void {
   });
 
   cheatList.onChange([&] {
+    lock_guard<recursive_mutex> lock(*programMutex);
     deleteButton.setEnabled(false);
     descriptionEdit.setText("");
     codeEdit.setText("");
@@ -74,6 +79,7 @@ auto CheatEditor::construct() -> void {
 }
 
 auto CheatEditor::reload() -> void {
+  lock_guard<recursive_mutex> lock(*programMutex);
   cheats.reset();
 
   location = emulator->locate(emulator->game->location, {".cheats.bml"});
@@ -92,6 +98,7 @@ auto CheatEditor::reload() -> void {
 }
 
 auto CheatEditor::refresh() -> void {
+  lock_guard<recursive_mutex> lock(*programMutex);
   cheatList.reset();
   cheatList.setHeadered();
   cheatList.append(TableViewColumn());
@@ -111,6 +118,7 @@ auto CheatEditor::refresh() -> void {
 }
 
 auto CheatEditor::unload() -> void {
+  lock_guard<recursive_mutex> lock(*programMutex);
   bool hasCheats = cheats.size() > 0;
   bool isCheatLocation = location.endsWith(".cheats.bml");
 
@@ -137,6 +145,7 @@ auto CheatEditor::unload() -> void {
 }
 
 auto CheatEditor::find(uint address) -> maybe<u32> {
+  lock_guard<recursive_mutex> lock(*programMutex);
   for(auto& cheat : cheats) {
     if(!cheat.enabled) continue;
     if(auto result = cheat.addressValuePairs.find(address)) return result();

Diff for: desktop-ui/tools/graphics.cpp

@@ -1,4 +1,5 @@
-auto GraphicsViewer::construct() -> void {
+auto GraphicsViewer::construct(std::recursive_mutex *programMutexIn) -> void {
+  this->programMutex = programMutexIn;
   setCollapsible();
   setVisible(false);
 

Diff for: desktop-ui/tools/memory.cpp

@@ -1,4 +1,5 @@
-auto MemoryEditor::construct() -> void {
+auto MemoryEditor::construct(std::recursive_mutex *programMutexIn) -> void {
+  this->programMutex = programMutexIn;
   setCollapsible();
   setVisible(false);
 
@@ -8,11 +9,13 @@ auto MemoryEditor::construct() -> void {
   memoryEditor.setRows(24);
 
   exportButton.setText("Export").onActivate([&] {
+    lock_guard<recursive_mutex> lock(*programMutex);
     eventExport();
   });
 
   gotoLabel.setText("Goto:");
   gotoAddress.setFont(Font().setFamily(Font::Mono)).onActivate([&] {
+    lock_guard<recursive_mutex> lock(*programMutex);
     auto address = gotoAddress.text().hex();
     memoryEditor.setAddress(address);
     gotoAddress.setText();
@@ -21,6 +24,7 @@ auto MemoryEditor::construct() -> void {
   liveOption.setText("Live");
 
   refreshButton.setText("Refresh").onActivate([&] {
+    lock_guard<recursive_mutex> lock(*programMutex);
     memoryEditor.update();
   });
 }
@@ -58,6 +62,7 @@ auto MemoryEditor::eventChange() -> void {
         return memory->read(address);
       });
       memoryEditor.onWrite([=](u32 address, u8 data) -> void {
+        lock_guard<recursive_mutex> lock(*programMutex);
         return memory->write(address, data);
       });
     }
@@ -71,6 +76,7 @@ auto MemoryEditor::eventChange() -> void {
 }
 
 auto MemoryEditor::eventExport() -> void {
+  lock_guard<recursive_mutex> lock(*programMutex);
   if(auto item = memoryList.selected()) {
     if(auto memory = item.attribute<ares::Node::Debugger::Memory>("node")) {
       auto identifier = memory->name().downcase().replace(" ", "-");

Diff for: desktop-ui/tools/tools.cpp

@@ -17,7 +17,7 @@ StreamManager& streamManager = toolsWindow.streamManager;
 PropertiesViewer& propertiesViewer = toolsWindow.propertiesViewer;
 TraceLogger& traceLogger = toolsWindow.traceLogger;
 
-ToolsWindow::ToolsWindow() {
+ToolsWindow::ToolsWindow(std::recursive_mutex *programMutex) {
 
   panelList.append(ListViewItem().setText("Manifest").setIcon(Icon::Emblem::Binary));
   panelList.append(ListViewItem().setText("Cheats").setIcon(Icon::Emblem::Text));
@@ -43,9 +43,9 @@ ToolsWindow::ToolsWindow() {
   panelContainer.append(homePanel, Size{~0, ~0});
 
   manifestViewer.construct();
-  cheatEditor.construct();
-  memoryEditor.construct();
-  graphicsViewer.construct();
+  cheatEditor.construct(programMutex);
+  memoryEditor.construct(programMutex);
+  graphicsViewer.construct(programMutex);
   streamManager.construct();
   propertiesViewer.construct();
   traceLogger.construct();

Diff for: desktop-ui/tools/tools.hpp

@@ -12,13 +12,15 @@ struct ManifestViewer : VerticalLayout {
 };
 
 struct CheatEditor : VerticalLayout {
-  auto construct() -> void;
+  auto construct(std::recursive_mutex *programMutex) -> void;
   auto reload() -> void;
   auto unload() -> void;
   auto refresh() -> void;
   auto setVisible(bool visible = true) -> CheatEditor&;
 
   auto find(u32 address) -> maybe<u32>;
+  
+  std::recursive_mutex *programMutex;
 
   Label cheatsLabel{this, Size{~0, 0}, 5};
   HorizontalLayout editLayout{this, Size{~0, 0}};
@@ -47,14 +49,16 @@ struct CheatEditor : VerticalLayout {
 };
 
 struct MemoryEditor : VerticalLayout {
-  auto construct() -> void;
+  auto construct(std::recursive_mutex *programMutex) -> void;
   auto reload() -> void;
   auto unload() -> void;
   auto refresh() -> void;
   auto liveRefresh() -> void;
   auto eventChange() -> void;
   auto eventExport() -> void;
   auto setVisible(bool visible = true) -> MemoryEditor&;
+  
+  std::recursive_mutex *programMutex;
 
   Label memoryLabel{this, Size{~0, 0}, 5};
   ComboButton memoryList{this, Size{~0, 0}};
@@ -69,14 +73,16 @@ struct MemoryEditor : VerticalLayout {
 };
 
 struct GraphicsViewer : VerticalLayout {
-  auto construct() -> void;
+  auto construct(std::recursive_mutex *programMutex) -> void;
   auto reload() -> void;
   auto unload() -> void;
   auto refresh() -> void;
   auto liveRefresh() -> void;
   auto eventChange() -> void;
   auto eventExport() -> void;
   auto setVisible(bool visible = true) -> GraphicsViewer&;
+  
+  std::recursive_mutex *programMutex;
 
   Label graphicsLabel{this, Size{~0, 0}, 5};
   ComboButton graphicsList{this, Size{~0, 0}};
@@ -128,7 +134,7 @@ struct TraceLogger : VerticalLayout {
 };
 
 struct ToolsWindow : Window {
-  ToolsWindow();
+  ToolsWindow(std::recursive_mutex *programMutex);
   auto show(const string& panel) -> void;
   auto eventChange() -> void;