Added insert/delete line callbacks and line-based user data (BalazsJako#29)

Author: goossens

README.md

@@ -71,6 +71,7 @@ public API to externally implement these features is however included.
 - Has marker API to specify lines and/or line numbers to highlight and optional show tooltips (see [example](docs/markers.md)).
 - Has optional scrollbar minimap to render cursor, selection and marker locations.
 - Provides middle-mouse pan and scroll functions like CAD programs and browsers.
+- Has API to attach user data to select or all lines (see [example](docs/userData.md)).
 - Has API to decorate each line (useful for debuggers and IDEs) (see [example](docs/lineDecorator.md)).
 - Provides optional and customizable right click context menus for line numbers or text lines (see [example](docs/contextMenus.md))
 - Provides auto completion for paired glyphs (\[, \{, \(, \", \') (can be turned on and off).

TextEditor.cpp

@@ -22,6 +22,15 @@
 #include "TextEditor.h"
 
 
+//
+//	TextEditor::TextEditor
+//
+
+TextEditor::TextEditor() {
+	SetPalette(defaultPalette);
+}
+
+
 //
 //	TextEditor::setText
 //
@@ -504,10 +513,11 @@ void TextEditor::renderDecorations() {
 		auto cursorScreenPos = ImGui::GetCursorScreenPos();
 		auto position = ImVec2(ImGui::GetWindowPos().x + decorationOffset, cursorScreenPos.y + glyphSize.y * firstVisibleLine);
 		auto widthInPixels = (decoratorWidth < 0.0f) ? -decoratorWidth * glyphSize.x: decoratorWidth;
-		Decorator decorator{0, widthInPixels, glyphSize.y, glyphSize};
+		Decorator decorator{0, widthInPixels, glyphSize.y, glyphSize, nullptr};
 
 		for (int i = firstVisibleLine; i <= lastVisibleLine; i++) {
 			decorator.line = i;
+			decorator.userData = document.getUserData(i);
 			ImGui::SetCursorScreenPos(position);
 			ImGui::PushID(i);
 			decoratorCallback(decorator);
@@ -2938,8 +2948,8 @@ void TextEditor::Cursors::adjustForDelete(iterator start, Coordinate deleteStart
 
 void TextEditor::Document::setText(const std::string_view& text) {
 	// reset document
-	clear();
-	emplace_back();
+	clearDocument();
+	appendLine();
 	updated = true;
 
 	// process UTF-8 and generate lines of glyphs
@@ -2951,7 +2961,7 @@ void TextEditor::Document::setText(const std::string_view& text) {
 		i = CodePoint::read(i, end, &character);
 
 		if (character == '\n') {
-			emplace_back();
+			appendLine();
 
 		} else if (insertSpacesOnTabs && character == '\t') {
 			auto spaces = ((back().size() / tabSize) + 1) * tabSize - back().size();
@@ -2976,13 +2986,13 @@ void TextEditor::Document::setText(const std::string_view& text) {
 
 void TextEditor::Document::setText(const std::vector<std::string_view>& text) {
 	// reset document
-	clear();
+	clearDocument();
 	updated = true;
 
 	if (text.size()) {
 		// process input UTF-8 and generate lines of glyphs
 		for (auto& line : text) {
-			emplace_back();
+			appendLine();
 			auto i = line.begin();
 			auto end = line.end();
 
@@ -3004,7 +3014,7 @@ void TextEditor::Document::setText(const std::vector<std::string_view>& text) {
 		}
 
 	} else {
-		emplace_back();
+		appendLine();
 	}
 
 	// update maximum column counts
@@ -3032,7 +3042,7 @@ TextEditor::Coordinate TextEditor::Document::insertText(Coordinate start, const
 
 		if (character == '\n') {
 			// split line
-			insert(line + 1, Line());
+			insertLine(lineNo + 1);
 			line = begin() + lineNo;
 			auto nextLine = begin() + ++lineNo;
 
@@ -3089,19 +3099,17 @@ void TextEditor::Document::deleteText(Coordinate start, Coordinate end) {
 
 	// start and end are on different lines
 	} else {
-		// remove start of last line
-		endLine.erase(endLine.begin(), endLine.begin() + endIndex);
-
-		// remove full lines
-		erase(begin() + start.line + 1, begin() + end.line);
-
 		// remove end of first line
 		startLine.erase(startLine.begin() + startIndex, startLine.end());
 
+		// remove start of last line
+		endLine.erase(endLine.begin(), endLine.begin() + endIndex);
+
 		// join lines
-		auto& nextLine = at(start.line + 1);
-		startLine.insert(startLine.end(), nextLine.begin(), nextLine.end());
-		erase(begin() + start.line + 1);
+		startLine.insert(startLine.end(), endLine.begin(), endLine.end());
+
+		// delete lines
+		deleteLines(start.line + 1, end.line);
 	}
 
 	// mark affected lines for colorization
@@ -3548,6 +3556,41 @@ bool TextEditor::Document::findText(Coordinate from, const std::string_view& tex
 }
 
 
+//
+//	TextEditor::Document::setUserData
+//
+
+void TextEditor::Document::setUserData(int line, void* data) {
+	if (line >= 0 && line < lineCount()) {
+		at(static_cast<size_t>(line)).userData = data;
+	}
+}
+
+
+//
+//	TextEditor::Document::getUserData
+//
+
+void* TextEditor::Document::getUserData(int line) const {
+	if (line >= 0 && line < lineCount()) {
+		return at(static_cast<size_t>(line)).userData;
+
+	} else {
+		return nullptr;
+	}
+}
+
+//
+//	TextEditor::Document::iterateUserData
+//
+
+void TextEditor::Document::iterateUserData(std::function<void(int line, void* data)> callback) const {
+	for (size_t i = 0; i < size(); i++) {
+		callback(static_cast<int>(i), at(i).userData);
+	}
+}
+
+
 //
 //	TextEditor::Document::isWholeWord
 //
@@ -3721,6 +3764,62 @@ void TextEditor::Document::normalizeCoordinate(float line, float column, Coordin
 }
 
 
+//
+//	TextEditor::Document::appendLine
+//
+
+void TextEditor::Document::appendLine() {
+	auto& line = emplace_back();
+
+	if (insertor) {
+		line.userData = insertor(static_cast<int>(size() - 1));
+	}
+}
+
+
+//
+//	TextEditor::Document::insertLine
+//
+
+void TextEditor::Document::insertLine(int offsset) {
+	auto line = insert(begin() + offsset, Line());
+
+	if (insertor) {
+		line->userData = insertor(offsset);
+	}
+}
+
+
+//
+//	TextEditor::Document::deleteLines
+//
+
+void TextEditor::Document::deleteLines(int start, int end) {
+	if (deletor) {
+		for (auto i = start; i <= end; i++) {
+			deletor(i, at(i).userData);
+		}
+	}
+
+	erase(begin() + start, begin() + end);
+}
+
+
+//
+//	TextEditor::Document::clearDocument
+//
+
+void TextEditor::Document::clearDocument() {
+	if (deletor) {
+		for (auto i = 0; i <= lineCount(); i++) {
+			deletor(i, at(i).userData);
+		}
+	}
+
+	clear();
+}
+
+
 //
 //	TextEditor::Transactions::reset
 //

TextEditor.h

@@ -32,7 +32,7 @@
 class TextEditor {
 public:
 	// constructor
-	TextEditor() { SetPalette(defaultPalette); }
+	TextEditor();
 
 	//
 	// Below is the public API
@@ -192,12 +192,32 @@ class TextEditor {
 	inline void ClearMarkers() { clearMarkers(); }
 	inline bool HasMarkers() const { return markers.size() != 0; }
 
+	// line-based callbacks (line numbers are zero-based)
+	// insertor callbacks are called when lines are added/inserted
+	// deletor callbacks are called when lines are deleted
+	// these callbacks work with user data (see below)
+	// setting either callback to nullptr will deactivate that callback
+	inline void SetInsertor(std::function<void*(int line)> callback) { document.setInsertor(callback); }
+	inline void SetDeletor(std::function<void(int line, void* data)> callback) { document.setDeletor(callback); }
+
+	// line-based user data (line numbers are zero-based)
+	// allowing integrators to associate external data with select lines or all lines
+	// user data is an opaque void* that must be managed externally
+	// user data is also passed to the decorator callback (see below)
+	// user data is attached to a line and additions/insertions/deletions don't effect this
+	// if a line with user data is removed, it won't come back on a redo (yet)
+	// the deletor callback (if specified) is called when a line is deleted (see above)
+	inline void SetUserData(int line, void* data) { document.setUserData(line, data); }
+	inline void* GetUserData(int line) const { return document.getUserData(line); }
+	inline void IterateUserData(std::function<void(int line, void* data)> callback) const { document.iterateUserData(callback); }
+
 	// line-based decoration
 	struct Decorator {
 		int line; // zero-based
 		float width;
 		float height;
 		ImVec2 glyphSize;
+		void* userData;
 	};
 
 	// positive width is number of pixels, negative with is number of glyphs
@@ -667,6 +687,9 @@ class TextEditor {
 
 		// do we need to (re)colorize this line
 		bool colorize = true;
+
+		// user data associated with this line
+		void* userData = nullptr;
 	};
 
 	// the document being edited (Lines of Glyphs)
@@ -729,6 +752,15 @@ class TextEditor {
 		inline bool isUpdated() { auto result = updated; updated = false; return result; }
 		inline void resetUpdated() { updated = false; }
 
+		// line-based callbacks
+		inline void setInsertor(std::function<void*(int line )> callback) { insertor = callback; }
+		inline void setDeletor(std::function<void(int line, void* data)> callback) { deletor = callback; }
+
+		// access line user data
+		void setUserData(int line, void* data);
+		void* getUserData(int line) const;
+		void iterateUserData(std::function<void(int line, void* data)> callback) const;
+
 		// utility functions
 		bool isWholeWord(Coordinate start, Coordinate end) const;
 		inline bool isEndOfLine(Coordinate from) const { return getIndex(from) == at(from.line).size(); }
@@ -743,6 +775,14 @@ class TextEditor {
 		bool insertSpacesOnTabs = false;
 		int maxColumn = 0;
 		bool updated = false;
+
+		std::function<void*(int)> insertor;
+		std::function<void(int, void*)> deletor;
+
+		void appendLine();
+		void insertLine(int line);
+		void deleteLines(int start, int end);
+		void clearDocument();
 	} document;
 
 	// single action to be performed on text as part of a larger transaction