Pass cancellable token around

Author: ghedwards

cfmleditor-0.6.15.vsix

@@ -2,7 +2,7 @@
 	"name": "cfmleditor",
 	"displayName": "CFML Editor",
 	"description": "CFML Language Editor",
-	"version": "0.6.14",
+	"version": "0.6.15",
 	"preview": true,
 	"author": "cfmleditor",
 	"publisher": "cfmleditor",

dist/web/cfmlMain.js

@@ -134,8 +134,8 @@ export function activate(context: ExtensionContext): void {
 
   context.subscriptions.push(commands.registerCommand("cfml.refreshGlobalDefinitionCache", refreshGlobalDefinitionCache));
   context.subscriptions.push(commands.registerCommand("cfml.refreshWorkspaceDefinitionCache", refreshWorkspaceDefinitionCache));
-  context.subscriptions.push(commands.registerTextEditorCommand("cfml.toggleLineComment", toggleComment(CommentType.Line)));
-  context.subscriptions.push(commands.registerTextEditorCommand("cfml.toggleBlockComment", toggleComment(CommentType.Block)));
+  context.subscriptions.push(commands.registerTextEditorCommand("cfml.toggleLineComment", toggleComment(CommentType.Line, null)));
+  context.subscriptions.push(commands.registerTextEditorCommand("cfml.toggleBlockComment", toggleComment(CommentType.Block, null)));
   context.subscriptions.push(commands.registerTextEditorCommand("cfml.openActiveApplicationFile", showApplicationDocument));
   context.subscriptions.push(commands.registerTextEditorCommand("cfml.goToMatchingTag", goToMatchingTag));
   context.subscriptions.push(commands.registerTextEditorCommand("cfml.openCfDocs", CFDocsService.openCfDocsForCurrentWord));
@@ -160,13 +160,13 @@ export function activate(context: ExtensionContext): void {
       return;
     }
 
-    if (isCfcFile(document)) {
+    if (isCfcFile(document, null)) {
       const cfmlCompletionSettings: WorkspaceConfiguration = workspace.getConfiguration("cfml.suggest", document.uri);
       const replaceComments = cfmlCompletionSettings.get<boolean>("replaceComments", true);
-      cachedEntity.cacheComponentFromDocument(document, false, replaceComments);
+      cachedEntity.cacheComponentFromDocument(document, false, replaceComments, null);
     } else if (Utils.basename(Uri.parse(document.fileName)) === "Application.cfm") {
-      const documentStateContext: DocumentStateContext = getDocumentStateContext(document, false, true);
-      const thisApplicationVariables: Variable[] = await parseVariableAssignments(documentStateContext, documentStateContext.docIsScript);
+      const documentStateContext: DocumentStateContext = getDocumentStateContext(document, false, true, null);
+      const thisApplicationVariables: Variable[] = await parseVariableAssignments(documentStateContext, documentStateContext.docIsScript, null, null);
       const thisApplicationFilteredVariables: Variable[] = thisApplicationVariables.filter((variable: Variable) => {
         return [Scope.Application, Scope.Session, Scope.Request].includes(variable.scope);
       });
@@ -183,7 +183,7 @@ export function activate(context: ExtensionContext): void {
     workspace.openTextDocument(componentUri).then((document: TextDocument) => {
         const cfmlCompletionSettings: WorkspaceConfiguration = workspace.getConfiguration("cfml.suggest", document.uri);
         const replaceComments = cfmlCompletionSettings.get<boolean>("replaceComments", true);
-        cachedEntity.cacheComponentFromDocument(document, false, replaceComments);
+        cachedEntity.cacheComponentFromDocument(document, false, replaceComments, null);
     });
   });
   componentWatcher.onDidDelete((componentUri: Uri) => {
@@ -208,8 +208,8 @@ export function activate(context: ExtensionContext): void {
     }
 
     workspace.openTextDocument(applicationUri).then(async (document: TextDocument) => {
-      const documentStateContext: DocumentStateContext = getDocumentStateContext(document, false, true);
-      const thisApplicationVariables: Variable[] = await parseVariableAssignments(documentStateContext, documentStateContext.docIsScript);
+      const documentStateContext: DocumentStateContext = getDocumentStateContext(document, false, true, null);
+      const thisApplicationVariables: Variable[] = await parseVariableAssignments(documentStateContext, documentStateContext.docIsScript, null, null);
       const thisApplicationFilteredVariables: Variable[] = thisApplicationVariables.filter((variable: Variable) => {
         return [Scope.Application, Scope.Session, Scope.Request].includes(variable.scope);
       });

dist/web/cfmlMain.js.map

@@ -1,6 +1,6 @@
 import { CompletionEntry } from "../features/completionItemProvider";
 import { DocumentStateContext } from "../utils/documentUtil";
-import { TextDocument, Range } from "vscode";
+import { TextDocument, Range, CancellationToken } from "vscode";
 import { getClosingPosition, getCfScriptRanges } from "../utils/contextUtil";
 import { parseTags, Tag } from "./tag";
 
@@ -99,9 +99,10 @@ export interface CatchInfo {
  * @param documentStateContext The context information for a TextDocument in which to parse the CFScript functions
  * @param isScript Whether this document or range is defined entirely in CFScript
  * @param docRange Range within which to check
+ * @param _token
  * @returns
  */
-export function parseCatches(documentStateContext: DocumentStateContext, isScript: boolean, docRange?: Range): CatchInfo[] {
+export function parseCatches(documentStateContext: DocumentStateContext, isScript: boolean, docRange: Range, _token: CancellationToken): CatchInfo[] {
   let catchInfoArr: CatchInfo[] = [];
   const document: TextDocument = documentStateContext.document;
   let textOffset: number = 0;
@@ -120,7 +121,7 @@ export function parseCatches(documentStateContext: DocumentStateContext, isScrip
       const catchVariable = scriptCatchMatch[2];
 
       const catchBodyStartOffset = textOffset + scriptCatchMatch.index + scriptCatchMatch[0].length;
-      const catchBodyEndPosition = getClosingPosition(documentStateContext, catchBodyStartOffset, "}");
+      const catchBodyEndPosition = getClosingPosition(documentStateContext, catchBodyStartOffset, "}", _token);
 
       const catchBodyRange: Range = new Range(
         document.positionAt(catchBodyStartOffset),
@@ -137,7 +138,7 @@ export function parseCatches(documentStateContext: DocumentStateContext, isScrip
     }
   } else {
     const tagName: string = "cfcatch";
-    const tags: Tag[] = parseTags(documentStateContext, tagName, docRange);
+    const tags: Tag[] = parseTags(documentStateContext, tagName, docRange, _token);
 
     tags.forEach((tag: Tag) => {
       if (tag.bodyRange === undefined) {
@@ -165,9 +166,9 @@ export function parseCatches(documentStateContext: DocumentStateContext, isScrip
     });
 
     // Check cfscript sections
-    const cfScriptRanges: Range[] = getCfScriptRanges(document, docRange);
+    const cfScriptRanges: Range[] = getCfScriptRanges(document, docRange, _token);
     cfScriptRanges.forEach((range: Range) => {
-      const cfscriptCatches: CatchInfo[] = parseCatches(documentStateContext, true, range);
+      const cfscriptCatches: CatchInfo[] = parseCatches(documentStateContext, true, range, _token);
 
       catchInfoArr = catchInfoArr.concat(cfscriptCatches);
     });

package.json

@@ -1,5 +1,5 @@
 
-import { Position, Range, TextDocument, Uri } from "vscode";
+import { CancellationToken, Position, Range, TextDocument, Uri } from "vscode";
 import * as cachedEntities from "../features/cachedEntities";
 import { getComponent, hasComponent } from "../features/cachedEntities";
 import { MySet } from "../utils/collections";
@@ -159,23 +159,25 @@ export interface ComponentsByName {
 /**
  * Determines whether the given document is a script-based component
  * @param document The document to check
+ * @param _token
  * @returns
  */
-export function isScriptComponent(document: TextDocument): boolean {
+export function isScriptComponent(document: TextDocument, _token: CancellationToken): boolean {
   const componentTagMatch: RegExpExecArray = COMPONENT_TAG_PATTERN.exec(document.getText());
   if (componentTagMatch) {
     return false;
   }
 
-  return isCfcFile(document);
+  return isCfcFile(document, _token);
 }
 
 /**
  * Parses a component document and returns an object conforming to the Component interface
  * @param documentStateContext The context information for a TextDocument to be parsed
+ * @param _token
  * @returns
  */
-export async function parseComponent(documentStateContext: DocumentStateContext): Promise<Component | undefined> {
+export async function parseComponent(documentStateContext: DocumentStateContext, _token: CancellationToken): Promise<Component | undefined> {
   const document: TextDocument = documentStateContext.document;
   const documentText: string = document.getText();
   const componentIsScript: boolean = documentStateContext.docIsScript;
@@ -348,8 +350,8 @@ export async function parseComponent(documentStateContext: DocumentStateContext)
 
   documentStateContext.component = component;
   const componentFunctions = new ComponentFunctions();
-  let userFunctions: UserFunction[] = parseScriptFunctions(documentStateContext);
-  userFunctions = userFunctions.concat(parseTagFunctions(documentStateContext));
+  let userFunctions: UserFunction[] = parseScriptFunctions(documentStateContext, _token);
+  userFunctions = userFunctions.concat(parseTagFunctions(documentStateContext, _token));
   let earliestFunctionRangeStart: Position = document.positionAt(documentText.length);
   userFunctions.forEach((compFun: UserFunction) => {
     if (compFun.location.range.start.isBefore(earliestFunctionRangeStart)) {
@@ -382,7 +384,7 @@ export async function parseComponent(documentStateContext: DocumentStateContext)
 
   // Only check before first function definition
   const componentDefinitionRange = new Range(document.positionAt(componentMatch.index + head.length), earliestFunctionRangeStart);
-  component.variables = await parseVariableAssignments(documentStateContext, componentIsScript, componentDefinitionRange);
+  component.variables = await parseVariableAssignments(documentStateContext, componentIsScript, componentDefinitionRange, _token);
 
   // TODO: Get imports
 
@@ -537,9 +539,10 @@ export function getApplicationUri(baseUri: Uri): Uri | undefined {
 /**
  * Finds the applicable Server file for the given file URI
  * @param baseUri The URI from which the Server file will be searched
+ * @param _token
  * @returns
  */
-export function getServerUri(baseUri: Uri): Uri | undefined {
+export function getServerUri(baseUri: Uri, _token: CancellationToken): Uri | undefined {
   let componentUri: Uri;
 
   const fileName = "Server.cfc";
@@ -548,7 +551,7 @@ export function getServerUri(baseUri: Uri): Uri | undefined {
   if (rootPath) {
     const rootUri: Uri = Uri.file(rootPath);
 
-    if (hasComponent(rootUri)) {
+    if (hasComponent(rootUri, _token)) {
       componentUri = rootUri;
     }
   }
@@ -562,16 +565,17 @@ export function getServerUri(baseUri: Uri): Uri | undefined {
  * Checks whether `checkComponent` is a subcomponent or equal to `baseComponent`
  * @param checkComponent The candidate subcomponent
  * @param baseComponent The candidate base component
+ * @param _token
  * @returns
  */
-export function isSubcomponentOrEqual(checkComponent: Component, baseComponent: Component): boolean {
+export function isSubcomponentOrEqual(checkComponent: Component, baseComponent: Component, _token: CancellationToken): boolean {
   while (checkComponent) {
     if (checkComponent.uri.toString() === baseComponent.uri.toString()) {
       return true;
     }
 
     if (checkComponent.extends) {
-      checkComponent = getComponent(checkComponent.extends);
+      checkComponent = getComponent(checkComponent.extends, _token);
     } else {
       checkComponent = undefined;
     }
@@ -584,11 +588,12 @@ export function isSubcomponentOrEqual(checkComponent: Component, baseComponent:
  * Checks whether `checkComponent` is a subcomponent of `baseComponent`
  * @param checkComponent The candidate subcomponent
  * @param baseComponent The candidate base component
+ * @param _token
  * @returns
  */
-export function isSubcomponent(checkComponent: Component, baseComponent: Component): boolean {
+export function isSubcomponent(checkComponent: Component, baseComponent: Component, _token: CancellationToken): boolean {
   if (checkComponent.extends) {
-    checkComponent = getComponent(checkComponent.extends);
+    checkComponent = getComponent(checkComponent.extends, _token);
   } else {
     return false;
   }
@@ -599,7 +604,7 @@ export function isSubcomponent(checkComponent: Component, baseComponent: Compone
     }
 
     if (checkComponent.extends) {
-      checkComponent = getComponent(checkComponent.extends);
+      checkComponent = getComponent(checkComponent.extends, _token);
     } else {
       checkComponent = undefined;
     }

src/cfmlMain.ts

@@ -2,7 +2,7 @@ import { DataType } from "./dataType";
 import { Signature, constructSignatureLabelParamsPart, constructSignatureLabelParamsPrefix } from "./signature";
 import { UserFunction } from "./userFunction";
 import { DocumentStateContext } from "../utils/documentUtil";
-import { Range, TextDocument, Position } from "vscode";
+import { Range, TextDocument, Position, CancellationToken } from "vscode";
 import { getNextCharacterPosition } from "../utils/contextUtil";
 import { Utils } from "vscode-uri";
 
@@ -76,16 +76,17 @@ export function getReturnTypeString(func: Function): string {
  * @param documentStateContext The context information for the TextDocument containing function arguments
  * @param argsRange The full range for a set of arguments
  * @param separatorChar The character that separates function arguments
+ * @param _token
  * @returns
  */
-export function getScriptFunctionArgRanges(documentStateContext: DocumentStateContext, argsRange: Range, separatorChar: string = ","): Range[] {
+export function getScriptFunctionArgRanges(documentStateContext: DocumentStateContext, argsRange: Range, separatorChar: string = ",", _token: CancellationToken): Range[] {
   const argRanges: Range[] = [];
   const document: TextDocument = documentStateContext.document;
   const argsEndOffset: number = document.offsetAt(argsRange.end);
 
   let argStartPosition = argsRange.start;
   while (argStartPosition.isBeforeOrEqual(argsRange.end)) {
-    const argSeparatorPos: Position = getNextCharacterPosition(documentStateContext, document.offsetAt(argStartPosition), argsEndOffset, separatorChar, false);
+    const argSeparatorPos: Position = getNextCharacterPosition(documentStateContext, document.offsetAt(argStartPosition), argsEndOffset, separatorChar, false, _token);
     const argRange: Range = new Range(argStartPosition, argSeparatorPos);
     argRanges.push(argRange);
     argStartPosition = argSeparatorPos.translate(0, 1);

src/entities/catch.ts

@@ -1,4 +1,4 @@
-import { Position, Range, Selection, TextDocument, TextEditor, Uri, WorkspaceConfiguration, window, workspace } from "vscode";
+import { CancellationToken, Position, Range, Selection, TextDocument, TextEditor, TextEditorEdit, Uri, WorkspaceConfiguration, window, workspace } from "vscode";
 import { getGlobalTag } from "../features/cachedEntities";
 import { StringContext, isStringDelimiter } from "../utils/contextUtil";
 import { DocumentPositionStateContext, DocumentStateContext, getDocumentPositionStateContext } from "../utils/documentUtil";
@@ -596,9 +596,10 @@ export function getNonClosingCfmlTags(): string[] {
  * @param documentStateContext The context information for the TextDocument to check
  * @param tagName The name of the tag to capture
  * @param range Range within which to check
+ * @param _token
  * @returns
  */
-export function parseTags(documentStateContext: DocumentStateContext, tagName: string, range?: Range): Tag[] {
+export function parseTags(documentStateContext: DocumentStateContext, tagName: string, range: Range, _token: CancellationToken): Tag[] {
   const tags: Tag[] = [];
   const document: TextDocument = documentStateContext.document;
   let textOffset: number = 0;
@@ -653,9 +654,10 @@ export function parseTags(documentStateContext: DocumentStateContext, tagName: s
  * @param tagName The name of the tag to capture
  * @param isScript Whether this document or range is defined entirely in CFScript
  * @param range Range within which to check
+ * @param _token
  * @returns
  */
-export function parseStartTags(documentStateContext: DocumentStateContext, tagName: string, isScript: boolean, range?: Range): StartTag[] {
+export function parseStartTags(documentStateContext: DocumentStateContext, tagName: string, isScript: boolean, range: Range, _token: CancellationToken): StartTag[] {
   const startTags: StartTag[] = [];
   const document: TextDocument = documentStateContext.document;
   let textOffset: number = 0;
@@ -873,16 +875,18 @@ export function getCfTags(documentStateContext: DocumentStateContext, isScript:
 /**
  * Relocates cursor to the start of the tag matching the current selection
  * @param editor The text editor in which to find the matching tag
+ * @param edit
+ * @param _token
  */
-export async function goToMatchingTag(editor: TextEditor): Promise<void> {
+export async function goToMatchingTag(editor: TextEditor, edit: TextEditorEdit, _token: CancellationToken = null): Promise<void> {
 
   const position: Position = editor.selection.active;
   const documentUri: Uri = editor.document.uri;
 
   const cfmlCompletionSettings: WorkspaceConfiguration = workspace.getConfiguration("cfml.suggest", documentUri);
   const replaceComments = cfmlCompletionSettings.get<boolean>("replaceComments", true);
 
-  const documentPositionStateContext: DocumentPositionStateContext = getDocumentPositionStateContext(editor.document, position, false, replaceComments);
+  const documentPositionStateContext: DocumentPositionStateContext = getDocumentPositionStateContext(editor.document, position, false, replaceComments, _token);
 
   const currentWord: string = documentPositionStateContext.currentWord;
   let globalTag: GlobalTag = getGlobalTag(currentWord);