C++: Fix outdated macro usage info in documents.

Record revisions of documents in macro definitions and usages. Then,
when searching for usages, check the revision of the documents against
the revision of the macros. If they are out-of-sync, repreprocess the
documents to get up-to-date info.

Task-number: QTCREATORBUG-7872
Change-Id: I846bb52ec660024728ab117a9fb7e43382a50e63
Reviewed-by: Christian Stenger <[email protected]>

7 files changed, 100 insertions, 18 deletions

diff --git a/src/libs/cplusplus/CppDocument.cpp b/src/libs/cplusplus/CppDocument.cpp
index 2046747db5b..1584afa2ede 100644
--- a/src/libs/cplusplus/CppDocument.cpp
+++ b/src/libs/cplusplus/CppDocument.cpp
@@ -676,10 +676,19 @@ void Snapshot::insert(Document::Ptr doc)
         _documents.insert(doc->fileName(), doc);
 }
 
-QByteArray Snapshot::preprocessedCode(const QString &source, const QString &fileName) const
+Document::Ptr Snapshot::preprocessedDocument(const QString &source, const QString &fileName) const
 {
+    Document::Ptr newDoc = Document::create(fileName);
+    if (Document::Ptr thisDocument = document(fileName)) {
+        newDoc->_revision = thisDocument->_revision;
+        newDoc->_editorRevision = thisDocument->_editorRevision;
+        newDoc->_lastModified = thisDocument->_lastModified;
+    }
+
     FastPreprocessor pp(*this);
-    return pp.run(fileName, source);
+    const QByteArray preprocessedCode = pp.run(newDoc, source);
+    newDoc->setUtf8Source(preprocessedCode);
+    return newDoc;
 }
 
 Document::Ptr Snapshot::documentFromSource(const QByteArray &preprocessedCode,
diff --git a/src/libs/cplusplus/CppDocument.h b/src/libs/cplusplus/CppDocument.h
index 68f78def55b..484a1b3d9e9 100644
--- a/src/libs/cplusplus/CppDocument.h
+++ b/src/libs/cplusplus/CppDocument.h
@@ -79,7 +79,8 @@ public:
 
     void appendMacro(const Macro &macro);
     void addMacroUse(const Macro &macro, unsigned offset, unsigned length,
-                     unsigned beginLine, const QVector<MacroArgumentReference> &range);
+                     unsigned beginLine,
+                     const QVector<MacroArgumentReference> &range);
     void addUndefinedMacroUse(const QByteArray &name, unsigned offset);
 
     Control *control() const;
@@ -254,8 +255,7 @@ public:
         unsigned _beginLine;
 
     public:
-        inline MacroUse(const Macro &macro,
-                        unsigned begin, unsigned end, unsigned beginLine)
+        inline MacroUse(const Macro &macro, unsigned begin, unsigned end, unsigned beginLine)
             : Block(begin, end),
               _macro(macro),
               _beginLine(beginLine)
@@ -371,10 +371,10 @@ public:
 
     Snapshot simplified(Document::Ptr doc) const;
 
-    QByteArray preprocessedCode(const QString &source,
-                                const QString &fileName) const;
+    Document::Ptr preprocessedDocument(const QString &source,
+                                       const QString &fileName) const;
 
-    Document::Ptr documentFromSource(const QByteArray &preprocessedCode,
+    Document::Ptr documentFromSource(const QByteArray &preprocessedDocument,
                                      const QString &fileName) const;
 
 private:
diff --git a/src/libs/cplusplus/FastPreprocessor.cpp b/src/libs/cplusplus/FastPreprocessor.cpp
index d94c99beda9..b95ea7493fb 100644
--- a/src/libs/cplusplus/FastPreprocessor.cpp
+++ b/src/libs/cplusplus/FastPreprocessor.cpp
@@ -39,8 +39,10 @@ FastPreprocessor::FastPreprocessor(const Snapshot &snapshot)
       _preproc(this, &_env)
 { }
 
-QByteArray FastPreprocessor::run(QString fileName, const QString &source)
+QByteArray FastPreprocessor::run(Document::Ptr newDoc, const QString &source)
 {
+    std::swap(newDoc, _currentDoc);
+    const QString fileName = _currentDoc->fileName();
     _preproc.setExpandFunctionlikeMacros(false);
     _preproc.setKeepComments(true);
 
@@ -54,11 +56,17 @@ QByteArray FastPreprocessor::run(QString fileName, const QString &source)
 
     const QByteArray preprocessed = _preproc.run(fileName, source);
 //    qDebug("FastPreprocessor::run for %s produced [[%s]]", fileName.toUtf8().constData(), preprocessed.constData());
+    std::swap(newDoc, _currentDoc);
     return preprocessed;
 }
 
-void FastPreprocessor::sourceNeeded(unsigned, QString &fileName, IncludeType)
-{ mergeEnvironment(fileName); }
+void FastPreprocessor::sourceNeeded(unsigned line, QString &fileName, IncludeType)
+{
+    Q_ASSERT(_currentDoc);
+    _currentDoc->addIncludeFile(fileName, line);
+
+    mergeEnvironment(fileName);
+}
 
 void FastPreprocessor::mergeEnvironment(const QString &fileName)
 {
@@ -73,3 +81,56 @@ void FastPreprocessor::mergeEnvironment(const QString &fileName)
         }
     }
 }
+
+void FastPreprocessor::macroAdded(const Macro &macro)
+{
+    Q_ASSERT(_currentDoc);
+
+    _currentDoc->appendMacro(macro);
+}
+
+static const Macro revision(const Snapshot &s, const Macro &m)
+{
+    if (Document::Ptr d = s.document(m.fileName())) {
+        Macro newMacro(m);
+        newMacro.setFileRevision(d->revision());
+        return newMacro;
+    }
+
+    return m;
+}
+
+void FastPreprocessor::passedMacroDefinitionCheck(unsigned offset, unsigned line, const Macro &macro)
+{
+    Q_ASSERT(_currentDoc);
+
+    _currentDoc->addMacroUse(revision(_snapshot, macro),
+                             offset, macro.name().length(), line,
+                             QVector<MacroArgumentReference>());
+}
+
+void FastPreprocessor::failedMacroDefinitionCheck(unsigned offset, const ByteArrayRef &name)
+{
+    Q_ASSERT(_currentDoc);
+
+    _currentDoc->addUndefinedMacroUse(QByteArray(name.start(), name.size()), offset);
+}
+
+void FastPreprocessor::notifyMacroReference(unsigned offset, unsigned line, const Macro &macro)
+{
+    Q_ASSERT(_currentDoc);
+
+    _currentDoc->addMacroUse(revision(_snapshot, macro),
+                             offset, macro.name().length(), line,
+                             QVector<MacroArgumentReference>());
+}
+
+void FastPreprocessor::startExpandingMacro(unsigned offset, unsigned line,
+                                          const Macro &macro,
+                                          const QVector<MacroArgumentReference> &actuals)
+{
+    Q_ASSERT(_currentDoc);
+
+    _currentDoc->addMacroUse(revision(_snapshot, macro),
+                             offset, macro.name().length(), line, actuals);
+}
diff --git a/src/libs/cplusplus/FastPreprocessor.h b/src/libs/cplusplus/FastPreprocessor.h
index 5aed578ff0c..14168ad2e6b 100644
--- a/src/libs/cplusplus/FastPreprocessor.h
+++ b/src/libs/cplusplus/FastPreprocessor.h
@@ -47,28 +47,29 @@ class CPLUSPLUS_EXPORT FastPreprocessor: public Client
     Snapshot _snapshot;
     Preprocessor _preproc;
     QSet<QString> _merged;
+    Document::Ptr _currentDoc;
 
     void mergeEnvironment(const QString &fileName);
 
 public:
     FastPreprocessor(const Snapshot &snapshot);
 
-    QByteArray run(QString fileName, const QString &source);
+    QByteArray run(Document::Ptr newDoc, const QString &source);
 
     // CPlusPlus::Client
-    virtual void sourceNeeded(unsigned, QString &fileName, IncludeType);
+    virtual void sourceNeeded(unsigned line, QString &fileName, IncludeType);
 
-    virtual void macroAdded(const Macro &) {}
+    virtual void macroAdded(const Macro &);
 
-    virtual void passedMacroDefinitionCheck(unsigned, unsigned, const Macro &) {}
-    virtual void failedMacroDefinitionCheck(unsigned, const ByteArrayRef &) {}
+    virtual void passedMacroDefinitionCheck(unsigned, unsigned, const Macro &);
+    virtual void failedMacroDefinitionCheck(unsigned, const ByteArrayRef &);
 
-    virtual void notifyMacroReference(unsigned, unsigned, const Macro &) {}
+    virtual void notifyMacroReference(unsigned, unsigned, const Macro &);
 
     virtual void startExpandingMacro(unsigned,
                                      unsigned,
                                      const Macro &,
-                                     const QVector<MacroArgumentReference> &) {}
+                                     const QVector<MacroArgumentReference> &);
     virtual void stopExpandingMacro(unsigned, const Macro &) {}
 
     virtual void startSkippingBlocks(unsigned) {}
diff --git a/src/libs/cplusplus/Macro.cpp b/src/libs/cplusplus/Macro.cpp
index 4c8cac92ad8..7b6ddf09881 100644
--- a/src/libs/cplusplus/Macro.cpp
+++ b/src/libs/cplusplus/Macro.cpp
@@ -53,6 +53,7 @@ using namespace CPlusPlus;
 Macro::Macro()
     : _next(0),
       _hashcode(0),
+      _fileRevision(0),
       _line(0),
       _offset(0),
       _length(0),
diff --git a/src/libs/cplusplus/Macro.h b/src/libs/cplusplus/Macro.h
index 80b797cbc77..241b15d69d3 100644
--- a/src/libs/cplusplus/Macro.h
+++ b/src/libs/cplusplus/Macro.h
@@ -95,6 +95,12 @@ public:
     void setFileName(const QString &fileName)
     { _fileName = fileName; }
 
+    unsigned fileRevision() const
+    { return _fileRevision; }
+
+    void setFileRevision(unsigned fileRevision)
+    { _fileRevision = fileRevision; }
+
     unsigned line() const
     { return _line; }
 
@@ -154,6 +160,7 @@ private:
     QVector<PPToken> _definitionTokens;
     QVector<QByteArray> _formals;
     QString _fileName;
+    unsigned _fileRevision;
     unsigned _line;
     unsigned _offset;
     unsigned _length;
diff --git a/src/libs/cplusplus/pp-engine.cpp b/src/libs/cplusplus/pp-engine.cpp
index c2d104ae6ea..3564cc11c45 100644
--- a/src/libs/cplusplus/pp-engine.cpp
+++ b/src/libs/cplusplus/pp-engine.cpp
@@ -812,6 +812,9 @@ bool Preprocessor::handleIdentifier(PPToken *tk)
         if (!expandFunctionlikeMacros()
                 // Still expand if this originally started with an object-like macro.
                 && m_state.m_expansionStatus != Expanding) {
+            m_client->notifyMacroReference(m_state.m_offsetRef + idTk.offset,
+                                           idTk.lineno,
+                                           *macro);
             return false;
         }