ref edbee#134, textChange signals with oldText

gamecreature · gamecreature · commit f14c146ff986 · 2022-09-08T20:41:48.000+02:00
- add oldText info to textChange signals (possible breaking change of some interfaces)
- fix undo crash by missing oldText in AccessibleTextEditorWidget::notifyTextSelectionEvent
- add some extra range checks. OS X voice-over, somethimes asks text out of range.
  With a length of -1 or outside document length
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,9 @@
-## Upcoming Release
+# Upcoming Release
 
 edbee.lib:
 
+- add #135, QAccessibleTextInterface support
+- add TextBuffer::emitTextChanged is extended with the oldText. SIGNAL void emitTextChanged( TextBufferChange* change, QString oldText = QString()); (WARNING: signal interface changes )
 - fix #133, Added Qt 6.3.0 compatibility
 - fix #132, Writing diacritics in Linux
 - ref #128, Build in supprort for virtual characters. Alternate position/cursor calculations via TextLayout
diff --git a/edbee-lib/edbee/models/chardocument/chartextbuffer.cpp b/edbee-lib/edbee/models/chardocument/chartextbuffer.cpp
@@ -83,14 +83,16 @@ void CharTextBuffer::replaceText(int offset, int length, const QChar* buffer, in
     emit textAboutToBeChanged( change );
 
     // replace the text
+    QString oldText = buf_.mid(offset, length);
+
     buf_.replace( offset, length, buffer, bufferLength );
 
     // replace the line data and offsets
     lineOffsetList_.applyChange( change );
 
 //    emit linesReplaced( change.line, change.lineCount, change.newLineCount );
 //    emit textReplaced( offset, length, buffer, bufferLength );
-    emit textChanged( change );
+    emit textChanged( change, oldText );
 
 }
 
@@ -168,7 +170,7 @@ void CharTextBuffer::rawAppendEnd()
 
     emit textAboutToBeChanged( change );
     lineOffsetList_.applyChange( change );
-    emit textChanged( change );
+    emit textChanged( change, QString() );
 
     rawAppendLineStart_ = -1;
     rawAppendStart_     = -1;
diff --git a/edbee-lib/edbee/models/chardocument/chartextbuffer.h b/edbee-lib/edbee/models/chardocument/chartextbuffer.h
@@ -43,7 +43,7 @@ class EDBEE_EXPORT CharTextBuffer : public TextBuffer
 
 protected slots:
 
-    void emitTextChanged( edbee::TextBufferChange* change );
+    void emitTextChanged( edbee::TextBufferChange* change, QString oldText = QString());
 
 private:
     QCharGapVector buf_;                     ///< The textbuffer
diff --git a/edbee-lib/edbee/models/chardocument/chartextdocument.cpp b/edbee-lib/edbee/models/chardocument/chartextdocument.cpp
@@ -59,7 +59,7 @@ CharTextDocument::CharTextDocument(QObject *object)
 
     // simply forward the about to change signal
     connect( textBuffer_, SIGNAL(textAboutToBeChanged(edbee::TextBufferChange)), SIGNAL(textAboutToBeChanged(edbee::TextBufferChange)), Qt::DirectConnection );
-    connect( textBuffer_, SIGNAL(textChanged(edbee::TextBufferChange)), SLOT(textBufferChanged(edbee::TextBufferChange)), Qt::DirectConnection );
+    connect( textBuffer_, SIGNAL(textChanged(edbee::TextBufferChange, QString)), SLOT(textBufferChanged(edbee::TextBufferChange, QString)), Qt::DirectConnection );
 
     // forward the persisted state changes
     connect( textUndoStack_, SIGNAL(persistedChanged(bool)), this,  SIGNAL(persistedChanged(bool)) );
@@ -143,7 +143,7 @@ Change *CharTextDocument::giveChangeWithoutFilter(Change *change, int coalesceId
 
 
 // the text is changed
-void CharTextDocument::textBufferChanged(const TextBufferChange& change)
+void CharTextDocument::textBufferChanged(const TextBufferChange& change, QString oldText)
 {
     if( textLexer_ ) {
         textLexer_->textChanged( change );
@@ -158,7 +158,7 @@ void CharTextDocument::textBufferChanged(const TextBufferChange& change)
     }
 
     // emit the textchanged singal
-    emit textChanged( change);   // and notify the document listeners
+    emit textChanged(change, oldText);   // and notify the document listeners
 }
 
 
diff --git a/edbee-lib/edbee/models/chardocument/chartextdocument.h b/edbee-lib/edbee/models/chardocument/chartextdocument.h
@@ -79,7 +79,7 @@ Q_OBJECT
 protected slots:
 //    virtual void textReplaced( int offset, int length, const QChar* data, int dataLength );
 //    virtual void linesReplaced( int line, int lineCount, int newLineCount );
-    virtual void textBufferChanged( const edbee::TextBufferChange& change );
+    virtual void textBufferChanged( const edbee::TextBufferChange& change, QString oldText = QString() );
 
 private:
     TextEditorConfig* config_;                               ///< The text editor configuration
diff --git a/edbee-lib/edbee/models/textbuffer.h b/edbee-lib/edbee/models/textbuffer.h
@@ -145,7 +145,7 @@ Q_OBJECT
  signals:
 
     void textAboutToBeChanged( edbee::TextBufferChange change );
-    void textChanged( edbee::TextBufferChange change );
+    void textChanged( edbee::TextBufferChange change, QString oldText = QString() );
 
 };
 
diff --git a/edbee-lib/edbee/models/textdocument.h b/edbee-lib/edbee/models/textdocument.h
@@ -157,7 +157,7 @@ Q_OBJECT
 signals:
 
     void textAboutToBeChanged( edbee::TextBufferChange change );
-    void textChanged( edbee::TextBufferChange change );
+    void textChanged( edbee::TextBufferChange change, QString oldText = QString() );
 
     /// This signal is emitted if the persisted state is changed
     void persistedChanged(bool persisted);
diff --git a/edbee-lib/edbee/models/textrange.cpp b/edbee-lib/edbee/models/textrange.cpp
@@ -1230,7 +1230,7 @@ bool DynamicTextRangeSet::deleteMode() const
 
 
 /// This method is notified if a change happens to the textbuffer
-void DynamicTextRangeSet::textChanged(edbee::TextBufferChange change)
+void DynamicTextRangeSet::textChanged(edbee::TextBufferChange change, QString oldText)
 {
     changeSpatial( change.offset(), change.length(), change.newTextLength(), stickyMode_, deleteMode_ );
 }
diff --git a/edbee-lib/edbee/models/textrange.h b/edbee-lib/edbee/models/textrange.h
@@ -256,7 +256,7 @@ Q_OBJECT
     bool deleteMode() const;
 
 public slots:
-    void textChanged( edbee::TextBufferChange change );
+    void textChanged( edbee::TextBufferChange change, QString oldText = QString() );
 
 private:
     bool stickyMode_;                       ///< Sticky mode means if this rangeset is the current selection (This requires a different approach)
diff --git a/edbee-lib/edbee/texteditorcontroller.cpp b/edbee-lib/edbee/texteditorcontroller.cpp
@@ -131,7 +131,7 @@ void TextEditorController::setTextDocument(TextDocument* doc)
         TextDocument* oldDocumentRef = textDocument();
         if( oldDocumentRef ) {
             oldDocumentRef->textUndoStack()->unregisterController(this);
-            disconnect( oldDocumentRef, SIGNAL(textChanged(edbee::TextBufferChange)), this, SLOT(onTextChanged(edbee::TextBufferChange)) );
+            disconnect( oldDocumentRef, SIGNAL(textChanged(edbee::TextBufferChange, QString)), this, SLOT(onTextChanged(edbee::TextBufferChange, QString)) );
             disconnect( textDocumentRef_->lineDataManager(), SIGNAL(lineDataChanged(int,int,int)), this, SLOT(onLineDataChanged(int,int,int)));
         }
 
@@ -151,7 +151,7 @@ void TextEditorController::setTextDocument(TextDocument* doc)
 
         textDocumentRef_->textUndoStack()->registerContoller(this);
 
-        connect( textDocumentRef_, SIGNAL(textChanged(edbee::TextBufferChange)), this, SLOT(onTextChanged(edbee::TextBufferChange)));
+        connect( textDocumentRef_, SIGNAL(textChanged(edbee::TextBufferChange, QString)), this, SLOT(onTextChanged(edbee::TextBufferChange, QString)));
         connect( textDocumentRef_->lineDataManager(), SIGNAL(lineDataChanged(int,int,int)), this, SLOT(onLineDataChanged(int,int,int)) );
 
         // force an repaint when the grammar is changed
@@ -366,10 +366,8 @@ DynamicVariables* TextEditorController::dynamicVariables() const
 
 
 /// This slot is placed if a piece of text is replaced
-void TextEditorController::onTextChanged( edbee::TextBufferChange change )
+void TextEditorController::onTextChanged( edbee::TextBufferChange change, QString oldText )
 {
-    Q_UNUSED(change)
-
     /// update the selection
 //    textSelection()->changeSpatial( change.offset(), change.length(), change.newTextLength() );
 
@@ -378,7 +376,7 @@ void TextEditorController::onTextChanged( edbee::TextBufferChange change )
         widget()->updateGeometryComponents();
         notifyStateChange();
 
-        AccessibleTextEditorWidget::notifyTextChangeEvent(widget(), &change);
+        AccessibleTextEditorWidget::notifyTextChangeEvent(widget(), &change, oldText);
     }
 }
 
diff --git a/edbee-lib/edbee/texteditorcontroller.h b/edbee-lib/edbee/texteditorcontroller.h
@@ -100,7 +100,7 @@ class EDBEE_EXPORT TextEditorController : public QObject
 
 public slots:
 
-    void onTextChanged( edbee::TextBufferChange change );
+    void onTextChanged( edbee::TextBufferChange change, QString oldText = QString() );
     void onSelectionChanged( edbee::TextRangeSet *oldRangeSet );
     void onLineDataChanged( int line, int length, int newLength );
 
diff --git a/edbee-lib/edbee/views/accessibletexteditorwidget.cpp b/edbee-lib/edbee/views/accessibletexteditorwidget.cpp
@@ -112,7 +112,9 @@ static const QString VTEXT(TextDocument* doc)
 static const QString VTEXT_PART(TextDocument* doc, int offset, int length)
 {
 #ifndef WINDOWS_END_LINE_READ_ERROR_FIX
-    return doc->textPart(offset, length);
+    if(length < 0) { return QString(); }
+
+    return doc->textPart(offset, qMin(length, doc->length() - offset));
 #endif
     int docLength = doc->length();
 #ifdef WINDOWS_LAST_LINE_ERROR_FIX
@@ -191,23 +193,31 @@ void AccessibleTextEditorWidget::notifyTextSelectionEvent(TextEditorWidget *widg
 
         QAccessibleTextSelectionEvent ev(eventWidget, D2V(widget, range.min()), D2V(widget, range.max()));
         ev.setCursorPosition(D2V(widget, range.caret()));
+
+//        qDebug() << " !!updateAccessibility: QAccessibleTextSelectionEvent: " << range.min()<< ", " << range.max() << ", " << range.caret();
+
         QAccessible::updateAccessibility(&ev);
     }
 }
 
 /// Notifies a text change event happens
-void AccessibleTextEditorWidget::notifyTextChangeEvent(TextEditorWidget *widget, TextBufferChange *change)
+void AccessibleTextEditorWidget::notifyTextChangeEvent(TextEditorWidget *widget, TextBufferChange *change, QString oldDocText)
 {
     QWidget* eventWidget = eventWidgetForTextEditor(widget);
 
-    // this is a bit tricky, a textbuffer change uses the newtext-value
-    // for storing the old text. The new text can be found in the document
-
-    QString oldText = VTEXT(QString(change->newText()));
-    QString newText = VTEXT_PART(widget->textDocument(), change->offset(), change->newTextLength());
+    QString oldText = VTEXT(oldDocText);
+    QString newText = VTEXT(QString(change->newText()));
 
     QAccessibleTextUpdateEvent ev(eventWidget, D2V(widget, change->offset()), oldText, newText);
     // TODO: When a caret is included, (Inherited change, use this caret position)
+
+//    qDebug() << "-- change: length: " << change->length()
+//             << ", newTextLength: " << change->newTextLength()
+//             << ", offset :" << change->offset()
+//             << ", newText: " << QString(change->newText())
+//             << ", CONTENT: " << widget->textDocument()->text();
+//    qDebug() << "!! updateAccessibility: QAccessibleTextUpdateEvent: " << change->offset()<< ", oldText: " << oldText << ", newText: " << newText;
+
     QAccessible::updateAccessibility(&ev);
 }
 
@@ -237,14 +247,14 @@ QAccessible::State AccessibleTextEditorWidget::state() const
 /// The accessibility APIs support multiple selections. For most widgets though, only one selection
 /// is supported with selectionIndex equal to 0.
 void AccessibleTextEditorWidget::selection(int selectionIndex, int *startOffset, int *endOffset) const
-{   
+{
     if(selectionIndex >= textSelection()->rangeCount()) {
         *startOffset = 0;
         *endOffset = 0;
     }
 
     TextRange& range = textSelection()->range(selectionIndex);
-    *startOffset = D2V(textWidget(), range.min());    
+    *startOffset = D2V(textWidget(), range.min());
     *endOffset = D2V(textWidget(), range.max());
     //qDebug() << " selection >> " << selectionIndex << ", " << range.min() << " =>" << *startOffset << ", " << range.max() << " => " << *endOffset;
 }
@@ -288,7 +298,7 @@ void AccessibleTextEditorWidget::setSelection(int selectionIndex, int startOffse
 /// Returns the current cursor position.
 int AccessibleTextEditorWidget::cursorPosition() const
 {
-    int caret = D2V(textWidget(), textSelection()->range(0).caret());   
+    int caret = D2V(textWidget(), textSelection()->range(0).caret());
     return caret;
 }
 
@@ -302,7 +312,7 @@ QString AccessibleTextEditorWidget::text(QAccessible::Text t) const
 {
     if (t != QAccessible::Value) {
         return QAccessibleWidget::text(t);
-    }    
+    }
     return VTEXT(textWidget()->textDocument());
 }
 
@@ -314,13 +324,14 @@ QString AccessibleTextEditorWidget::text(int vStartOffset, int vEndOffset) const
     int endOffset = V2D(textWidget(), vEndOffset);
 
     //qDebug() << "text: " << VTEXT_PART(textWidget()->textDocument(), startOffset, endOffset - startOffset);
-    //qDebug() << "      - startOffset" << startOffset << ", endOffset: " << endOffset << ", len: " << endOffset-startOffset;
+    //qDebug() << "      - startOffset" << startOffset << ", endOffset: " << endOffset << ", len: " << endOffset-startOffset << " (docLength: " << textWidget()->textDocument()->length() <<")";
     return VTEXT_PART(textWidget()->textDocument(), startOffset, endOffset - startOffset);
 }
 
 /// Returns the length of the text (total size including spaces).
 int AccessibleTextEditorWidget::characterCount() const
 {
+    //qDebug() << " characterCount >> " << VLEN(textWidget());
     return VLEN(textWidget());
 }
 
@@ -479,7 +490,7 @@ QString AccessibleTextEditorWidget::textAtOffset(int vOffset, QAccessible::TextB
 /// have to return the result as if the length was passed in as offset.
 QString AccessibleTextEditorWidget::textBeforeOffset(int offset, QAccessible::TextBoundaryType boundaryType, int *startOffset, int *endOffset) const
 {
-    //qDebug() << "textBeforeOffset: offset: " << offset << ", boundaryType: " << boundaryType;
+    // qDebug() << "textBeforeOffset: offset: " << offset << ", boundaryType: " << boundaryType;
     return QAccessibleTextInterface::textBeforeOffset(offset, boundaryType, startOffset, endOffset);
 }
 
diff --git a/edbee-lib/edbee/views/accessibletexteditorwidget.h b/edbee-lib/edbee/views/accessibletexteditorwidget.h
@@ -29,7 +29,7 @@ class EDBEE_EXPORT AccessibleTextEditorWidget : public QAccessibleWidget, public
     static QWidget* eventWidgetForTextEditor(TextEditorWidget* widget);
 
     static void notifyTextSelectionEvent(TextEditorWidget* widget, TextSelection* selection);
-    static void notifyTextChangeEvent(TextEditorWidget* widget, TextBufferChange* change);
+    static void notifyTextChangeEvent(TextEditorWidget* widget, TextBufferChange* change, QString oldText);
 
 
     void* interface_cast(QAccessible::InterfaceType t) override;
diff --git a/edbee-lib/edbee/views/textrenderer.cpp b/edbee-lib/edbee/views/textrenderer.cpp
@@ -617,14 +617,15 @@ void TextRenderer::textDocumentChanged(edbee::TextDocument *oldDocument, edbee::
     reset();
 
     // connect with the new dpcument
-    connect( newDocument, SIGNAL(textChanged(edbee::TextBufferChange)), this, SLOT(textChanged(edbee::TextBufferChange)));
+    connect( newDocument, SIGNAL(textChanged(edbee::TextBufferChange, QSstring)), this, SLOT(textChanged(edbee::TextBufferChange, QString)));
     connect( newDocument, SIGNAL(lastScopedOffsetChanged(int,int)), this, SLOT(lastScopedOffsetChanged(int,int)) );
 }
 
 
 /// The text is replaced
-void TextRenderer::textChanged(edbee::TextBufferChange change)
+void TextRenderer::textChanged(edbee::TextBufferChange change, QString oldText)
 {
+    Q_UNUSED(oldText)
     int lineCount = qMax( change.lineCount(), change.newLineCount()) + 1;
 
     // Unfortunately when the line-count is changed we need to invalidate all
diff --git a/edbee-lib/edbee/views/textrenderer.h b/edbee-lib/edbee/views/textrenderer.h
@@ -115,7 +115,7 @@ Q_OBJECT
 protected slots:
 
     void textDocumentChanged( edbee::TextDocument* oldDocument, edbee::TextDocument* newDocument );
-    void textChanged( edbee::TextBufferChange change );
+    void textChanged( edbee::TextBufferChange change, QString oldText = QString() );
 
     void lastScopedOffsetChanged( int previousOffset, int newOffset );
 

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ CharTextDocument::CharTextDocument(QObject *object)`
`59`	`59`
`60`	`60`	`// simply forward the about to change signal`
`61`	`61`	`connect( textBuffer_, SIGNAL(textAboutToBeChanged(edbee::TextBufferChange)), SIGNAL(textAboutToBeChanged(edbee::TextBufferChange)), Qt::DirectConnection );`
`62`		`- connect( textBuffer_, SIGNAL(textChanged(edbee::TextBufferChange)), SLOT(textBufferChanged(edbee::TextBufferChange)), Qt::DirectConnection );`
	`62`	`+ connect( textBuffer_, SIGNAL(textChanged(edbee::TextBufferChange, QString)), SLOT(textBufferChanged(edbee::TextBufferChange, QString)), Qt::DirectConnection );`
`63`	`63`
`64`	`64`	`// forward the persisted state changes`
`65`	`65`	`connect( textUndoStack_, SIGNAL(persistedChanged(bool)), this, SIGNAL(persistedChanged(bool)) );`
`@@ -143,7 +143,7 @@ Change CharTextDocument::giveChangeWithoutFilter(Change change, int coalesceId`
`143`	`143`
`144`	`144`
`145`	`145`	`// the text is changed`
`146`		`-void CharTextDocument::textBufferChanged(const TextBufferChange& change)`
	`146`	`+void CharTextDocument::textBufferChanged(const TextBufferChange& change, QString oldText)`
`147`	`147`	`{`
`148`	`148`	`if( textLexer_ ) {`
`149`	`149`	`textLexer_->textChanged( change );`
`@@ -158,7 +158,7 @@ void CharTextDocument::textBufferChanged(const TextBufferChange& change)`
`158`	`158`	`}`
`159`	`159`
`160`	`160`	`// emit the textchanged singal`
`161`		`- emit textChanged( change); // and notify the document listeners`
	`161`	`+ emit textChanged(change, oldText); // and notify the document listeners`
`162`	`162`	`}`
`163`	`163`
`164`	`164`
Original file line number	Diff line number	Diff line change
`@@ -1230,7 +1230,7 @@ bool DynamicTextRangeSet::deleteMode() const`
`1230`	`1230`
`1231`	`1231`
`1232`	`1232`	`/// This method is notified if a change happens to the textbuffer`
`1233`		`-void DynamicTextRangeSet::textChanged(edbee::TextBufferChange change)`
	`1233`	`+void DynamicTextRangeSet::textChanged(edbee::TextBufferChange change, QString oldText)`
`1234`	`1234`	`{`
`1235`	`1235`	`changeSpatial( change.offset(), change.length(), change.newTextLength(), stickyMode_, deleteMode_ );`
`1236`	`1236`	`}`