2981 - sandbox buttons implemented in edit/

1 files changed, 284 insertions, 0 deletions

diff --git a/edit/006-sandbox-copy.mu b/edit/006-sandbox-copy.mu
new file mode 100644
index 00000000..867be5ff
--- /dev/null
+++ b/edit/006-sandbox-copy.mu
@@ -0,0 +1,284 @@
+## the 'copy' button makes it easy to duplicate a sandbox, and thence to
+## see code operate in multiple situations
+
+scenario copy-a-sandbox-to-editor [
+  trace-until 100/app  # trace too long
+  assume-screen 100/width, 10/height
+  # basic recipe
+  1:address:array:character <- new [ 
+recipe foo [
+  reply 4
+]]
+  # run it
+  2:address:array:character <- new [foo]
+  assume-console [
+    press F4
+  ]
+  3:address:programming-environment-data <- new-programming-environment screen:address:screen, 1:address:array:character, 2:address:array:character
+  event-loop screen:address:screen, console:address:console, 3:address:programming-environment-data
+  screen-should-contain [
+    .                                                                                 run (F4)           .
+    .                                                  ┊                                                 .
+    .recipe foo [                                      ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .  reply 4                                         ┊0   edit          copy            delete         .
+    .]                                                 ┊foo                                              .
+    .┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┊4                                                .
+    .                                                  ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .                                                  ┊                                                 .
+  ]
+  # click at left edge of 'copy' button
+  assume-console [
+    left-click 3, 69
+  ]
+  run [
+    event-loop screen:address:screen, console:address:console, 3:address:programming-environment-data
+  ]
+  # it copies into editor
+  screen-should-contain [
+    .                                                                                 run (F4)           .
+    .                                                  ┊foo                                              .
+    .recipe foo [                                      ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .  reply 4                                         ┊0   edit          copy            delete         .
+    .]                                                 ┊foo                                              .
+    .┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┊4                                                .
+    .                                                  ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .                                                  ┊                                                 .
+  ]
+  # cursor should be in the right place
+  assume-console [
+    type [0]
+  ]
+  run [
+    event-loop screen:address:screen, console:address:console, 3:address:programming-environment-data
+  ]
+  screen-should-contain [
+    .                                                                                 run (F4)           .
+    .                                                  ┊0foo                                             .
+    .recipe foo [                                      ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .  reply 4                                         ┊0   edit          copy            delete         .
+    .]                                                 ┊foo                                              .
+    .┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┊4                                                .
+    .                                                  ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .                                                  ┊                                                 .
+  ]
+]
+
+scenario copy-a-sandbox-to-editor-2 [
+  trace-until 100/app  # trace too long
+  assume-screen 100/width, 10/height
+  # basic recipe
+  1:address:array:character <- new [ 
+recipe foo [
+  reply 4
+]]
+  # run it
+  2:address:array:character <- new [foo]
+  assume-console [
+    press F4
+  ]
+  3:address:programming-environment-data <- new-programming-environment screen:address:screen, 1:address:array:character, 2:address:array:character
+  event-loop screen:address:screen, console:address:console, 3:address:programming-environment-data
+  screen-should-contain [
+    .                                                                                 run (F4)           .
+    .                                                  ┊                                                 .
+    .recipe foo [                                      ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .  reply 4                                         ┊0   edit          copy            delete         .
+    .]                                                 ┊foo                                              .
+    .┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┊4                                                .
+    .                                                  ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .                                                  ┊                                                 .
+  ]
+  # click at right edge of 'copy' button (just before 'delete')
+  assume-console [
+    left-click 3, 84
+  ]
+  run [
+    event-loop screen:address:screen, console:address:console, 3:address:programming-environment-data
+  ]
+  # it copies into editor
+  screen-should-contain [
+    .                                                                                 run (F4)           .
+    .                                                  ┊foo                                              .
+    .recipe foo [                                      ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .  reply 4                                         ┊0   edit          copy            delete         .
+    .]                                                 ┊foo                                              .
+    .┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┊4                                                .
+    .                                                  ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .                                                  ┊                                                 .
+  ]
+  # cursor should be in the right place
+  assume-console [
+    type [0]
+  ]
+  run [
+    event-loop screen:address:screen, console:address:console, 3:address:programming-environment-data
+  ]
+  screen-should-contain [
+    .                                                                                 run (F4)           .
+    .                                                  ┊0foo                                             .
+    .recipe foo [                                      ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .  reply 4                                         ┊0   edit          copy            delete         .
+    .]                                                 ┊foo                                              .
+    .┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┊4                                                .
+    .                                                  ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .                                                  ┊                                                 .
+  ]
+]
+
+after <global-touch> [
+  # support 'copy' button
+  {
+    copy?:boolean <- should-attempt-copy? click-row, click-column, env
+    break-unless copy?
+    copy?, env <- try-copy-sandbox click-row, env
+    break-unless copy?
+    hide-screen screen
+    screen <- render-sandbox-side screen, env
+    screen <- update-cursor screen, recipes, current-sandbox, sandbox-in-focus?, env
+    show-screen screen
+    loop +next-event:label
+  }
+]
+
+# some preconditions for attempting to copy a sandbox
+def should-attempt-copy? click-row:number, click-column:number, env:address:programming-environment-data -> result:boolean [
+  local-scope
+  load-ingredients
+  # are we below the sandbox editor?
+  click-sandbox-area?:boolean <- click-on-sandbox-area? click-row, click-column, env
+  reply-unless click-sandbox-area?, 0/false
+  # narrower, is the click in the columns spanning the 'copy' button?
+  first-sandbox:address:editor-data <- get *env, current-sandbox:offset
+  assert first-sandbox, [!!]
+  sandbox-left-margin:number <- get *first-sandbox, left:offset
+  sandbox-right-margin:number <- get *first-sandbox, right:offset
+  _, _, copy-button-left:number, copy-button-right:number, _ <- sandbox-menu-columns sandbox-left-margin, sandbox-right-margin
+  copy-button-vertical-area?:boolean <- within-range? click-column, copy-button-left, copy-button-right
+  reply-unless copy-button-vertical-area?, 0/false
+  # finally, is sandbox editor empty?
+  current-sandbox:address:editor-data <- get *env, current-sandbox:offset
+  result <- empty-editor? current-sandbox
+]
+
+def try-copy-sandbox click-row:number, env:address:programming-environment-data -> clicked-on-copy-button?:boolean, env:address:programming-environment-data [
+  local-scope
+  load-ingredients
+  # identify the sandbox to copy, if the click was actually on the 'copy' button
+  sandbox:address:sandbox-data <- find-sandbox env, click-row
+  return-unless sandbox, 0/false
+  clicked-on-copy-button? <- copy 1/true
+  text:address:array:character <- get *sandbox, data:offset
+  current-sandbox:address:editor-data <- get *env, current-sandbox:offset
+  current-sandbox <- insert-text current-sandbox, text
+  # reset scroll
+  *env <- put *env, render-from:offset, -1
+  # position cursor in sandbox editor
+  *env <- put *env, sandbox-in-focus?:offset, 1/true
+]
+
+def find-sandbox env:address:programming-environment-data, click-row:number -> result:address:sandbox-data [
+  local-scope
+  load-ingredients
+  curr-sandbox:address:sandbox-data <- get *env, sandbox:offset
+  {
+    start:number <- get *curr-sandbox, starting-row-on-screen:offset
+    found?:boolean <- equal click-row, start
+    return-if found?, curr-sandbox
+    curr-sandbox <- get *curr-sandbox, next-sandbox:offset
+    loop
+  }
+  return 0/not-found
+]
+
+def click-on-sandbox-area? click-row:number, click-column:number, env:address:programming-environment-data -> result:boolean [
+  local-scope
+  load-ingredients
+  current-sandbox:address:editor-data <- get *env, current-sandbox:offset
+  sandbox-left-margin:number <- get *current-sandbox, left:offset
+  on-sandbox-side?:boolean <- greater-or-equal click-column, sandbox-left-margin
+  return-unless on-sandbox-side?, 0/false
+  first-sandbox:address:sandbox-data <- get *env, sandbox:offset
+  return-unless first-sandbox, 0/false
+  first-sandbox-begins:number <- get *first-sandbox, starting-row-on-screen:offset
+  result <- greater-or-equal click-row, first-sandbox-begins
+]
+
+def empty-editor? editor:address:editor-data -> result:boolean [
+  local-scope
+  load-ingredients
+  head:address:duplex-list:character <- get *editor, data:offset
+  first:address:duplex-list:character <- next head
+  result <- not first
+]
+
+def within-range? x:number, low:number, high:number -> result:boolean [
+  local-scope
+  load-ingredients
+  not-too-far-left?:boolean <- greater-or-equal x, low
+  not-too-far-right?:boolean <- lesser-or-equal x, high
+  result <- and not-too-far-left? not-too-far-right?
+]
+
+scenario copy-fails-if-sandbox-editor-not-empty [
+  trace-until 100/app  # trace too long
+  assume-screen 100/width, 10/height
+  # basic recipe
+  1:address:array:character <- new [ 
+recipe foo [
+  reply 4
+]]
+  # run it
+  2:address:array:character <- new [foo]
+  assume-console [
+    press F4
+  ]
+  3:address:programming-environment-data <- new-programming-environment screen:address:screen, 1:address:array:character, 2:address:array:character
+  event-loop screen:address:screen, console:address:console, 3:address:programming-environment-data
+  screen-should-contain [
+    .                                                                                 run (F4)           .
+    .                                                  ┊                                                 .
+    .recipe foo [                                      ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .  reply 4                                         ┊0   edit          copy            delete         .
+    .]                                                 ┊foo                                              .
+    .┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┊4                                                .
+    .                                                  ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .                                                  ┊                                                 .
+  ]
+  # type something into the sandbox editor, then click on the 'copy' button
+  assume-console [
+    left-click 2, 70  # put cursor in sandbox editor
+    type [0]  # type something
+    left-click 3, 70  # click 'copy' button
+  ]
+  run [
+    event-loop screen:address:screen, console:address:console, 3:address:programming-environment-data
+  ]
+  # copy doesn't happen
+  screen-should-contain [
+    .                                                                                 run (F4)           .
+    .                                                  ┊0                                                .
+    .recipe foo [                                      ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .  reply 4                                         ┊0   edit          copy            delete         .
+    .]                                                 ┊foo                                              .
+    .┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┊4                                                .
+    .                                                  ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .                                                  ┊                                                 .
+  ]
+  # cursor should be in the right place
+  assume-console [
+    type [1]
+  ]
+  run [
+    event-loop screen:address:screen, console:address:console, 3:address:programming-environment-data
+  ]
+  screen-should-contain [
+    .                                                                                 run (F4)           .
+    .                                                  ┊01                                               .
+    .recipe foo [                                      ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .  reply 4                                         ┊0   edit          copy            delete         .
+    .]                                                 ┊foo                                              .
+    .┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┊4                                                .
+    .                                                  ┊━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━.
+    .                                                  ┊                                                 .
+  ]
+]