qt-creator/src/tools/clangbackend/ipcsource/clangrequestdocumentannotationsjob.cpp

/****************************************************************************
**
** 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 "clangrequestdocumentannotationsjob.h"

#include <clangbackendipc/clangbackendipcdebugutils.h>
#include <clangbackendipc/documentannotationschangedmessage.h>
#include <clangbackendipc/clangcodemodelclientinterface.h>

#include <utils/qtcassert.h>

namespace ClangBackEnd {

static RequestDocumentAnnotationsJob::AsyncResult runAsyncHelper(
        const TranslationUnit &translationUnit)
{
    TIME_SCOPE_DURATION("RequestDocumentAnnotationsJobRunner");

    RequestDocumentAnnotationsJob::AsyncResult asyncResult;

    translationUnit.extractDocumentAnnotations(asyncResult.firstHeaderErrorDiagnostic,
                                               asyncResult.diagnostics,
                                               asyncResult.highlightingMarks,
                                               asyncResult.skippedSourceRanges);

    return asyncResult;
}

IAsyncJob::AsyncPrepareResult RequestDocumentAnnotationsJob::prepareAsyncRun()
{
    const JobRequest jobRequest = context().jobRequest;
    QTC_ASSERT(jobRequest.type == JobRequest::Type::RequestDocumentAnnotations,
               return AsyncPrepareResult());

    try {
        m_pinnedDocument = context().documentForJobRequest();
        m_pinnedFileContainer = m_pinnedDocument.fileContainer();

        const TranslationUnit translationUnit
                = m_pinnedDocument.translationUnit(jobRequest.preferredTranslationUnit);
        setRunner([translationUnit]() {
            return runAsyncHelper(translationUnit);
        });
        return AsyncPrepareResult{translationUnit.id()};

    } catch (const std::exception &exception) {
        qWarning() << "Error in RequestDocumentAnnotationsJob::prepareAsyncRun:" << exception.what();
        return AsyncPrepareResult();
    }
}

void RequestDocumentAnnotationsJob::finalizeAsyncRun()
{
    if (context().isDocumentOpen()) {
        const AsyncResult result = asyncResult();
        sendAnnotations(result);
    }
}

void RequestDocumentAnnotationsJob::sendAnnotations(
        const RequestDocumentAnnotationsJob::AsyncResult &result)
{
    const DocumentAnnotationsChangedMessage message(m_pinnedFileContainer,
                                                    result.diagnostics,
                                                    result.firstHeaderErrorDiagnostic,
                                                    result.highlightingMarks,
                                                    result.skippedSourceRanges);

    context().client->documentAnnotationsChanged(message);
}

} // namespace ClangBackEnd