linny-r 2.0.8 → 2.0.10

package/static/scripts/linny-r-ctrl.js

@@ -192,58 +192,57 @@ class Controller {
     // NOTE: Add '' in case string is a number
     const lines = ('' + string).split('\n');
     let w = 0;
-    for(let i = 0; i < lines.length; i++) {
-      w = Math.max(w, lines[i].length * cw);
+    for(const l of lines) {
+      w = Math.max(w, l.length * cw);
     }
     return {width: w, height: lines.length * ch};
   }
 
   stringToLineArray(string, width=100, fsize=8) {
-    // Returns an array of strings wrapped to given width at given font size
-    // while preserving newlines -- used to format text of notes
+    // Return an array of strings wrapped to given width at given font size
+    // while preserving newlines -- used to format text of notes.
     const
         multi = [],
         lines = string.split('\n'),
-        ll = lines.length,
         // If no paper, assume 144 px/inch, so 1 pt = 2 px
         fh = (this.paper ? this.paper.font_heights[fsize] : 2 * fsize),
         scalar = fh / 2;
-    for(let i = 0; i < ll; i++) {
+    for(const l of lines) {
       // NOTE: interpret two spaces as a "non-breaking" space
-      const words = lines[i].replace(/  /g, '\u00A0').trim().split(/ +/);
+      const words = l.replace(/  /g, '\u00A0').trim().split(/ +/);
       // Split words at '-' when wider than width
-      for(let j = 0; j < words.length; j++) {
-        if(words[j].length * scalar > width) {
-          const sw = words[j].split('-');
-          if(sw.length > 1) {
-            // Replace j-th word by last fragment of split string
-            words[j] = sw.pop();
+      for(let i = 0; i < words.length; i++) {
+        if(words[i].length * scalar > width) {
+          const sw = words[i].split('-');
+          if(sw[0] && sw.length > 1) {
+            // Replace i-th word by last fragment of split string
+            words[i] = sw.pop();
             // Insert remaining fragments before
-            while(sw.length > 0) words.splice(j, 0, sw.pop() + '-');
+            while(sw.length > 0) words.splice(i, 0, sw.pop() + '-');
           }
         }
       }
-      let line = words[0] + ' ';
-      for(let j = 1; j < words.length; j++) {
+      let line = words.shift() + ' ';
+      for(const word of words) {
         const
-            l = line + words[j] + ' ',
+            l = line + word + ' ',
             w = (l.length - 1) * scalar;
-        if (w > width && j > 0) {
+        if (w > width) {
           const
               nl = line.trim(),
               nw = Math.floor(nl.length * scalar);
           multi.push(nl);
           // If width of added line exceeds the given width, adjust width
-          // so that following lines fill out better
+          // so that following lines fill out better.
           width = Math.max(width, nw);
-          line = words[j] + ' ';
+          line = word + ' ';
         } else {
           line = l;
         }
       }
       line = line.trim();
       // NOTE: Chrome and Safari ignore empty lines in SVG text; as a workaround,
-      // we add a non-breaking space to lines containing only whitespace
+      // we add a non-breaking space to lines containing only whitespace.
       if(!line) line = '\u00A0';
       multi.push(line);
     }
@@ -280,19 +279,19 @@ class Controller {
   // Methods to ensure proper naming of entities.
 
   cleanName(name) {
-    // Returns `name` without the object-attribute separator |, backslashes,
+    // Return `name` without the object-attribute separator |, backslashes,
     // and leading and trailing whitespace, and with all internal whitespace
     // reduced to a single space.
     name = name.replace(this.OA_SEPARATOR, ' ')
         .replace(/\||\\/g, ' ').trim()
         .replace(/\s\s+/g, ' ');
-    // NOTE: this may still result in a single space, which is not a name
+    // NOTE: This may still result in a single space, which is not a name.
     if(name === ' ') return '';
     return name;
   }
   
   validName(name) {
-    // Returns TRUE if `name` is a valid Linny-R entity name. These names
+    // Return TRUE if `name` is a valid Linny-R entity name. These names
     // must not be empty strings, may not contain brackets, backslashes or
     // vertical bars, may not end with a colon, and must start with an
     // underscore, a letter or a digit.
@@ -335,7 +334,7 @@ class Controller {
   }
   
   completePrefix(name) {
-    // Returns the prefix part (including the final colon plus space),
+    // Return the prefix part (including the final colon plus space),
     // or the empty string if none.
     const p = UI.prefixesAndName(name);
     p[p.length - 1] = '';
@@ -343,6 +342,7 @@ class Controller {
   }
   
   sharedPrefix(n1, n2) {
+    // Return the longest series of prefixes that `n1` and `n2` have in common.
     const
         pan1 = this.prefixesAndName(n1),
         pan2 = this.prefixesAndName(n2),
@@ -350,7 +350,7 @@ class Controller {
         shared = [];
     let i = 0;
     while(i < l && ciCompare(pan1[i], pan2[i]) === 0) {
-      // NOTE: if identical except for case, prefer "Abc" over "aBc" 
+      // NOTE: If identical except for case, prefer "Abc" over "aBc".
       shared.push(pan1[i] < pan2[i] ? pan1[i] : pan2[i]);
       i++;
     }
@@ -358,26 +358,90 @@ class Controller {
   }
   
   colonPrefixedName(name, prefix) {
-    // Replaces a leading colon in `name` by `prefix`.
+    // Replace a leading colon in `name` by `prefix`.
     // If `name` identifies a link or a constraint, this is applied to
     // both node names.
+    // NOTE: To give the modeler more control over what to use as prefix,
+    // successive colons indicate that a shorter prefix should be used.
+    // For example, when the prefix is XXX: YYY: ZZZ, two colons mean
+    // "use only XXX: YYY:", three colons "use only XXX:", etc.
     const
         arrow = (name.indexOf(this.LINK_ARROW) >= 0 ?
             this.LINK_ARROW : this.CONSTRAINT_ARROW),
         nodes = name.split(arrow);
     for(let i = 0; i < nodes.length; i++) {
-      nodes[i] = nodes[i].replace(/^:\s*/, prefix)
+      // First check for the special case of just a leading colon plus
+      // possibly an entity attribute.
+      // NOTE:
+      const m = nodes[i].match(/^(:+)\s*(\|[^\|]*)/);
+      if(m) {
+        // Split prefix in parts.
+        const p = prefix.split(UI.PREFIXER);
+        // Remove last (empty!) substring.
+        p.pop();
+        // Shorten prefix by the number of successive colons minus 1.
+        for(let i = 1; i < m[1].length; i++) p.pop();
+        p.push('');
+        // New name is just the (shortened) prefix without its last ": ".
+        nodes[i] = p.join(UI.PREFIXER).replace(/:\s*$/, '') + m[2];
+      } else {
+        // Prefix is typically leading, so try to replace this first.
+        const m = nodes[i].match(/^(:+)/);
+        if(m) {
+          // Shorten prefix by the number of successive colons minus 1.
+          let p = prefix.split(UI.PREFIXER);
+          p.pop();
+          for(let i = 1; i < m[1].length; i++) p.pop();
+          p.push('');
+          nodes[i] = nodes[i].replace(/^:+\s*/, p.join(UI.PREFIXER));
+        } else {
+          // If no change, try to replace an embedded double prefix.
           // NOTE: An embedded double prefix, e.g., "xxx: : yyy" indicates
           // that the second colon+space should be replaced by the prefix.
-          // This "double prefix" may occur only once in an entity name,
-          // hence no global regexp.
-          .replace(/(\w+):\s+:\s+(\w+)/, `$1: ${prefix}$2`);
+          const m = nodes[i].match(/(\w+):\s+(:+)\s+(\w+)/);
+          if(m) {
+            // Shorten prefix by the number of successive colons minus 1.
+            let p = prefix.split(UI.PREFIXER);
+            p.pop();
+            for(let i = 1; i < m[2].length; i++) p.pop();
+            p.push('');
+            prefix = p.join(UI.PREFIXER);
+            nodes[i] = `${m[1]}: ${prefix}${m[3]}`;
+          }
+        }
+      }
     }
     return nodes.join(arrow);
   }
+
+  entityPrefix(name) {
+    // Return the prefix of `name` with its trailing colon+space.
+    const
+        arrow = (name.indexOf(this.LINK_ARROW) >= 0 ?
+            this.LINK_ARROW : this.CONSTRAINT_ARROW),
+        nodes = name.split(arrow);
+    if(nodes.length === 1) return this.completePrefix(name);
+    // For names of links and constraints, it depends:
+    const
+        fn = nodes[0],
+        tn = nodes[1];
+    if(fn.indexOf(UI.PREFIXER) >= 0) {
+      if(tn.indexOf(UI.PREFIXER) >= 0) {
+        // If BOTH nodes are prefixed, use the longest prefix that these
+        // nodes have in common...
+        return UI.sharedPrefix(fn, tn) + UI.PREFIXER;
+      }
+      // .. otherwise, return the FROM node prefix.
+      return UI.completePrefix(fn);
+    }
+    // No FROM node prefix => return the TO node prefix (if any)
+    if(tn.indexOf(UI.PREFIXER) >= 0) return UI.completePrefix(tn);
+    // No prefixers => empty prefix.
+    return '';
+  }
   
   tailNumber(name) {
-    // Returns the string of digits at the end of `name`. If not there,
+    // Return the string of digits at the end of `name`. If not there,
     // check prefixes (if any) *from right to left* for a tail number.
     // Thus, the number that is "closest" to the name part is returned.
     const pan = UI.prefixesAndName(name);
@@ -429,7 +493,6 @@ class Controller {
     return pan1.length - pan2.length;
   }
 
-  
   nameToID(name) {
     // Return a name in lower case with link arrow replaced by three
     // underscores, constraint link arrow by four underscores, and spaces
@@ -444,10 +507,11 @@ class Controller {
       // Empty string signals failure.
       return '';
     }
-    // NOTE: Replace single quotes by Unicode apostrophe so that they
-    // cannot interfere with JavaScript strings delimited by single quotes.
+    // NOTE: Replace single quotes by Unicode apostrophe, and double quotes
+    // by Unicode mono-space " so that quotes cannot interfere with string
+    // delimiters used in JavaScript or HTML.
     return name.toLowerCase().replace(/\s/g, '_')
-        .replace("'", '\u2019').replace('"', '\uff02');
+        .replaceAll("'", '\u2019').replaceAll('"', '\uff02');
   }
   
   htmlEquationName(n) {
@@ -654,9 +718,8 @@ class RepositoryBrowser {
       .then((data) => {
           if(UI.postResponseOK(data)) {
             // NOTE: Trim to prevent empty name strings.
-            const rl = data.trim().split('\n');
-            for(let i = 0; i < rl.length; i++) {
-              this.addRepository(rl[i].trim());
+            for(const r of data.trim().split('\n')) {
+              this.addRepository(r.trim());
             }
           }
           // NOTE: Set index to first repository on list (typically the
@@ -669,23 +732,12 @@ class RepositoryBrowser {
   
   repositoryByName(n) {
     // Return the repository having name `n` if already known, or NULL.
-    for(let i = 0; i < this.repositories.length; i++) {
-      if(this.repositories[i].name === n) {
-        return this.repositories[i];
-      }
+    for(const r of this.repositories) {
+      if(r.name === n) return r;
     }
     return null;
   }
   
-  asFileName(s) {
-    // Return 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, '');
-  }
-  
   loadModuleAsModel() {
     // Load selected module as model.
     if(this.repository_index >= 0 && this.module_index >= 0) {
@@ -842,9 +894,7 @@ class ChartManager {
   
   resetChartVectors() {
     // Reset vectors of all charts.
-    for(let i = 0; i < MODEL.charts.length; i++) {
-      MODEL.charts[i].resetVectors();
-    }
+    for(const c of MODEL.charts) c.resetVectors();
   }
 
   promptForWildcardIndices(chart, dsm) {
@@ -916,9 +966,8 @@ class SensitivityAnalysis {
       // Clear results from previous analysis.
       this.clearResults();
       this.parameters = [];
-      for(let i = 0; i < MODEL.sensitivity_parameters.length; i++) {
+      for(const p of MODEL.sensitivity_parameters) {
         const
-            p = MODEL.sensitivity_parameters[i],
             vn = p.split(UI.OA_SEPARATOR),
             obj = MODEL.objectByName(vn[0]),
             oax = (obj ? obj.attributeExpression(vn[1]) : null);
@@ -932,20 +981,16 @@ class SensitivityAnalysis {
         }
       }
       this.chart = new Chart(this.chart_title);
-      for(let i = 0; i < MODEL.sensitivity_outcomes.length; i++) {
-        const vn = MODEL.sensitivity_outcomes[i].split(UI.OA_SEPARATOR);
-        this.chart.addVariable(vn[0], vn[1]);
+      for(const o of MODEL.sensitivity_outcomes) {
+        this.chart.addVariable(...o.split(UI.OA_SEPARATOR));
       }
       this.experiment = new Experiment(this.experiment_title);
       this.experiment.charts = [this.chart];
       this.experiment.inferVariables();
       // This experiment always uses the same combination: the base selectors.
       const bs = MODEL.base_case_selectors.split(' ');
-      this.experiment.combinations = [];
       // Add this combination N+1 times for N parameters.
-      for(let i = 0; i <= this.parameters.length; i++) {
-        this.experiment.combinations.push(bs);
-      }
+      this.experiment.combinations = Array(this.parameters.length + 1).fill(bs);
       // NOTE: Model settings will not be changed, but will be restored after
       // each run => store the original settings.
       this.experiment.original_model_settings = MODEL.settingsString;
@@ -1045,17 +1090,15 @@ class SensitivityAnalysis {
     this.perc = {};
     this.shade = {};
     this.data = {};
-    const
-        ol = MODEL.sensitivity_outcomes.length,
-        rl = MODEL.sensitivity_runs.length;
+    const ol = MODEL.sensitivity_outcomes.length;
     if(ol === 0) return;
     // Always find highest relative change.
     let max_dif = 0;
     for(let i = 0; i < ol; i++) {
       this.data[i] = [];
-      for(let j = 0; j < rl; j++) {
+      for(const run of MODEL.sensitivity_runs) {
         // Get the selected statistic for each run to get an array of numbers.
-        const rr = MODEL.sensitivity_runs[j].results[i];
+        const rr = run.results[i];
         if(!rr) {
           this.data[i].push(VM.UNDEFINED);
         } else if(sas === 'N') {
@@ -1162,8 +1205,7 @@ class ExperimentManager {
     // Select charts having 1 or more variables, as only these are meaningful
     // as the dependent variables of an experiment
     this.suitable_charts.length = 0;
-    for(let i = 0; i < MODEL.charts.length; i++) {
-      const c = MODEL.charts[i];
+    for(const c of MODEL.charts) {
       if(c.variables.length > 0) this.suitable_charts.push(c);
     }
   }  
@@ -1278,23 +1320,22 @@ class ExperimentManager {
       }
       xr.start();
       this.showProgress(ci, p, n);
-      // NOTE: first restore original model settings (setings may be partial!)
+      // NOTE: First restore original model settings (setings may be partial!).
       MODEL.parseSettings(x.original_model_settings);
-      // Parse all active settings selector strings
-      // NOTE: may be multiple strings; the later overwrite the earlier
-      for(let i = 0; i < x.settings_selectors.length; i++) {
-        const ssel = x.settings_selectors[i].split('|');
+      // Parse all active settings selector strings.
+      // NOTE: May be multiple strings; the later overwrite the earlier.
+      for(const sel of x.settings_selectors) {
+        const ssel = sel.split('|');
         if(combi.indexOf(ssel[0]) >= 0) MODEL.parseSettings(ssel[1]);
       }
-      // Also set the correct round sequence
-      // NOTE: if no match, default is retained
-      for(let i = 0; i < x.actor_selectors.length; i++) {
-        const asel = x.actor_selectors[i];
+      // Also set the correct round sequence.
+      // NOTE: If no match, default is retained.
+      for(const asel of x.actor_selectors) {
         if(combi.indexOf(asel.selector) >= 0) {
           MODEL.round_sequence = asel.round_sequence;
         }
       }
-      // Only now compute the simulation run time (number of time steps)
+      // Only now compute the simulation run time (number of time steps).
       xr.time_steps = MODEL.end_period - MODEL.start_period + 1;
       VM.callback = this.callback;
       // NOTE: Asynchronous call. All follow-up actions must be performed
@@ -1304,18 +1345,18 @@ class ExperimentManager {
   }
   
   processRun() {
-    // This method is called by the solveBlocks method of the Virtual Machine
+    // This method is called by the solveBlocks method of the Virtual Machine.
     const x = MODEL.running_experiment;
     if(!x) return;
     const aci = x.active_combination_index;
     if(MODEL.solved) {
-      // NOTE: addresults will call processRestOfRun when completed
+      // NOTE: addresults will call processRestOfRun when completed.
       x.runs[aci].addResults();
     } else {
       // Do not add results...
       UI.warn(`Model run #${aci} incomplete -- results will be invalid`);
-      // ... but do perform the usual post-processing
-      // NOTE: when sensitivity analysis is being performed, switch back to SA
+      // ... but do perform the usual post-processing.
+      // NOTE: When sensitivity analysis is being performed, switch back to SA.
       if(SENSITIVITY_ANALYSIS.experiment) {
         SENSITIVITY_ANALYSIS.processRestOfRun();
       } else {

package/static/scripts/linny-r-gui-actor-manager.js

@@ -72,18 +72,18 @@ class ActorManager {
   }
   
   roundLetter(n) {
-    // Returns integer `n` as lower case letter: 1 = a, 2 = b, 26 = z
-    // NOTE: numbers 27-52 return upper case A-Z; beyond ranges results in '?' 
-    if(n < 1 || n > this.max_rounds) return '?';
+    // Return integer `n` as lower case letter: 1 = a, 2 = b, 26 = z.
+    // NOTE: Numbers 27-31 return upper case A-E; beyond ranges results in '?'.
+    if(n < 1 || n > VM.max_rounds) return '?';
     return VM.round_letters[n];
   }
   
   checkRoundSequence(s) {
     // Expects a string with zero or more round letters
-    for(let i = 0; i < s.length; i++) {
-      const n = VM.round_letters.indexOf(s[i]);
+    for(const rl of s) {
+      const n = VM.round_letters.indexOf(rl);
       if(n < 1 || n > this.rounds) {
-        UI.warn(`Round ${s[i]} outside range (a` +
+        UI.warn(`Round ${rl} outside range (a` +
             (this.rounds > 1 ? '-' + this.roundLetter(this.rounds) : '') + ')');
         return false;    
       }
@@ -160,20 +160,14 @@ class ActorManager {
             // in the actors table, but both need to be passed on.
             const p = event.target.parentElement;
             // Pass name and weight of the selected actor (first and second
-            // TD of this TR)
+            // TD of this TR).
             ACTOR_MANAGER.showEditActorDialog(
                 p.cells[0].innerText, p.cells[1].innerText);
           };
-      for(let i = 0; i < abs.length; i++) {          
-      abs[i].addEventListener('click', abf);
-    }
-    // Clicking the other cells should open the ACTOR dialog
-    for(let i = 0; i < abns.length; i++) {          
-      abns[i].addEventListener('click', eaf);
-    }
-    for(let i = 0; i < abws.length; i++) {          
-      abws[i].addEventListener('click', eaf);
-    }
+    for(const ab of abs) ab.addEventListener('click', abf);
+    // Clicking the other cells should open the ACTOR dialog.
+    for(const abn of abns) abn.addEventListener('click', eaf);
+    for(const abw of abws) abw.addEventListener('click', eaf);
     UI.modals.actors.show();
   }
 
@@ -190,7 +184,7 @@ class ActorManager {
   }
 
   addRound() {
-    // Limit # rounds to 30 to cope with 32 bit integer used by JavaScript
+    // Limit # rounds to 31 to cope with 32 bit integer used by JavaScript.
     if(this.rounds < VM.max_rounds) {
       this.rounds++;
       this.round_count.innerHTML = pluralS(this.rounds, 'round');
@@ -202,12 +196,12 @@ class ActorManager {
     if(this.selected_round > 0 && this.selected_round <= this.rounds) {
       const mask = Math.pow(2, this.selected_round) - 1;
       this.updateRoundFlags();
-      for(let i = 0; i < MODEL.actor_list.length; i++) {
-        let rf = MODEL.actor_list[i][2];
+      for(const a of MODEL.actor_list) {
+        let rf = a[2];
         const
             low = (rf & mask),
             high = (rf & ~mask) >>> 1;
-        MODEL.actor_list[i][2] = (low | high);
+        a[2] = (low | high);
       }
       this.rounds--;
       this.selected_round = 0;
@@ -291,16 +285,13 @@ class ActorManager {
   }
 
   updateActorProperties() {
-    // This method is called when the modeler clicks OK on the actor list dialog
+    // This method is called when the modeler clicks OK on the actor list dialog.
     this.updateRoundFlags();
     const xp = new ExpressionParser('');
-    let a,
-        ali,
-        ok = true;
-    for(let i = 0; i < MODEL.actor_list.length; i++) {
-      ali = MODEL.actor_list[i];
-      a = MODEL.actors[ali[0]];
-      // Rename actor if name has been changed
+    let ok = true;
+    for(const ali of MODEL.actor_list) {
+      const a = MODEL.actors[ali[0]];
+      // Rename actor if name has been changed.
       if(a.displayName != ali[1]) a.rename(ali[1]);
       // Set its round flags
       a.round_flags = ali[2];
@@ -316,7 +307,7 @@ class ActorManager {
           a.weight.update(xp);
         }
       }
-      // Update import/export status
+      // Update import/export status.
       MODEL.ioUpdate(a, ali[4]);
     }
     const seq = this.sequence.value;
@@ -329,8 +320,8 @@ class ActorManager {
   }
   
   showActorInfo(n, shift) {
-    // Show actor documentation when Shift is held down
-    // NOTE: do not allow documentation of "(no actor)"
+    // Show actor documentation when Shift is held down.
+    // NOTE: do not allow documentation of "(no actor)".
     if(n > 0) {
       const a = MODEL.actorByID(MODEL.actor_list[n][0]);
       DOCUMENTATION_MANAGER.update(a, shift);
@@ -338,4 +329,3 @@ class ActorManager {
   }
   
 } // END of class ActorManager
-