| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473 |
- /*---------------------------------------------------------------------------------------------
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
- import { CursorColumns } from '../../../core/cursorColumns.js';
- import { lengthAdd, lengthGetLineCount, lengthToObj, lengthZero } from './length.js';
- import { SmallImmutableSet } from './smallImmutableSet.js';
- /**
- * The base implementation for all AST nodes.
- */
- class BaseAstNode {
- constructor(length) {
- this._length = length;
- }
- /**
- * The length of the entire node, which should equal the sum of lengths of all children.
- */
- get length() {
- return this._length;
- }
- }
- /**
- * Represents a bracket pair including its child (e.g. `{ ... }`).
- * Might be unclosed.
- * Immutable, if all children are immutable.
- */
- export class PairAstNode extends BaseAstNode {
- constructor(length, openingBracket, child, closingBracket, missingOpeningBracketIds) {
- super(length);
- this.openingBracket = openingBracket;
- this.child = child;
- this.closingBracket = closingBracket;
- this.missingOpeningBracketIds = missingOpeningBracketIds;
- }
- static create(openingBracket, child, closingBracket) {
- let length = openingBracket.length;
- if (child) {
- length = lengthAdd(length, child.length);
- }
- if (closingBracket) {
- length = lengthAdd(length, closingBracket.length);
- }
- return new PairAstNode(length, openingBracket, child, closingBracket, child ? child.missingOpeningBracketIds : SmallImmutableSet.getEmpty());
- }
- get kind() {
- return 2 /* AstNodeKind.Pair */;
- }
- get listHeight() {
- return 0;
- }
- get childrenLength() {
- return 3;
- }
- getChild(idx) {
- switch (idx) {
- case 0: return this.openingBracket;
- case 1: return this.child;
- case 2: return this.closingBracket;
- }
- throw new Error('Invalid child index');
- }
- /**
- * Avoid using this property, it allocates an array!
- */
- get children() {
- const result = new Array();
- result.push(this.openingBracket);
- if (this.child) {
- result.push(this.child);
- }
- if (this.closingBracket) {
- result.push(this.closingBracket);
- }
- return result;
- }
- canBeReused(openBracketIds) {
- if (this.closingBracket === null) {
- // Unclosed pair ast nodes only
- // end at the end of the document
- // or when a parent node is closed.
- // This could be improved:
- // Only return false if some next token is neither "undefined" nor a bracket that closes a parent.
- return false;
- }
- if (openBracketIds.intersects(this.missingOpeningBracketIds)) {
- return false;
- }
- return true;
- }
- deepClone() {
- return new PairAstNode(this.length, this.openingBracket.deepClone(), this.child && this.child.deepClone(), this.closingBracket && this.closingBracket.deepClone(), this.missingOpeningBracketIds);
- }
- computeMinIndentation(offset, textModel) {
- return this.child ? this.child.computeMinIndentation(lengthAdd(offset, this.openingBracket.length), textModel) : Number.MAX_SAFE_INTEGER;
- }
- }
- export class ListAstNode extends BaseAstNode {
- /**
- * Use ListAstNode.create.
- */
- constructor(length, listHeight, _missingOpeningBracketIds) {
- super(length);
- this.listHeight = listHeight;
- this._missingOpeningBracketIds = _missingOpeningBracketIds;
- this.cachedMinIndentation = -1;
- }
- /**
- * This method uses more memory-efficient list nodes that can only store 2 or 3 children.
- */
- static create23(item1, item2, item3, immutable = false) {
- let length = item1.length;
- let missingBracketIds = item1.missingOpeningBracketIds;
- if (item1.listHeight !== item2.listHeight) {
- throw new Error('Invalid list heights');
- }
- length = lengthAdd(length, item2.length);
- missingBracketIds = missingBracketIds.merge(item2.missingOpeningBracketIds);
- if (item3) {
- if (item1.listHeight !== item3.listHeight) {
- throw new Error('Invalid list heights');
- }
- length = lengthAdd(length, item3.length);
- missingBracketIds = missingBracketIds.merge(item3.missingOpeningBracketIds);
- }
- return immutable
- ? new Immutable23ListAstNode(length, item1.listHeight + 1, item1, item2, item3, missingBracketIds)
- : new TwoThreeListAstNode(length, item1.listHeight + 1, item1, item2, item3, missingBracketIds);
- }
- static getEmpty() {
- return new ImmutableArrayListAstNode(lengthZero, 0, [], SmallImmutableSet.getEmpty());
- }
- get kind() {
- return 4 /* AstNodeKind.List */;
- }
- get missingOpeningBracketIds() {
- return this._missingOpeningBracketIds;
- }
- throwIfImmutable() {
- // NOOP
- }
- makeLastElementMutable() {
- this.throwIfImmutable();
- const childCount = this.childrenLength;
- if (childCount === 0) {
- return undefined;
- }
- const lastChild = this.getChild(childCount - 1);
- const mutable = lastChild.kind === 4 /* AstNodeKind.List */ ? lastChild.toMutable() : lastChild;
- if (lastChild !== mutable) {
- this.setChild(childCount - 1, mutable);
- }
- return mutable;
- }
- makeFirstElementMutable() {
- this.throwIfImmutable();
- const childCount = this.childrenLength;
- if (childCount === 0) {
- return undefined;
- }
- const firstChild = this.getChild(0);
- const mutable = firstChild.kind === 4 /* AstNodeKind.List */ ? firstChild.toMutable() : firstChild;
- if (firstChild !== mutable) {
- this.setChild(0, mutable);
- }
- return mutable;
- }
- canBeReused(openBracketIds) {
- if (openBracketIds.intersects(this.missingOpeningBracketIds)) {
- return false;
- }
- let lastChild = this;
- let lastLength;
- while (lastChild.kind === 4 /* AstNodeKind.List */ && (lastLength = lastChild.childrenLength) > 0) {
- lastChild = lastChild.getChild(lastLength - 1);
- }
- return lastChild.canBeReused(openBracketIds);
- }
- handleChildrenChanged() {
- this.throwIfImmutable();
- const count = this.childrenLength;
- let length = this.getChild(0).length;
- let unopenedBrackets = this.getChild(0).missingOpeningBracketIds;
- for (let i = 1; i < count; i++) {
- const child = this.getChild(i);
- length = lengthAdd(length, child.length);
- unopenedBrackets = unopenedBrackets.merge(child.missingOpeningBracketIds);
- }
- this._length = length;
- this._missingOpeningBracketIds = unopenedBrackets;
- this.cachedMinIndentation = -1;
- }
- computeMinIndentation(offset, textModel) {
- if (this.cachedMinIndentation !== -1) {
- return this.cachedMinIndentation;
- }
- let minIndentation = Number.MAX_SAFE_INTEGER;
- let childOffset = offset;
- for (let i = 0; i < this.childrenLength; i++) {
- const child = this.getChild(i);
- if (child) {
- minIndentation = Math.min(minIndentation, child.computeMinIndentation(childOffset, textModel));
- childOffset = lengthAdd(childOffset, child.length);
- }
- }
- this.cachedMinIndentation = minIndentation;
- return minIndentation;
- }
- }
- class TwoThreeListAstNode extends ListAstNode {
- constructor(length, listHeight, _item1, _item2, _item3, missingOpeningBracketIds) {
- super(length, listHeight, missingOpeningBracketIds);
- this._item1 = _item1;
- this._item2 = _item2;
- this._item3 = _item3;
- }
- get childrenLength() {
- return this._item3 !== null ? 3 : 2;
- }
- getChild(idx) {
- switch (idx) {
- case 0: return this._item1;
- case 1: return this._item2;
- case 2: return this._item3;
- }
- throw new Error('Invalid child index');
- }
- setChild(idx, node) {
- switch (idx) {
- case 0:
- this._item1 = node;
- return;
- case 1:
- this._item2 = node;
- return;
- case 2:
- this._item3 = node;
- return;
- }
- throw new Error('Invalid child index');
- }
- get children() {
- return this._item3 ? [this._item1, this._item2, this._item3] : [this._item1, this._item2];
- }
- get item1() {
- return this._item1;
- }
- get item2() {
- return this._item2;
- }
- get item3() {
- return this._item3;
- }
- deepClone() {
- return new TwoThreeListAstNode(this.length, this.listHeight, this._item1.deepClone(), this._item2.deepClone(), this._item3 ? this._item3.deepClone() : null, this.missingOpeningBracketIds);
- }
- appendChildOfSameHeight(node) {
- if (this._item3) {
- throw new Error('Cannot append to a full (2,3) tree node');
- }
- this.throwIfImmutable();
- this._item3 = node;
- this.handleChildrenChanged();
- }
- unappendChild() {
- if (!this._item3) {
- throw new Error('Cannot remove from a non-full (2,3) tree node');
- }
- this.throwIfImmutable();
- const result = this._item3;
- this._item3 = null;
- this.handleChildrenChanged();
- return result;
- }
- prependChildOfSameHeight(node) {
- if (this._item3) {
- throw new Error('Cannot prepend to a full (2,3) tree node');
- }
- this.throwIfImmutable();
- this._item3 = this._item2;
- this._item2 = this._item1;
- this._item1 = node;
- this.handleChildrenChanged();
- }
- unprependChild() {
- if (!this._item3) {
- throw new Error('Cannot remove from a non-full (2,3) tree node');
- }
- this.throwIfImmutable();
- const result = this._item1;
- this._item1 = this._item2;
- this._item2 = this._item3;
- this._item3 = null;
- this.handleChildrenChanged();
- return result;
- }
- toMutable() {
- return this;
- }
- }
- /**
- * Immutable, if all children are immutable.
- */
- class Immutable23ListAstNode extends TwoThreeListAstNode {
- toMutable() {
- return new TwoThreeListAstNode(this.length, this.listHeight, this.item1, this.item2, this.item3, this.missingOpeningBracketIds);
- }
- throwIfImmutable() {
- throw new Error('this instance is immutable');
- }
- }
- /**
- * For debugging.
- */
- class ArrayListAstNode extends ListAstNode {
- constructor(length, listHeight, _children, missingOpeningBracketIds) {
- super(length, listHeight, missingOpeningBracketIds);
- this._children = _children;
- }
- get childrenLength() {
- return this._children.length;
- }
- getChild(idx) {
- return this._children[idx];
- }
- setChild(idx, child) {
- this._children[idx] = child;
- }
- get children() {
- return this._children;
- }
- deepClone() {
- const children = new Array(this._children.length);
- for (let i = 0; i < this._children.length; i++) {
- children[i] = this._children[i].deepClone();
- }
- return new ArrayListAstNode(this.length, this.listHeight, children, this.missingOpeningBracketIds);
- }
- appendChildOfSameHeight(node) {
- this.throwIfImmutable();
- this._children.push(node);
- this.handleChildrenChanged();
- }
- unappendChild() {
- this.throwIfImmutable();
- const item = this._children.pop();
- this.handleChildrenChanged();
- return item;
- }
- prependChildOfSameHeight(node) {
- this.throwIfImmutable();
- this._children.unshift(node);
- this.handleChildrenChanged();
- }
- unprependChild() {
- this.throwIfImmutable();
- const item = this._children.shift();
- this.handleChildrenChanged();
- return item;
- }
- toMutable() {
- return this;
- }
- }
- /**
- * Immutable, if all children are immutable.
- */
- class ImmutableArrayListAstNode extends ArrayListAstNode {
- toMutable() {
- return new ArrayListAstNode(this.length, this.listHeight, [...this.children], this.missingOpeningBracketIds);
- }
- throwIfImmutable() {
- throw new Error('this instance is immutable');
- }
- }
- const emptyArray = [];
- class ImmutableLeafAstNode extends BaseAstNode {
- get listHeight() {
- return 0;
- }
- get childrenLength() {
- return 0;
- }
- getChild(idx) {
- return null;
- }
- get children() {
- return emptyArray;
- }
- deepClone() {
- return this;
- }
- }
- export class TextAstNode extends ImmutableLeafAstNode {
- get kind() {
- return 0 /* AstNodeKind.Text */;
- }
- get missingOpeningBracketIds() {
- return SmallImmutableSet.getEmpty();
- }
- canBeReused(_openedBracketIds) {
- return true;
- }
- computeMinIndentation(offset, textModel) {
- const start = lengthToObj(offset);
- // Text ast nodes don't have partial indentation (ensured by the tokenizer).
- // Thus, if this text node does not start at column 0, the first line cannot have any indentation at all.
- const startLineNumber = (start.columnCount === 0 ? start.lineCount : start.lineCount + 1) + 1;
- const endLineNumber = lengthGetLineCount(lengthAdd(offset, this.length)) + 1;
- let result = Number.MAX_SAFE_INTEGER;
- for (let lineNumber = startLineNumber; lineNumber <= endLineNumber; lineNumber++) {
- const firstNonWsColumn = textModel.getLineFirstNonWhitespaceColumn(lineNumber);
- const lineContent = textModel.getLineContent(lineNumber);
- if (firstNonWsColumn === 0) {
- continue;
- }
- const visibleColumn = CursorColumns.visibleColumnFromColumn(lineContent, firstNonWsColumn, textModel.getOptions().tabSize);
- result = Math.min(result, visibleColumn);
- }
- return result;
- }
- }
- export class BracketAstNode extends ImmutableLeafAstNode {
- constructor(length, bracketInfo,
- /**
- * In case of a opening bracket, this is the id of the opening bracket.
- * In case of a closing bracket, this contains the ids of all opening brackets it can close.
- */
- bracketIds) {
- super(length);
- this.bracketInfo = bracketInfo;
- this.bracketIds = bracketIds;
- }
- static create(length, bracketInfo, bracketIds) {
- const node = new BracketAstNode(length, bracketInfo, bracketIds);
- return node;
- }
- get kind() {
- return 1 /* AstNodeKind.Bracket */;
- }
- get missingOpeningBracketIds() {
- return SmallImmutableSet.getEmpty();
- }
- get text() {
- return this.bracketInfo.bracketText;
- }
- get languageId() {
- return this.bracketInfo.languageId;
- }
- canBeReused(_openedBracketIds) {
- // These nodes could be reused,
- // but not in a general way.
- // Their parent may be reused.
- return false;
- }
- computeMinIndentation(offset, textModel) {
- return Number.MAX_SAFE_INTEGER;
- }
- }
- export class InvalidBracketAstNode extends ImmutableLeafAstNode {
- constructor(closingBrackets, length) {
- super(length);
- this.missingOpeningBracketIds = closingBrackets;
- }
- get kind() {
- return 3 /* AstNodeKind.UnexpectedClosingBracket */;
- }
- canBeReused(openedBracketIds) {
- return !openedBracketIds.intersects(this.missingOpeningBracketIds);
- }
- computeMinIndentation(offset, textModel) {
- return Number.MAX_SAFE_INTEGER;
- }
- }
|