qqmlfindusagessupport.cpp

Go to the documentation of this file.

// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#include "qqmlfindusagessupport_p.h"
#include "qqmllsutils_p.h"
#include <QtLanguageServer/private/qlanguageserverspectypes_p.h>
#include <QtQmlDom/private/qqmldomexternalitems_p.h>
#include <QtQmlDom/private/qqmldomtop_p.h>
#include <variant>
 
QT_BEGIN_NAMESPACE
 
using namespace Qt::StringLiterals;
 
QQmlFindUsagesSupport::QQmlFindUsagesSupport(QmlLsp::QQmlCodeModelManager *codeModelManager)
    : BaseT(codeModelManager)
{
}
 
QString QQmlFindUsagesSupport::name() const
{
    return u"QmlFindUsagesSupport"_s;
}
 
void QQmlFindUsagesSupport::setupCapabilities(
        const QLspSpecification::InitializeParams &,
        QLspSpecification::InitializeResult &serverCapabilities)
{
    // just assume serverCapabilities.capabilities.typeDefinitionProvider is a bool for now
    // handle the ReferenceOptions later if needed (it adds the possibility to communicate the
    // current progress).
    serverCapabilities.capabilities.referencesProvider = true;
}
 
void QQmlFindUsagesSupport::registerHandlers(QLanguageServer *, QLanguageServerProtocol *protocol)
{
    protocol->registerReferenceRequestHandler(getRequestHandler());
}
 
void QQmlFindUsagesSupport::process(QQmlFindUsagesSupport::RequestPointerArgument request)
{
    QList<QLspSpecification::Location> results;
    ResponseScopeGuard guard(results, request->m_response);
 
    auto itemsFound = itemsForRequest(request);
    if (guard.setErrorFrom(itemsFound))
        return;
 
    QQmlLSUtils::ItemLocation &front =
            std::get<QList<QQmlLSUtils::ItemLocation>>(itemsFound).front();
 
    auto usages = QQmlLSUtils::findUsagesOf(front.domItem);
 
    QQmlJS::Dom::DomItem files = front.domItem.top().field(QQmlJS::Dom::Fields::qmlFileWithPath);
 
    // note: ignore usages in filenames here as that is not supported by the protocol.
    for (const auto &usage : usages.usagesInFile()) {
        QLspSpecification::Location location;
        location.uri = QUrl::fromLocalFile(usage.filename()).toEncoded();
        location.range = QQmlLSUtils::qmlLocationToLspLocation(usage);
 
        results.append(location);
    }
}
QT_END_NAMESPACE