clangeditordocumentprocessor.cpp 17.3 KB
Newer Older
1 2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
5 6 7 8 9 10 11
**
** 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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Tobias Hunger's avatar
Tobias Hunger committed
14
** use the contact form at http://www.qt.io/contact-us.
15 16 17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Tobias Hunger's avatar
Tobias Hunger committed
18 19 20 21 22 23
** 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.
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
27 28 29 30 31 32
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "clangeditordocumentprocessor.h"

33 34
#include "clangmodelmanagersupport.h"
#include "clangutils.h"
35 36 37 38
#include "cppcreatemarkers.h"
#include "diagnostic.h"
#include "pchinfo.h"

Marco Bubke's avatar
Marco Bubke committed
39 40 41
#include <diagnosticcontainer.h>
#include <sourcelocationcontainer.h>

42 43 44
#include <cpptools/cpptoolsplugin.h>
#include <cpptools/cppworkingcopy.h>

Marco Bubke's avatar
Marco Bubke committed
45 46
#include <texteditor/texteditor.h>

47 48 49 50 51
#include <cplusplus/CppDocument.h>

#include <utils/qtcassert.h>
#include <utils/QtConcurrentTools>

Marco Bubke's avatar
Marco Bubke committed
52 53
#include <QTextBlock>

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
namespace {

typedef CPlusPlus::Document::DiagnosticMessage CppToolsDiagnostic;

QList<TextEditor::BlockRange> toTextEditorBlocks(
        const QList<ClangCodeModel::SemanticMarker::Range> &ranges)
{
    QList<TextEditor::BlockRange> result;
    result.reserve(ranges.size());
    foreach (const ClangCodeModel::SemanticMarker::Range &range, ranges)
        result.append(TextEditor::BlockRange(range.first, range.last));
    return result;
}

} // anonymous namespace

namespace ClangCodeModel {
71
namespace Internal {
72

73 74 75
ClangEditorDocumentProcessor::ClangEditorDocumentProcessor(
        ModelManagerSupportClang *modelManagerSupport,
        TextEditor::TextDocument *document)
76
    : BaseEditorDocumentProcessor(document)
77
    , m_modelManagerSupport(modelManagerSupport)
78
    , m_parser(document->filePath().toString())
79 80 81 82 83 84 85 86 87 88 89
    , 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);

90 91 92
    connect(CppTools::CppModelManager::instance(), &CppTools::CppModelManager::projectPartsRemoved,
            this, &ClangEditorDocumentProcessor::onProjectPartsRemoved);

93 94 95 96 97
    m_semanticHighlighter.setHighlightingRunner(
        [this]() -> QFuture<TextEditor::HighlightingResult> {
            const int firstLine = 1;
            const int lastLine = baseTextDocument()->document()->blockCount();

98
            CreateMarkers *createMarkers = CreateMarkers::create(m_parser.semanticMarker(),
99
                                                                 baseTextDocument()->filePath().toString(),
100 101 102 103 104 105 106 107 108
                                                                 firstLine, lastLine);
            return createMarkers->start();
        });
}

ClangEditorDocumentProcessor::~ClangEditorDocumentProcessor()
{
    m_parserWatcher.cancel();
    m_parserWatcher.waitForFinished();
109

110 111 112 113 114
    if (m_projectPart) {
        QTC_ASSERT(m_modelManagerSupport, return);
        m_modelManagerSupport->ipcCommunicator().unregisterFilesForCodeCompletion(
            {ClangBackEnd::FileContainer(filePath(), m_projectPart->id())});
    }
115 116 117 118
}

void ClangEditorDocumentProcessor::run()
{
Marco Bubke's avatar
Marco Bubke committed
119 120
    requestDiagnostics();

121 122 123 124 125 126 127 128 129
    // 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);
130 131 132
    const QFuture<void> future = QtConcurrent::run(&runParser,
                                                   parser(),
                                                   ClangEditorDocumentParser::InMemoryInfo(true));
133 134 135 136 137 138
    m_parserWatcher.setFuture(future);

    // Run builtin processor
    m_builtinProcessor.run();
}

139
void ClangEditorDocumentProcessor::recalculateSemanticInfoDetached(bool force)
140
{
141
    m_builtinProcessor.recalculateSemanticInfoDetached(force);
142 143
}

144 145 146 147 148 149
void ClangEditorDocumentProcessor::semanticRehighlight()
{
    m_semanticHighlighter.updateFormatMapFromFontSettings();
    m_semanticHighlighter.run();
}

150 151 152 153 154 155 156
CppTools::SemanticInfo ClangEditorDocumentProcessor::recalculateSemanticInfo()
{
    return m_builtinProcessor.recalculateSemanticInfo();
}

CppTools::BaseEditorDocumentParser *ClangEditorDocumentProcessor::parser()
{
157
    return &m_parser;
158 159
}

160 161 162 163 164
CPlusPlus::Snapshot ClangEditorDocumentProcessor::snapshot()
{
   return m_builtinProcessor.snapshot();
}

165 166 167 168 169
bool ClangEditorDocumentProcessor::isParserRunning() const
{
    return m_parserWatcher.isRunning();
}

170 171 172 173 174
CppTools::ProjectPart::Ptr ClangEditorDocumentProcessor::projectPart() const
{
    return m_projectPart;
}

Marco Bubke's avatar
Marco Bubke committed
175 176 177 178 179 180 181 182 183
void ClangEditorDocumentProcessor::updateCodeWarnings(const QVector<ClangBackEnd::DiagnosticContainer> &diagnostics,
                                                      uint documentRevision)
{
    if (documentRevision == revision()) {
        const auto codeWarnings = generateDiagnosticHints(diagnostics);
        emit codeWarningsUpdated(revision(), codeWarnings);
    }
}

184 185 186 187 188 189 190 191 192 193 194
ClangEditorDocumentProcessor *ClangEditorDocumentProcessor::get(const QString &filePath)
{
    return qobject_cast<ClangEditorDocumentProcessor *>(BaseEditorDocumentProcessor::get(filePath));
}

void ClangEditorDocumentProcessor::updateProjectPartAndTranslationUnitForCompletion()
{
    const CppTools::ProjectPart::Ptr projectPart = m_parser.projectPart();
    QTC_ASSERT(projectPart, return);

    updateTranslationUnitForCompletion(*projectPart.data());
Marco Bubke's avatar
Marco Bubke committed
195 196
    requestDiagnostics(*projectPart.data());

197 198 199
    m_projectPart = projectPart;
}

200 201 202 203 204 205
void ClangEditorDocumentProcessor::onParserFinished()
{
    if (revision() != m_parserRevision)
        return;

    // Emit ifdefed out blocks
206
    const auto ifdefoutBlocks = toTextEditorBlocks(m_parser.ifdefedOutBlocks());
207 208 209 210
    emit ifdefedOutBlocksUpdated(revision(), ifdefoutBlocks);

    // Run semantic highlighter
    m_semanticHighlighter.run();
211 212 213 214 215 216 217 218 219 220

    updateProjectPartAndTranslationUnitForCompletion();
}

void ClangEditorDocumentProcessor::onProjectPartsRemoved(const QStringList &projectPartIds)
{
    if (m_projectPart && projectPartIds.contains(m_projectPart->id()))
        m_projectPart.clear();
}

Marco Bubke's avatar
Marco Bubke committed
221
void ClangEditorDocumentProcessor::updateTranslationUnitForCompletion(CppTools::ProjectPart &projectPart)
222 223 224 225 226 227
{
    QTC_ASSERT(m_modelManagerSupport, return);
    IpcCommunicator &ipcCommunicator = m_modelManagerSupport->ipcCommunicator();

    if (m_projectPart) {
        if (projectPart.id() != m_projectPart->id()) {
Marco Bubke's avatar
Marco Bubke committed
228 229
            auto container1 = ClangBackEnd::FileContainer(filePath(), m_projectPart->id());
            ipcCommunicator.unregisterFilesForCodeCompletion({container1});
230

Marco Bubke's avatar
Marco Bubke committed
231 232
            auto container2 = ClangBackEnd::FileContainer(filePath(), projectPart.id());
            ipcCommunicator.registerFilesForCodeCompletion({container2});
233 234
        }
    } else {
Marco Bubke's avatar
Marco Bubke committed
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
        auto container = ClangBackEnd::FileContainer(filePath(), projectPart.id());
        ipcCommunicator.registerFilesForCodeCompletion({container});
    }
}

namespace {
bool isWarningOrNote(ClangBackEnd::DiagnosticSeverity severity)
{
    using ClangBackEnd::DiagnosticSeverity;
    switch (severity) {
        case DiagnosticSeverity::Ignored:
        case DiagnosticSeverity::Note:
        case DiagnosticSeverity::Warning: return true;
        case DiagnosticSeverity::Error:
        case DiagnosticSeverity::Fatal: return false;
    }

    Q_UNREACHABLE();
}

bool isHelpfulChildDiagnostic(const ClangBackEnd::DiagnosticContainer &parentDiagnostic,
                              const ClangBackEnd::DiagnosticContainer &childDiagnostic)
{
    auto parentLocation = parentDiagnostic.location();
    auto childLocation = childDiagnostic.location();

    return parentLocation == childLocation;
}

QString diagnosticText(const ClangBackEnd::DiagnosticContainer &diagnostic)
{
    QString text = diagnostic.category().toString()
            + QStringLiteral(" ")
            + diagnostic.text().toString();
    if (!diagnostic.enableOption().isEmpty()) {
        text += QStringLiteral(" (clang option: ")
                + diagnostic.enableOption().toString()
                + QStringLiteral(" disable with: ")
                + diagnostic.disableOption().toString()
                + QStringLiteral(")");
    }

    for (auto &&childDiagnostic : diagnostic.children()) {
        if (isHelpfulChildDiagnostic(diagnostic, childDiagnostic))
            text += QStringLiteral("\n  ") + childDiagnostic.text().toString();
    }

    return text;
}

template <class Condition>
std::vector<ClangBackEnd::DiagnosticContainer>
filterDiagnostics(const QVector<ClangBackEnd::DiagnosticContainer> &diagnostics,
                  const Condition &condition)
{
    std::vector<ClangBackEnd::DiagnosticContainer> filteredDiagnostics;

    std::copy_if(diagnostics.cbegin(),
                 diagnostics.cend(),
                 std::back_inserter(filteredDiagnostics),
                 condition);

    return filteredDiagnostics;
}

std::vector<ClangBackEnd::DiagnosticContainer>
filterInterestingWarningDiagnostics(const QVector<ClangBackEnd::DiagnosticContainer> &diagnostics,
                                    QString &&documentFilePath)
{
    auto isLocalWarning = [documentFilePath] (const ClangBackEnd::DiagnosticContainer &diagnostic) {
        return isWarningOrNote(diagnostic.severity())
            && diagnostic.location().filePath() == documentFilePath;
    };

    return filterDiagnostics(diagnostics, isLocalWarning);
}

std::vector<ClangBackEnd::DiagnosticContainer>
filterInterestingErrorsDiagnostics(const QVector<ClangBackEnd::DiagnosticContainer> &diagnostics,
                                   QString &&documentFilePath)
{
    auto isLocalWarning = [documentFilePath] (const ClangBackEnd::DiagnosticContainer &diagnostic) {
        return !isWarningOrNote(diagnostic.severity())
            && diagnostic.location().filePath() == documentFilePath;
    };

    return filterDiagnostics(diagnostics, isLocalWarning);
}

QTextEdit::ExtraSelection createExtraSelections(const QTextCharFormat &mainformat,
                                               const QTextCursor &cursor,
                                               const QString &diagnosticText)
{
    QTextEdit::ExtraSelection extraSelection;

    extraSelection.format = mainformat;
    extraSelection.cursor = cursor;
    extraSelection.format.setToolTip(diagnosticText);

    return extraSelection;
}

void addRangeSelections(const ClangBackEnd::DiagnosticContainer &diagnostic,
                        QTextDocument *textDocument,
                        const QTextCharFormat &rangeFormat,
                        const QString &diagnosticText,
                        QList<QTextEdit::ExtraSelection> &extraSelections)
{
    for (auto &&range : diagnostic.ranges()) {
        QTextCursor cursor(textDocument);
        cursor.setPosition(int(range.start().offset()));
        cursor.setPosition(int(range.end().offset()), QTextCursor::KeepAnchor);

        auto extraSelection = createExtraSelections(rangeFormat, cursor, diagnosticText);

        extraSelections.push_back(std::move(extraSelection));
    }
}

QTextCursor createSelectionCursor(QTextDocument *textDocument, uint position)
{
    QTextCursor cursor(textDocument);
    cursor.setPosition(int(position));
    cursor.movePosition(QTextCursor::EndOfWord, QTextCursor::KeepAnchor);

    if (!cursor.hasSelection()) {
        cursor.setPosition(int(position) - 1);
        cursor.movePosition(QTextCursor::Right, QTextCursor::KeepAnchor, 2);
    }

    return cursor;
}

void addSelections(const std::vector<ClangBackEnd::DiagnosticContainer> &diagnostics,
                   QTextDocument *textDocument,
                   const QTextCharFormat &mainFormat,
                   const QTextCharFormat &rangeFormat,
                   QList<QTextEdit::ExtraSelection> &extraSelections)
{
    for (auto &&diagnostic : diagnostics) {
        auto cursor = createSelectionCursor(textDocument, diagnostic.location().offset());

        auto text = diagnosticText(diagnostic);
        auto extraSelection = createExtraSelections(mainFormat, cursor, text);

        addRangeSelections(diagnostic, textDocument, rangeFormat, text, extraSelections);

        extraSelections.push_back(std::move(extraSelection));
    }
}

void addWarningSelections(const std::vector<ClangBackEnd::DiagnosticContainer> &diagnostics,
                          QTextDocument *textDocument,
                          QList<QTextEdit::ExtraSelection> &extraSelections)
{
    QTextCharFormat warningFormat;
    warningFormat.setUnderlineStyle(QTextCharFormat::SingleUnderline);
    warningFormat.setUnderlineColor(QColor(180, 180, 0, 255));

    QTextCharFormat warningRangeFormat;
    warningRangeFormat.setUnderlineStyle(QTextCharFormat::DotLine);
    warningRangeFormat.setUnderlineColor(QColor(180, 180, 0, 255));

    addSelections(diagnostics, textDocument, warningFormat, warningRangeFormat, extraSelections);
}

void addErrorSelections(const std::vector<ClangBackEnd::DiagnosticContainer> &diagnostics,
                         QTextDocument *textDocument,
                         QList<QTextEdit::ExtraSelection> &extraSelections)
{
    QTextCharFormat errorFormat;
    errorFormat.setUnderlineStyle(QTextCharFormat::SingleUnderline);
    errorFormat.setUnderlineColor(QColor(255, 0, 0, 255));

    QTextCharFormat errorRangeFormat;
    errorRangeFormat.setUnderlineStyle(QTextCharFormat::DotLine);
    errorRangeFormat.setUnderlineColor(QColor(255, 0, 0, 255));

    addSelections(diagnostics, textDocument, errorFormat, errorRangeFormat, extraSelections);
}

}  // anonymous namespace

QList<QTextEdit::ExtraSelection>
ClangEditorDocumentProcessor::generateDiagnosticHints(const QVector<ClangBackEnd::DiagnosticContainer> &allDiagnostics)
{
    const auto warningDiagnostic = filterInterestingWarningDiagnostics(allDiagnostics, filePath());
    const auto errorDiagnostic = filterInterestingErrorsDiagnostics(allDiagnostics, filePath());

    m_clangTextMarks.clear();
    m_clangTextMarks.reserve(warningDiagnostic.size() + errorDiagnostic.size());

    addClangTextMarks(warningDiagnostic);
    addClangTextMarks(errorDiagnostic);

    QList<QTextEdit::ExtraSelection> extraSelections;
    extraSelections.reserve(int(warningDiagnostic.size() + errorDiagnostic.size()));

    addWarningSelections(warningDiagnostic, textDocument(), extraSelections);
    addErrorSelections(errorDiagnostic, textDocument(), extraSelections);

    return extraSelections;
}

void ClangEditorDocumentProcessor::addClangTextMarks(const std::vector<ClangBackEnd::DiagnosticContainer> &diagnostics)
{
    QTC_ASSERT(m_clangTextMarks.size() + diagnostics.size() <= m_clangTextMarks.capacity(), return);

    for (auto &&diagnostic : diagnostics) {
        m_clangTextMarks.emplace_back(filePath(),
                                      diagnostic.location().line(),
                                      diagnostic.severity());

        ClangTextMark &textMark = m_clangTextMarks.back();

        textMark.setBaseTextDocument(baseTextDocument());

        baseTextDocument()->addMark(&textMark);
    }
}

void ClangEditorDocumentProcessor::requestDiagnostics(CppTools::ProjectPart &projectPart)
{
    if (!m_projectPart || projectPart.id() != m_projectPart->id()) {
        IpcCommunicator &ipcCommunicator = m_modelManagerSupport->ipcCommunicator();

        ipcCommunicator.requestDiagnostics({filePath(), projectPart.id()},
                                            revision());
    }
}

void ClangEditorDocumentProcessor::requestDiagnostics()
{
    // Get diagnostics
    if (m_projectPart) {
        auto  &ipcCommunicator = m_modelManagerSupport->ipcCommunicator();
        ipcCommunicator.requestDiagnostics({filePath(),
                                             m_projectPart->id(),
                                             baseTextDocument()->plainText(),
                                             true},
                                            revision());
476
    }
477 478
}

479
} // namespace Internal
480
} // namespace ClangCodeModel