mirror of
https://github.com/microsoft/TypeScript.git
synced 2026-02-06 02:33:53 -06:00
2811 lines
131 KiB
TypeScript
2811 lines
131 KiB
TypeScript
//
|
|
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
/// <reference path="..\services\services.ts" />
|
|
/// <reference path="..\services\shims.ts" />
|
|
/// <reference path="harnessLanguageService.ts" />
|
|
/// <reference path="harness.ts" />
|
|
/// <reference path="fourslashRunner.ts" />
|
|
|
|
module FourSlash {
|
|
ts.disableIncrementalParsing = false;
|
|
|
|
// Represents a parsed source file with metadata
|
|
export interface FourSlashFile {
|
|
// The contents of the file (with markers, etc stripped out)
|
|
content: string;
|
|
fileName: string;
|
|
version: number;
|
|
// File-specific options (name/value pairs)
|
|
fileOptions: { [index: string]: string; };
|
|
}
|
|
|
|
// Represents a set of parsed source files and options
|
|
export interface FourSlashData {
|
|
// Global options (name/value pairs)
|
|
globalOptions: { [index: string]: string; };
|
|
|
|
files: FourSlashFile[];
|
|
|
|
// A mapping from marker names to name/position pairs
|
|
markerPositions: { [index: string]: Marker; };
|
|
|
|
markers: Marker[];
|
|
|
|
ranges: Range[];
|
|
}
|
|
|
|
export interface TestXmlData {
|
|
invalidReason: string;
|
|
originalName: string;
|
|
actions: string[];
|
|
}
|
|
|
|
interface MemberListData {
|
|
result: {
|
|
maybeInaccurate: boolean;
|
|
isMemberCompletion: boolean;
|
|
entries: {
|
|
name: string;
|
|
type: string;
|
|
kind: string;
|
|
kindModifiers: string;
|
|
}[];
|
|
};
|
|
}
|
|
|
|
export interface Marker {
|
|
fileName: string;
|
|
position: number;
|
|
data?: any;
|
|
}
|
|
|
|
interface MarkerMap {
|
|
[index: string]: Marker;
|
|
}
|
|
|
|
export interface Range {
|
|
fileName: string;
|
|
start: number;
|
|
end: number;
|
|
marker?: Marker;
|
|
}
|
|
|
|
interface ILocationInformation {
|
|
position: number;
|
|
sourcePosition: number;
|
|
sourceLine: number;
|
|
sourceColumn: number;
|
|
}
|
|
|
|
interface IRangeLocationInformation extends ILocationInformation {
|
|
marker?: Marker;
|
|
}
|
|
|
|
export interface TextSpan {
|
|
start: number;
|
|
end: number;
|
|
}
|
|
|
|
let entityMap: ts.Map<string> = {
|
|
"&": "&",
|
|
"\"": """,
|
|
"'": "'",
|
|
"/": "/",
|
|
"<": "<",
|
|
">": ">"
|
|
};
|
|
|
|
export function escapeXmlAttributeValue(s: string) {
|
|
return s.replace(/[&<>"'\/]/g, ch => entityMap[ch]);
|
|
}
|
|
|
|
// Name of testcase metadata including ts.CompilerOptions properties that will be used by globalOptions
|
|
// To add additional option, add property into the testOptMetadataNames, refer the property in either globalMetadataNames or fileMetadataNames
|
|
// Add cases into convertGlobalOptionsToCompilationsSettings function for the compiler to acknowledge such option from meta data
|
|
let metadataOptionNames = {
|
|
baselineFile: "BaselineFile",
|
|
declaration: "declaration",
|
|
emitThisFile: "emitThisFile", // This flag is used for testing getEmitOutput feature. It allows test-cases to indicate what file to be output in multiple files project
|
|
fileName: "Filename",
|
|
mapRoot: "mapRoot",
|
|
module: "module",
|
|
out: "out",
|
|
outDir: "outDir",
|
|
sourceMap: "sourceMap",
|
|
sourceRoot: "sourceRoot",
|
|
allowNonTsExtensions: "allowNonTsExtensions",
|
|
resolveReference: "ResolveReference", // This flag is used to specify entry file for resolve file references. The flag is only allow once per test file
|
|
};
|
|
|
|
// List of allowed metadata names
|
|
let fileMetadataNames = [metadataOptionNames.fileName, metadataOptionNames.emitThisFile, metadataOptionNames.resolveReference];
|
|
let globalMetadataNames = [metadataOptionNames.allowNonTsExtensions, metadataOptionNames.baselineFile, metadataOptionNames.declaration,
|
|
metadataOptionNames.mapRoot, metadataOptionNames.module, metadataOptionNames.out,
|
|
metadataOptionNames.outDir, metadataOptionNames.sourceMap, metadataOptionNames.sourceRoot];
|
|
|
|
function convertGlobalOptionsToCompilerOptions(globalOptions: { [idx: string]: string }): ts.CompilerOptions {
|
|
let settings: ts.CompilerOptions = { target: ts.ScriptTarget.ES5 };
|
|
// Convert all property in globalOptions into ts.CompilationSettings
|
|
for (let prop in globalOptions) {
|
|
if (globalOptions.hasOwnProperty(prop)) {
|
|
switch (prop) {
|
|
case metadataOptionNames.allowNonTsExtensions:
|
|
settings.allowNonTsExtensions = globalOptions[prop] === "true";
|
|
break;
|
|
case metadataOptionNames.declaration:
|
|
settings.declaration = globalOptions[prop] === "true";
|
|
break;
|
|
case metadataOptionNames.mapRoot:
|
|
settings.mapRoot = globalOptions[prop];
|
|
break;
|
|
case metadataOptionNames.module:
|
|
// create appropriate external module target for CompilationSettings
|
|
switch (globalOptions[prop]) {
|
|
case "AMD":
|
|
settings.module = ts.ModuleKind.AMD;
|
|
break;
|
|
case "CommonJS":
|
|
settings.module = ts.ModuleKind.CommonJS;
|
|
break;
|
|
default:
|
|
ts.Debug.assert(globalOptions[prop] === undefined || globalOptions[prop] === "None");
|
|
settings.module = ts.ModuleKind.None;
|
|
break;
|
|
}
|
|
break;
|
|
case metadataOptionNames.out:
|
|
settings.out = globalOptions[prop];
|
|
break;
|
|
case metadataOptionNames.outDir:
|
|
settings.outDir = globalOptions[prop];
|
|
break;
|
|
case metadataOptionNames.sourceMap:
|
|
settings.sourceMap = globalOptions[prop] === "true";
|
|
break;
|
|
case metadataOptionNames.sourceRoot:
|
|
settings.sourceRoot = globalOptions[prop];
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
return settings;
|
|
}
|
|
|
|
export let currentTestState: TestState = null;
|
|
function assertionMessage(msg: string) {
|
|
return "\nMarker: " + currentTestState.lastKnownMarker + "\nChecking: " + msg + "\n\n";
|
|
}
|
|
|
|
export class TestCancellationToken implements ts.HostCancellationToken {
|
|
// 0 - cancelled
|
|
// >0 - not cancelled
|
|
// <0 - not cancelled and value denotes number of isCancellationRequested after which token become cancelled
|
|
private static NotCanceled: number = -1;
|
|
private numberOfCallsBeforeCancellation: number = TestCancellationToken.NotCanceled;
|
|
|
|
public isCancellationRequested(): boolean {
|
|
if (this.numberOfCallsBeforeCancellation < 0) {
|
|
return false;
|
|
}
|
|
|
|
if (this.numberOfCallsBeforeCancellation > 0) {
|
|
this.numberOfCallsBeforeCancellation--;
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
public setCancelled(numberOfCalls: number = 0): void {
|
|
ts.Debug.assert(numberOfCalls >= 0);
|
|
this.numberOfCallsBeforeCancellation = numberOfCalls;
|
|
}
|
|
|
|
public resetCancelled(): void {
|
|
this.numberOfCallsBeforeCancellation = TestCancellationToken.NotCanceled;
|
|
}
|
|
}
|
|
|
|
export function verifyOperationIsCancelled(f: () => void) {
|
|
try {
|
|
f();
|
|
}
|
|
catch (e) {
|
|
if (e instanceof ts.OperationCanceledException) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
throw new Error("Operation should be cancelled");
|
|
}
|
|
|
|
// This function creates IScriptSnapshot object for testing getPreProcessedFileInfo
|
|
// Return object may lack some functionalities for other purposes.
|
|
function createScriptSnapShot(sourceText: string): ts.IScriptSnapshot {
|
|
return {
|
|
getText: (start: number, end: number) => {
|
|
return sourceText.substr(start, end - start);
|
|
},
|
|
getLength: () => {
|
|
return sourceText.length;
|
|
},
|
|
getChangeRange: (oldSnapshot: ts.IScriptSnapshot) => {
|
|
return <ts.TextChangeRange>undefined;
|
|
}
|
|
};
|
|
}
|
|
|
|
export class TestState {
|
|
// Language service instance
|
|
private languageServiceAdapterHost: Harness.LanguageService.LanguageServiceAdapterHost;
|
|
private languageService: ts.LanguageService;
|
|
private cancellationToken: TestCancellationToken;
|
|
|
|
// The current caret position in the active file
|
|
public currentCaretPosition = 0;
|
|
public lastKnownMarker: string = "";
|
|
|
|
// The file that's currently 'opened'
|
|
public activeFile: FourSlashFile = null;
|
|
|
|
// Whether or not we should format on keystrokes
|
|
public enableFormatting = true;
|
|
|
|
public formatCodeOptions: ts.FormatCodeOptions;
|
|
|
|
private scenarioActions: string[] = [];
|
|
private taoInvalidReason: string = null;
|
|
|
|
private inputFiles: ts.Map<string> = {}; // Map between inputFile's fileName and its content for easily looking up when resolving references
|
|
|
|
// Add input file which has matched file name with the given reference-file path.
|
|
// This is necessary when resolveReference flag is specified
|
|
private addMatchedInputFile(referenceFilePath: string) {
|
|
let inputFile = this.inputFiles[referenceFilePath];
|
|
if (inputFile && !Harness.isLibraryFile(referenceFilePath)) {
|
|
this.languageServiceAdapterHost.addScript(referenceFilePath, inputFile);
|
|
}
|
|
}
|
|
|
|
private getLanguageServiceAdapter(testType: FourSlashTestType, cancellationToken: TestCancellationToken, compilationOptions: ts.CompilerOptions): Harness.LanguageService.LanguageServiceAdapter {
|
|
switch (testType) {
|
|
case FourSlashTestType.Native:
|
|
return new Harness.LanguageService.NativeLanugageServiceAdapter(cancellationToken, compilationOptions);
|
|
case FourSlashTestType.Shims:
|
|
return new Harness.LanguageService.ShimLanugageServiceAdapter(cancellationToken, compilationOptions);
|
|
case FourSlashTestType.Server:
|
|
return new Harness.LanguageService.ServerLanugageServiceAdapter(cancellationToken, compilationOptions);
|
|
default:
|
|
throw new Error("Unknown FourSlash test type: ");
|
|
}
|
|
}
|
|
|
|
constructor(private basePath: string, private testType: FourSlashTestType, public testData: FourSlashData) {
|
|
// Create a new Services Adapter
|
|
this.cancellationToken = new TestCancellationToken();
|
|
let compilationOptions = convertGlobalOptionsToCompilerOptions(this.testData.globalOptions);
|
|
let languageServiceAdapter = this.getLanguageServiceAdapter(testType, this.cancellationToken, compilationOptions);
|
|
this.languageServiceAdapterHost = languageServiceAdapter.getHost();
|
|
this.languageService = languageServiceAdapter.getLanguageService();
|
|
|
|
// Initialize the language service with all the scripts
|
|
let startResolveFileRef: FourSlashFile;
|
|
|
|
ts.forEach(testData.files, file => {
|
|
// Create map between fileName and its content for easily looking up when resolveReference flag is specified
|
|
this.inputFiles[file.fileName] = file.content;
|
|
if (!startResolveFileRef && file.fileOptions[metadataOptionNames.resolveReference] === "true") {
|
|
startResolveFileRef = file;
|
|
} else if (startResolveFileRef) {
|
|
// If entry point for resolving file references is already specified, report duplication error
|
|
throw new Error("There exists a Fourslash file which has resolveReference flag specified; remove duplicated resolveReference flag");
|
|
}
|
|
});
|
|
|
|
if (startResolveFileRef) {
|
|
// Add the entry-point file itself into the languageServiceShimHost
|
|
this.languageServiceAdapterHost.addScript(startResolveFileRef.fileName, startResolveFileRef.content);
|
|
|
|
let resolvedResult = languageServiceAdapter.getPreProcessedFileInfo(startResolveFileRef.fileName, startResolveFileRef.content);
|
|
let referencedFiles: ts.FileReference[] = resolvedResult.referencedFiles;
|
|
let importedFiles: ts.FileReference[] = resolvedResult.importedFiles;
|
|
|
|
// Add triple reference files into language-service host
|
|
ts.forEach(referencedFiles, referenceFile => {
|
|
// Fourslash insert tests/cases/fourslash into inputFile.unitName so we will properly append the same base directory to refFile path
|
|
let referenceFilePath = this.basePath + "/" + referenceFile.fileName;
|
|
this.addMatchedInputFile(referenceFilePath);
|
|
});
|
|
|
|
// Add import files into language-service host
|
|
ts.forEach(importedFiles, importedFile => {
|
|
// Fourslash insert tests/cases/fourslash into inputFile.unitName and import statement doesn't require ".ts"
|
|
// so convert them before making appropriate comparison
|
|
let importedFilePath = this.basePath + "/" + importedFile.fileName + ".ts";
|
|
this.addMatchedInputFile(importedFilePath);
|
|
});
|
|
|
|
// Check if no-default-lib flag is false and if so add default library
|
|
if (!resolvedResult.isLibFile) {
|
|
this.languageServiceAdapterHost.addScript(Harness.Compiler.defaultLibFileName, Harness.Compiler.defaultLibSourceFile.text);
|
|
}
|
|
}
|
|
else {
|
|
// resolveReference file-option is not specified then do not resolve any files and include all inputFiles
|
|
ts.forEachKey(this.inputFiles, fileName => {
|
|
if (!Harness.isLibraryFile(fileName)) {
|
|
this.languageServiceAdapterHost.addScript(fileName, this.inputFiles[fileName]);
|
|
}
|
|
});
|
|
this.languageServiceAdapterHost.addScript(Harness.Compiler.defaultLibFileName, Harness.Compiler.defaultLibSourceFile.text);
|
|
}
|
|
|
|
this.formatCodeOptions = {
|
|
IndentSize: 4,
|
|
TabSize: 4,
|
|
NewLineCharacter: ts.sys.newLine,
|
|
ConvertTabsToSpaces: true,
|
|
InsertSpaceAfterCommaDelimiter: true,
|
|
InsertSpaceAfterSemicolonInForStatements: true,
|
|
InsertSpaceBeforeAndAfterBinaryOperators: true,
|
|
InsertSpaceAfterKeywordsInControlFlowStatements: true,
|
|
InsertSpaceAfterFunctionKeywordForAnonymousFunctions: false,
|
|
InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis: false,
|
|
PlaceOpenBraceOnNewLineForFunctions: false,
|
|
PlaceOpenBraceOnNewLineForControlBlocks: false,
|
|
};
|
|
|
|
this.testData.files.forEach(file => {
|
|
let fileName = file.fileName.replace(Harness.IO.directoryName(file.fileName), "").substr(1);
|
|
let fileNameWithoutExtension = fileName.substr(0, fileName.lastIndexOf("."));
|
|
this.scenarioActions.push("<CreateFileOnDisk FileId=\"" + fileName + "\" FileNameWithoutExtension=\"" + fileNameWithoutExtension + "\" FileExtension=\".ts\"><![CDATA[" + file.content + "]]></CreateFileOnDisk>");
|
|
});
|
|
|
|
// Open the first file by default
|
|
this.openFile(0);
|
|
}
|
|
|
|
private getFileContent(fileName: string): string {
|
|
let script = this.languageServiceAdapterHost.getScriptInfo(fileName);
|
|
return script.content;
|
|
}
|
|
|
|
// Entry points from fourslash.ts
|
|
public goToMarker(name = "") {
|
|
let marker = this.getMarkerByName(name);
|
|
if (this.activeFile.fileName !== marker.fileName) {
|
|
this.openFile(marker.fileName);
|
|
}
|
|
|
|
let content = this.getFileContent(marker.fileName);
|
|
if (marker.position === -1 || marker.position > content.length) {
|
|
throw new Error(`Marker "${name}" has been invalidated by unrecoverable edits to the file.`);
|
|
}
|
|
this.lastKnownMarker = name;
|
|
this.goToPosition(marker.position);
|
|
}
|
|
|
|
public goToPosition(pos: number) {
|
|
this.currentCaretPosition = pos;
|
|
|
|
let lineStarts = ts.computeLineStarts(this.getFileContent(this.activeFile.fileName));
|
|
let lineCharPos = ts.computeLineAndCharacterOfPosition(lineStarts, pos);
|
|
this.scenarioActions.push(`<MoveCaretToLineAndChar LineNumber=${ lineCharPos.line + 1 } CharNumber=${ lineCharPos.character + 1 } />`);
|
|
}
|
|
|
|
public moveCaretRight(count = 1) {
|
|
this.currentCaretPosition += count;
|
|
this.currentCaretPosition = Math.min(this.currentCaretPosition, this.getFileContent(this.activeFile.fileName).length);
|
|
if (count > 0) {
|
|
this.scenarioActions.push(`<MoveCaretRight NumberOfChars="${count}" />`);
|
|
} else {
|
|
this.scenarioActions.push(`<MoveCaretLeft NumberOfChars="${-count}" />`);
|
|
}
|
|
}
|
|
|
|
// Opens a file given its 0-based index or fileName
|
|
public openFile(index: number): void;
|
|
public openFile(name: string): void;
|
|
public openFile(indexOrName: any) {
|
|
let fileToOpen: FourSlashFile = this.findFile(indexOrName);
|
|
fileToOpen.fileName = ts.normalizeSlashes(fileToOpen.fileName);
|
|
this.activeFile = fileToOpen;
|
|
let fileName = fileToOpen.fileName.replace(Harness.IO.directoryName(fileToOpen.fileName), "").substr(1);
|
|
this.scenarioActions.push(`<OpenFile FileName="" SrcFileId="${fileName}" FileId="${fileName}" />`);
|
|
|
|
// Let the host know that this file is now open
|
|
this.languageServiceAdapterHost.openFile(fileToOpen.fileName);
|
|
}
|
|
|
|
public verifyErrorExistsBetweenMarkers(startMarkerName: string, endMarkerName: string, negative: boolean) {
|
|
let startMarker = this.getMarkerByName(startMarkerName);
|
|
let endMarker = this.getMarkerByName(endMarkerName);
|
|
let predicate = function (errorMinChar: number, errorLimChar: number, startPos: number, endPos: number) {
|
|
return ((errorMinChar === startPos) && (errorLimChar === endPos)) ? true : false;
|
|
};
|
|
|
|
let exists = this.anyErrorInRange(predicate, startMarker, endMarker);
|
|
|
|
this.taoInvalidReason = "verifyErrorExistsBetweenMarkers NYI";
|
|
|
|
if (exists !== negative) {
|
|
this.printErrorLog(negative, this.getAllDiagnostics());
|
|
throw new Error("Failure between markers: " + startMarkerName + ", " + endMarkerName);
|
|
}
|
|
}
|
|
|
|
private raiseError(message: string) {
|
|
message = this.messageAtLastKnownMarker(message);
|
|
throw new Error(message);
|
|
}
|
|
|
|
private messageAtLastKnownMarker(message: string) {
|
|
return "Marker: " + currentTestState.lastKnownMarker + "\n" + message;
|
|
}
|
|
|
|
private getDiagnostics(fileName: string): ts.Diagnostic[] {
|
|
let syntacticErrors = this.languageService.getSyntacticDiagnostics(fileName);
|
|
let semanticErrors = this.languageService.getSemanticDiagnostics(fileName);
|
|
|
|
let diagnostics: ts.Diagnostic[] = [];
|
|
diagnostics.push.apply(diagnostics, syntacticErrors);
|
|
diagnostics.push.apply(diagnostics, semanticErrors);
|
|
|
|
return diagnostics;
|
|
}
|
|
|
|
private getAllDiagnostics(): ts.Diagnostic[] {
|
|
let diagnostics: ts.Diagnostic[] = [];
|
|
|
|
let fileNames = this.languageServiceAdapterHost.getFilenames();
|
|
for (let i = 0, n = fileNames.length; i < n; i++) {
|
|
diagnostics.push.apply(this.getDiagnostics(fileNames[i]));
|
|
}
|
|
|
|
return diagnostics;
|
|
}
|
|
|
|
public verifyErrorExistsAfterMarker(markerName: string, negative: boolean, after: boolean) {
|
|
let marker: Marker = this.getMarkerByName(markerName);
|
|
let predicate: (errorMinChar: number, errorLimChar: number, startPos: number, endPos: number) => boolean;
|
|
|
|
if (after) {
|
|
predicate = function (errorMinChar: number, errorLimChar: number, startPos: number, endPos: number) {
|
|
return ((errorMinChar >= startPos) && (errorLimChar >= startPos)) ? true : false;
|
|
};
|
|
} else {
|
|
predicate = function (errorMinChar: number, errorLimChar: number, startPos: number, endPos: number) {
|
|
return ((errorMinChar <= startPos) && (errorLimChar <= startPos)) ? true : false;
|
|
};
|
|
}
|
|
|
|
this.taoInvalidReason = "verifyErrorExistsAfterMarker NYI";
|
|
|
|
let exists = this.anyErrorInRange(predicate, marker);
|
|
let diagnostics = this.getAllDiagnostics();
|
|
|
|
if (exists !== negative) {
|
|
this.printErrorLog(negative, diagnostics);
|
|
throw new Error("Failure at marker: " + markerName);
|
|
}
|
|
}
|
|
|
|
private anyErrorInRange(predicate: (errorMinChar: number, errorLimChar: number, startPos: number, endPos: number) => boolean, startMarker: Marker, endMarker?: Marker) {
|
|
|
|
let errors = this.getDiagnostics(startMarker.fileName);
|
|
let exists = false;
|
|
|
|
let startPos = startMarker.position;
|
|
let endPos: number = undefined;
|
|
if (endMarker !== undefined) {
|
|
endPos = endMarker.position;
|
|
}
|
|
|
|
errors.forEach(function (error: ts.Diagnostic) {
|
|
if (predicate(error.start, error.start + error.length, startPos, endPos)) {
|
|
exists = true;
|
|
}
|
|
});
|
|
|
|
return exists;
|
|
}
|
|
|
|
private printErrorLog(expectErrors: boolean, errors: ts.Diagnostic[]) {
|
|
if (expectErrors) {
|
|
Harness.IO.log("Expected error not found. Error list is:");
|
|
} else {
|
|
Harness.IO.log("Unexpected error(s) found. Error list is:");
|
|
}
|
|
|
|
errors.forEach(function (error: ts.Diagnostic) {
|
|
Harness.IO.log(" minChar: " + error.start +
|
|
", limChar: " + (error.start + error.length) +
|
|
", message: " + ts.flattenDiagnosticMessageText(error.messageText, ts.sys.newLine) + "\n");
|
|
});
|
|
}
|
|
|
|
public verifyNumberOfErrorsInCurrentFile(expected: number) {
|
|
let errors = this.getDiagnostics(this.activeFile.fileName);
|
|
let actual = errors.length;
|
|
|
|
this.scenarioActions.push(`<CheckErrorList ExpectedNumOfErrors="${expected}" />`);
|
|
|
|
if (actual !== expected) {
|
|
this.printErrorLog(false, errors);
|
|
let errorMsg = "Actual number of errors (" + actual + ") does not match expected number (" + expected + ")";
|
|
Harness.IO.log(errorMsg);
|
|
this.raiseError(errorMsg);
|
|
}
|
|
}
|
|
|
|
public verifyEval(expr: string, value: any) {
|
|
let emit = this.languageService.getEmitOutput(this.activeFile.fileName);
|
|
if (emit.outputFiles.length !== 1) {
|
|
throw new Error("Expected exactly one output from emit of " + this.activeFile.fileName);
|
|
}
|
|
|
|
this.taoInvalidReason = "verifyEval impossible";
|
|
|
|
let evaluation = new Function(`${emit.outputFiles[0].text};\r\nreturn (${expr});`)();
|
|
if (evaluation !== value) {
|
|
this.raiseError(`Expected evaluation of expression "${expr}" to equal "${value}", but got "${evaluation}"`);
|
|
}
|
|
}
|
|
|
|
public verifyGetEmitOutputForCurrentFile(expected: string): void {
|
|
let emit = this.languageService.getEmitOutput(this.activeFile.fileName);
|
|
if (emit.outputFiles.length !== 1) {
|
|
throw new Error("Expected exactly one output from emit of " + this.activeFile.fileName);
|
|
}
|
|
this.taoInvalidReason = "verifyGetEmitOutputForCurrentFile impossible";
|
|
let actual = emit.outputFiles[0].text;
|
|
if (actual !== expected) {
|
|
this.raiseError(`Expected emit output to be "${expected}", but got "${actual}"`);
|
|
}
|
|
}
|
|
|
|
public verifyMemberListContains(symbol: string, text?: string, documentation?: string, kind?: string) {
|
|
this.scenarioActions.push("<ShowCompletionList />");
|
|
this.scenarioActions.push(`<VerifyCompletionContainsItem ItemName="${symbol}"/>`);
|
|
|
|
if (text || documentation || kind) {
|
|
this.taoInvalidReason = "verifyMemberListContains only supports the \"symbol\" parameter";
|
|
}
|
|
|
|
let members = this.getMemberListAtCaret();
|
|
if (members) {
|
|
this.assertItemInCompletionList(members.entries, symbol, text, documentation, kind);
|
|
}
|
|
else {
|
|
this.raiseError("Expected a member list, but none was provided");
|
|
}
|
|
}
|
|
|
|
public verifyMemberListCount(expectedCount: number, negative: boolean) {
|
|
if (expectedCount === 0) {
|
|
if (negative) {
|
|
this.verifyMemberListIsEmpty(false);
|
|
return;
|
|
} else {
|
|
this.scenarioActions.push("<ShowCompletionList />");
|
|
}
|
|
} else {
|
|
this.scenarioActions.push("<ShowCompletionList />");
|
|
this.scenarioActions.push(`<VerifyCompletionItemsCount Count="${expectedCount}" ${(negative ? "ExpectsFailure=\"true\" " : "")}/>`);
|
|
}
|
|
|
|
let members = this.getMemberListAtCaret();
|
|
|
|
if (members) {
|
|
let match = members.entries.length === expectedCount;
|
|
|
|
if ((!match && !negative) || (match && negative)) {
|
|
this.raiseError("Member list count was " + members.entries.length + ". Expected " + expectedCount);
|
|
}
|
|
}
|
|
else if (expectedCount) {
|
|
this.raiseError("Member list count was 0. Expected " + expectedCount);
|
|
}
|
|
}
|
|
|
|
public verifyMemberListDoesNotContain(symbol: string) {
|
|
this.scenarioActions.push("<ShowCompletionList />");
|
|
this.scenarioActions.push(`<VerifyCompletionDoesNotContainItem ItemName="${escapeXmlAttributeValue(symbol)}" />`);
|
|
|
|
let members = this.getMemberListAtCaret();
|
|
if (members && members.entries.filter(e => e.name === symbol).length !== 0) {
|
|
this.raiseError(`Member list did contain ${symbol}`);
|
|
}
|
|
}
|
|
|
|
public verifyCompletionListItemsCountIsGreaterThan(count: number) {
|
|
this.taoInvalidReason = "verifyCompletionListItemsCountIsGreaterThan NYI";
|
|
|
|
let completions = this.getCompletionListAtCaret();
|
|
let itemsCount = completions.entries.length;
|
|
|
|
if (itemsCount <= count) {
|
|
this.raiseError(`Expected completion list items count to be greater than ${count}, but is actually ${itemsCount}`);
|
|
}
|
|
}
|
|
|
|
public verifyMemberListIsEmpty(negative: boolean) {
|
|
if (negative) {
|
|
this.scenarioActions.push("<ShowCompletionList />");
|
|
} else {
|
|
this.scenarioActions.push("<ShowCompletionList ExpectsFailure=\"true\" />");
|
|
}
|
|
|
|
let members = this.getMemberListAtCaret();
|
|
if ((!members || members.entries.length === 0) && negative) {
|
|
this.raiseError("Member list is empty at Caret");
|
|
} else if ((members && members.entries.length !== 0) && !negative) {
|
|
|
|
let errorMsg = "\n" + "Member List contains: [" + members.entries[0].name;
|
|
for (let i = 1; i < members.entries.length; i++) {
|
|
errorMsg += ", " + members.entries[i].name;
|
|
}
|
|
errorMsg += "]\n";
|
|
|
|
this.raiseError("Member list is not empty at Caret: " + errorMsg);
|
|
|
|
}
|
|
}
|
|
|
|
public verifyCompletionListIsEmpty(negative: boolean) {
|
|
this.scenarioActions.push("<ShowCompletionList ExpectsFailure=\"true\" />");
|
|
|
|
let completions = this.getCompletionListAtCaret();
|
|
if ((!completions || completions.entries.length === 0) && negative) {
|
|
this.raiseError("Completion list is empty at caret at position " + this.activeFile.fileName + " " + this.currentCaretPosition);
|
|
}
|
|
else if (completions && completions.entries.length !== 0 && !negative) {
|
|
let errorMsg = "\n" + "Completion List contains: [" + completions.entries[0].name;
|
|
for (let i = 1; i < completions.entries.length; i++) {
|
|
errorMsg += ", " + completions.entries[i].name;
|
|
}
|
|
errorMsg += "]\n";
|
|
|
|
this.raiseError("Completion list is not empty at caret at position " + this.activeFile.fileName + " " + this.currentCaretPosition + errorMsg);
|
|
}
|
|
}
|
|
|
|
|
|
public verifyCompletionListAllowsNewIdentifier(negative: boolean) {
|
|
let completions = this.getCompletionListAtCaret();
|
|
|
|
if ((completions && !completions.isNewIdentifierLocation) && !negative) {
|
|
this.raiseError("Expected builder completion entry");
|
|
} else if ((completions && completions.isNewIdentifierLocation) && negative) {
|
|
this.raiseError("Un-expected builder completion entry");
|
|
}
|
|
}
|
|
|
|
public verifyCompletionListContains(symbol: string, text?: string, documentation?: string, kind?: string) {
|
|
let completions = this.getCompletionListAtCaret();
|
|
if (completions) {
|
|
this.assertItemInCompletionList(completions.entries, symbol, text, documentation, kind);
|
|
}
|
|
else {
|
|
this.raiseError(`No completions at position '${ this.currentCaretPosition }' when looking for '${ symbol }'.`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Verify that the completion list does NOT contain the given symbol.
|
|
* The symbol is considered matched with the symbol in the list if and only if all given parameters must matched.
|
|
* When any parameter is omitted, the parameter is ignored during comparison and assumed that the parameter with
|
|
* that property of the symbol in the list.
|
|
* @param symbol the name of symbol
|
|
* @param expectedText the text associated with the symbol
|
|
* @param expectedDocumentation the documentation text associated with the symbol
|
|
* @param expectedKind the kind of symbol (see ScriptElementKind)
|
|
*/
|
|
public verifyCompletionListDoesNotContain(symbol: string, expectedText?: string, expectedDocumentation?: string, expectedKind?: string) {
|
|
let that = this;
|
|
function filterByTextOrDocumentation(entry: ts.CompletionEntry) {
|
|
let details = that.getCompletionEntryDetails(entry.name);
|
|
let documentation = ts.displayPartsToString(details.documentation);
|
|
let text = ts.displayPartsToString(details.displayParts);
|
|
if (expectedText && expectedDocumentation) {
|
|
return (documentation === expectedDocumentation && text === expectedText) ? true : false;
|
|
}
|
|
else if (expectedText && !expectedDocumentation) {
|
|
return text === expectedText ? true : false;
|
|
}
|
|
else if (expectedDocumentation && !expectedText) {
|
|
return documentation === expectedDocumentation ? true : false;
|
|
}
|
|
// Because expectedText and expectedDocumentation are undefined, we assume that
|
|
// users don"t care to compare them so we will treat that entry as if the entry has matching text and documentation
|
|
// and keep it in the list of filtered entry.
|
|
return true;
|
|
}
|
|
this.scenarioActions.push("<ShowCompletionList />");
|
|
this.scenarioActions.push(`<VerifyCompletionDoesNotContainItem ItemName="${escapeXmlAttributeValue(symbol)}" />`);
|
|
|
|
let completions = this.getCompletionListAtCaret();
|
|
if (completions) {
|
|
let filterCompletions = completions.entries.filter(e => e.name === symbol);
|
|
filterCompletions = expectedKind ? filterCompletions.filter(e => e.kind === expectedKind) : filterCompletions;
|
|
filterCompletions = filterCompletions.filter(filterByTextOrDocumentation);
|
|
if (filterCompletions.length !== 0) {
|
|
// After filtered using all present criterion, if there are still symbol left in the list
|
|
// then these symbols must meet the criterion for Not supposed to be in the list. So we
|
|
// raise an error
|
|
let error = "Completion list did contain \'" + symbol + "\'.";
|
|
let details = this.getCompletionEntryDetails(filterCompletions[0].name);
|
|
if (expectedText) {
|
|
error += "Expected text: " + expectedText + " to equal: " + ts.displayPartsToString(details.displayParts) + ".";
|
|
}
|
|
if (expectedDocumentation) {
|
|
error += "Expected documentation: " + expectedDocumentation + " to equal: " + ts.displayPartsToString(details.documentation) + ".";
|
|
}
|
|
if (expectedKind) {
|
|
error += "Expected kind: " + expectedKind + " to equal: " + filterCompletions[0].kind + ".";
|
|
}
|
|
this.raiseError(error);
|
|
}
|
|
}
|
|
}
|
|
|
|
public verifyCompletionEntryDetails(entryName: string, expectedText: string, expectedDocumentation?: string, kind?: string) {
|
|
this.taoInvalidReason = "verifyCompletionEntryDetails NYI";
|
|
|
|
let details = this.getCompletionEntryDetails(entryName);
|
|
|
|
assert.equal(ts.displayPartsToString(details.displayParts), expectedText, assertionMessage("completion entry details text"));
|
|
|
|
if (expectedDocumentation !== undefined) {
|
|
assert.equal(ts.displayPartsToString(details.documentation), expectedDocumentation, assertionMessage("completion entry documentation"));
|
|
}
|
|
|
|
if (kind !== undefined) {
|
|
assert.equal(details.kind, kind, assertionMessage("completion entry kind"));
|
|
}
|
|
}
|
|
|
|
public verifyReferencesAtPositionListContains(fileName: string, start: number, end: number, isWriteAccess?: boolean) {
|
|
this.taoInvalidReason = "verifyReferencesAtPositionListContains NYI";
|
|
|
|
let references = this.getReferencesAtCaret();
|
|
|
|
if (!references || references.length === 0) {
|
|
this.raiseError("verifyReferencesAtPositionListContains failed - found 0 references, expected at least one.");
|
|
}
|
|
|
|
for (let i = 0; i < references.length; i++) {
|
|
let reference = references[i];
|
|
if (reference && reference.fileName === fileName && reference.textSpan.start === start && ts.textSpanEnd(reference.textSpan) === end) {
|
|
if (typeof isWriteAccess !== "undefined" && reference.isWriteAccess !== isWriteAccess) {
|
|
this.raiseError(`verifyReferencesAtPositionListContains failed - item isWriteAccess value does not match, actual: ${reference.isWriteAccess}, expected: ${isWriteAccess}.`);
|
|
}
|
|
return;
|
|
}
|
|
}
|
|
|
|
let missingItem = { fileName: fileName, start: start, end: end, isWriteAccess: isWriteAccess };
|
|
this.raiseError(`verifyReferencesAtPositionListContains failed - could not find the item: ${JSON.stringify(missingItem)} in the returned list: (${JSON.stringify(references)})`);
|
|
}
|
|
|
|
public verifyReferencesCountIs(count: number, localFilesOnly: boolean = true) {
|
|
this.taoInvalidReason = "verifyReferences NYI";
|
|
|
|
let references = this.getReferencesAtCaret();
|
|
let referencesCount = 0;
|
|
|
|
if (localFilesOnly) {
|
|
let localFiles = this.testData.files.map<string>(file => file.fileName);
|
|
// Count only the references in local files. Filter the ones in lib and other files.
|
|
ts.forEach(references, entry => {
|
|
if (localFiles.some((fileName) => fileName === entry.fileName)) {
|
|
++referencesCount;
|
|
}
|
|
});
|
|
}
|
|
else {
|
|
referencesCount = references && references.length || 0;
|
|
}
|
|
|
|
if (referencesCount !== count) {
|
|
let condition = localFilesOnly ? "excluding libs" : "including libs";
|
|
this.raiseError("Expected references count (" + condition + ") to be " + count + ", but is actually " + referencesCount);
|
|
}
|
|
}
|
|
|
|
private getMemberListAtCaret() {
|
|
return this.languageService.getCompletionsAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
}
|
|
|
|
private getCompletionListAtCaret() {
|
|
return this.languageService.getCompletionsAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
}
|
|
|
|
private getCompletionEntryDetails(entryName: string) {
|
|
return this.languageService.getCompletionEntryDetails(this.activeFile.fileName, this.currentCaretPosition, entryName);
|
|
}
|
|
|
|
private getReferencesAtCaret() {
|
|
return this.languageService.getReferencesAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
}
|
|
|
|
private assertionMessage(name: string, actualValue: any, expectedValue: any) {
|
|
return "\nActual " + name + ":\n\t" + actualValue + "\nExpected value:\n\t" + expectedValue;
|
|
}
|
|
|
|
public getSyntacticDiagnostics(expected: string) {
|
|
let diagnostics = this.languageService.getSyntacticDiagnostics(this.activeFile.fileName);
|
|
this.testDiagnostics(expected, diagnostics);
|
|
}
|
|
|
|
public getSemanticDiagnostics(expected: string) {
|
|
let diagnostics = this.languageService.getSemanticDiagnostics(this.activeFile.fileName);
|
|
this.testDiagnostics(expected, diagnostics);
|
|
}
|
|
|
|
private testDiagnostics(expected: string, diagnostics: ts.Diagnostic[]) {
|
|
let realized = ts.realizeDiagnostics(diagnostics, "\r\n");
|
|
let actual = JSON.stringify(realized, null, " ");
|
|
assert.equal(actual, expected);
|
|
}
|
|
|
|
public verifyQuickInfoString(negative: boolean, expectedText?: string, expectedDocumentation?: string) {
|
|
[expectedText, expectedDocumentation].forEach(str => {
|
|
if (str) {
|
|
this.scenarioActions.push("<ShowQuickInfo />");
|
|
this.scenarioActions.push(`<VerifyQuickInfoTextContains IgnoreSpacing="true" Text="${escapeXmlAttributeValue(str)}" ${(negative ? "ExpectsFailure=\"true\" " : "")} />`);
|
|
}
|
|
});
|
|
|
|
let actualQuickInfo = this.languageService.getQuickInfoAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
let actualQuickInfoText = actualQuickInfo ? ts.displayPartsToString(actualQuickInfo.displayParts) : "";
|
|
let actualQuickInfoDocumentation = actualQuickInfo ? ts.displayPartsToString(actualQuickInfo.documentation) : "";
|
|
|
|
if (negative) {
|
|
if (expectedText !== undefined) {
|
|
assert.notEqual(actualQuickInfoText, expectedText, this.messageAtLastKnownMarker("quick info text"));
|
|
}
|
|
// TODO: should be '==='?
|
|
if (expectedDocumentation != undefined) {
|
|
assert.notEqual(actualQuickInfoDocumentation, expectedDocumentation, this.messageAtLastKnownMarker("quick info doc comment"));
|
|
}
|
|
} else {
|
|
if (expectedText !== undefined) {
|
|
assert.equal(actualQuickInfoText, expectedText, this.messageAtLastKnownMarker("quick info text"));
|
|
}
|
|
// TODO: should be '==='?
|
|
if (expectedDocumentation != undefined) {
|
|
assert.equal(actualQuickInfoDocumentation, expectedDocumentation, assertionMessage("quick info doc"));
|
|
}
|
|
}
|
|
}
|
|
|
|
public verifyQuickInfoDisplayParts(kind: string, kindModifiers: string, textSpan: { start: number; length: number; },
|
|
displayParts: ts.SymbolDisplayPart[],
|
|
documentation: ts.SymbolDisplayPart[]) {
|
|
this.scenarioActions.push("<ShowQuickInfo />");
|
|
this.scenarioActions.push(`<Verify return values of quickInfo="${JSON.stringify(displayParts)}"/>`);
|
|
|
|
function getDisplayPartsJson(displayParts: ts.SymbolDisplayPart[]) {
|
|
let result = "";
|
|
ts.forEach(displayParts, part => {
|
|
if (result) {
|
|
result += ",\n ";
|
|
}
|
|
else {
|
|
result = "[\n ";
|
|
}
|
|
result += JSON.stringify(part);
|
|
});
|
|
if (result) {
|
|
result += "\n]";
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
let actualQuickInfo = this.languageService.getQuickInfoAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
assert.equal(actualQuickInfo.kind, kind, this.messageAtLastKnownMarker("QuickInfo kind"));
|
|
assert.equal(actualQuickInfo.kindModifiers, kindModifiers, this.messageAtLastKnownMarker("QuickInfo kindModifiers"));
|
|
assert.equal(JSON.stringify(actualQuickInfo.textSpan), JSON.stringify(textSpan), this.messageAtLastKnownMarker("QuickInfo textSpan"));
|
|
assert.equal(getDisplayPartsJson(actualQuickInfo.displayParts), getDisplayPartsJson(displayParts), this.messageAtLastKnownMarker("QuickInfo displayParts"));
|
|
assert.equal(getDisplayPartsJson(actualQuickInfo.documentation), getDisplayPartsJson(documentation), this.messageAtLastKnownMarker("QuickInfo documentation"));
|
|
}
|
|
|
|
public verifyRenameLocations(findInStrings: boolean, findInComments: boolean) {
|
|
let renameInfo = this.languageService.getRenameInfo(this.activeFile.fileName, this.currentCaretPosition);
|
|
if (renameInfo.canRename) {
|
|
let references = this.languageService.findRenameLocations(
|
|
this.activeFile.fileName, this.currentCaretPosition, findInStrings, findInComments);
|
|
|
|
let ranges = this.getRanges();
|
|
|
|
if (!references) {
|
|
if (ranges.length !== 0) {
|
|
this.raiseError(`Expected ${ranges.length} rename locations; got none.`);
|
|
}
|
|
return;
|
|
}
|
|
|
|
if (ranges.length !== references.length) {
|
|
this.raiseError("Rename location count does not match result.\n\nExpected: " + JSON.stringify(ranges) + "\n\nActual:" + JSON.stringify(references));
|
|
}
|
|
|
|
ranges = ranges.sort((r1, r2) => r1.start - r2.start);
|
|
references = references.sort((r1, r2) => r1.textSpan.start - r2.textSpan.start);
|
|
|
|
for (let i = 0, n = ranges.length; i < n; i++) {
|
|
let reference = references[i];
|
|
let range = ranges[i];
|
|
|
|
if (reference.textSpan.start !== range.start ||
|
|
ts.textSpanEnd(reference.textSpan) !== range.end) {
|
|
|
|
this.raiseError("Rename location results do not match.\n\nExpected: " + JSON.stringify(ranges) + "\n\nActual:" + JSON.stringify(references));
|
|
}
|
|
}
|
|
}
|
|
else {
|
|
this.raiseError("Expected rename to succeed, but it actually failed.");
|
|
}
|
|
}
|
|
|
|
public verifyQuickInfoExists(negative: boolean) {
|
|
this.taoInvalidReason = "verifyQuickInfoExists NYI";
|
|
|
|
let actualQuickInfo = this.languageService.getQuickInfoAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
if (negative) {
|
|
if (actualQuickInfo) {
|
|
this.raiseError("verifyQuickInfoExists failed. Expected quick info NOT to exist");
|
|
}
|
|
}
|
|
else {
|
|
if (!actualQuickInfo) {
|
|
this.raiseError("verifyQuickInfoExists failed. Expected quick info to exist");
|
|
}
|
|
}
|
|
}
|
|
|
|
public verifyCurrentSignatureHelpIs(expected: string) {
|
|
this.taoInvalidReason = "verifyCurrentSignatureHelpIs NYI";
|
|
|
|
let help = this.getActiveSignatureHelpItem();
|
|
assert.equal(
|
|
ts.displayPartsToString(help.prefixDisplayParts) +
|
|
help.parameters.map(p => ts.displayPartsToString(p.displayParts)).join(ts.displayPartsToString(help.separatorDisplayParts)) +
|
|
ts.displayPartsToString(help.suffixDisplayParts), expected);
|
|
}
|
|
|
|
public verifyCurrentParameterIsletiable(isVariable: boolean) {
|
|
this.taoInvalidReason = "verifyCurrentParameterIsletiable NYI";
|
|
|
|
let signature = this.getActiveSignatureHelpItem();
|
|
assert.isNotNull(signature);
|
|
assert.equal(isVariable, signature.isVariadic);
|
|
}
|
|
|
|
public verifyCurrentParameterHelpName(name: string) {
|
|
this.taoInvalidReason = "verifyCurrentParameterHelpName NYI";
|
|
|
|
let activeParameter = this.getActiveParameter();
|
|
let activeParameterName = activeParameter.name;
|
|
assert.equal(activeParameterName, name);
|
|
}
|
|
|
|
public verifyCurrentParameterSpanIs(parameter: string) {
|
|
this.taoInvalidReason = "verifyCurrentParameterSpanIs NYI";
|
|
|
|
let activeSignature = this.getActiveSignatureHelpItem();
|
|
let activeParameter = this.getActiveParameter();
|
|
assert.equal(ts.displayPartsToString(activeParameter.displayParts), parameter);
|
|
}
|
|
|
|
public verifyCurrentParameterHelpDocComment(docComment: string) {
|
|
this.taoInvalidReason = "verifyCurrentParameterHelpDocComment NYI";
|
|
|
|
let activeParameter = this.getActiveParameter();
|
|
let activeParameterDocComment = activeParameter.documentation;
|
|
assert.equal(ts.displayPartsToString(activeParameterDocComment), docComment, assertionMessage("current parameter Help DocComment"));
|
|
}
|
|
|
|
public verifyCurrentSignatureHelpParameterCount(expectedCount: number) {
|
|
this.taoInvalidReason = "verifyCurrentSignatureHelpParameterCount NYI";
|
|
|
|
assert.equal(this.getActiveSignatureHelpItem().parameters.length, expectedCount);
|
|
}
|
|
|
|
public verifyCurrentSignatureHelpTypeParameterCount(expectedCount: number) {
|
|
this.taoInvalidReason = "verifyCurrentSignatureHelpTypeParameterCount NYI";
|
|
|
|
// assert.equal(this.getActiveSignatureHelpItem().typeParameters.length, expectedCount);
|
|
}
|
|
|
|
public verifyCurrentSignatureHelpDocComment(docComment: string) {
|
|
this.taoInvalidReason = "verifyCurrentSignatureHelpDocComment NYI";
|
|
|
|
let actualDocComment = this.getActiveSignatureHelpItem().documentation;
|
|
assert.equal(ts.displayPartsToString(actualDocComment), docComment, assertionMessage("current signature help doc comment"));
|
|
}
|
|
|
|
public verifySignatureHelpCount(expected: number) {
|
|
this.scenarioActions.push("<InvokeSignatureHelp />");
|
|
this.scenarioActions.push(`<VerifySignatureHelpOverloadCountEquals Count="${expected}" />`);
|
|
|
|
let help = this.languageService.getSignatureHelpItems(this.activeFile.fileName, this.currentCaretPosition);
|
|
let actual = help && help.items ? help.items.length : 0;
|
|
assert.equal(actual, expected);
|
|
}
|
|
|
|
public verifySignatureHelpArgumentCount(expected: number) {
|
|
this.taoInvalidReason = "verifySignatureHelpArgumentCount NYI";
|
|
let signatureHelpItems = this.languageService.getSignatureHelpItems(this.activeFile.fileName, this.currentCaretPosition);
|
|
let actual = signatureHelpItems.argumentCount;
|
|
assert.equal(actual, expected);
|
|
}
|
|
|
|
public verifySignatureHelpPresent(shouldBePresent = true) {
|
|
this.taoInvalidReason = "verifySignatureHelpPresent NYI";
|
|
|
|
let actual = this.languageService.getSignatureHelpItems(this.activeFile.fileName, this.currentCaretPosition);
|
|
if (shouldBePresent) {
|
|
if (!actual) {
|
|
this.raiseError("Expected signature help to be present, but it wasn't");
|
|
}
|
|
} else {
|
|
if (actual) {
|
|
this.raiseError(`Expected no signature help, but got "${JSON.stringify(actual)}"`);
|
|
}
|
|
}
|
|
}
|
|
|
|
private validate(name: string, expected: string, actual: string) {
|
|
if (expected && expected !== actual) {
|
|
this.raiseError("Expected " + name + " '" + expected + "'. Got '" + actual + "' instead.");
|
|
}
|
|
}
|
|
|
|
public verifyRenameInfoSucceeded(displayName?: string, fullDisplayName?: string, kind?: string, kindModifiers?: string) {
|
|
let renameInfo = this.languageService.getRenameInfo(this.activeFile.fileName, this.currentCaretPosition);
|
|
if (!renameInfo.canRename) {
|
|
this.raiseError("Rename did not succeed");
|
|
}
|
|
|
|
this.validate("displayName", displayName, renameInfo.displayName);
|
|
this.validate("fullDisplayName", fullDisplayName, renameInfo.fullDisplayName);
|
|
this.validate("kind", kind, renameInfo.kind);
|
|
this.validate("kindModifiers", kindModifiers, renameInfo.kindModifiers);
|
|
|
|
if (this.getRanges().length !== 1) {
|
|
this.raiseError("Expected a single range to be selected in the test file.");
|
|
}
|
|
|
|
let expectedRange = this.getRanges()[0];
|
|
if (renameInfo.triggerSpan.start !== expectedRange.start ||
|
|
ts.textSpanEnd(renameInfo.triggerSpan) !== expectedRange.end) {
|
|
this.raiseError("Expected triggerSpan [" + expectedRange.start + "," + expectedRange.end + "). Got [" +
|
|
renameInfo.triggerSpan.start + "," + ts.textSpanEnd(renameInfo.triggerSpan) + ") instead.");
|
|
}
|
|
}
|
|
|
|
public verifyRenameInfoFailed(message?: string) {
|
|
let renameInfo = this.languageService.getRenameInfo(this.activeFile.fileName, this.currentCaretPosition);
|
|
if (renameInfo.canRename) {
|
|
this.raiseError("Rename was expected to fail");
|
|
}
|
|
|
|
this.validate("error", message, renameInfo.localizedErrorMessage);
|
|
}
|
|
|
|
private getActiveSignatureHelpItem() {
|
|
let help = this.languageService.getSignatureHelpItems(this.activeFile.fileName, this.currentCaretPosition);
|
|
let index = help.selectedItemIndex;
|
|
return help.items[index];
|
|
}
|
|
|
|
private getActiveParameter(): ts.SignatureHelpParameter {
|
|
let help = this.languageService.getSignatureHelpItems(this.activeFile.fileName, this.currentCaretPosition);
|
|
let item = help.items[help.selectedItemIndex];
|
|
let currentParam = help.argumentIndex;
|
|
return item.parameters[currentParam];
|
|
}
|
|
|
|
private alignmentForExtraInfo = 50;
|
|
|
|
private spanInfoToString(pos: number, spanInfo: ts.TextSpan, prefixString: string) {
|
|
let resultString = "SpanInfo: " + JSON.stringify(spanInfo);
|
|
if (spanInfo) {
|
|
let spanString = this.activeFile.content.substr(spanInfo.start, spanInfo.length);
|
|
let spanLineMap = ts.computeLineStarts(spanString);
|
|
for (let i = 0; i < spanLineMap.length; i++) {
|
|
if (!i) {
|
|
resultString += "\n";
|
|
}
|
|
resultString += prefixString + spanString.substring(spanLineMap[i], spanLineMap[i + 1]);
|
|
}
|
|
resultString += "\n" + prefixString + ":=> (" + this.getLineColStringAtPosition(spanInfo.start) + ") to (" + this.getLineColStringAtPosition(ts.textSpanEnd(spanInfo)) + ")";
|
|
}
|
|
|
|
return resultString;
|
|
}
|
|
|
|
private baselineCurrentFileLocations(getSpanAtPos: (pos: number) => ts.TextSpan): string {
|
|
let fileLineMap = ts.computeLineStarts(this.activeFile.content);
|
|
let nextLine = 0;
|
|
let resultString = "";
|
|
let currentLine: string;
|
|
let previousSpanInfo: string;
|
|
let startColumn: number;
|
|
let length: number;
|
|
let prefixString = " >";
|
|
|
|
let pos = 0;
|
|
let addSpanInfoString = () => {
|
|
if (previousSpanInfo) {
|
|
resultString += currentLine;
|
|
let thisLineMarker = repeatString(startColumn, " ") + repeatString(length, "~");
|
|
thisLineMarker += repeatString(this.alignmentForExtraInfo - thisLineMarker.length - prefixString.length + 1, " ");
|
|
resultString += thisLineMarker;
|
|
resultString += "=> Pos: (" + (pos - length) + " to " + (pos - 1) + ") ";
|
|
resultString += " " + previousSpanInfo;
|
|
previousSpanInfo = undefined;
|
|
}
|
|
};
|
|
|
|
for (; pos < this.activeFile.content.length; pos++) {
|
|
if (pos === 0 || pos === fileLineMap[nextLine]) {
|
|
nextLine++;
|
|
addSpanInfoString();
|
|
if (resultString.length) {
|
|
resultString += "\n--------------------------------";
|
|
}
|
|
currentLine = "\n" + nextLine.toString() + repeatString(3 - nextLine.toString().length, " ") + ">" + this.activeFile.content.substring(pos, fileLineMap[nextLine]) + "\n ";
|
|
startColumn = 0;
|
|
length = 0;
|
|
}
|
|
let spanInfo = this.spanInfoToString(pos, getSpanAtPos(pos), prefixString);
|
|
if (previousSpanInfo && previousSpanInfo !== spanInfo) {
|
|
addSpanInfoString();
|
|
previousSpanInfo = spanInfo;
|
|
startColumn = startColumn + length;
|
|
length = 1;
|
|
}
|
|
else {
|
|
previousSpanInfo = spanInfo;
|
|
length++;
|
|
}
|
|
}
|
|
addSpanInfoString();
|
|
return resultString;
|
|
|
|
function repeatString(count: number, char: string) {
|
|
let result = "";
|
|
for (let i = 0; i < count; i++) {
|
|
result += char;
|
|
}
|
|
return result;
|
|
}
|
|
}
|
|
|
|
public getBreakpointStatementLocation(pos: number) {
|
|
this.taoInvalidReason = "getBreakpointStatementLocation NYI";
|
|
return this.languageService.getBreakpointStatementAtPosition(this.activeFile.fileName, pos);
|
|
}
|
|
|
|
public baselineCurrentFileBreakpointLocations() {
|
|
this.taoInvalidReason = "baselineCurrentFileBreakpointLocations impossible";
|
|
|
|
Harness.Baseline.runBaseline(
|
|
"Breakpoint Locations for " + this.activeFile.fileName,
|
|
this.testData.globalOptions[metadataOptionNames.baselineFile],
|
|
() => {
|
|
return this.baselineCurrentFileLocations(pos => this.getBreakpointStatementLocation(pos));
|
|
},
|
|
true /* run immediately */);
|
|
}
|
|
|
|
public baselineGetEmitOutput() {
|
|
this.taoInvalidReason = "baselineGetEmitOutput impossible";
|
|
// Find file to be emitted
|
|
let emitFiles: FourSlashFile[] = []; // List of FourSlashFile that has emitThisFile flag on
|
|
|
|
let allFourSlashFiles = this.testData.files;
|
|
for (let idx = 0; idx < allFourSlashFiles.length; ++idx) {
|
|
let file = allFourSlashFiles[idx];
|
|
if (file.fileOptions[metadataOptionNames.emitThisFile] === "true") {
|
|
// Find a file with the flag emitThisFile turned on
|
|
emitFiles.push(file);
|
|
}
|
|
}
|
|
|
|
// If there is not emiThisFile flag specified in the test file, throw an error
|
|
if (emitFiles.length === 0) {
|
|
this.raiseError("No emitThisFile is specified in the test file");
|
|
}
|
|
|
|
Harness.Baseline.runBaseline(
|
|
"Generate getEmitOutput baseline : " + emitFiles.join(" "),
|
|
this.testData.globalOptions[metadataOptionNames.baselineFile],
|
|
() => {
|
|
let resultString = "";
|
|
// Loop through all the emittedFiles and emit them one by one
|
|
emitFiles.forEach(emitFile => {
|
|
let emitOutput = this.languageService.getEmitOutput(emitFile.fileName);
|
|
// Print emitOutputStatus in readable format
|
|
resultString += "EmitSkipped: " + emitOutput.emitSkipped + ts.sys.newLine;
|
|
|
|
if (emitOutput.emitSkipped) {
|
|
resultString += "Diagnostics:" + ts.sys.newLine;
|
|
let diagnostics = ts.getPreEmitDiagnostics(this.languageService.getProgram());
|
|
for (let i = 0, n = diagnostics.length; i < n; i++) {
|
|
resultString += " " + diagnostics[0].messageText + ts.sys.newLine;
|
|
}
|
|
}
|
|
|
|
emitOutput.outputFiles.forEach((outputFile, idx, array) => {
|
|
let fileName = "FileName : " + outputFile.name + ts.sys.newLine;
|
|
resultString = resultString + fileName + outputFile.text;
|
|
});
|
|
resultString += ts.sys.newLine;
|
|
});
|
|
|
|
return resultString;
|
|
},
|
|
true /* run immediately */);
|
|
}
|
|
|
|
public printBreakpointLocation(pos: number) {
|
|
Harness.IO.log("\n**Pos: " + pos + " " + this.spanInfoToString(pos, this.getBreakpointStatementLocation(pos), " "));
|
|
}
|
|
|
|
public printBreakpointAtCurrentLocation() {
|
|
this.printBreakpointLocation(this.currentCaretPosition);
|
|
}
|
|
|
|
public printCurrentParameterHelp() {
|
|
let help = this.languageService.getSignatureHelpItems(this.activeFile.fileName, this.currentCaretPosition);
|
|
Harness.IO.log(JSON.stringify(help));
|
|
}
|
|
|
|
public printCurrentQuickInfo() {
|
|
let quickInfo = this.languageService.getQuickInfoAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
Harness.IO.log(JSON.stringify(quickInfo));
|
|
}
|
|
|
|
public printErrorList() {
|
|
let syntacticErrors = this.languageService.getSyntacticDiagnostics(this.activeFile.fileName);
|
|
let semanticErrors = this.languageService.getSemanticDiagnostics(this.activeFile.fileName);
|
|
let errorList = syntacticErrors.concat(semanticErrors);
|
|
Harness.IO.log(`Error list (${errorList.length} errors)`);
|
|
|
|
if (errorList.length) {
|
|
errorList.forEach(err => {
|
|
Harness.IO.log(
|
|
"start: " + err.start +
|
|
", length: " + err.length +
|
|
", message: " + ts.flattenDiagnosticMessageText(err.messageText, ts.sys.newLine));
|
|
});
|
|
}
|
|
}
|
|
|
|
public printCurrentFileState(makeWhitespaceVisible = false, makeCaretVisible = true) {
|
|
for (let i = 0; i < this.testData.files.length; i++) {
|
|
let file = this.testData.files[i];
|
|
let active = (this.activeFile === file);
|
|
Harness.IO.log(`=== Script (${file.fileName}) ${(active ? "(active, cursor at |)" : "")} ===`);
|
|
let content = this.getFileContent(file.fileName);
|
|
if (active) {
|
|
content = content.substr(0, this.currentCaretPosition) + (makeCaretVisible ? "|" : "") + content.substr(this.currentCaretPosition);
|
|
}
|
|
if (makeWhitespaceVisible) {
|
|
content = TestState.makeWhitespaceVisible(content);
|
|
}
|
|
Harness.IO.log(content);
|
|
}
|
|
}
|
|
|
|
public printCurrentSignatureHelp() {
|
|
let sigHelp = this.getActiveSignatureHelpItem();
|
|
Harness.IO.log(JSON.stringify(sigHelp));
|
|
}
|
|
|
|
public printMemberListMembers() {
|
|
let members = this.getMemberListAtCaret();
|
|
Harness.IO.log(JSON.stringify(members));
|
|
}
|
|
|
|
public printCompletionListMembers() {
|
|
let completions = this.getCompletionListAtCaret();
|
|
Harness.IO.log(JSON.stringify(completions));
|
|
}
|
|
|
|
public printReferences() {
|
|
let references = this.getReferencesAtCaret();
|
|
ts.forEach(references, entry => {
|
|
Harness.IO.log(JSON.stringify(entry));
|
|
});
|
|
}
|
|
|
|
public printContext() {
|
|
ts.forEach(this.languageServiceAdapterHost.getFilenames(), Harness.IO.log);
|
|
}
|
|
|
|
public deleteChar(count = 1) {
|
|
this.scenarioActions.push(`<DeleteCharNext Count="${count}" />`);
|
|
|
|
let offset = this.currentCaretPosition;
|
|
let ch = "";
|
|
|
|
let checkCadence = (count >> 2) + 1;
|
|
|
|
for (let i = 0; i < count; i++) {
|
|
// Make the edit
|
|
this.languageServiceAdapterHost.editScript(this.activeFile.fileName, offset, offset + 1, ch);
|
|
this.updateMarkersForEdit(this.activeFile.fileName, offset, offset + 1, ch);
|
|
|
|
if (i % checkCadence === 0) {
|
|
this.checkPostEditInletiants();
|
|
}
|
|
|
|
// Handle post-keystroke formatting
|
|
if (this.enableFormatting) {
|
|
let edits = this.languageService.getFormattingEditsAfterKeystroke(this.activeFile.fileName, offset, ch, this.formatCodeOptions);
|
|
if (edits.length) {
|
|
offset += this.applyEdits(this.activeFile.fileName, edits, true);
|
|
// this.checkPostEditInletiants();
|
|
}
|
|
}
|
|
}
|
|
|
|
// Move the caret to wherever we ended up
|
|
this.currentCaretPosition = offset;
|
|
|
|
this.fixCaretPosition();
|
|
this.checkPostEditInletiants();
|
|
}
|
|
|
|
public replace(start: number, length: number, text: string) {
|
|
this.taoInvalidReason = "replace NYI";
|
|
|
|
this.languageServiceAdapterHost.editScript(this.activeFile.fileName, start, start + length, text);
|
|
this.updateMarkersForEdit(this.activeFile.fileName, start, start + length, text);
|
|
this.checkPostEditInletiants();
|
|
}
|
|
|
|
public deleteCharBehindMarker(count = 1) {
|
|
this.scenarioActions.push(`<DeleteCharPrevious Count="${count}" />`);
|
|
|
|
let offset = this.currentCaretPosition;
|
|
let ch = "";
|
|
let checkCadence = (count >> 2) + 1;
|
|
|
|
for (let i = 0; i < count; i++) {
|
|
offset--;
|
|
// Make the edit
|
|
this.languageServiceAdapterHost.editScript(this.activeFile.fileName, offset, offset + 1, ch);
|
|
this.updateMarkersForEdit(this.activeFile.fileName, offset, offset + 1, ch);
|
|
|
|
if (i % checkCadence === 0) {
|
|
this.checkPostEditInletiants();
|
|
}
|
|
|
|
// Handle post-keystroke formatting
|
|
if (this.enableFormatting) {
|
|
let edits = this.languageService.getFormattingEditsAfterKeystroke(this.activeFile.fileName, offset, ch, this.formatCodeOptions);
|
|
if (edits.length) {
|
|
offset += this.applyEdits(this.activeFile.fileName, edits, true);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Move the caret to wherever we ended up
|
|
this.currentCaretPosition = offset;
|
|
|
|
this.fixCaretPosition();
|
|
this.checkPostEditInletiants();
|
|
}
|
|
|
|
// Enters lines of text at the current caret position
|
|
public type(text: string) {
|
|
if (text === "") {
|
|
this.taoInvalidReason = "Test used empty-insert workaround.";
|
|
} else {
|
|
this.scenarioActions.push(`<InsertText><![CDATA[${text}]]></InsertText>`);
|
|
}
|
|
|
|
return this.typeHighFidelity(text);
|
|
}
|
|
|
|
// Enters lines of text at the current caret position, invoking
|
|
// language service APIs to mimic Visual Studio's behavior
|
|
// as much as possible
|
|
private typeHighFidelity(text: string) {
|
|
let offset = this.currentCaretPosition;
|
|
let prevChar = " ";
|
|
let checkCadence = (text.length >> 2) + 1;
|
|
|
|
for (let i = 0; i < text.length; i++) {
|
|
// Make the edit
|
|
let ch = text.charAt(i);
|
|
this.languageServiceAdapterHost.editScript(this.activeFile.fileName, offset, offset, ch);
|
|
this.languageService.getBraceMatchingAtPosition(this.activeFile.fileName, offset);
|
|
|
|
this.updateMarkersForEdit(this.activeFile.fileName, offset, offset, ch);
|
|
offset++;
|
|
|
|
if (ch === "(" || ch === ",") {
|
|
/* Signature help*/
|
|
this.languageService.getSignatureHelpItems(this.activeFile.fileName, offset);
|
|
} else if (prevChar === " " && /A-Za-z_/.test(ch)) {
|
|
/* Completions */
|
|
this.languageService.getCompletionsAtPosition(this.activeFile.fileName, offset);
|
|
}
|
|
|
|
if (i % checkCadence === 0) {
|
|
this.checkPostEditInletiants();
|
|
// this.languageService.getSyntacticDiagnostics(this.activeFile.fileName);
|
|
// this.languageService.getSemanticDiagnostics(this.activeFile.fileName);
|
|
}
|
|
|
|
// Handle post-keystroke formatting
|
|
if (this.enableFormatting) {
|
|
let edits = this.languageService.getFormattingEditsAfterKeystroke(this.activeFile.fileName, offset, ch, this.formatCodeOptions);
|
|
if (edits.length) {
|
|
offset += this.applyEdits(this.activeFile.fileName, edits, true);
|
|
// this.checkPostEditInletiants();
|
|
}
|
|
}
|
|
}
|
|
|
|
// Move the caret to wherever we ended up
|
|
this.currentCaretPosition = offset;
|
|
|
|
this.fixCaretPosition();
|
|
this.checkPostEditInletiants();
|
|
}
|
|
|
|
// Enters text as if the user had pasted it
|
|
public paste(text: string) {
|
|
this.scenarioActions.push(`<InsertText><![CDATA[${text}]]></InsertText>`);
|
|
|
|
let start = this.currentCaretPosition;
|
|
let offset = this.currentCaretPosition;
|
|
this.languageServiceAdapterHost.editScript(this.activeFile.fileName, offset, offset, text);
|
|
this.updateMarkersForEdit(this.activeFile.fileName, offset, offset, text);
|
|
this.checkPostEditInletiants();
|
|
offset += text.length;
|
|
|
|
// Handle formatting
|
|
if (this.enableFormatting) {
|
|
let edits = this.languageService.getFormattingEditsForRange(this.activeFile.fileName, start, offset, this.formatCodeOptions);
|
|
if (edits.length) {
|
|
offset += this.applyEdits(this.activeFile.fileName, edits, true);
|
|
this.checkPostEditInletiants();
|
|
}
|
|
}
|
|
|
|
// Move the caret to wherever we ended up
|
|
this.currentCaretPosition = offset;
|
|
this.fixCaretPosition();
|
|
|
|
this.checkPostEditInletiants();
|
|
}
|
|
|
|
private checkPostEditInletiants() {
|
|
if (this.testType !== FourSlashTestType.Native) {
|
|
// getSourcefile() results can not be serialized. Only perform these verifications
|
|
// if running against a native LS object.
|
|
return;
|
|
}
|
|
|
|
let incrementalSourceFile = this.languageService.getSourceFile(this.activeFile.fileName);
|
|
Utils.assertInvariants(incrementalSourceFile, /*parent:*/ undefined);
|
|
|
|
let incrementalSyntaxDiagnostics = incrementalSourceFile.parseDiagnostics;
|
|
|
|
// Check syntactic structure
|
|
let content = this.getFileContent(this.activeFile.fileName);
|
|
|
|
let referenceSourceFile = ts.createLanguageServiceSourceFile(
|
|
this.activeFile.fileName, createScriptSnapShot(content), ts.ScriptTarget.Latest, /*version:*/ "0", /*setNodeParents:*/ false);
|
|
let referenceSyntaxDiagnostics = referenceSourceFile.parseDiagnostics;
|
|
|
|
Utils.assertDiagnosticsEquals(incrementalSyntaxDiagnostics, referenceSyntaxDiagnostics);
|
|
Utils.assertStructuralEquals(incrementalSourceFile, referenceSourceFile);
|
|
}
|
|
|
|
private fixCaretPosition() {
|
|
// The caret can potentially end up between the \r and \n, which is confusing. If
|
|
// that happens, move it back one character
|
|
if (this.currentCaretPosition > 0) {
|
|
let ch = this.getFileContent(this.activeFile.fileName).substring(this.currentCaretPosition - 1, this.currentCaretPosition);
|
|
if (ch === "\r") {
|
|
this.currentCaretPosition--;
|
|
}
|
|
};
|
|
}
|
|
|
|
private applyEdits(fileName: string, edits: ts.TextChange[], isFormattingEdit = false): number {
|
|
// We get back a set of edits, but langSvc.editScript only accepts one at a time. Use this to keep track
|
|
// of the incremental offset from each edit to the next. Assumption is that these edit ranges don't overlap
|
|
let runningOffset = 0;
|
|
edits = edits.sort((a, b) => a.span.start - b.span.start);
|
|
// Get a snapshot of the content of the file so we can make sure any formatting edits didn't destroy non-whitespace characters
|
|
let oldContent = this.getFileContent(this.activeFile.fileName);
|
|
for (let j = 0; j < edits.length; j++) {
|
|
this.languageServiceAdapterHost.editScript(fileName, edits[j].span.start + runningOffset, ts.textSpanEnd(edits[j].span) + runningOffset, edits[j].newText);
|
|
this.updateMarkersForEdit(fileName, edits[j].span.start + runningOffset, ts.textSpanEnd(edits[j].span) + runningOffset, edits[j].newText);
|
|
let change = (edits[j].span.start - ts.textSpanEnd(edits[j].span)) + edits[j].newText.length;
|
|
runningOffset += change;
|
|
// TODO: Consider doing this at least some of the time for higher fidelity. Currently causes a failure (bug 707150)
|
|
// this.languageService.getScriptLexicalStructure(fileName);
|
|
}
|
|
|
|
if (isFormattingEdit) {
|
|
let newContent = this.getFileContent(fileName);
|
|
|
|
if (newContent.replace(/\s/g, "") !== oldContent.replace(/\s/g, "")) {
|
|
this.raiseError("Formatting operation destroyed non-whitespace content");
|
|
}
|
|
}
|
|
return runningOffset;
|
|
}
|
|
|
|
public copyFormatOptions(): ts.FormatCodeOptions {
|
|
return ts.clone(this.formatCodeOptions);
|
|
}
|
|
|
|
public setFormatOptions(formatCodeOptions: ts.FormatCodeOptions): ts.FormatCodeOptions {
|
|
let oldFormatCodeOptions = this.formatCodeOptions;
|
|
this.formatCodeOptions = formatCodeOptions;
|
|
return oldFormatCodeOptions;
|
|
}
|
|
|
|
public formatDocument() {
|
|
this.scenarioActions.push("<FormatDocument />");
|
|
|
|
let edits = this.languageService.getFormattingEditsForDocument(this.activeFile.fileName, this.formatCodeOptions);
|
|
this.currentCaretPosition += this.applyEdits(this.activeFile.fileName, edits, true);
|
|
this.fixCaretPosition();
|
|
}
|
|
|
|
public formatSelection(start: number, end: number) {
|
|
this.taoInvalidReason = "formatSelection NYI";
|
|
|
|
let edits = this.languageService.getFormattingEditsForRange(this.activeFile.fileName, start, end, this.formatCodeOptions);
|
|
this.currentCaretPosition += this.applyEdits(this.activeFile.fileName, edits, true);
|
|
this.fixCaretPosition();
|
|
}
|
|
|
|
private updateMarkersForEdit(fileName: string, minChar: number, limChar: number, text: string) {
|
|
for (let i = 0; i < this.testData.markers.length; i++) {
|
|
let marker = this.testData.markers[i];
|
|
if (marker.fileName === fileName) {
|
|
if (marker.position > minChar) {
|
|
if (marker.position < limChar) {
|
|
// Marker is inside the edit - mark it as invalidated (?)
|
|
marker.position = -1;
|
|
} else {
|
|
// Move marker back/forward by the appropriate amount
|
|
marker.position += (minChar - limChar) + text.length;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public goToBOF() {
|
|
this.goToPosition(0);
|
|
}
|
|
|
|
public goToEOF() {
|
|
let len = this.getFileContent(this.activeFile.fileName).length;
|
|
this.goToPosition(len);
|
|
}
|
|
|
|
public goToDefinition(definitionIndex: number) {
|
|
if (definitionIndex === 0) {
|
|
this.scenarioActions.push("<GoToDefinition />");
|
|
} else {
|
|
this.taoInvalidReason = "GoToDefinition not supported for non-zero definition indices";
|
|
}
|
|
|
|
let definitions = this.languageService.getDefinitionAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
if (!definitions || !definitions.length) {
|
|
this.raiseError("goToDefinition failed - expected to at least one definition location but got 0");
|
|
}
|
|
|
|
if (definitionIndex >= definitions.length) {
|
|
this.raiseError(`goToDefinition failed - definitionIndex value (${definitionIndex}) exceeds definition list size (${definitions.length})`);
|
|
}
|
|
|
|
let definition = definitions[definitionIndex];
|
|
this.openFile(definition.fileName);
|
|
this.currentCaretPosition = definition.textSpan.start;
|
|
}
|
|
|
|
public goToTypeDefinition(definitionIndex: number) {
|
|
if (definitionIndex === 0) {
|
|
this.scenarioActions.push("<GoToTypeDefinition />");
|
|
}
|
|
else {
|
|
this.taoInvalidReason = "GoToTypeDefinition not supported for non-zero definition indices";
|
|
}
|
|
|
|
let definitions = this.languageService.getTypeDefinitionAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
if (!definitions || !definitions.length) {
|
|
this.raiseError("goToTypeDefinition failed - expected to at least one definition location but got 0");
|
|
}
|
|
|
|
if (definitionIndex >= definitions.length) {
|
|
this.raiseError(`goToTypeDefinition failed - definitionIndex value (${definitionIndex}) exceeds definition list size (${definitions.length})`);
|
|
}
|
|
|
|
let definition = definitions[definitionIndex];
|
|
this.openFile(definition.fileName);
|
|
this.currentCaretPosition = definition.textSpan.start;
|
|
}
|
|
|
|
public verifyDefinitionLocationExists(negative: boolean) {
|
|
this.taoInvalidReason = "verifyDefinitionLocationExists NYI";
|
|
|
|
let definitions = this.languageService.getDefinitionAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
|
|
let foundDefinitions = definitions && definitions.length;
|
|
|
|
if (foundDefinitions && negative) {
|
|
this.raiseError(`goToDefinition - expected to 0 definition locations but got ${definitions.length}`);
|
|
}
|
|
else if (!foundDefinitions && !negative) {
|
|
this.raiseError("goToDefinition - expected to at least one definition location but got 0");
|
|
}
|
|
}
|
|
|
|
public verifyDefinitionsCount(negative: boolean, expectedCount: number) {
|
|
let assertFn = negative ? assert.notEqual : assert.equal;
|
|
|
|
let definitions = this.languageService.getDefinitionAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
let actualCount = definitions && definitions.length || 0;
|
|
|
|
assertFn(actualCount, expectedCount, this.messageAtLastKnownMarker("Definitions Count"));
|
|
}
|
|
|
|
public verifyTypeDefinitionsCount(negative: boolean, expectedCount: number) {
|
|
let assertFn = negative ? assert.notEqual : assert.equal;
|
|
|
|
let definitions = this.languageService.getTypeDefinitionAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
let actualCount = definitions && definitions.length || 0;
|
|
|
|
assertFn(actualCount, expectedCount, this.messageAtLastKnownMarker("Type definitions Count"));
|
|
}
|
|
|
|
public verifyDefinitionsName(negative: boolean, expectedName: string, expectedContainerName: string) {
|
|
this.taoInvalidReason = "verifyDefinititionsInfo NYI";
|
|
|
|
let definitions = this.languageService.getDefinitionAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
let actualDefinitionName = definitions && definitions.length ? definitions[0].name : "";
|
|
let actualDefinitionContainerName = definitions && definitions.length ? definitions[0].containerName : "";
|
|
if (negative) {
|
|
assert.notEqual(actualDefinitionName, expectedName, this.messageAtLastKnownMarker("Definition Info Name"));
|
|
assert.notEqual(actualDefinitionContainerName, expectedContainerName, this.messageAtLastKnownMarker("Definition Info Container Name"));
|
|
} else {
|
|
assert.equal(actualDefinitionName, expectedName, this.messageAtLastKnownMarker("Definition Info Name"));
|
|
assert.equal(actualDefinitionContainerName, expectedContainerName, this.messageAtLastKnownMarker("Definition Info Container Name"));
|
|
}
|
|
}
|
|
|
|
public getMarkers(): Marker[] {
|
|
// Return a copy of the list
|
|
return this.testData.markers.slice(0);
|
|
}
|
|
|
|
public getRanges(): Range[] {
|
|
// Return a copy of the list
|
|
return this.testData.ranges.slice(0);
|
|
}
|
|
|
|
public verifyCaretAtMarker(markerName = "") {
|
|
this.taoInvalidReason = "verifyCaretAtMarker NYI";
|
|
|
|
let pos = this.getMarkerByName(markerName);
|
|
if (pos.fileName !== this.activeFile.fileName) {
|
|
throw new Error(`verifyCaretAtMarker failed - expected to be in file "${pos.fileName}", but was in file "${this.activeFile.fileName}"`);
|
|
}
|
|
if (pos.position !== this.currentCaretPosition) {
|
|
throw new Error(`verifyCaretAtMarker failed - expected to be at marker "/*${markerName}*/, but was at position ${this.currentCaretPosition}(${this.getLineColStringAtPosition(this.currentCaretPosition)})`);
|
|
}
|
|
}
|
|
|
|
private getIndentation(fileName: string, position: number): number {
|
|
return this.languageService.getIndentationAtPosition(fileName, position, this.formatCodeOptions);
|
|
}
|
|
|
|
public verifyIndentationAtCurrentPosition(numberOfSpaces: number) {
|
|
this.taoInvalidReason = "verifyIndentationAtCurrentPosition NYI";
|
|
|
|
let actual = this.getIndentation(this.activeFile.fileName, this.currentCaretPosition);
|
|
let lineCol = this.getLineColStringAtPosition(this.currentCaretPosition);
|
|
if (actual !== numberOfSpaces) {
|
|
this.raiseError(`verifyIndentationAtCurrentPosition failed at ${lineCol} - expected: ${numberOfSpaces}, actual: ${actual}`);
|
|
}
|
|
}
|
|
|
|
public verifyIndentationAtPosition(fileName: string, position: number, numberOfSpaces: number) {
|
|
this.taoInvalidReason = "verifyIndentationAtPosition NYI";
|
|
|
|
let actual = this.getIndentation(fileName, position);
|
|
let lineCol = this.getLineColStringAtPosition(position);
|
|
if (actual !== numberOfSpaces) {
|
|
this.raiseError(`verifyIndentationAtPosition failed at ${lineCol} - expected: ${numberOfSpaces}, actual: ${actual}`);
|
|
}
|
|
}
|
|
|
|
public verifyCurrentLineContent(text: string) {
|
|
this.taoInvalidReason = "verifyCurrentLineContent NYI";
|
|
|
|
let actual = this.getCurrentLineContent();
|
|
if (actual !== text) {
|
|
throw new Error("verifyCurrentLineContent\n" +
|
|
"\tExpected: \"" + text + "\"\n" +
|
|
"\t Actual: \"" + actual + "\"");
|
|
}
|
|
}
|
|
|
|
public verifyCurrentFileContent(text: string) {
|
|
this.taoInvalidReason = "verifyCurrentFileContent NYI";
|
|
|
|
let actual = this.getFileContent(this.activeFile.fileName);
|
|
let replaceNewlines = (str: string) => str.replace(/\r\n/g, "\n");
|
|
if (replaceNewlines(actual) !== replaceNewlines(text)) {
|
|
throw new Error("verifyCurrentFileContent\n" +
|
|
"\tExpected: \"" + text + "\"\n" +
|
|
"\t Actual: \"" + actual + "\"");
|
|
}
|
|
}
|
|
|
|
public verifyTextAtCaretIs(text: string) {
|
|
this.taoInvalidReason = "verifyCurrentFileContent NYI";
|
|
|
|
let actual = this.getFileContent(this.activeFile.fileName).substring(this.currentCaretPosition, this.currentCaretPosition + text.length);
|
|
if (actual !== text) {
|
|
throw new Error("verifyTextAtCaretIs\n" +
|
|
"\tExpected: \"" + text + "\"\n" +
|
|
"\t Actual: \"" + actual + "\"");
|
|
}
|
|
}
|
|
|
|
public verifyCurrentNameOrDottedNameSpanText(text: string) {
|
|
this.taoInvalidReason = "verifyCurrentNameOrDottedNameSpanText NYI";
|
|
|
|
let span = this.languageService.getNameOrDottedNameSpan(this.activeFile.fileName, this.currentCaretPosition, this.currentCaretPosition);
|
|
if (!span) {
|
|
this.raiseError("verifyCurrentNameOrDottedNameSpanText\n" +
|
|
"\tExpected: \"" + text + "\"\n" +
|
|
"\t Actual: undefined");
|
|
}
|
|
|
|
let actual = this.getFileContent(this.activeFile.fileName).substring(span.start, ts.textSpanEnd(span));
|
|
if (actual !== text) {
|
|
this.raiseError("verifyCurrentNameOrDottedNameSpanText\n" +
|
|
"\tExpected: \"" + text + "\"\n" +
|
|
"\t Actual: \"" + actual + "\"");
|
|
}
|
|
}
|
|
|
|
private getNameOrDottedNameSpan(pos: number) {
|
|
this.taoInvalidReason = "getNameOrDottedNameSpan NYI";
|
|
return this.languageService.getNameOrDottedNameSpan(this.activeFile.fileName, pos, pos);
|
|
}
|
|
|
|
public baselineCurrentFileNameOrDottedNameSpans() {
|
|
this.taoInvalidReason = "baselineCurrentFileNameOrDottedNameSpans impossible";
|
|
|
|
Harness.Baseline.runBaseline(
|
|
"Name OrDottedNameSpans for " + this.activeFile.fileName,
|
|
this.testData.globalOptions[metadataOptionNames.baselineFile],
|
|
() => {
|
|
return this.baselineCurrentFileLocations(pos =>
|
|
this.getNameOrDottedNameSpan(pos));
|
|
},
|
|
true /* run immediately */);
|
|
}
|
|
|
|
public printNameOrDottedNameSpans(pos: number) {
|
|
Harness.IO.log(this.spanInfoToString(pos, this.getNameOrDottedNameSpan(pos), "**"));
|
|
}
|
|
|
|
private verifyClassifications(expected: { classificationType: string; text: string; textSpan?: TextSpan }[], actual: ts.ClassifiedSpan[]) {
|
|
if (actual.length !== expected.length) {
|
|
this.raiseError("verifyClassifications failed - expected total classifications to be " + expected.length +
|
|
", but was " + actual.length +
|
|
jsonMismatchString());
|
|
}
|
|
|
|
for (let i = 0; i < expected.length; i++) {
|
|
let expectedClassification = expected[i];
|
|
let actualClassification = actual[i];
|
|
|
|
let expectedType: string = (<any>ts.ClassificationTypeNames)[expectedClassification.classificationType];
|
|
if (expectedType !== actualClassification.classificationType) {
|
|
this.raiseError("verifyClassifications failed - expected classifications type to be " +
|
|
expectedType + ", but was " +
|
|
actualClassification.classificationType +
|
|
jsonMismatchString());
|
|
}
|
|
|
|
let expectedSpan = expectedClassification.textSpan;
|
|
let actualSpan = actualClassification.textSpan;
|
|
|
|
if (expectedSpan) {
|
|
let expectedLength = expectedSpan.end - expectedSpan.start;
|
|
|
|
if (expectedSpan.start !== actualSpan.start || expectedLength !== actualSpan.length) {
|
|
this.raiseError("verifyClassifications failed - expected span of text to be " +
|
|
"{start=" + expectedSpan.start + ", length=" + expectedLength + "}, but was " +
|
|
"{start=" + actualSpan.start + ", length=" + actualSpan.length + "}" +
|
|
jsonMismatchString());
|
|
}
|
|
}
|
|
|
|
let actualText = this.activeFile.content.substr(actualSpan.start, actualSpan.length);
|
|
if (expectedClassification.text !== actualText) {
|
|
this.raiseError("verifyClassifications failed - expected classified text to be " +
|
|
expectedClassification.text + ", but was " +
|
|
actualText +
|
|
jsonMismatchString());
|
|
}
|
|
}
|
|
|
|
function jsonMismatchString() {
|
|
return ts.sys.newLine +
|
|
"expected: '" + ts.sys.newLine + JSON.stringify(expected, (k, v) => v, 2) + "'" + ts.sys.newLine +
|
|
"actual: '" + ts.sys.newLine + JSON.stringify(actual, (k, v) => v, 2) + "'";
|
|
}
|
|
}
|
|
|
|
public verifyProjectInfo(expected: string[]) {
|
|
if (this.testType === FourSlashTestType.Server) {
|
|
let actual = (<ts.server.SessionClient>this.languageService).getProjectInfo(
|
|
this.activeFile.fileName,
|
|
/* needFileNameList */ true
|
|
);
|
|
assert.equal(
|
|
expected.join(","),
|
|
actual.fileNameList.map( file => {
|
|
return file.replace(this.basePath + "/", "");
|
|
}).join(",")
|
|
);
|
|
}
|
|
}
|
|
|
|
public verifySemanticClassifications(expected: { classificationType: string; text: string }[]) {
|
|
let actual = this.languageService.getSemanticClassifications(this.activeFile.fileName,
|
|
ts.createTextSpan(0, this.activeFile.content.length));
|
|
|
|
this.verifyClassifications(expected, actual);
|
|
}
|
|
|
|
public verifySyntacticClassifications(expected: { classificationType: string; text: string }[]) {
|
|
let actual = this.languageService.getSyntacticClassifications(this.activeFile.fileName,
|
|
ts.createTextSpan(0, this.activeFile.content.length));
|
|
|
|
this.verifyClassifications(expected, actual);
|
|
}
|
|
|
|
public verifyOutliningSpans(spans: TextSpan[]) {
|
|
this.taoInvalidReason = "verifyOutliningSpans NYI";
|
|
|
|
let actual = this.languageService.getOutliningSpans(this.activeFile.fileName);
|
|
|
|
if (actual.length !== spans.length) {
|
|
this.raiseError(`verifyOutliningSpans failed - expected total spans to be ${spans.length}, but was ${actual.length}`);
|
|
}
|
|
|
|
for (let i = 0; i < spans.length; i++) {
|
|
let expectedSpan = spans[i];
|
|
let actualSpan = actual[i];
|
|
if (expectedSpan.start !== actualSpan.textSpan.start || expectedSpan.end !== ts.textSpanEnd(actualSpan.textSpan)) {
|
|
this.raiseError(`verifyOutliningSpans failed - span ${(i + 1)} expected: (${expectedSpan.start},${expectedSpan.end}), actual: (${actualSpan.textSpan.start},${ts.textSpanEnd(actualSpan.textSpan)})`);
|
|
}
|
|
}
|
|
}
|
|
|
|
public verifyTodoComments(descriptors: string[], spans: TextSpan[]) {
|
|
let actual = this.languageService.getTodoComments(this.activeFile.fileName,
|
|
descriptors.map(d => { return { text: d, priority: 0 }; }));
|
|
|
|
if (actual.length !== spans.length) {
|
|
this.raiseError(`verifyTodoComments failed - expected total spans to be ${spans.length}, but was ${actual.length}`);
|
|
}
|
|
|
|
for (let i = 0; i < spans.length; i++) {
|
|
let expectedSpan = spans[i];
|
|
let actualComment = actual[i];
|
|
let actualCommentSpan = ts.createTextSpan(actualComment.position, actualComment.message.length);
|
|
|
|
if (expectedSpan.start !== actualCommentSpan.start || expectedSpan.end !== ts.textSpanEnd(actualCommentSpan)) {
|
|
this.raiseError(`verifyOutliningSpans failed - span ${(i + 1)} expected: (${expectedSpan.start},${expectedSpan.end}), actual: (${actualCommentSpan.start},${ts.textSpanEnd(actualCommentSpan)})`);
|
|
}
|
|
}
|
|
}
|
|
|
|
public verifyMatchingBracePosition(bracePosition: number, expectedMatchPosition: number) {
|
|
this.taoInvalidReason = "verifyMatchingBracePosition NYI";
|
|
|
|
let actual = this.languageService.getBraceMatchingAtPosition(this.activeFile.fileName, bracePosition);
|
|
|
|
if (actual.length !== 2) {
|
|
this.raiseError(`verifyMatchingBracePosition failed - expected result to contain 2 spans, but it had ${actual.length}`);
|
|
}
|
|
|
|
let actualMatchPosition = -1;
|
|
if (bracePosition === actual[0].start) {
|
|
actualMatchPosition = actual[1].start;
|
|
} else if (bracePosition === actual[1].start) {
|
|
actualMatchPosition = actual[0].start;
|
|
} else {
|
|
this.raiseError(`verifyMatchingBracePosition failed - could not find the brace position: ${bracePosition} in the returned list: (${actual[0].start},${ts.textSpanEnd(actual[0])}) and (${actual[1].start},${ts.textSpanEnd(actual[1])})`);
|
|
}
|
|
|
|
if (actualMatchPosition !== expectedMatchPosition) {
|
|
this.raiseError(`verifyMatchingBracePosition failed - expected: ${actualMatchPosition}, actual: ${expectedMatchPosition}`);
|
|
}
|
|
}
|
|
|
|
public verifyNoMatchingBracePosition(bracePosition: number) {
|
|
this.taoInvalidReason = "verifyNoMatchingBracePosition NYI";
|
|
|
|
let actual = this.languageService.getBraceMatchingAtPosition(this.activeFile.fileName, bracePosition);
|
|
|
|
if (actual.length !== 0) {
|
|
this.raiseError("verifyNoMatchingBracePosition failed - expected: 0 spans, actual: " + actual.length);
|
|
}
|
|
}
|
|
|
|
/*
|
|
Check number of navigationItems which match both searchValue and matchKind.
|
|
Report an error if expected value and actual value do not match.
|
|
*/
|
|
public verifyNavigationItemsCount(expected: number, searchValue: string, matchKind?: string) {
|
|
this.taoInvalidReason = "verifyNavigationItemsCount NYI";
|
|
|
|
let items = this.languageService.getNavigateToItems(searchValue);
|
|
let actual = 0;
|
|
let item: ts.NavigateToItem = null;
|
|
|
|
// Count only the match that match the same MatchKind
|
|
for (let i = 0; i < items.length; ++i) {
|
|
item = items[i];
|
|
if (!matchKind || item.matchKind === matchKind) {
|
|
actual++;
|
|
}
|
|
}
|
|
|
|
if (expected !== actual) {
|
|
this.raiseError(`verifyNavigationItemsCount failed - found: ${actual} navigation items, expected: ${expected}.`);
|
|
}
|
|
}
|
|
|
|
/*
|
|
Verify that returned navigationItems from getNavigateToItems have matched searchValue, matchKind, and kind.
|
|
Report an error if getNavigateToItems does not find any matched searchValue.
|
|
*/
|
|
public verifyNavigationItemsListContains(
|
|
name: string,
|
|
kind: string,
|
|
searchValue: string,
|
|
matchKind: string,
|
|
fileName?: string,
|
|
parentName?: string) {
|
|
this.taoInvalidReason = "verifyNavigationItemsListContains NYI";
|
|
|
|
let items = this.languageService.getNavigateToItems(searchValue);
|
|
|
|
if (!items || items.length === 0) {
|
|
this.raiseError("verifyNavigationItemsListContains failed - found 0 navigation items, expected at least one.");
|
|
}
|
|
|
|
for (let i = 0; i < items.length; i++) {
|
|
let item = items[i];
|
|
if (item && item.name === name && item.kind === kind &&
|
|
(matchKind === undefined || item.matchKind === matchKind) &&
|
|
(fileName === undefined || item.fileName === fileName) &&
|
|
(parentName === undefined || item.containerName === parentName)) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
// if there was an explicit match kind specified, then it should be validated.
|
|
if (matchKind !== undefined) {
|
|
let missingItem = { name: name, kind: kind, searchValue: searchValue, matchKind: matchKind, fileName: fileName, parentName: parentName };
|
|
this.raiseError(`verifyNavigationItemsListContains failed - could not find the item: ${JSON.stringify(missingItem)} in the returned list: (${JSON.stringify(items)})`);
|
|
}
|
|
}
|
|
|
|
public verifyGetScriptLexicalStructureListCount(expected: number) {
|
|
this.taoInvalidReason = "verifyNavigationItemsListContains impossible";
|
|
|
|
let items = this.languageService.getNavigationBarItems(this.activeFile.fileName);
|
|
let actual = this.getNavigationBarItemsCount(items);
|
|
|
|
if (expected !== actual) {
|
|
this.raiseError(`verifyGetScriptLexicalStructureListCount failed - found: ${actual} navigation items, expected: ${expected}.`);
|
|
}
|
|
}
|
|
|
|
private getNavigationBarItemsCount(items: ts.NavigationBarItem[]) {
|
|
let result = 0;
|
|
if (items) {
|
|
for (let i = 0, n = items.length; i < n; i++) {
|
|
result++;
|
|
result += this.getNavigationBarItemsCount(items[i].childItems);
|
|
}
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
public verifyGetScriptLexicalStructureListContains(name: string, kind: string) {
|
|
this.taoInvalidReason = "verifyGetScriptLexicalStructureListContains impossible";
|
|
|
|
let items = this.languageService.getNavigationBarItems(this.activeFile.fileName);
|
|
|
|
if (!items || items.length === 0) {
|
|
this.raiseError("verifyGetScriptLexicalStructureListContains failed - found 0 navigation items, expected at least one.");
|
|
}
|
|
|
|
if (this.navigationBarItemsContains(items, name, kind)) {
|
|
return;
|
|
}
|
|
|
|
let missingItem = { name: name, kind: kind };
|
|
this.raiseError(`verifyGetScriptLexicalStructureListContains failed - could not find the item: ${JSON.stringify(missingItem)} in the returned list: (${JSON.stringify(items, null, " ")})`);
|
|
}
|
|
|
|
private navigationBarItemsContains(items: ts.NavigationBarItem[], name: string, kind: string) {
|
|
if (items) {
|
|
for (let i = 0; i < items.length; i++) {
|
|
let item = items[i];
|
|
if (item && item.text === name && item.kind === kind) {
|
|
return true;
|
|
}
|
|
|
|
if (this.navigationBarItemsContains(item.childItems, name, kind)) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
public printNavigationItems(searchValue: string) {
|
|
let items = this.languageService.getNavigateToItems(searchValue);
|
|
let length = items && items.length;
|
|
|
|
Harness.IO.log(`NavigationItems list (${length} items)`);
|
|
|
|
for (let i = 0; i < length; i++) {
|
|
let item = items[i];
|
|
Harness.IO.log(`name: ${item.name}, kind: ${item.kind}, parentName: ${item.containerName}, fileName: ${item.fileName}`);
|
|
}
|
|
}
|
|
|
|
public printScriptLexicalStructureItems() {
|
|
let items = this.languageService.getNavigationBarItems(this.activeFile.fileName);
|
|
let length = items && items.length;
|
|
|
|
Harness.IO.log(`NavigationItems list (${length} items)`);
|
|
|
|
for (let i = 0; i < length; i++) {
|
|
let item = items[i];
|
|
Harness.IO.log(`name: ${item.text}, kind: ${item.kind}`);
|
|
}
|
|
}
|
|
|
|
private getOccurancesAtCurrentPosition() {
|
|
return this.languageService.getOccurrencesAtPosition(this.activeFile.fileName, this.currentCaretPosition);
|
|
}
|
|
|
|
public verifyOccurrencesAtPositionListContains(fileName: string, start: number, end: number, isWriteAccess?: boolean) {
|
|
this.taoInvalidReason = "verifyOccurrencesAtPositionListContains NYI";
|
|
|
|
let occurrences = this.getOccurancesAtCurrentPosition();
|
|
|
|
if (!occurrences || occurrences.length === 0) {
|
|
this.raiseError('verifyOccurancesAtPositionListContains failed - found 0 references, expected at least one.');
|
|
}
|
|
|
|
for (let occurrence of occurrences) {
|
|
if (occurrence && occurrence.fileName === fileName && occurrence.textSpan.start === start && ts.textSpanEnd(occurrence.textSpan) === end) {
|
|
if (typeof isWriteAccess !== "undefined" && occurrence.isWriteAccess !== isWriteAccess) {
|
|
this.raiseError(`verifyOccurrencesAtPositionListContains failed - item isWriteAccess value does not match, actual: ${occurrence.isWriteAccess}, expected: ${isWriteAccess}.`);
|
|
}
|
|
return;
|
|
}
|
|
}
|
|
|
|
let missingItem = { fileName: fileName, start: start, end: end, isWriteAccess: isWriteAccess };
|
|
this.raiseError(`verifyOccurrencesAtPositionListContains failed - could not find the item: ${JSON.stringify(missingItem)} in the returned list: (${JSON.stringify(occurrences)})`);
|
|
}
|
|
|
|
public verifyOccurrencesAtPositionListCount(expectedCount: number) {
|
|
this.taoInvalidReason = "verifyOccurrencesAtPositionListCount NYI";
|
|
|
|
let occurrences = this.getOccurancesAtCurrentPosition();
|
|
let actualCount = occurrences ? occurrences.length : 0;
|
|
if (expectedCount !== actualCount) {
|
|
this.raiseError(`verifyOccurrencesAtPositionListCount failed - actual: ${actualCount}, expected:${expectedCount}`);
|
|
}
|
|
}
|
|
|
|
private getDocumentHighlightsAtCurrentPosition(fileNamesToSearch: string[]) {
|
|
let filesToSearch = fileNamesToSearch.map(name => ts.combinePaths(this.basePath, name));
|
|
return this.languageService.getDocumentHighlights(this.activeFile.fileName, this.currentCaretPosition, filesToSearch);
|
|
}
|
|
|
|
public verifyDocumentHighlightsAtPositionListContains(fileName: string, start: number, end: number, fileNamesToSearch: string[], kind?: string) {
|
|
this.taoInvalidReason = 'verifyDocumentHighlightsAtPositionListContains NYI';
|
|
|
|
let documentHighlights = this.getDocumentHighlightsAtCurrentPosition(fileNamesToSearch);
|
|
|
|
if (!documentHighlights || documentHighlights.length === 0) {
|
|
this.raiseError('verifyDocumentHighlightsAtPositionListContains failed - found 0 highlights, expected at least one.');
|
|
}
|
|
|
|
for (let documentHighlight of documentHighlights) {
|
|
if (documentHighlight.fileName === fileName) {
|
|
let { highlightSpans } = documentHighlight;
|
|
|
|
for (let highlight of highlightSpans) {
|
|
if (highlight && highlight.textSpan.start === start && ts.textSpanEnd(highlight.textSpan) === end) {
|
|
if (typeof kind !== "undefined" && highlight.kind !== kind) {
|
|
this.raiseError('verifyDocumentHighlightsAtPositionListContains failed - item "kind" value does not match, actual: ' + highlight.kind + ', expected: ' + kind + '.');
|
|
}
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
let missingItem = { fileName: fileName, start: start, end: end, kind: kind };
|
|
this.raiseError('verifyOccurancesAtPositionListContains failed - could not find the item: ' + JSON.stringify(missingItem) + ' in the returned list: (' + JSON.stringify(documentHighlights) + ')');
|
|
}
|
|
|
|
public verifyDocumentHighlightsAtPositionListCount(expectedCount: number, fileNamesToSearch: string[]) {
|
|
this.taoInvalidReason = 'verifyDocumentHighlightsAtPositionListCount NYI';
|
|
|
|
let documentHighlights = this.getDocumentHighlightsAtCurrentPosition(fileNamesToSearch);
|
|
let actualCount = documentHighlights
|
|
? documentHighlights.reduce((currentCount, { highlightSpans }) => currentCount + highlightSpans.length, 0)
|
|
: 0;
|
|
|
|
if (expectedCount !== actualCount) {
|
|
this.raiseError('verifyDocumentHighlightsAtPositionListCount failed - actual: ' + actualCount + ', expected:' + expectedCount);
|
|
}
|
|
}
|
|
|
|
// Get the text of the entire line the caret is currently at
|
|
private getCurrentLineContent() {
|
|
let text = this.getFileContent(this.activeFile.fileName);
|
|
|
|
let pos = this.currentCaretPosition;
|
|
let startPos = pos, endPos = pos;
|
|
|
|
while (startPos > 0) {
|
|
let ch = text.charCodeAt(startPos - 1);
|
|
if (ch === ts.CharacterCodes.carriageReturn || ch === ts.CharacterCodes.lineFeed) {
|
|
break;
|
|
}
|
|
|
|
startPos--;
|
|
}
|
|
|
|
while (endPos < text.length) {
|
|
let ch = text.charCodeAt(endPos);
|
|
|
|
if (ch === ts.CharacterCodes.carriageReturn || ch === ts.CharacterCodes.lineFeed) {
|
|
break;
|
|
}
|
|
|
|
endPos++;
|
|
}
|
|
|
|
return text.substring(startPos, endPos);
|
|
}
|
|
|
|
private assertItemInCompletionList(items: ts.CompletionEntry[], name: string, text?: string, documentation?: string, kind?: string) {
|
|
this.scenarioActions.push("<ShowCompletionList />");
|
|
this.scenarioActions.push(`<VerifyCompletionContainsItem ItemName="${name}"/>`);
|
|
|
|
if (text || documentation || kind) {
|
|
this.taoInvalidReason = "assertItemInCompletionList only supports the \"name\" parameter";
|
|
}
|
|
|
|
for (let i = 0; i < items.length; i++) {
|
|
let item = items[i];
|
|
if (item.name === name) {
|
|
if (documentation != undefined || text !== undefined) {
|
|
let details = this.getCompletionEntryDetails(item.name);
|
|
|
|
if (documentation !== undefined) {
|
|
assert.equal(ts.displayPartsToString(details.documentation), documentation, assertionMessage("completion item documentation"));
|
|
}
|
|
if (text !== undefined) {
|
|
assert.equal(ts.displayPartsToString(details.displayParts), text, assertionMessage("completion item detail text"));
|
|
}
|
|
}
|
|
|
|
if (kind !== undefined) {
|
|
assert.equal(item.kind, kind, assertionMessage("completion item kind"));
|
|
}
|
|
|
|
return;
|
|
}
|
|
}
|
|
|
|
let itemsString = items.map((item) => JSON.stringify({ name: item.name, kind: item.kind })).join(",\n");
|
|
|
|
this.raiseError(`Expected "${JSON.stringify({ name, text, documentation, kind })}" to be in list [${itemsString}]`);
|
|
}
|
|
|
|
private findFile(indexOrName: any) {
|
|
let result: FourSlashFile = null;
|
|
if (typeof indexOrName === "number") {
|
|
let index = <number>indexOrName;
|
|
if (index >= this.testData.files.length) {
|
|
throw new Error(`File index (${index}) in openFile was out of range. There are only ${this.testData.files.length} files in this test.`);
|
|
} else {
|
|
result = this.testData.files[index];
|
|
}
|
|
} else if (typeof indexOrName === "string") {
|
|
let name = <string>indexOrName;
|
|
|
|
// names are stored in the compiler with this relative path, this allows people to use goTo.file on just the fileName
|
|
name = name.indexOf("/") === -1 ? (this.basePath + "/" + name) : name;
|
|
|
|
let availableNames: string[] = [];
|
|
let foundIt = false;
|
|
for (let i = 0; i < this.testData.files.length; i++) {
|
|
let fn = this.testData.files[i].fileName;
|
|
if (fn) {
|
|
if (fn === name) {
|
|
result = this.testData.files[i];
|
|
foundIt = true;
|
|
break;
|
|
}
|
|
availableNames.push(fn);
|
|
}
|
|
}
|
|
|
|
if (!foundIt) {
|
|
throw new Error(`No test file named "${name}" exists. Available file names are: ${availableNames.join(", ")}`);
|
|
}
|
|
} else {
|
|
throw new Error("Unknown argument type");
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
private getLineColStringAtPosition(position: number) {
|
|
let pos = this.languageServiceAdapterHost.positionToLineAndCharacter(this.activeFile.fileName, position);
|
|
return `line ${(pos.line + 1)}, col ${pos.character}`;
|
|
}
|
|
|
|
public getMarkerByName(markerName: string) {
|
|
let markerPos = this.testData.markerPositions[markerName];
|
|
if (markerPos === undefined) {
|
|
let markerNames: string[] = [];
|
|
for (let m in this.testData.markerPositions) markerNames.push(m);
|
|
throw new Error(`Unknown marker "${markerName}" Available markers: ${markerNames.map(m => "\"" + m + "\"").join(", ")}`);
|
|
} else {
|
|
return markerPos;
|
|
}
|
|
}
|
|
|
|
private static makeWhitespaceVisible(text: string) {
|
|
return text.replace(/ /g, "\u00B7").replace(/\r/g, "\u00B6").replace(/\n/g, "\u2193\n").replace(/\t/g, "\u2192\ ");
|
|
}
|
|
|
|
public getTestXmlData(): TestXmlData {
|
|
return {
|
|
actions: this.scenarioActions,
|
|
invalidReason: this.taoInvalidReason,
|
|
originalName: ""
|
|
};
|
|
}
|
|
|
|
public setCancelled(numberOfCalls: number): void {
|
|
this.cancellationToken.setCancelled(numberOfCalls);
|
|
}
|
|
|
|
public resetCancelled(): void {
|
|
this.cancellationToken.resetCancelled();
|
|
}
|
|
}
|
|
|
|
// TOOD: should these just use the Harness's stdout/stderr?
|
|
let fsOutput = new Harness.Compiler.WriterAggregator();
|
|
let fsErrors = new Harness.Compiler.WriterAggregator();
|
|
export let xmlData: TestXmlData[] = [];
|
|
export function runFourSlashTest(basePath: string, testType: FourSlashTestType, fileName: string) {
|
|
let content = Harness.IO.readFile(fileName);
|
|
let xml = runFourSlashTestContent(basePath, testType, content, fileName);
|
|
xmlData.push(xml);
|
|
}
|
|
|
|
// We don't want to recompile 'fourslash.ts' for every test, so
|
|
// here we cache the JS output and reuse it for every test.
|
|
let fourslashJsOutput: string;
|
|
{
|
|
let host = Harness.Compiler.createCompilerHost([{ unitName: Harness.Compiler.fourslashFileName, content: undefined }],
|
|
(fn, contents) => fourslashJsOutput = contents,
|
|
ts.ScriptTarget.Latest,
|
|
ts.sys.useCaseSensitiveFileNames);
|
|
|
|
let program = ts.createProgram([Harness.Compiler.fourslashFileName], { noResolve: true, target: ts.ScriptTarget.ES3 }, host);
|
|
|
|
program.emit(host.getSourceFile(Harness.Compiler.fourslashFileName, ts.ScriptTarget.ES3));
|
|
}
|
|
|
|
|
|
export function runFourSlashTestContent(basePath: string, testType: FourSlashTestType, content: string, fileName: string): TestXmlData {
|
|
// Parse out the files and their metadata
|
|
let testData = parseTestData(basePath, content, fileName);
|
|
|
|
currentTestState = new TestState(basePath, testType, testData);
|
|
|
|
let result = "";
|
|
let host = Harness.Compiler.createCompilerHost(
|
|
[
|
|
{ unitName: Harness.Compiler.fourslashFileName, content: undefined },
|
|
{ unitName: fileName, content: content }
|
|
],
|
|
(fn, contents) => result = contents,
|
|
ts.ScriptTarget.Latest,
|
|
ts.sys.useCaseSensitiveFileNames);
|
|
|
|
let program = ts.createProgram([Harness.Compiler.fourslashFileName, fileName], { out: "fourslashTestOutput.js", noResolve: true, target: ts.ScriptTarget.ES3 }, host);
|
|
|
|
let sourceFile = host.getSourceFile(fileName, ts.ScriptTarget.ES3);
|
|
|
|
let diagnostics = ts.getPreEmitDiagnostics(program, sourceFile);
|
|
if (diagnostics.length > 0) {
|
|
throw new Error(`Error compiling ${fileName}: ` +
|
|
diagnostics.map(e => ts.flattenDiagnosticMessageText(e.messageText, ts.sys.newLine)).join("\r\n"));
|
|
}
|
|
|
|
program.emit(sourceFile);
|
|
result = result || ""; // Might have an empty fourslash file
|
|
|
|
result = fourslashJsOutput + "\r\n" + result;
|
|
|
|
// Compile and execute the test
|
|
try {
|
|
eval(result);
|
|
}
|
|
catch (err) {
|
|
// Debugging: FourSlash.currentTestState.printCurrentFileState();
|
|
throw err;
|
|
}
|
|
|
|
let xmlData = currentTestState.getTestXmlData();
|
|
xmlData.originalName = fileName;
|
|
return xmlData;
|
|
}
|
|
|
|
function chompLeadingSpace(content: string) {
|
|
let lines = content.split("\n");
|
|
for (let i = 0; i < lines.length; i++) {
|
|
if ((lines[i].length !== 0) && (lines[i].charAt(0) !== " ")) {
|
|
return content;
|
|
}
|
|
}
|
|
|
|
return lines.map(s => s.substr(1)).join("\n");
|
|
}
|
|
|
|
function parseTestData(basePath: string, contents: string, fileName: string): FourSlashData {
|
|
// Regex for parsing options in the format "@Alpha: Value of any sort"
|
|
let optionRegex = /^\s*@(\w+): (.*)\s*/;
|
|
|
|
// List of all the subfiles we've parsed out
|
|
let files: FourSlashFile[] = [];
|
|
// Global options
|
|
let globalOptions: { [s: string]: string; } = {};
|
|
// Marker positions
|
|
|
|
// Split up the input file by line
|
|
// Note: IE JS engine incorrectly handles consecutive delimiters here when using RegExp split, so
|
|
// we have to string-based splitting instead and try to figure out the delimiting chars
|
|
let lines = contents.split("\n");
|
|
|
|
let markerPositions: MarkerMap = {};
|
|
let markers: Marker[] = [];
|
|
let ranges: Range[] = [];
|
|
|
|
// Stuff related to the subfile we're parsing
|
|
let currentFileContent: string = null;
|
|
let currentFileName = fileName;
|
|
let currentFileOptions: { [s: string]: string } = {};
|
|
|
|
for (let i = 0; i < lines.length; i++) {
|
|
let line = lines[i];
|
|
let lineLength = line.length;
|
|
|
|
if (lineLength > 0 && line.charAt(lineLength - 1) === "\r") {
|
|
line = line.substr(0, lineLength - 1);
|
|
}
|
|
|
|
if (line.substr(0, 4) === "////") {
|
|
// Subfile content line
|
|
|
|
// Append to the current subfile content, inserting a newline needed
|
|
if (currentFileContent === null) {
|
|
currentFileContent = "";
|
|
} else {
|
|
// End-of-line
|
|
currentFileContent = currentFileContent + "\n";
|
|
}
|
|
|
|
currentFileContent = currentFileContent + line.substr(4);
|
|
} else if (line.substr(0, 2) === "//") {
|
|
// Comment line, check for global/file @options and record them
|
|
let match = optionRegex.exec(line.substr(2));
|
|
if (match) {
|
|
let globalMetadataNamesIndex = globalMetadataNames.indexOf(match[1]);
|
|
let fileMetadataNamesIndex = fileMetadataNames.indexOf(match[1]);
|
|
if (globalMetadataNamesIndex === -1) {
|
|
if (fileMetadataNamesIndex === -1) {
|
|
throw new Error(`Unrecognized metadata name "${match[1]}". Available global metadata names are: ${globalMetadataNames.join(", ")}; file metadata names are: ${fileMetadataNames.join(", ")}`);
|
|
} else if (fileMetadataNamesIndex === fileMetadataNames.indexOf(metadataOptionNames.fileName)) {
|
|
// Found an @FileName directive, if this is not the first then create a new subfile
|
|
if (currentFileContent) {
|
|
let file = parseFileContent(currentFileContent, currentFileName, markerPositions, markers, ranges);
|
|
file.fileOptions = currentFileOptions;
|
|
|
|
// Store result file
|
|
files.push(file);
|
|
|
|
// Reset local data
|
|
currentFileContent = null;
|
|
currentFileOptions = {};
|
|
currentFileName = fileName;
|
|
}
|
|
|
|
currentFileName = basePath + "/" + match[2];
|
|
currentFileOptions[match[1]] = match[2];
|
|
} else {
|
|
// Add other fileMetadata flag
|
|
currentFileOptions[match[1]] = match[2];
|
|
}
|
|
} else {
|
|
// Check if the match is already existed in the global options
|
|
if (globalOptions[match[1]] !== undefined) {
|
|
throw new Error("Global Option : '" + match[1] + "' is already existed");
|
|
}
|
|
globalOptions[match[1]] = match[2];
|
|
}
|
|
}
|
|
// TODO: should be '==='?
|
|
} else if (line == "" || lineLength === 0) {
|
|
// Previously blank lines between fourslash content caused it to be considered as 2 files,
|
|
// Remove this behavior since it just causes errors now
|
|
} else {
|
|
// Empty line or code line, terminate current subfile if there is one
|
|
if (currentFileContent) {
|
|
let file = parseFileContent(currentFileContent, currentFileName, markerPositions, markers, ranges);
|
|
file.fileOptions = currentFileOptions;
|
|
|
|
// Store result file
|
|
files.push(file);
|
|
|
|
// Reset local data
|
|
currentFileContent = null;
|
|
currentFileOptions = {};
|
|
currentFileName = fileName;
|
|
}
|
|
}
|
|
}
|
|
|
|
// @Filename is the only directive that can be used in a test that contains tsconfig.json file.
|
|
if (containTSConfigJson(files)) {
|
|
let directive = getNonFileNameOptionInFileList(files);
|
|
if (!directive) {
|
|
directive = getNonFileNameOptionInObject(globalOptions);
|
|
}
|
|
if (directive) {
|
|
throw Error("It is not allowed to use tsconfig.json along with directive '" + directive + "'");
|
|
}
|
|
}
|
|
|
|
return {
|
|
markerPositions,
|
|
markers,
|
|
globalOptions,
|
|
files,
|
|
ranges
|
|
};
|
|
}
|
|
|
|
function containTSConfigJson(files: FourSlashFile[]): boolean {
|
|
return ts.forEach(files, f => f.fileOptions["Filename"] === "tsconfig.json");
|
|
}
|
|
|
|
function getNonFileNameOptionInFileList(files: FourSlashFile[]): string {
|
|
return ts.forEach(files, f => getNonFileNameOptionInObject(f.fileOptions));
|
|
}
|
|
|
|
function getNonFileNameOptionInObject(optionObject: { [s: string]: string }): string {
|
|
for (let option in optionObject) {
|
|
if (option !== metadataOptionNames.fileName) {
|
|
return option;
|
|
}
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
const enum State {
|
|
none,
|
|
inSlashStarMarker,
|
|
inObjectMarker
|
|
}
|
|
|
|
function reportError(fileName: string, line: number, col: number, message: string) {
|
|
let errorMessage = fileName + "(" + line + "," + col + "): " + message;
|
|
throw new Error(errorMessage);
|
|
}
|
|
|
|
function recordObjectMarker(fileName: string, location: ILocationInformation, text: string, markerMap: MarkerMap, markers: Marker[]): Marker {
|
|
let markerValue: any = undefined;
|
|
try {
|
|
// Attempt to parse the marker value as JSON
|
|
markerValue = JSON.parse("{ " + text + " }");
|
|
} catch (e) {
|
|
reportError(fileName, location.sourceLine, location.sourceColumn, "Unable to parse marker text " + e.message);
|
|
}
|
|
|
|
if (markerValue === undefined) {
|
|
reportError(fileName, location.sourceLine, location.sourceColumn, "Object markers can not be empty");
|
|
return null;
|
|
}
|
|
|
|
let marker: Marker = {
|
|
fileName: fileName,
|
|
position: location.position,
|
|
data: markerValue
|
|
};
|
|
|
|
// Object markers can be anonymous
|
|
if (markerValue.name) {
|
|
markerMap[markerValue.name] = marker;
|
|
}
|
|
|
|
markers.push(marker);
|
|
|
|
return marker;
|
|
}
|
|
|
|
function recordMarker(fileName: string, location: ILocationInformation, name: string, markerMap: MarkerMap, markers: Marker[]): Marker {
|
|
let marker: Marker = {
|
|
fileName: fileName,
|
|
position: location.position
|
|
};
|
|
|
|
// Verify markers for uniqueness
|
|
if (markerMap[name] !== undefined) {
|
|
let message = "Marker '" + name + "' is duplicated in the source file contents.";
|
|
reportError(marker.fileName, location.sourceLine, location.sourceColumn, message);
|
|
return null;
|
|
} else {
|
|
markerMap[name] = marker;
|
|
markers.push(marker);
|
|
return marker;
|
|
}
|
|
}
|
|
|
|
function parseFileContent(content: string, fileName: string, markerMap: MarkerMap, markers: Marker[], ranges: Range[]): FourSlashFile {
|
|
content = chompLeadingSpace(content);
|
|
|
|
// Any slash-star comment with a character not in this string is not a marker.
|
|
let validMarkerChars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz$1234567890_";
|
|
|
|
/// The file content (minus metacharacters) so far
|
|
let output: string = "";
|
|
|
|
/// The current marker (or maybe multi-line comment?) we're parsing, possibly
|
|
let openMarker: ILocationInformation = null;
|
|
|
|
/// A stack of the open range markers that are still unclosed
|
|
let openRanges: IRangeLocationInformation[] = [];
|
|
|
|
/// A list of ranges we've collected so far */
|
|
let localRanges: Range[] = [];
|
|
|
|
/// The latest position of the start of an unflushed plain text area
|
|
let lastNormalCharPosition: number = 0;
|
|
|
|
/// The total number of metacharacters removed from the file (so far)
|
|
let difference: number = 0;
|
|
|
|
/// The fourslash file state object we are generating
|
|
let state: State = State.none;
|
|
|
|
/// Current position data
|
|
let line: number = 1;
|
|
let column: number = 1;
|
|
|
|
let flush = (lastSafeCharIndex: number) => {
|
|
if (lastSafeCharIndex === undefined) {
|
|
output = output + content.substr(lastNormalCharPosition);
|
|
} else {
|
|
output = output + content.substr(lastNormalCharPosition, lastSafeCharIndex - lastNormalCharPosition);
|
|
}
|
|
};
|
|
|
|
if (content.length > 0) {
|
|
let previousChar = content.charAt(0);
|
|
for (let i = 1; i < content.length; i++) {
|
|
let currentChar = content.charAt(i);
|
|
switch (state) {
|
|
case State.none:
|
|
if (previousChar === "[" && currentChar === "|") {
|
|
// found a range start
|
|
openRanges.push({
|
|
position: (i - 1) - difference,
|
|
sourcePosition: i - 1,
|
|
sourceLine: line,
|
|
sourceColumn: column,
|
|
});
|
|
// copy all text up to marker position
|
|
flush(i - 1);
|
|
lastNormalCharPosition = i + 1;
|
|
difference += 2;
|
|
} else if (previousChar === "|" && currentChar === "]") {
|
|
// found a range end
|
|
let rangeStart = openRanges.pop();
|
|
if (!rangeStart) {
|
|
reportError(fileName, line, column, "Found range end with no matching start.");
|
|
}
|
|
|
|
let range: Range = {
|
|
fileName: fileName,
|
|
start: rangeStart.position,
|
|
end: (i - 1) - difference,
|
|
marker: rangeStart.marker
|
|
};
|
|
localRanges.push(range);
|
|
|
|
// copy all text up to range marker position
|
|
flush(i - 1);
|
|
lastNormalCharPosition = i + 1;
|
|
difference += 2;
|
|
} else if (previousChar === "/" && currentChar === "*") {
|
|
// found a possible marker start
|
|
state = State.inSlashStarMarker;
|
|
openMarker = {
|
|
position: (i - 1) - difference,
|
|
sourcePosition: i - 1,
|
|
sourceLine: line,
|
|
sourceColumn: column,
|
|
};
|
|
} else if (previousChar === "{" && currentChar === "|") {
|
|
// found an object marker start
|
|
state = State.inObjectMarker;
|
|
openMarker = {
|
|
position: (i - 1) - difference,
|
|
sourcePosition: i - 1,
|
|
sourceLine: line,
|
|
sourceColumn: column,
|
|
};
|
|
flush(i - 1);
|
|
}
|
|
break;
|
|
|
|
case State.inObjectMarker:
|
|
// Object markers are only ever terminated by |} and have no content restrictions
|
|
if (previousChar === "|" && currentChar === "}") {
|
|
// Record the marker
|
|
let objectMarkerNameText = content.substring(openMarker.sourcePosition + 2, i - 1).trim();
|
|
let marker = recordObjectMarker(fileName, openMarker, objectMarkerNameText, markerMap, markers);
|
|
|
|
if (openRanges.length > 0) {
|
|
openRanges[openRanges.length - 1].marker = marker;
|
|
}
|
|
|
|
// Set the current start to point to the end of the current marker to ignore its text
|
|
lastNormalCharPosition = i + 1;
|
|
difference += i + 1 - openMarker.sourcePosition;
|
|
|
|
// Reset the state
|
|
openMarker = null;
|
|
state = State.none;
|
|
}
|
|
break;
|
|
|
|
case State.inSlashStarMarker:
|
|
if (previousChar === "*" && currentChar === "/") {
|
|
// Record the marker
|
|
// start + 2 to ignore the */, -1 on the end to ignore the * (/ is next)
|
|
let markerNameText = content.substring(openMarker.sourcePosition + 2, i - 1).trim();
|
|
let marker = recordMarker(fileName, openMarker, markerNameText, markerMap, markers);
|
|
|
|
if (openRanges.length > 0) {
|
|
openRanges[openRanges.length - 1].marker = marker;
|
|
}
|
|
|
|
// Set the current start to point to the end of the current marker to ignore its text
|
|
flush(openMarker.sourcePosition);
|
|
lastNormalCharPosition = i + 1;
|
|
difference += i + 1 - openMarker.sourcePosition;
|
|
|
|
// Reset the state
|
|
openMarker = null;
|
|
state = State.none;
|
|
} else if (validMarkerChars.indexOf(currentChar) < 0) {
|
|
if (currentChar === "*" && i < content.length - 1 && content.charAt(i + 1) === "/") {
|
|
// The marker is about to be closed, ignore the 'invalid' char
|
|
} else {
|
|
// We've hit a non-valid marker character, so we were actually in a block comment
|
|
// Bail out the text we've gathered so far back into the output
|
|
flush(i);
|
|
lastNormalCharPosition = i;
|
|
openMarker = null;
|
|
|
|
state = State.none;
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
|
|
if (currentChar === "\n" && previousChar === "\r") {
|
|
// Ignore trailing \n after a \r
|
|
continue;
|
|
} else if (currentChar === "\n" || currentChar === "\r") {
|
|
line++;
|
|
column = 1;
|
|
continue;
|
|
}
|
|
|
|
column++;
|
|
previousChar = currentChar;
|
|
}
|
|
}
|
|
|
|
// Add the remaining text
|
|
flush(undefined);
|
|
|
|
if (openRanges.length > 0) {
|
|
let openRange = openRanges[0];
|
|
reportError(fileName, openRange.sourceLine, openRange.sourceColumn, "Unterminated range.");
|
|
}
|
|
|
|
if (openMarker !== null) {
|
|
reportError(fileName, openMarker.sourceLine, openMarker.sourceColumn, "Unterminated marker.");
|
|
}
|
|
|
|
// put ranges in the correct order
|
|
localRanges = localRanges.sort((a, b) => a.start < b.start ? -1 : 1);
|
|
localRanges.forEach((r) => { ranges.push(r); });
|
|
|
|
return {
|
|
content: output,
|
|
fileOptions: {},
|
|
version: 0,
|
|
fileName: fileName
|
|
};
|
|
}
|
|
} |