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.

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

editor: introduce anchor selection #97912

Merged
merged 2 commits into from
May 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions src/vs/editor/contrib/anchorSelect/anchorSelect.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

.monaco-editor .selection-anchor {
background-color: #007ACC;
width: 2px !important;
}
176 changes: 176 additions & 0 deletions src/vs/editor/contrib/anchorSelect/anchorSelect.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

import 'vs/css!./anchorSelect';
import { EditorAction, ServicesAccessor, registerEditorAction, registerEditorContribution } from 'vs/editor/browser/editorExtensions';
import { localize } from 'vs/nls';
import { EditorContextKeys } from 'vs/editor/common/editorContextKeys';
import { Selection } from 'vs/editor/common/core/selection';
import { KeyMod, KeyCode, KeyChord } from 'vs/base/common/keyCodes';
import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry';
import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
import { RawContextKey, IContextKeyService, IContextKey } from 'vs/platform/contextkey/common/contextkey';
import { IEditorContribution } from 'vs/editor/common/editorCommon';
import { TrackedRangeStickiness } from 'vs/editor/common/model';
import { MarkdownString } from 'vs/base/common/htmlContent';
import { IDisposable } from 'vs/base/common/lifecycle';

export const SelectionAnchorSet = new RawContextKey('selectionAnchorSet', false);

class SelectionAnchorController implements IEditorContribution {

public static readonly ID = 'editor.contrib.selectionAnchorController';

static get(editor: ICodeEditor): SelectionAnchorController {
return editor.getContribution<SelectionAnchorController>(SelectionAnchorController.ID);
}

private decorationId: string | undefined;
private selectionAnchorSetContextKey: IContextKey<boolean>;
private modelChangeListener: IDisposable;

constructor(
private editor: ICodeEditor,
@IContextKeyService contextKeyService: IContextKeyService
) {
this.selectionAnchorSetContextKey = SelectionAnchorSet.bindTo(contextKeyService);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should also listen to editor.onDidChangeModel and reset the context key if the editor gets a new model set.

this.modelChangeListener = editor.onDidChangeModel(() => this.selectionAnchorSetContextKey.reset());
}

setSelectionAnchor(): void {
if (this.editor.hasModel()) {
const position = this.editor.getPosition();
const previousDecorations = this.decorationId ? [this.decorationId] : [];
const newDecorationId = this.editor.deltaDecorations(previousDecorations, [{
range: Selection.fromPositions(position, position),
options: {
stickiness: TrackedRangeStickiness.NeverGrowsWhenTypingAtEdges,
hoverMessage: new MarkdownString().appendText(localize('selectionAnchor', "Selection Anchor")),
className: 'selection-anchor'
}
}]);
this.decorationId = newDecorationId[0];
this.selectionAnchorSetContextKey.set(!!this.decorationId);
}
}

goToSelectionAnchor(): void {
if (this.editor.hasModel() && this.decorationId) {
const anchorPosition = this.editor.getModel().getDecorationRange(this.decorationId);
if (anchorPosition) {
this.editor.setPosition(anchorPosition.getStartPosition());
}
}
}

selectFromAnchorToCursor(): void {
if (this.editor.hasModel() && this.decorationId) {
const start = this.editor.getModel().getDecorationRange(this.decorationId);
if (start) {
const end = this.editor.getPosition();
this.editor.setSelection(Selection.fromPositions(start.getStartPosition(), end));
this.cancelSelectionAnchor();
}
}
}

cancelSelectionAnchor(): void {
if (this.decorationId) {
this.editor.deltaDecorations([this.decorationId], []);
this.decorationId = undefined;
this.selectionAnchorSetContextKey.set(false);
}
}

dispose(): void {
this.cancelSelectionAnchor();
this.modelChangeListener.dispose();
}
}

class SetSelectionAnchor extends EditorAction {
constructor() {
super({
id: 'editor.action.setSelectionAnchor',
label: localize('setSelectionAnchor', "Set Selection Anchor"),
alias: 'Set Selection Anchor',
precondition: undefined,
kbOpts: {
kbExpr: EditorContextKeys.editorTextFocus,
primary: KeyChord(KeyMod.CtrlCmd | KeyCode.KEY_K, KeyMod.CtrlCmd | KeyCode.KEY_B),
weight: KeybindingWeight.EditorContrib
}
});
}

async run(_accessor: ServicesAccessor, editor: ICodeEditor): Promise<void> {
const controller = SelectionAnchorController.get(editor);
controller.setSelectionAnchor();
}
}

class GoToSelectionAnchor extends EditorAction {
constructor() {
super({
id: 'editor.action.goToSelectionAnchor',
label: localize('goToSelectionAnchor', "Go to Selection Anchor"),
alias: 'Go to Selection Anchor',
precondition: SelectionAnchorSet,
});
}

async run(_accessor: ServicesAccessor, editor: ICodeEditor): Promise<void> {
const controller = SelectionAnchorController.get(editor);
controller.goToSelectionAnchor();
}
}

class SelectFromAnchorToCursor extends EditorAction {
constructor() {
super({
id: 'editor.action.selectFromAnchorToCursor',
label: localize('selectFromAnchorToCursor', "Select from Anchor to Cursor"),
alias: 'Select from Anchor to Cursor',
precondition: SelectionAnchorSet,
kbOpts: {
kbExpr: EditorContextKeys.editorTextFocus,
primary: KeyChord(KeyMod.CtrlCmd | KeyCode.KEY_K, KeyMod.CtrlCmd | KeyCode.KEY_K),
weight: KeybindingWeight.EditorContrib
}
});
}

async run(_accessor: ServicesAccessor, editor: ICodeEditor): Promise<void> {
const controller = SelectionAnchorController.get(editor);
controller.selectFromAnchorToCursor();
}
}

class CancelSelectionAnchor extends EditorAction {
constructor() {
super({
id: 'editor.action.cancelSelectionAnchor',
label: localize('cancelSelectionAnchor', "Cancel Selection Anchor"),
alias: 'Cancel Selection Anchor',
precondition: SelectionAnchorSet,
kbOpts: {
kbExpr: EditorContextKeys.editorTextFocus,
primary: KeyCode.Escape,
weight: KeybindingWeight.EditorContrib
}
});
}

async run(_accessor: ServicesAccessor, editor: ICodeEditor): Promise<void> {
const controller = SelectionAnchorController.get(editor);
controller.cancelSelectionAnchor();
}
}

registerEditorContribution(SelectionAnchorController.ID, SelectionAnchorController);
registerEditorAction(SetSelectionAnchor);
registerEditorAction(GoToSelectionAnchor);
registerEditorAction(SelectFromAnchorToCursor);
registerEditorAction(CancelSelectionAnchor);
1 change: 1 addition & 0 deletions src/vs/editor/editor.all.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import 'vs/editor/browser/controller/coreCommands';
import 'vs/editor/browser/widget/codeEditorWidget';
import 'vs/editor/browser/widget/diffEditorWidget';
import 'vs/editor/browser/widget/diffNavigator';
import 'vs/editor/contrib/anchorSelect/anchorSelect';
import 'vs/editor/contrib/bracketMatching/bracketMatching';
import 'vs/editor/contrib/caretOperations/caretOperations';
import 'vs/editor/contrib/caretOperations/transpose';
Expand Down