Merge branch 'bidirectional-web-editor' into code-view

This fixes the bidirectional web editor endpoint, as well as
incorperating code views into its interface

Author: smj-edison

README.md

@@ -60,6 +60,9 @@ if flashing from a Mac] -- Ubuntu doesn't have a good kernel for Pi 5)
    If no `folk` user, then:
 
         sudo useradd -m folk; sudo passwd folk;
+
+   After creating `folk` user, then:
+    
         for group in adm dialout cdrom sudo audio video plugdev games users input tty render netdev lpadmin gpio i2c spi; do sudo usermod -a -G $group folk; done; groups folk
 
 1. `sudo apt update`

lib/folk.js

@@ -1,10 +1,8 @@
 // const WHITESPACE = /^[ \t]+/;
 // const NEWLINE = /^[;\n]+/;
-const WORDSEP = /^[ \t;\n]+/;
+const WORDSEP = /^[ \t\n\r\f\v]+/;
 const QUOTED = /^".*?[^\\]"/;
-const WORD = /^([^ \t;\n{}[\]"\\]|\\[ \t;\n{}[\]"\\])+/;
-const ESCAPED = /\\(.)/g;
-const ESCAPABLE = /([ \t;\n{}[\]"])/g;
+const WORD = /^([^ \t\n\r\f\v{}\\]|\\.)+/;
 
 const eat = (regex, str) => {
   const match = str.match(regex);
@@ -34,26 +32,84 @@ const eatBrace = (str) => {
 };
 
 const checkBrace = (str) => {
-  let bc = 0;
-  let bk = 0;
+  let curlies = 0;
+  let brackets = 0;
   const l = str.length;
   for (let i = 0; i < l; i++) {
     switch (str[i]) {
-      case '{': bc++; break;
-      case '}': bc--; break;
-      case '[': bk++; break;
-      case ']': bk--; break;
+      case '{': curlies++; break;
+      case '}': curlies--; break;
+      case '[': brackets++; break;
+      case ']': brackets--; break;
+    }
+
+    if (curlies < 0) return false;
+  }
+
+  return curlies === 0 && brackets >= 0;
+};
+
+// ported from JimEscape in jim.c
+const UNESCAPE_TABLE = {
+  'a': '\a',
+  'b': '\b',
+  'n': '\n',
+  'r': '\r',
+  't': '\t',
+  'f': '\f',
+  'v': '\v',
+  '0': '\x00',
+};
+
+const unescape = (str) => {
+  let output = "";
+
+  for (let i = 0; i < str.length; i++) {
+    // used to prevent out-of-bounds issues with `str[i + 1]`
+    if (i === str.length - 1) {
+      output += str[i];
+      break;
     }
 
-    if (bc < 0) return false;
-    if (bk < 0) return false;
+    if (str[i] === '\\') {
+      // is the next character escapable?
+      const unescaped = UNESCAPE_TABLE[str[i + 1]];
+      if (unescaped) {
+        output += unescaped;
+      } else {
+        // else just append it, sans the backslash
+        output += str[i + 1];
+      }
+
+      i++;
+      // TODO: octal, \x \u \U \u{NNN}
+    } else {
+      output += str[i];
+    }
   }
 
-  return bc === 0 && bk === 0;
+  return output;
+};
+
+// ported from BackslashQuoteString in jim.c
+const ESCAPE_TABLE = {
+  ' ': '\\ ',
+  '$': '\\$',
+  '"': '\\"',
+  '[': '\\[',
+  ']': '\\]',
+  '{': '\\{',
+  '}': '\\}',
+  ';': '\\;',
+  '\\': '\\\\',
+  '\n': '\\n',
+  '\r': '\\r',
+  '\t': '\\t',
+  '\f': '\\f',
+  '\v': '\\v',
 };
 
-const unescape = (str) => str.replaceAll(ESCAPED, '$1');
-const escape = (str) => str.replaceAll(ESCAPABLE, '\\$1');
+const escape = (str) => str.split("").map(char => char in ESCAPE_TABLE ? ESCAPE_TABLE[char] : char).join("");
 
 // deserializtion
 const nextToken = (str) => {
@@ -69,14 +125,19 @@ const nextToken = (str) => {
       case ' ':
       case '\t':
       case '\n':
-      case ';':
+      case '\r':
+      case '\f':
+      case '\v':
         return [token, str];
 
-      case '[':
-        throw new Error("this aint no interpreter");
       case '{':
         [word, str] = eatBrace(str);
-        token += word.slice(1, -1);
+
+        if (token === '') {
+          token = word.slice(1, -1);
+        } else {
+          token += word;
+        }
         break;
       case '"':
         [word, str] = eat(QUOTED, str);
@@ -127,8 +188,13 @@ const loadDict = (str) => {
 const dumpString = (word) => {
   if (!word.length) return '{}';
   const match = word.match(WORD);
-  if (match && match[0] === word) return word;
-  if (checkBrace(word)) return `{${word}}`;
+  if (word[0] !== "#" && match && match[0] === word) return word;
+  if (checkBrace(word)) {
+    // the one case that we can't handle with braces is a linefeed escape
+    if (!(/\\\n/.test(word))) {
+      return `{${word}}`;
+    }
+  }
   return escape(word);
 }
 
@@ -280,7 +346,7 @@ class FolkWS {
     const channel = this.createChannel((message) => {
       const [action, match, matchId] = loadList(message);
       const callback = callbacks[action];
-      callback && callback(loadDict(match), matchId);
+      if (callback) callback(loadDict(match), matchId);
     });
 
     const retractKey = await this.send(tcl`

virtual-programs/calibrate/calibrate.folk

@@ -487,22 +487,26 @@ Wish the web server handles route "/calibrate$" with handler [list apply {{UNIT_
               });
 
               function advanceCamera() {
-                cameraFrame.src = cameraFrame.src + '0'
+                cameraFrame.src = '/camera-frame?' + Math.random()
               }
             </script>
 
             <p>Use this camera preview to debug why printed and/or projected tags aren't being recognized (maybe overexposure, maybe your camera isn't in a good position): <button id="refreshButton" onclick="advanceCamera()">Refresh Preview</button> <input type="checkbox" value="true" id="auto-refresh-checkbox" checked>
-  <label for="auto-refresh-checkbox">Automatically refresh preview (May not work well during calibration)</label> </p><br> <img src="/camera-frame?0" id="cameraFrame" style="max-width: 100%"> 
+ <label for="auto-refresh-checkbox">Automatically refresh preview</label> </p><br> <img src="/camera-frame" id="cameraFrame" style="max-width: 100%"> 
 
             <script>
                 const refreshButton = document.getElementById('refreshButton');
                 const autoRefreshCheckbox = document.getElementById('auto-refresh-checkbox');
-                setInterval(() => {
-                     if (autoRefreshCheckbox.checked) {
-                        refreshButton.click()
-                     } 
-                     console.log("checked?", autoRefreshCheckbox.checked)
-                }, 100)
+                cameraFrame.addEventListener('load', () => {
+                  if (autoRefreshCheckbox.checked) {
+                    advanceCamera();
+                  } 
+                });
+                autoRefreshCheckbox.addEventListener('change', () => {
+                  if (autoRefreshCheckbox.checked) {
+                    advanceCamera();
+                  }
+                });
             </script>
 
 

virtual-programs/camera-usb.folk

@@ -349,7 +349,11 @@ When /someone/ wishes $::thisNode uses camera /cameraPath/ with /...options/ {
         set camera [Camera::new $cameraPath $width $height $bufferCount]
 
         # TODO: report actual width and height from v4l2
-        Claim camera $cameraPath has width $width height $height
+        if {[info exists crop]} {
+            Claim camera $cameraPath has width [dict get $crop width] height [dict get $crop height]
+        } else {
+            Claim camera $cameraPath has width $width height $height
+        }
 
         puts "camera-usb: $cameraPath ($options) (tid [getTid]) booted at [clock milliseconds]"
 

virtual-programs/code-view.folk

@@ -41,16 +41,10 @@ When /someone/ claims /view/ is a code view {
 When /view/ is a code view with /...options/ {
   set options [dict merge $codeView::defaults $options]
 
-  # select which program the view is viewing
-  When $view points up at /program/ {
-    Hold selected-program:$view {
-      Claim $view has selected program $program
-    }
-  }
-
-  # reset selected program when it's not pointing at anything
-  When /nobody/ claims $view points up at /anything/ {
-    Hold selected-program:$view {}
+  # reset selected program when it's not pointing at any program (or pointing at a wormhole)
+  When $view points up at /program/ &\
+       /nobody/ claims /program/ is a wormhole entry {
+    Claim $view has selected program $program
   }
 
   # load in defaults for the view if it hasn't been initialized
@@ -94,12 +88,12 @@ When /view/ is a code view with /...options/ {
 When /keyboard/ is a keyboard with path /kbPath/ /...anything/ &\
      /nobody/ claims /keyboard/ is an editor &\
      /keyboard/ points up at /view/ &\
-     /view/ is a code view with /...anything/ {
+     /view/ is a code view with /...anything/ &\
+     /view/ has selected program /program/ {
   # TODO: is there a way to make this `Every time` less of a beast?
   Every time keyboard $kbPath claims key /key/ is /keyState/ with /...options/ &\
         $view has view dimensions /dims/ &\
-        $view has selected program /program/ &\
-        view code for /program/ is /code/ &\
+        view code for $program is /code/ &\
         $view has max cursor x /maxCursorX/ &\
         $view has cursor /cursor/ &\
         $view has viewport scale with width /widthScale/ height /heightScale/ &\
@@ -127,22 +121,8 @@ When /keyboard/ is a keyboard with path /kbPath/ /...anything/ &\
             set resetCode true
           }
           Control_s {
-            Hold new-code-for:$program {
-              Wish program $program is replaced with code $code
-              Wish $program is titled "EDITED"
-            }
-
-            set fp [open "$::env(HOME)/folk-printed-programs/$program.folk.edited" w]
-            puts -nonewline $fp $code
-            close $fp
-
-            # give the user some feedback
-            Hold saved-alert:$keyboard {
-              Wish $keyboard is labelled "Saved!"
-            }
-
-            After 250 milliseconds {
-              Hold saved-alert:$keyboard {}
+            Hold saving-code-for:$view {
+              Wish to save code on view $view
             }
           }
           Control_p {
@@ -222,6 +202,37 @@ When /keyboard/ is a keyboard with path /kbPath/ /...anything/ &\
   }
 }
 
+# TODO: replace with event firing
+When /someone/ wishes to save code on view /view/ &\
+     /view/ has selected program /program/ &\
+      view code for /program/ is /programCode/ {
+  Hold new-code-for:$program {
+    Wish program $program is replaced with code $programCode
+  }
+
+  set fp [open "$::env(HOME)/folk-printed-programs/$program.folk.edited" w]
+  puts -nonewline $fp $programCode
+  close $fp
+
+  Hold saving-code-for:$view {}
+
+  # code may be saved even without an attached keyboard, hence
+  # feedback being optional
+  # TODO: maybe move feedback to code view instead?
+  When /keyboard/ is a keyboard with path /kbPath/ /...anything/ &\
+       /nobody/ claims /keyboard/ is an editor &\
+       /keyboard/ points up at $view {
+    # give the user some feedback
+    Hold saved-alert:$keyboard {
+      Wish $keyboard is labelled "Saved!"
+    }
+
+    After 250 milliseconds {
+      Hold saved-alert:$keyboard {}
+    }
+  }
+}
+
 # calculate cursor position
 When /view/ is a code view with /...anything/ &\
      /view/ has cursor /cursor/ &\

virtual-programs/connections.folk

@@ -63,7 +63,7 @@ When /anyone/ wishes /source/ is dynamically connected to /sink/ /...options/ &
      for {set p $offset} {$p < $distance} {incr p $spacing} {
         set c [vec2 add $source [vec2 scale $direction $p]]
         set s [expr {min($maxsize, 0.20*min($p, $distance - $p))}]
-        Wish to draw a shape with sides 3 center $c radius $s radians $angle color $color filled true layer $layer
+        Wish to draw a shape with sides 3 center $c radius $s angle $angle color $color filled true layer $layer
       }
     }
 }