Skip to content

[clang][ExtractAPI] fix a couple crashes when used via libclang #132297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 26, 2025
Merged

[clang][ExtractAPI] fix a couple crashes when used via libclang #132297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a94992
collect template argument locs ahead of time to null-check
QuietMisdreavus Mar 20, 2025
bc3d715
don't collect bases for types without definitions
QuietMisdreavus Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions clang/include/clang/ExtractAPI/ExtractAPIVisitor.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,10 @@ class ExtractAPIVisitorBase : public RecursiveASTVisitor<Derived> {

protected:
SmallVector<SymbolReference> getBases(const CXXRecordDecl *Decl) {
if (!Decl->isCompleteDefinition()) {
return {};
}

// FIXME: store AccessSpecifier given by inheritance
SmallVector<SymbolReference> Bases;
for (const auto &BaseSpecifier : Decl->bases()) {
Expand Down
6 changes: 5 additions & 1 deletion clang/lib/ExtractAPI/DeclarationFragments.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1225,6 +1225,10 @@ DeclarationFragments
DeclarationFragmentsBuilder::getFragmentsForClassTemplateSpecialization(
const ClassTemplateSpecializationDecl *Decl) {
DeclarationFragments Fragments;
std::optional<ArrayRef<TemplateArgumentLoc>> TemplateArgumentLocs = {};
if (auto *TemplateArgs = Decl->getTemplateArgsAsWritten()) {
TemplateArgumentLocs = TemplateArgs->arguments();
}
return Fragments
.append("template", DeclarationFragments::FragmentKind::Keyword)
.appendSpace()
Expand All @@ -1237,7 +1241,7 @@ DeclarationFragmentsBuilder::getFragmentsForClassTemplateSpecialization(
.append("<", DeclarationFragments::FragmentKind::Text)
.append(getFragmentsForTemplateArguments(
Decl->getTemplateArgs().asArray(), Decl->getASTContext(),
Decl->getTemplateArgsAsWritten()->arguments()))
TemplateArgumentLocs))
.append(">", DeclarationFragments::FragmentKind::Text)
.appendSemicolon();
}
Expand Down
41 changes: 41 additions & 0 deletions clang/test/Index/extract-api-cursor-cpp.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// Test is line- and column-sensitive. Run lines are below

template <typename T>
class basic_vector {
public:
T x;
T y;
};

using my_vec = basic_vector<int>;

class MyClass {
my_vec myVec;
};

struct OuterStruct {
struct InnerStruct;
int outer_field;
};

// RUN: c-index-test -single-symbol-sgf-at=%s:13:7 local %s | FileCheck --check-prefix=CHECK-VEC-TYPE %s
// CHECK-VEC-TYPE: "parentContexts":[{"kind":"c++.typealias","name":"my_vec","usr":"c:@my_vec"}]
// CHECK-VEC-TYPE: "declarationFragments":[{"kind":"keyword","spelling":"typedef"},{"kind":"text","spelling":" "},{"kind":"typeIdentifier","preciseIdentifier":"c:@ST>1#T@basic_vector","spelling":"basic_vector"},{"kind":"text","spelling":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:I","spelling":"int"},{"kind":"text","spelling":"> "},{"kind":"identifier","spelling":"my_vec"},{"kind":"text","spelling":";"}]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not an issue for this change, but I guess for further C++ support we might want to correctly record the spelled keyword using in the decl fragments. Right now this is using typedef for all type aliases.

Might be an editorial choice to use a consistent type alias keyword, but it might be better to preserve the actual spelling. Plus I think there are some minor distinctions and eligible contexts between the two.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely but this should definitely be handled in a follow up patch.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, i agree that this is good, but we should track that separately.

// CHECK-VEC-TYPE: "identifier":{"interfaceLanguage":"c++","precise":"c:@my_vec"}
// CHECK-VEC-TYPE: "kind":{"displayName":"Type Alias","identifier":"c++.typealias"}
// CHECK-VEC-TYPE: "title":"my_vec"
// CHECK-VEC-TYPE: "pathComponents":["my_vec"]

// RUN: c-index-test -single-symbol-sgf-at=%s:13:13 local %s | FileCheck --check-prefix=CHECK-MYVEC %s
// CHECK-MYVEC: "parentContexts":[{"kind":"c++.class","name":"MyClass","usr":"c:@S@MyClass"},{"kind":"c++.property","name":"myVec","usr":"c:@S@MyClass@FI@myVec"}]
// CHECK-MYVEC: "identifier":{"interfaceLanguage":"c++","precise":"c:@S@MyClass@FI@myVec"}
// CHECK-MYVEC: "kind":{"displayName":"Instance Property","identifier":"c++.property"}
// CHECK-MYVEC: "title":"myVec"
// CHECK-MYVEC: "pathComponents":["MyClass","myVec"]

// RUN: c-index-test -single-symbol-sgf-at=%s:17:17 local %s | FileCheck --check-prefix=CHECK-INNER %s
// CHECK-INNER: "parentContexts":[{"kind":"c++.struct","name":"OuterStruct","usr":"c:@S@OuterStruct"},{"kind":"c++.struct","name":"InnerStruct","usr":"c:@S@OuterStruct@S@InnerStruct"}]
// CHECK-INNER: "identifier":{"interfaceLanguage":"c++","precise":"c:@S@OuterStruct@S@InnerStruct"}
// CHECK-INNER: "kind":{"displayName":"Structure","identifier":"c++.struct"}
// CHECK-INNER: "title":"InnerStruct"
// CHECK-INNER: "pathComponents":["OuterStruct","InnerStruct"]
Loading