Skip to content

Rework multi-line output handling in the worksheet #5582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 10, 2018
Merged

Rework multi-line output handling in the worksheet #5582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
835a2fb
Rework multi-line output handling in the worksheet
smarter Dec 9, 2018
9416146
vscode-dotty: Release 0.1.11
smarter Dec 10, 2018
fa5bdbe
vscode-dotty: Bump to 0.1.12-snapshot
smarter Dec 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion project/Build.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -992,7 +992,7 @@ object Build {
settings(commonSettings).
settings(
EclipseKeys.skipProject := true,
version := "0.1.11-snapshot", // Keep in sync with package.json
version := "0.1.12-snapshot", // Keep in sync with package.json
autoScalaLibrary := false,
publishArtifact := false,
includeFilter in unmanagedSources := NothingFilter | "*.ts" | "**.json",
Expand Down
2 changes: 1 addition & 1 deletion vscode-dotty/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vscode-dotty/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "dotty",
"displayName": "Dotty Language Server",
"description": "IDE integration for Dotty, the experimental Scala compiler",
"version": "0.1.11-snapshot",
"version": "0.1.12-snapshot",
"license": "BSD-3-Clause",
"publisher": "lampepfl",
"repository": {
Expand Down
189 changes: 38 additions & 151 deletions vscode-dotty/src/worksheet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,6 @@ class Worksheet implements Disposable {
/** All decorations that have been added so far */
private decorations: Decoration[] = []

/** The number of blank lines that have been inserted to fit the output so far. */
private insertedLines: number = 0

/** The lines that contain decorations */
private decoratedLines: Set<number> = new Set<number>()

/** The minimum margin to add so that the decoration is shown after all text. */
private margin: number = 0

Expand All @@ -70,46 +64,22 @@ class Worksheet implements Disposable {
*/
private canceller?: CancellationTokenSource = undefined

/**
* The edits that should be applied to this worksheet.
*
* This is used to ensure that the blank lines added to fit the output of the worksheet
* are inserted in the same order as the output arrived.
*/
private applyEdits: Promise<void> = Promise.resolve()

constructor(readonly document: vscode.TextDocument, readonly client: BaseLanguageClient) {
}

dispose() {
this.reset()
if (this.canceller) {
this.canceller.dispose()
this.canceller = undefined
}
this._onDidStateChange.dispose()
}

/** Remove all decorations, and resets this worksheet. */
/** Cancel any current run, remove all decorations, and resets this worksheet. */
private reset(): void {
this.cancel()

this.decorations.forEach(decoration => decoration.decorationType.dispose())
this.decorations = []
this.insertedLines = 0
this.decoratedLines.clear()
this.runVersion = -1
this.margin = this.longestLine() + 5
this.applyEdits = Promise.resolve()
}

/**
* Reset the "worksheet state" (margin and number of inserted lines), and
* return an array of TextEdit that remove the redundant blank lines that have
* been inserted by a previous run.
*/
prepareRun(): TextEdit[] {
const edits = this.removeRedundantBlankLinesEdits()
this.reset()
return edits
}

/** If this worksheet is currently being run, cancel the run. */
Expand All @@ -129,9 +99,7 @@ class Worksheet implements Disposable {

/** Display the output in the worksheet's editor. */
handleMessage(output: WorksheetPublishOutputParams, editor: vscode.TextEditor) {
this.applyEdits = this.applyEdits.then(() => {
this.displayAndSaveResult(output.line - 1, output.content, editor)
})
this.displayAndSaveResult(output.line - 1, output.content, editor)
}

/**
Expand All @@ -140,29 +108,22 @@ class Worksheet implements Disposable {
*/
run(): Promise<WorksheetRunResult> {
this.cancel()
this.reset()
const canceller = new CancellationTokenSource()
const token = canceller.token
// This ensures that isRunning() returns true.
this.canceller = canceller
this.canceller = canceller // This ensures that isRunning() returns true.

this._onDidStateChange.fire()

return new Promise<WorksheetRunResult>(resolve => {
const textEdits = this.prepareRun()
const edit = new vscode.WorkspaceEdit()
edit.set(this.document.uri, textEdits)
vscode.workspace.applyEdit(edit).then(editSucceeded => {
this.runVersion = this.document.version
if (editSucceeded && !token.isCancellationRequested)
resolve(vscode.window.withProgress({
location: ProgressLocation.Window,
title: "Running worksheet"
}, () => this.client.sendRequest(
WorksheetRunRequest.type, asWorksheetRunParams(this.document), token
)))
else
resolve({ success: false })
})
this.runVersion = this.document.version
resolve(
vscode.window.withProgress({
location: ProgressLocation.Window,
title: "Running worksheet"
}, () => this.client.sendRequest(
WorksheetRunRequest.type, asWorksheetRunParams(this.document), token
)))
}).then(result => {
canceller.dispose()
if (this.canceller === canceller) { // If false, a new run has already started
Expand All @@ -181,43 +142,25 @@ class Worksheet implements Disposable {
*
* @param lineNumber The number of the line in the source that produced the result.
* @param runResult The result itself.
* @param worksheet The worksheet that receives the result.
* @param editor The editor where to display the result.
* @return A `Promise` that will insert necessary lines to fit the output
* and display the decorations upon completion.
*/
public async displayAndSaveResult(lineNumber: number, runResult: string, editor: vscode.TextEditor): Promise<void> {
const resultLines = runResult.trim().split(/\r\n|\r|\n/g)

// The line where the next decoration should be put.
// It's the number of the line that produced the output, plus the number
// of lines that we've inserted so far.
let actualLine = lineNumber + this.insertedLines

// If the output has more than one line, we need to insert blank lines
// below the line that produced the output to fit the output.
const addNewLinesEdit = new vscode.WorkspaceEdit()
if (resultLines.length > 1) {
const linesToInsert = resultLines.length - 1
const editPos = new vscode.Position(actualLine + 1, 0) // add after the line
addNewLinesEdit.insert(editor.document.uri, editPos, "\n".repeat(linesToInsert))
this.insertedLines += linesToInsert
// Increase the `runVersion`, because the text edit will increase the document's version
this.runVersion += 1
}
private displayAndSaveResult(lineNumber: number, runResult: string, editor: vscode.TextEditor): void {
const resultLines = runResult.split(/\r\n|\r|\n/g)

await vscode.workspace.applyEdit(addNewLinesEdit);
for (let line of resultLines) {
const decorationPosition = new vscode.Position(actualLine, 0);
const decorationMargin = this.margin - editor.document.lineAt(actualLine).text.length;
const decorationType = this.createDecoration(decorationMargin, line);
const decorationOptions = { range: new vscode.Range(decorationPosition, decorationPosition), hoverMessage: line };
const decoration = new Decoration(decorationType, decorationOptions);
this.decoratedLines.add(actualLine);
this.decorations.push(decoration);
editor.setDecorations(decorationType, [decorationOptions]);
actualLine += 1;
if (resultLines.length == 0)
return

const line = editor.document.lineAt(lineNumber)
const decorationOptions = {
range: line.range,
hoverMessage: new vscode.MarkdownString().appendCodeblock(runResult)
}
const decorationMargin = this.margin - line.text.length
const decorationText = resultLines[0] + (resultLines.length > 1 ? `<${resultLines.length - 1} lines hidden>` : "")
const decorationType = this.createDecoration(decorationMargin, decorationText)
const decoration = new Decoration(decorationType, decorationOptions)
this.decorations.push(decoration)
editor.setDecorations(decorationType, [decorationOptions])
}

/**
Expand All @@ -226,7 +169,7 @@ class Worksheet implements Disposable {
*
* @param editor The editor where to display the decorations.
*/
public restoreDecorations(editor: vscode.TextEditor) {
restoreDecorations(editor: vscode.TextEditor) {
if (editor.document.version == this.runVersion) {
this.decorations.forEach(decoration => {
editor.setDecorations(decoration.decorationType, [decoration.decorationOptions])
Expand Down Expand Up @@ -274,59 +217,6 @@ class Worksheet implements Disposable {

return maxLength
}

/**
* TextEdits to remove the repeated blank lines in the source.
*
* Running a worksheet can insert new lines in the worksheet so that the
* output of a line fits below the line. Before a run, we remove blank
* lines in the worksheet to keep its length under control.
*
* @param worksheet The worksheet where blank lines must be removed.
* @return An array of `TextEdit` that remove the blank lines.
*/
private removeRedundantBlankLinesEdits(): TextEdit[] {

const document = this.document
const lineCount = document.lineCount
let rangesToRemove: vscode.Range[] = []
let rangeStart = 0
let rangeEnd = 0
let inRange = true

function addRange() {
inRange = false
if (rangeStart < rangeEnd) {
rangesToRemove.push(new vscode.Range(rangeStart, 0, rangeEnd, 0))
}
return
}

for (let i = 0; i < lineCount; ++i) {
const isEmpty = document.lineAt(i).isEmptyOrWhitespace && this.hasDecoration(i)
if (inRange) {
if (isEmpty) rangeEnd += 1
else addRange()
} else {
if (isEmpty) {
rangeStart = i
rangeEnd = i + 1
inRange = true
}
}
}

if (inRange) {
rangeEnd = lineCount
addRange()
}

return rangesToRemove.reverse().map(range => vscode.TextEdit.delete(range))
}

private hasDecoration(line: number): boolean {
return this.decoratedLines.has(line)
}
}

export class WorksheetProvider implements Disposable {
Expand All @@ -347,17 +237,14 @@ export class WorksheetProvider implements Disposable {
vscode.workspace.onWillSaveTextDocument(event => {
const document = event.document
const worksheet = this.worksheetFor(document)
if (worksheet) {
event.waitUntil(Promise.resolve(worksheet.prepareRun()))
// If the document is not dirty, then `onDidSaveTextDocument` will not
// be called so we need to run the worksheet now.
// On the other hand, if the document _is_ dirty, we should _not_ run
// the worksheet now because the server state will not be synchronized
// with the client state, instead we let `onDidSaveTextDocument`
// handle it.
if (runWorksheetOnSave() && !document.isDirty) {
worksheet.run()
}
// If the document is not dirty, then `onDidSaveTextDocument` will not
// be called so we need to run the worksheet now.
// On the other hand, if the document _is_ dirty, we should _not_ run
// the worksheet now because the server state will not be synchronized
// with the client state, instead we let `onDidSaveTextDocument`
// handle it.
if (worksheet && runWorksheetOnSave() && !document.isDirty) {
worksheet.run()
}
}),
vscode.workspace.onDidSaveTextDocument(document => {
Expand Down