Some cleanup

Author: goossens

TextEditor.cpp

@@ -3266,7 +3266,7 @@ static inline bool isIdentifier(TextEditor::Color color) {
 		color == TextEditor::Color::knownIdentifier;
 }
 
-void TextEditor::Document::iterateIdentifiers(std::function<void(const std::string&)> callback) {
+void TextEditor::Document::iterateIdentifiers(std::function<void(const std::string&)> callback) const {
 	for (size_t i = 0; i < size(); i++) {
 		auto p = at(i).begin();
 		auto end = at(i).end();

TextEditor.h

@@ -130,11 +130,7 @@ class TextEditor {
 	inline void SelectAll() { selectAll(); }
 	inline void SelectLine(int line) { if (line >= 0 && line < document.lineCount()) selectLine(line); }
 	inline void SelectLines(int start, int end) { if (start >= 0 && end < document.lineCount() && start <= end) selectLines(start, end); }
-
-	inline void SelectRegion(int startLine, int startColumn, int endLine, int endColumn) {
-		selectRegion(startLine, startColumn, endLine, endColumn);
-	}
-
+	inline void SelectRegion(int startLine, int startColumn, int endLine, int endColumn) { selectRegion(startLine, startColumn, endLine, endColumn); }
 	inline void SelectToBrackets(bool includeBrackets=true) { selectToBrackets(includeBrackets); }
 	inline void GrowSelectionsToCurlyBrackets() { growSelectionsToCurlyBrackets(); }
 	inline void ShrinkSelectionsToCurlyBrackets() { shrinkSelectionsToCurlyBrackets(); }
@@ -439,7 +435,7 @@ class TextEditor {
 	inline std::string GetLanguageName() const { return language == nullptr ? "None" : language->name; }
 
 	// iterate through identifiers detected by the colorizer (based on current language)
-	inline void IterateIdentifiers(std::function<void(const std::string& identifier)> callback) { document.iterateIdentifiers(callback); }
+	inline void IterateIdentifiers(std::function<void(const std::string& identifier)> callback) const { document.iterateIdentifiers(callback); }
 
 	// autocomplete state (acts as API between editor and outer application)
 	class AutoCompleteState {
@@ -924,7 +920,7 @@ class TextEditor {
 		void iterateUserData(std::function<void(int line, void* data)> callback) const;
 
 		// iterate through document to find identifiers
-		void iterateIdentifiers(std::function<void(const std::string& identifier)> callback);
+		void iterateIdentifiers(std::function<void(const std::string& identifier)> callback) const;
 
 		// utility functions
 		bool isWholeWord(Coordinate start, Coordinate end) const;

docs/autocomplete.md

@@ -114,4 +114,59 @@ poor-man's solution, more sophisticated solutions probably required external
 language engines/services that are beyond the scope of this editor. With the
 provided API however, connections to external capabilities can be established
 and context-sensitive suggestions can be provided based on the most advanced
-algorithms (even good-old AI slop :-)
+algorithms (even good-old AI slop :-).
+
+Below is a quick snippet that shows how to use the Trie class to implement
+a poor-man's autocomplete without using a language server. This snippet
+was taken from the [example application](../example/) so can see it in
+context.
+
+```c++
+void Editor::setAutocompleteMode(bool flag) {
+	// see we are turning autocomplete on or off
+	if (flag) {
+		// rebuild word list
+		buildAutocompleteTrie();
+
+		// setup autocomplete by submitting a new configuration
+		TextEditor::AutoCompleteConfig config;
+
+		config.callback = [this](TextEditor::AutoCompleteState& state) {
+			trie.findSuggestions(state.suggestions, state.searchTerm);
+		};
+
+		editor.SetAutoCompleteConfig(&config);
+
+		// enable change tracking
+		// we don't track every keystroke, callbacks can be delayed up to 3000 milliseconds
+		// if you want live tracking, change 3000 to 0 (performance hit will be minimal for small documents)
+		editor.SetChangeCallback([this]() {
+			buildAutocompleteTrie();
+		}, 3000);
+
+	} else {
+		// disable autocomplete and change tracking
+		editor.SetAutoCompleteConfig(nullptr);
+		editor.SetChangeCallback(nullptr);
+	}
+}
+
+void Editor::buildAutocompleteTrie() {
+	// empty list first
+	trie.clear();
+
+	// add language words (if required)
+	auto language = editor.GetLanguage();
+
+	if (language) {
+		for (auto& word : language->keywords) { trie.insert(word); }
+		for (auto& word : language->declarations) { trie.insert(word); }
+		for (auto& word : language->identifiers) { trie.insert(word); }
+	}
+
+	// add all identifiers in current document
+	editor.IterateIdentifiers([this](const std::string& identifier) {
+		trie.insert(identifier);
+	});
+}
+```

example/editor.cpp

@@ -682,11 +682,12 @@ void Editor::renderConfirmError() {
 //
 
 void Editor::setAutocompleteMode(bool flag) {
+	// see we are turning autocomplete on or off
 	if (flag) {
 		// rebuild word list
 		buildAutocompleteTrie();
 
-		// enable autocomplete
+		// setup autocomplete by submitting a new configuration
 		TextEditor::AutoCompleteConfig config;
 
 		config.callback = [this](TextEditor::AutoCompleteState& state) {
@@ -696,12 +697,12 @@ void Editor::setAutocompleteMode(bool flag) {
 		editor.SetAutoCompleteConfig(&config);
 
 		// enable change tracking
-		// (we don't track every keystroke, callbacks can be delayed up to 3000 milliseconds)
+		// we don't track every keystroke, callbacks can be delayed up to 3000 milliseconds
+		// if you want live tracking, change the 3000 to 0 (performance hit will be minimal for small documents)
 		editor.SetChangeCallback([this]() {
 			buildAutocompleteTrie();
 		}, 3000);
 
-
 	} else {
 		// disable autocomplete and change tracking
 		editor.SetAutoCompleteConfig(nullptr);
@@ -715,7 +716,7 @@ void Editor::setAutocompleteMode(bool flag) {
 //
 
 void Editor::buildAutocompleteTrie() {
-	// rebuild autocomplete word list
+	// empty list first
 	trie.clear();
 
 	// add language words (if required)
@@ -727,7 +728,7 @@ void Editor::buildAutocompleteTrie() {
 		for (auto& word : language->identifiers) { trie.insert(word); }
 	}
 
-	// add all identifiers in document
+	// add all identifiers in current document
 	editor.IterateIdentifiers([this](const std::string& identifier) {
 		trie.insert(identifier);
 	});