bahlint 28.58.6934

package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js

@@ -0,0 +1,61 @@
+/**
+ * @fileoverview Define the cursor which iterates tokens and comments in reverse.
+ * @author Toru Nagashima
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const Cursor = require("./cursor");
+const utils = require("./utils");
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * The cursor which iterates tokens and comments in reverse.
+ */
+module.exports = class BackwardTokenCommentCursor extends Cursor {
+	/**
+	 * Initializes this cursor.
+	 * @param {Token[]} tokens The array of tokens.
+	 * @param {Comment[]} comments The array of comments.
+	 * @param {Object} indexMap The map from locations to indices in `tokens`.
+	 * @param {number} startLoc The start location of the iteration range.
+	 * @param {number} endLoc The end location of the iteration range.
+	 */
+	constructor(tokens, comments, indexMap, startLoc, endLoc) {
+		super();
+		this.tokens = tokens;
+		this.comments = comments;
+		this.tokenIndex = utils.getLastIndex(tokens, indexMap, endLoc);
+		this.commentIndex = utils.search(comments, endLoc) - 1;
+		this.border = startLoc;
+	}
+
+	/** @inheritdoc */
+	moveNext() {
+		const token =
+			this.tokenIndex >= 0 ? this.tokens[this.tokenIndex] : null;
+		const comment =
+			this.commentIndex >= 0 ? this.comments[this.commentIndex] : null;
+
+		if (token && (!comment || token.range[1] > comment.range[1])) {
+			this.current = token;
+			this.tokenIndex -= 1;
+		} else if (comment) {
+			this.current = comment;
+			this.commentIndex -= 1;
+		} else {
+			this.current = null;
+		}
+
+		return (
+			Boolean(this.current) &&
+			(this.border === -1 || this.current.range[0] >= this.border)
+		);
+	}
+};

package/lib/languages/js/source-code/token-store/backward-token-cursor.js

@@ -0,0 +1,57 @@
+/**
+ * @fileoverview Define the cursor which iterates tokens only in reverse.
+ * @author Toru Nagashima
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const Cursor = require("./cursor");
+const { getLastIndex, getFirstIndex } = require("./utils");
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * The cursor which iterates tokens only in reverse.
+ */
+module.exports = class BackwardTokenCursor extends Cursor {
+	/**
+	 * Initializes this cursor.
+	 * @param {Token[]} tokens The array of tokens.
+	 * @param {Comment[]} comments The array of comments.
+	 * @param {Object} indexMap The map from locations to indices in `tokens`.
+	 * @param {number} startLoc The start location of the iteration range.
+	 * @param {number} endLoc The end location of the iteration range.
+	 */
+	constructor(tokens, comments, indexMap, startLoc, endLoc) {
+		super();
+		this.tokens = tokens;
+		this.index = getLastIndex(tokens, indexMap, endLoc);
+		this.indexEnd = getFirstIndex(tokens, indexMap, startLoc);
+	}
+
+	/** @inheritdoc */
+	moveNext() {
+		if (this.index >= this.indexEnd) {
+			this.current = this.tokens[this.index];
+			this.index -= 1;
+			return true;
+		}
+		return false;
+	}
+
+	/*
+	 *
+	 * Shorthand for performance.
+	 *
+	 */
+
+	/** @inheritdoc */
+	getOneToken() {
+		return this.index >= this.indexEnd ? this.tokens[this.index] : null;
+	}
+};

package/lib/languages/js/source-code/token-store/cursor.js

@@ -0,0 +1,76 @@
+/**
+ * @fileoverview Define the abstract class about cursors which iterate tokens.
+ * @author Toru Nagashima
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * The abstract class about cursors which iterate tokens.
+ *
+ * This class has 2 abstract methods.
+ *
+ * - `current: Token | Comment | null` ... The current token.
+ * - `moveNext(): boolean` ... Moves this cursor to the next token. If the next token didn't exist, it returns `false`.
+ *
+ * This is similar to ES2015 Iterators.
+ * However, Iterators were slow (at 2017-01), so I created this class as similar to C# IEnumerable.
+ *
+ * There are the following known sub classes.
+ *
+ * - ForwardTokenCursor .......... The cursor which iterates tokens only.
+ * - BackwardTokenCursor ......... The cursor which iterates tokens only in reverse.
+ * - ForwardTokenCommentCursor ... The cursor which iterates tokens and comments.
+ * - BackwardTokenCommentCursor .. The cursor which iterates tokens and comments in reverse.
+ * - DecorativeCursor
+ *     - FilterCursor ............ The cursor which ignores the specified tokens.
+ *     - SkipCursor .............. The cursor which ignores the first few tokens.
+ *     - LimitCursor ............. The cursor which limits the count of tokens.
+ *
+ */
+module.exports = class Cursor {
+	/**
+	 * Initializes this cursor.
+	 */
+	constructor() {
+		this.current = null;
+	}
+
+	/**
+	 * Gets the first token.
+	 * This consumes this cursor.
+	 * @returns {Token|Comment} The first token or null.
+	 */
+	getOneToken() {
+		return this.moveNext() ? this.current : null;
+	}
+
+	/**
+	 * Gets the first tokens.
+	 * This consumes this cursor.
+	 * @returns {(Token|Comment)[]} All tokens.
+	 */
+	getAllTokens() {
+		const tokens = [];
+
+		while (this.moveNext()) {
+			tokens.push(this.current);
+		}
+
+		return tokens;
+	}
+
+	/**
+	 * Moves this cursor to the next token.
+	 * @returns {boolean} `true` if the next token exists.
+	 * @abstract
+	 */
+	/* c8 ignore next */
+	// eslint-disable-next-line class-methods-use-this -- Unused
+	moveNext() {
+		throw new Error("Not implemented.");
+	}
+};

package/lib/languages/js/source-code/token-store/cursors.js

@@ -0,0 +1,120 @@
+/**
+ * @fileoverview Define 2 token factories; forward and backward.
+ * @author Toru Nagashima
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const BackwardTokenCommentCursor = require("./backward-token-comment-cursor");
+const BackwardTokenCursor = require("./backward-token-cursor");
+const FilterCursor = require("./filter-cursor");
+const ForwardTokenCommentCursor = require("./forward-token-comment-cursor");
+const ForwardTokenCursor = require("./forward-token-cursor");
+const LimitCursor = require("./limit-cursor");
+const SkipCursor = require("./skip-cursor");
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/**
+ * The cursor factory.
+ * @private
+ */
+class CursorFactory {
+	/**
+	 * Initializes this cursor.
+	 * @param {Function} TokenCursor The class of the cursor which iterates tokens only.
+	 * @param {Function} TokenCommentCursor The class of the cursor which iterates the mix of tokens and comments.
+	 */
+	constructor(TokenCursor, TokenCommentCursor) {
+		this.TokenCursor = TokenCursor;
+		this.TokenCommentCursor = TokenCommentCursor;
+	}
+
+	/**
+	 * Creates a base cursor instance that can be decorated by createCursor.
+	 * @param {Token[]} tokens The array of tokens.
+	 * @param {Comment[]} comments The array of comments.
+	 * @param {Object} indexMap The map from locations to indices in `tokens`.
+	 * @param {number} startLoc The start location of the iteration range.
+	 * @param {number} endLoc The end location of the iteration range.
+	 * @param {boolean} includeComments The flag to iterate comments as well.
+	 * @returns {Cursor} The created base cursor.
+	 */
+	createBaseCursor(
+		tokens,
+		comments,
+		indexMap,
+		startLoc,
+		endLoc,
+		includeComments,
+	) {
+		const Cursor = includeComments
+			? this.TokenCommentCursor
+			: this.TokenCursor;
+
+		return new Cursor(tokens, comments, indexMap, startLoc, endLoc);
+	}
+
+	/**
+	 * Creates a cursor that iterates tokens with normalized options.
+	 * @param {Token[]} tokens The array of tokens.
+	 * @param {Comment[]} comments The array of comments.
+	 * @param {Object} indexMap The map from locations to indices in `tokens`.
+	 * @param {number} startLoc The start location of the iteration range.
+	 * @param {number} endLoc The end location of the iteration range.
+	 * @param {boolean} includeComments The flag to iterate comments as well.
+	 * @param {Function|null} filter The predicate function to choose tokens.
+	 * @param {number} skip The count of tokens the cursor skips.
+	 * @param {number} count The maximum count of tokens the cursor iterates. Zero is no iteration for backward compatibility.
+	 * @returns {Cursor} The created cursor.
+	 */
+	createCursor(
+		tokens,
+		comments,
+		indexMap,
+		startLoc,
+		endLoc,
+		includeComments,
+		filter,
+		skip,
+		count,
+	) {
+		let cursor = this.createBaseCursor(
+			tokens,
+			comments,
+			indexMap,
+			startLoc,
+			endLoc,
+			includeComments,
+		);
+
+		if (filter) {
+			cursor = new FilterCursor(cursor, filter);
+		}
+		if (skip >= 1) {
+			cursor = new SkipCursor(cursor, skip);
+		}
+		if (count >= 0) {
+			cursor = new LimitCursor(cursor, count);
+		}
+
+		return cursor;
+	}
+}
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+module.exports = {
+	forward: new CursorFactory(ForwardTokenCursor, ForwardTokenCommentCursor),
+	backward: new CursorFactory(
+		BackwardTokenCursor,
+		BackwardTokenCommentCursor,
+	),
+};

package/lib/languages/js/source-code/token-store/decorative-cursor.js

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview Define the abstract class about cursors which manipulate another cursor.
+ * @author Toru Nagashima
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const Cursor = require("./cursor");
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * The abstract class about cursors which manipulate another cursor.
+ */
+module.exports = class DecorativeCursor extends Cursor {
+	/**
+	 * Initializes this cursor.
+	 * @param {Cursor} cursor The cursor to be decorated.
+	 */
+	constructor(cursor) {
+		super();
+		this.cursor = cursor;
+	}
+
+	/** @inheritdoc */
+	moveNext() {
+		const retv = this.cursor.moveNext();
+
+		this.current = this.cursor.current;
+
+		return retv;
+	}
+};

package/lib/languages/js/source-code/token-store/filter-cursor.js

@@ -0,0 +1,42 @@
+/**
+ * @fileoverview Define the cursor which ignores specified tokens.
+ * @author Toru Nagashima
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const DecorativeCursor = require("./decorative-cursor");
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * The decorative cursor which ignores specified tokens.
+ */
+module.exports = class FilterCursor extends DecorativeCursor {
+	/**
+	 * Initializes this cursor.
+	 * @param {Cursor} cursor The cursor to be decorated.
+	 * @param {Function} predicate The predicate function to decide tokens this cursor iterates.
+	 */
+	constructor(cursor, predicate) {
+		super(cursor);
+		this.predicate = predicate;
+	}
+
+	/** @inheritdoc */
+	moveNext() {
+		const predicate = this.predicate;
+
+		while (super.moveNext()) {
+			if (predicate(this.current)) {
+				return true;
+			}
+		}
+		return false;
+	}
+};

package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js

@@ -0,0 +1,65 @@
+/**
+ * @fileoverview Define the cursor which iterates tokens and comments.
+ * @author Toru Nagashima
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const Cursor = require("./cursor");
+const { getFirstIndex, search } = require("./utils");
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * The cursor which iterates tokens and comments.
+ */
+module.exports = class ForwardTokenCommentCursor extends Cursor {
+	/**
+	 * Initializes this cursor.
+	 * @param {Token[]} tokens The array of tokens.
+	 * @param {Comment[]} comments The array of comments.
+	 * @param {Object} indexMap The map from locations to indices in `tokens`.
+	 * @param {number} startLoc The start location of the iteration range.
+	 * @param {number} endLoc The end location of the iteration range.
+	 */
+	constructor(tokens, comments, indexMap, startLoc, endLoc) {
+		super();
+		this.tokens = tokens;
+		this.comments = comments;
+		this.tokenIndex = getFirstIndex(tokens, indexMap, startLoc);
+		this.commentIndex = search(comments, startLoc);
+		this.border = endLoc;
+	}
+
+	/** @inheritdoc */
+	moveNext() {
+		const token =
+			this.tokenIndex < this.tokens.length
+				? this.tokens[this.tokenIndex]
+				: null;
+		const comment =
+			this.commentIndex < this.comments.length
+				? this.comments[this.commentIndex]
+				: null;
+
+		if (token && (!comment || token.range[0] < comment.range[0])) {
+			this.current = token;
+			this.tokenIndex += 1;
+		} else if (comment) {
+			this.current = comment;
+			this.commentIndex += 1;
+		} else {
+			this.current = null;
+		}
+
+		return (
+			Boolean(this.current) &&
+			(this.border === -1 || this.current.range[1] <= this.border)
+		);
+	}
+};

package/lib/languages/js/source-code/token-store/forward-token-cursor.js

@@ -0,0 +1,62 @@
+/**
+ * @fileoverview Define the cursor which iterates tokens only.
+ * @author Toru Nagashima
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const Cursor = require("./cursor");
+const { getFirstIndex, getLastIndex } = require("./utils");
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * The cursor which iterates tokens only.
+ */
+module.exports = class ForwardTokenCursor extends Cursor {
+	/**
+	 * Initializes this cursor.
+	 * @param {Token[]} tokens The array of tokens.
+	 * @param {Comment[]} comments The array of comments.
+	 * @param {Object} indexMap The map from locations to indices in `tokens`.
+	 * @param {number} startLoc The start location of the iteration range.
+	 * @param {number} endLoc The end location of the iteration range.
+	 */
+	constructor(tokens, comments, indexMap, startLoc, endLoc) {
+		super();
+		this.tokens = tokens;
+		this.index = getFirstIndex(tokens, indexMap, startLoc);
+		this.indexEnd = getLastIndex(tokens, indexMap, endLoc);
+	}
+
+	/** @inheritdoc */
+	moveNext() {
+		if (this.index <= this.indexEnd) {
+			this.current = this.tokens[this.index];
+			this.index += 1;
+			return true;
+		}
+		return false;
+	}
+
+	/*
+	 *
+	 * Shorthand for performance.
+	 *
+	 */
+
+	/** @inheritdoc */
+	getOneToken() {
+		return this.index <= this.indexEnd ? this.tokens[this.index] : null;
+	}
+
+	/** @inheritdoc */
+	getAllTokens() {
+		return this.tokens.slice(this.index, this.indexEnd + 1);
+	}
+};