Skip to content

[clang][ASTMatchers] Add arrayTypeLoc ast matcher for ArrayTypeLoc #168990

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+48 −0
Open

[clang][ASTMatchers] Add arrayTypeLoc ast matcher for ArrayTypeLoc #168990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e0837e4
Introduce arrayTypeLoc ast matcher for ArrayTypeLoc
yuhaouy Nov 21, 2025
e67c700
Fix format issue
yuhaouy Nov 21, 2025
61194a1
Merge branch 'llvm:main' into array-type-loc-matcher
yuhaouy Nov 21, 2025
5072889
add arrayTypeLoc to the dynamic matchers
yuhaouy Nov 21, 2025
c0d1b52
update ast matchers reference doc
yuhaouy Nov 21, 2025
54f46dc
Update clang release notes
yuhaouy Nov 21, 2025
27b863a
fix release notes erors
yuhaouy Nov 21, 2025
e984e2f
fix release note error due to the letter after the inline markup
yuhaouy Nov 21, 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
12 changes: 12 additions & 0 deletions clang/docs/LibASTMatchersReference.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2449,6 +2449,18 @@ <h2 id="decl-matchers">Node Matchers</h2>
</pre></td></tr>


<tr><td>Matcher&lt;<a href="https://clang.llvm.org/doxygen/classclang_1_1TypeLoc.html">TypeLoc</a>&gt;</td><td class="name" onclick="toggle('arrayTypeLoc0')"><a name="arrayTypeLoc0Anchor">arrayTypeLoc</a></td><td>Matcher&lt;<a href="https://clang.llvm.org/doxygen/classclang_1_1ArrayTypeLoc.html">ArrayTypeLoc</a>&gt;...</td></tr>
<tr><td colspan="4" class="doc" id="arrayTypeLoc0"><pre>Matches `ArrayTypeLoc`s.

Given
int a[] = {1, 2};
int b[3];
void f() { int c[a[0]]; }
arrayTypeLoc()
matches "int a[]", "int b[3]" and "int c[a[0]]".
</pre></td></tr>


<tr><td>Matcher&lt;<a href="https://clang.llvm.org/doxygen/classclang_1_1TypeLoc.html">TypeLoc</a>&gt;</td><td class="name" onclick="toggle('pointerTypeLoc0')"><a name="pointerTypeLoc0Anchor">pointerTypeLoc</a></td><td>Matcher&lt;<a href="https://clang.llvm.org/doxygen/classclang_1_1PointerTypeLoc.html">PointerTypeLoc</a>&gt;...</td></tr>
<tr><td colspan="4" class="doc" id="pointerTypeLoc0"><pre>Matches pointer `TypeLoc`s.

Expand Down
1 change: 1 addition & 0 deletions clang/docs/ReleaseNotes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,7 @@ AST Matchers
- Fixed detection of explicit parameter lists in ``LambdaExpr``. (#GH168452)
- Added ``hasExplicitParameters`` for ``LambdaExpr`` as an output attribute to
AST JSON dumps.
- Add ``arrayTypeLoc`` matcher for matching ``ArrayTypeLoc``.

clang-format
------------
Expand Down
13 changes: 13 additions & 0 deletions clang/include/clang/ASTMatchers/ASTMatchers.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7003,6 +7003,19 @@ AST_MATCHER_P(ReferenceTypeLoc, hasReferentLoc, internal::Matcher<TypeLoc>,
return ReferentMatcher.matches(Node.getPointeeLoc(), Finder, Builder);
}

/// Matches `ArrayTypeLoc`s.
Copy link
Collaborator

@AaronBallman AaronBallman Nov 21, 2025

Choose a reason for hiding this comment

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

Please be sure to run clang/docs/tools/dump_ast_matchers.py to regenerate the documentation for the new matcher.

You should also update clang/lib/ASTMatchers/Dynamic/Registry.cpp to add the dynamic matcher at the same time.

And finally, this should come with a release note in clang/docs/ReleaseNotes.rst.

Copy link
Contributor Author

@yuhaouy yuhaouy Nov 21, 2025

Choose a reason for hiding this comment

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

Thanks! Done.

///
/// Given
/// \code
/// int a[] = {1, 2};
/// int b[3];
/// void f() { int c[a[0]]; }
/// \endcode
/// arrayTypeLoc()
/// matches "int a[]", "int b[3]" and "int c[a[0]]".
extern const internal::VariadicDynCastAllOfMatcher<TypeLoc, ArrayTypeLoc>
arrayTypeLoc;

/// Matches template specialization `TypeLoc`s.
///
/// Given
Expand Down
1 change: 1 addition & 0 deletions clang/lib/ASTMatchers/ASTMatchersInternal.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -807,6 +807,7 @@ const internal::VariadicDynCastAllOfMatcher<TypeLoc, PointerTypeLoc>
pointerTypeLoc;
const internal::VariadicDynCastAllOfMatcher<TypeLoc, ReferenceTypeLoc>
referenceTypeLoc;
const internal::VariadicDynCastAllOfMatcher<TypeLoc, ArrayTypeLoc> arrayTypeLoc;
const internal::VariadicDynCastAllOfMatcher<TypeLoc,
TemplateSpecializationTypeLoc>
templateSpecializationTypeLoc;
Expand Down
1 change: 1 addition & 0 deletions clang/lib/ASTMatchers/Dynamic/Registry.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ RegistryMaps::RegistryMaps() {
REGISTER_MATCHER(argumentCountAtLeast);
REGISTER_MATCHER(arraySubscriptExpr);
REGISTER_MATCHER(arrayType);
REGISTER_MATCHER(arrayTypeLoc);
REGISTER_MATCHER(asString);
REGISTER_MATCHER(asmStmt);
REGISTER_MATCHER(atomicExpr);
Expand Down
20 changes: 20 additions & 0 deletions clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2353,6 +2353,26 @@ TEST_P(ASTMatchersTest, ReferenceTypeLocTest_BindsToAnyRvalueReferenceTypeLoc) {
EXPECT_TRUE(matches("float&& r = 3.0;", matcher));
}

TEST_P(ASTMatchersTest, ArrayTypeLocTest_BindsToAnyArrayTypeLoc) {
auto matcher = varDecl(hasName("x"), hasTypeLoc(arrayTypeLoc()));
EXPECT_TRUE(matches("int x[3];", matcher));
EXPECT_TRUE(matches("float x[3];", matcher));
EXPECT_TRUE(matches("char x[3];", matcher));
EXPECT_TRUE(matches("void* x[3];", matcher));
EXPECT_TRUE(matches("const int x[3] = {1, 2, 3};", matcher));
EXPECT_TRUE(matches("int x[3][4];", matcher));
EXPECT_TRUE(matches("void foo(int x[]);", matcher));
EXPECT_TRUE(matches("int a[] = {1, 2}; void foo() {int x[a[0]];}", matcher));
}

TEST_P(ASTMatchersTest, ArrayTypeLocTest_DoesNotBindToNonArrayTypeLoc) {
auto matcher = varDecl(hasName("x"), hasTypeLoc(arrayTypeLoc()));
EXPECT_TRUE(notMatches("int x;", matcher));
EXPECT_TRUE(notMatches("float x;", matcher));
EXPECT_TRUE(notMatches("char x;", matcher));
EXPECT_TRUE(notMatches("void* x;", matcher));
}

TEST_P(ASTMatchersTest,
TemplateSpecializationTypeLocTest_BindsToVarDeclTemplateSpecialization) {
if (!GetParam().isCXX()) {
Expand Down
Loading