Skip to content

Commit

Permalink
Fix issue with incorrect colorization immediately after saving a new …
Browse files Browse the repository at this point in the history 
…file (#4153)
  • Loading branch information
@Colengms
Colengms authored Aug 28, 2019
1 parent c03fea0 commit 41933fa
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 40 deletions.
83 changes: 46 additions & 37 deletions Extension/src/LanguageServer/client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,7 @@ export interface Client {
TrackedDocuments: Set<vscode.TextDocument>;
onDidChangeSettings(event: vscode.ConfigurationChangeEvent): { [key: string] : string };
onDidOpenTextDocument(document: vscode.TextDocument): void;
onDidCloseTextDocument(document: vscode.TextDocument): void;
onDidChangeVisibleTextEditors(editors: vscode.TextEditor[]): void;
onDidChangeTextDocument(textDocumentChangeEvent: vscode.TextDocumentChangeEvent): void;
onDidChangeTextEditorVisibleRanges(textEditorVisibleRangesChangeEvent: vscode.TextEditorVisibleRangesChangeEvent): void;
Expand Down Expand Up @@ -360,6 +361,7 @@ class DefaultClient implements Client {
private isSupported: boolean = true;
private colorizationSettings: ColorizationSettings;
private colorizationState = new Map<string, ColorizationState>();
private openFileVersions = new Map<string, number>();
private visibleRanges = new Map<string, Range[]>();
private settingsTracker: SettingsTracker;
private configurationProvider: string;
Expand Down Expand Up @@ -659,36 +661,49 @@ class DefaultClient implements Client {
this.editVersion++;
if (textDocumentChangeEvent.document.uri.scheme === "file") {
if (textDocumentChangeEvent.document.languageId === "cpp" || textDocumentChangeEvent.document.languageId === "c") {
try {
let colorizationState: ColorizationState = this.getColorizationState(textDocumentChangeEvent.document.uri.toString());

// Adjust colorization ranges after this edit. (i.e. if a line was added, push decorations after it down one line)
colorizationState.addEdits(textDocumentChangeEvent.contentChanges, this.editVersion);
} catch (e) {
// Ensure an exception does not prevent pass-through to native handler, or editVersion could become inconsistent
console.log(e.toString());
let oldVersion: number = this.openFileVersions.get(textDocumentChangeEvent.document.uri.toString());
let newVersion: number = textDocumentChangeEvent.document.version;
if (newVersion > oldVersion) {
this.openFileVersions.set(textDocumentChangeEvent.document.uri.toString(), newVersion);
try {
let colorizationState: ColorizationState = this.colorizationState.get(textDocumentChangeEvent.document.uri.toString());
if (colorizationState) {
// Adjust colorization ranges after this edit. (i.e. if a line was added, push decorations after it down one line)
colorizationState.addEdits(textDocumentChangeEvent.contentChanges, this.editVersion);
}
} catch (e) {
// Ensure an exception does not prevent pass-through to native handler, or editVersion could become inconsistent
console.log(e.toString());
}
}
}
}
}

public onDidOpenTextDocument(document: vscode.TextDocument): void {
if (document.uri.scheme === "file") {
this.openFileVersions.set(document.uri.toString(), document.version);
this.colorizationState.set(document.uri.toString(), new ColorizationState(document.uri, this.colorizationSettings));
this.sendVisibleRanges(document.uri);
}
}

public onDidCloseTextDocument(document: vscode.TextDocument): void {
this.colorizationState.delete(document.uri.toString());
this.openFileVersions.delete(document.uri.toString());
}

public onDidChangeVisibleTextEditors(editors: vscode.TextEditor[]): void {
let processedUris: vscode.Uri[] = [];
editors.forEach(editor => {
if (editor.document.uri.scheme === "file") {
let colorizationState: ColorizationState = this.colorizationState.get(editor.document.uri.toString());
if (colorizationState) {
colorizationState.refresh(editor);
}
if (!processedUris.find(uri => uri === editor.document.uri)) {
processedUris.push(editor.document.uri);
this.sendVisibleRanges(editor.document.uri);
if (!processedUris.find(uri => uri === editor.document.uri)) {
processedUris.push(editor.document.uri);
this.sendVisibleRanges(editor.document.uri);
}
}
}
});
Expand Down Expand Up @@ -1362,33 +1377,26 @@ class DefaultClient implements Client {
this.model.tagParserStatus.Value = notificationBody.status;
}

private getColorizationState(uri: string): ColorizationState {
let colorizationState: ColorizationState = this.colorizationState.get(uri);
if (!colorizationState) {
colorizationState = new ColorizationState(this.RootUri, this.colorizationSettings);
this.colorizationState.set(uri, colorizationState);
}
return colorizationState;
}

private updateSemanticColorizationRegions(params: SemanticColorizationRegionsParams): void {
// Convert the params to vscode.Range's before passing to colorizationState.updateSemantic()
let semanticRanges: vscode.Range[][] = new Array<vscode.Range[]>(TokenKind.Count);
for (let i: number = 0; i < TokenKind.Count; i++) {
semanticRanges[i] = [];
let colorizationState: ColorizationState = this.colorizationState.get(params.uri);
if (colorizationState) {
// Convert the params to vscode.Range's before passing to colorizationState.updateSemantic()
let semanticRanges: vscode.Range[][] = new Array<vscode.Range[]>(TokenKind.Count);
for (let i: number = 0; i < TokenKind.Count; i++) {
semanticRanges[i] = [];
}
params.regions.forEach(element => {
let newRange : vscode.Range = new vscode.Range(element.range.start.line, element.range.start.character, element.range.end.line, element.range.end.character);
semanticRanges[element.kind].push(newRange);
});
let inactiveRanges: vscode.Range[] = [];
params.inactiveRegions.forEach(element => {
let newRange : vscode.Range = new vscode.Range(element.startLine, 0, element.endLine, 0);
inactiveRanges.push(newRange);
});
colorizationState.updateSemantic(params.uri, semanticRanges, inactiveRanges, params.editVersion);
this.languageClient.sendNotification(SemanticColorizationRegionsReceiptNotification, { uri: params.uri });
}
params.regions.forEach(element => {
let newRange : vscode.Range = new vscode.Range(element.range.start.line, element.range.start.character, element.range.end.line, element.range.end.character);
semanticRanges[element.kind].push(newRange);
});
let inactiveRanges: vscode.Range[] = [];
params.inactiveRegions.forEach(element => {
let newRange : vscode.Range = new vscode.Range(element.startLine, 0, element.endLine, 0);
inactiveRanges.push(newRange);
});
let colorizationState: ColorizationState = this.getColorizationState(params.uri);
colorizationState.updateSemantic(params.uri, semanticRanges, inactiveRanges, params.editVersion);
this.languageClient.sendNotification(SemanticColorizationRegionsReceiptNotification, { uri: params.uri });
}

private promptCompileCommands(params: CompileCommandsPaths) : void {
Expand Down Expand Up @@ -2007,6 +2015,7 @@ class NullClient implements Client {
TrackedDocuments = new Set<vscode.TextDocument>();
onDidChangeSettings(event: vscode.ConfigurationChangeEvent): { [key: string] : string } { return {}; }
onDidOpenTextDocument(document: vscode.TextDocument): void {}
onDidCloseTextDocument(document: vscode.TextDocument): void {}
onDidChangeVisibleTextEditors(editors: vscode.TextEditor[]): void {}
onDidChangeTextDocument(textDocumentChangeEvent: vscode.TextDocumentChangeEvent): void {}
onDidChangeTextEditorVisibleRanges(textEditorVisibleRangesChangeEvent: vscode.TextEditorVisibleRangesChangeEvent): void {}
Expand Down
8 changes: 5 additions & 3 deletions Extension/src/LanguageServer/protocolFilter.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,11 @@ export function createProtocolFilter(me: Client, clients: ClientCollection): Mid
me.addFileAssociations(mappingString, false);
}

me.onDidOpenTextDocument(document);

me.provideCustomConfiguration(document.uri, null);
me.notifyWhenReady(() => sendMessage(document));
me.notifyWhenReady(() => {
me.onDidOpenTextDocument(document);
sendMessage(document);
});
}
},
didChange: (textDocumentChangeEvent, sendMessage) => {
Expand All @@ -55,6 +56,7 @@ export function createProtocolFilter(me: Client, clients: ClientCollection): Mid
didClose: (document, sendMessage) => {
if (clients.ActiveClient === me) {
console.assert(me.TrackedDocuments.has(document));
me.onDidCloseTextDocument(document);
me.TrackedDocuments.delete(document);
me.notifyWhenReady(() => sendMessage(document));
}
Expand Down

0 comments on commit 41933fa

Please sign in to comment.