clarity-pattern-parser 4.0.3 → 6.0.0

package/src/patterns/Repeat.test.ts

@@ -0,0 +1,218 @@
+import { Node } from "../ast/Node";
+import { And } from "./And";
+import { Cursor } from "./Cursor";
+import { findPattern } from "./findPattern";
+import { Literal } from "./Literal";
+import { Pattern } from "./Pattern";
+import { Regex } from "./Regex";
+import { Repeat } from "./Repeat";
+
+describe("Repeat", () => {
+    test("Successful Parse", () => {
+        const digit = new Regex("digit", "\\d");
+        const integer = new Repeat("number", digit);
+        const cursor = new Cursor("337");
+        const result = integer.parse(cursor);
+        const expected = new Node("repeat", "number", 0, 2, [
+            new Node("regex", "digit", 0, 0, [], "3"),
+            new Node("regex", "digit", 1, 1, [], "3"),
+            new Node("regex", "digit", 2, 2, [], "7"),
+        ]);
+
+        expect(result).toEqual(expected)
+        expect(cursor.hasError).toBeFalsy()
+    });
+
+    test("Failed Parse", () => {
+        const digit = new Regex("digit", "\\d");
+        const integer = new Repeat("number", digit);
+        const cursor = new Cursor("John");
+        const result = integer.parse(cursor);
+
+        expect(result).toBeNull()
+        expect(cursor.hasError).toBeTruthy()
+    });
+
+    test("Successful Parse With Divider", () => {
+        const digit = new Regex("digit", "\\d");
+        const divider = new Literal("divider", ",");
+        const integer = new Repeat("number", digit, divider);
+        const cursor = new Cursor("3,3,7");
+        const result = integer.parse(cursor);
+        const expected = new Node("repeat", "number", 0, 4, [
+            new Node("regex", "digit", 0, 0, [], "3"),
+            new Node("literal", "divider", 1, 1, [], ","),
+            new Node("regex", "digit", 2, 2, [], "3"),
+            new Node("literal", "divider", 3, 3, [], ","),
+            new Node("regex", "digit", 4, 4, [], "7"),
+        ]);
+
+        expect(result).toEqual(expected)
+        expect(cursor.hasError).toBeFalsy()
+    });
+
+    test("Successful Parse Text Ends With Divider", () => {
+        const digit = new Regex("digit", "\\d");
+        const divider = new Literal("divider", ",");
+        const integer = new Repeat("number", digit, divider);
+        const cursor = new Cursor("3,3,7,");
+        const result = integer.parse(cursor);
+        const expected = new Node("repeat", "number", 0, 4, [
+            new Node("regex", "digit", 0, 0, [], "3"),
+            new Node("literal", "divider", 1, 1, [], ","),
+            new Node("regex", "digit", 2, 2, [], "3"),
+            new Node("literal", "divider", 3, 3, [], ","),
+            new Node("regex", "digit", 4, 4, [], "7"),
+        ]);
+
+        expect(result).toEqual(expected)
+        expect(cursor.hasError).toBeFalsy()
+    });
+
+    test("Successful Parse Trailing Comma", () => {
+        const digit = new Regex("digit", "\\d");
+        const divider = new Literal("divider", ",");
+        const integer = new Repeat("number", digit, divider);
+        const cursor = new Cursor("3,3,7,t");
+        const result = integer.parse(cursor);
+        const expected = new Node("repeat", "number", 0, 4, [
+            new Node("regex", "digit", 0, 0, [], "3"),
+            new Node("literal", "divider", 1, 1, [], ","),
+            new Node("regex", "digit", 2, 2, [], "3"),
+            new Node("literal", "divider", 3, 3, [], ","),
+            new Node("regex", "digit", 4, 4, [], "7"),
+        ]);
+
+        expect(result).toEqual(expected)
+        expect(cursor.hasError).toBeFalsy()
+    });
+
+    test("Failed (Optional)", () => {
+        const digit = new Regex("digit", "\\d");
+        const integer = new Repeat("number", digit, undefined, true);
+        const cursor = new Cursor("John");
+        const result = integer.parse(cursor);
+
+        expect(result).toBeNull()
+        expect(cursor.hasError).toBeFalsy()
+    });
+
+    test("Get Tokens", () => {
+        const a = new Literal("a", "A");
+        const manyA = new Repeat("number", a);
+        const tokens = manyA.getTokens();
+        const expected = ["A"];
+
+        expect(tokens).toEqual(expected)
+    });
+
+    test("Get Tokens After With Bogus Pattern", () => {
+        const a = new Literal("a", "A");
+        const manyA = new Repeat("many-a", a);
+        const tokens = manyA.getTokensAfter(new Literal("bogus", "bogus"));
+        const expected: string[] = [];
+
+        expect(tokens).toEqual(expected)
+    });
+
+    test("Get Tokens After With Divider", () => {
+        const a = new Literal("a", "A");
+        const b = new Literal("b", "B");
+        const divider = new Literal("divider", ",");
+        const manyA = new Repeat("many-a", a, divider);
+        const parent = new And("parent", [manyA, b]);
+
+        const clonedManyA = findPattern(parent, p => p.name == "many-a");
+        let tokens = clonedManyA?.getTokensAfter(clonedManyA.children[0]);
+        let expected = [",", "B"];
+
+        expect(tokens).toEqual(expected)
+
+        tokens = clonedManyA?.getTokensAfter(clonedManyA.children[1]);
+        expected = ["A"];
+
+        expect(tokens).toEqual(expected)
+    });
+
+    test("Get Tokens After Without Divider", () => {
+        const a = new Literal("a", "A");
+        const b = new Literal("b", "B");
+        const manyA = new Repeat("many-a", a);
+        const parent = new And("parent", [manyA, b]);
+
+        const clonedManyA = findPattern(parent, p => p.name == "many-a");
+        const tokens = clonedManyA?.getTokensAfter(clonedManyA.children[0]);
+        const expected = ["A", "B"];
+
+        expect(tokens).toEqual(expected)
+    });
+
+    test("Properties", () => {
+        const integer = new Repeat("integer", new Regex("digit", "\\d"));
+
+        expect(integer.type).toBe("repeat");
+        expect(integer.name).toBe("integer");
+        expect(integer.isOptional).toBeFalsy()
+        expect(integer.parent).toBeNull();
+        expect(integer.children[0].name).toBe("digit");
+    });
+
+    test("Exec", () => {
+        const integer = new Repeat("integer", new Regex("digit", "\\d"));
+        const { ast: result } = integer.exec("B");
+        expect(result).toBeNull()
+    });
+
+    test("Test With Match", () => {
+        const integer = new Repeat("integer", new Regex("digit", "\\d"));
+        const result = integer.test("1");
+        expect(result).toBeTruthy()
+    });
+
+    test("Test With No Match", () => {
+        const integer = new Repeat("integer", new Regex("digit", "\\d"));
+        const result = integer.test("b");
+        expect(result).toBeFalsy()
+    });
+
+    test("Get Next Tokens", () => {
+        const integer = new Repeat("integer", new Regex("digit", "\\d"));
+        const parent = new And("parent", [integer, new Literal("pow", "!")]);
+        const integerClone = parent.findPattern(p => p.name === "integer") as Pattern;
+        const tokens = integerClone.getNextTokens();
+
+        expect(tokens).toEqual(["!"])
+    });
+
+    test("Get Next Tokens With Null Parents", () => {
+        const integer = new Repeat("integer", new Regex("digit", "\\d"));
+        const tokens = integer.getNextTokens();
+
+        expect(tokens.length).toBe(0);
+    });
+
+    test("Find Pattern", () => {
+        const integer = new Repeat("integer", new Regex("digit", "\\d"));
+        const digitClone = integer.findPattern(p => p.name === "digit") as Pattern;
+
+        expect(digitClone).not.toBeNull();
+    });
+
+    test("Get Next Patterns", () => {
+        const integer = new Repeat("integer", new Regex("digit", "\\d"));
+        const parent = new And("parent", [integer, new Literal("pow", "!")]);
+        const integerClone = parent.findPattern(p => p.name === "integer") as Pattern;
+        const powClone = parent.findPattern(p => p.name === "pow") as Pattern;
+        const patterns = integerClone.getNextPatterns();
+
+        expect(patterns.length).toBe(1);
+        expect(patterns[0]).toBe(powClone);
+    });
+
+    test("Get Next Patterns With Null Parents", () => {
+        const integer = new Repeat("integer", new Regex("digit", "\\d"));
+        const patterns = integer.getNextPatterns();
+
+        expect(patterns.length).toBe(0);
+    });
+});

package/src/patterns/Repeat.ts

@@ -1,87 +1,149 @@
-import Pattern from "./Pattern";
-import Node from "../ast/Node";
-import ParseError from "./ParseError";
-import Cursor from "../Cursor";
-
-export default class Repeat extends Pattern {
-  public _pattern: Pattern;
-  public _divider: Pattern;
-  public nodes: Node[] = [];
-  public cursor!: Cursor;
-  public mark: number = 0;
-  public node: Node | null = null;
-
-  constructor(
-    name: string,
-    pattern: Pattern,
-    divider?: Pattern,
-    isOptional = false
-  ) {
-    super(
-      "repeat",
-      name,
-      divider != null ? [pattern, divider] : [pattern],
-      isOptional
-    );
+import { Node } from "../ast/Node";
+import { Cursor } from "./Cursor";
+import { Pattern } from "./Pattern";
+import { clonePatterns } from "./clonePatterns";
+import { findPattern } from "./findPattern";
+
+export class Repeat implements Pattern {
+  private _type: string;
+  private _name: string;
+  private _parent: Pattern | null;
+  private _children: Pattern[];
+  private _pattern: Pattern;
+  private _divider: Pattern;
+  private _isOptional: boolean;
+  private _nodes: Node[];
+  private _firstIndex: number;
+
+  get type(): string {
+    return this._type;
+  }
+
+  get name(): string {
+    return this._name;
+  }
+
+  get parent(): Pattern | null {
+    return this._parent;
+  }
 
-    this._pattern = this.children[0];
-    this._divider = this.children[1];
-    this.assertArguments();
+  set parent(pattern: Pattern | null) {
+    this._parent = pattern;
   }
 
-  private assertArguments() {
-    if (this._pattern.isOptional) {
-      throw new Error(
-        "Invalid Arguments: The pattern cannot be a optional pattern."
-      );
+  get children(): Pattern[] {
+    return this._children;
+  }
+
+  get isOptional(): boolean {
+    return this._isOptional;
+  }
+
+  constructor(name: string, pattern: Pattern, divider?: Pattern, isOptional = false) {
+    const patterns = divider != null ? [pattern, divider] : [pattern];
+    const children: Pattern[] = clonePatterns(patterns, false);
+    this._assignChildrenToParent(children);
+
+    this._type = "repeat";
+    this._name = name;
+    this._isOptional = isOptional;
+    this._parent = null;
+    this._children = children;
+    this._pattern = children[0];
+    this._divider = children[1];
+    this._firstIndex = -1
+    this._nodes = [];
+  }
+
+  private _assignChildrenToParent(children: Pattern[]): void {
+    for (const child of children) {
+      child.parent = this;
     }
   }
 
-  private _reset(cursor: Cursor) {
-    this.nodes = [];
-    this.cursor = cursor;
-    this.mark = this.cursor.mark();
+  test(text: string) {
+    const cursor = new Cursor(text);
+    const ast = this.parse(cursor);
+
+    return ast?.value === text;
+  }
+
+  exec(text: string) {
+    const cursor = new Cursor(text);
+    const ast = this.parse(cursor);
+
+    return {
+      ast: ast?.value === text ? ast : null,
+      cursor
+    };
   }
 
-  parse(cursor: Cursor) {
-    this._reset(cursor);
-    this.tryToParse();
+  parse(cursor: Cursor): Node | null {
+    this._firstIndex = cursor.index;
+    this._nodes = [];
+
+    const passed = this.tryToParse(cursor);
+
+    if (passed) {
+      cursor.resolveError();
+      const node = this.createNode(cursor);
+
+      if (node != null) {
+        cursor.recordMatch(this, node);
+      }
+
+      return node;
+    }
+
+    if (!this._isOptional) {
+      return null;
+    }
 
-    return this.node;
+    cursor.resolveError();
+    cursor.moveTo(this._firstIndex);
+    return null;
   }
 
-  private tryToParse() {
-    const cursor = this.safelyGetCursor();
+  private tryToParse(cursor: Cursor): boolean {
+    let passed = false;
 
     while (true) {
-      const node = this._pattern.parse(cursor);
+      const runningCursorIndex = cursor.index;
+      const repeatedNode = this._pattern.parse(cursor);
+
+      if (cursor.hasError) {
+        const lastValidNode = this.getLastValidNode();
+
+        if (lastValidNode != null) {
+          passed = true;
+        } else {
+          cursor.moveTo(runningCursorIndex);
+          cursor.recordErrorAt(runningCursorIndex, this._pattern);
+          passed = false;
+        }
 
-      if (cursor.hasUnresolvedError()) {
-        this.processResult();
         break;
-      } else if (node != null) {
-        this.nodes.push(node);
+      } else if (repeatedNode) {
+        this._nodes.push(repeatedNode);
 
-        if (node.endIndex === cursor.lastIndex()) {
-          this.processResult();
+        if (!cursor.hasNext()) {
+          passed = true;
           break;
         }
 
         cursor.next();
 
         if (this._divider != null) {
-          const mark = cursor.mark();
-          const node = this._divider.parse(cursor);
+          const dividerNode = this._divider.parse(cursor);
 
-          if (cursor.hasUnresolvedError()) {
-            cursor.moveToMark(mark);
-            this.processResult();
+          if (cursor.hasError) {
+            passed = true;
             break;
-          } else if (node != null) {
-            this.nodes.push(node);
+          } else if (dividerNode != null) {
+            this._nodes.push(dividerNode);
 
-            if (node.endIndex === cursor.lastIndex()) {
-              this.processResult();
+            if (!cursor.hasNext()) {
+              passed = true;
               break;
             }
 
@@ -90,66 +152,121 @@ export default class Repeat extends Pattern {
         }
       }
     }
-  }
 
-  private processResult() {
-    const endsOnDivider = this.nodes.length % 2 === 0;
-    const noMatch = this.nodes.length === 0;
-    const hasDivider = this._divider != null;
+    return passed;
+  }
 
-    this.cursor.resolveError();
+  private createNode(cursor: Cursor): Node | null {
+    let children: Node[] = [];
 
-    if ((hasDivider && endsOnDivider) || noMatch) {
-      if (this._isOptional) {
-        this.cursor.moveToMark(this.mark);
-      } else  {
-        const parseError = new ParseError(
-          `Did not find a repeating match of ${this.name}.`,
-          this.mark,
-          this
-        );
-        this.cursor.throwError(parseError);
-      }
-      this.node = null;
+    if (!this._divider) {
+      children = this._nodes;
     } else {
-      const value = this.nodes.map((node) => node.value).join("");
-
-      this.node = new Node(
-        "repeat",
-        this.name,
-        this.nodes[0].startIndex,
-        this.nodes[this.nodes.length - 1].endIndex,
-        this.nodes,
-        value
-      );
-
-      this.cursor.index = this.node.endIndex;
-      this.cursor.addMatch(this, this.node);
+      if (this._nodes.length % 2 !== 1) {
+        const dividerNode = this._nodes[this._nodes.length - 1];
+        cursor.moveTo(dividerNode.firstIndex);
+        children = this._nodes.slice(0, this._nodes.length - 1);
+      } else {
+        children = this._nodes;
+      }
     }
+
+    const lastIndex = children[children.length - 1].lastIndex;
+    const value = cursor.getChars(this._firstIndex, lastIndex);
+    cursor.moveTo(lastIndex);
+
+    return new Node(
+      "repeat",
+      this._name,
+      this._firstIndex,
+      lastIndex,
+      children,
+      undefined
+    );
+  }
+
+  private getLastValidNode(): Node | null {
+    const nodes = this._nodes.filter((node) => node !== null);
+
+    if (nodes.length === 0) {
+      return null;
+    }
+
+    return nodes[nodes.length - 1];
+  }
+
+  getTokens(): string[] {
+    return this._pattern.getTokens();
   }
 
-  private safelyGetCursor() {
-    const cursor = this.cursor;
+  getTokensAfter(childReference: Pattern): string[] {
+    const patterns = this.getPatternsAfter(childReference);
+    const tokens: string[] = [];
+
+    patterns.forEach(p => tokens.push(...p.getTokens()));
+
+    return tokens;
+  }
 
-    if (cursor == null) {
-      throw new Error("Couldn't find cursor.");
+  getNextTokens(): string[] {
+    if (this.parent == null) {
+      return []
     }
-    return cursor;
+
+    return this.parent.getTokensAfter(this);
   }
 
-  clone(name?: string, isOptional?: boolean) {
-    if (name == null) {
-      name = this.name;
+  getPatternsAfter(childReference: Pattern): Pattern[] {
+    let index = -1;
+    const patterns: Pattern[] = [];
+
+    for (let i = 0; i < this._children.length; i++) {
+      if (this._children[i] === childReference) {
+        index = i;
+      }
     }
 
-    if (isOptional == null) {
-      isOptional = this._isOptional;
+    // If the last match isn't a child of this pattern.
+    if (index === -1) {
+      return [];
     }
 
-    return new Repeat(name, this._pattern, this._divider, isOptional);
+    // If the last match was the repeated patterns, then suggest the divider.
+    if (index === 0 && this._divider) {
+      patterns.push(this._children[1]);
+
+      if (this._parent) {
+        patterns.push(...this._parent.getPatternsAfter(this));
+      }
+    }
+
+    // Suggest the pattern because the divider was the last match.
+    if (index === 1) {
+      patterns.push(this._children[0]);
+    }
+
+    if (index === 0 && !this._divider && this._parent) {
+      patterns.push(this._children[0]);
+      patterns.push(...this._parent.getPatternsAfter(this));
+    }
+
+    return patterns;
   }
 
-  getTokens() {
-    return this._pattern.getTokens();
+  getNextPatterns(): Pattern[] {
+    if (this.parent == null) {
+      return [];
+    }
+
+    return this.parent.getPatternsAfter(this)
+  }
+
+  findPattern(predicate: (p: Pattern) => boolean): Pattern | null {
+    return findPattern(this, predicate);
+  }
+
+  clone(name = this._name, isOptional = this._isOptional): Pattern {
+    return new Repeat(name, this._pattern, this._divider, isOptional);
   }
 }
+

package/src/patterns/clonePatterns.ts

@@ -0,0 +1,5 @@
+import { Pattern } from "./Pattern";
+
+export function clonePatterns(patterns: Pattern[], isOptional?: boolean): Pattern[] {
+    return patterns.map(p => p.clone(p.name, isOptional))
+}

package/src/patterns/filterOutNull.ts

@@ -0,0 +1,13 @@
+import { Node } from "../ast/Node"
+
+export function filterOutNull(nodes: (Node | null)[]): Node[] {
+    const filteredNodes: Node[] = [];
+
+    for (const node of nodes) {
+        if (node !== null) {
+            filteredNodes.push(node);
+        }
+    }
+
+    return filteredNodes;
+}

package/src/patterns/findPattern.ts

@@ -0,0 +1,25 @@
+import { Pattern } from "./Pattern";
+
+export function findPattern(pattern: Pattern, predicate: (pattern: Pattern) => boolean): Pattern | null {
+    let children: Pattern[] = [];
+
+    if (pattern.type === "reference") {
+        children = [];
+    } else {
+        children = pattern.children;
+    }
+
+    for (const child of children) {
+        const result = findPattern(child, predicate);
+
+        if (result !== null) {
+            return result;
+        }
+    }
+
+    if (predicate(pattern)) {
+        return pattern;
+    } else {
+        return null;
+    }
+}