clarity-pattern-parser 4.0.3 → 6.0.0

package/src/patterns/And.ts

@@ -1,178 +1,303 @@
-import ParseError from "../patterns/ParseError";
-import Cursor from "../Cursor";
-import Pattern from "./Pattern";
-import Node from "../ast/Node";
+import { Cursor } from "./Cursor";
+import { Pattern } from "./Pattern";
+import { Node } from "../ast/Node";
+import { clonePatterns } from "./clonePatterns";
+import { filterOutNull } from "./filterOutNull";
+import { findPattern } from "./findPattern";
+
+export class And implements Pattern {
+  private _type: string;
+  private _name: string;
+  private _parent: Pattern | null;
+  private _children: Pattern[];
+  private _isOptional: boolean;
+  private _nodes: (Node | null)[];
+  private _firstIndex: number;
+
+  get type(): string {
+    return this._type;
+  }
+
+  get name(): string {
+    return this._name;
+  }
 
-export default class And extends Pattern {
-  public onPatternIndex: number = 0;
-  public nodes: (Node | null)[] = [];
-  public node: Node | null = null;
-  public cursor: Cursor | null = null;
-  public mark: number = 0;
+  get parent(): Pattern | null {
+    return this._parent;
+  }
 
-  constructor(name: string, patterns: Pattern[], isOptional = false) {
-    super("and", name, patterns, isOptional);
+  set parent(pattern: Pattern | null) {
+    this._parent = pattern;
   }
 
-  parse(cursor: Cursor) {
-    this.resetState(cursor);
-    this.tryToParse();
+  get children(): Pattern[] {
+    return this._children;
+  }
 
-    return this.node;
+  get isOptional(): boolean {
+    return this._isOptional;
   }
 
-  clone(name?: string, isOptional?: boolean) {
-    if (name == null) {
-      name = this.name;
+  constructor(name: string, sequence: Pattern[], isOptional = false) {
+    if (sequence.length === 0) {
+      throw new Error("Need at least one pattern with an 'and' pattern.");
     }
 
-    if (isOptional == null){
-      isOptional = this._isOptional;
+    const children = clonePatterns(sequence);
+    this._assignChildrenToParent(children)
+
+    this._type = "and";
+    this._name = name;
+    this._isOptional = isOptional;
+    this._parent = null;
+    this._children = children;
+    this._firstIndex = -1
+    this._nodes = [];
+  }
+
+  private _assignChildrenToParent(children: Pattern[]): void {
+    for (const child of children) {
+      child.parent = this;
     }
+  }
+
+  test(text: string) {
+    const cursor = new Cursor(text);
+    const ast = this.parse(cursor);
+
+    return ast?.value === text;
+  }
 
-    return new And(name, this._children, isOptional);
+  exec(text: string) {
+    const cursor = new Cursor(text);
+    const ast = this.parse(cursor);
+
+    return {
+      ast: ast?.value === text ? ast : null,
+      cursor
+    };
   }
 
-  getTokens() {
-    let tokens: string[] = [];
+  parse(cursor: Cursor): Node | null {
+    this._firstIndex = cursor.index;
+    this._nodes = [];
+
+    const passed = this.tryToParse(cursor);
+
+    if (passed) {
+      const node = this.createNode(cursor);
+
+      if (node !== null) {
+        cursor.recordMatch(this, node);
+      }
+
+      return node;
+    }
+
+    if (this._isOptional) {
+      cursor.resolveError();
+    }
 
-    for (let x = 0; x < this._children.length; x++) {
-      const child = this._children[x];
+    return null;
+  }
 
-      if (child.isOptional) {
-        tokens = tokens.concat(child.getTokens());
+  private tryToParse(cursor: Cursor): boolean {
+    let passed = false;
+
+    for (let i = 0; i < this._children.length; i++) {
+      const runningCursorIndex = cursor.index;
+      const nextPatternIndex = i + 1;
+      const hasMorePatterns = nextPatternIndex < this._children.length;
+
+      const node = this._children[i].parse(cursor);
+      const hasNoError = !cursor.hasError;
+      const hadMatch = node !== null;
+
+      if (hasNoError) {
+        this._nodes.push(node);
+
+        if (hasMorePatterns) {
+          if (hadMatch) {
+            if (cursor.hasNext()) {
+              // We had a match. Increment the cursor and use the next pattern.
+              cursor.next();
+              continue;
+            } else {
+              // We are at the end of the text, it may still be valid, if all the
+              // following patterns are optional.
+              if (this.areRemainingPatternsOptional(i)) {
+                passed = true;
+                break;
+              }
+
+              // We didn't finish the parsing sequence.
+              cursor.recordErrorAt(cursor.index + 1, this);
+              break;
+            }
+          } else {
+            // An optional pattern did not matched, try from the same spot on the next
+            // pattern.
+            cursor.moveTo(runningCursorIndex);
+            continue;
+          }
+        } else {
+          // If we don't have any results from what we parsed then record error.
+          const lastNode = this.getLastValidNode();
+          if (lastNode === null) {
+            cursor.recordErrorAt(cursor.index, this);
+            break;
+          }
+
+          // The sequence was parsed fully.
+          passed = true;
+          break;
+        }
       } else {
-        tokens = tokens.concat(child.getTokens());
+        // The pattern failed.
+        cursor.moveTo(this._firstIndex);
         break;
       }
     }
 
-    return tokens;
+    return passed;
   }
 
-  private resetState(cursor: Cursor) {
-    this.onPatternIndex = 0;
-    this.nodes = [];
-    this.node = null;
-    this.cursor = cursor;
-    this.mark = this.cursor.mark();
-  }
+  private getLastValidNode(): Node | null {
+    const nodes = filterOutNull(this._nodes);
 
-  private tryToParse() {
-    const cursor = this.safelyGetCursor();
+    if (nodes.length === 0) {
+      return null;
+    }
 
-    while (true) {
-      const pattern = this._children[this.onPatternIndex];
-      const node = pattern.parse(cursor);
+    return nodes[nodes.length - 1];
+  }
 
-      if (cursor.hasUnresolvedError()) {
-        this.processError();
-        break;
-      } else {
-        this.nodes.push(node);
-      }
+  private areRemainingPatternsOptional(fromIndex: number): boolean {
+    const startOnIndex = fromIndex + 1;
+    const length = this._children.length;
 
-      if (!this.shouldProceed()) {
-        this.processResult();
-        break;
+    for (let i = startOnIndex; i < length; i++) {
+      const pattern = this._children[i];
+      if (!pattern.isOptional) {
+        return false;
       }
     }
+
+    return true;
   }
 
-  private safelyGetCursor() {
-    const cursor = this.cursor;
+  private createNode(cursor: Cursor): Node | null {
+    const children = filterOutNull(this._nodes);
 
-    if (cursor == null) {
-      throw new Error("Couldn't find cursor.");
-    }
-    return cursor;
+    const lastIndex = children[children.length - 1].lastIndex;
+    const value = cursor.getChars(this._firstIndex, lastIndex);
+
+    cursor.moveTo(lastIndex)
+
+    return new Node(
+      "and",
+      this._name,
+      this._firstIndex,
+      lastIndex,
+      children
+    );
   }
 
-  private processResult() {
-    const cursor = this.safelyGetCursor();
+  getTokens(): string[] {
+    const tokens: string[] = [];
 
-    if (cursor.hasUnresolvedError()) {
-      this.processError();
-    } else {
-      this.processSuccess();
+    for (const child of this._children) {
+      tokens.push(...child.getTokens());
+
+      if (!child.isOptional) {
+        break;
+      }
     }
+
+    return tokens;
   }
 
-  private processError() {
-    const cursor = this.safelyGetCursor();
+  getTokensAfter(childReference: Pattern): string[] {
+    const patterns = this.getPatternsAfter(childReference);
+    const tokens: string[] = [];
 
-    if (this.isOptional) {
-      cursor.moveToMark(this.mark);
-      cursor.resolveError();
-    }
-    this.node = null;
+    patterns.forEach(p => tokens.push(...p.getTokens()));
+
+    return tokens;
   }
 
-  private shouldProceed() {
-    const cursor = this.safelyGetCursor();
+  getNextTokens(): string[] {
+    if (this.parent == null) {
+      return []
+    }
 
-    if (this.hasMorePatterns()) {
-      const lastNode = this.nodes[this.nodes.length - 1];
-      const wasOptional = lastNode == null;
+    return this.parent.getTokensAfter(this);
+  }
 
-      if (cursor.hasNext()) {
-        if (!wasOptional) {
-          cursor.next();
-        }
+  getPatternsAfter(childReference: Pattern): Pattern[] {
+    let nextSibling: Pattern | null = null;
+    let nextSiblingIndex = -1;
+    let index = -1;
+    const patterns: Pattern[] = [];
 
-        this.onPatternIndex++;
-        return true;
-      } else if (wasOptional) {
-        this.onPatternIndex++;
-        return true;
+    for (let i = 0; i < this._children.length; i++) {
+      if (this._children[i] === childReference) {
+        if (i + 1 < this._children.length) {
+          nextSibling = this._children[i + 1];
+        }
+        nextSiblingIndex = i + 1;
+        index = i;
+        break;
       }
+    }
 
-      this.assertRestOfPatternsAreOptional();
-      return false;
-    } else {
-      return false;
+    // The child reference isn't one of the child patterns.
+    if (index === -1) {
+      return [];
     }
-  }
 
-  private hasMorePatterns() {
-    return this.onPatternIndex + 1 < this._children.length;
-  }
+    // The reference pattern is the last child. So ask the parent for the next pattern.
+    if (nextSiblingIndex === this._children.length && this._parent !== null) {
+      return this._parent.getPatternsAfter(this);
+    }
 
-  private assertRestOfPatternsAreOptional() {
-    const cursor = this.safelyGetCursor();
-    const areTheRestOptional = this.areTheRemainingPatternsOptional();
+    // Next pattern isn't optional so send it back as the next patterns.
+    if (nextSibling !== null && !nextSibling.isOptional) {
+      return [nextSibling];
+    }
 
-    if (!areTheRestOptional) {
-      const parseError = new ParseError(
-        `Could not match ${this.name} before string ran out.`,
-        this.onPatternIndex,
-        this
-      );
+    // Send back as many optional patterns as possible.
+    if (nextSibling !== null && nextSibling.isOptional) {
+      for (let i = nextSiblingIndex; i < this._children.length; i++) {
+        const child = this._children[i];
+        patterns.push(child);
 
-      cursor.throwError(parseError);
+        if (!child.isOptional) {
+          break;
+        }
+
+        if (i === this._children.length - 1 && this._parent !== null) {
+          patterns.push(...this._parent.getPatternsAfter(this));
+        }
+      }
     }
-  }
 
-  private areTheRemainingPatternsOptional() {
-    return this.children
-      .slice(this.onPatternIndex + 1)
-      .map((p) => p.isOptional)
-      .every((r) => r);
+    return patterns;
   }
 
-  private processSuccess() {
-    const cursor = this.safelyGetCursor();
-    const nodes = this.nodes.filter((node) => node != null) as Node[];
-    this.nodes = nodes;
+  getNextPatterns(): Pattern[] {
+    if (this.parent == null) {
+      return [];
+    }
 
-    const lastNode = nodes[this.nodes.length - 1];
-    const startIndex = this.mark;
-    const endIndex = lastNode.endIndex;
-    const value = nodes.map((node) => node.value).join("");
+    return this.parent.getPatternsAfter(this)
+  }
 
-    this.node = new Node("and", this.name, startIndex, endIndex, nodes, value);
+  findPattern(predicate: (p: Pattern) => boolean): Pattern | null {
+    return findPattern(this, predicate);
+  }
 
-    cursor.index = this.node.endIndex;
-    cursor.addMatch(this, this.node);
+  clone(name = this._name, isOptional = this._isOptional): Pattern {
+    return new And(name, this._children, isOptional)
   }
 }

package/src/patterns/Cursor.test.ts

@@ -0,0 +1,93 @@
+import { Cursor } from "./Cursor";
+import { Literal } from "./Literal";
+import { Node } from "../ast/Node"
+
+describe("Cursor", () => {
+    test("Empty Text", () => {
+        expect(() => {
+            new Cursor("");
+        }).toThrowError()
+    });
+
+    test("Move Cursor", () => {
+        const cursor = new Cursor("Hello World!");
+        cursor.moveTo(6);
+
+        expect(cursor.currentChar).toBe("W")
+
+        cursor.moveToFirstChar();
+        cursor.previous();
+
+        expect(cursor.isOnFirst).toBeTruthy();
+        expect(cursor.currentChar).toBe("H");
+
+        cursor.next();
+
+        expect(cursor.currentChar).toBe("e");
+
+        cursor.moveToLastChar();
+        cursor.next();
+
+        expect(cursor.isOnLast).toBeTruthy()
+        expect(cursor.currentChar).toBe("!");
+
+        cursor.previous();
+
+        expect(cursor.currentChar).toBe("d");
+    });
+
+    test("Error Handling", () => {
+        const pattern = new Literal("a", "A");
+        const cursor = new Cursor("Hello World!");
+
+        cursor.recordErrorAt(0, pattern);
+
+        expect(cursor.hasError).toBeTruthy();
+        expect(cursor.error?.index).toBe(0);
+        expect(cursor.error?.pattern).toBe(pattern);
+
+        cursor.resolveError();
+
+        expect(cursor.hasError).toBeFalsy();
+        expect(cursor.error).toBe(null);
+        expect(cursor.furthestError?.index).toBe(0);
+        expect(cursor.furthestError?.pattern).toBe(pattern);
+    });
+
+    test("Error Handling", () => {
+        const pattern = new Literal("h", "H");
+        const node = new Node("literal", "h", 0, 0, [], "H");
+
+        const cursor = new Cursor("Hello World!");
+
+        cursor.recordMatch(pattern, node)
+
+        expect(cursor.leafMatch.node).toBe(node);
+        expect(cursor.leafMatch.pattern).toBe(pattern);
+
+        expect(cursor.rootMatch.node).toBe(node);
+        expect(cursor.rootMatch.pattern).toBe(pattern);
+    });
+
+    test("Recording", () => {
+        const cursor = new Cursor("Hello World!");
+        cursor.startRecording();
+
+        expect(cursor.isRecording).toBeTruthy();
+
+        cursor.stopRecording();
+
+        expect(cursor.isRecording).toBeFalsy();
+    });
+
+
+    test("Text Information", () => {
+        const cursor = new Cursor("Hello World!");
+        const hello = cursor.getChars(0, 4);
+
+        expect(hello).toBe("Hello");
+        expect(cursor.length).toBe(12);
+        expect(cursor.text).toBe("Hello World!")
+        expect(cursor.index).toBe(0);
+    });
+});

package/src/patterns/Cursor.ts

@@ -0,0 +1,133 @@
+import { Node } from "../ast/Node";
+import { CursorHistory, Match } from "./CursorHistory";
+import { ParseError } from "./ParseError";
+import { Pattern } from "./Pattern";
+
+export class Cursor {
+  private _text: string;
+  private _index: number;
+  private _length: number;
+  private _history: CursorHistory;
+
+  get text(): string {
+    return this._text;
+  }
+
+  get isOnFirst(): boolean {
+    return this._index === 0;
+  }
+
+  get isOnLast(): boolean {
+    return this._index === this.getLastIndex();
+  }
+
+  get isRecording(): boolean {
+    return this._history.isRecording;
+  }
+
+  get rootMatch(): Match {
+    return this._history.rootMatch;
+  }
+
+  get leafMatch(): Match {
+    return this._history.leafMatch;
+  }
+
+  get furthestError(): ParseError | null {
+    return this._history.furthestError;
+  }
+
+  get error() {
+    return this._history.error;
+  }
+
+  get index(): number {
+    return this._index;
+  }
+
+  get length(): number {
+    return this._length;
+  }
+
+  get hasError(): boolean {
+    return this._history.error != null
+  }
+
+  get currentChar(): string {
+    return this._text[this._index]
+  }
+
+  constructor(text: string) {
+    if (text.length === 0) {
+      throw new Error("Cannot have a empty string.");
+    }
+
+    this._text = text;
+    this._index = 0;
+    this._length = text.length;
+    this._history = new CursorHistory();
+  }
+
+  hasNext(): boolean {
+    return this._index + 1 < this._length;
+  }
+
+  next(): void {
+    if (this.hasNext()) {
+      this._index++;
+    }
+  }
+
+  hasPrevious(): boolean {
+    return this._index - 1 >= 0;
+  }
+
+  previous(): void {
+    if (this.hasPrevious()) {
+      this._index--;
+    }
+  }
+
+  moveTo(position: number): void {
+    if (position >= 0 && position < this._length) {
+      this._index = position;
+    }
+  }
+
+  moveToFirstChar(): void {
+    this._index = 0;
+  }
+
+  moveToLastChar(): void {
+    this._index = this.getLastIndex();
+  }
+
+  getLastIndex(): number {
+    return this._length - 1;
+  }
+
+  getChars(first: number, last: number): string {
+    return this._text.slice(first, last + 1);
+  }
+
+  recordMatch(pattern: Pattern, node: Node): void {
+    this._history.recordMatch(pattern, node);
+  }
+
+  recordErrorAt(index: number, onPattern: Pattern): void {
+    this._history.recordErrorAt(index, onPattern);
+  }
+
+  resolveError(): void {
+    this._history.resolveError()
+  }
+
+  startRecording(): void {
+    this._history.startRecording();
+  }
+
+  stopRecording(): void {
+    this._history.stopRecording();
+  }
+
+}