Skip to content
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

Jump to bottom

play audio cues on cursor change in diff editors #171275

Merged
merged 2 commits into from Jan 13, 2023
Merged

play audio cues on cursor change in diff editors #171275

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
848988f
fix #171256
meganrogge Jan 13, 2023
c551a65
fix #171256
meganrogge Jan 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
48 changes: 36 additions & 12 deletions src/vs/editor/browser/widget/diffNavigator.ts
View file
Open in desktop
Expand Up @@ -14,6 +14,7 @@ import { ILineChange } from 'vs/editor/common/diff/smartLinesDiffComputer';
import { ScrollType } from 'vs/editor/common/editorCommon';
import { AudioCue, IAudioCueService } from 'vs/platform/audioCues/browser/audioCueService';
import { ICodeEditorService } from 'vs/editor/browser/services/codeEditorService';
import { IAccessibilityService } from 'vs/platform/accessibility/common/accessibility';


interface IDiffRange {
Expand Down Expand Up @@ -59,7 +60,13 @@ export class DiffNavigator extends Disposable implements IDiffNavigator {
private ranges: IDiffRange[];
private ignoreSelectionChange: boolean;

constructor(editor: IDiffEditor, options: Options = {}, @IAudioCueService private readonly _audioCueService: IAudioCueService, @ICodeEditorService private readonly _codeEditorService: ICodeEditorService) {
constructor(
editor: IDiffEditor,
options: Options = {},
@IAudioCueService private readonly _audioCueService: IAudioCueService,
@ICodeEditorService private readonly _codeEditorService: ICodeEditorService,
@IAccessibilityService private readonly _accessibilityService: IAccessibilityService
) {
super();
this._editor = editor;
this._options = objects.mixin(options, defaultOptions, false);
Expand All @@ -80,6 +87,7 @@ export class DiffNavigator extends Disposable implements IDiffNavigator {
if (this.ignoreSelectionChange) {
return;
}
this._updateAccessibilityState(e.position.lineNumber);
this.nextIdx = -1;
}));
}
Expand Down Expand Up @@ -210,22 +218,38 @@ export class DiffNavigator extends Disposable implements IDiffNavigator {
const pos = info.range.getStartPosition();
this._editor.setPosition(pos);
this._editor.revealRangeInCenter(info.range, scrollType);
const modifiedEditor = this._editor.getModel()?.modified;
if (!modifiedEditor) {
return;
}
const insertedOrModified = modifiedEditor.getLineDecorations(pos.lineNumber).find(l => l.options.className === 'line-insert');
this._audioCueService.playAudioCue(insertedOrModified ? AudioCue.diffLineModified : AudioCue.diffLineDeleted);
const codeEditor = this._codeEditorService.getActiveCodeEditor();
if (codeEditor && insertedOrModified) {
codeEditor.setSelection({ startLineNumber: pos.lineNumber, startColumn: 0, endLineNumber: pos.lineNumber, endColumn: Number.MAX_VALUE });
codeEditor.writeScreenReaderContent('diff-navigation');
}
this._updateAccessibilityState(pos.lineNumber, true);
} finally {
this.ignoreSelectionChange = false;
}
}

_updateAccessibilityState(lineNumber: number, jumpToChange?: boolean): void {
const modifiedEditor = this._editor.getModel()?.modified;
if (!modifiedEditor) {
return;
}
const insertedOrModified = modifiedEditor.getLineDecorations(lineNumber).find(l => l.options.className === 'line-insert');
if (insertedOrModified) {
this._audioCueService.playAudioCue(AudioCue.diffLineModified);
} else if (jumpToChange) {
// The modified editor does not include deleted lines, but when
// we are moved to the area where lines were deleted, play this cue
this._audioCueService.playAudioCue(AudioCue.diffLineDeleted);
} else {
return;
}

if (!jumpToChange || !insertedOrModified) {
return;
}
const codeEditor = this._codeEditorService.getActiveCodeEditor();
if (codeEditor && insertedOrModified && this._accessibilityService.isScreenReaderOptimized()) {
codeEditor.setSelection({ startLineNumber: lineNumber, startColumn: 0, endLineNumber: lineNumber, endColumn: Number.MAX_VALUE });
codeEditor.writeScreenReaderContent('diff-navigation');
}
}

canNavigate(): boolean {
return this.ranges && this.ranges.length > 0;
}
Expand Down