/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ 'use strict'; import { onUnexpectedError } from 'vs/base/common/errors'; import Event, { Emitter } from 'vs/base/common/event'; import { Disposable, IDisposable, dispose } from 'vs/base/common/lifecycle'; import { TPromise } from 'vs/base/common/winjs.base'; import { ServicesAccessor, IInstantiationService } from 'vs/platform/instantiation/common/instantiation'; import { ServiceCollection } from 'vs/platform/instantiation/common/serviceCollection'; import { IContextKey, IContextKeyServiceTarget, IContextKeyService } from 'vs/platform/contextkey/common/contextkey'; import { CommonEditorConfiguration } from 'vs/editor/common/config/commonEditorConfig'; import { Cursor, CursorStateChangedEvent } from 'vs/editor/common/controller/cursor'; import { CursorColumns, ICursors, CursorConfiguration } from 'vs/editor/common/controller/cursorCommon'; import { Position, IPosition } from 'vs/editor/common/core/position'; import { Range, IRange } from 'vs/editor/common/core/range'; import { Selection, ISelection } from 'vs/editor/common/core/selection'; import * as editorCommon from 'vs/editor/common/editorCommon'; import { ViewModel } from 'vs/editor/common/viewModel/viewModelImpl'; import { hash } from 'vs/base/common/hash'; import { IModelContentChangedEvent, IModelDecorationsChangedEvent, IModelLanguageChangedEvent, IModelOptionsChangedEvent, IModelLanguageConfigurationChangedEvent } from 'vs/editor/common/model/textModelEvents'; import * as editorOptions from 'vs/editor/common/config/editorOptions'; import { ICursorPositionChangedEvent, ICursorSelectionChangedEvent } from 'vs/editor/common/controller/cursorEvents'; import { EditorContextKeys } from 'vs/editor/common/editorContextKeys'; import { VerticalRevealType } from 'vs/editor/common/view/viewEvents'; import { ModelDecorationOptions } from 'vs/editor/common/model/textModel'; import { IEditorWhitespace } from 'vs/editor/common/viewLayout/whitespaceComputer'; import * as modes from 'vs/editor/common/modes'; import { Schemas } from 'vs/base/common/network'; import { ITextModel, EndOfLinePreference, IIdentifiedSingleEditOperation, IModelDecorationsChangeAccessor, IModelDecoration, IModelDeltaDecoration, IModelDecorationOptions } from 'vs/editor/common/model'; let EDITOR_ID = 0; export abstract class CommonCodeEditor extends Disposable { private readonly _onDidDispose: Emitter = this._register(new Emitter()); public readonly onDidDispose: Event = this._onDidDispose.event; private readonly _onDidChangeModelContent: Emitter = this._register(new Emitter()); public readonly onDidChangeModelContent: Event = this._onDidChangeModelContent.event; private readonly _onDidChangeModelLanguage: Emitter = this._register(new Emitter()); public readonly onDidChangeModelLanguage: Event = this._onDidChangeModelLanguage.event; private readonly _onDidChangeModelLanguageConfiguration: Emitter = this._register(new Emitter()); public readonly onDidChangeModelLanguageConfiguration: Event = this._onDidChangeModelLanguageConfiguration.event; private readonly _onDidChangeModelOptions: Emitter = this._register(new Emitter()); public readonly onDidChangeModelOptions: Event = this._onDidChangeModelOptions.event; private readonly _onDidChangeModelDecorations: Emitter = this._register(new Emitter()); public readonly onDidChangeModelDecorations: Event = this._onDidChangeModelDecorations.event; private readonly _onDidChangeConfiguration: Emitter = this._register(new Emitter()); public readonly onDidChangeConfiguration: Event = this._onDidChangeConfiguration.event; protected readonly _onDidChangeModel: Emitter = this._register(new Emitter()); public readonly onDidChangeModel: Event = this._onDidChangeModel.event; private readonly _onDidChangeCursorPosition: Emitter = this._register(new Emitter()); public readonly onDidChangeCursorPosition: Event = this._onDidChangeCursorPosition.event; private readonly _onDidChangeCursorSelection: Emitter = this._register(new Emitter()); public readonly onDidChangeCursorSelection: Event = this._onDidChangeCursorSelection.event; private readonly _onDidLayoutChange: Emitter = this._register(new Emitter()); public readonly onDidLayoutChange: Event = this._onDidLayoutChange.event; protected readonly _onDidFocusEditorText: Emitter = this._register(new Emitter()); public readonly onDidFocusEditorText: Event = this._onDidFocusEditorText.event; protected readonly _onDidBlurEditorText: Emitter = this._register(new Emitter()); public readonly onDidBlurEditorText: Event = this._onDidBlurEditorText.event; protected readonly _onDidFocusEditor: Emitter = this._register(new Emitter()); public readonly onDidFocusEditor: Event = this._onDidFocusEditor.event; protected readonly _onDidBlurEditor: Emitter = this._register(new Emitter()); public readonly onDidBlurEditor: Event = this._onDidBlurEditor.event; private readonly _onWillType: Emitter = this._register(new Emitter()); public readonly onWillType = this._onWillType.event; private readonly _onDidType: Emitter = this._register(new Emitter()); public readonly onDidType = this._onDidType.event; private readonly _onDidPaste: Emitter = this._register(new Emitter()); public readonly onDidPaste = this._onDidPaste.event; protected readonly domElement: IContextKeyServiceTarget; protected readonly id: number; protected readonly _configuration: CommonEditorConfiguration; protected _contributions: { [key: string]: editorCommon.IEditorContribution; }; protected _actions: { [key: string]: editorCommon.IEditorAction; }; // --- Members logically associated to a model protected model: ITextModel; protected listenersToRemove: IDisposable[]; protected hasView: boolean; protected viewModel: ViewModel; protected cursor: Cursor; protected readonly _instantiationService: IInstantiationService; protected readonly _contextKeyService: IContextKeyService; /** * map from "parent" decoration type to live decoration ids. */ private _decorationTypeKeysToIds: { [decorationTypeKey: string]: string[] }; private _decorationTypeSubtypes: { [decorationTypeKey: string]: { [subtype: string]: boolean } }; constructor( domElement: IContextKeyServiceTarget, options: editorOptions.IEditorOptions, instantiationService: IInstantiationService, contextKeyService: IContextKeyService ) { super(); this.domElement = domElement; this.id = (++EDITOR_ID); this._decorationTypeKeysToIds = {}; this._decorationTypeSubtypes = {}; options = options || {}; this._configuration = this._register(this._createConfiguration(options)); this._register(this._configuration.onDidChange((e) => { this._onDidChangeConfiguration.fire(e); if (e.layoutInfo) { this._onDidLayoutChange.fire(this._configuration.editor.layoutInfo); } })); this._contextKeyService = this._register(contextKeyService.createScoped(this.domElement)); this._register(new EditorContextKeysManager(this, this._contextKeyService)); this._register(new EditorModeContext(this, this._contextKeyService)); this._instantiationService = instantiationService.createChild(new ServiceCollection([IContextKeyService, this._contextKeyService])); this._attachModel(null); this._contributions = {}; this._actions = {}; } protected abstract _createConfiguration(options: editorOptions.IEditorOptions): CommonEditorConfiguration; public getId(): string { return this.getEditorType() + ':' + this.id; } public getEditorType(): string { return editorCommon.EditorType.ICodeEditor; } public dispose(): void { let keys = Object.keys(this._contributions); for (let i = 0, len = keys.length; i < len; i++) { let contributionId = keys[i]; this._contributions[contributionId].dispose(); } this._contributions = {}; // editor actions don't need to be disposed this._actions = {}; this._removeDecorationTypes(); this._postDetachModelCleanup(this._detachModel()); this._onDidDispose.fire(); super.dispose(); } public invokeWithinContext(fn: (accessor: ServicesAccessor) => T): T { return this._instantiationService.invokeFunction(fn); } public updateOptions(newOptions: editorOptions.IEditorOptions): void { this._configuration.updateOptions(newOptions); } public getConfiguration(): editorOptions.InternalEditorOptions { return this._configuration.editor; } public getRawConfiguration(): editorOptions.IEditorOptions { return this._configuration.getRawOptions(); } public getValue(options: { preserveBOM: boolean; lineEnding: string; } = null): string { if (this.model) { let preserveBOM: boolean = (options && options.preserveBOM) ? true : false; let eolPreference = EndOfLinePreference.TextDefined; if (options && options.lineEnding && options.lineEnding === '\n') { eolPreference = EndOfLinePreference.LF; } else if (options && options.lineEnding && options.lineEnding === '\r\n') { eolPreference = EndOfLinePreference.CRLF; } return this.model.getValue(eolPreference, preserveBOM); } return ''; } public setValue(newValue: string): void { if (this.model) { this.model.setValue(newValue); } } public getModel(): ITextModel { return this.model; } public setModel(model: ITextModel = null): void { if (this.model === model) { // Current model is the new model return; } let detachedModel = this._detachModel(); this._attachModel(model); let e: editorCommon.IModelChangedEvent = { oldModelUrl: detachedModel ? detachedModel.uri : null, newModelUrl: model ? model.uri : null }; this._removeDecorationTypes(); this._onDidChangeModel.fire(e); this._postDetachModelCleanup(detachedModel); } private _removeDecorationTypes(): void { this._decorationTypeKeysToIds = {}; if (this._decorationTypeSubtypes) { for (let decorationType in this._decorationTypeSubtypes) { let subTypes = this._decorationTypeSubtypes[decorationType]; for (let subType in subTypes) { this._removeDecorationType(decorationType + '-' + subType); } } this._decorationTypeSubtypes = {}; } } public getCenteredRangeInViewport(): Range { if (!this.hasView) { return null; } return this.viewModel.getCenteredRangeInViewport(); } public getWhitespaces(): IEditorWhitespace[] { if (!this.hasView) { return []; } return this.viewModel.viewLayout.getWhitespaces(); } protected _getVerticalOffsetForPosition(modelLineNumber: number, modelColumn: number): number { let modelPosition = this.model.validatePosition({ lineNumber: modelLineNumber, column: modelColumn }); let viewPosition = this.viewModel.coordinatesConverter.convertModelPositionToViewPosition(modelPosition); return this.viewModel.viewLayout.getVerticalOffsetForLineNumber(viewPosition.lineNumber); } public getTopForLineNumber(lineNumber: number): number { if (!this.hasView) { return -1; } return this._getVerticalOffsetForPosition(lineNumber, 1); } public getTopForPosition(lineNumber: number, column: number): number { if (!this.hasView) { return -1; } return this._getVerticalOffsetForPosition(lineNumber, column); } public setHiddenAreas(ranges: IRange[]): void { if (this.viewModel) { this.viewModel.setHiddenAreas(ranges.map(r => Range.lift(r))); } } public getVisibleColumnFromPosition(rawPosition: IPosition): number { if (!this.model) { return rawPosition.column; } let position = this.model.validatePosition(rawPosition); let tabSize = this.model.getOptions().tabSize; return CursorColumns.visibleColumnFromColumn(this.model.getLineContent(position.lineNumber), position.column, tabSize) + 1; } public getPosition(): Position { if (!this.cursor) { return null; } return this.cursor.getPosition().clone(); } public setPosition(position: IPosition): void { if (!this.cursor) { return; } if (!Position.isIPosition(position)) { throw new Error('Invalid arguments'); } this.cursor.setSelections('api', [{ selectionStartLineNumber: position.lineNumber, selectionStartColumn: position.column, positionLineNumber: position.lineNumber, positionColumn: position.column }]); } private _sendRevealRange(modelRange: Range, verticalType: VerticalRevealType, revealHorizontal: boolean, scrollType: editorCommon.ScrollType): void { if (!this.model || !this.cursor) { return; } if (!Range.isIRange(modelRange)) { throw new Error('Invalid arguments'); } const validatedModelRange = this.model.validateRange(modelRange); const viewRange = this.viewModel.coordinatesConverter.convertModelRangeToViewRange(validatedModelRange); this.cursor.emitCursorRevealRange(viewRange, verticalType, revealHorizontal, scrollType); } public revealLine(lineNumber: number, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealLine(lineNumber, VerticalRevealType.Simple, scrollType); } public revealLineInCenter(lineNumber: number, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealLine(lineNumber, VerticalRevealType.Center, scrollType); } public revealLineInCenterIfOutsideViewport(lineNumber: number, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealLine(lineNumber, VerticalRevealType.CenterIfOutsideViewport, scrollType); } private _revealLine(lineNumber: number, revealType: VerticalRevealType, scrollType: editorCommon.ScrollType): void { if (typeof lineNumber !== 'number') { throw new Error('Invalid arguments'); } this._sendRevealRange( new Range(lineNumber, 1, lineNumber, 1), revealType, false, scrollType ); } public revealPosition(position: IPosition, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealPosition( position, VerticalRevealType.Simple, true, scrollType ); } public revealPositionInCenter(position: IPosition, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealPosition( position, VerticalRevealType.Center, true, scrollType ); } public revealPositionInCenterIfOutsideViewport(position: IPosition, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealPosition( position, VerticalRevealType.CenterIfOutsideViewport, true, scrollType ); } private _revealPosition(position: IPosition, verticalType: VerticalRevealType, revealHorizontal: boolean, scrollType: editorCommon.ScrollType): void { if (!Position.isIPosition(position)) { throw new Error('Invalid arguments'); } this._sendRevealRange( new Range(position.lineNumber, position.column, position.lineNumber, position.column), verticalType, revealHorizontal, scrollType ); } public getSelection(): Selection { if (!this.cursor) { return null; } return this.cursor.getSelection().clone(); } public getSelections(): Selection[] { if (!this.cursor) { return null; } let selections = this.cursor.getSelections(); let result: Selection[] = []; for (let i = 0, len = selections.length; i < len; i++) { result[i] = selections[i].clone(); } return result; } public setSelection(range: IRange): void; public setSelection(editorRange: Range): void; public setSelection(selection: ISelection): void; public setSelection(editorSelection: Selection): void; public setSelection(something: any): void { let isSelection = Selection.isISelection(something); let isRange = Range.isIRange(something); if (!isSelection && !isRange) { throw new Error('Invalid arguments'); } if (isSelection) { this._setSelectionImpl(something); } else if (isRange) { // act as if it was an IRange let selection: ISelection = { selectionStartLineNumber: something.startLineNumber, selectionStartColumn: something.startColumn, positionLineNumber: something.endLineNumber, positionColumn: something.endColumn }; this._setSelectionImpl(selection); } } private _setSelectionImpl(sel: ISelection): void { if (!this.cursor) { return; } let selection = new Selection(sel.selectionStartLineNumber, sel.selectionStartColumn, sel.positionLineNumber, sel.positionColumn); this.cursor.setSelections('api', [selection]); } public revealLines(startLineNumber: number, endLineNumber: number, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealLines( startLineNumber, endLineNumber, VerticalRevealType.Simple, scrollType ); } public revealLinesInCenter(startLineNumber: number, endLineNumber: number, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealLines( startLineNumber, endLineNumber, VerticalRevealType.Center, scrollType ); } public revealLinesInCenterIfOutsideViewport(startLineNumber: number, endLineNumber: number, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealLines( startLineNumber, endLineNumber, VerticalRevealType.CenterIfOutsideViewport, scrollType ); } private _revealLines(startLineNumber: number, endLineNumber: number, verticalType: VerticalRevealType, scrollType: editorCommon.ScrollType): void { if (typeof startLineNumber !== 'number' || typeof endLineNumber !== 'number') { throw new Error('Invalid arguments'); } this._sendRevealRange( new Range(startLineNumber, 1, endLineNumber, 1), verticalType, false, scrollType ); } public revealRange(range: IRange, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth, revealVerticalInCenter: boolean = false, revealHorizontal: boolean = true): void { this._revealRange( range, revealVerticalInCenter ? VerticalRevealType.Center : VerticalRevealType.Simple, revealHorizontal, scrollType ); } public revealRangeInCenter(range: IRange, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealRange( range, VerticalRevealType.Center, true, scrollType ); } public revealRangeInCenterIfOutsideViewport(range: IRange, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealRange( range, VerticalRevealType.CenterIfOutsideViewport, true, scrollType ); } public revealRangeAtTop(range: IRange, scrollType: editorCommon.ScrollType = editorCommon.ScrollType.Smooth): void { this._revealRange( range, VerticalRevealType.Top, true, scrollType ); } private _revealRange(range: IRange, verticalType: VerticalRevealType, revealHorizontal: boolean, scrollType: editorCommon.ScrollType): void { if (!Range.isIRange(range)) { throw new Error('Invalid arguments'); } this._sendRevealRange( Range.lift(range), verticalType, revealHorizontal, scrollType ); } public setSelections(ranges: ISelection[]): void { if (!this.cursor) { return; } if (!ranges || ranges.length === 0) { throw new Error('Invalid arguments'); } for (let i = 0, len = ranges.length; i < len; i++) { if (!Selection.isISelection(ranges[i])) { throw new Error('Invalid arguments'); } } this.cursor.setSelections('api', ranges); } public getScrollWidth(): number { if (!this.hasView) { return -1; } return this.viewModel.viewLayout.getScrollWidth(); } public getScrollLeft(): number { if (!this.hasView) { return -1; } return this.viewModel.viewLayout.getCurrentScrollLeft(); } public getScrollHeight(): number { if (!this.hasView) { return -1; } return this.viewModel.viewLayout.getScrollHeight(); } public getScrollTop(): number { if (!this.hasView) { return -1; } return this.viewModel.viewLayout.getCurrentScrollTop(); } public setScrollLeft(newScrollLeft: number): void { if (!this.hasView) { return; } if (typeof newScrollLeft !== 'number') { throw new Error('Invalid arguments'); } this.viewModel.viewLayout.setScrollPositionNow({ scrollLeft: newScrollLeft }); } public setScrollTop(newScrollTop: number): void { if (!this.hasView) { return; } if (typeof newScrollTop !== 'number') { throw new Error('Invalid arguments'); } this.viewModel.viewLayout.setScrollPositionNow({ scrollTop: newScrollTop }); } public setScrollPosition(position: editorCommon.INewScrollPosition): void { if (!this.hasView) { return; } this.viewModel.viewLayout.setScrollPositionNow(position); } public saveViewState(): editorCommon.ICodeEditorViewState { if (!this.cursor || !this.hasView) { return null; } let contributionsState: { [key: string]: any } = {}; let keys = Object.keys(this._contributions); for (let i = 0, len = keys.length; i < len; i++) { let id = keys[i]; let contribution = this._contributions[id]; if (typeof contribution.saveViewState === 'function') { contributionsState[id] = contribution.saveViewState(); } } let cursorState = this.cursor.saveState(); let viewState = this.viewModel.viewLayout.saveState(); return { cursorState: cursorState, viewState: viewState, contributionsState: contributionsState }; } public restoreViewState(s: editorCommon.ICodeEditorViewState): void { if (!this.cursor || !this.hasView) { return; } if (s && s.cursorState && s.viewState) { let codeEditorState = s; let cursorState = codeEditorState.cursorState; if (Array.isArray(cursorState)) { this.cursor.restoreState(cursorState); } else { // Backwards compatibility this.cursor.restoreState([cursorState]); } let contributionsState = s.contributionsState || {}; let keys = Object.keys(this._contributions); for (let i = 0, len = keys.length; i < len; i++) { let id = keys[i]; let contribution = this._contributions[id]; if (typeof contribution.restoreViewState === 'function') { contribution.restoreViewState(contributionsState[id]); } } } } public onVisible(): void { } public onHide(): void { } public abstract layout(dimension?: editorCommon.IDimension): void; public abstract focus(): void; public abstract isFocused(): boolean; public abstract hasWidgetFocus(): boolean; public getContribution(id: string): T { return (this._contributions[id] || null); } public getActions(): editorCommon.IEditorAction[] { let result: editorCommon.IEditorAction[] = []; let keys = Object.keys(this._actions); for (let i = 0, len = keys.length; i < len; i++) { let id = keys[i]; result.push(this._actions[id]); } return result; } public getSupportedActions(): editorCommon.IEditorAction[] { let result = this.getActions(); result = result.filter(action => action.isSupported()); return result; } public getAction(id: string): editorCommon.IEditorAction { return this._actions[id] || null; } public trigger(source: string, handlerId: string, payload: any): void { payload = payload || {}; // Special case for typing if (handlerId === editorCommon.Handler.Type) { if (!this.cursor || typeof payload.text !== 'string' || payload.text.length === 0) { // nothing to do return; } if (source === 'keyboard') { this._onWillType.fire(payload.text); } this.cursor.trigger(source, handlerId, payload); if (source === 'keyboard') { this._onDidType.fire(payload.text); } return; } // Special case for pasting if (handlerId === editorCommon.Handler.Paste) { if (!this.cursor || typeof payload.text !== 'string' || payload.text.length === 0) { // nothing to do return; } const startPosition = this.cursor.getSelection().getStartPosition(); this.cursor.trigger(source, handlerId, payload); const endPosition = this.cursor.getSelection().getStartPosition(); if (source === 'keyboard') { this._onDidPaste.fire( new Range(startPosition.lineNumber, startPosition.column, endPosition.lineNumber, endPosition.column) ); } return; } const action = this.getAction(handlerId); if (action) { TPromise.as(action.run()).then(null, onUnexpectedError); return; } if (!this.cursor) { return; } if (this._triggerEditorCommand(source, handlerId, payload)) { return; } this.cursor.trigger(source, handlerId, payload); } protected abstract _triggerEditorCommand(source: string, handlerId: string, payload: any): boolean; public _getCursors(): ICursors { return this.cursor; } public _getCursorConfiguration(): CursorConfiguration { return this.cursor.context.config; } public pushUndoStop(): boolean { if (!this.model) { return false; } if (this._configuration.editor.readOnly) { // read only editor => sorry! return false; } this.model.pushStackElement(); return true; } public executeEdits(source: string, edits: IIdentifiedSingleEditOperation[], endCursorState?: Selection[]): boolean { if (!this.cursor) { // no view, no cursor return false; } if (this._configuration.editor.readOnly) { // read only editor => sorry! return false; } this.model.pushEditOperations(this.cursor.getSelections(), edits, () => { return endCursorState ? endCursorState : this.cursor.getSelections(); }); if (endCursorState) { this.cursor.setSelections(source, endCursorState); } return true; } public executeCommand(source: string, command: editorCommon.ICommand): void { if (!this.cursor) { return; } this.cursor.trigger(source, editorCommon.Handler.ExecuteCommand, command); } public executeCommands(source: string, commands: editorCommon.ICommand[]): void { if (!this.cursor) { return; } this.cursor.trigger(source, editorCommon.Handler.ExecuteCommands, commands); } public changeDecorations(callback: (changeAccessor: IModelDecorationsChangeAccessor) => any): any { if (!this.model) { // console.warn('Cannot change decorations on editor that is not attached to a model'); // callback will not be called return null; } return this.model.changeDecorations(callback, this.id); } public getLineDecorations(lineNumber: number): IModelDecoration[] { if (!this.model) { return null; } return this.model.getLineDecorations(lineNumber, this.id, this._configuration.editor.readOnly); } public deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[] { if (!this.model) { return []; } if (oldDecorations.length === 0 && newDecorations.length === 0) { return oldDecorations; } return this.model.deltaDecorations(oldDecorations, newDecorations, this.id); } public setDecorations(decorationTypeKey: string, decorationOptions: editorCommon.IDecorationOptions[]): void { let newDecorationsSubTypes: { [key: string]: boolean } = {}; let oldDecorationsSubTypes = this._decorationTypeSubtypes[decorationTypeKey] || {}; this._decorationTypeSubtypes[decorationTypeKey] = newDecorationsSubTypes; let newModelDecorations: IModelDeltaDecoration[] = []; for (let decorationOption of decorationOptions) { let typeKey = decorationTypeKey; if (decorationOption.renderOptions) { // identify custom reder options by a hash code over all keys and values // For custom render options register a decoration type if necessary let subType = hash(decorationOption.renderOptions).toString(16); // The fact that `decorationTypeKey` appears in the typeKey has no influence // it is just a mechanism to get predictable and unique keys (repeatable for the same options and unique across clients) typeKey = decorationTypeKey + '-' + subType; if (!oldDecorationsSubTypes[subType] && !newDecorationsSubTypes[subType]) { // decoration type did not exist before, register new one this._registerDecorationType(typeKey, decorationOption.renderOptions, decorationTypeKey); } newDecorationsSubTypes[subType] = true; } let opts = this._resolveDecorationOptions(typeKey, !!decorationOption.hoverMessage); if (decorationOption.hoverMessage) { opts.hoverMessage = decorationOption.hoverMessage; } newModelDecorations.push({ range: decorationOption.range, options: opts }); } // remove decoration sub types that are no longer used, deregister decoration type if necessary for (let subType in oldDecorationsSubTypes) { if (!newDecorationsSubTypes[subType]) { this._removeDecorationType(decorationTypeKey + '-' + subType); } } // update all decorations let oldDecorationsIds = this._decorationTypeKeysToIds[decorationTypeKey] || []; this._decorationTypeKeysToIds[decorationTypeKey] = this.deltaDecorations(oldDecorationsIds, newModelDecorations); } public setDecorationsFast(decorationTypeKey: string, ranges: IRange[]): void { // remove decoration sub types that are no longer used, deregister decoration type if necessary let oldDecorationsSubTypes = this._decorationTypeSubtypes[decorationTypeKey] || {}; for (let subType in oldDecorationsSubTypes) { this._removeDecorationType(decorationTypeKey + '-' + subType); } this._decorationTypeSubtypes[decorationTypeKey] = {}; const opts = ModelDecorationOptions.createDynamic(this._resolveDecorationOptions(decorationTypeKey, false)); let newModelDecorations: IModelDeltaDecoration[] = new Array(ranges.length); for (let i = 0, len = ranges.length; i < len; i++) { newModelDecorations[i] = { range: ranges[i], options: opts }; } // update all decorations let oldDecorationsIds = this._decorationTypeKeysToIds[decorationTypeKey] || []; this._decorationTypeKeysToIds[decorationTypeKey] = this.deltaDecorations(oldDecorationsIds, newModelDecorations); } public removeDecorations(decorationTypeKey: string): void { // remove decorations for type and sub type let oldDecorationsIds = this._decorationTypeKeysToIds[decorationTypeKey]; if (oldDecorationsIds) { this.deltaDecorations(oldDecorationsIds, []); } if (this._decorationTypeKeysToIds.hasOwnProperty(decorationTypeKey)) { delete this._decorationTypeKeysToIds[decorationTypeKey]; } if (this._decorationTypeSubtypes.hasOwnProperty(decorationTypeKey)) { delete this._decorationTypeSubtypes[decorationTypeKey]; } } public getLayoutInfo(): editorOptions.EditorLayoutInfo { return this._configuration.editor.layoutInfo; } protected _attachModel(model: ITextModel): void { this.model = model ? model : null; this.listenersToRemove = []; this.viewModel = null; this.cursor = null; if (this.model) { this.domElement.setAttribute('data-mode-id', this.model.getLanguageIdentifier().language); this._configuration.setIsDominatedByLongLines(this.model.isDominatedByLongLines()); this._configuration.setMaxLineNumber(this.model.getLineCount()); this.model.onBeforeAttached(); this.viewModel = new ViewModel(this.id, this._configuration, this.model, (callback) => this._scheduleAtNextAnimationFrame(callback)); this.listenersToRemove.push(this.model.onDidChangeDecorations((e) => this._onDidChangeModelDecorations.fire(e))); this.listenersToRemove.push(this.model.onDidChangeLanguage((e) => { if (!this.model) { return; } this.domElement.setAttribute('data-mode-id', this.model.getLanguageIdentifier().language); this._onDidChangeModelLanguage.fire(e); })); this.listenersToRemove.push(this.model.onDidChangeLanguageConfiguration((e) => this._onDidChangeModelLanguageConfiguration.fire(e))); this.listenersToRemove.push(this.model.onDidChangeContent((e) => this._onDidChangeModelContent.fire(e))); this.listenersToRemove.push(this.model.onDidChangeOptions((e) => this._onDidChangeModelOptions.fire(e))); // Someone might destroy the model from under the editor, so prevent any exceptions by setting a null model this.listenersToRemove.push(this.model.onWillDispose(() => this.setModel(null))); this.cursor = new Cursor( this._configuration, this.model, this.viewModel ); this._createView(); this.listenersToRemove.push(this.cursor.onDidChange((e: CursorStateChangedEvent) => { let positions: Position[] = []; for (let i = 0, len = e.selections.length; i < len; i++) { positions[i] = e.selections[i].getPosition(); } const e1: ICursorPositionChangedEvent = { position: positions[0], secondaryPositions: positions.slice(1), reason: e.reason, source: e.source }; this._onDidChangeCursorPosition.fire(e1); const e2: ICursorSelectionChangedEvent = { selection: e.selections[0], secondarySelections: e.selections.slice(1), source: e.source, reason: e.reason }; this._onDidChangeCursorSelection.fire(e2); })); } else { this.hasView = false; } } protected abstract _scheduleAtNextAnimationFrame(callback: () => void): IDisposable; protected abstract _createView(): void; protected _postDetachModelCleanup(detachedModel: ITextModel): void { if (detachedModel) { detachedModel.removeAllDecorationsWithOwnerId(this.id); } } protected _detachModel(): ITextModel { if (this.model) { this.model.onBeforeDetached(); } this.hasView = false; this.listenersToRemove = dispose(this.listenersToRemove); if (this.cursor) { this.cursor.dispose(); this.cursor = null; } if (this.viewModel) { this.viewModel.dispose(); this.viewModel = null; } let result = this.model; this.model = null; this.domElement.removeAttribute('data-mode-id'); return result; } protected abstract _registerDecorationType(key: string, options: editorCommon.IDecorationRenderOptions, parentTypeKey?: string): void; protected abstract _removeDecorationType(key: string): void; protected abstract _resolveDecorationOptions(typeKey: string, writable: boolean): IModelDecorationOptions; /* __GDPR__FRAGMENT__ "EditorTelemetryData" : {} */ public getTelemetryData(): { [key: string]: any; } { return null; } } class EditorContextKeysManager extends Disposable { private _editor: CommonCodeEditor; private _editorFocus: IContextKey; private _editorTextFocus: IContextKey; private _editorTabMovesFocus: IContextKey; private _editorReadonly: IContextKey; private _hasMultipleSelections: IContextKey; private _hasNonEmptySelection: IContextKey; constructor( editor: CommonCodeEditor, contextKeyService: IContextKeyService ) { super(); this._editor = editor; contextKeyService.createKey('editorId', editor.getId()); this._editorFocus = EditorContextKeys.focus.bindTo(contextKeyService); this._editorTextFocus = EditorContextKeys.textFocus.bindTo(contextKeyService); this._editorTabMovesFocus = EditorContextKeys.tabMovesFocus.bindTo(contextKeyService); this._editorReadonly = EditorContextKeys.readOnly.bindTo(contextKeyService); this._hasMultipleSelections = EditorContextKeys.hasMultipleSelections.bindTo(contextKeyService); this._hasNonEmptySelection = EditorContextKeys.hasNonEmptySelection.bindTo(contextKeyService); this._register(this._editor.onDidChangeConfiguration(() => this._updateFromConfig())); this._register(this._editor.onDidChangeCursorSelection(() => this._updateFromSelection())); this._register(this._editor.onDidFocusEditor(() => this._updateFromFocus())); this._register(this._editor.onDidBlurEditor(() => this._updateFromFocus())); this._register(this._editor.onDidFocusEditorText(() => this._updateFromFocus())); this._register(this._editor.onDidBlurEditorText(() => this._updateFromFocus())); this._updateFromConfig(); this._updateFromSelection(); this._updateFromFocus(); } private _updateFromConfig(): void { let config = this._editor.getConfiguration(); this._editorTabMovesFocus.set(config.tabFocusMode); this._editorReadonly.set(config.readOnly); } private _updateFromSelection(): void { let selections = this._editor.getSelections(); if (!selections) { this._hasMultipleSelections.reset(); this._hasNonEmptySelection.reset(); } else { this._hasMultipleSelections.set(selections.length > 1); this._hasNonEmptySelection.set(selections.some(s => !s.isEmpty())); } } private _updateFromFocus(): void { this._editorFocus.set(this._editor.hasWidgetFocus()); this._editorTextFocus.set(this._editor.isFocused()); } } export class EditorModeContext extends Disposable { private _editor: CommonCodeEditor; private _langId: IContextKey; private _hasCompletionItemProvider: IContextKey; private _hasCodeActionsProvider: IContextKey; private _hasCodeLensProvider: IContextKey; private _hasDefinitionProvider: IContextKey; private _hasImplementationProvider: IContextKey; private _hasTypeDefinitionProvider: IContextKey; private _hasHoverProvider: IContextKey; private _hasDocumentHighlightProvider: IContextKey; private _hasDocumentSymbolProvider: IContextKey; private _hasReferenceProvider: IContextKey; private _hasRenameProvider: IContextKey; private _hasDocumentFormattingProvider: IContextKey; private _hasDocumentSelectionFormattingProvider: IContextKey; private _hasSignatureHelpProvider: IContextKey; private _isInWalkThrough: IContextKey; constructor( editor: CommonCodeEditor, contextKeyService: IContextKeyService ) { super(); this._editor = editor; this._langId = EditorContextKeys.languageId.bindTo(contextKeyService); this._hasCompletionItemProvider = EditorContextKeys.hasCompletionItemProvider.bindTo(contextKeyService); this._hasCodeActionsProvider = EditorContextKeys.hasCodeActionsProvider.bindTo(contextKeyService); this._hasCodeLensProvider = EditorContextKeys.hasCodeLensProvider.bindTo(contextKeyService); this._hasDefinitionProvider = EditorContextKeys.hasDefinitionProvider.bindTo(contextKeyService); this._hasImplementationProvider = EditorContextKeys.hasImplementationProvider.bindTo(contextKeyService); this._hasTypeDefinitionProvider = EditorContextKeys.hasTypeDefinitionProvider.bindTo(contextKeyService); this._hasHoverProvider = EditorContextKeys.hasHoverProvider.bindTo(contextKeyService); this._hasDocumentHighlightProvider = EditorContextKeys.hasDocumentHighlightProvider.bindTo(contextKeyService); this._hasDocumentSymbolProvider = EditorContextKeys.hasDocumentSymbolProvider.bindTo(contextKeyService); this._hasReferenceProvider = EditorContextKeys.hasReferenceProvider.bindTo(contextKeyService); this._hasRenameProvider = EditorContextKeys.hasRenameProvider.bindTo(contextKeyService); this._hasDocumentFormattingProvider = EditorContextKeys.hasDocumentFormattingProvider.bindTo(contextKeyService); this._hasDocumentSelectionFormattingProvider = EditorContextKeys.hasDocumentSelectionFormattingProvider.bindTo(contextKeyService); this._hasSignatureHelpProvider = EditorContextKeys.hasSignatureHelpProvider.bindTo(contextKeyService); this._isInWalkThrough = EditorContextKeys.isInEmbeddedEditor.bindTo(contextKeyService); const update = () => this._update(); // update when model/mode changes this._register(editor.onDidChangeModel(update)); this._register(editor.onDidChangeModelLanguage(update)); // update when registries change this._register(modes.SuggestRegistry.onDidChange(update)); this._register(modes.CodeActionProviderRegistry.onDidChange(update)); this._register(modes.CodeLensProviderRegistry.onDidChange(update)); this._register(modes.DefinitionProviderRegistry.onDidChange(update)); this._register(modes.ImplementationProviderRegistry.onDidChange(update)); this._register(modes.TypeDefinitionProviderRegistry.onDidChange(update)); this._register(modes.HoverProviderRegistry.onDidChange(update)); this._register(modes.DocumentHighlightProviderRegistry.onDidChange(update)); this._register(modes.DocumentSymbolProviderRegistry.onDidChange(update)); this._register(modes.ReferenceProviderRegistry.onDidChange(update)); this._register(modes.RenameProviderRegistry.onDidChange(update)); this._register(modes.DocumentFormattingEditProviderRegistry.onDidChange(update)); this._register(modes.DocumentRangeFormattingEditProviderRegistry.onDidChange(update)); this._register(modes.SignatureHelpProviderRegistry.onDidChange(update)); update(); } dispose() { super.dispose(); } reset() { this._langId.reset(); this._hasCompletionItemProvider.reset(); this._hasCodeActionsProvider.reset(); this._hasCodeLensProvider.reset(); this._hasDefinitionProvider.reset(); this._hasImplementationProvider.reset(); this._hasTypeDefinitionProvider.reset(); this._hasHoverProvider.reset(); this._hasDocumentHighlightProvider.reset(); this._hasDocumentSymbolProvider.reset(); this._hasReferenceProvider.reset(); this._hasRenameProvider.reset(); this._hasDocumentFormattingProvider.reset(); this._hasDocumentSelectionFormattingProvider.reset(); this._hasSignatureHelpProvider.reset(); this._isInWalkThrough.reset(); } private _update() { const model = this._editor.getModel(); if (!model) { this.reset(); return; } this._langId.set(model.getLanguageIdentifier().language); this._hasCompletionItemProvider.set(modes.SuggestRegistry.has(model)); this._hasCodeActionsProvider.set(modes.CodeActionProviderRegistry.has(model)); this._hasCodeLensProvider.set(modes.CodeLensProviderRegistry.has(model)); this._hasDefinitionProvider.set(modes.DefinitionProviderRegistry.has(model)); this._hasImplementationProvider.set(modes.ImplementationProviderRegistry.has(model)); this._hasTypeDefinitionProvider.set(modes.TypeDefinitionProviderRegistry.has(model)); this._hasHoverProvider.set(modes.HoverProviderRegistry.has(model)); this._hasDocumentHighlightProvider.set(modes.DocumentHighlightProviderRegistry.has(model)); this._hasDocumentSymbolProvider.set(modes.DocumentSymbolProviderRegistry.has(model)); this._hasReferenceProvider.set(modes.ReferenceProviderRegistry.has(model)); this._hasRenameProvider.set(modes.RenameProviderRegistry.has(model)); this._hasSignatureHelpProvider.set(modes.SignatureHelpProviderRegistry.has(model)); this._hasDocumentFormattingProvider.set(modes.DocumentFormattingEditProviderRegistry.has(model) || modes.DocumentRangeFormattingEditProviderRegistry.has(model)); this._hasDocumentSelectionFormattingProvider.set(modes.DocumentRangeFormattingEditProviderRegistry.has(model)); this._isInWalkThrough.set(model.uri.scheme === Schemas.walkThroughSnippet); } }