ohm-js 17.1.0-pre → 17.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2022 Alessandro Warth and the Ohm project contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,4 @@
-# [Ohm](https://ohmjs.org/) · [![NPM](https://img.shields.io/npm/v/ohm-js.svg)](https://www.npmjs.com/package/ohm-js) ![Node.js CI](https://github.com/ohmjs/ohm/workflows/Node.js%20CI/badge.svg?style=flat-square) [![Chat on Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/KwxY5gegRQ)
+# [Ohm](https://ohmjs.org/) · [![NPM](https://img.shields.io/npm/v/ohm-js.svg)](https://www.npmjs.com/package/ohm-js) [![Node.js CI](https://github.com/ohmjs/ohm/actions/workflows/node.js.yml/badge.svg)](https://github.com/ohmjs/ohm/actions/workflows/node.js.yml) [![Chat on Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/KwxY5gegRQ)
 
 Ohm is a parsing toolkit consisting of a library and a domain-specific language. You can use it to parse custom file formats or quickly build parsers, interpreters, and compilers for programming languages.
 
@@ -21,6 +21,19 @@ Some awesome things people have built using Ohm:
 - A [browser-based tool](https://www.arthurcarabott.com/konnakkol/) that turns written _Konnakkol_ (a South Indian vocal percussion art) into audio.
 - [Wildcard](https://www.geoffreylitt.com/wildcard/), a browser extension that empowers anyone to modify websites to meet their own specific needs, uses Ohm for its spreadsheet formulas.
 
+## Sponsors
+
+Since 2017, Ohm has been maintained by [@pdubroy](https://github.com/pdubroy) on an unpaid basis. Please consider [becoming a sponsor](http://github.com/sponsors/pdubroy/)!
+
+### Diamond 💎
+
+<table>
+  <tr>
+    <td><a href="https://shopify.com"><img alt="Shopify" src="./doc/images/shopify-logo.png" height="48"></a></td>
+    <td><a href="https://projectsubstrate.org"><img alt="Project Substrate" src="./doc/images/substrate-logo.png" height="128"></a></td>
+  </tr>
+</table>
+
 ## Getting Started
 
 The easiest way to get started with Ohm is to use the [interactive editor](https://ohmjs.org/editor/). Alternatively, you can play with one of the following examples on JSFiddle:
@@ -203,4 +216,4 @@ our [suggestions for publishing grammars](./doc/publishing-grammars.md).
 ## Contributing to Ohm
 
 Interested in contributing to Ohm? Please read [CONTRIBUTING.md](./CONTRIBUTING.md)
-and the [Ohm Contributor Guide](doc/contributing.md).
+and the [Ohm Contributor Guide](doc/contributor-guide.md).

package/dist/ohm-extras.cjs

@@ -171,6 +171,13 @@ function unexpectedObjToString(obj) {
   }
 }
 
+function checkNotNull(obj, message = 'unexpected null value') {
+  if (obj == null) {
+    throw new Error(message);
+  }
+  return obj;
+}
+
 var common = /*#__PURE__*/Object.freeze({
   __proto__: null,
   abstract: abstract,
@@ -187,7 +194,8 @@ var common = /*#__PURE__*/Object.freeze({
   padLeft: padLeft,
   StringBuffer: StringBuffer,
   unescapeCodePoint: unescapeCodePoint,
-  unexpectedObjToString: unexpectedObjToString
+  unexpectedObjToString: unexpectedObjToString,
+  checkNotNull: checkNotNull
 });
 
 // --------------------------------------------------------------------
@@ -2897,7 +2905,7 @@ any.substituteParams =
     };
 
 Param.prototype.substituteParams = function(actuals) {
-  return actuals[this.index];
+  return checkNotNull(actuals[this.index]);
 };
 
 Alt.prototype.substituteParams = function(actuals) {
@@ -5592,6 +5600,9 @@ function initBuiltInSemantics(builtInRules) {
     nonEmpty(first, _, rest) {
       return this.iteration([first].concat(rest.children));
     },
+    self(..._children) {
+      return this;
+    },
   };
 
   Semantics.BuiltInSemantics = Semantics.createSemantics(builtInRules, null).addOperation(
@@ -5601,6 +5612,7 @@ function initBuiltInSemantics(builtInRules) {
         nonemptyListOf: actions.nonEmpty,
         EmptyListOf: actions.empty,
         NonemptyListOf: actions.nonEmpty,
+        _iter: actions.self,
       },
   );
 }
@@ -5845,13 +5857,7 @@ const grammarsSource = String.raw`
   // Example:
   //+ "//+ \"x\"\nG {\n//- \"\"\nstart = \"x\"}"
   OhmWithExamples <: Ohm {
-    // The default start rule for Ohm is 'Grammars', which is syntactic rule.
-    // When the start rule is a syntactic rule, there's no way to get access to
-    // leading space (including comments). So, for this grammar to be useful,
-    // you have to explicit use this rule as the start rule.
-    grammarsWithExamples = (exampleComments applySyntactic<Grammar>)*
-
-    Grammar := ident SuperGrammar? "{" (#exampleComments Rule)* "}"
+    Grammar := ident SuperGrammar? "{" (#exampleComments Rule)* #exampleComments "}"
 
     exampleComments = (spacesNoExampleComment exampleComment)*
 
@@ -5915,19 +5921,10 @@ const semantics = grammars.OhmWithExamples.createSemantics().addOperation('hasEx
 });
 
 semantics.addOperation('examples', {
-  grammarsWithExamples(exampleCommentsIter, grammarIter) {
-    const result = [];
-    for (const [i, child] of Object.entries(grammarIter.children)) {
-      if (exampleCommentsIter.hasExamples()) {
-        const defaultExamples = exampleCommentsIter.child(i).examples();
-        const grammar = child.grammarName();
-        result.push(...defaultExamples.map(ex => ({...ex, grammar, rule: ''})));
-      }
-      result.push(...child.examples());
-    }
-    return result;
+  Grammars(grammarIter) {
+    return grammarIter.children.flatMap(c => c.examples());
   },
-  Grammar(name, _, _open, exampleCommentsIter, ruleIter, _close) {
+  Grammar(name, _, _open, exampleCommentsIter, ruleIter, trailingCommentsIter, _close) {
     const result = [];
     const grammar = this.grammarName();
     for (let i = 0; i < ruleIter.numChildren; i++) {
@@ -5939,6 +5936,10 @@ semantics.addOperation('examples', {
 
       result.push(...augmentedExamples);
     }
+    if (trailingCommentsIter.hasExamples()) {
+      const defaultExamples = trailingCommentsIter.examples();
+      result.push(...defaultExamples.map(ex => ({...ex, grammar, rule: ''})));
+    }
     return result;
   },
   exampleComments(_, commentIter) {
@@ -5964,7 +5965,7 @@ semantics.addOperation('examples', {
 });
 
 semantics.addOperation('grammarName', {
-  Grammar(name, _, _open, exampleCommentsIter, ruleIter, _close) {
+  Grammar(name, _, _open, exampleCommentsIter, ruleIter, trailingCommentsIter, _close) {
     return name.sourceString;
   },
 });
@@ -5988,7 +5989,7 @@ semantics.addOperation('ruleName', {
  * @return {[Example]}
  */
 function extractExamples(grammarsDef) {
-  const matchResult = grammars.OhmWithExamples.match(grammarsDef, 'grammarsWithExamples');
+  const matchResult = grammars.OhmWithExamples.match(grammarsDef);
   if (matchResult.failed()) {
     throw new Error(matchResult.message);
   }

package/dist/ohm-extras.js

@@ -173,6 +173,13 @@
     }
   }
 
+  function checkNotNull(obj, message = 'unexpected null value') {
+    if (obj == null) {
+      throw new Error(message);
+    }
+    return obj;
+  }
+
   var common = /*#__PURE__*/Object.freeze({
     __proto__: null,
     abstract: abstract,
@@ -189,7 +196,8 @@
     padLeft: padLeft,
     StringBuffer: StringBuffer,
     unescapeCodePoint: unescapeCodePoint,
-    unexpectedObjToString: unexpectedObjToString
+    unexpectedObjToString: unexpectedObjToString,
+    checkNotNull: checkNotNull
   });
 
   // --------------------------------------------------------------------
@@ -2899,7 +2907,7 @@
       };
 
   Param.prototype.substituteParams = function(actuals) {
-    return actuals[this.index];
+    return checkNotNull(actuals[this.index]);
   };
 
   Alt.prototype.substituteParams = function(actuals) {
@@ -5594,6 +5602,9 @@
       nonEmpty(first, _, rest) {
         return this.iteration([first].concat(rest.children));
       },
+      self(..._children) {
+        return this;
+      },
     };
 
     Semantics.BuiltInSemantics = Semantics.createSemantics(builtInRules, null).addOperation(
@@ -5603,6 +5614,7 @@
           nonemptyListOf: actions.nonEmpty,
           EmptyListOf: actions.empty,
           NonemptyListOf: actions.nonEmpty,
+          _iter: actions.self,
         },
     );
   }
@@ -5847,13 +5859,7 @@
   // Example:
   //+ "//+ \"x\"\nG {\n//- \"\"\nstart = \"x\"}"
   OhmWithExamples <: Ohm {
-    // The default start rule for Ohm is 'Grammars', which is syntactic rule.
-    // When the start rule is a syntactic rule, there's no way to get access to
-    // leading space (including comments). So, for this grammar to be useful,
-    // you have to explicit use this rule as the start rule.
-    grammarsWithExamples = (exampleComments applySyntactic<Grammar>)*
-
-    Grammar := ident SuperGrammar? "{" (#exampleComments Rule)* "}"
+    Grammar := ident SuperGrammar? "{" (#exampleComments Rule)* #exampleComments "}"
 
     exampleComments = (spacesNoExampleComment exampleComment)*
 
@@ -5917,19 +5923,10 @@
   });
 
   semantics.addOperation('examples', {
-    grammarsWithExamples(exampleCommentsIter, grammarIter) {
-      const result = [];
-      for (const [i, child] of Object.entries(grammarIter.children)) {
-        if (exampleCommentsIter.hasExamples()) {
-          const defaultExamples = exampleCommentsIter.child(i).examples();
-          const grammar = child.grammarName();
-          result.push(...defaultExamples.map(ex => ({...ex, grammar, rule: ''})));
-        }
-        result.push(...child.examples());
-      }
-      return result;
+    Grammars(grammarIter) {
+      return grammarIter.children.flatMap(c => c.examples());
     },
-    Grammar(name, _, _open, exampleCommentsIter, ruleIter, _close) {
+    Grammar(name, _, _open, exampleCommentsIter, ruleIter, trailingCommentsIter, _close) {
       const result = [];
       const grammar = this.grammarName();
       for (let i = 0; i < ruleIter.numChildren; i++) {
@@ -5941,6 +5938,10 @@
 
         result.push(...augmentedExamples);
       }
+      if (trailingCommentsIter.hasExamples()) {
+        const defaultExamples = trailingCommentsIter.examples();
+        result.push(...defaultExamples.map(ex => ({...ex, grammar, rule: ''})));
+      }
       return result;
     },
     exampleComments(_, commentIter) {
@@ -5966,7 +5967,7 @@
   });
 
   semantics.addOperation('grammarName', {
-    Grammar(name, _, _open, exampleCommentsIter, ruleIter, _close) {
+    Grammar(name, _, _open, exampleCommentsIter, ruleIter, trailingCommentsIter, _close) {
       return name.sourceString;
     },
   });
@@ -5990,7 +5991,7 @@
    * @return {[Example]}
    */
   function extractExamples(grammarsDef) {
-    const matchResult = grammars.OhmWithExamples.match(grammarsDef, 'grammarsWithExamples');
+    const matchResult = grammars.OhmWithExamples.match(grammarsDef);
     if (matchResult.failed()) {
       throw new Error(matchResult.message);
     }

package/dist/ohm.cjs

@@ -171,6 +171,13 @@ function unexpectedObjToString(obj) {
   }
 }
 
+function checkNotNull(obj, message = 'unexpected null value') {
+  if (obj == null) {
+    throw new Error(message);
+  }
+  return obj;
+}
+
 var common = /*#__PURE__*/Object.freeze({
   __proto__: null,
   abstract: abstract,
@@ -187,7 +194,8 @@ var common = /*#__PURE__*/Object.freeze({
   padLeft: padLeft,
   StringBuffer: StringBuffer,
   unescapeCodePoint: unescapeCodePoint,
-  unexpectedObjToString: unexpectedObjToString
+  unexpectedObjToString: unexpectedObjToString,
+  checkNotNull: checkNotNull
 });
 
 // These are just categories that are used in ES5/ES2015.
@@ -2606,7 +2614,7 @@ any.substituteParams =
     };
 
 Param.prototype.substituteParams = function(actuals) {
-  return actuals[this.index];
+  return checkNotNull(actuals[this.index]);
 };
 
 Alt.prototype.substituteParams = function(actuals) {
@@ -5327,6 +5335,9 @@ function initBuiltInSemantics(builtInRules) {
     nonEmpty(first, _, rest) {
       return this.iteration([first].concat(rest.children));
     },
+    self(..._children) {
+      return this;
+    },
   };
 
   Semantics.BuiltInSemantics = Semantics.createSemantics(builtInRules, null).addOperation(
@@ -5336,6 +5347,7 @@ function initBuiltInSemantics(builtInRules) {
         nonemptyListOf: actions.nonEmpty,
         EmptyListOf: actions.empty,
         NonemptyListOf: actions.nonEmpty,
+        _iter: actions.self,
       },
   );
 }
@@ -5541,7 +5553,7 @@ Object.assign(IndentationSensitive, {
 });
 
 // Generated by scripts/prebuild.js
-const version = '17.1.0-pre';
+const version = '17.2.0';
 
 Grammar.initApplicationParser(ohmGrammar, buildGrammar);