Debugger: Fix dumpers in case alphabetical sorting is off.

No longer change iname to obtain sorting.

Reviewed-by: hjk

src/plugins/debugger/cdb/cdbsymbolgroupcontext.cpp

@@ -187,15 +187,15 @@ static inline void fixDumperResult(const WatchData &source,
     // If the model queries the expanding item by pretending childrenNeeded=1,
     // refuse the request as the children are already known
     returned.source |= CdbSymbolGroupContext::ChildrenKnownBit;
-    // Fix the children: If the address is missing, we cannot query any further.
+    // Fix the children: Assign sort id , if the address is missing, we cannot query any further.
-    const QList<WatchData>::iterator wend = result->end();
+    const int resultSize = result->size();
-    QList<WatchData>::iterator it = result->begin();
+    for (int i = 1; i < resultSize; i++) {
-    for (++it; it != wend; ++it) {
+        WatchData &wd = (*result)[i];
-        WatchData &wd = *it;
+        wd.sortId = i;
         // Indicate owner and known children
-        it->source = OwnerDumper;
+        wd.source = OwnerDumper;
-        if (it->isChildrenKnown() && it->isHasChildrenKnown() && it->hasChildren)
+        if (wd.isChildrenKnown() && wd.isHasChildrenKnown() && wd.hasChildren)
-            it->source |= CdbSymbolGroupContext::ChildrenKnownBit;
+            wd.source |= CdbSymbolGroupContext::ChildrenKnownBit;
         // Cannot dump items with missing addresses or missing types
         const bool typeFixed = fixDumperType(&wd); // Order of evaluation!
         if ((wd.address == 0 && wd.isSomethingNeeded()) || typeFixed) {

src/plugins/debugger/cdb/cdbsymbolgroupcontext_tpl.h

@@ -52,6 +52,7 @@ bool CdbSymbolGroupContext::getDumpChildSymbols(const QString &prefix,
     // children, so, re-evaluate size in end condition.
     // Note the that the internal dumpers might expand children,
     // so the size might change.
+    int sortId = 0;
     for (int s = start; s < size(); ++s) {
         const DEBUG_SYMBOL_PARAMETERS &p = symbolParameterAt(s);
         if (p.ParentSymbol == parentId && isSymbolDisplayable(p)) {
@@ -59,6 +60,7 @@ bool CdbSymbolGroupContext::getDumpChildSymbols(const QString &prefix,
             const unsigned rc = watchDataAt(s, &wd);
             if (rc & InternalDumperMask)
                 wd.source = dumpedOwner;
+            wd.sortId = sortId++;
             *it = wd;
             ++it;
         }

src/plugins/debugger/gdb/classicgdbengine.cpp

@@ -425,10 +425,7 @@ void GdbEngine::handleDebuggingHelperValue2Classic(const GdbResponse &response)
     setWatchDataType(data, response.data.findChild("type"));
     setWatchDataDisplayedType(data, response.data.findChild("displaytype"));
     QList<WatchData> list;
-    parseWatchData(watchHandler()->expandedINames(),
+    parseWatchData(watchHandler()->expandedINames(), data, contents, &list);
-        data, contents,
-        theDebuggerBoolSetting(SortStructMembers),
-        &list);
     //for (int i = 0; i != list.size(); ++i)
     //    qDebug() << "READ: " << list.at(i).toString();
     watchHandler()->insertBulkData(list);

src/plugins/debugger/gdb/pythongdbengine.cpp

@@ -133,14 +133,12 @@ void GdbEngine::handleStackFramePython(const GdbResponse &response)
 
         GdbMi data = all.findChild("data");
         QList<WatchData> list;
-        const bool sortMembers = theDebuggerBoolSetting(SortStructMembers);
         foreach (const GdbMi &child, data.children()) {
             WatchData dummy;
             dummy.iname = child.findChild("iname").data();
             dummy.name = _(child.findChild("name").data());
             //qDebug() << "CHILD: " << child.toString();
-            parseWatchData(watchHandler()->expandedINames(), dummy, child,
+            parseWatchData(watchHandler()->expandedINames(), dummy, child, &list);
-                sortMembers, &list);
         }
         watchHandler()->insertBulkData(list);
         //for (int i = 0; i != list.size(); ++i)

src/plugins/debugger/pdb/pdbengine.cpp

@@ -826,13 +826,12 @@ void PdbEngine::handleListLocals(const PdbResponse &response)
     //GdbMi data = all.findChild("data");
     QList<WatchData> list;
     WatchHandler *handler = watchHandler();
-    bool sortMembers = theDebuggerBoolSetting(SortStructMembers);
     foreach (const GdbMi &child, all.children()) {
         WatchData dummy;
         dummy.iname = child.findChild("iname").data();
         dummy.name = _(child.findChild("name").data());
         //qDebug() << "CHILD: " << child.toString();
-        parseWatchData(handler->expandedINames(), dummy, child, sortMembers, &list);
+        parseWatchData(handler->expandedINames(), dummy, child, &list);
     }
     handler->insertBulkData(list);
 }

src/plugins/debugger/watchdata.cpp

@@ -28,7 +28,8 @@ WatchData::WatchData() :
     source(0),
     objectId(0),
     state(InitialState),
-    changed(false)
+    changed(false),
+    sortId(0)
 {
 }
 
@@ -172,6 +173,7 @@ QString WatchData::toString() const
     str << QLatin1Char('{');
     if (!iname.isEmpty())
         str << "iname=\"" << iname << doubleQuoteComma;
+    str << "sortId=\"" << sortId << doubleQuoteComma;
     if (!name.isEmpty() && name != iname)
         str << "name=\"" << name << doubleQuoteComma;
     if (error)

src/plugins/debugger/watchdata.h

@@ -136,6 +136,7 @@ public:
     quint64 objectId; // Object id used for the QMLEngine
     int state;
     bool changed;
+    int sortId;
 };
 
 } // namespace Internal

src/plugins/debugger/watchhandler.cpp

@@ -960,40 +960,62 @@ QVariant WatchModel::headerData(int section, Qt::Orientation orientation, int ro
     return QVariant();
 }
 
-struct IName : public QByteArray
+// Determine sort order of watch items by sort order or alphabetical inames
+// according to setting 'SortStructMembers'. We need a map key for bulkInsert
+// and a predicate for finding the insertion position of a single item.
+
+// Set this before using any of the below according to action
+static bool sortWatchDataAlphabetically = true;
+
+static bool watchDataLessThan(const QByteArray &iname1, int sortId1, const QByteArray &iname2, int sortId2)
 {
-    IName(const QByteArray &iname) : QByteArray(iname) {}
+    if (!sortWatchDataAlphabetically)
+        return sortId1 < sortId2;
+    // Get positions of last part of iname 'local.this.i1" -> "i1"
+    int cmpPos1 = iname1.lastIndexOf('.');
+    if (cmpPos1 == -1) {
+        cmpPos1 = 0;
+    } else {
+        cmpPos1++;
+    }
+    int cmpPos2 = iname2.lastIndexOf('.');
+    if (cmpPos2 == -1) {
+        cmpPos2 = 0;
+    } else {
+        cmpPos2++;
+    }
+    // Are we looking at an array with numerical inames 'local.this.i1.0" ->
+    // Go by sort id.
+    if (cmpPos1 < iname1.size() && cmpPos2 < iname2.size()
+            && isdigit(iname1.at(cmpPos1)) && isdigit(iname2.at(cmpPos2)))
+        return sortId1 < sortId2;
+    // Alphabetically
+    return qstrcmp(iname1.constData() + cmpPos1, iname2.constData() + cmpPos2) < 0;
+}
+
+// Sort key for watch data consisting of iname and numerical sort id.
+struct WatchDataSortKey {
+    explicit WatchDataSortKey(const WatchData &wd) :
+             iname(wd.iname), sortId(wd.sortId) {}
+    QByteArray iname;
+    int sortId;
 };
 
-bool iNameLess(const QString &iname1, const QString &iname2)
+inline bool operator<(const WatchDataSortKey &k1, const WatchDataSortKey &k2)
 {
-    QString name1 = iname1.section('.', -1);
+    return watchDataLessThan(k1.iname, k1.sortId, k2.iname, k2.sortId);
-    QString name2 = iname2.section('.', -1);
-    if (!name1.isEmpty() && !name2.isEmpty()) {
-        if (name1.at(0).isDigit() && name2.at(0).isDigit()) {
-            bool ok1 = false, ok2 = false;
-            int i1 = name1.toInt(&ok1), i2 = name2.toInt(&ok2);
-            if (ok1 && ok2)
-                return i1 < i2;
-        }
-    }
-    return name1 < name2;
 }
 
-bool operator<(const IName &iname1, const IName &iname2)
+bool watchItemSorter(const WatchItem *item1, const WatchItem *item2)
 {
-    return iNameLess(iname1, iname2);
+    return watchDataLessThan(item1->iname, item1->sortId, item2->iname, item2->sortId);
-}
-
-static bool iNameSorter(const WatchItem *item1, const WatchItem *item2)
-{
-    return iNameLess(item1->iname, item2->iname);
 }
 
 static int findInsertPosition(const QList<WatchItem *> &list, const WatchItem *item)
 {
-    QList<WatchItem *>::const_iterator it =
+    sortWatchDataAlphabetically = theDebuggerBoolSetting(SortStructMembers);
-        qLowerBound(list.begin(), list.end(), item, iNameSorter);
+    const QList<WatchItem *>::const_iterator it =
+        qLowerBound(list.begin(), list.end(), item, watchItemSorter);
     return it - list.begin();
 }
 
@@ -1045,7 +1067,7 @@ void WatchModel::insertData(const WatchData &data)
         item->parent = parent;
         item->generation = generationCounter;
         item->changed = true;
-        int n = findInsertPosition(parent->children, item);
+        const int n = findInsertPosition(parent->children, item);
         beginInsertRows(index, n, n);
         parent->children.insert(n, item);
         endInsertRows();
@@ -1078,10 +1100,11 @@ void WatchModel::insertBulkData(const QList<WatchData> &list)
     }
     QModelIndex index = watchIndex(parent);
 
-    QMap<IName, WatchData> newList;
+    sortWatchDataAlphabetically = theDebuggerBoolSetting(SortStructMembers);
-    typedef QMap<IName, WatchData>::iterator Iterator;
+    QMap<WatchDataSortKey, WatchData> newList;
+    typedef QMap<WatchDataSortKey, WatchData>::iterator Iterator;
     foreach (const WatchItem &data, list)
-        newList[data.iname] = data;
+        newList.insert(WatchDataSortKey(data), data);
     if (newList.size() != list.size()) {
         qDebug() << "LIST: ";
         foreach (const WatchItem &data, list)
@@ -1100,11 +1123,12 @@ void WatchModel::insertBulkData(const QList<WatchData> &list)
     QTC_ASSERT(newList.size() == list.size(), return);
 
     foreach (WatchItem *oldItem, parent->children) {
-        Iterator it = newList.find(oldItem->iname);
+        const WatchDataSortKey oldSortKey(*oldItem);
+        Iterator it = newList.find(oldSortKey);
         if (it == newList.end()) {
             WatchData data = *oldItem;
             data.generation = generationCounter;
-            newList[oldItem->iname] = data;
+            newList.insert(oldSortKey, data);
         } else {
             bool changed = !it->value.isEmpty()
                 && it->value != oldItem->value

src/plugins/debugger/watchutils.cpp

@@ -1666,7 +1666,7 @@ void setWatchDataDisplayedType(WatchData &data, const GdbMi &item)
 
 void parseWatchData(const QSet<QByteArray> &expandedINames,
     const WatchData &data0, const GdbMi &item,
-    bool sortMembers, QList<WatchData> *list)
+    QList<WatchData> *list)
 {
     //qDebug() << "HANDLE CHILDREN: " << data0.toString() << item.toString();
     WatchData data = data0;
@@ -1711,6 +1711,7 @@ void parseWatchData(const QSet<QByteArray> &expandedINames,
     int i = 0;
     foreach (const GdbMi &child, children.children()) {
         WatchData data1 = childtemplate;
+        data1.sortId = i++;
         GdbMi name = child.findChild("name");
         if (name.isValid())
             data1.name = _(name.data());
@@ -1722,11 +1723,6 @@ void parseWatchData(const QSet<QByteArray> &expandedINames,
         } else {
             data1.iname = data.iname;
             data1.iname += '.';
-            if (!sortMembers) {
-                char buf[10];
-                qsnprintf(buf, sizeof(buf) - 1, "%04d", i);
-                data1.iname += buf;
-            }
             data1.iname += data1.name.toLatin1();
         }
         if (!data1.name.isEmpty() && data1.name.at(0).isDigit())
@@ -1747,8 +1743,7 @@ void parseWatchData(const QSet<QByteArray> &expandedINames,
             //data1.name += " (" + skey + ")";
             data1.name = skey;
         }
-        parseWatchData(expandedINames, data1, child, sortMembers, list);
+        parseWatchData(expandedINames, data1, child, list);
-        ++i;
     }
 }
 

src/plugins/debugger/watchutils.h

@@ -257,7 +257,7 @@ void setWatchDataType(WatchData &data, const GdbMi &mi);
 void setWatchDataDisplayedType(WatchData &data, const GdbMi &mi);
 
 void parseWatchData(const QSet<QByteArray> &expandedINames,
-    const WatchData &parent, const GdbMi &child, bool sortMembers,
+    const WatchData &parent, const GdbMi &child,
     QList<WatchData> *insertions);
 
 } // namespace Internal