@naanlang/naan 1.0.0 → 1.0.3

package/LICENSE.md

@@ -1,4 +1,4 @@
-Naan for NPM version 1.0.0-1 is released under the MIT License:
+Naan for NPM version 1.0.3-1 is released under the MIT License:
 
 Copyright (c) 2017-2022 Zulch Laboratories, Inc.
 

package/README.md

@@ -4,7 +4,7 @@
 Naan is an async-first software platform for rapid development.
 
 #### Release:
-     Naan for NPM version 1.0.0-1
+     Naan for NPM version 1.0.3-1
      Copyright (c) 2017-2022 Zulch Laboratories, Inc.
 
 #### Features
@@ -17,7 +17,7 @@ Naan is an async-first software platform for rapid development.
 - Preserves referential integrity when communicating among workers or hosts
 - Plugin architecture enables alternate languages and functionality
 - Custom language syntax can be added through simplified dialect extensions
-- Integrates transparently with all exising JavaScript libraries
+- Integrates transparently with all existing JavaScript libraries
 - Can save and reload running program state across page loads or lambda invocations
 - Lightweight and efficient
 
@@ -27,18 +27,47 @@ Please ensure you have a recent version of [node.js](http://nodejs.org/)
 
 For use everywhere as a command line app:
 
-    npm install naan -g
+    npm install @naanlang/naan -g
 
 For use as a library in the current project:
 
-    npm install naan
+    npm install @naanlang/naan
 
-#### Command line usage
+#### Command line execution
 
-    naan
+    naan [options] [source file] [arguments]
 
-##### Dependencies:
-     We greatfully acknowlege these software packages used with Naan:
+With no arguments Naan runs as an interactive REPL using the node.js terminal.
+It can also evaluate an expression or execute a source file.
+
+##### Command line usage
+
+    -h, --help                  print usage information
+    -e <expression>             evaluate an expression
+    -i, --interactive           use REPL with -e or [source file]
+    -v, --version               print Naan version
+    -vv                         print Naan version with build number
+
+Naan prints the results of evaluating each expression with the REPL, but not
+by default with an expression or source file. The interactive flag overrides
+this to print the result of each expression in all cases.
+
+##### Shell scripting
+
+When installed globally, Naan can be used for shell scripts with the [Shebang](https://en.wikipedia.org/wiki/Shebang_(Unix))
+mechanism. For example, copy the following text to a file named helloworld:
+
+    #!/usr/bin/env naan
+    printline("Hello World")
+
+Now make it executable with chmod:
+
+    chmod a+x helloworld
+
+
+
+#### Dependencies:
+     We gratefully acknowledge these software packages used with Naan:
 - [jszip.js](http://stuartk.com/jszip) - read and write zip files
 - [NodeJS-path](https://nodejs.org/) - NodeJS path utilities
 - [PouchDB](https://pouchdb.com/) - synchronizing database

package/bin/index.js

@@ -0,0 +1,148 @@
+#!/usr/bin/env node
+/*
+ * index.js
+ * Naanlib
+ *
+ *     Naan command line.
+ *
+ * column positioning:                          //                          //                      !
+ *
+ * Copyright (c) 2021-2022 by Richard C. Zulch
+ *
+ */
+
+"use strict";
+
+/*
+ * imports
+ *
+ */
+
+var path = require("path");
+var fs = require("fs");
+var naanOptions;
+
+/*
+ * Process command-line arguments
+ *
+ */
+
+var cmd_file;
+var eval_text;
+var do_interactive;
+var cmd_text = "nodeparse('node_repl_init.nlg');;\n";
+
+process.argv.every((val, index) => {
+    if (index < 2)
+        return (true);
+    if (val == "-e") {
+        eval_text = 1;
+        return (true);
+    }
+    if (eval_text == 1 && val.substring(0,1) == "-")
+        return (false);
+    if (val == "-h" || val == "--help") {
+        console.log(
+            "Usage: naan [options] [source file] [arguments]\n\n" +
+            "Options:\n" +
+            "  -e <expression>      evaluate an expression\n" +
+            "  -i, --interactive    use REPL with -e or [source file]\n" +
+            "  --version            print the Naan version\n" +
+            "  --buildno            print the version and build\n" +
+            "  -h, --help           print this usage information\n"
+        );
+        process.exit(0);
+    }
+    if (val == "-i" || val == "--interactive") {
+        do_interactive = true;
+        return (true);
+    }
+    if (val == "--version") {
+        console.log("1.0.3");
+        process.exit(0);
+    }
+    if (val == "--buildno") {
+        console.log("1.0.3-1");
+        process.exit(0);
+    }
+    if (val.substring(0,1) == "-") {
+        console.log("naan: bad option: " + val);
+        process.exit(9);
+    }
+    if (eval_text == 1) {
+        eval_text = val + '\n';
+        return (true);
+    }
+    if (!cmd_file) {
+        cmd_file = val;
+        return (true);
+    }
+    // ignore extra arguments
+    return (true);
+});
+
+if (eval_text == 1) {
+    console.log("naan: -e requires an argument");
+    process.exit(9);
+}
+if (cmd_file) {
+    if (!fs.existsSync(cmd_file)) {
+        console.log("naan: file not found: " + cmd_file);
+        process.exit(1);
+    }
+    eval_text = fs.readFileSync(cmd_file, "utf8");
+    eval_text = eval_text.replace(/^#!.*\n/, "");
+}
+if (eval_text) {
+    if (!do_interactive)
+        naanOptions = { replDisable: true };
+    cmd_text =
+        "closure NodeREPL(local input, error, expr) {\n" +
+        (do_interactive ?
+        ""
+        :
+        "   sudo(putproc(`exception, false))\n") +
+        "   input = new(textstream, js.expr)\n" +
+        "   try {\n" +
+        "       loop {\n" +
+        "           `(error, expr) = Dialect.parse(input)\n" +
+        "           if error {\n" +
+        "               printline(' ==> parse error: ', Dialect.parseErrorString(error.0))\n" +
+        "               break\n" +
+        "           } else\n" +
+        (cmd_file && !do_interactive ?
+        "               eval(expr)\n"
+        :
+        "           {\n" +
+        "               if input.tokenlast().atom == `;;\n" +
+        "                   eval(expr)\n" +
+        "               else if input.tokenlast().atom == `;>\n" +
+        "                   printline(eval(expr))\n" +
+        "               else\n" +
+        "                   printline(Dialect.print(eval(expr)))\n" +
+        "           }\n") +
+        "       }\n" +
+        "   } catch {\n" +
+        "       if true {\n" +
+        "           if exception != `(internal, 'end-of-file')\n" +
+        "               printline(' ==> exception: ', error = exception)\n" +
+        "       }\n" +
+        "   } finally {\n" +
+        "       sleep(1)\n" +
+        "       exec(quote(js.g.process.exit(if error 1 else 0)))\n" +
+        "   }\n" +
+        "}();;\n";
+}
+
+
+/*
+ * Execute Naan
+ *
+ */
+
+var NaanNodeREPL = require('../lib/env_node.js');
+var naanrepl = new NaanNodeREPL(naanOptions);
+naanrepl.setDirectory(path.join(__dirname, "../lib"));
+if (eval_text)
+    naanrepl.setGlobal("expr", eval_text + "\n");
+naanrepl.textCommand(cmd_text);

package/dist/env_web.js

@@ -6,7 +6,7 @@
  *
  * column positioning:                          //                          //                      !
  *
- * Copyright (c) 2017-2021 by Richard C. Zulch
+ * Copyright (c) 2017-2022 by Richard C. Zulch
  *
  */
 
@@ -83,6 +83,7 @@ exports.NaanControllerWeb = function() {
     var replqueue;                                                          // text destined for terminal when opened
     var termlist = [];                                                      // list of terminals currently attached
     var prefs = { };
+    var vsiteName;
 
     //
     // termTextOut
@@ -149,8 +150,15 @@ exports.NaanControllerWeb = function() {
     //
     
     this.StateGet = function StateGet() {
-        if (termlist.length > 0)
-            replstate = termlist[0].StateSave();                            // restore current buffer state to new terminal
+        termlist.every(function(term) {
+            var state;
+            if (term.StateSave && (state = term.StateSave()))
+            {                                                               // update the state if we can
+                replstate = state;
+                return (false);
+            }
+            return (true);                                                  // keep searching
+        });
         return (replstate);
     };
 
@@ -204,14 +212,14 @@ exports.NaanControllerWeb = function() {
             if (term !== terminal)
                 term.OnMessage({                                            // send text to other terminals
                     id: "textout",
-                    text: text + "\r\n"
+                    text: "\x1b[90m\x1b[3m" + text + "\x1b[0m" + "\r\n"
                 });
         });
         window.setTimeout(function () {
-            naanlib.textLine(text)
+            naanlib.textLine(text);
         }, 1);
     };
-                
+
     this.ReplyMessage = function ReplyMessage(data) {                       // "remote" -> "local"
         termlist.forEach(function(term) {
             if (term.OnMessageOut)
@@ -229,9 +237,9 @@ exports.NaanControllerWeb = function() {
     this.DispatchMessage = function DispatchMessage(data) {                 // "local" -> "remote"
         if (nideListener)
             setTimeout(function() {
-                nideListener(data)
+                nideListener(data);
             }, 1);
-    }
+    };
 
     this.ReplyDebugger = function ReplyDebugger(data) {                     // "remote" -> "local"
         termlist.forEach(function(term) {
@@ -250,9 +258,9 @@ exports.NaanControllerWeb = function() {
     this.DispatchDebugger = function DispatchDebugger(data) {               // "local" -> "remote"
         if (debugListener)
             setTimeout(function() {
-                debugListener(data)
+                debugListener(data);
             }, 1);
-    }
+    };
 
     //
     // Status
@@ -290,7 +298,95 @@ exports.NaanControllerWeb = function() {
     this.Dimensions = function Dimensions(rows, cols) {
         console.log("Naan terminal dimensions now (" + rows + ", " + cols + ")");
     };
+    
+    //
+    // VsiteRefresh
+    //
+    // Check if our underlying data has changed, and reload if needed.
+    //
+    
+    this.VsiteRefresh = function VsiteRefresh(url_origin) {
+        if (window.location.href.startsWith(url_origin))
+            window.location.reload();                                       // we have changed underneath
+    };
+
 
+    //==========================================================================
+    // Clone Debug Interface
+    //--------------------------------------------------------------------------
+
+    function CloneDebugTerminal()
+    {
+        var termSelf = this;
+        //
+        // listen for messages
+        //
+        window.addEventListener("message", function (event) {
+            if (event.origin !== window.origin)
+                return;                                                     // only talk with our peers
+            var msg = event.data;
+            if (msg.id == "interrupt")
+                contSelf.Interrupt();
+            else if (msg.id == "keyline")
+                contSelf.Return(msg.text, termSelf);                        // keyboard text from terminal
+            else if (msg.id == "start")
+                contSelf.Attach(term);                                      // opener is ready
+            else if (msg.id == "import")
+            {                                                               // for workers
+            }
+            else if (msg.id == "targetin")
+            {
+                if (nideListener)
+                    nideListener(msg.data);                                 // target received a message
+            }
+            else if (msg.id == "debugin")
+            {
+                if (debugListener)
+                    debugListener(msg.data);                                // target received a message
+            }
+        });
+        
+        //
+        // report messages back to opener
+        //
+        termSelf.OnMessage = function OnMessage(msg) {
+            window.opener.postMessage(msg, window.origin);
+            return (msg);
+        };
+                
+        //
+        // report messages back to opener
+        //
+        termSelf.OnMessageOut = function OnMessageOut(data) {
+            var msg = {                                                       // target is sending debug data
+                id: "targetout",
+                data: data
+            };
+            return (termSelf.OnMessage(msg));
+        };
+
+        //
+        // report debug messages back to opener
+        //
+        termSelf.OnDebugOut = function OnDebugOut(data) {
+            var msg = {                                                       // target is sending debug data
+                id: "debugout",
+                data: data
+            };
+            return (termSelf.OnMessage(msg));
+        };
+        
+        //
+        // report status back to opener
+        //
+        termSelf.OnStatus = function OnStatus(status) {
+            var msg = {                                                       // target is sending debug data
+                id: "status",
+                status: status
+            };
+            return (termSelf.OnMessage(msg));
+        };
+    }
  
     //==========================================================================
     // Host Environment
@@ -299,7 +395,7 @@ exports.NaanControllerWeb = function() {
     //
     // SavePref
     //
-    // Save a persistent preference objectc that can be retrieved in the future.
+    // Save a persistent preference object that can be retrieved in the future.
     //
     
     this.SavePref = function SavePref(key, value) {
@@ -333,6 +429,7 @@ exports.NaanControllerWeb = function() {
     window.addEventListener("unload", function (e) {
         window.dispatchEvent(saveEvent);
         saveLocal();
+        virtualClose();
     });
  
     window.addEventListener("beforeunload", function (e) {
@@ -348,11 +445,11 @@ exports.NaanControllerWeb = function() {
         statedoc.verstring = "$Version$";
         statedoc.date = new Date().toISOString();
         statedoc.prefs = prefs;
-        statedoc.naan = naanlib.saveState(true);                            // true to optimize, which is a bit slower
+        statedoc.naan = naanlib.saveState(false);                           // true to optimize, which is a bit slower
         termlist.forEach(function(term) {
             if (!replstate || term.termwin)
                 replstate = term.StateSave();                               // state with separate window, otherwise any state
-        })
+        });
         if (replstate)
             statedoc.replstate = replstate;
         return (statedoc);
@@ -364,7 +461,10 @@ exports.NaanControllerWeb = function() {
             || statedoc.curversion < kStateFirstVersion
             || statedoc.licensee != "$Licensee$"
             || statedoc.verstring != "$Version$")
+        {
+            localStorage.removeItem("NaanState_Hosted");
             return (false);
+        }
         naanstate = statedoc.naan;
         replstate = statedoc.replstate;                                     // get terminal state, if any
         if (typeof(statedoc.prefs) == "object")
@@ -381,8 +481,8 @@ exports.NaanControllerWeb = function() {
         try {
             if ("localStorage" in window && window["localStorage"] !== null)
             {
-                localStorage.removeItem("NaanState_Nide");
-                if (localStorage.setItem("NaanState_Nide", statestr) !== undefined)
+                localStorage.removeItem("NaanState_Hosted");
+                if (localStorage.setItem("NaanState_Hosted", statestr) !== undefined)
                     return (true);
             }
         } catch(e) {
@@ -396,7 +496,7 @@ exports.NaanControllerWeb = function() {
             /*jshint sub:true */
             if ("localStorage" in window && window["localStorage"] !== null)
             {
-                var statestr = localStorage.getItem("NaanState_Nide");
+                var statestr = localStorage.getItem("NaanState_Hosted");
                 if (statestr)
                     return (loadState(JSON.parse(statestr)));
             }
@@ -405,7 +505,28 @@ exports.NaanControllerWeb = function() {
         }
         return (false);
     }
+        
+    function virtualOpen() {
+        vsiteName = window.document.title;                                  // consistent name at open and close
+        if (window.opener && window.opener.Naanlang)
+            window.opener.Naanlang.naancon.DispatchMessage({
+                op: "VsiteOpen",
+                name: vsiteName,
+                naancont: contSelf
+            });
+    }
     
+    function virtualClose() {
+        if (window.opener && window.opener.Naanlang) {
+            window.opener.Naanlang.naancon.DispatchMessage({
+                op: "VsiteClose",
+                name: vsiteName,
+                naancont: contSelf
+            });
+            termTextOut("\x1b[90m\x1b[3m".concat("\nwindow closed", "\x1b[0m\n"));
+        }
+    }
+
     /*jshint sub:true */
     if (querystrings["restart"] || !loadLocal())
     {                                                                       // don't load state or can't load state
@@ -423,6 +544,14 @@ exports.NaanControllerWeb = function() {
             state: naanstate
         });
     }
+
+    if (window.opener) {
+        virtualOpen();
+        var term = new CloneDebugTerminal();
+        term.OnMessage({
+            id: "loaded"
+        });
+    }
 };
 
 /*jshint sub:true */