@bablr/helpers 0.18.1 → 0.19.0

package/lib/grammar.js

@@ -2,6 +2,7 @@ import every from 'iter-tools-es/methods/every';
 import isString from 'iter-tools-es/methods/is-string';
 import objectEntries from 'iter-tools-es/methods/object-entries';
 import { getPrototypeOf } from './object.js';
+import { OpenNodeTag, CloseNodeTag } from './symbols.js';
 
 const { isArray } = Array;
 const isSymbol = (value) => typeof value === 'symbol';
@@ -110,14 +111,14 @@ export const buildDependentLanguages = (language, transformLanguage = (l) => l)
 
 const arrayLast = (arr) => arr[arr.length - 1];
 
-export function* zipLanguages(tokens, rootLanguage) {
+export function* zipLanguages(tags, rootLanguage) {
   const languages = [rootLanguage];
 
-  for (const token of tokens) {
-    switch (token.type) {
-      case 'OpenNodeTag': {
-        if (token.value.language) {
-          const dependentLanguage = languages.dependencies[token.value.language];
+  for (const tag of tags) {
+    switch (tag.type) {
+      case OpenNodeTag: {
+        if (tag.value.language) {
+          const dependentLanguage = languages.dependencies[tag.value.language];
 
           if (!dependentLanguage) throw new Error('language was not a dependency');
 
@@ -126,14 +127,14 @@ export function* zipLanguages(tokens, rootLanguage) {
         break;
       }
 
-      case 'CloseNodeTag': {
-        if (token.value.language !== arrayLast(languages).canonicalURL) {
+      case CloseNodeTag: {
+        if (tag.value.language !== arrayLast(languages).canonicalURL) {
           languages.pop();
         }
         break;
       }
     }
 
-    yield [token, arrayLast(languages)];
+    yield [tag, arrayLast(languages)];
   }
 }

package/lib/productions.js

@@ -1,6 +1,6 @@
 /* @macrome
  * @generatedby @bablr/macrome-generator-bablr
- * @generatedfrom ./productions.macro.js#f76280b033fb91e9fb8362cc2c1caa8988b5beb4
+ * @generatedfrom ./productions.macro.js#ab30a55dff3676ff2418023be450dabe54386ee0
  * This file is autogenerated. Please do not edit it directly.
  * When editing run `npx macrome watch` then change the file this is generated from.
  */
@@ -17,13 +17,28 @@ export function* List({
     allowHoles = false,
     allowTrailingSeparator = true
   } = ctx.unbox(props);
+  yield _t.node(_l.Instruction, "Call", [_t.ref`verb`, _t.ref`arguments`], {
+    verb: _t.s_node(_l.Instruction, "Identifier", "eat"),
+    arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, _t.ref`values[]`, _t.arr(), _t.ref`values[]`, _t.embedded(_t.node(_l.Instruction, "Space", [_t.lit(" ")], {}, {})), _t.ref`values[]`, _t.ref`closeToken`], {
+      openToken: _t.s_i_node(_l.Instruction, "Punctuator", "("),
+      values: [_t.node(_l.Instruction, "Array", [_t.ref`openToken`, _t.ref`closeToken`], {
+        openToken: _t.s_i_node(_l.Instruction, "Punctuator", "["),
+        closeToken: _t.s_i_node(_l.Instruction, "Punctuator", "]")
+      }, {}), _t.node(_l.CSTML, "String", [_t.ref`openToken`, _t.ref`content`, _t.ref`closeToken`], {
+        openToken: _t.s_i_node(_l.CSTML, "Punctuator", "'"),
+        content: _t.node(_l.CSTML, "Content", [_t.lit("separators[]")], {}, {}),
+        closeToken: _t.s_i_node(_l.CSTML, "Punctuator", "'")
+      }, {})],
+      closeToken: _t.s_i_node(_l.Instruction, "Punctuator", ")")
+    }, {})
+  }, {});
   let sep,
     it,
     anySep = false;
   for (;;) {
     it = yield _t.node(_l.Instruction, "Call", [_t.ref`verb`, _t.ref`arguments`], {
       verb: _t.s_node(_l.Instruction, "Identifier", "eatMatch"),
-      arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, ..._interpolateArrayChildren(element, _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.ref`closeToken`], {
+      arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, _t.ref`values[]`, _t.arr(), ..._interpolateArrayChildren(element, _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.ref`closeToken`], {
         openToken: _t.s_i_node(_l.Instruction, "Punctuator", "("),
         values: [..._interpolateArray(element)],
         closeToken: _t.s_i_node(_l.Instruction, "Punctuator", ")")
@@ -32,7 +47,7 @@ export function* List({
     if (it || allowTrailingSeparator) {
       sep = yield _t.node(_l.Instruction, "Call", [_t.ref`verb`, _t.ref`arguments`], {
         verb: _t.s_node(_l.Instruction, "Identifier", "eatMatch"),
-        arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, ..._interpolateArrayChildren(separator, _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.embedded(_t.s_t_node(_l.Space, "Space", [_t.lit(" ")], {}, {})), _t.ref`values[]`, _t.ref`closeToken`], {
+        arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, _t.ref`values[]`, _t.arr(), ..._interpolateArrayChildren(separator, _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.embedded(_t.node(_l.Instruction, "Space", [_t.lit(" ")], {}, {})), _t.ref`values[]`, _t.ref`closeToken`], {
           openToken: _t.s_i_node(_l.Instruction, "Punctuator", "("),
           values: [..._interpolateArray(separator), _t.node(_l.CSTML, "String", [_t.ref`openToken`, _t.ref`content`, _t.ref`closeToken`], {
             openToken: _t.s_i_node(_l.CSTML, "Punctuator", "'"),
@@ -46,22 +61,6 @@ export function* List({
     }
     if (!(sep || allowHoles)) break;
   }
-  if (!anySep) {
-    yield _t.node(_l.Instruction, "Call", [_t.ref`verb`, _t.ref`arguments`], {
-      verb: _t.s_node(_l.Instruction, "Identifier", "eat"),
-      arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, _t.ref`values[]`, _t.embedded(_t.s_t_node(_l.Space, "Space", [_t.lit(" ")], {}, {})), _t.ref`values[]`, _t.ref`closeToken`], {
-        openToken: _t.s_i_node(_l.Instruction, "Punctuator", "("),
-        values: [_t.node(_l.Instruction, "Null", [_t.ref`sigilToken`], {
-          sigilToken: _t.s_i_node(_l.Instruction, "Keyword", "null")
-        }, {}), _t.node(_l.CSTML, "String", [_t.ref`openToken`, _t.ref`content`, _t.ref`closeToken`], {
-          openToken: _t.s_i_node(_l.CSTML, "Punctuator", "'"),
-          content: _t.node(_l.CSTML, "Content", [_t.lit("separators[]")], {}, {}),
-          closeToken: _t.s_i_node(_l.CSTML, "Punctuator", "'")
-        }, {})],
-        closeToken: _t.s_i_node(_l.Instruction, "Punctuator", ")")
-      }, {})
-    }, {});
-  }
 }
 export function* Any({
   value: matchers,
@@ -70,7 +69,7 @@ export function* Any({
   for (const matcher of ctx.unbox(matchers)) {
     if (yield _t.node(_l.Instruction, "Call", [_t.ref`verb`, _t.ref`arguments`], {
       verb: _t.s_node(_l.Instruction, "Identifier", "eatMatch"),
-      arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, ..._interpolateArrayChildren(matcher, _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.ref`closeToken`], {
+      arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, _t.ref`values[]`, _t.arr(), ..._interpolateArrayChildren(matcher, _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.ref`closeToken`], {
         openToken: _t.s_i_node(_l.Instruction, "Punctuator", "("),
         values: [..._interpolateArray(matcher)],
         closeToken: _t.s_i_node(_l.Instruction, "Punctuator", ")")
@@ -85,7 +84,7 @@ export function* All({
   for (const matcher of ctx.unbox(matchers)) {
     yield _t.node(_l.Instruction, "Call", [_t.ref`verb`, _t.ref`arguments`], {
       verb: _t.s_node(_l.Instruction, "Identifier", "eat"),
-      arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, ..._interpolateArrayChildren(matcher, _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.ref`closeToken`], {
+      arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, _t.ref`values[]`, _t.arr(), ..._interpolateArrayChildren(matcher, _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.ref`closeToken`], {
         openToken: _t.s_i_node(_l.Instruction, "Punctuator", "("),
         values: [..._interpolateArray(matcher)],
         closeToken: _t.s_i_node(_l.Instruction, "Punctuator", ")")
@@ -99,7 +98,7 @@ export function* Punctuator({
   if (!intrinsicValue) throw new Error('Intrinsic productions must have value');
   yield _t.node(_l.Instruction, "Call", [_t.ref`verb`, _t.ref`arguments`], {
     verb: _t.s_node(_l.Instruction, "Identifier", "eat"),
-    arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, ..._interpolateArrayChildren(intrinsicValue, _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.ref`closeToken`], {
+    arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, _t.ref`values[]`, _t.arr(), ..._interpolateArrayChildren(intrinsicValue, _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.ref`closeToken`], {
       openToken: _t.s_i_node(_l.Instruction, "Punctuator", "("),
       values: [..._interpolateArray(intrinsicValue)],
       closeToken: _t.s_i_node(_l.Instruction, "Punctuator", ")")
@@ -117,7 +116,7 @@ export function* Optional({
   }
   yield _t.node(_l.Instruction, "Call", [_t.ref`verb`, _t.ref`arguments`], {
     verb: _t.s_node(_l.Instruction, "Identifier", "eatMatch"),
-    arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, ..._interpolateArrayChildren(matchers_[0], _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.ref`closeToken`], {
+    arguments: _t.node(_l.Instruction, "Tuple", [_t.ref`openToken`, _t.ref`values[]`, _t.arr(), ..._interpolateArrayChildren(matchers_[0], _t.ref`values[]`, _t.embedded(_t.t_node(_l.Comment, null, [_t.embedded(_t.t_node('Space', 'Space', [_t.lit(' ')]))]))), _t.ref`closeToken`], {
       openToken: _t.s_i_node(_l.Instruction, "Punctuator", "("),
       values: [..._interpolateArray(matchers_[0])],
       closeToken: _t.s_i_node(_l.Instruction, "Punctuator", ")")

package/lib/productions.macro.js

@@ -8,6 +8,8 @@ export function* List({ value: props, ctx }) {
     allowTrailingSeparator = true,
   } = ctx.unbox(props);
 
+  yield i`eat([] 'separators[]')`;
+
   let sep,
     it,
     anySep = false;
@@ -19,10 +21,6 @@ export function* List({ value: props, ctx }) {
     }
     if (!(sep || allowHoles)) break;
   }
-
-  if (!anySep) {
-    yield i`eat(null 'separators[]')`;
-  }
 }
 
 export function* Any({ value: matchers, ctx }) {

package/lib/source.js

@@ -1,6 +1,7 @@
 import slice from 'iter-tools-es/methods/slice';
 import { streamFromTree } from '@bablr/agast-helpers/tree';
 import { StreamIterable, getStreamIterator } from '@bablr/agast-helpers/stream';
+import { ShiftTag, GapTag, LiteralTag } from './symbols.js';
 
 const escapables = {
   n: '\n',
@@ -91,8 +92,8 @@ function* __embeddedSourceFrom(iterable) {
 
 export const embeddedSourceFrom = (iterable) => new StreamIterable(__embeddedSourceFrom(iterable));
 
-function* __sourceFromTokenStream(terminals) {
-  let iter = getStreamIterator(terminals);
+function* __sourceFromTokenStream(Tags) {
+  let iter = getStreamIterator(Tags);
   let step;
 
   for (;;) {
@@ -104,18 +105,17 @@ function* __sourceFromTokenStream(terminals) {
 
     if (step.done) break;
 
-    const terminal = step.value;
+    const tag = step.value;
 
-    if (terminal.type === 'Literal') {
-      yield* terminal.value;
-    } else if (terminal.type === 'Gap') {
+    if (tag.type === LiteralTag) {
+      yield* tag.value;
+    } else if (tag.type === GapTag) {
       yield null;
     }
   }
 }
 
-export const sourceFromTokenStream = (terminals) =>
-  new StreamIterable(__sourceFromTokenStream(terminals));
+export const sourceFromTokenStream = (Tags) => new StreamIterable(__sourceFromTokenStream(Tags));
 
 function* __sourceFromQuasis(quasis) {
   let first = true;
@@ -157,11 +157,11 @@ export function* fillGapsWith(expressions, iterable) {
 
     const token = step.value;
 
-    if (token.type === 'Shift') {
+    if (token.type === ShiftTag) {
       holding = true;
     }
 
-    if (token.type === 'Gap') {
+    if (token.type === GapTag) {
       if (holding) {
         holding = false;
         yield token;

package/lib/stream.js

@@ -9,12 +9,15 @@ import {
 } from '@bablr/agast-helpers/stream';
 import isString from 'iter-tools-es/methods/is-string';
 import emptyStack from '@iter-tools/imm-stack';
+import { DoctypeTag, OpenNodeTag, CloseNodeTag } from './symbols.js';
 
 import { unresolveLanguage } from './grammar.js';
 
+const { freeze } = Object;
+
 // bad: wrecks tree by breaking weak linkages
-function* __resolveTerminals(ctx, terminals) {
-  const co = new Coroutine(getStreamIterator(terminals));
+function* __resolveTags(ctx, tags) {
+  const co = new Coroutine(getStreamIterator(tags));
   let languages = emptyStack;
 
   for (;;) {
@@ -26,60 +29,60 @@ function* __resolveTerminals(ctx, terminals) {
 
     if (co.done) break;
 
-    const terminal = co.value;
+    const tag = co.value;
 
-    if (terminal.type === 'DoctypeTag') {
-      languages = languages.push(ctx.languages.get(terminal.value.attributes['bablr-language']));
+    if (tag.type === DoctypeTag) {
+      languages = languages.push(ctx.languages.get(tag.value.attributes['bablr-language']));
     }
 
-    if (terminal.type === 'CloseNodeTag') {
+    if (tag.type === CloseNodeTag) {
       languages = languages.pop();
     }
 
-    if (terminal.type === 'OpenNodeTag') {
-      if (isString(terminal.value.language)) {
+    if (tag.type === OpenNodeTag) {
+      if (isString(tag.value.language)) {
         const currentLanguage = languages.value;
-        const nodeLanguageURL = terminal.value.language;
+        const nodeLanguageURL = tag.value.language;
         const nodeLanguage = ctx.languages.get(nodeLanguageURL);
 
         languages = languages.push(nodeLanguage);
 
-        yield {
-          type: 'OpenNodeTag',
-          value: {
-            ...terminal.value,
+        yield freeze({
+          type: OpenNodeTag,
+          value: freeze({
+            ...tag.value,
             language: unresolveLanguage(ctx, currentLanguage, nodeLanguageURL),
-          },
-        };
+          }),
+        });
       } else {
-        yield terminal;
+        yield tag;
       }
     } else {
-      yield terminal;
+      yield tag;
     }
   }
 }
 
-export const resolveTerminals = (ctx, terminals) => {
-  return new StreamIterable(__resolveTerminals(ctx, terminals));
+export const resolveTags = (ctx, tags) => {
+  return new StreamIterable(__resolveTags(ctx, tags));
 };
 
-export const generatePrettyCSTMLStrategy = (terminals, options = {}) => {
+export const generatePrettyCSTMLStrategy = (tags, options = {}) => {
   const { ctx } = options;
 
-  return generatePrettyCSTML(ctx ? resolveTerminals(ctx, terminals) : terminals, options);
+  return generatePrettyCSTML(ctx ? resolveTags(ctx, tags) : tags, options);
 };
 
-export const printPrettyCSTML = (terminals, options = {}) => {
-  return stringFromStream(generateStandardOutput(generatePrettyCSTMLStrategy(terminals, options)));
+export const printPrettyCSTML = (tags, options = {}) => {
+  return stringFromStream(generateStandardOutput(generatePrettyCSTMLStrategy(tags, options)));
 };
 
-export const generateCSTMLStrategy = (terminals, options = {}) => {
+export const generateCSTMLStrategy = (tags, options = {}) => {
   const { ctx } = options;
 
-  return generateCSTML(ctx ? resolveTerminals(ctx, terminals) : terminals, options);
+  return generateCSTML(ctx ? resolveTags(ctx, tags) : tags, options);
 };
 
-export const printCSTML = (terminals, options = {}) => {
-  return stringFromStream(generateStandardOutput(generateCSTMLStrategy(terminals, options)));
+export const printCSTML = (tags, options = {}) => {
+  return stringFromStream(generateStandardOutput(generateCSTMLStrategy(tags, options)));
 };

package/lib/symbols.js

@@ -1 +1 @@
-export const node = Symbol.for('@bablr/node');
+export * from '@bablr/agast-helpers/symbols';

package/lib/tree.js

@@ -3,6 +3,6 @@ import { streamFromTree } from '@bablr/agast-helpers/tree';
 import { printPrettyCSTML as printPrettyCSTMLFromStream } from './stream.js';
 
 export const printPrettyCSTML = (rootNode, options = {}) => {
-  // i need a context-aware streamFromTree here to build a stream with linked terminals...?
+  // i need a context-aware streamFromTree here to build a stream with linked Tags...?
   return printPrettyCSTMLFromStream(streamFromTree(rootNode), options);
 };

package/lib/trivia.js

@@ -1,15 +1,16 @@
 import { Coroutine } from '@bablr/coroutine';
 import { reifyExpression } from '@bablr/agast-vm-helpers';
 import { mapProductions } from './enhancers.js';
+import { OpenNodeTag, CloseNodeTag, ReferenceTag } from './symbols.js';
 
 const lookbehind = (context, s) => {
   let token = s.result;
   while (
     token &&
-    ['OpenNodeTag', 'CloseNodeTag', 'Reference'].includes(token.type) &&
-    (token.type !== 'OpenNodeTag' || !(token.value.flags.intrinsic && token.value.flags.token))
+    [OpenNodeTag, CloseNodeTag, ReferenceTag].includes(token.type) &&
+    (token.type !== OpenNodeTag || !(token.value.flags.intrinsic && token.value.flags.token))
   ) {
-    const prevToken = context.getPreviousTerminal(token);
+    const prevToken = context.getPreviousTag(token);
     if (!prevToken) break;
     token = prevToken;
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bablr/helpers",
   "description": "Command helpers for use in writing BABLR grammars",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "author": "Conrad Buck<conartist6@gmail.com>",
   "type": "module",
   "files": [
@@ -28,19 +28,19 @@
     "clean": "macrome clean"
   },
   "dependencies": {
-    "@bablr/language_enhancer-debug-log": "0.5.0",
-    "@bablr/strategy_enhancer-debug-log": "0.4.0",
-    "@bablr/agast-helpers": "0.3.2",
-    "@bablr/agast-vm-helpers": "0.3.2",
+    "@bablr/language_enhancer-debug-log": "0.6.0",
+    "@bablr/strategy_enhancer-debug-log": "0.5.0",
+    "@bablr/agast-helpers": "0.4.0",
+    "@bablr/agast-vm-helpers": "0.4.0",
     "@bablr/coroutine": "0.1.0",
     "@iter-tools/imm-stack": "1.1.0",
     "iter-tools-es": "^7.5.3"
   },
   "devDependencies": {
-    "@bablr/boot": "0.4.0",
+    "@bablr/boot": "0.5.0",
     "@bablr/eslint-config-base": "github:bablr-lang/eslint-config-base#d834ccc52795d6c3b96ecc6c419960fceed221a6",
     "@bablr/macrome": "0.1.3",
-    "@bablr/macrome-generator-bablr": "0.3.1",
+    "@bablr/macrome-generator-bablr": "0.3.2",
     "enhanced-resolve": "^5.12.0",
     "eslint": "^7.32.0",
     "eslint-import-resolver-enhanced-resolve": "^1.0.5",