linny-r 1.2.1 → 1.3.1

package/README.md

@@ -25,7 +25,7 @@ Technical documentation will be developed on GitHub: https://github.com/pwgbots/
 Linny-R is developed as a JavaScript package, and requires that **Node.js** is installed on your computer. 
 This software can be downloaded from <a href="https://nodejs.org" target="_blank">https://nodejs.org</a>. 
 Make sure that you choose the correct installer for your computer.
-Linny-R is developed using the _current_ release. Presently (April 2023) this is 20.0.0. 
+Linny-R is developed using the _current_ release. Presently (June 2023) this is 20.3.0. 
 
 Run the installer and accept the default settings.
 There is **no** need to install the optional _Tools for Native Modules_.
@@ -36,7 +36,7 @@ Verify the installation by typing:
 
 ``node --version``
 
-The response should be the version number of Node.js, for example: v20.0.0.
+The response should be the version number of Node.js, for example: v20.3.0.
 
 ## Installing Linny-R
 It is advisable to install Linny-R in a directory on your computer, not in a cloud. 
@@ -170,8 +170,8 @@ Open the Command Line Interface (CLI) of your computer, change to your `WORKING_
 This response should be something similar to:
 
 <pre>
-Node.js server for Linny-R version 1.1.21
-Node.js version: v20.0.0
+Node.js server for Linny-R version 1.2.1
+Node.js version: v20.3.0
 ... etc.
 </pre>
 
@@ -286,8 +286,8 @@ To install Inkscape, please look here: https://inkscape.org/release
 Linny-R will automatically detect whether Inkscape is installed by searching for it in the environment variable PATH on your computer.
 On a macOS computer, Linny-R will look for Inkscape in /Applications/Inkscape.app/Contents/MacOS.
 
-**NOTE:** The current installation wizard for Inkscape (version 1.2) does **not** add the application to the PATH variable,
-so you need to do this yourself.
+**NOTE:** The current installation wizard for Inkscape (version 1.2.2) may **not** add the application to the PATH variable.
+Please check whether you need to do this yourself.
 
 ## Using Linny-R console
 

package/console.js

@@ -113,10 +113,14 @@ Possible options are:
   channel=[identifier]  will start listening at the specified channel
                         (FUTURE OPTION)
   check                 will report whether current version is up-to-date
-  model=[path]          will load model file in [path]
+  data-dir=[path]       will look for series data files in [path] instead of
+                        (main)/user/data
+  model=[path]          will load model file specified by [path]
   module=[name@repo]    will load model [name] from repository [repo]
                         (if @repo is blank, repository "local host" is used)
                         (FUTURE OPTION)
+  report=[name]         will write run results to [name]-series.txt and
+                        [name]-stats.txt in (workspace)/reports
   run                   will run the loaded model
   solver=[name]         will select solver [name], or warn if not found
                         (name choices: Gurobi or LP_solve)
@@ -196,7 +200,7 @@ class ConsoleMonitor {
     return true;
   }
 
-  submitBlockToSolver(bcode) {
+  submitBlockToSolver() {
     let top = MODEL.timeout_period;
     if(VM.max_solver_time && top > VM.max_solver_time) {
       top = VM.max_solver_time;
@@ -211,7 +215,7 @@ class ConsoleMonitor {
             token: VM.solver_token,
             block: VM.block_count,
             round: VM.round_sequence[VM.current_round],
-            data: bcode,
+            data: VM.lines,
             timeout: top
           }));
       VM.processServerResponse(data);
@@ -247,11 +251,81 @@ class ConsoleMonitor {
 } // END of class ConsoleMonitor
 
 
+// NOTE: This implementation is very incomplete, still!
+class ConsoleRepositoryBrowser {
+  constructor() {
+    this.repositories = [];
+    this.repository_index = -1; 
+    this.module_index = -1;
+    // Get the repository list from the modules
+    this.getRepositories();
+    this.reset();
+  }
+  
+  reset() {
+    this.visible = false;
+  }
+
+  get isLocalHost() {
+    // Returns TRUE if first repository on the list is 'local host'
+    return this.repositories.length > 0 &&
+      this.repositories[0].name === 'local host';
+  }
+
+  getRepositories() {
+    // Gets the list of repository names from the server
+    this.repositories.length = 0;
+    // @@TO DO!!
+  }
+  
+  repositoryByName(n) {
+    // Returns the repository having name `n` if already known, otherwise NULL
+    for(let i = 0; i < this.repositories.length; i++) {
+      if(this.repositories[i].name === n) {
+        return this.repositories[i];
+      }
+    }
+    return null;
+  }
+  
+  asFileName(s) {
+    // NOTE: asFileName is implemented as function (see below) to permit
+    // its use prior to instantiation of the RepositoryBrowser
+    return stringToFileName(s);
+  }
+  
+}
+
+function stringToFileName(s) {
+  // Returns string `s` with whitespace converted to a single dash, and
+  // special characters converted to underscores
+  return s.normalize('NFKD').trim()
+      .replace(/[\s\-]+/g, '-')
+      .replace(/[^A-Za-z0-9_\-]/g, '_')
+      .replace(/^[\-\_]+|[\-\_]+$/g, '');
+}
+
 // CLASS ConsoleFileManager allows loading and saving models and diagrams, and
 // handles the interaction with the MILP solver via `exec` calls and files
 // stored on the modeler's computer
 class ConsoleFileManager {
 
+  anyOSpath(p) {
+    // Helper function that converts any path notation to platform notation
+    // based on the predominant separator
+    const
+       s_parts = p.split('/'),
+       bs_parts = p.split('\\'),
+       parts = (s_parts.length > bs_parts.length ? s_parts : bs_parts);
+    // On macOS machines, paths start with a slash, so first substring is empty
+    if(parts[0].endsWith(':') && path.sep === '\\') {
+      // On Windows machines, add a backslash after the disk (if specified)
+      parts[0] += path.sep;
+    }
+    // Reassemble path for the OS of this machine
+    return path.join(...parts);
+  }
+  
   getRemoteData(dataset, url) {
     // Gets data from a URL, or from a file on the local host 
     if(url === '') return;
@@ -281,7 +355,13 @@ class ConsoleFileManager {
         console.log('ERROR: Invalid URL', url);
       }
     } else {
-      const fp = anyOSpath(url);
+      let fp = this.anyOSpath(url);
+      if(!(fp.startsWith('/') || fp.startsWith('\\') || fp.indexOf(':\\') > 0)) {
+        // Relative path => add path to specified data path or to the
+        // default location user/data
+        fp = path.join(SETTINGS.data_path || WORKSPACE.data, fp);
+        console.log('Full path: ', fp);
+      }
       fs.readFile(fp, 'utf8', (err, data) => {
           if(err) {
             console.log(err);
@@ -354,6 +434,17 @@ class ConsoleFileManager {
       });
   }
 
+  writeStringToFile(s, fp) {
+    // Write string `s` to path `fp`
+    try {
+      fs.writeFileSync(fp, s);
+      console.log(pluralS(s.length, 'character') + ' written to file ' + fp);
+    } catch(err) {
+      console.log(err);
+      console.log('ERROR: Failed to write data to file ' +  fp);
+    }
+  }
+
 } // END of class ConsoleFileManager
 
 // CLASS ConsoleReceiver defines a listener/interpreter for channel commands
@@ -702,7 +793,9 @@ function commandLineSettings() {
   const settings = {
       cli_name: (PLATFORM.startsWith('win') ? 'Command Prompt' : 'Terminal'),
       check: false,
+      data_path: '',
       preferred_solver: '',
+      report: '',
       run: false,
       solver: '',
       solver_path: '',
@@ -759,6 +852,31 @@ function commandLineSettings() {
           console.log(`ERROR: File "${av[1]}" not found`);
           process.exit();
         }
+      } else if(av[0] === 'data-dir') {
+        // Set path (if valid) to override default data directory
+        const dp = av[1];
+        try {
+          // See whether the directory already exists
+          try {
+            fs.accessSync(dp, fs.constants.R_OK | fs.constants.W_O);
+          } catch(err) {
+            // If not, try to create it
+            fs.mkdirSync(dp);
+            console.log('Created data directory:', dp);
+          }
+          settings.data_path = dp;
+        } catch(err) {
+          console.log(err.message);
+          console.log('ERROR: Failed to create data directory:', dp);
+        }
+      } else if(av[0] === 'report') {
+        // Set report file name (if valid)
+        const rfn = stringToFileName(av[1]);
+        if(/^[A-Za-z0-9]+/.test(rfn)) {
+          settings.report = path.join(settings.user_dir, 'reports', rfn);
+        } else {
+          console.log(`WARNING: Invalid report file name "{$rfn}"`);
+        }
       } else if(av[0] === 'module') {
         // Add default repository is none specified
         if(av[1].indexOf('@') < 0) av[1] += '@local host';
@@ -882,10 +1000,13 @@ function createWorkspace() {
   }
   // Define the sub-directory paths
   const ws = {
+      autosave: path.join(SETTINGS.user_dir, 'autosave'),
       channel: path.join(SETTINGS.user_dir, 'channel'),
       callback: path.join(SETTINGS.user_dir, 'callback'),
+      data: path.join(SETTINGS.user_dir, 'data'),
       diagrams: path.join(SETTINGS.user_dir, 'diagrams'),
       modules: path.join(SETTINGS.user_dir, 'modules'),
+      reports: path.join(SETTINGS.user_dir, 'reports'),
       solver_output: path.join(SETTINGS.user_dir, 'solver'),
     };
   // Create these sub-directories if not aready there
@@ -968,7 +1089,7 @@ PROMPTER.questionPrompt = (str) => {
 // Initialize the Linny-R console components as global variables
 global.UI = new Controller();
 global.VM = new VirtualMachine();
-//global.REPOSITORY_BROWSER = new ConsoleRepositoryBrowser(),  // still to re-code
+global.REPOSITORY_BROWSER = new ConsoleRepositoryBrowser();
 global.FILE_MANAGER = new ConsoleFileManager();
 global.DATASET_MANAGER = new DatasetManager();
 global.CHART_MANAGER = new ChartManager();
@@ -990,8 +1111,19 @@ if(SETTINGS.model_path) {
         MONITOR.show_log = SETTINGS.verbose;
         VM.callback = () => {
             const od = model.outputData;
-            console.log(od[0]);
-            console.log(od[1]);
+            // Output data is two-string list [time series, statistics]
+            if(SETTINGS.report) {
+              // Output time series
+              FILE_MANAGER.writeStringToFile(od[0],
+                  SETTINGS.report + '-series.txt');
+              // Output statistics
+              FILE_MANAGER.writeStringToFile(od[1],
+                  SETTINGS.report + '-stats.txt');
+            } else {
+              // Output strings to console
+              console.log(od[0]);
+              console.log(od[1]);
+            }
             VM.callback = null;
         };
         VM.solveModel();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linny-r",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Executable graphical language with WYSIWYG editor for MILP models",
   "main": "server.js",
   "scripts": {
@@ -29,4 +29,4 @@
     "url": "https://github.com/pwgbots/linny-r/issues"
   },
   "homepage": "https://github.com/pwgbots/linny-r#readme"
-}
+}

package/server.js

@@ -847,20 +847,19 @@ function repoDelete(res, name, file) {
 // Dataset dialog
 
 function anyOSpath(p) {
-  // Helper function that converts Unix path notation (with slashes) to
-  // Windows notation if needed
-  if(p.indexOf('/') < 0) return p;
-  p = p.split('/');
+  // Helper function that converts any path notation to platform notation
+  // based on the predominant separator
+  const
+     s_parts = p.split('/'),
+     bs_parts = p.split('\\'),
+     parts = (s_parts.length > bs_parts.length ? s_parts : bs_parts);
   // On macOS machines, paths start with a slash, so first substring is empty
-  if(p[0].length === 0) {
-      // In that case, add the leading slash
-    return '/' + path.join(...p);
-  } else if(p[0].endsWith(':') && path.sep === '\\') {
+  if(parts[0].endsWith(':') && path.sep === '\\') {
     // On Windows machines, add a backslash after the disk (if specified)
-    path[0] += path.sep;
+    parts[0] += path.sep;
   }
   // Reassemble path for the OS of this machine
-  return path.join(...p);
+  return path.join(...parts);
 }
 
 function loadData(res, url) {
@@ -881,7 +880,11 @@ function loadData(res, url) {
       servePlainText(res, `ERROR: Invalid URL <tt>${url}</tt>`);
     }
   } else {
-    const fp = anyOSpath(url);
+    let fp = anyOSpath(url);
+    if(!(fp.startsWith('/') || fp.startsWith('\\') || fp.indexOf(':\\') > 0)) {
+      // Relative path => add path to user/data directory
+      fp = path.join(WORKSPACE.data, fp);
+    }
     fs.readFile(fp, 'utf8', (err, data) => {
         if(err) {
           console.log(err);
@@ -1568,6 +1571,7 @@ function createWorkspace() {
       autosave: path.join(SETTINGS.user_dir, 'autosave'),
       channel: path.join(SETTINGS.user_dir, 'channel'),
       callback: path.join(SETTINGS.user_dir, 'callback'),
+      data: path.join(SETTINGS.user_dir, 'data'),
       diagrams: path.join(SETTINGS.user_dir, 'diagrams'),
       modules: path.join(SETTINGS.user_dir, 'modules'),
       solver_output: path.join(SETTINGS.user_dir, 'solver'),

package/static/index.html

@@ -28,7 +28,7 @@ implementation is made available via the Linny-R web site.
 -->
 
 <!--
-Copyright (c) 2017-2022 Delft University of Technology
+Copyright (c) 2017-2023 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -239,7 +239,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
       <img id="load-btn" class="btn enab" src="images/open.png"
            title="Load model (Ctrl-L)">
       <img id="settings-btn" class="btn enab" src="images/settings.png"
-           title="Change settings (Ctrl-V)">
+           title="Change model settings (Alt-M)">
       <img id="save-btn" class="btn enab" src="images/save.png"
            title="Save model (Ctrl-S)">
       <img id="repository-btn" class="btn enab" src="images/repository.png"
@@ -321,6 +321,11 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         <td id="step-sep">
           <img id="stepforward-btn" class="sbtn senab" src="images/forward.png">
         </td>
+        <td id="issue-panel">
+          <span id="prev-issue">&#x25C1;</span>
+          <span id="issue-nr"></span>
+          <span id="next-issue">&#x25B7;</span>
+        </td>
         <td id="info-line" title="Status bar"></td>
         <td id="autosave-sep">
           <img id="autosave-btn" class="btn enab" src="images/restore.png">
@@ -347,7 +352,9 @@ and move the cursor over the status bar">
     <img id="note-btn" class="btn toggle enab sep" src="images/note.png"
          title="Add note">
     <img id="clone-btn" class="btn disab sep" src="images/clone.png"
-         title="Clone selection (Ctrl-C)">
+         title="Copy selection (Ctrl-C) &ndash; Alt-click to clone (Alt-C)">
+    <img id="paste-btn" class="btn disab sep" src="images/paste.png"
+         title="Paste selection (Ctrl-V) -- WORK IN PROGESS!">
     <img id="delete-btn" class="btn disab sep" src="images/delete.png"
          title="Delete">
     <img id="undo-btn" class="btn enab" src="images/undo.png"
@@ -1530,7 +1537,8 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
     <div id="ds-filter-bar">
       <input id="ds-filter-text" type="text"
              placeholder="(name filtering pattern)"
-             title="Pattern may contain logical & (AND), | (OR) and ^ (NOT)">
+             title="Pattern may contain logical & (AND), | (OR) and ^ (NOT)
+Start with = to find exact match, with ~ to match first characters">
     </div>
     <div id="dataset-scroll-area">
       <table id="dataset-table">
@@ -1584,6 +1592,9 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
       <img id="ds-delete-modif-btn" class="btn disab"
            src="images/delete.png" title="Delete selected modifier"
            style="margin-left: 20px">
+      <img id="ds-convert-modif-btn" class="btn enab blink"
+           src="images/dataset.png" title="Convert modifiers to prefixed datasets"
+           style="margin-left: 20px; display: none">
     </div>
     <div id="dataset-resize" class="resizer"></div>
   </div>
@@ -1604,7 +1615,7 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
   <div id="rename-dataset-modal" class="modal">
     <div id="rename-dataset-dlg" class="inp-dlg">
       <div class="dlg-title">
-        Rename dataset
+        <span id="rename-dataset-title">Rename dataset</span>
         <img class="cancel-btn" src="images/cancel.png">
         <img class="ok-btn" src="images/ok.png">
       </div>
@@ -1643,6 +1654,23 @@ NOTE: * and ? will be interpreted as wildcards"
     </div>
   </div>
 
+  <!-- the CONVERT MODIFIER prompts for the new name of a dataset -->
+  <div id="convert-modifiers-modal" class="modal">
+    <div id="convert-modifiers-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Convert modifiers to datasets
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <div style="margin: 4px">
+        Each modifier will become a dataset
+        <tt><em>prefix</em>:&nbsp;<em>selector</em></tt>
+        using this prefix: 
+      </div>
+      <input id="convert-modifiers-prefix" type="text" autocomplete="off">
+    </div>
+  </div>
+
   <!-- the SERIES dialog presents the properties of the time series
        data of the selected dataset, including a text area for copy/paste
        of numbers while showing the line count and checking for correct
@@ -1676,8 +1704,11 @@ NOTE: * and ? will be interpreted as wildcards"
         <!-- options are added by DATASET_MANAGER -->
       </select>
       <div id="series-remote">
-      <input id="series-url" type="text"
-             placeholder="(URL or path on local host)"> </div>
+        <img id="series-clip" src="images/paperclip.png">
+        <input id="series-url" type="text"
+               placeholder="URL or path on local host"
+               title="Path can be absolute or relative to (Linny-R)/user/data">
+      </div>
       <div id="series-data-lbl">Series data:</div>
       <textarea id="series-data" autocomplete="off"
           autocorrect="off" autocapitalize="off" spellcheck="false">
@@ -1859,7 +1890,8 @@ NOTE: * and ? will be interpreted as wildcards"
       <div style="padding: 4px; width: 100px">
         <div id="variable-color-div">
           <div style="display:inline-block; vertical-align:top">Color:</div>
-          <div id="variable-color"></div>
+          <div id="variable-color" title="Click to copy, Shift-click to paste"></div>
+          <div id="variable-paste-color"></div>
         </div>
         <div id="variable-scale-div" style="margin-top: 3px">
           <div style="display:inline-block; vertical-align:top; margin-top: 2px">

package/static/linny-r.css

@@ -10,7 +10,7 @@ file that implements the graphical user interface for Linny-R.
 */
 
 /*
-Copyright (c) 2017-2022 Delft University of Technology
+Copyright (c) 2017-2023 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -413,6 +413,7 @@ textarea {
 #zoom-sep,
 #step-sep,
 #info-line,
+#issue-panel,
 #autosave-sep {
   border-right: 1px solid #e2d8e8;
 }
@@ -507,6 +508,36 @@ div.notification-msg.first-msg {
   color: black;
 }
 
+#issue-panel {
+  display: none;
+  background-color: Yellow;
+  white-space: nowrap;
+  padding: 0 3px;
+}
+
+#issue-nr {
+  padding: 0 4px;
+  cursor: pointer;
+}
+
+#prev-issue,
+#next-issue {
+  cursor: pointer;
+}
+
+#prev-issue:hover,
+#issue-nr:hover,
+#next-issue:hover {
+  color: Orange;
+}
+
+#prev-issue.disab,
+#next-issue.disab {
+  cursor: default;
+  pointer-events: none;
+  color: #e8d898;
+}
+
 /* Modal dialogs cover the entire browser window with a dark,
    semi-transparent DIV that ignores mouse events. Their z-index
    is 100+ so that they cover "stay-on-top" dialogs. */ 
@@ -2091,84 +2122,103 @@ tr.def-sel {
   font-weight: bold;
 }
 
-td.modif::before {
+tr.dataset > td > div {
+  display: inline-block;
+}
+
+div.ds-indent {
+  color: #909090;
+  text-align: right;
+  font-weight: normal !important;
+  margin-right: 2px;
+  margin-left: 3px;
+}
+
+div.tree-btn {
+  color: #909090;
+  margin-right: 3px;
+  cursor: pointer;
+  margin-left: -13px;
+}
+
+div.modif::before {
   content: ' \2045';
   color: #b00080;
   margin-right: 2px;
 }
 
-td.outcome::before {
+div.outcome::before {
   content: ' \25C8';
   color: #b00080;
   margin-right: 1px;
 }
 
-td.array::before {
+div.array::before {
   content: ' \2263';
   color: #b00080;
   margin-right: 1px;
 }
 
-td.series::before {
+div.series::before {
   content: ' \28B8';
   color: #b00080;
   margin-left: -4px;
 }
 
-td.outcome.modif::before {
+div.outcome.modif::before {
   content: ' \25C8\2045';
   color: #b00080;
   margin-right: 2px;
 }
 
-td.array.modif::before {
+div.array.modif::before {
   content: ' \2263\2045';
   color: #b00080;
   margin-right: 1px;
 }
 
-td.series.modif::before {
+div.series.modif::before {
   content: ' \28B8\2045';
   color: #b00080;
   margin-left: -4px;
 }
 
-td.blackbox::before {
+div.blackbox::before {
   content: ' \25FC';
   color: #b00080;
 }
 
-td.blackbox.series::before {
+div.blackbox.series::before {
   content: ' \25FC\28B8';
   color: #b00080;
 }
 
-td.blackbox.array::before {
+div.blackbox.array::before {
   content: ' \25FC\2263';
   color: #b00080;
 }
 
-td.blackbox.outcome::before {
+div.blackbox.outcome::before {
   content: ' \25FC\25C8';
   color: #b00080;
 }
 
-td.blackbox.modif::before {
+div.blackbox.modif::before {
   content: ' \25FC\2045';
   color: #b00080;
 }
 
-td.blackbox.series.modif::before {
+div.blackbox.series.modif::before {
   content: ' \25FC\28B8\2045';
   color: #b00080;
 }
 
-td.blackbox.array.modif::before {
+div.blackbox.array.modif::before {
   content: ' \25FC\2263\2045';
   color: #b00080;
 }
 
-td.blackbox.outcome.modif::before {
+div.blackbox.outcome.modif::before {
   content: ' \25FC\25C8\2045';
   color: #b00080;
 }
@@ -2294,6 +2344,17 @@ td.equation-expression {
   bottom: 5px;
 }
 
+/* CONVERT MODIFIERS modal dialog */
+#convert-modifiers-dlg {
+  width: 220px;
+  height: 84px;
+}
+
+#convert-modifiers-prefix {
+  margin: 3px;
+  width: calc(100% - 8px);
+}
+
 /* SERIES modal dialog */
 #series-dlg {
   width: 165px;
@@ -2407,12 +2468,18 @@ td.equation-expression {
 #series-remote {
   position: absolute;
   top: 134px;
-  left: 3px;
-  width: calc(100% - 8px);
+  left: 2px;
+  width: calc(100% - 5px);
+}
+
+#series-clip {
+  height: 12px;
+  width: 132x;
+  vertical-align: middle;
 }
 
 #series-url {
-  width: 100%;
+  width: calc(100% - 17px);
   font-size: 12px;
 }
 
@@ -2738,6 +2805,17 @@ img.v-disab {
   height: 15px;
   border: 1px solid Black;
   background-color: #c00000;
+  cursor: pointer;
+}
+
+#variable-paste-color {
+  display: none;
+  vertical-align: top;
+  margin-left: 3px;
+  width: 13px;
+  height: 13px;
+  border: 1px solid Silver;
+  background-color: #c00000;
 }
 
 #variable-scale {