occam-parsers 23.0.161 → 23.1.1

package/src/node/bnf/{terminalSymbol.js → stringLiteral.js}

@@ -3,20 +3,20 @@
 import { arrayUtilities } from "necessary";
 
 import NonTerminalNode from "../../node/nonTerminal";
-import TerminalSymbolPart from "../../part/terminal/terminalSymbol";
+import StringLiteralPart from "../../part/terminal/stringLiteral";
 
 import { ESCAPED_BACKSLASH, ESCAPED_DOUBLE_QUOTE } from "../../constants";
 
 const { first, second } = arrayUtilities;
 
-export default class TerminalSymbolBNFNode extends NonTerminalNode {
+export default class StringLiteralBNFNode extends NonTerminalNode {
   regularExpression = /^"((?:\\.|[^"\\])*)"$/;
 
   generatePart(callAhead) {
     const content = this.getContent(),
-          terminalSymbolPart = TerminalSymbolPart.fromContent(content);
+          stringLiteralPart = StringLiteralPart.fromContent(content);
 
-    return terminalSymbolPart;
+    return stringLiteralPart;
   }
 
   getContent() {
@@ -35,7 +35,7 @@ export default class TerminalSymbolBNFNode extends NonTerminalNode {
     return content;
   }
 
-  static fromRuleNameChildNodesOpacityAndPrecedence(ruleName, childNodes, opacity, precedence) { return NonTerminalNode.fromRuleNameChildNodesOpacityAndPrecedence(TerminalSymbolBNFNode, ruleName, childNodes, opacity, precedence); }
+  static fromRuleNameChildNodesOpacityAndPrecedence(ruleName, childNodes, opacity, precedence) { return NonTerminalNode.fromRuleNameChildNodesOpacityAndPrecedence(StringLiteralBNFNode, ruleName, childNodes, opacity, precedence); }
 }
 
 function sanitiseContent(content) {

package/src/nonTerminalNodeMap.js

@@ -16,7 +16,7 @@ import DefinitionBNFNode from "./node/bnf/definition";
 import DefinitionsBNFNode from "./node/bnf/definitions";
 import TerminalPartBNFNode from "./node/bnf/terminalPart";
 import ChoiceOfPartsBNFNode from "./node/bnf/choiceOfParts";
-import TerminalSymbolBNFNode from "./node/bnf/terminalSymbol";
+import StringLiteralBNFNode from "./node/bnf/stringLiteral";
 import BonTerminalPartBNFNode from "./node/bnf/nonTerminalPart";
 import SequenceOfPartsBNFNode from "./node/bnf/sequenceOfParts";
 import OpacityModifierBNFNode from "./node/bnf/opacityModifier";
@@ -44,8 +44,8 @@ import { NAME_RULE_NAME,
          PART_CHOICE_RULE_NAME,
          DEFINITIONS_RULE_NAME,
          TERMINAL_PART_RULE_NAME,
+         STRING_LITERAL_RULE_NAME,
          CHOICE_OF_PARTS_RULE_NAME,
-         TERMINAL_SYMBOL_RULE_NAME,
          OPACITY_MODIFIER_RULE_NAME,
          NON_TERMINAL_PART_RULE_NAME,
          SEQUENCE_OF_PARTS_RULE_NAME,
@@ -74,8 +74,8 @@ const NonTerminalNodeMap = {
   [PART_CHOICE_RULE_NAME]: PartChoiceBNFNode,
   [DEFINITIONS_RULE_NAME]: DefinitionsBNFNode,
   [TERMINAL_PART_RULE_NAME]: TerminalPartBNFNode,
+  [STRING_LITERAL_RULE_NAME]: StringLiteralBNFNode,
   [CHOICE_OF_PARTS_RULE_NAME]: ChoiceOfPartsBNFNode,
-  [TERMINAL_SYMBOL_RULE_NAME]: TerminalSymbolBNFNode,
   [OPACITY_MODIFIER_RULE_NAME]: OpacityModifierBNFNode,
   [NON_TERMINAL_PART_RULE_NAME]: BonTerminalPartBNFNode,
   [SEQUENCE_OF_PARTS_RULE_NAME]: SequenceOfPartsBNFNode,

package/src/parseTree/terminalNode.js

@@ -1,14 +1,34 @@
 "use strict";
 
+import { characters } from "necessary";
+
 import VerticalBranchParseTree from "./verticalBranch";
 
 import { EMPTY_STRING } from "../constants";
 import { lineIndexFromTokenIndexAndTokens } from "../utilities/tokens";
 
+const { NEW_LINE_CHARACTER, CARRIAGE_RETURN_CHARACTER } = characters;
+
 export default class TerminalNodeParseTree extends VerticalBranchParseTree {
   static fromTerminalNodeAndTokens(terminalNode, tokens) {
+    let content;
+
+    content = terminalNode.getContent();
+
+    content = content.replace(/[\r\n]/g, (match) => {
+      switch (match) {
+        case CARRIAGE_RETURN_CHARACTER:
+          return "\\r";
+
+        case NEW_LINE_CHARACTER:
+          return "\\n";
+
+        default:
+          return match;
+      }
+    });
+
     const type = terminalNode.getType(),
-          content = terminalNode.getContent(),
           significantTokenIndex = terminalNode.getSignificantTokenIndex(tokens),
           lineIndex = lineIndexFromTokenIndexAndTokens(significantTokenIndex, tokens);
 

package/src/part/terminal/{terminalSymbol.js → stringLiteral.js}

@@ -3,7 +3,7 @@
 import TerminalPart from "../../part/terminal";
 import TerminalNode from "../../node/terminal";
 
-export default class TerminalSymbolPart extends TerminalPart {
+export default class StringLiteralPart extends TerminalPart {
   constructor(content) {
     super();
     
@@ -54,8 +54,8 @@ export default class TerminalSymbolPart extends TerminalPart {
   }
 
   static fromContent(content) {
-    const terminalSymbolPart = new TerminalSymbolPart(content);
+    const stringLiteralPart = new StringLiteralPart(content);
 
-    return terminalSymbolPart;
+    return stringLiteralPart;
   }
 }

package/src/parts.js

@@ -1,29 +1,29 @@
 "use strict";
 
 import EpsilonPart from "./part/terminal/epsilon";
+import RuleNamePart from "./part/nonTerminal/ruleName";
 import WildcardPart from "./part/terminal/wildcard";
 import EndOfLinePart from "./part/terminal/endOfLine";
-import TerminalSymbolPart from "./part/terminal/terminalSymbol";
-import RegularExpressionPart from "./part/terminal/regularExpression";
-import SignificantTokenTypePart from "./part/terminal/significantTokenType";
-import RuleNamePart from "./part/nonTerminal/ruleName";
 import OptionalPartPart from "./part/nonTerminal/optionalPart";
-import ZeroOrMorePartsPart from "./part/nonTerminal/zeroOrMoreParts";
+import StringLiteralPart from "./part/terminal/stringLiteral";
+import ChoiceOfPartsPart from "./part/nonTerminal/choiceOfParts";
 import OneOrMorePartsPart from "./part/nonTerminal/oneOrMoreParts";
 import SequenceOfPartsPart from "./part/nonTerminal/sequenceOfParts";
-import ChoiceOfPartsPart from "./part/nonTerminal/choiceOfParts";
+import ZeroOrMorePartsPart from "./part/nonTerminal/zeroOrMoreParts";
+import RegularExpressionPart from "./part/terminal/regularExpression";
+import SignificantTokenTypePart from "./part/terminal/significantTokenType";
 
 export default {
   EpsilonPart,
+  RuleNamePart,
   WildcardPart,
   EndOfLinePart,
-  TerminalSymbolPart,
-  RegularExpressionPart,
-  SignificantTokenTypePart,
-  RuleNamePart,
   OptionalPartPart,
-  ZeroOrMorePartsPart,
+  ChoiceOfPartsPart,
+  StringLiteralPart,
   OneOrMorePartsPart,
   SequenceOfPartsPart,
-  ChoiceOfPartsPart
+  ZeroOrMorePartsPart,
+  RegularExpressionPart,
+  SignificantTokenTypePart
 };

package/src/rule/bnf/endOfLine.js

@@ -3,7 +3,7 @@
 import { specialSymbols } from "occam-lexers";
 
 import Rule from "../../rule";
-import TerminalSymbolDefinition from "../../definition/terminalSymbol";
+import StringLiteralDefinition from "../../definition/stringLiteral";
 
 import { END_OF_LINE_RULE_NAME } from "../../ruleNames";
 
@@ -12,11 +12,11 @@ const { endOfLine } = specialSymbols;
 export default class EndOfLineBNFRule extends Rule {
   static fromNothing() {
     const content = endOfLine,
-          endOfLineTerminalSymbolDefinition = TerminalSymbolDefinition.fromContent(content),
+          endOfLineStringLiteralDefinition = StringLiteralDefinition.fromContent(content),
           name = END_OF_LINE_RULE_NAME, ///
           opacity = null,
           definitions = [
-            endOfLineTerminalSymbolDefinition
+            endOfLineStringLiteralDefinition
           ],
           endOfLineRule = new EndOfLineBNFRule(name, opacity, definitions);
 

package/src/rule/bnf/epsilon.js

@@ -3,7 +3,7 @@
 import { specialSymbols } from "occam-lexers";
 
 import Rule from "../../rule";
-import TerminalSymbolDefinition from "../../definition/terminalSymbol";
+import StringLiteralDefinition from "../../definition/stringLiteral";
 
 import { EPSILON_RULE_NAME } from "../../ruleNames";
 
@@ -12,11 +12,11 @@ const { epsilon } = specialSymbols;
 export default class EpsilonBNFRule extends Rule {
   static fromNothing() {
     const content = epsilon, ///
-          epsilonTerminalSymbolDefinition = TerminalSymbolDefinition.fromContent(content),
+          epsilonStringLiteralDefinition = StringLiteralDefinition.fromContent(content),
           name = EPSILON_RULE_NAME, ///
           opacity = null,
           definitions = [
-            epsilonTerminalSymbolDefinition
+            epsilonStringLiteralDefinition
           ],
           epsilonRule = new EpsilonBNFRule(name, opacity, definitions);
 

package/src/rule/bnf/{terminalSymbol.js → stringLiteral.js}

@@ -5,21 +5,21 @@ import { types } from "occam-lexers";
 import Rule from "../../rule";
 import SignificantTokenTypeDefinition from "../../definition/significantTokenType";
 
-import { TERMINAL_SYMBOL_RULE_NAME } from "../../ruleNames";
+import { STRING_LITERAL_RULE_NAME } from "../../ruleNames";
 
 const { stringLiteralType } = types;
 
-export default class TerminalSymbolBNFRule extends Rule {
+export default class StringLiteralBNFRule extends Rule {
   static fromNothing() {
     const significantTokenType = stringLiteralType,  ///
           stringLiteralSignificantTokenTypeDefinition = SignificantTokenTypeDefinition.fromSignificantTokenType(significantTokenType),
-          name = TERMINAL_SYMBOL_RULE_NAME,  ///
+          name = STRING_LITERAL_RULE_NAME,  ///
           opacity = null,
           definitions = [
             stringLiteralSignificantTokenTypeDefinition
           ],
-          terminalSymbolRule = new TerminalSymbolBNFRule(name, opacity, definitions);
+          stringLiteralRule = new StringLiteralBNFRule(name, opacity, definitions);
 
-    return terminalSymbolRule;
+    return stringLiteralRule;
   }
 }

package/src/rule/bnf/terminalPart.js

@@ -7,7 +7,7 @@ import { EPSILON_RULE_NAME,
          WILDCARD_RULE_NAME,
          END_OF_LINE_RULE_NAME,
          TERMINAL_PART_RULE_NAME,
-         TERMINAL_SYMBOL_RULE_NAME,
+         STRING_LITERAL_RULE_NAME,
          NO_WHITESPACE_PART_RULE_NAME,
          REGULAR_EXPRESSION_RULE_NAME,
          START_OF_CONTENT_PART_RULE_NAME,
@@ -31,9 +31,9 @@ export default class TerminalPartBNFRule extends Rule {
 
     const endOfLineRuleNameDefinition = RuleNameDefinition.fromRuleName(ruleName);
 
-    ruleName = TERMINAL_SYMBOL_RULE_NAME;
+    ruleName = STRING_LITERAL_RULE_NAME;
 
-    const terminalSymbolRuleNameDefinition = RuleNameDefinition.fromRuleName(ruleName);
+    const stringLiteralRuleNameDefinition = RuleNameDefinition.fromRuleName(ruleName);
 
     ruleName = NO_WHITESPACE_PART_RULE_NAME;
 
@@ -54,7 +54,7 @@ export default class TerminalPartBNFRule extends Rule {
           definitions = [
             significantTokenTypeRuleNameDefinition,
             regularExpressionRuleNameDefinition,
-            terminalSymbolRuleNameDefinition,
+            stringLiteralRuleNameDefinition,
             endOfLineRuleNameDefinition,
             wildcardRuleNameDefinition,
             epsilonRuleNameDefinition,

package/src/rule/bnf/wildcard.js

@@ -3,7 +3,7 @@
 import { specialSymbols } from "occam-lexers";
 
 import Rule from "../../rule";
-import TerminalSymbolDefinition from "../../definition/terminalSymbol";
+import StringLiteralDefinition from "../../definition/stringLiteral";
 
 import { WILDCARD_RULE_NAME } from "../../ruleNames";
 
@@ -12,11 +12,11 @@ const { wildcard } = specialSymbols;
 export default class WildcardBNFRule extends Rule {
   static fromNothing() {
     const content = wildcard, ///
-          wildcardTerminalSymbolDefinition = TerminalSymbolDefinition.fromContent(content),
+          wildcardStringLiteralDefinition = StringLiteralDefinition.fromContent(content),
           name = WILDCARD_RULE_NAME,  ///
           opacity = null,
           definitions = [
-            wildcardTerminalSymbolDefinition
+            wildcardStringLiteralDefinition
           ],
           wildcardRule = new WildcardBNFRule(name, opacity, definitions);
 

package/src/ruleNames.js

@@ -15,8 +15,8 @@ export const END_OF_LINE_RULE_NAME = "endOfLine";
 export const PART_CHOICE_RULE_NAME = "partChoice";
 export const DEFINITIONS_RULE_NAME = "definitions";
 export const TERMINAL_PART_RULE_NAME = "terminalPart";
+export const STRING_LITERAL_RULE_NAME = "stringLiteral";
 export const CHOICE_OF_PARTS_RULE_NAME = "choiceOfParts";
-export const TERMINAL_SYMBOL_RULE_NAME = "terminalSymbol";
 export const OPACITY_MODIFIER_RULE_NAME = "opacityModifier";
 export const NON_TERMINAL_PART_RULE_NAME = "nonTerminalPart";
 export const SEQUENCE_OF_PARTS_RULE_NAME = "sequenceOfParts";

package/src/definition/terminalSymbol.js

@@ -1,17 +0,0 @@
-"use strict";
-
-import Definition from "../definition";
-import TerminalSymbolPart from "../part/terminal/terminalSymbol";
-
-export default class TerminalSymbolDefinition extends Definition {
-  static fromContent(content) {
-    const terminalSymbolPart = TerminalSymbolPart.fromContent(content),
-          parts = [
-            terminalSymbolPart
-          ],
-          precedence = null,
-          terminalSymbolDefinition = new TerminalSymbolDefinition(parts, precedence);
-
-    return terminalSymbolDefinition;
-  }
-}