V4 debugger: Drop redundantRefs option

No client is using this anymore and we can eliminate a lot of code this
way.

Change-Id: I454581928fe88e59cd28738c4f7fddd060999181
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>

6 files changed, 13 insertions, 107 deletions

diff --git a/src/plugins/qmltooling/qmldbg_debugger/qv4datacollector.cpp b/src/plugins/qmltooling/qmldbg_debugger/qv4datacollector.cpp
index a437b7ccc7..2d1dcee0aa 100644
--- a/src/plugins/qmltooling/qmldbg_debugger/qv4datacollector.cpp
+++ b/src/plugins/qmltooling/qmldbg_debugger/qv4datacollector.cpp
@@ -111,18 +111,14 @@ int QV4DataCollector::encodeScopeType(QV4::Heap::ExecutionContext::ContextType s
 }
 
 QV4DataCollector::QV4DataCollector(QV4::ExecutionEngine *engine)
-    : m_engine(engine), m_namesAsObjects(true), m_redundantRefs(true)
+    : m_engine(engine), m_namesAsObjects(true)
 {
     m_values.set(engine, engine->newArrayObject());
 }
 
-// TODO: Directly call addRef() once we don't need to support redundantRefs anymore
-QV4DataCollector::Ref QV4DataCollector::collect(const QV4::ScopedValue &value)
+QV4DataCollector::Ref QV4DataCollector::addValueRef(const QV4::ScopedValue &value)
 {
-    Ref ref = addRef(value);
-    if (m_redundantRefs)
-        m_collectedRefs.append(ref);
-    return ref;
+    return addRef(value);
 }
 
 const QV4::Object *collectProperty(const QV4::ScopedValue &value, QV4::ExecutionEngine *engine,
@@ -192,7 +188,7 @@ const QV4::Object *collectProperty(const QV4::ScopedValue &value, QV4::Execution
     }
 }
 
-QJsonObject QV4DataCollector::lookupRef(Ref ref, bool deep)
+QJsonObject QV4DataCollector::lookupRef(Ref ref)
 {
     QJsonObject dict;
 
@@ -201,15 +197,12 @@ QJsonObject QV4DataCollector::lookupRef(Ref ref, bool deep)
             return dict;
     }
 
-    if (m_redundantRefs)
-        deep = true;
-
     dict.insert(QStringLiteral("handle"), qint64(ref));
     QV4::Scope scope(engine());
     QV4::ScopedValue value(scope, getValue(ref));
 
     const QV4::Object *object = collectProperty(value, engine(), dict);
-    if (deep && object)
+    if (object)
         dict.insert(QStringLiteral("properties"), collectProperties(object));
 
     return dict;
@@ -226,7 +219,6 @@ QV4DataCollector::Ref QV4DataCollector::addFunctionRef(const QString &functionNa
     dict.insert(QStringLiteral("type"), QStringLiteral("function"));
     dict.insert(QStringLiteral("name"), functionName);
     m_specialRefs.insert(ref, dict);
-    m_collectedRefs.append(ref);
 
     return ref;
 }
@@ -242,7 +234,6 @@ QV4DataCollector::Ref QV4DataCollector::addScriptRef(const QString &scriptName)
     dict.insert(QStringLiteral("type"), QStringLiteral("script"));
     dict.insert(QStringLiteral("name"), scriptName);
     m_specialRefs.insert(ref, dict);
-    m_collectedRefs.append(ref);
 
     return ref;
 }
@@ -273,7 +264,7 @@ bool QV4DataCollector::collectScope(QJsonObject *dict, int frameNr, int scopeNr)
             QString name = ic->nameMap[i].toQString();
             names.append(name);
             v = static_cast<QV4::Heap::CallContext *>(ctxt->d())->locals[i];
-            collectedRefs.append(collect(v));
+            collectedRefs.append(addValueRef(v));
         }
 
         Q_ASSERT(names.size() == collectedRefs.size());
@@ -284,13 +275,7 @@ bool QV4DataCollector::collectScope(QJsonObject *dict, int frameNr, int scopeNr)
         }
     }
 
-    Ref scopeObjectRef = addRef(scopeObject);
-    if (m_redundantRefs) {
-        dict->insert(QStringLiteral("ref"), qint64(scopeObjectRef));
-        m_collectedRefs.append(scopeObjectRef);
-    } else {
-        *dict = lookupRef(scopeObjectRef, true);
-    }
+    *dict = lookupRef(addRef(scopeObject));
 
     return true;
 }
@@ -330,7 +315,7 @@ QJsonObject QV4DataCollector::buildFrame(const QV4::StackFrame &stackFrame, int
 
     if (ctxt) {
         QV4::ScopedValue o(scope, ctxt->d()->activation);
-        frame[QLatin1String("receiver")] = toRef(collect(o));
+        frame[QLatin1String("receiver")] = toRef(addValueRef(o));
     }
 
     // Only type and index are used by Qt Creator, so we keep it easy:
@@ -351,30 +336,11 @@ QJsonObject QV4DataCollector::buildFrame(const QV4::StackFrame &stackFrame, int
     return frame;
 }
 
-// TODO: Drop this method once we don't need to support redundantRefs anymore
-QJsonArray QV4DataCollector::flushCollectedRefs()
-{
-    Q_ASSERT(m_redundantRefs);
-    QJsonArray refs;
-    std::sort(m_collectedRefs.begin(), m_collectedRefs.end());
-    for (int i = 0, ei = m_collectedRefs.size(); i != ei; ++i) {
-        QV4DataCollector::Ref ref = m_collectedRefs.at(i);
-        if (i > 0 && ref == m_collectedRefs.at(i - 1))
-            continue;
-        refs.append(lookupRef(ref, true));
-    }
-
-    m_collectedRefs.clear();
-    return refs;
-}
-
 void QV4DataCollector::clear()
 {
     m_values.set(engine(), engine()->newArrayObject());
-    m_collectedRefs.clear();
     m_specialRefs.clear();
     m_namesAsObjects = true;
-    m_redundantRefs = true;
 }
 
 QV4DataCollector::Ref QV4DataCollector::addRef(QV4::Value value, bool deduplicate)
@@ -459,8 +425,6 @@ QJsonObject QV4DataCollector::collectAsJson(const QString &name, const QV4::Scop
     if (value->isManaged() && !value->isString()) {
         Ref ref = addRef(value);
         dict.insert(QStringLiteral("ref"), qint64(ref));
-        if (m_redundantRefs)
-            m_collectedRefs.append(ref);
     }
 
     collectProperty(value, engine(), dict);
diff --git a/src/plugins/qmltooling/qmldbg_debugger/qv4datacollector.h b/src/plugins/qmltooling/qmldbg_debugger/qv4datacollector.h
index 5494e10e9a..4851e2fa29 100644
--- a/src/plugins/qmltooling/qmldbg_debugger/qv4datacollector.h
+++ b/src/plugins/qmltooling/qmldbg_debugger/qv4datacollector.h
@@ -67,24 +67,20 @@ public:
 
     QV4DataCollector(QV4::ExecutionEngine *engine);
 
-    Ref collect(const QV4::ScopedValue &value);      // only for redundantRefs
+    Ref addValueRef(const QV4::ScopedValue &value);
     Ref addFunctionRef(const QString &functionName); // only for namesAsObjects
     Ref addScriptRef(const QString &scriptName);     // only for namesAsObjects
 
     void setNamesAsObjects(bool namesAsObjects) { m_namesAsObjects = namesAsObjects; }
     bool namesAsObjects() const { return m_namesAsObjects; }
 
-    void setRedundantRefs(bool redundantRefs) { m_redundantRefs = redundantRefs; }
-    bool redundantRefs() const { return m_redundantRefs; }
-
     bool isValidRef(Ref ref) const;
-    QJsonObject lookupRef(Ref ref, bool deep);
+    QJsonObject lookupRef(Ref ref);
 
     bool collectScope(QJsonObject *dict, int frameNr, int scopeNr);
     QJsonObject buildFrame(const QV4::StackFrame &stackFrame, int frameNr);
 
     QV4::ExecutionEngine *engine() const { return m_engine; }
-    QJsonArray flushCollectedRefs(); // only for redundantRefs
     void clear();
 
 private:
@@ -97,12 +93,10 @@ private:
     void collectArgumentsInContext();
 
     QV4::ExecutionEngine *m_engine;
-    Refs m_collectedRefs;                        // only for redundantRefs
     QV4::PersistentValue m_values;
     typedef QHash<Ref, QJsonObject> SpecialRefs; // only for namesAsObjects
     SpecialRefs m_specialRefs;                   // only for namesAsObjects
     bool m_namesAsObjects;
-    bool m_redundantRefs;
 };
 
 QT_END_NAMESPACE
diff --git a/src/plugins/qmltooling/qmldbg_debugger/qv4debugjob.cpp b/src/plugins/qmltooling/qmldbg_debugger/qv4debugjob.cpp
index 70f71de6ca..b424ef9f6c 100644
--- a/src/plugins/qmltooling/qmldbg_debugger/qv4debugjob.cpp
+++ b/src/plugins/qmltooling/qmldbg_debugger/qv4debugjob.cpp
@@ -150,7 +150,6 @@ void BacktraceJob::run()
         result.insert(QStringLiteral("toFrame"), fromFrame + frameArray.size());
         result.insert(QStringLiteral("frames"), frameArray);
     }
-    flushRedundantRefs();
 }
 
 FrameJob::FrameJob(QV4DataCollector *collector, int frameNr) :
@@ -165,7 +164,6 @@ void FrameJob::run()
         success = false;
     } else {
         result = collector->buildFrame(frames[frameNr], frameNr);
-        flushRedundantRefs();
         success = true;
     }
 }
@@ -195,7 +193,6 @@ void ScopeJob::run()
     result[QLatin1String("index")] = scopeNr;
     result[QLatin1String("frameIndex")] = frameNr;
     result[QLatin1String("object")] = object;
-    flushRedundantRefs();
 }
 
 bool ScopeJob::wasSuccessful() const
@@ -228,9 +225,8 @@ void ValueLookupJob::run()
             exception = QString::fromLatin1("Invalid Ref: %1").arg(ref);
             break;
         }
-        result[QString::number(ref)] = collector->lookupRef(ref, true);
+        result[QString::number(ref)] = collector->lookupRef(ref);
     }
-    flushRedundantRefs();
 }
 
 const QString &ValueLookupJob::exceptionMessage() const
@@ -249,9 +245,7 @@ void ExpressionEvalJob::handleResult(QV4::ScopedValue &value)
 {
     if (hasExeption())
         exception = value->toQStringNoThrow();
-    result = collector->lookupRef(collector->collect(value), true);
-    if (collector->redundantRefs())
-        collectedRefs = collector->flushCollectedRefs();
+    result = collector->lookupRef(collector->addValueRef(value));
 }
 
 const QString &ExpressionEvalJob::exceptionMessage() const
@@ -264,13 +258,6 @@ const QJsonObject &ExpressionEvalJob::returnValue() const
     return result;
 }
 
-// TODO: Drop this method once we don't need to support redundantRefs anymore
-const QJsonArray &ExpressionEvalJob::refs() const
-{
-    Q_ASSERT(collector->redundantRefs());
-    return collectedRefs;
-}
-
 GatherSourcesJob::GatherSourcesJob(QV4::ExecutionEngine *engine)
     : engine(engine)
 {}
diff --git a/src/plugins/qmltooling/qmldbg_debugger/qv4debugjob.h b/src/plugins/qmltooling/qmldbg_debugger/qv4debugjob.h
index eca8710e15..d1c7495863 100644
--- a/src/plugins/qmltooling/qmldbg_debugger/qv4debugjob.h
+++ b/src/plugins/qmltooling/qmldbg_debugger/qv4debugjob.h
@@ -78,24 +78,10 @@ class CollectJob : public QV4DebugJob
 protected:
     QV4DataCollector *collector;
     QJsonObject result;
-    QJsonArray collectedRefs; // only for redundantRefs
-
-    void flushRedundantRefs()
-    {
-        if (collector->redundantRefs())
-            collectedRefs = collector->flushCollectedRefs();
-    }
 
 public:
     CollectJob(QV4DataCollector *collector) : collector(collector) {}
     const QJsonObject &returnValue() const { return result; }
-
-    // TODO: Drop this method once we don't need to support redundantRefs anymore
-    const QJsonArray &refs() const
-    {
-        Q_ASSERT(collector->redundantRefs());
-        return collectedRefs;
-    }
 };
 
 class BacktraceJob: public CollectJob
@@ -146,7 +132,6 @@ class ExpressionEvalJob: public JavaScriptJob
     QV4DataCollector *collector;
     QString exception;
     QJsonObject result;
-    QJsonArray collectedRefs; // only for redundantRefs
 
 public:
     ExpressionEvalJob(QV4::ExecutionEngine *engine, int frameNr, int context,
@@ -154,7 +139,6 @@ public:
     void handleResult(QV4::ScopedValue &value) override;
     const QString &exceptionMessage() const;
     const QJsonObject &returnValue() const;
-    const QJsonArray &refs() const; // only for redundantRefs
 };
 
 class GatherSourcesJob: public QV4DebugJob
diff --git a/src/plugins/qmltooling/qmldbg_debugger/qv4debugservice.cpp b/src/plugins/qmltooling/qmldbg_debugger/qv4debugservice.cpp
index 6822d1db9c..42e4566a4f 100644
--- a/src/plugins/qmltooling/qmldbg_debugger/qv4debugservice.cpp
+++ b/src/plugins/qmltooling/qmldbg_debugger/qv4debugservice.cpp
@@ -126,17 +126,9 @@ protected:
     {
         QV4DataCollector *collector = debugger->collector();
         collector->setNamesAsObjects(debugService->clientRequiresNamesAsObjects());
-        collector->setRedundantRefs(debugService->clientRequiresRedundantRefs());
         return collector;
     }
 
-    // TODO: drop this method once we don't need to support redundantRefs anymore.
-    void addRefs(const QJsonArray &refs)
-    {
-        Q_ASSERT(debugService->clientRequiresRedundantRefs());
-        response.insert(QStringLiteral("refs"), refs);
-    }
-
     void createErrorResponse(const QString &msg)
     {
         QJsonValue command = req.value(QLatin1String("command"));
@@ -306,8 +298,6 @@ public:
         addSuccess(true);
         addRunning();
         addBody(job.returnValue());
-        if (debugService->clientRequiresRedundantRefs())
-            addRefs(job.refs());
     }
 };
 
@@ -349,8 +339,6 @@ public:
         addSuccess(true);
         addRunning();
         addBody(job.returnValue());
-        if (debugService->clientRequiresRedundantRefs())
-            addRefs(job.refs());
     }
 };
 
@@ -395,8 +383,6 @@ public:
         addSuccess(true);
         addRunning();
         addBody(job.returnValue());
-        if (debugService->clientRequiresRedundantRefs())
-            addRefs(job.refs());
     }
 };
 
@@ -435,8 +421,6 @@ public:
             addSuccess(true);
             addRunning();
             addBody(job.returnValue());
-            if (debugService->clientRequiresRedundantRefs())
-                addRefs(job.refs());
         }
     }
 };
@@ -655,8 +639,6 @@ public:
             addSuccess(true);
             addRunning();
             addBody(job.returnValue());
-            if (debugService->clientRequiresRedundantRefs())
-                addRefs(job.refs());
         }
     }
 };
@@ -678,7 +660,7 @@ V4CommandHandler *QV4DebugServiceImpl::v4CommandHandler(const QString &command)
 
 QV4DebugServiceImpl::QV4DebugServiceImpl(QObject *parent) :
     QQmlConfigurableDebugService<QV4DebugService>(1, parent),
-    debuggerAgent(this), theSelectedFrame(0), redundantRefs(true), namesAsObjects(true),
+    debuggerAgent(this), theSelectedFrame(0), namesAsObjects(true),
     unknownV4CommandHandler(new UnknownV4CommandHandler)
 {
     addHandler(new V4VersionRequest);
@@ -783,11 +765,8 @@ void QV4DebugServiceImpl::messageReceived(const QByteArray &message)
         if (type == V4_CONNECT) {
             QJsonObject parameters = QJsonDocument::fromJson(payload).object();
             namesAsObjects = true;
-            redundantRefs = true;
             if (parameters.contains("namesAsObjects"))
                 namesAsObjects = parameters.value("namesAsObjects").toBool();
-            if (parameters.contains("redundantRefs"))
-                redundantRefs = parameters.value("redundantRefs").toBool();
 
             emit messageToClient(name(), packMessage(type));
             stopWaiting();
diff --git a/src/plugins/qmltooling/qmldbg_debugger/qv4debugservice.h b/src/plugins/qmltooling/qmldbg_debugger/qv4debugservice.h
index f1ff66d3c5..30ea5cd0bf 100644
--- a/src/plugins/qmltooling/qmldbg_debugger/qv4debugservice.h
+++ b/src/plugins/qmltooling/qmldbg_debugger/qv4debugservice.h
@@ -86,7 +86,6 @@ public:
     int selectedFrame() const;
     void selectFrame(int frameNr);
 
-    bool clientRequiresRedundantRefs() const { return redundantRefs; }
     bool clientRequiresNamesAsObjects() const { return namesAsObjects; }
 
     QV4DebuggerAgent debuggerAgent;
@@ -108,7 +107,6 @@ private:
     static int sequence;
     int theSelectedFrame;
 
-    bool redundantRefs;
     bool namesAsObjects;
 
     void addHandler(V4CommandHandler* handler);