Rename some QTextEngine members to reflect their meaning

formats() -> formatCollection()
additionalFormats -> formats

QTextEngine has three different code paths: in context of QTextDocument,
additionalFormats are currently _additional_ formats;
though in QTextLayout, they are the only formats in use;
and the QRawFont-related path shares the QTextLayout's behavior.

This is a preparation step to consolidating these three into a single one.

Change-Id: I427ccc3c2f672ce090899bb0a0995972315daafa
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>

3 files changed, 56 insertions, 55 deletions

diff --git a/src/gui/text/qtextengine.cpp b/src/gui/text/qtextengine.cpp
index 36bf1e6187..de7b42604a 100644
--- a/src/gui/text/qtextengine.cpp
+++ b/src/gui/text/qtextengine.cpp
@@ -1576,9 +1576,9 @@ void QTextEngine::itemize() const
                 }
                 Q_ASSERT(position <= length);
                 QFont::Capitalization capitalization =
-                        formats()->charFormat(format).hasProperty(QTextFormat::FontCapitalization)
-                        ? formats()->charFormat(format).fontCapitalization()
-                        : formats()->defaultFont().capitalization();
+                        formatCollection()->charFormat(format).hasProperty(QTextFormat::FontCapitalization)
+                        ? formatCollection()->charFormat(format).fontCapitalization()
+                        : formatCollection()->defaultFont().capitalization();
                 itemizer.generate(prevPosition, position - prevPosition, capitalization);
                 if (it == end) {
                     if (position < length)
@@ -1595,8 +1595,8 @@ void QTextEngine::itemize() const
 #ifndef QT_NO_RAWFONT
         if (useRawFont && specialData) {
             int lastIndex = 0;
-            for (int i = 0; i < specialData->addFormats.size(); ++i) {
-                const QTextLayout::FormatRange &range = specialData->addFormats.at(i);
+            for (int i = 0; i < specialData->formats.size(); ++i) {
+                const QTextLayout::FormatRange &range = specialData->formats.at(i);
                 const QTextCharFormat &format = range.format;
                 if (format.hasProperty(QTextFormat::FontCapitalization)) {
                     itemizer.generate(lastIndex, range.start - lastIndex, QFont::MixedCase);
@@ -1611,7 +1611,7 @@ void QTextEngine::itemize() const
     }
 
     addRequiredBoundaries();
-    resolveAdditionalFormats();
+    resolveFormats();
 }
 
 bool QTextEngine::isRightToLeft() const
@@ -2366,7 +2366,7 @@ void QTextEngine::freeMemory()
 int QTextEngine::formatIndex(const QScriptItem *si) const
 {
     if (specialData && !specialData->resolvedFormats.isEmpty()) {
-        QTextFormatCollection *collection = formats();
+        QTextFormatCollection *collection = formatCollection();
         Q_ASSERT(collection);
         return collection->indexForFormat(specialData->resolvedFormats.at(si - &layoutData->items[0]));
     }
@@ -2388,16 +2388,16 @@ int QTextEngine::formatIndex(const QScriptItem *si) const
 
 QTextCharFormat QTextEngine::format(const QScriptItem *si) const
 {
-    if (const QTextFormatCollection *formats = this->formats())
-        return formats->charFormat(formatIndex(si));
+    if (const QTextFormatCollection *collection = formatCollection())
+        return collection->charFormat(formatIndex(si));
     return QTextCharFormat();
 }
 
 void QTextEngine::addRequiredBoundaries() const
 {
     if (specialData) {
-        for (int i = 0; i < specialData->addFormats.size(); ++i) {
-            const QTextLayout::FormatRange &r = specialData->addFormats.at(i);
+        for (int i = 0; i < specialData->formats.size(); ++i) {
+            const QTextLayout::FormatRange &r = specialData->formats.at(i);
             setBoundary(r.start);
             setBoundary(r.start + r.length);
             //qDebug("adding boundaries %d %d", r.start, r.start+r.length);
@@ -2466,7 +2466,7 @@ void QTextEngine::setPreeditArea(int position, const QString &preeditText)
     if (preeditText.isEmpty()) {
         if (!specialData)
             return;
-        if (specialData->addFormats.isEmpty()) {
+        if (specialData->formats.isEmpty()) {
             delete specialData;
             specialData = 0;
         } else {
@@ -2483,41 +2483,41 @@ void QTextEngine::setPreeditArea(int position, const QString &preeditText)
     clearLineData();
 }
 
-void QTextEngine::setAdditionalFormats(const QList<QTextLayout::FormatRange> &formatList)
+void QTextEngine::setFormats(const QList<QTextLayout::FormatRange> &formats)
 {
-    if (formatList.isEmpty()) {
+    if (formats.isEmpty()) {
         if (!specialData)
             return;
         if (specialData->preeditText.isEmpty()) {
             delete specialData;
             specialData = 0;
         } else {
-            specialData->addFormats.clear();
+            specialData->formats.clear();
         }
     } else {
         if (!specialData) {
             specialData = new SpecialData;
             specialData->preeditPosition = -1;
         }
-        specialData->addFormats = formatList;
-        indexAdditionalFormats();
+        specialData->formats = formats;
+        indexFormats();
     }
     invalidate();
     clearLineData();
 }
 
-void QTextEngine::indexAdditionalFormats()
+void QTextEngine::indexFormats()
 {
-    QTextFormatCollection *collection = formats();
+    QTextFormatCollection *collection = formatCollection();
     if (!collection) {
         Q_ASSERT(!block.docHandle());
-        specialData->formats.reset(new QTextFormatCollection);
-        collection = specialData->formats.data();
+        specialData->formatCollection.reset(new QTextFormatCollection);
+        collection = specialData->formatCollection.data();
     }
 
     // replace with shared copies
-    for (int i = 0; i < specialData->addFormats.count(); ++i) {
-        QTextCharFormat &format = specialData->addFormats[i].format;
+    for (int i = 0; i < specialData->formats.size(); ++i) {
+        QTextCharFormat &format = specialData->formats[i].format;
         format = collection->charFormat(collection->indexForFormat(format));
     }
 }
@@ -2922,45 +2922,45 @@ public:
 };
 }
 
-void QTextEngine::resolveAdditionalFormats() const
+void QTextEngine::resolveFormats() const
 {
-    if (!specialData || specialData->addFormats.isEmpty()
+    if (!specialData || specialData->formats.isEmpty()
         || !specialData->resolvedFormats.isEmpty())
         return;
 
-    QTextFormatCollection *collection = formats();
+    QTextFormatCollection *collection = formatCollection();
 
     specialData->resolvedFormats.clear();
     QVector<QTextCharFormat> resolvedFormats(layoutData->items.count());
 
-    QVarLengthArray<int, 64> addFormatSortedByStart;
-    addFormatSortedByStart.reserve(specialData->addFormats.count());
-    for (int i = 0; i < specialData->addFormats.count(); ++i) {
-        if (specialData->addFormats.at(i).length >= 0)
-            addFormatSortedByStart.append(i);
+    QVarLengthArray<int, 64> formatsSortedByStart;
+    formatsSortedByStart.reserve(specialData->formats.size());
+    for (int i = 0; i < specialData->formats.size(); ++i) {
+        if (specialData->formats.at(i).length >= 0)
+            formatsSortedByStart.append(i);
     }
-    QVarLengthArray<int, 64> addFormatSortedByEnd = addFormatSortedByStart;
-    std::sort(addFormatSortedByStart.begin(), addFormatSortedByStart.end(),
-              FormatRangeComparatorByStart(specialData->addFormats));
-    std::sort(addFormatSortedByEnd.begin(), addFormatSortedByEnd.end(),
-              FormatRangeComparatorByEnd(specialData->addFormats));
+    QVarLengthArray<int, 64> formatsSortedByEnd = formatsSortedByStart;
+    std::sort(formatsSortedByStart.begin(), formatsSortedByStart.end(),
+              FormatRangeComparatorByStart(specialData->formats));
+    std::sort(formatsSortedByEnd.begin(), formatsSortedByEnd.end(),
+              FormatRangeComparatorByEnd(specialData->formats));
 
     QVarLengthArray<int, 16>  currentFormats;
-    const int *startIt = addFormatSortedByStart.constBegin();
-    const int *endIt = addFormatSortedByEnd.constBegin();
+    const int *startIt = formatsSortedByStart.constBegin();
+    const int *endIt = formatsSortedByEnd.constBegin();
 
     for (int i = 0; i < layoutData->items.count(); ++i) {
         const QScriptItem *si = &layoutData->items.at(i);
         int end = si->position + length(si);
 
-        while (startIt != addFormatSortedByStart.constEnd() &&
-            specialData->addFormats.at(*startIt).start <= si->position) {
+        while (startIt != formatsSortedByStart.constEnd() &&
+            specialData->formats.at(*startIt).start <= si->position) {
             currentFormats.insert(std::upper_bound(currentFormats.begin(), currentFormats.end(), *startIt),
                                   *startIt);
             ++startIt;
         }
-        while (endIt != addFormatSortedByEnd.constEnd() &&
-            specialData->addFormats.at(*endIt).start + specialData->addFormats.at(*endIt).length < end) {
+        while (endIt != formatsSortedByEnd.constEnd() &&
+            specialData->formats.at(*endIt).start + specialData->formats.at(*endIt).length < end) {
             int *currentFormatIterator = std::lower_bound(currentFormats.begin(), currentFormats.end(), *endIt);
             if (*endIt < *currentFormatIterator)
                 currentFormatIterator = currentFormats.end();
@@ -2976,7 +2976,7 @@ void QTextEngine::resolveAdditionalFormats() const
         }
         if (!currentFormats.isEmpty()) {
             foreach (int cur, currentFormats) {
-                const QTextLayout::FormatRange &range = specialData->addFormats.at(cur);
+                const QTextLayout::FormatRange &range = specialData->formats.at(cur);
                 Q_ASSERT(range.start <= si->position && range.start + range.length >= end);
                 format.merge(range.format);
             }
diff --git a/src/gui/text/qtextengine_p.h b/src/gui/text/qtextengine_p.h
index 14670249a1..29aa9597db 100644
--- a/src/gui/text/qtextengine_p.h
+++ b/src/gui/text/qtextengine_p.h
@@ -505,10 +505,10 @@ public:
     void freeMemory();
 
     int findItem(int strPos) const;
-    inline QTextFormatCollection *formats() const {
+    inline QTextFormatCollection *formatCollection() const {
         if (block.docHandle())
             return block.docHandle()->formatCollection();
-        return specialData ? specialData->formats.data() : 0;
+        return specialData ? specialData->formatCollection.data() : 0;
     }
     QTextCharFormat format(const QScriptItem *si) const;
     inline QAbstractTextDocumentLayout *docLayout() const {
@@ -578,10 +578,11 @@ public:
     inline QString preeditAreaText() const { return specialData ? specialData->preeditText : QString(); }
     void setPreeditArea(int position, const QString &text);
 
-    inline bool hasFormats() const { return block.docHandle() || (specialData && !specialData->addFormats.isEmpty()); }
-    inline QList<QTextLayout::FormatRange> additionalFormats() const
-    { return specialData ? specialData->addFormats : QList<QTextLayout::FormatRange>(); }
-    void setAdditionalFormats(const QList<QTextLayout::FormatRange> &formatList);
+    inline bool hasFormats() const
+    { return block.docHandle() || (specialData && !specialData->formats.isEmpty()); }
+    inline QList<QTextLayout::FormatRange> formats() const
+    { return specialData ? specialData->formats : QList<QTextLayout::FormatRange>(); }
+    void setFormats(const QList<QTextLayout::FormatRange> &formats);
 
 private:
     static void init(QTextEngine *e);
@@ -589,15 +590,15 @@ private:
     struct SpecialData {
         int preeditPosition;
         QString preeditText;
-        QList<QTextLayout::FormatRange> addFormats;
+        QList<QTextLayout::FormatRange> formats;
         QVector<QTextCharFormat> resolvedFormats;
         // only used when no docHandle is available
-        QScopedPointer<QTextFormatCollection> formats;
+        QScopedPointer<QTextFormatCollection> formatCollection;
     };
     SpecialData *specialData;
 
-    void indexAdditionalFormats();
-    void resolveAdditionalFormats() const;
+    void indexFormats();
+    void resolveFormats() const;
 
 public:
     bool atWordSeparator(int position) const;
diff --git a/src/gui/text/qtextlayout.cpp b/src/gui/text/qtextlayout.cpp
index 824ebbb2cf..912ab05a59 100644
--- a/src/gui/text/qtextlayout.cpp
+++ b/src/gui/text/qtextlayout.cpp
@@ -500,7 +500,7 @@ QString QTextLayout::preeditAreaText() const
 */
 void QTextLayout::setAdditionalFormats(const QList<FormatRange> &formatList)
 {
-    d->setAdditionalFormats(formatList);
+    d->setFormats(formatList);
 
     if (d->block.docHandle())
         d->block.docHandle()->documentChange(d->block.position(), d->block.length());
@@ -513,7 +513,7 @@ void QTextLayout::setAdditionalFormats(const QList<FormatRange> &formatList)
 */
 QList<QTextLayout::FormatRange> QTextLayout::additionalFormats() const
 {
-    return d->additionalFormats();
+    return d->formats();
 }
 
 /*!