qt-creator/src/tools/clangbackend/source/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 <clangsupport/clangsupportdebugutils.h>
#include <clangsupport/documentannotationschangedmessage.h>
#include <clangsupport/clangcodemodelclientinterface.h>

#include <utils/qtcassert.h>

namespace ClangBackEnd {

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

    const TranslationUnit translationUnit = *m_translationUnit;
    setRunner([translationUnit]() {
        TIME_SCOPE_DURATION("RequestDocumentAnnotationsJobRunner");

        RequestDocumentAnnotationsJob::AsyncResult asyncResult;
        translationUnit.extractDocumentAnnotations(asyncResult.firstHeaderErrorDiagnostic,
                                                   asyncResult.diagnostics,
                                                   asyncResult.highlightingMarks,
                                                   asyncResult.skippedSourceRanges);
        return asyncResult;
    });

    return AsyncPrepareResult{translationUnit.id()};
}

void RequestDocumentAnnotationsJob::finalizeAsyncRun()
{
    if (context().isDocumentOpen()) {
        const AsyncResult result = asyncResult();
        context().client->documentAnnotationsChanged(
            DocumentAnnotationsChangedMessage(m_pinnedFileContainer,
                                              result.diagnostics,
                                              result.firstHeaderErrorDiagnostic,
                                              result.highlightingMarks,
                                              result.skippedSourceRanges));
    }
}

} // namespace ClangBackEnd