limit suggestions that can be remembered, #41060only items from the top bucket will be remembered and pre-selected the next time suggestion happens

jrieken · jrieken · commit b4ee65d1e330 · 2018-01-15T14:49:24.000-08:00
diff --git a/src/vs/editor/contrib/suggest/suggestController.ts b/src/vs/editor/contrib/suggest/suggestController.ts
@@ -25,7 +25,7 @@ import { SnippetController2 } from 'vs/editor/contrib/snippet/snippetController2
 import { Context as SuggestContext } from './suggest';
 import { SuggestModel, State } from './suggestModel';
 import { ICompletionItem } from './completionModel';
-import { SuggestWidget } from './suggestWidget';
+import { SuggestWidget, ISelectedSuggestion } from './suggestWidget';
 import { KeybindingsRegistry } from 'vs/platform/keybinding/common/keybindingsRegistry';
 import { SuggestMemories } from 'vs/editor/contrib/suggest/suggestMemory';
 
@@ -34,9 +34,9 @@ class AcceptOnCharacterOracle {
 	private _disposables: IDisposable[] = [];
 
 	private _activeAcceptCharacters = new Set<string>();
-	private _activeItem: ICompletionItem;
+	private _activeItem: ISelectedSuggestion;
 
-	constructor(editor: ICodeEditor, widget: SuggestWidget, accept: (item: ICompletionItem) => any) {
+	constructor(editor: ICodeEditor, widget: SuggestWidget, accept: (selected: ISelectedSuggestion) => any) {
 
 		this._disposables.push(widget.onDidShow(() => this._onItem(widget.getFocusedItem())));
 		this._disposables.push(widget.onDidFocus(this._onItem, this));
@@ -52,14 +52,14 @@ class AcceptOnCharacterOracle {
 		}));
 	}
 
-	private _onItem(item: ICompletionItem): void {
-		if (!item || isFalsyOrEmpty(item.suggestion.commitCharacters)) {
+	private _onItem(selected: ISelectedSuggestion): void {
+		if (!selected || isFalsyOrEmpty(selected.item.suggestion.commitCharacters)) {
 			this.reset();
 			return;
 		}
-		this._activeItem = item;
+		this._activeItem = selected;
 		this._activeAcceptCharacters.clear();
-		for (const ch of item.suggestion.commitCharacters) {
+		for (const ch of selected.item.suggestion.commitCharacters) {
 			if (ch.length > 0) {
 				this._activeAcceptCharacters.add(ch[0]);
 			}
@@ -148,7 +148,7 @@ export class SuggestController implements IEditorContribution {
 		);
 
 		let makesTextEdit = SuggestContext.MakesTextEdit.bindTo(this._contextKeyService);
-		this._toDispose.push(this._widget.onDidFocus(item => {
+		this._toDispose.push(this._widget.onDidFocus(({ item }) => {
 
 			const position = this._editor.getPosition();
 			const startColumn = item.position.column - item.suggestion.overwriteBefore;
@@ -193,13 +193,13 @@ export class SuggestController implements IEditorContribution {
 		}
 	}
 
-	protected _onDidSelectItem(item: ICompletionItem): void {
-		if (!item) {
+	protected _onDidSelectItem(event: ISelectedSuggestion): void {
+		if (!event.item) {
 			this._model.cancel();
 			return;
 		}
 
-		const { suggestion, position } = item;
+		const { suggestion, position } = event.item;
 		const editorColumn = this._editor.getPosition().column;
 		const columnDelta = editorColumn - position.column;
 
@@ -209,8 +209,12 @@ export class SuggestController implements IEditorContribution {
 			this._editor.pushUndoStop();
 		}
 
-		// remember this word for future invocations
-		this._memory.remember(this._editor.getModel().getLanguageIdentifier(), item);
+		// remember this suggestion for future invocations
+		// when it wasn't the first suggestion but from the group
+		// of top suggestions (cons -> const, console, constructor)
+		if (event.model.items[0].score === event.item.score) {
+			this._memory.remember(this._editor.getModel().getLanguageIdentifier(), event.item);
+		}
 
 		let { insertText } = suggestion;
 		if (suggestion.snippetType !== 'textmate') {
@@ -237,7 +241,7 @@ export class SuggestController implements IEditorContribution {
 			this._model.cancel();
 		}
 
-		this._alertCompletionItem(item);
+		this._alertCompletionItem(event.item);
 	}
 
 	private _alertCompletionItem({ suggestion }: ICompletionItem): void {
diff --git a/src/vs/editor/contrib/suggest/suggestMemory.ts b/src/vs/editor/contrib/suggest/suggestMemory.ts
@@ -79,7 +79,23 @@ export class SuggestMemory {
 	}
 
 	select(items: ICompletionItem[], last: ICompletionItem): number {
+
+		if (items.length === 0) {
+			return -1;
+		}
+
+		const topScore = items[0].score;
+
 		for (let i = 0; i < items.length; i++) {
+
+			if (topScore !== items[i].score) {
+				// we only take a look at the bucket
+				// of top matches, hence we return
+				// as soon as we see an item that
+				// hasn't the top score anymore
+				return -1;
+			}
+
 			if (items[i] === last) {
 				// prefer the last selected item when
 				// there is one
diff --git a/src/vs/editor/contrib/suggest/suggestWidget.ts b/src/vs/editor/contrib/suggest/suggestWidget.ts
@@ -335,6 +335,12 @@ class SuggestionDetails {
 	}
 }
 
+export interface ISelectedSuggestion {
+	item: ICompletionItem;
+	index: number;
+	model: CompletionModel;
+}
+
 export class SuggestWidget implements IContentWidget, IDelegate<ICompletionItem>, IDisposable {
 
 	private static ID: string = 'editor.widget.suggestWidget';
@@ -368,14 +374,14 @@ export class SuggestWidget implements IContentWidget, IDelegate<ICompletionItem>
 	private showTimeout: TPromise<void>;
 	private toDispose: IDisposable[];
 
-	private onDidSelectEmitter = new Emitter<ICompletionItem>();
-	private onDidFocusEmitter = new Emitter<ICompletionItem>();
+	private onDidSelectEmitter = new Emitter<ISelectedSuggestion>();
+	private onDidFocusEmitter = new Emitter<ISelectedSuggestion>();
 	private onDidHideEmitter = new Emitter<this>();
 	private onDidShowEmitter = new Emitter<this>();
 
 
-	readonly onDidSelect: Event<ICompletionItem> = this.onDidSelectEmitter.event;
-	readonly onDidFocus: Event<ICompletionItem> = this.onDidFocusEmitter.event;
+	readonly onDidSelect: Event<ISelectedSuggestion> = this.onDidSelectEmitter.event;
+	readonly onDidFocus: Event<ISelectedSuggestion> = this.onDidFocusEmitter.event;
 	readonly onDidHide: Event<this> = this.onDidHideEmitter.event;
 	readonly onDidShow: Event<this> = this.onDidShowEmitter.event;
 
@@ -499,8 +505,9 @@ export class SuggestWidget implements IContentWidget, IDelegate<ICompletionItem>
 		}
 
 		const item = e.elements[0];
+		const index = e.indexes[0];
 		item.resolve().then(() => {
-			this.onDidSelectEmitter.fire(item);
+			this.onDidSelectEmitter.fire({ item, index, model: this.completionModel });
 		});
 
 		alert(nls.localize('suggestionAriaAccepted', "{0}, accepted", item.suggestion.label));
@@ -613,7 +620,7 @@ export class SuggestWidget implements IContentWidget, IDelegate<ICompletionItem>
 			.then(() => this.currentSuggestionDetails = null);
 
 		// emit an event
-		this.onDidFocusEmitter.fire(item);
+		this.onDidFocusEmitter.fire({ item, index, model: this.completionModel });
 	}
 
 	private setState(state: State): void {
@@ -838,12 +845,16 @@ export class SuggestWidget implements IContentWidget, IDelegate<ICompletionItem>
 		}
 	}
 
-	getFocusedItem(): ICompletionItem {
+	getFocusedItem(): ISelectedSuggestion {
 		if (this.state !== State.Hidden
 			&& this.state !== State.Empty
 			&& this.state !== State.Loading) {
 
-			return this.list.getFocusedElements()[0];
+			return {
+				item: this.list.getFocusedElements()[0],
+				index: this.list.getFocus()[0],
+				model: this.completionModel
+			};
 		}
 		return undefined;
 	}
diff --git a/src/vs/editor/contrib/suggest/test/suggestModel.test.ts b/src/vs/editor/contrib/suggest/test/suggestModel.test.ts
@@ -25,6 +25,7 @@ import { CoreEditingCommands } from 'vs/editor/browser/controller/coreCommands';
 import { SuggestController } from 'vs/editor/contrib/suggest/suggestController';
 import { IStorageService, NullStorageService } from 'vs/platform/storage/common/storage';
 import { SnippetController2 } from 'vs/editor/contrib/snippet/snippetController2';
+import { ISelectedSuggestion } from 'vs/editor/contrib/suggest/suggestWidget';
 
 function createMockEditor(model: TextModel): TestCodeEditor {
 	const contextKeyService = new MockContextKeyService();
@@ -590,7 +591,7 @@ suite('SuggestModel - TriggerAndCancelOracle', function () {
 
 		return withOracle(async (sugget, editor) => {
 			class TestCtrl extends SuggestController {
-				_onDidSelectItem(item) {
+				_onDidSelectItem(item: ISelectedSuggestion) {
 					super._onDidSelectItem(item);
 				}
 			}
@@ -606,7 +607,7 @@ suite('SuggestModel - TriggerAndCancelOracle', function () {
 				const [first] = event.completionModel.items;
 				assert.equal(first.suggestion.label, 'bar');
 
-				ctrl._onDidSelectItem(first);
+				ctrl._onDidSelectItem({ item: first, index: 0, model: event.completionModel });
 			});
 
 			assert.equal(
