forked from qt-creator/qt-creator
384 lines
14 KiB
C++
384 lines
14 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** 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 The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "clangeditordocumentprocessor.h"
|
|
|
|
#include "clangbackendipcintegration.h"
|
|
#include "clangdiagnostictooltipwidget.h"
|
|
#include "clangfixitoperation.h"
|
|
#include "clangfixitoperationsextractor.h"
|
|
#include "clanghighlightingmarksreporter.h"
|
|
#include "clangprojectsettings.h"
|
|
#include "clangutils.h"
|
|
|
|
#include <diagnosticcontainer.h>
|
|
#include <sourcelocationcontainer.h>
|
|
|
|
#include <cpptools/clangdiagnosticconfigsmodel.h>
|
|
#include <cpptools/clangdiagnosticconfigsmodel.h>
|
|
#include <cpptools/compileroptionsbuilder.h>
|
|
#include <cpptools/cppcodemodelsettings.h>
|
|
#include <cpptools/cppmodelmanager.h>
|
|
#include <cpptools/cpptoolsbridge.h>
|
|
#include <cpptools/cpptoolsreuse.h>
|
|
#include <cpptools/cppworkingcopy.h>
|
|
|
|
#include <texteditor/convenience.h>
|
|
#include <texteditor/fontsettings.h>
|
|
#include <texteditor/texteditor.h>
|
|
#include <texteditor/texteditorconstants.h>
|
|
#include <texteditor/texteditorsettings.h>
|
|
|
|
#include <cplusplus/CppDocument.h>
|
|
|
|
#include <utils/qtcassert.h>
|
|
#include <utils/runextensions.h>
|
|
|
|
#include <QTextBlock>
|
|
|
|
namespace ClangCodeModel {
|
|
namespace Internal {
|
|
|
|
ClangEditorDocumentProcessor::ClangEditorDocumentProcessor(
|
|
IpcCommunicator &ipcCommunicator,
|
|
TextEditor::TextDocument *document)
|
|
: BaseEditorDocumentProcessor(document->document(), document->filePath().toString())
|
|
, m_diagnosticManager(document)
|
|
, m_ipcCommunicator(ipcCommunicator)
|
|
, m_parser(new ClangEditorDocumentParser(document->filePath().toString()))
|
|
, m_parserRevision(0)
|
|
, m_semanticHighlighter(document)
|
|
, m_builtinProcessor(document, /*enableSemanticHighlighter=*/ false)
|
|
{
|
|
// Forwarding the semantic info from the builtin processor enables us to provide all
|
|
// editor (widget) related features that are not yet implemented by the clang plugin.
|
|
connect(&m_builtinProcessor, &CppTools::BuiltinEditorDocumentProcessor::cppDocumentUpdated,
|
|
this, &ClangEditorDocumentProcessor::cppDocumentUpdated);
|
|
connect(&m_builtinProcessor, &CppTools::BuiltinEditorDocumentProcessor::semanticInfoUpdated,
|
|
this, &ClangEditorDocumentProcessor::semanticInfoUpdated);
|
|
}
|
|
|
|
ClangEditorDocumentProcessor::~ClangEditorDocumentProcessor()
|
|
{
|
|
m_parserWatcher.cancel();
|
|
m_parserWatcher.waitForFinished();
|
|
|
|
if (m_projectPart) {
|
|
m_ipcCommunicator.unregisterTranslationUnitsForEditor(
|
|
{ClangBackEnd::FileContainer(filePath(), m_projectPart->id())});
|
|
}
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::run()
|
|
{
|
|
updateTranslationUnitIfProjectPartExists();
|
|
|
|
// Run clang parser
|
|
disconnect(&m_parserWatcher, &QFutureWatcher<void>::finished,
|
|
this, &ClangEditorDocumentProcessor::onParserFinished);
|
|
m_parserWatcher.cancel();
|
|
m_parserWatcher.setFuture(QFuture<void>());
|
|
|
|
m_parserRevision = revision();
|
|
connect(&m_parserWatcher, &QFutureWatcher<void>::finished,
|
|
this, &ClangEditorDocumentProcessor::onParserFinished);
|
|
const CppTools::WorkingCopy workingCopy = CppTools::CppModelManager::instance()->workingCopy();
|
|
const QFuture<void> future = ::Utils::runAsync(&runParser, parser(), workingCopy);
|
|
m_parserWatcher.setFuture(future);
|
|
|
|
// Run builtin processor
|
|
m_builtinProcessor.run();
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::recalculateSemanticInfoDetached(bool force)
|
|
{
|
|
m_builtinProcessor.recalculateSemanticInfoDetached(force);
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::semanticRehighlight()
|
|
{
|
|
m_semanticHighlighter.updateFormatMapFromFontSettings();
|
|
|
|
if (m_projectPart)
|
|
requestDocumentAnnotations(m_projectPart->id());
|
|
}
|
|
|
|
CppTools::SemanticInfo ClangEditorDocumentProcessor::recalculateSemanticInfo()
|
|
{
|
|
return m_builtinProcessor.recalculateSemanticInfo();
|
|
}
|
|
|
|
CppTools::BaseEditorDocumentParser::Ptr ClangEditorDocumentProcessor::parser()
|
|
{
|
|
return m_parser;
|
|
}
|
|
|
|
CPlusPlus::Snapshot ClangEditorDocumentProcessor::snapshot()
|
|
{
|
|
return m_builtinProcessor.snapshot();
|
|
}
|
|
|
|
bool ClangEditorDocumentProcessor::isParserRunning() const
|
|
{
|
|
return m_parserWatcher.isRunning();
|
|
}
|
|
|
|
bool ClangEditorDocumentProcessor::hasProjectPart() const
|
|
{
|
|
return m_projectPart;
|
|
}
|
|
|
|
CppTools::ProjectPart::Ptr ClangEditorDocumentProcessor::projectPart() const
|
|
{
|
|
return m_projectPart;
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::clearProjectPart()
|
|
{
|
|
m_projectPart.clear();
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::updateCodeWarnings(const QVector<ClangBackEnd::DiagnosticContainer> &diagnostics,
|
|
uint documentRevision)
|
|
{
|
|
if (documentRevision == revision()) {
|
|
m_diagnosticManager.processNewDiagnostics(diagnostics);
|
|
const auto codeWarnings = m_diagnosticManager.takeExtraSelections();
|
|
const auto fixitAvailableMarkers = m_diagnosticManager.takeFixItAvailableMarkers();
|
|
emit codeWarningsUpdated(revision(), codeWarnings, fixitAvailableMarkers);
|
|
}
|
|
}
|
|
namespace {
|
|
|
|
int positionInText(QTextDocument *textDocument,
|
|
const ClangBackEnd::SourceLocationContainer &sourceLocationContainer)
|
|
{
|
|
auto textBlock = textDocument->findBlockByNumber(int(sourceLocationContainer.line()) - 1);
|
|
|
|
return textBlock.position() + int(sourceLocationContainer.column()) - 1;
|
|
}
|
|
|
|
TextEditor::BlockRange
|
|
toTextEditorBlock(QTextDocument *textDocument,
|
|
const ClangBackEnd::SourceRangeContainer &sourceRangeContainer)
|
|
{
|
|
return TextEditor::BlockRange(positionInText(textDocument, sourceRangeContainer.start()),
|
|
positionInText(textDocument, sourceRangeContainer.end()));
|
|
}
|
|
|
|
QList<TextEditor::BlockRange>
|
|
toTextEditorBlocks(QTextDocument *textDocument,
|
|
const QVector<ClangBackEnd::SourceRangeContainer> &ifdefedOutRanges)
|
|
{
|
|
QList<TextEditor::BlockRange> blockRanges;
|
|
blockRanges.reserve(ifdefedOutRanges.size());
|
|
|
|
for (const auto &range : ifdefedOutRanges)
|
|
blockRanges.append(toTextEditorBlock(textDocument, range));
|
|
|
|
return blockRanges;
|
|
}
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::updateHighlighting(
|
|
const QVector<ClangBackEnd::HighlightingMarkContainer> &highlightingMarks,
|
|
const QVector<ClangBackEnd::SourceRangeContainer> &skippedPreprocessorRanges,
|
|
uint documentRevision)
|
|
{
|
|
if (documentRevision == revision()) {
|
|
const auto skippedPreprocessorBlocks = toTextEditorBlocks(textDocument(), skippedPreprocessorRanges);
|
|
emit ifdefedOutBlocksUpdated(documentRevision, skippedPreprocessorBlocks);
|
|
|
|
m_semanticHighlighter.setHighlightingRunner(
|
|
[highlightingMarks]() {
|
|
auto *reporter = new HighlightingMarksReporter(highlightingMarks);
|
|
return reporter->start();
|
|
});
|
|
m_semanticHighlighter.run();
|
|
}
|
|
}
|
|
|
|
static int currentLine(const TextEditor::AssistInterface &assistInterface)
|
|
{
|
|
int line, column;
|
|
TextEditor::Convenience::convertPosition(assistInterface.textDocument(),
|
|
assistInterface.position(),
|
|
&line,
|
|
&column);
|
|
return line;
|
|
}
|
|
|
|
TextEditor::QuickFixOperations ClangEditorDocumentProcessor::extraRefactoringOperations(
|
|
const TextEditor::AssistInterface &assistInterface)
|
|
{
|
|
ClangFixItOperationsExtractor extractor(m_diagnosticManager.diagnosticsWithFixIts());
|
|
|
|
return extractor.extract(assistInterface.fileName(), currentLine(assistInterface));
|
|
}
|
|
|
|
bool ClangEditorDocumentProcessor::hasDiagnosticsAt(uint line, uint column) const
|
|
{
|
|
return m_diagnosticManager.hasDiagnosticsAt(line, column);
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::addDiagnosticToolTipToLayout(uint line,
|
|
uint column,
|
|
QLayout *target) const
|
|
{
|
|
foreach (const auto &diagnostic, m_diagnosticManager.diagnosticsAt(line, column))
|
|
addToolTipToLayout(diagnostic, target);
|
|
}
|
|
|
|
ClangBackEnd::FileContainer ClangEditorDocumentProcessor::fileContainerWithArguments() const
|
|
{
|
|
return fileContainerWithArguments(m_projectPart.data());
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::clearDiagnosticsWithFixIts()
|
|
{
|
|
m_diagnosticManager.clearDiagnosticsWithFixIts();
|
|
}
|
|
|
|
ClangEditorDocumentProcessor *ClangEditorDocumentProcessor::get(const QString &filePath)
|
|
{
|
|
auto *processor = CppTools::CppToolsBridge::baseEditorDocumentProcessor(filePath);
|
|
|
|
return qobject_cast<ClangEditorDocumentProcessor*>(processor);
|
|
}
|
|
|
|
static bool isProjectPartLoadedOrIsFallback(CppTools::ProjectPart::Ptr projectPart)
|
|
{
|
|
return projectPart
|
|
&& (projectPart->id().isEmpty() || ClangCodeModel::Utils::isProjectPartLoaded(projectPart));
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::updateProjectPartAndTranslationUnitForEditor()
|
|
{
|
|
const CppTools::ProjectPart::Ptr projectPart = m_parser->projectPart();
|
|
|
|
if (isProjectPartLoadedOrIsFallback(projectPart)) {
|
|
registerTranslationUnitForEditor(projectPart.data());
|
|
|
|
m_projectPart = projectPart;
|
|
}
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::onParserFinished()
|
|
{
|
|
if (revision() != m_parserRevision)
|
|
return;
|
|
|
|
updateProjectPartAndTranslationUnitForEditor();
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::registerTranslationUnitForEditor(CppTools::ProjectPart *projectPart)
|
|
{
|
|
if (m_projectPart) {
|
|
if (projectPart->id() != m_projectPart->id()) {
|
|
m_ipcCommunicator.unregisterTranslationUnitsForEditor({fileContainerWithArguments()});
|
|
m_ipcCommunicator.registerTranslationUnitsForEditor({fileContainerWithArguments(projectPart)});
|
|
}
|
|
} else {
|
|
m_ipcCommunicator.registerTranslationUnitsForEditor({{fileContainerWithArguments(projectPart)}});
|
|
}
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::updateTranslationUnitIfProjectPartExists()
|
|
{
|
|
if (m_projectPart) {
|
|
const ClangBackEnd::FileContainer fileContainer = fileContainerWithDocumentContent(m_projectPart->id());
|
|
|
|
m_ipcCommunicator.updateTranslationUnitWithRevisionCheck(fileContainer);
|
|
}
|
|
}
|
|
|
|
void ClangEditorDocumentProcessor::requestDocumentAnnotations(const QString &projectpartId)
|
|
{
|
|
const auto fileContainer = fileContainerWithDocumentContent(projectpartId);
|
|
|
|
m_ipcCommunicator.requestDocumentAnnotations(fileContainer);
|
|
}
|
|
|
|
static CppTools::ProjectPart projectPartForLanguageOption(CppTools::ProjectPart *projectPart)
|
|
{
|
|
if (projectPart)
|
|
return *projectPart;
|
|
return *CppTools::CppModelManager::instance()->fallbackProjectPart().data();
|
|
}
|
|
|
|
static QStringList languageOptions(const QString &filePath, CppTools::ProjectPart *projectPart)
|
|
{
|
|
const auto theProjectPart = projectPartForLanguageOption(projectPart);
|
|
CppTools::CompilerOptionsBuilder builder(theProjectPart);
|
|
builder.addLanguageOption(CppTools::ProjectFile::classify(filePath));
|
|
|
|
return builder.options();
|
|
}
|
|
|
|
static QStringList warningOptions(CppTools::ProjectPart *projectPart)
|
|
{
|
|
if (projectPart && projectPart->project) {
|
|
ClangProjectSettings projectSettings(projectPart->project);
|
|
if (!projectSettings.useGlobalWarningConfig()) {
|
|
const Core::Id warningConfigId = projectSettings.warningConfigId();
|
|
const CppTools::ClangDiagnosticConfigsModel configsModel(
|
|
CppTools::codeModelSettings()->clangCustomDiagnosticConfigs());
|
|
if (configsModel.hasConfigWithId(warningConfigId))
|
|
return configsModel.configWithId(warningConfigId).commandLineOptions();
|
|
}
|
|
}
|
|
|
|
return CppTools::codeModelSettings()->clangDiagnosticConfig().commandLineOptions();
|
|
}
|
|
|
|
static QStringList fileArguments(const QString &filePath, CppTools::ProjectPart *projectPart)
|
|
{
|
|
return languageOptions(filePath, projectPart) + warningOptions(projectPart);
|
|
}
|
|
|
|
ClangBackEnd::FileContainer
|
|
ClangEditorDocumentProcessor::fileContainerWithArguments(CppTools::ProjectPart *projectPart) const
|
|
{
|
|
const auto projectPartId = projectPart
|
|
? Utf8String::fromString(projectPart->id())
|
|
: Utf8String();
|
|
const QStringList theFileArguments = fileArguments(filePath(), projectPart);
|
|
|
|
return {filePath(), projectPartId, Utf8StringVector(theFileArguments), revision()};
|
|
}
|
|
|
|
ClangBackEnd::FileContainer
|
|
ClangEditorDocumentProcessor::fileContainerWithDocumentContent(const QString &projectpartId) const
|
|
{
|
|
return ClangBackEnd::FileContainer(filePath(),
|
|
projectpartId,
|
|
textDocument()->toPlainText(),
|
|
true,
|
|
revision());
|
|
}
|
|
|
|
} // namespace Internal
|
|
} // namespace ClangCodeModel
|