CppTools: Extract BaseEditorDocumentParser out of SnapshotUpdater

Change-Id: If89e81eec6d600d3d39cc09203cf434d0768c1b4
Reviewed-by: Erik Verbruggen <erik.verbruggen@digia.com>

1 files changed, 143 insertions, 0 deletions

diff --git a/src/plugins/cpptools/baseeditordocumentparser.cpp b/src/plugins/cpptools/baseeditordocumentparser.cpp
new file mode 100644
index 0000000000..058fae5b99
--- /dev/null
+++ b/src/plugins/cpptools/baseeditordocumentparser.cpp
@@ -0,0 +1,143 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "baseeditordocumentparser.h"
+
+namespace CppTools {
+
+/*!
+    \class CppTools::BaseEditorDocumentParser
+
+    \brief The BaseEditorDocumentParser class parses a source text as
+           precisely as possible.
+
+    It's meant to be used in the C++ editor to get precise results by using
+    the "best" project part for a file.
+
+    Derived classes are expected to implement update() by using the protected
+    mutex, updateProjectPart() and by respecting the options set by the client.
+*/
+
+BaseEditorDocumentParser::BaseEditorDocumentParser(const QString &filePath)
+    : m_mutex(QMutex::Recursive)
+    , m_filePath(filePath)
+    , m_usePrecompiledHeaders(false)
+    , m_editorDefinesChangedSinceLastUpdate(false)
+{
+}
+
+BaseEditorDocumentParser::~BaseEditorDocumentParser()
+{
+}
+
+QString BaseEditorDocumentParser::filePath() const
+{
+    return m_filePath;
+}
+
+ProjectPart::Ptr BaseEditorDocumentParser::projectPart() const
+{
+    QMutexLocker locker(&m_mutex);
+    return m_projectPart;
+}
+
+void BaseEditorDocumentParser::setProjectPart(ProjectPart::Ptr projectPart)
+{
+    QMutexLocker locker(&m_mutex);
+    m_manuallySetProjectPart = projectPart;
+}
+
+bool BaseEditorDocumentParser::usePrecompiledHeaders() const
+{
+    QMutexLocker locker(&m_mutex);
+    return m_usePrecompiledHeaders;
+}
+
+void BaseEditorDocumentParser::setUsePrecompiledHeaders(bool usePrecompiledHeaders)
+{
+    QMutexLocker locker(&m_mutex);
+    m_usePrecompiledHeaders = usePrecompiledHeaders;
+}
+
+QByteArray BaseEditorDocumentParser::editorDefines() const
+{
+    QMutexLocker locker(&m_mutex);
+    return m_editorDefines;
+}
+
+void BaseEditorDocumentParser::setEditorDefines(const QByteArray &editorDefines)
+{
+    QMutexLocker locker(&m_mutex);
+
+    if (editorDefines != m_editorDefines) {
+        m_editorDefines = editorDefines;
+        m_editorDefinesChangedSinceLastUpdate = true;
+    }
+}
+
+void BaseEditorDocumentParser::updateProjectPart()
+{
+    if (m_manuallySetProjectPart) {
+        m_projectPart = m_manuallySetProjectPart;
+        return;
+    }
+
+    CppModelManagerInterface *cmm = CppModelManagerInterface::instance();
+    QList<ProjectPart::Ptr> projectParts = cmm->projectPart(m_filePath);
+    if (projectParts.isEmpty()) {
+        if (m_projectPart)
+            // File is not directly part of any project, but we got one before. We will re-use it,
+            // because re-calculating this can be expensive when the dependency table is big.
+            return;
+
+        // Fall-back step 1: Get some parts through the dependency table:
+        projectParts = cmm->projectPartFromDependencies(m_filePath);
+        if (projectParts.isEmpty())
+            // Fall-back step 2: Use fall-back part from the model manager:
+            m_projectPart = cmm->fallbackProjectPart();
+        else
+            m_projectPart = projectParts.first();
+    } else {
+        if (!projectParts.contains(m_projectPart))
+            // Apparently the project file changed, so update our project part.
+            m_projectPart = projectParts.first();
+    }
+}
+
+bool BaseEditorDocumentParser::editorDefinesChanged() const
+{
+    return m_editorDefinesChangedSinceLastUpdate;
+}
+
+void BaseEditorDocumentParser::resetEditorDefinesChanged()
+{
+    m_editorDefinesChangedSinceLastUpdate = false;
+}
+
+} // namespace CppTools