Hat snapshots #318
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| import * as vscode from "vscode"; | ||
| import { addDecorationsToEditors } from "../util/addDecorationsToEditor"; | ||
| import { DECORATION_DEBOUNCE_DELAY } from "../core/constants"; | ||
| import { Graph } from "../typings/Types"; | ||
| import { Disposable } from "vscode"; | ||
| import { IndividualHatMap } from "./IndividualHatMap"; | ||
|
|
||
| interface Context { | ||
| getActiveMap(): Promise<IndividualHatMap>; | ||
| } | ||
|
|
||
| export class HatAllocator { | ||
| private timeoutHandle: NodeJS.Timeout | null = null; | ||
| private isActive: boolean; | ||
| private disposables: Disposable[] = []; | ||
| private disposalFunctions: (() => void)[] = []; | ||
|
|
||
| constructor(private graph: Graph, private context: Context) { | ||
| graph.extensionContext.subscriptions.push(this); | ||
|
|
||
| this.isActive = vscode.workspace | ||
| .getConfiguration("cursorless") | ||
| .get<boolean>("showOnStart")!; | ||
|
|
||
| this.addDecorationsDebounced = this.addDecorationsDebounced.bind(this); | ||
| this.toggleDecorations = this.toggleDecorations.bind(this); | ||
| this.clearEditorDecorations = this.clearEditorDecorations.bind(this); | ||
|
|
||
| this.disposalFunctions.push( | ||
| graph.decorations.registerDecorationChangeListener( | ||
| this.addDecorationsDebounced | ||
| ) | ||
| ); | ||
|
|
||
| this.disposables.push( | ||
| vscode.commands.registerCommand( | ||
| "cursorless.toggleDecorations", | ||
| this.toggleDecorations | ||
| ), | ||
|
|
||
| vscode.window.onDidChangeTextEditorVisibleRanges( | ||
| this.addDecorationsDebounced | ||
| ), | ||
| vscode.window.onDidChangeActiveTextEditor(this.addDecorationsDebounced), | ||
| vscode.window.onDidChangeVisibleTextEditors(this.addDecorationsDebounced), | ||
| vscode.window.onDidChangeTextEditorSelection( | ||
| this.addDecorationsDebounced | ||
| ), | ||
| vscode.workspace.onDidChangeTextDocument(this.addDecorationsDebounced) | ||
| ); | ||
| } | ||
|
|
||
| private clearEditorDecorations(editor: vscode.TextEditor) { | ||
| this.graph.decorations.decorations.forEach(({ decoration }) => { | ||
| editor.setDecorations(decoration, []); | ||
| }); | ||
| } | ||
|
|
||
| async addDecorations() { | ||
| const activeMap = await this.context.getActiveMap(); | ||
|
|
||
| if (this.isActive) { | ||
| addDecorationsToEditors(activeMap, this.graph.decorations); | ||
| } else { | ||
| vscode.window.visibleTextEditors.forEach(this.clearEditorDecorations); | ||
| activeMap.clear(); | ||
| } | ||
| } | ||
|
|
||
| addDecorationsDebounced() { | ||
| if (this.timeoutHandle != null) { | ||
| clearTimeout(this.timeoutHandle); | ||
| } | ||
|
|
||
| this.timeoutHandle = setTimeout(() => { | ||
| this.addDecorations(); | ||
|
|
||
| this.timeoutHandle = null; | ||
| }, DECORATION_DEBOUNCE_DELAY); | ||
| } | ||
|
|
||
| private toggleDecorations() { | ||
| this.isActive = !this.isActive; | ||
| this.addDecorationsDebounced(); | ||
| } | ||
|
|
||
| dispose() { | ||
| this.disposables.forEach(({ dispose }) => dispose()); | ||
| this.disposalFunctions.forEach((dispose) => dispose()); | ||
|
|
||
| if (this.timeoutHandle != null) { | ||
| clearTimeout(this.timeoutHandle); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| import { HatStyleName } from "./constants"; | ||
| import { Graph } from "../typings/Types"; | ||
| import { IndividualHatMap, ReadOnlyHatMap } from "./IndividualHatMap"; | ||
| import { HatAllocator } from "./HatAllocator"; | ||
| import { hrtime } from "process"; | ||
| import { abs } from "../util/bigint"; | ||
|
|
||
| /** | ||
| * Maximum age for the pre-phrase snapshot before we consider it to be stale | ||
| */ | ||
| const PRE_PHRASE_SNAPSHOT_MAX_AGE_NS = BigInt(6e10); // 60 seconds | ||
|
|
||
| /** | ||
| * Maps from (hatStyle, character) pairs to tokens | ||
| */ | ||
| export default class HatTokenMap { | ||
| /** | ||
| * This is the active map the changes every time we reallocate hats. It is | ||
| * liable to change in the middle of a phrase. | ||
| */ | ||
| private activeMap: IndividualHatMap; | ||
|
|
||
| /** | ||
| * This is a snapshot of the hat map that remains stable over the course of a | ||
| * phrase. Ranges will be updated to account for changes to the document, but a | ||
| * hat with the same color and shape will refer to the same logical range. | ||
| */ | ||
| private prePhraseMapSnapshot?: IndividualHatMap; | ||
| private prePhraseMapsSnapshotTimestamp: bigint | null = null; | ||
|
|
||
| private lastSignalVersion: string | null = null; | ||
| private hatAllocator: HatAllocator; | ||
|
|
||
| constructor(private graph: Graph) { | ||
| graph.extensionContext.subscriptions.push(this); | ||
| this.activeMap = new IndividualHatMap(graph); | ||
|
|
||
| this.getActiveMap = this.getActiveMap.bind(this); | ||
|
|
||
| this.hatAllocator = new HatAllocator(graph, { | ||
| getActiveMap: this.getActiveMap, | ||
| }); | ||
| } | ||
|
|
||
| init() { | ||
| return this.hatAllocator.addDecorations(); | ||
| } | ||
|
|
||
| addDecorations() { | ||
| return this.hatAllocator.addDecorations(); | ||
| } | ||
|
|
||
| static getKey(hatStyle: HatStyleName, character: string) { | ||
| return `${hatStyle}.${character}`; | ||
| } | ||
|
|
||
| static splitKey(key: string) { | ||
| let [hatStyle, character] = key.split("."); | ||
| if (character.length === 0) { | ||
| // If the character is `.` then it will appear as a zero length string | ||
| // due to the way the split on `.` works | ||
| character = "."; | ||
| } | ||
| return { hatStyle: hatStyle as HatStyleName, character }; | ||
| } | ||
|
|
||
| private async getActiveMap() { | ||
| // NB: We need to take a snapshot of the hat map before we make any | ||
| // modifications if it is the beginning of the phrase | ||
| await this.maybeTakePrePhraseSnapshot(); | ||
|
|
||
| return this.activeMap; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a transient, read-only hat map for use during the course of a | ||
| * single command. | ||
| * | ||
| * Please do not hold onto this copy beyond the lifetime of a single command, | ||
| * because it will get stale. | ||
| * @param usePrePhraseSnapshot Whether to use pre-phrase snapshot | ||
| * @returns A readable snapshot of the map | ||
| */ | ||
| async getReadableMap(usePrePhraseSnapshot: boolean): Promise<ReadOnlyHatMap> { | ||
| // NB: Take a snapshot before we return the map if it is the beginning of | ||
| // the phrase so all commands will get the same map over the course of the | ||
| // phrase | ||
| await this.maybeTakePrePhraseSnapshot(); | ||
|
|
||
| if (usePrePhraseSnapshot) { | ||
| if (this.lastSignalVersion == null) { | ||
| console.error( | ||
| "Pre phrase snapshot requested but no signal was present; please upgrade command client" | ||
| ); | ||
| return this.activeMap; | ||
| } | ||
|
|
||
| if (this.prePhraseMapSnapshot == null) { | ||
| console.error( | ||
| "Navigation map pre-phrase snapshot requested, but no snapshot has been taken" | ||
| ); | ||
| return this.activeMap; | ||
| } | ||
|
|
||
| if ( | ||
| abs(hrtime.bigint() - this.prePhraseMapsSnapshotTimestamp!) > | ||
| PRE_PHRASE_SNAPSHOT_MAX_AGE_NS | ||
| ) { | ||
| console.error( | ||
| "Navigation map pre-phrase snapshot requested, but snapshot is more than a minute old" | ||
| ); | ||
| return this.activeMap; | ||
| } | ||
|
|
||
| return this.prePhraseMapSnapshot; | ||
| } | ||
|
|
||
| return this.activeMap; | ||
| } | ||
|
|
||
| public dispose() { | ||
| this.activeMap.dispose(); | ||
|
|
||
| if (this.prePhraseMapSnapshot != null) { | ||
| this.prePhraseMapSnapshot.dispose(); | ||
| } | ||
| } | ||
|
|
||
| private async maybeTakePrePhraseSnapshot() { | ||
| const phraseStartSignal = this.graph.commandServerApi?.signals?.prePhrase; | ||
|
|
||
| if (phraseStartSignal != null) { | ||
| const newSignalVersion = await phraseStartSignal.getVersion(); | ||
|
|
||
| if (newSignalVersion !== this.lastSignalVersion) { | ||
| console.debug("taking snapshot"); | ||
| this.lastSignalVersion = newSignalVersion; | ||
|
|
||
| if (newSignalVersion != null) { | ||
| this.takePrePhraseSnapshot(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private takePrePhraseSnapshot() { | ||
| if (this.prePhraseMapSnapshot != null) { | ||
| this.prePhraseMapSnapshot.dispose(); | ||
| } | ||
|
|
||
| this.prePhraseMapSnapshot = this.activeMap.clone(); | ||
| this.prePhraseMapsSnapshotTimestamp = hrtime.bigint(); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with local unit testing, where this variable is set by
launch.json