Editor: Add replacement helper to document layout

More inline with the other text block user data members and cleaner on
the client side. Additionally add some & for const arguments and remove
test function call.

Change-Id: I19e646aa204eedf447c02a2f76b89c3430280169
Reviewed-by: hjk <hjk@qt.io>

src/plugins/texteditor/textdocument.cpp

@@ -373,7 +373,7 @@ QAction *TextDocument::createDiffAgainstCurrentFileAction(
     return diffAction;
 }
 
-void TextDocument::insertSuggestion(const QString text, const QTextBlock &block)
+void TextDocument::insertSuggestion(const QString &text, const QTextBlock &block)
 {
     TextDocumentLayout::userData(block)->setReplacement(block.text() + text);
     TextDocumentLayout::updateReplacmentFormats(block, fontSettings());

src/plugins/texteditor/textdocument.h

@@ -144,7 +144,7 @@ public:
     static QAction *createDiffAgainstCurrentFileAction(QObject *parent,
         const std::function<Utils::FilePath()> &filePath);
 
-    void insertSuggestion(const QString text, const QTextBlock &block);
+    void insertSuggestion(const QString &text, const QTextBlock &block);
 
 #ifdef WITH_TESTS
     void setSilentReload();

src/plugins/texteditor/textdocumentlayout.cpp

@@ -345,7 +345,7 @@ void TextBlockUserData::setCodeFormatterData(CodeFormatterData *data)
     m_codeFormatterData = data;
 }
 
-void TextBlockUserData::setReplacement(const QString replacement)
+void TextBlockUserData::setReplacement(const QString &replacement)
 {
     m_replacement.reset(new QTextDocument(replacement));
     m_replacement->setDocumentLayout(new TextDocumentLayout(m_replacement.get()));
@@ -528,8 +528,7 @@ QByteArray TextDocumentLayout::expectedRawStringSuffix(const QTextBlock &block)
 void TextDocumentLayout::updateReplacmentFormats(const QTextBlock &block,
                                                  const FontSettings &fontSettings)
 {
-    if (TextBlockUserData *userData = textUserData(block)) {
+    if (QTextDocument *replacement = replacementDocument(block)) {
-        if (QTextDocument *replacement = userData->replacement()) {
         const QTextCharFormat replacementFormat = fontSettings.toTextCharFormat(
             TextStyles{C_TEXT, {C_DISABLED_CODE}});
         QTextCursor cursor(replacement);
@@ -541,17 +540,20 @@ void TextDocumentLayout::updateReplacmentFormats(const QTextBlock &block,
         replacement->firstBlock().layout()->setFormats(block.layout()->formats());
     }
 }
-}
 
 QString TextDocumentLayout::replacement(const QTextBlock &block)
 {
-    if (TextBlockUserData *userData = textUserData(block)) {
+    if (QTextDocument *replacement = replacementDocument(block))
-        if (QTextDocument *replacement = userData->replacement())
         return replacement->toPlainText().mid(block.length() - 1);
-    }
     return {};
 }
 
+QTextDocument *TextDocumentLayout::replacementDocument(const QTextBlock &block)
+{
+    TextBlockUserData *userData = textUserData(block);
+    return userData ? userData->replacement() : nullptr;
+}
+
 void TextDocumentLayout::requestExtraAreaUpdate()
 {
     emit updateExtraArea();
@@ -682,10 +684,8 @@ static QRectF replacementBoundingRect(const QTextDocument *replacement)
 
 QRectF TextDocumentLayout::blockBoundingRect(const QTextBlock &block) const
 {
-    if (TextBlockUserData *userData = textUserData(block)) {
+    if (QTextDocument *replacement = replacementDocument(block))
-        if (auto replacement = userData->replacement())
         return replacementBoundingRect(replacement);
-    }
 
     QRectF boundingRect = QPlainTextDocumentLayout::blockBoundingRect(block);
 

src/plugins/texteditor/textdocumentlayout.h

@@ -126,7 +126,7 @@ public:
     QByteArray expectedRawStringSuffix() { return m_expectedRawStringSuffix; }
     void setExpectedRawStringSuffix(const QByteArray &suffix) { m_expectedRawStringSuffix = suffix; }
 
-    void setReplacement(const QString replacement);
+    void setReplacement(const QString &replacement);
     void clearReplacement() { m_replacement.reset(); }
     QTextDocument *replacement() const { return m_replacement.get(); }
 
@@ -179,6 +179,7 @@ public:
     static QByteArray expectedRawStringSuffix(const QTextBlock &block);
     static void updateReplacmentFormats(const QTextBlock &block, const FontSettings &fontSettings);
     static QString replacement(const QTextBlock &block);
+    static QTextDocument *replacementDocument(const QTextBlock &block);
 
     class TEXTEDITOR_EXPORT FoldValidator
     {

src/plugins/texteditor/texteditor.cpp

@@ -1853,15 +1853,15 @@ TextEditorWidget *TextEditorWidget::fromEditor(const IEditor *editor)
 void TextEditorWidgetPrivate::editorContentsChange(int position, int charsRemoved, int charsAdded)
 {
     if (m_suggestionBlock.isValid()) {
-        if (TextBlockUserData *data = TextDocumentLayout::textUserData(m_suggestionBlock)) {
+        if (QTextDocument *replacementDocument = TextDocumentLayout::replacementDocument(
-            if (auto replacementDocument = data->replacement()) {
+                m_suggestionBlock)) {
             if (replacementDocument->firstBlock().text().startsWith(m_suggestionBlock.text()))
-                    TextDocumentLayout::updateReplacmentFormats(m_suggestionBlock, m_document->fontSettings());
+                TextDocumentLayout::updateReplacmentFormats(m_suggestionBlock,
+                                                            m_document->fontSettings());
             else
                 clearCurrentSuggestion();
         }
     }
-    }
 
     if (m_bracketsAnimator)
         m_bracketsAnimator->finish();
@@ -2994,8 +2994,6 @@ void TextEditorWidgetPrivate::universalHelper()
 {
     // Test function for development. Place your new fangled experiment here to
     // give it proper scrutiny before pushing it onto others.
-
-    insertSuggestion("Teste\nWeste\nBeste", q->textCursor().block());
 }
 
 void TextEditorWidget::doSetTextCursor(const QTextCursor &cursor, bool keepMultiSelection)
@@ -4449,9 +4447,8 @@ void TextEditorWidgetPrivate::paintAdditionalVisualWhitespaces(PaintEventData &d
         }
         if (!nextBlockIsValid) { // paint EOF symbol
             if (m_suggestionBlock.isValid() && data.block == m_suggestionBlock) {
-                if (TextBlockUserData *userData = TextDocumentLayout::textUserData(
+                if (QTextDocument *replacement = TextDocumentLayout::replacementDocument(
                         m_suggestionBlock)) {
-                    if (QTextDocument *replacement = userData->replacement()) {
                     const QTextBlock lastReplacementBlock = replacement->lastBlock();
                     for (QTextBlock block = replacement->firstBlock();
                          block != lastReplacementBlock && block.isValid();
@@ -4462,7 +4459,6 @@ void TextEditorWidgetPrivate::paintAdditionalVisualWhitespaces(PaintEventData &d
                     lineCount = layout->lineCount();
                 }
             }
-            }
             QTextLine line = layout->lineAt(lineCount - 1);
             QRectF lineRect = line.naturalTextRect().translated(data.offset.x(), top);
             int h = 4;
@@ -4937,8 +4933,7 @@ void TextEditorWidget::paintBlock(QPainter *painter,
                                   const QVector<QTextLayout::FormatRange> &selections,
                                   const QRect &clipRect) const
 {
-    if (TextBlockUserData *userData = TextDocumentLayout::textUserData(block)) {
+    if (QTextDocument *replacement = TextDocumentLayout::replacementDocument(block)) {
-        if (QTextDocument *replacement = userData->replacement()) {
         QTextBlock replacementBlock = replacement->firstBlock();
         QPointF replacementOffset = offset;
         replacementOffset.rx() += document()->documentMargin();
@@ -4950,7 +4945,6 @@ void TextEditorWidget::paintBlock(QPainter *painter,
         }
         return;
     }
-    }
 
     block.layout()->draw(painter, offset, selections, clipRect);
 }