1// Copyright (C) 2023 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#include "qqmlgototypedefinitionsupport_p.h"
5#include "qqmllsutils_p.h"
6#include <QtLanguageServer/private/qlanguageserverspectypes_p.h>
7#include <QtQmlDom/private/qqmldomexternalitems_p.h>
8#include <QtQmlDom/private/qqmldomtop_p.h>
9
10QT_BEGIN_NAMESPACE
11
12using namespace Qt::StringLiterals;
13
14QmlGoToTypeDefinitionSupport::QmlGoToTypeDefinitionSupport(QmlLsp::QQmlCodeModel *codeModel)
15 : BaseT(codeModel)
16{
17}
18
19QString QmlGoToTypeDefinitionSupport::name() const
20{
21 return u"QmlNavigationSupport"_s;
22}
23
24void QmlGoToTypeDefinitionSupport::setupCapabilities(
25 const QLspSpecification::InitializeParams &,
26 QLspSpecification::InitializeResult &serverCapabilities)
27{
28 // just assume serverCapabilities.capabilities.typeDefinitionProvider is a bool for now
29 // handle the TypeDefinitionOptions and TypeDefinitionRegistrationOptions cases later on, if
30 // needed (as they just allow more fancy go-to-type-definition action).
31 serverCapabilities.capabilities.typeDefinitionProvider = true;
32}
33
34void QmlGoToTypeDefinitionSupport::registerHandlers(QLanguageServer *,
35 QLanguageServerProtocol *protocol)
36{
37 protocol->registerTypeDefinitionRequestHandler(handler: getRequestHandler());
38}
39
40void QmlGoToTypeDefinitionSupport::process(RequestPointerArgument request)
41{
42 QList<QLspSpecification::Location> results;
43 QScopeGuard onExit([&results, &request]() { request->m_response.sendResponse(r: results); });
44
45 auto itemsFound = itemsForRequest(request);
46 if (!itemsFound) {
47 return;
48 }
49
50 QQmlJS::Dom::DomItem base = QQmlLSUtils::findTypeDefinitionOf(item: itemsFound->first().domItem);
51 if (base.domKind() == QQmlJS::Dom::DomKind::Empty) {
52 qWarning() << u"Could not obtain the type definition, was the type correctly resolved?"_s
53 << u"\n Obtained type was:\n"_s << base.toString()
54 << u"\nbut selected item was:\n"
55 << itemsFound->first().domItem.toString();
56 return;
57 }
58
59 if (base.domKind() == QQmlJS::Dom::DomKind::Empty) {
60 qWarning() << u"Could not obtain the base from the item"_s;
61 return;
62 }
63 auto locationInfo = QQmlJS::Dom::FileLocations::fileLocationsOf(base);
64 if (!locationInfo) {
65 qWarning()
66 << u"Could not obtain the text location from the base item, was it correctly resolved?\nBase was "_s
67 << base.toString();
68 return;
69 }
70
71 QQmlJS::Dom::DomItem fileOfBase = base.containingFile();
72 auto fileOfBasePtr = fileOfBase.ownerAs<QQmlJS::Dom::QmlFile>();
73 if (!fileOfBasePtr) {
74 qWarning() << u"Could not obtain the file of the base."_s;
75 return;
76 }
77
78 QLspSpecification::Location l;
79 l.uri = QUrl::fromLocalFile(localfile: fileOfBasePtr->canonicalFilePath()).toEncoded();
80
81 const QString qmlCode = fileOfBasePtr->code();
82 l.range = QQmlLSUtils::qmlLocationToLspLocation(code: qmlCode, qmlLocation: locationInfo->fullRegion);
83
84 results.append(t: l);
85}
86
87QT_END_NAMESPACE
88

source code of qtdeclarative/src/qmlls/qqmlgototypedefinitionsupport.cpp