2014-08-19 15:59:29 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
**
|
|
|
|
|
** 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
|
2014-10-15 14:46:23 +02:00
|
|
|
** conditions see http://www.qt.io/licensing. For further information
|
|
|
|
|
** use the contact form at http://www.qt.io/contact-us.
|
2014-08-19 15:59:29 +02:00
|
|
|
**
|
|
|
|
|
** GNU Lesser General Public License Usage
|
|
|
|
|
** Alternatively, this file may be used under the terms of the GNU Lesser
|
2014-10-15 14:46:23 +02:00
|
|
|
** General Public License version 2.1 or version 3 as published by the Free
|
|
|
|
|
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
|
|
|
|
|
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
|
|
|
|
|
** following information to ensure the GNU Lesser General Public License
|
|
|
|
|
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
|
|
|
|
|
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
2014-08-19 15:59:29 +02:00
|
|
|
**
|
|
|
|
|
** 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 "builtineditordocumentprocessor.h"
|
|
|
|
|
|
|
|
|
|
#include "cppchecksymbols.h"
|
|
|
|
|
#include "cppcodemodelsettings.h"
|
|
|
|
|
#include "cppmodelmanager.h"
|
|
|
|
|
#include "cpptoolsplugin.h"
|
|
|
|
|
#include "cpptoolsreuse.h"
|
|
|
|
|
#include "cppworkingcopy.h"
|
|
|
|
|
|
2014-09-26 09:14:03 +02:00
|
|
|
#include <texteditor/texteditor.h>
|
2014-08-19 15:59:29 +02:00
|
|
|
#include <texteditor/convenience.h>
|
|
|
|
|
|
|
|
|
|
#include <cplusplus/CppDocument.h>
|
|
|
|
|
#include <cplusplus/SimpleLexer.h>
|
|
|
|
|
|
|
|
|
|
#include <utils/QtConcurrentTools>
|
|
|
|
|
#include <utils/qtcassert.h>
|
|
|
|
|
|
2014-10-23 12:39:59 +02:00
|
|
|
#include <QLoggingCategory>
|
|
|
|
|
|
|
|
|
|
static Q_LOGGING_CATEGORY(log, "qtc.cpptools.builtineditordocumentprocessor")
|
2014-08-19 15:59:29 +02:00
|
|
|
|
|
|
|
|
namespace {
|
|
|
|
|
|
2014-10-23 12:39:59 +02:00
|
|
|
CppTools::CheckSymbols *createHighlighter(const CPlusPlus::Document::Ptr &doc,
|
|
|
|
|
const CPlusPlus::Snapshot &snapshot,
|
|
|
|
|
QTextDocument *textDocument)
|
2014-08-19 15:59:29 +02:00
|
|
|
{
|
2014-09-15 11:13:36 +02:00
|
|
|
QTC_ASSERT(doc, return 0);
|
|
|
|
|
QTC_ASSERT(doc->translationUnit(), return 0);
|
|
|
|
|
QTC_ASSERT(doc->translationUnit()->ast(), return 0);
|
|
|
|
|
QTC_ASSERT(textDocument, return 0);
|
2014-08-19 15:59:29 +02:00
|
|
|
|
|
|
|
|
using namespace CPlusPlus;
|
|
|
|
|
using namespace CppTools;
|
|
|
|
|
typedef TextEditor::HighlightingResult Result;
|
|
|
|
|
QList<Result> macroUses;
|
|
|
|
|
|
|
|
|
|
using TextEditor::Convenience::convertPosition;
|
|
|
|
|
|
|
|
|
|
// Get macro definitions
|
|
|
|
|
foreach (const CPlusPlus::Macro& macro, doc->definedMacros()) {
|
|
|
|
|
int line, column;
|
|
|
|
|
convertPosition(textDocument, macro.utf16CharOffset(), &line, &column);
|
|
|
|
|
|
|
|
|
|
++column; //Highlighting starts at (column-1) --> compensate here
|
|
|
|
|
Result use(line, column, macro.nameToQString().size(), SemanticHighlighter::MacroUse);
|
|
|
|
|
macroUses.append(use);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Get macro uses
|
|
|
|
|
foreach (const Document::MacroUse ¯o, doc->macroUses()) {
|
|
|
|
|
const QString name = macro.macro().nameToQString();
|
|
|
|
|
|
|
|
|
|
//Filter out QtKeywords
|
|
|
|
|
if (isQtKeyword(QStringRef(&name)))
|
|
|
|
|
continue;
|
|
|
|
|
|
|
|
|
|
// Filter out C++ keywords
|
|
|
|
|
// FIXME: Check default values or get from document.
|
|
|
|
|
LanguageFeatures features;
|
|
|
|
|
features.cxx11Enabled = true;
|
|
|
|
|
features.c99Enabled = true;
|
|
|
|
|
|
|
|
|
|
SimpleLexer tokenize;
|
|
|
|
|
tokenize.setLanguageFeatures(features);
|
|
|
|
|
|
|
|
|
|
const QList<Token> tokens = tokenize(name);
|
|
|
|
|
if (tokens.length() && (tokens.at(0).isKeyword() || tokens.at(0).isObjCAtKeyword()))
|
|
|
|
|
continue;
|
|
|
|
|
|
|
|
|
|
int line, column;
|
|
|
|
|
convertPosition(textDocument, macro.utf16charsBegin(), &line, &column);
|
|
|
|
|
++column; //Highlighting starts at (column-1) --> compensate here
|
|
|
|
|
Result use(line, column, name.size(), SemanticHighlighter::MacroUse);
|
|
|
|
|
macroUses.append(use);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
LookupContext context(doc, snapshot);
|
2014-09-15 11:13:36 +02:00
|
|
|
return CheckSymbols::create(doc, context, macroUses);
|
2014-08-19 15:59:29 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
QList<TextEditor::BlockRange> toTextEditorBlocks(
|
|
|
|
|
const QList<CPlusPlus::Document::Block> &skippedBlocks)
|
|
|
|
|
{
|
|
|
|
|
QList<TextEditor::BlockRange> result;
|
|
|
|
|
result.reserve(skippedBlocks.size());
|
|
|
|
|
foreach (const CPlusPlus::Document::Block &block, skippedBlocks)
|
|
|
|
|
result.append(TextEditor::BlockRange(block.utf16charsBegin(), block.utf16charsEnd()));
|
|
|
|
|
return result;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
} // anonymous namespace
|
|
|
|
|
|
|
|
|
|
namespace CppTools {
|
|
|
|
|
|
|
|
|
|
BuiltinEditorDocumentProcessor::BuiltinEditorDocumentProcessor(
|
2014-09-22 18:43:31 +02:00
|
|
|
TextEditor::TextDocument *document,
|
2014-08-19 15:59:29 +02:00
|
|
|
bool enableSemanticHighlighter)
|
|
|
|
|
: BaseEditorDocumentProcessor(document)
|
2014-08-26 15:24:58 +02:00
|
|
|
, m_parser(document->filePath())
|
2014-09-15 11:13:36 +02:00
|
|
|
, m_codeWarningsUpdated(false)
|
2014-08-19 15:59:29 +02:00
|
|
|
, m_semanticHighlighter(enableSemanticHighlighter
|
|
|
|
|
? new CppTools::SemanticHighlighter(document)
|
|
|
|
|
: 0)
|
|
|
|
|
{
|
2014-08-26 13:28:31 +02:00
|
|
|
using namespace Internal;
|
|
|
|
|
|
|
|
|
|
QSharedPointer<CppCodeModelSettings> cms = CppToolsPlugin::instance()->codeModelSettings();
|
2014-08-26 15:24:58 +02:00
|
|
|
m_parser.setUsePrecompiledHeaders(cms->pchUsage() != CppCodeModelSettings::PchUse_None);
|
2014-08-19 15:59:29 +02:00
|
|
|
|
|
|
|
|
if (m_semanticHighlighter) {
|
|
|
|
|
m_semanticHighlighter->setHighlightingRunner(
|
|
|
|
|
[this]() -> QFuture<TextEditor::HighlightingResult> {
|
|
|
|
|
const SemanticInfo semanticInfo = m_semanticInfoUpdater.semanticInfo();
|
2014-09-15 11:13:36 +02:00
|
|
|
CheckSymbols *checkSymbols = createHighlighter(semanticInfo.doc, semanticInfo.snapshot,
|
|
|
|
|
baseTextDocument()->document());
|
|
|
|
|
QTC_ASSERT(checkSymbols, return QFuture<TextEditor::HighlightingResult>());
|
|
|
|
|
connect(checkSymbols, &CheckSymbols::codeWarningsUpdated,
|
|
|
|
|
this, &BuiltinEditorDocumentProcessor::onCodeWarningsUpdated);
|
|
|
|
|
return checkSymbols->start();
|
2014-08-19 15:59:29 +02:00
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
2014-08-26 15:24:58 +02:00
|
|
|
connect(&m_parser, &BuiltinEditorDocumentParser::finished,
|
2014-08-26 14:26:28 +02:00
|
|
|
this, &BuiltinEditorDocumentProcessor::onParserFinished);
|
2014-08-19 15:59:29 +02:00
|
|
|
connect(&m_semanticInfoUpdater, &SemanticInfoUpdater::updated,
|
|
|
|
|
this, &BuiltinEditorDocumentProcessor::onSemanticInfoUpdated);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
BuiltinEditorDocumentProcessor::~BuiltinEditorDocumentProcessor()
|
|
|
|
|
{
|
|
|
|
|
m_parserFuture.cancel();
|
|
|
|
|
m_parserFuture.waitForFinished();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void BuiltinEditorDocumentProcessor::run()
|
|
|
|
|
{
|
2014-09-15 00:12:27 +02:00
|
|
|
m_parserFuture = QtConcurrent::run(&runParser, parser(), CppTools::CppModelManager::instance()->workingCopy());
|
2014-08-19 15:59:29 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
BaseEditorDocumentParser *BuiltinEditorDocumentProcessor::parser()
|
|
|
|
|
{
|
2014-08-26 15:24:58 +02:00
|
|
|
return &m_parser;
|
2014-08-19 15:59:29 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void BuiltinEditorDocumentProcessor::semanticRehighlight(bool force)
|
|
|
|
|
{
|
|
|
|
|
const auto source = createSemanticInfoSource(force);
|
|
|
|
|
m_semanticInfoUpdater.updateDetached(source);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
SemanticInfo BuiltinEditorDocumentProcessor::recalculateSemanticInfo()
|
|
|
|
|
{
|
|
|
|
|
const auto source = createSemanticInfoSource(false);
|
|
|
|
|
return m_semanticInfoUpdater.update(source);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
bool BuiltinEditorDocumentProcessor::isParserRunning() const
|
|
|
|
|
{
|
|
|
|
|
return m_parserFuture.isRunning();
|
|
|
|
|
}
|
|
|
|
|
|
2014-08-26 14:26:28 +02:00
|
|
|
void BuiltinEditorDocumentProcessor::onParserFinished(CPlusPlus::Document::Ptr document,
|
|
|
|
|
CPlusPlus::Snapshot snapshot)
|
2014-08-19 15:59:29 +02:00
|
|
|
{
|
|
|
|
|
if (document.isNull())
|
|
|
|
|
return;
|
|
|
|
|
|
|
|
|
|
if (document->fileName() != filePath())
|
|
|
|
|
return; // some other document got updated
|
|
|
|
|
|
|
|
|
|
if (document->editorRevision() != revision())
|
|
|
|
|
return; // outdated content, wait for a new document to be parsed
|
|
|
|
|
|
2014-10-23 12:39:59 +02:00
|
|
|
qCDebug(log) << "document parsed" << document->fileName() << document->editorRevision();
|
2014-08-19 15:59:29 +02:00
|
|
|
|
|
|
|
|
// Emit ifdefed out blocks
|
|
|
|
|
const auto ifdefoutBlocks = toTextEditorBlocks(document->skippedBlocks());
|
|
|
|
|
emit ifdefedOutBlocksUpdated(revision(), ifdefoutBlocks);
|
|
|
|
|
|
2014-09-15 11:13:36 +02:00
|
|
|
// Store parser warnings
|
|
|
|
|
m_codeWarnings = toTextEditorSelections(document->diagnosticMessages(), textDocument());
|
|
|
|
|
m_codeWarningsUpdated = false;
|
2014-08-19 15:59:29 +02:00
|
|
|
|
|
|
|
|
emit cppDocumentUpdated(document);
|
|
|
|
|
|
2014-08-26 14:26:28 +02:00
|
|
|
m_documentSnapshot = snapshot;
|
2014-08-19 15:59:29 +02:00
|
|
|
const auto source = createSemanticInfoSource(false);
|
2014-08-26 14:26:28 +02:00
|
|
|
QTC_CHECK(source.snapshot.contains(document->fileName()));
|
2014-08-19 15:59:29 +02:00
|
|
|
m_semanticInfoUpdater.updateDetached(source);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void BuiltinEditorDocumentProcessor::onSemanticInfoUpdated(const SemanticInfo semanticInfo)
|
|
|
|
|
{
|
2014-10-23 12:39:59 +02:00
|
|
|
qCDebug(log) << "semantic info updated"
|
2014-08-19 15:59:29 +02:00
|
|
|
<< semanticInfo.doc->fileName() << semanticInfo.revision << semanticInfo.complete;
|
|
|
|
|
|
|
|
|
|
emit semanticInfoUpdated(semanticInfo);
|
|
|
|
|
|
|
|
|
|
if (m_semanticHighlighter)
|
|
|
|
|
m_semanticHighlighter->run();
|
|
|
|
|
}
|
|
|
|
|
|
2014-09-15 11:13:36 +02:00
|
|
|
void BuiltinEditorDocumentProcessor::onCodeWarningsUpdated(
|
|
|
|
|
CPlusPlus::Document::Ptr document,
|
|
|
|
|
const QList<CPlusPlus::Document::DiagnosticMessage> &codeWarnings)
|
|
|
|
|
{
|
|
|
|
|
if (document.isNull())
|
|
|
|
|
return;
|
|
|
|
|
|
|
|
|
|
if (document->fileName() != filePath())
|
|
|
|
|
return; // some other document got updated
|
|
|
|
|
|
|
|
|
|
if (document->editorRevision() != revision())
|
|
|
|
|
return; // outdated content, wait for a new document to be parsed
|
|
|
|
|
|
|
|
|
|
if (m_codeWarningsUpdated)
|
|
|
|
|
return; // code warnings already updated
|
|
|
|
|
|
|
|
|
|
m_codeWarnings += toTextEditorSelections(codeWarnings, textDocument());
|
|
|
|
|
m_codeWarningsUpdated = true;
|
|
|
|
|
emit codeWarningsUpdated(revision(), m_codeWarnings);
|
|
|
|
|
}
|
|
|
|
|
|
2014-08-19 15:59:29 +02:00
|
|
|
SemanticInfo::Source BuiltinEditorDocumentProcessor::createSemanticInfoSource(bool force) const
|
|
|
|
|
{
|
2014-09-15 00:12:27 +02:00
|
|
|
const WorkingCopy workingCopy = CppTools::CppModelManager::instance()->workingCopy();
|
2014-08-19 15:59:29 +02:00
|
|
|
const QString path = filePath();
|
|
|
|
|
return SemanticInfo::Source(path,
|
|
|
|
|
workingCopy.source(path),
|
|
|
|
|
workingCopy.revision(path),
|
2014-08-26 14:26:28 +02:00
|
|
|
m_documentSnapshot,
|
2014-08-19 15:59:29 +02:00
|
|
|
force);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
} // namespace CppTools
|