@naanlang/naan 1.0.2 → 1.0.5

package/LICENSE.md

@@ -1,4 +1,4 @@
-Naan for NPM version 1.0.2-1 is released under the MIT License:
+Naan for NPM version 1.0.5-2 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.2-1
+     Naan for NPM version 1.0.5-2
      Copyright (c) 2017-2022 Zulch Laboratories, Inc.
 
 #### Features
@@ -23,15 +23,15 @@ Naan is an async-first software platform for rapid development.
 
 #### Installation
 
-Please ensure you have a recent version of [node.js](http://nodejs.org/)
+Please ensure you have a recent version of [node.js](http://nodejs.org/). The minimum is `v14.14.0`
 
 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 execution
 
@@ -42,11 +42,11 @@ 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
+    --version                   print Naan version
+    --buildno                   print Naan version with build number
+    -h, --help                  print usage information
 
 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
@@ -64,10 +64,12 @@ Now make it executable with chmod:
 
     chmod a+x helloworld
 
+#### For More Information
 
+[NaanIDE](https://www.npmjs.com/package/@naanlang/naanide) -- the Naan IDE -- includes more detailed documentation on Naan.
 
 #### Dependencies:
-     We gratefully acknowledge these software packages used with Naan:
+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

@@ -58,11 +58,11 @@ process.argv.every((val, index) => {
         return (true);
     }
     if (val == "--version") {
-        console.log("1.0.2");
+        console.log("1.0.5");
         process.exit(0);
     }
     if (val == "--buildno") {
-        console.log("1.0.2-1");
+        console.log("1.0.5-2");
         process.exit(0);
     }
     if (val.substring(0,1) == "-") {

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
  *
  */
 
@@ -74,15 +74,19 @@ exports.NaanControllerWeb = function() {
     //
  
     var naanlib = new exports.Naanlib();
+    var dontSaveUntilWorking;                                               // true when state loaded, must be reset to save state again
     var contSelf = this;                                                    // this is us, for access within nested functions
     exports.naancon = this;                                                 // access to this instance
     contSelf.anaan = naanlib.js.n;
     naanlib.js.t = contSelf;
+    naanlib.js.q = querystrings;
     var replstate;                                                          // latest known state of the REPL
     var naanstate;                                                          // desired state for the interpreter
     var replqueue;                                                          // text destined for terminal when opened
     var termlist = [];                                                      // list of terminals currently attached
+    contSelf.termlist = termlist;
     var prefs = { };
+    var vsiteName;
 
     //
     // termTextOut
@@ -149,8 +153,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 +215,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 +240,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 +261,9 @@ exports.NaanControllerWeb = function() {
     this.DispatchDebugger = function DispatchDebugger(data) {               // "local" -> "remote"
         if (debugListener)
             setTimeout(function() {
-                debugListener(data)
+                debugListener(data);
             }, 1);
-    }
+    };
 
     //
     // Status
@@ -290,7 +301,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 +398,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) {
@@ -315,6 +414,16 @@ exports.NaanControllerWeb = function() {
     this.LoadPref = function LoadPref(key) {
         return (prefs[key]);
     };
+    
+    //
+    // Working
+    //
+    // The application is working, so it is safe to save state.
+    //
+    
+    this.Working = function Working() {
+        dontSaveUntilWorking = false;
+    };
  
     var saveEvent = new Event("NaanSave");
  
@@ -333,6 +442,7 @@ exports.NaanControllerWeb = function() {
     window.addEventListener("unload", function (e) {
         window.dispatchEvent(saveEvent);
         saveLocal();
+        virtualClose();
     });
  
     window.addEventListener("beforeunload", function (e) {
@@ -344,15 +454,15 @@ exports.NaanControllerWeb = function() {
         var statedoc = {};
         statedoc.curversion = kStateCurrentVersion;
         statedoc.firstver = kStateFirstVersion;
-        statedoc.licensee = "Zulch Laboratories, Inc.";
-        statedoc.verstring = "1.0.2-1";
+        statedoc.licensee = "$Licensee$";
+        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);
@@ -362,9 +472,12 @@ exports.NaanControllerWeb = function() {
         if (statedoc===undefined || statedoc.naan === undefined
             || statedoc.firstver > kStateCurrentVersion
             || statedoc.curversion < kStateFirstVersion
-            || statedoc.licensee != "Zulch Laboratories, Inc."
-            || statedoc.verstring != "1.0.2-1")
+            || 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")
@@ -374,6 +487,10 @@ exports.NaanControllerWeb = function() {
  
     function saveLocal() {
         /*jshint sub:true */
+        if (dontSaveUntilWorking) {                                         // saved state is problematic
+            localStorage.removeItem("NaanState_Hosted");
+            return (false);
+        }
         if (querystrings["nosave"])
             return (false);
         var statedoc = makeState();
@@ -381,8 +498,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 +513,8 @@ 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");
+                dontSaveUntilWorking = true;
                 if (statestr)
                     return (loadState(JSON.parse(statestr)));
             }
@@ -405,7 +523,30 @@ 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,
+                title: vsiteName + " $Version$"
+            });
+    }
     
+    function virtualClose() {
+        if (window.opener && window.opener.Naanlang) {
+            window.opener.Naanlang.naancon.DispatchMessage({
+                op: "VsiteClose",
+                name: vsiteName,
+                naancont: contSelf,
+                title: vsiteName + " $Version$"
+            });
+            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
@@ -419,8 +560,17 @@ exports.NaanControllerWeb = function() {
             naanlib.banner();
             naanlib.textLine("print();;\n");
         }
-        naanlib.start({
-            state: naanstate
+        if (!naanlib.start({ state: naanstate })) {                         // state loading failed
+            localStorage.removeItem("NaanState_Hosted");
+            window.location.reload();
+        }
+    }
+
+    if (window.opener) {
+        virtualOpen();
+        var term = new CloneDebugTerminal();
+        term.OnMessage({
+            id: "loaded"
         });
     }
 };