Pushed locking through to Window drawing thread on MacOSX. For #1790.

highperformancecoder · highperformancecoder · commit 68b8cd3e89a5 · 2025-04-14T14:57:16.000+10:00
diff --git a/RESTService/addon.cc b/RESTService/addon.cc
@@ -276,10 +276,11 @@ namespace minsky
 
       void macOSXDrawNativeWindows()
       {
-        const lock_guard<mutex> lock(minskyCmdMutex);
+        // share the lock with all window redraw routines - when all windows redrawn, lock is released
+        auto lock=make_shared<lock_guard<mutex>>(minskyCmdMutex);
         const Timer timer(timers["draw"]);
         for (auto i: nativeWindowsToRedraw)
-          i->macOSXRedraw();
+          macOSXRedraw(*i,lock);
         nativeWindowsToRedraw.clear();
         drawLaunched=false;
        }
diff --git a/RESTService/typescriptAPI.cc b/RESTService/typescriptAPI.cc
@@ -309,6 +309,7 @@ int main()
   cout << "class classdesc__RESTProcess_t {}\n";
   cout << "class classdesc__TCL_obj_t {}\n";
   cout << "class ecolab__cairo__Surface {}\n";
+  cout << "class std__lock_guard {}\n";
   cout<<endl;
   
   // these need to be declared in a specific order
diff --git a/gui-js/libs/shared/src/lib/backend/minsky.ts b/gui-js/libs/shared/src/lib/backend/minsky.ts
@@ -16,6 +16,7 @@ class classdesc__pack_t {}
 class classdesc__RESTProcess_t {}
 class classdesc__TCL_obj_t {}
 class ecolab__cairo__Surface {}
+class std__lock_guard {}
 
 export class EventInterface extends CppClass {
   item: Item;
@@ -172,7 +173,6 @@ export class RenderNativeWindow extends EventInterface {
   async frameArgs(): Promise<minsky__RenderNativeWindow__RenderFrameArgs> {return this.$callMethod('frameArgs');}
   async hasScrollBars(): Promise<boolean> {return this.$callMethod('hasScrollBars');}
   async init(): Promise<void> {return this.$callMethod('init');}
-  async macOSXRedraw(): Promise<void> {return this.$callMethod('macOSXRedraw');}
   async registerImage(): Promise<void> {return this.$callMethod('registerImage');}
   async renderFrame(a1: minsky__RenderNativeWindow__RenderFrameArgs): Promise<void> {return this.$callMethod('renderFrame',a1);}
   async renderToEMF(a1: string): Promise<void> {return this.$callMethod('renderToEMF',a1);}
@@ -376,7 +376,6 @@ export class CSVDialog extends CppClass {
   async keyPress(a1: minsky__EventInterface__KeyPressArgs): Promise<boolean> {return this.$callMethod('keyPress',a1);}
   async loadFile(): Promise<void> {return this.$callMethod('loadFile');}
   async loadFileFromName(a1: string): Promise<void> {return this.$callMethod('loadFileFromName',a1);}
-  async macOSXRedraw(): Promise<void> {return this.$callMethod('macOSXRedraw');}
   async mouseDown(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseDown',a1,a2);}
   async mouseMove(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseMove',a1,a2);}
   async mouseUp(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseUp',a1,a2);}
@@ -470,7 +469,6 @@ export class Canvas extends RenderNativeWindow {
   async keyPress(a1: minsky__EventInterface__KeyPressArgs): Promise<boolean> {return this.$callMethod('keyPress',a1);}
   async lassoMode(...args: string[]): Promise<string> {return this.$callMethod('lassoMode',...args);}
   async lockRavelsInSelection(): Promise<void> {return this.$callMethod('lockRavelsInSelection');}
-  async macOSXRedraw(): Promise<void> {return this.$callMethod('macOSXRedraw');}
   async mouseDown(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseDown',a1,a2);}
   async mouseMove(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseMove',a1,a2);}
   async mouseUp(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseUp',a1,a2);}
@@ -641,7 +639,6 @@ export class EquationDisplay extends RenderNativeWindow {
   async init(): Promise<void> {return this.$callMethod('init');}
   async keyPress(a1: minsky__EventInterface__KeyPressArgs): Promise<boolean> {return this.$callMethod('keyPress',a1);}
   async m_zoomFactor(...args: number[]): Promise<number> {return this.$callMethod('m_zoomFactor',...args);}
-  async macOSXRedraw(): Promise<void> {return this.$callMethod('macOSXRedraw');}
   async mouseDown(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseDown',a1,a2);}
   async mouseMove(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseMove',a1,a2);}
   async mouseUp(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseUp',a1,a2);}
@@ -693,7 +690,6 @@ export class FontDisplay extends CppClass {
   async hasScrollBars(): Promise<boolean> {return this.$callMethod('hasScrollBars');}
   async init(): Promise<void> {return this.$callMethod('init');}
   async keyPress(a1: minsky__EventInterface__KeyPressArgs): Promise<boolean> {return this.$callMethod('keyPress',a1);}
-  async macOSXRedraw(): Promise<void> {return this.$callMethod('macOSXRedraw');}
   async mouseDown(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseDown',a1,a2);}
   async mouseMove(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseMove',a1,a2);}
   async mouseUp(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseUp',a1,a2);}
@@ -945,7 +941,6 @@ export class GodleyTableWindow extends CppClass {
   async insertIdx(...args: number[]): Promise<number> {return this.$callMethod('insertIdx',...args);}
   async keyPress(...args: any[]): Promise<boolean> {return this.$callMethod('keyPress',...args);}
   async leftTableOffset(...args: number[]): Promise<number> {return this.$callMethod('leftTableOffset',...args);}
-  async macOSXRedraw(): Promise<void> {return this.$callMethod('macOSXRedraw');}
   async matchingTableColumns(a1: number): Promise<string[]> {return this.$callMethod('matchingTableColumns',a1);}
   async matchingTableColumnsByCol(a1: number): Promise<string[]> {return this.$callMethod('matchingTableColumnsByCol',a1);}
   async maxHistory(...args: number[]): Promise<number> {return this.$callMethod('maxHistory',...args);}
@@ -1487,7 +1482,6 @@ export class PhillipsDiagram extends RenderNativeWindow {
   async hasScrollBars(): Promise<boolean> {return this.$callMethod('hasScrollBars');}
   async init(): Promise<void> {return this.$callMethod('init');}
   async keyPress(a1: minsky__EventInterface__KeyPressArgs): Promise<boolean> {return this.$callMethod('keyPress',a1);}
-  async macOSXRedraw(): Promise<void> {return this.$callMethod('macOSXRedraw');}
   async mouseDown(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseDown',a1,a2);}
   async mouseMove(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseMove',a1,a2);}
   async mouseUp(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseUp',a1,a2);}
@@ -1649,7 +1643,6 @@ export class PlotWidget extends Item {
   async lh(a1: number,a2: number): Promise<number> {return this.$callMethod('lh',a1,a2);}
   async logx(...args: boolean[]): Promise<boolean> {return this.$callMethod('logx',...args);}
   async logy(...args: boolean[]): Promise<boolean> {return this.$callMethod('logy',...args);}
-  async macOSXRedraw(): Promise<void> {return this.$callMethod('macOSXRedraw');}
   async makeDisplayPlot(): Promise<void> {return this.$callMethod('makeDisplayPlot');}
   async maxx(...args: number[]): Promise<number> {return this.$callMethod('maxx',...args);}
   async maxy(...args: number[]): Promise<number> {return this.$callMethod('maxy',...args);}
@@ -1894,7 +1887,6 @@ export class RavelPopup extends CppClass {
   async hasScrollBars(): Promise<boolean> {return this.$callMethod('hasScrollBars');}
   async init(): Promise<void> {return this.$callMethod('init');}
   async keyPress(a1: minsky__EventInterface__KeyPressArgs): Promise<boolean> {return this.$callMethod('keyPress',a1);}
-  async macOSXRedraw(): Promise<void> {return this.$callMethod('macOSXRedraw');}
   async mouseDown(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseDown',a1,a2);}
   async mouseLeave(): Promise<void> {return this.$callMethod('mouseLeave');}
   async mouseMove(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseMove',a1,a2);}
@@ -2222,7 +2214,6 @@ export class VariablePane extends CppClass {
   async justification(a1: number): Promise<string> {return this.$callMethod('justification',a1);}
   async keyPress(a1: minsky__EventInterface__KeyPressArgs): Promise<boolean> {return this.$callMethod('keyPress',a1);}
   async m_zoomFactor(...args: number[]): Promise<number> {return this.$callMethod('m_zoomFactor',...args);}
-  async macOSXRedraw(): Promise<void> {return this.$callMethod('macOSXRedraw');}
   async mouseDown(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseDown',a1,a2);}
   async mouseMove(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseMove',a1,a2);}
   async mouseUp(a1: number,a2: number): Promise<void> {return this.$callMethod('mouseUp',a1,a2);}
diff --git a/model/getContext.cc b/model/getContext.cc
@@ -116,6 +116,7 @@ namespace minsky
     cairo_surface_set_device_offset(winfo->bufferSurface->surface(), 0, 20);
   winfo->draw();
   winfo->bufferSurface.reset();
+  winfo->lock.reset(); // unlock any mutex attached to this window
 }
 - (NSView *) hitTest: (NSPoint) aPoint
 {
diff --git a/model/renderNativeWindow.cc b/model/renderNativeWindow.cc
@@ -35,6 +35,7 @@ Please especially review the lifecycle (constructors, desctructors and copy cons
 #include "renderNativeWindow.xcd"
 #include "plot.rcd"
 #include "plot.xcd"
+
 #include "minsky_epilogue.h"
 
 #include <stdexcept>
@@ -91,19 +92,19 @@ namespace minsky
     winInfoPtr.reset();
   }
 
-  void RenderNativeWindow::macOSXRedraw()
+void macOSXRedraw(RenderNativeWindow& window,const std::shared_ptr<std::lock_guard<std::mutex>>& lock)
   {
 #ifdef MAC_OSX_TK
-    if (!winInfoPtr.get()) return;
-    winInfoPtr->requestRedraw();
+    if (!window->winInfoPtr.get()) return;
+    window->winInfoPtr->lock=macOSXDrawLock;
+    window->winInfoPtr->requestRedraw();
 #endif
   }
 
   
   void RenderNativeWindow::requestRedraw()
   {
     if (!winInfoPtr.get()) return;
-    macOSXRedraw();
     minsky().nativeWindowsToRedraw.insert(this);
   }
 
diff --git a/model/renderNativeWindow.h b/model/renderNativeWindow.h
@@ -25,6 +25,17 @@
 #include <cairoSurfaceImage.h>
 #include <plot.h>
 
+#ifndef CLASSDESC_TYPENAME___std__lock_guard__mutex___
+#define CLASSDESC_TYPENAME___std__lock_guard__mutex___
+namespace classdesc
+{
+  template <> struct tn<std::lock_guard<std::mutex>>
+  {
+    static string name() {return "std::lock_guard<std::mutex>";}
+  };
+}
+#endif
+
 namespace minsky
 {  
   class WindowInformation;
@@ -53,7 +64,8 @@ namespace minsky
     void destroyFrame();
     void draw();
     void requestRedraw();
-    void macOSXRedraw();
+    // implemented as a free function to avoid Classdesc exposing this to Typescript
+    friend void macOSXRedraw(RenderNativeWindow&,const std::shared_ptr<std::lock_guard<std::mutex>>&);
     // do not clobber winInfoPtr on load of model
     RenderNativeWindow& operator=(const RenderNativeWindow& x) {ecolab::CairoSurface::operator=(x); return *this;}
     RenderNativeWindow()=default;
@@ -75,6 +87,9 @@ namespace minsky
     };
     classdesc::Exclude<CopiableMutux> drawMutex;
   };
+
+  //void macOSXRedraw(RenderNativeWindow&,const std::shared_ptr<std::lock_guard<std::mutex>>&);
+  
 } // namespace minsky
 
 #include "renderNativeWindow.cd"
diff --git a/model/windowInformation.h b/model/windowInformation.h
@@ -50,6 +50,7 @@ namespace minsky
     HANDLE hOld;    // 
 #elif defined(MAC_OSX_TK)
     NSContext nsContext;
+    std::shared_ptr<std::lock_guard<std::mutex>> lock;
     Winfo(NSContext&& nsContext): nsContext(std::move(nsContext)) {}
 #elif defined(USE_X11)
     Window parentWindowId;

Original file line number	Diff line number	Diff line change
`@@ -276,10 +276,11 @@ namespace minsky`
`276`	`276`
`277`	`277`	`void macOSXDrawNativeWindows()`
`278`	`278`	`{`
`279`		`- const lock_guard<mutex> lock(minskyCmdMutex);`
	`279`	`+ // share the lock with all window redraw routines - when all windows redrawn, lock is released`
	`280`	`+ auto lock=make_shared<lock_guard<mutex>>(minskyCmdMutex);`
`280`	`281`	`const Timer timer(timers["draw"]);`
`281`	`282`	`for (auto i: nativeWindowsToRedraw)`
`282`		`- i->macOSXRedraw();`
	`283`	`+ macOSXRedraw(*i,lock);`
`283`	`284`	`nativeWindowsToRedraw.clear();`
`284`	`285`	`drawLaunched=false;`
`285`	`286`	`}`
Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,7 @@ namespace minsky`
`116`	`116`	`cairo_surface_set_device_offset(winfo->bufferSurface->surface(), 0, 20);`
`117`	`117`	`winfo->draw();`
`118`	`118`	`winfo->bufferSurface.reset();`
	`119`	`+ winfo->lock.reset(); // unlock any mutex attached to this window`
`119`	`120`	`}`
`120`	`121`	`- (NSView *) hitTest: (NSPoint) aPoint`
`121`	`122`	`{`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ Please especially review the lifecycle (constructors, desctructors and copy cons`
`35`	`35`	`#include "renderNativeWindow.xcd"`
`36`	`36`	`#include "plot.rcd"`
`37`	`37`	`#include "plot.xcd"`
	`38`	`+`
`38`	`39`	`#include "minsky_epilogue.h"`
`39`	`40`
`40`	`41`	`#include <stdexcept>`
`@@ -91,19 +92,19 @@ namespace minsky`
`91`	`92`	`winInfoPtr.reset();`
`92`	`93`	`}`
`93`	`94`
`94`		`- void RenderNativeWindow::macOSXRedraw()`
	`95`	`+void macOSXRedraw(RenderNativeWindow& window,const std::shared_ptr<std::lock_guard<std::mutex>>& lock)`
`95`	`96`	`{`
`96`	`97`	`#ifdef MAC_OSX_TK`
`97`		`- if (!winInfoPtr.get()) return;`
`98`		`- winInfoPtr->requestRedraw();`
	`98`	`+ if (!window->winInfoPtr.get()) return;`
	`99`	`+ window->winInfoPtr->lock=macOSXDrawLock;`
	`100`	`+ window->winInfoPtr->requestRedraw();`
`99`	`101`	`#endif`
`100`	`102`	`}`
`101`	`103`
`102`	`104`
`103`	`105`	`void RenderNativeWindow::requestRedraw()`
`104`	`106`	`{`
`105`	`107`	`if (!winInfoPtr.get()) return;`
`106`		`- macOSXRedraw();`
`107`	`108`	`minsky().nativeWindowsToRedraw.insert(this);`
`108`	`109`	`}`
`109`	`110`