fix: fix reopening or focusing scratchpad: only for electron

fixing a regression, and fixing #329

Author: alehander92

src/frontend/event_helpers.nim

@@ -63,3 +63,6 @@ proc successMessage*(api: MediatorWithSubscribers, text: cstring) =
   let notification =
     makeNotification(NotificationKind.NotificationSuccess, text)
   api.showNotification(notification)
+
+proc openValueInScratchpad*(api: MediatorWithSubscribers, arg: ValueWithExpression) =
+  api.emit(InternalAddToScratchpad, arg)

src/frontend/middleware.nim

@@ -1,12 +1,14 @@
 import std / [jsffi, jsconsole]
 import .. / common / ct_event
-import types
+import types, lib
 import communication, dap
 import event_helpers
 
 # backend(dap) <-> middleware <-> view (self-contained, can be separate: 0, 1 or more components);
 
 when not defined(ctInExtension):
+  import utils
+
   proc dapInitializationHandler() =
     data.dapApi.sendCtRequest(DapConfigurationDone, js{})
     data.dapApi.sendCtRequest(DapLaunch, js{
@@ -19,6 +21,23 @@ when not defined(ctInExtension):
     inc data.status.operationCount
     viewsApi.emit(InternalStatusUpdate, data.status)
 
+  proc addToScratchpadHandler*(viewsApi: MediatorWithSubscribers, value: ValueWithExpression) =
+    # opens again or re-focuses scratchpad panel if needed
+    let openNew = data.ui.componentMapping[Content.Scratchpad].isNil or
+        data.ui.componentMapping[Content.Scratchpad].len == 0 or
+        data.ui.componentMapping[Content.Scratchpad].toJs[0].isUndefined or
+        data.ui.componentMapping[Content.Scratchpad][0].layoutItem.isNil
+    if openNew:
+      data.openLayoutTab(Content.Scratchpad)
+
+    if not data.ui.componentMapping[Content.Scratchpad][0].layoutItem.parent.isNil:
+      data.ui.componentMapping[Content.Scratchpad][0].
+        layoutItem.parent.setActiveContentItem(
+          data.ui.componentMapping[Content.Scratchpad][0].layoutItem)
+    # if there is no parent, we assume it's a visible panel
+    # with only tab scratchpad
+    viewsApi.emit(InternalAddToScratchpad, value)
+
 proc setupMiddlewareApis*(dapApi: DapApi, viewsApi: MediatorWithSubscribers) {.exportc.}=
   var lastCompleteMove: MoveState = nil
 
@@ -75,7 +94,6 @@ proc setupMiddlewareApis*(dapApi: DapApi, viewsApi: MediatorWithSubscribers) {.e
     #   if not dapApi.completeMoveFunction.isNil:
     #     dapApi.completeMoveFunction(dapApi.editor, value, dapApi)
     # )
-  viewsApi.subscribe(InternalAddToScratchpad, proc(kind: CtEventKind, value: ValueWithExpression, sub: Subscriber) = viewsApi.emit(InternalAddToScratchpad, value))
   viewsApi.subscribe(InternalAddToScratchpadFromExpression, proc(kind: CtEventKind, value: cstring, sub: Subscriber) = viewsApi.emit(InternalAddToScratchpadFromExpression, value))
 
   when not defined(ctInExtension):
@@ -84,6 +102,15 @@ proc setupMiddlewareApis*(dapApi: DapApi, viewsApi: MediatorWithSubscribers) {.e
       newOperationHandler(viewsApi, value)
     )
 
+    viewsApi.subscribe(InternalAddToScratchpad, proc(kind: CtEventKind, value: ValueWithExpression, sub: Subscriber) =
+      addToScratchpadHandler(viewsApi, value))
+  else:
+    # TODO: also in extension: opening again/focusing scratchpad and 
+    # sending to it, maybe using a handler that we pass to setupMiddlewareApis ?
+    # or a global function?
+    viewsApi.subscribe(InternalAddToScratchpad, proc(kind: CtEventKind, value: ValueWithExpression, sub: Subscriber) = viewsApi.emit(InternalAddToScratchpad, value))
+
+
   viewsApi.subscribe(CtNotification, proc(kind: CtEventKind, value: Notification, sub: Subscriber) = viewsApi.emit(CtNotification, value))
   viewsApi.subscribe(DapStepIn, proc(kind: CtEventKind, value: DapStepArguments, sub: Subscriber) = dapApi.sendCtRequest(kind, value.toJs))
   viewsApi.subscribe(DapStepOut, proc(kind: CtEventKind, value: DapStepArguments, sub: Subscriber) = dapApi.sendCtRequest(kind, value.toJs))

src/frontend/ui/calltrace.nim

@@ -623,13 +623,9 @@ proc callView*(
         onclick = proc =
           clog fmt"calltrace: jump onclick call key " & $key
           self.resetValueView()
-          # TODO: send event to middleware to change state
-          # self.data.services.debugger.stableBusy = true
           self.selectedCallNumber = self.lineIndex[call.key]
           self.lastSelectedCallKey = call.key
           self.calltraceJump(call.location)
-          # TODO: send event to middleware to change status state
-          # inc self.data.services.debugger.operationCount
           self.redrawCallLines()
       ):
         if key != cstring"-1 -1 -1":

src/frontend/ui/editor.nim

@@ -897,7 +897,7 @@ proc createContextMenuItems(self: EditorViewComponent, ev: js): seq[ContextMenuI
             if local.expression == expression:
               let baseValue = local.value
               addToScratchpad = ContextMenuItem(name: "Add value to scratchpad", hint: "", handler: proc(e: Event) =
-                openValueInScratchpad((expression, baseValue))
+                self.api.openValueInScratchpad(ValueWithExpression(expression: expression, value: baseValue))
                 self.data.redraw())
               contextMenu &= addToScratchpad
           break
@@ -927,7 +927,10 @@ proc createContextMenuItems(self: EditorViewComponent, ev: js): seq[ContextMenuI
                 name: &"Add {tempValue[0]} to scratchpad",
                 hint: "",
                 handler: proc(e: Event) =
-                  openValueInScratchpad(tempValue)
+                  self.api.openValueInScratchpad(
+                    ValueWithExpression(
+                      expression: tempValue[0],
+                      value: tempValue[1]))
                   self.data.redraw()
               )
 
@@ -950,7 +953,10 @@ proc createContextMenuItems(self: EditorViewComponent, ev: js): seq[ContextMenuI
             hint: "",
             handler: proc(e: Event) =
               for localValue in traceValue.locals:
-                openValueInScratchpad(localValue)
+                self.api.openValueInScratchpad(
+                  ValueWithExpression(
+                    expression: localValue[0],
+                    value: localValue[1]))
                 self.data.redraw()
           )
 
@@ -960,7 +966,10 @@ proc createContextMenuItems(self: EditorViewComponent, ev: js): seq[ContextMenuI
             name: "Add value to scratchpad",
             hint: "CTRL+<click on value>",
             handler: proc(e: Event) =
-              openValueInScratchpad(traceValue.locals[0])
+              self.api.openValueInScratchpad(
+                ValueWithExpression(
+                  expression: traceValue.locals[0][0],
+                  value: traceValue.locals[0][1]))
               self.data.redraw()
           )
 

src/frontend/ui/flow.nim

@@ -2,7 +2,7 @@ import
   ../ui_helpers, ui_imports,
   ../renderer, value, scratchpad
 
-import ../communication, ../../common/ct_event, ../dap
+import ../communication, ../../common/ct_event, ../dap, ../event_helpers
 import strutils, os
 
 # thank, God!
@@ -1148,7 +1148,7 @@ proc createContextMenuItems(self: FlowComponent, name: cstring, beforeValue: Val
     name: "Add value to scratchpad",
     hint: "CTRL+<click on value>",
     handler: proc(e: Event) =
-      openValueInScratchpad((name, beforeValue))
+      self.api.openValueInScratchpad(ValueWithExpression(expression: name, value: beforeValue))
       data.redraw()
   )
 
@@ -1159,7 +1159,7 @@ proc createContextMenuItems(self: FlowComponent, name: cstring, beforeValue: Val
     hint: "",
     handler: proc(e: Event) =
       for key, value in step.beforeValues:
-        openValueInScratchpad((key, value))
+        self.api.openValueInScratchpad(ValueWithExpression(expression: key, value: value))
       data.redraw()
   )
 
@@ -1323,7 +1323,7 @@ proc flowSimpleValue*(
 
     if cast[MouseEvent](e).button == 0:
       if cast[bool](e.toJs.ctrlKey):
-        openValueInScratchpad((name, value))
+        self.api.openValueInScratchpad(ValueWithExpression(expression: name, value: value))
         data.redraw()
       else:
         self.jumpToLocalStep(stepCount)

src/frontend/ui/trace.nim

@@ -250,8 +250,7 @@ proc createContextMenuItems(self: TraceComponent, ev: js): seq[ContextMenuItem]
     hint: "",
     handler: proc(e: Event) =
       for local in localValues:
-        openValueInScratchpad(local)
-        self.data.redraw()
+        self.api.emit(InternalAddToScratchpad, ValueWithExpression(expression: local[0], value: local[1]))
   )
 
   contextMenu &= addToScratchpad

src/frontend/ui/value.nim

@@ -1149,10 +1149,7 @@ proc view(
           tdiv(
             class = "add-to-scratchpad-button",
             onmousedown = proc(ev: Event, v: VNode) =
-              # TODO: Figure out a way to open panel if closed
-              # The logic for opening should be in the middleware later on
-              # openValueInScratchpad((expression, value))
-              self.api.emit(InternalAddToScratchpad, ValueWithExpression(expression: expression, value: value))
+              self.api.openValueInScratchpad(ValueWithExpression(expression: expression, value: value))
               self.redraw()
           ):
             tdiv(class = "custom-tooltip"):

src/frontend/utils.nim

@@ -277,6 +277,7 @@ proc asmLoad*(self: EditorService, location: types.Location): Future[Instruction
   # else:
   #   name = location.functionName # using it for expanded-<firstLine>
   let instructions = await self.data.asyncSend("asm-load", functionLocation, $name, Instructions)
+
   return instructions
 
 # lowLevel: enum TODO
@@ -1254,23 +1255,6 @@ proc registerScratchpadValue*(self: ScratchpadComponent, expression: cstring, va
     stateID: -1,
     data: self.data))
 
-proc openValueInScratchpad*(value: (cstring, Value)) =
-  if data.ui.componentMapping[Content.Scratchpad].isNil or
-      data.ui.componentMapping[Content.Scratchpad].len == 0 or
-      data.ui.componentMapping[Content.Scratchpad].toJs[0].isUndefined or
-      data.ui.componentMapping[Content.Scratchpad][0].layoutItem.isNil:
-    data.openLayoutTab(Content.Scratchpad)
-
-  if not data.ui.componentMapping[Content.Scratchpad][0].layoutItem.parent.isNil:
-    cast[ScratchpadComponent](
-      data.ui.componentMapping[Content.Scratchpad][0]).registerScratchpadValue(
-        value[0],
-        value[1])
-    data.ui.componentMapping[Content.Scratchpad][0].
-      layoutItem.parent.setActiveContentItem(
-        data.ui.componentMapping[Content.Scratchpad][0].layoutItem)
-  # if there is no parent, we assume it's a visible panel
-  # with only tab scratchpad
 
 proc findTRNode*(node: js): js =
   return if node.tagName.to(cstring) == cstring("TR"):