ohm-js 16.3.1 → 16.3.4

package/index.d.ts

@@ -13,7 +13,7 @@ declare namespace ohm {
 
   /**
    * grammarFromScriptElement was removed in Ohm v16.0. See
-   * https://git.io/Jwow5 for more info.
+   * https://ohmjs.org/d/gfs for more info.
    * @deprecated
    */
   function grammarFromScriptElement(node?: unknown, namespace?: Namespace): Grammar;
@@ -28,7 +28,7 @@ declare namespace ohm {
 
   /**
    * grammarsFromScriptElements was removed in Ohm v16.0. See
-   * https://git.io/Jwow5 for more info.
+   * https://ohmjs.org/d/gfs for more info.
    * @deprecated
    */
   function grammarsFromScriptElements(nodeList?: unknown, namespace?: Namespace): Namespace;
@@ -307,14 +307,7 @@ declare namespace ohm {
     /**
      * True if Node is ? option
      */
-    isOptional: boolean;
-
-    /**
-     * For a terminal node, the raw value that was consumed from the
-     * input stream.
-     * @deprecated Use `sourceString` instead.
-     */
-    primitiveValue: string;
+    isOptional(): boolean;
 
     /**
      * In addition to the properties defined above, within a given

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ohm-js",
-  "version": "16.3.1",
+  "version": "16.3.4",
   "description": "An object-oriented language for parsing and pattern matching",
   "repository": "https://github.com/harc/ohm",
   "keywords": [
@@ -56,38 +56,39 @@
     "Tony Garnock-Jones <tonygarnockjones@gmail.com>",
     "Saketh Kasibatla <sake.kasi@gmail.com>",
     "Lionel Landwerlin <llandwerlin@gmail.com>",
-    "Jason Merrill <jwmerrill@gmail.com>",
     "Ray Toal <rtoal@lmu.edu>",
+    "Jason Merrill <jwmerrill@gmail.com>",
     "Yoshiki Ohshima <Yoshiki.Ohshima@acm.org>",
     "megabuz <3299889+megabuz@users.noreply.github.com>",
-    "stagas <gstagas@gmail.com>",
-    "Jonathan Edwards <JonathanMEdwards@gmail.com>",
     "Milan Lajtoš <milan.lajtos@me.com>",
     "Neil Jewers <njjewers@uwaterloo.ca>",
-    "Mike Niebling <(none)>",
-    "AngryPowman <angrypowman@qq.com>",
-    "Patrick Dubroy <patrick@sourcegraph.com>",
-    "Leslie Ying <acetophore@users.noreply.github.com>",
+    "Jonathan Edwards <JonathanMEdwards@gmail.com>",
+    "stagas <gstagas@gmail.com>",
+    "Daniel Tomlinson <DanielTomlinson@me.com>",
     "Pierre Donias <pierre.donias@gmail.com>",
-    "Justin Chase <justin.m.chase@gmail.com>",
-    "Ian Harris <ian@fofgof.xyz>",
+    "Casey Olson <casey.m.olson@gmail.com>",
+    "Arthur Carabott <arthurc@gmail.com>",
     "Stan Rozenraukh <stan@stanistan.com>",
     "Stephan Seidt <stephan.seidt@gmail.com>",
-    "Steve Phillips <steve@tryingtobeawesome.com>",
+    "Leslie Ying <acetophore@users.noreply.github.com>",
     "Szymon Kaliski <kaliskiszymon@gmail.com>",
     "Thomas Nyberg <tomnyberg@gmail.com>",
-    "Daniel Tomlinson <DanielTomlinson@me.com>",
+    "AngryPowman <angrypowman@qq.com>",
     "Vse Mozhet Byt <vsemozhetbyt@gmail.com>",
     "Wil Chung <10446+iamwilhelm@users.noreply.github.com>",
-    "Casey Olson <casey.m.olson@gmail.com>",
+    "Zachary Sakowitz <zsakowitz@gmail.com>",
     "abego <ub@abego-software.de>",
     "acslk <d_vd415@hotmail.com>",
     "codeZeilen <codeZeilen@users.noreply.github.com>",
     "kassadin <kassadin@foxmail.com>",
-    "Arthur Carabott <arthurc@gmail.com>",
     "owch <bowenrainyday@gmail.com>",
+    "sfinnie <scott.finnie@gmail.com>",
+    "Steve Phillips <steve@tryingtobeawesome.com>",
+    "Justin Chase <justin.m.chase@gmail.com>",
     "Luca Guzzon <luca.guzzon@gmail.com>",
-    "sfinnie <scott.finnie@gmail.com>"
+    "Ian Harris <ian@fofgof.xyz>",
+    "Mike Niebling <(none)>",
+    "Patrick Dubroy <patrick@sourcegraph.com>"
   ],
   "dependencies": {},
   "devDependencies": {

package/src/CaseInsensitiveTerminal.js

@@ -35,7 +35,7 @@ class CaseInsensitiveTerminal extends PExpr {
       state.processFailure(origPos, this);
       return false;
     } else {
-      state.pushBinding(new TerminalNode(state.grammar, matchStr), origPos);
+      state.pushBinding(new TerminalNode(matchStr.length), origPos);
       return true;
     }
   }

package/src/Grammar.js

@@ -140,7 +140,7 @@ Grammar.prototype = {
         if (k === '_iter' || k === '_nonterminal') {
           details =
             `it should use a rest parameter, e.g. \`${k}(...children) {}\`. ` +
-            'NOTE: this is new in Ohm v16 — see https://git.io/Jz4CI for details.';
+            'NOTE: this is new in Ohm v16 — see https://ohmjs.org/d/ati for details.';
         } else {
           details = `expected ${expected}, got ${actual}`;
         }

package/src/MatchState.js

@@ -219,7 +219,7 @@ MatchState.prototype = {
   // Returns the memoized trace entry for `expr` at `pos`, if one exists, `null` otherwise.
   getMemoizedTraceEntry(pos, expr) {
     const posInfo = this.memoTable[pos];
-    if (posInfo && expr.ruleName) {
+    if (posInfo && expr instanceof pexprs.Apply) {
       const memoRec = posInfo.memo[expr.toMemoKey()];
       if (memoRec && memoRec.traceEntry) {
         const entry = memoRec.traceEntry.cloneWithExpr(expr);
@@ -361,11 +361,15 @@ MatchState.prototype = {
           key => this.recordedFailures[key]
       );
     }
+    const cst = this._bindings[0];
+    if (cst) {
+      cst.grammar = this.grammar;
+    }
     return new MatchResult(
         this.matcher,
         this.input,
         this.startExpr,
-        this._bindings[0],
+        cst,
         this._bindingOffsets[0],
         this.rightmostFailurePosition,
         rightmostFailures

package/src/Semantics.js

@@ -47,11 +47,6 @@ class Wrapper {
     return '[semantics wrapper for ' + this._node.grammar.name + ']';
   }
 
-  // This is used by ohm editor to display a node wrapper appropriately.
-  toJSON() {
-    return this.toString();
-  }
-
   _forgetMemoizedResultFor(attributeName) {
     // Remove the memoized attribute from the cstNode and all its children.
     delete this._node[this._semantics.attributeKeys[attributeName]];
@@ -131,7 +126,7 @@ class Wrapper {
     const childWrappers = optChildWrappers || [];
 
     const childNodes = childWrappers.map(c => c._node);
-    const iter = new IterationNode(this._node.grammar, childNodes, [], -1, false);
+    const iter = new IterationNode(childNodes, [], -1, false);
 
     const wrapper = this._semantics.wrap(iter, null, null);
     wrapper._childWrappers = childWrappers;
@@ -158,18 +153,6 @@ class Wrapper {
     return this._node.numChildren();
   }
 
-  // Returns the primitive value of this CST node, if it's a terminal node. Otherwise,
-  // throws an exception.
-  // DEPRECATED: Use `sourceString` instead.
-  get primitiveValue() {
-    if (this.isTerminal()) {
-      return this._node.primitiveValue;
-    }
-    throw new TypeError(
-        "tried to access the 'primitiveValue' attribute of a non-terminal CST node"
-    );
-  }
-
   // Returns the contents of the input stream consumed by this CST node.
   get sourceString() {
     return this.source.contents;

package/src/errors.js

@@ -168,7 +168,7 @@ function invalidParameter(ruleName, expr) {
 
 const syntacticVsLexicalNote =
   'NOTE: A _syntactic rule_ is a rule whose name begins with a capital letter. ' +
-  'See https://git.io/JiYgP for more details.';
+  'See https://ohmjs.org/d/svl for more details.';
 
 function applicationOfSyntacticRuleFromLexicalContext(ruleName, applyExpr) {
   return createError(
@@ -298,7 +298,7 @@ function missingSemanticAction(ctorName, name, type, stack) {
   if (ctorName === '_iter') {
     moreInfo = [
       '\nNOTE: as of Ohm v16, there is no default action for iteration nodes — see ',
-      '  https://git.io/JRwtG for details.',
+      '  https://ohmjs.org/d/dsa for details.',
     ].join('\n');
   }
 

package/src/main.js

@@ -295,13 +295,13 @@ function grammars(source, optNamespace) {
 
 function grammarFromScriptElement(optNode) {
   throw new Error(
-      'grammarFromScriptElement was removed in Ohm v16.0. See https://git.io/Jwow5 for more info.'
+      'grammarFromScriptElement was removed in Ohm v16.0. See https://ohmjs.org/d/gfs for more info.'
   );
 }
 
 function grammarsFromScriptElements(optNodeOrNodeList) {
   throw new Error(
-      'grammarsFromScriptElements was removed in Ohm v16.0. See https://git.io/Jwow5 for more info.'
+      'grammarsFromScriptElements was removed in Ohm v16.0. See https://ohmjs.org/d/gfs for more info.'
   );
 }
 

package/src/nodes.js

@@ -2,20 +2,19 @@
 
 const common = require('./common');
 
-// Ensures that the deprecation warning for `primitiveValue` only appears once.
-let didWarnForPrimitiveValue = false;
-
 // --------------------------------------------------------------------
 // Private stuff
 // --------------------------------------------------------------------
 
 class Node {
-  constructor(grammar, ctorName, matchLength) {
-    this.grammar = grammar;
-    this.ctorName = ctorName;
+  constructor(matchLength) {
     this.matchLength = matchLength;
   }
 
+  get ctorName() {
+    throw new Error('subclass responsibility');
+  }
+
   numChildren() {
     return this.children ? this.children.length : 0;
   }
@@ -109,52 +108,38 @@ class Node {
   isOptional() {
     return false;
   }
-
-  toJSON() {
-    return {[this.ctorName]: this.children};
-  }
 }
 
 // Terminals
 
 class TerminalNode extends Node {
-  constructor(grammar, value) {
-    const matchLength = value ? value.length : 0;
-    super(grammar, '_terminal', matchLength);
-    this._value = value;
+  get ctorName() {
+    return '_terminal';
   }
 
   isTerminal() {
     return true;
   }
 
-  toJSON() {
-    return {[this.ctorName]: this._value};
-  }
-
   get primitiveValue() {
-    if (!didWarnForPrimitiveValue) {
-      // eslint-disable-next-line no-console
-      console.warn(
-          'Warning: primitiveValue is deprecated and will be removed in a future version of Ohm. ' +
-          'Use sourceString instead.'
-      );
-      didWarnForPrimitiveValue = true;
-    }
-
-    return this._value;
+    throw new Error('The `primitiveValue` property was removed in Ohm v17.');
   }
 }
 
 // Nonterminals
 
 class NonterminalNode extends Node {
-  constructor(grammar, ruleName, children, childOffsets, matchLength) {
-    super(grammar, ruleName, matchLength);
+  constructor(ruleName, children, childOffsets, matchLength) {
+    super(matchLength);
+    this.ruleName = ruleName;
     this.children = children;
     this.childOffsets = childOffsets;
   }
 
+  get ctorName() {
+    return this.ruleName;
+  }
+
   isNonterminal() {
     return true;
   }
@@ -171,13 +156,17 @@ class NonterminalNode extends Node {
 // Iterations
 
 class IterationNode extends Node {
-  constructor(grammar, children, childOffsets, matchLength, isOptional) {
-    super(grammar, '_iter', matchLength);
+  constructor(children, childOffsets, matchLength, isOptional) {
+    super(matchLength);
     this.children = children;
     this.childOffsets = childOffsets;
     this.optional = isOptional;
   }
 
+  get ctorName() {
+    return '_iter';
+  }
+
   isIteration() {
     return true;
   }

package/src/pexprs-eval.js

@@ -41,7 +41,7 @@ pexprs.any.eval = function(state) {
   const origPos = inputStream.pos;
   const ch = inputStream.next();
   if (ch) {
-    state.pushBinding(new TerminalNode(state.grammar, ch), origPos);
+    state.pushBinding(new TerminalNode(ch.length), origPos);
     return true;
   } else {
     state.processFailure(origPos, this);
@@ -53,7 +53,7 @@ pexprs.end.eval = function(state) {
   const {inputStream} = state;
   const origPos = inputStream.pos;
   if (inputStream.atEnd()) {
-    state.pushBinding(new TerminalNode(state.grammar, undefined), origPos);
+    state.pushBinding(new TerminalNode(0), origPos);
     return true;
   } else {
     state.processFailure(origPos, this);
@@ -68,7 +68,7 @@ pexprs.Terminal.prototype.eval = function(state) {
     state.processFailure(origPos, this);
     return false;
   } else {
-    state.pushBinding(new TerminalNode(state.grammar, this.obj), origPos);
+    state.pushBinding(new TerminalNode(this.obj.length), origPos);
     return true;
   }
 };
@@ -84,7 +84,7 @@ pexprs.Range.prototype.eval = function(state) {
   // Always compare by code point value to get the correct result in all scenarios.
   // Note that for strings of length 1, codePointAt(0) and charPointAt(0) are equivalent.
   if (cp !== undefined && this.from.codePointAt(0) <= cp && cp <= this.to.codePointAt(0)) {
-    state.pushBinding(new TerminalNode(state.grammar, String.fromCodePoint(cp)), origPos);
+    state.pushBinding(new TerminalNode(String.fromCodePoint(cp).length), origPos);
     return true;
   } else {
     state.processFailure(origPos, this);
@@ -169,7 +169,7 @@ pexprs.Iter.prototype.eval = function(state) {
   const isOptional = this instanceof pexprs.Opt;
   for (idx = 0; idx < cols.length; idx++) {
     state._bindings.push(
-        new IterationNode(state.grammar, cols[idx], colOffsets[idx], matchLength, isOptional)
+        new IterationNode(cols[idx], colOffsets[idx], matchLength, isOptional)
     );
     state._bindingOffsets.push(offset);
   }
@@ -344,13 +344,8 @@ pexprs.Apply.prototype.evalOnce = function(expr, state) {
     const arity = expr.getArity();
     const bindings = state._bindings.splice(state._bindings.length - arity, arity);
     const offsets = state._bindingOffsets.splice(state._bindingOffsets.length - arity, arity);
-    return new NonterminalNode(
-        state.grammar,
-        this.ruleName,
-        bindings,
-        offsets,
-        inputStream.pos - origPos
-    );
+    const matchLength = inputStream.pos - origPos;
+    return new NonterminalNode(this.ruleName, bindings, offsets, matchLength);
   } else {
     return false;
   }
@@ -405,7 +400,7 @@ pexprs.UnicodeChar.prototype.eval = function(state) {
   const origPos = inputStream.pos;
   const ch = inputStream.next();
   if (ch && this.pattern.test(ch)) {
-    state.pushBinding(new TerminalNode(state.grammar, ch), origPos);
+    state.pushBinding(new TerminalNode(ch.length), origPos);
     return true;
   } else {
     state.processFailure(origPos, this);