Fixed autocomplete cancellation bug

Author: goossens

TextEditor.cpp

@@ -692,7 +692,13 @@ void TextEditor::handleKeyboardInputs() {
 
 		// ignore specific keys when autocomplete is active, they will be handled later
 		if (autocomplete.isActive() && autocomplete.isSpecialKeyPressed()) {
-			return;
+			if (autocomplete.hasSuggestions()) {
+				return;
+
+			} else {
+				// this is the exception, cancel autocomplete when special keys are used without any suggestions
+				autocomplete.cancel();
+			}
 		}
 
 		// cursor movements and selections

TextEditor.h

@@ -491,6 +491,10 @@ class TextEditor {
 		// this is left to the application so it can be context specific in case a language server is used
 		// a pointer to the current language definition is provided so callbacks have easy access
 		std::vector<std::string> suggestions;
+
+		// set this to true if you are building the suggestion list asynchronously and provide it later
+		// this way autocomplete is not cancelled if the suggestion list is empty and the user hits tab or enter
+		bool suggestionsPromise = false;
 	};
 
 	// autocomplete configuration (defaults are like Visual Studio Code)
@@ -531,6 +535,7 @@ class TextEditor {
 
 		// if it takes too long, applications should do search in separate thread and
 		// use API to report results (see SetAutoCompleteSuggestions)
+		// callback should set suggestionsPromise to true in this case
 		std::function<void(AutoCompleteState&)> callback;
 
 		// opaque void* that must be managed externally but passed to callback
@@ -1121,6 +1126,7 @@ class TextEditor {
 
 		// get information
 		inline bool isActive() const { return active; }
+		inline bool hasSuggestions() const { return state.suggestions.size() > 0 || state.suggestionsPromise; }
 		bool isSpecialKeyPressed() const;
 		inline ImGuiKeyChord getTriggerShortcut() const { return configuration.triggerShortcut; }
 		inline Coordinate getStart() const { return startLocation; }

docs/autocomplete.md

@@ -64,6 +64,7 @@ public:
 
 	// if it takes too long, applications should do search in separate thread and
 	// use API to report results (see SetAutoCompleteSuggestions)
+	// callback should set suggestionsPromise to true in this case
 	std::function<void(AutoCompleteState&)> callback;
 
 	// optional opaque void* that must be managed externally but passed to callback
@@ -104,6 +105,10 @@ public:
 	// this is left to the application so it can be context specific in case a language server is used
 	// a pointer to the current language definition is provided so callbacks have easy access
 	std::vector<std::string> suggestions;
+
+	// set this to true if you are building the suggestion list asynchronously and provide it later
+	// this way autocomplete is not cancelled if the suggestion list is empty and the user hits tab or enter
+	bool suggestionsPromise = false;
 };
 ```