[Clang][ASTMatcher] Add `dependentTemplateSpecializationType` AST mat… #121435

caokefan · 2025-01-01T13:20:25Z

Add AST Matcher for dependentTemplateSpecializationType
Fixes:#121307

github-actions · 2025-01-01T13:20:44Z

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

llvmbot · 2025-01-01T13:21:13Z

@llvm/pr-subscribers-clang

Author: kefan cao (caokefan)

Changes

Add AST Matcher for dependentTemplateSpecializationType
Fixes:#121307

Full diff: https://github.com/llvm/llvm-project/pull/121435.diff

7 Files Affected:

(modified) clang/docs/LibASTMatchersReference.html (+11)
(modified) clang/docs/ReleaseNotes.rst (+2)
(modified) clang/include/clang/ASTMatchers/ASTMatchers.h (+12)
(modified) clang/lib/ASTMatchers/ASTMatchersInternal.cpp (+2)
(modified) clang/lib/ASTMatchers/Dynamic/Registry.cpp (+1)
(modified) clang/unittests/AST/ASTImporterTest.cpp (-4)
(modified) clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp (+15)

diff --git a/clang/docs/LibASTMatchersReference.html b/clang/docs/LibASTMatchersReference.html
index 8564f2650d205f..428a3385e2f39e 100644
--- a/clang/docs/LibASTMatchersReference.html
+++ b/clang/docs/LibASTMatchersReference.html
@@ -2546,6 +2546,17 @@ <h2 id="decl-matchers">Node Matchers</h2>
   };
 </pre></td></tr>
 
+<tr><td>Matcher&lt;<a href="https://clang.llvm.org/doxygen/classclang_1_1Type.html">Type</a>&gt;</td><td class="name" onclick="toggle('dependentTemplateSpecializationType0')"><a name="dependentTemplateSpecializationType0Anchor">dependentTemplateSpecializationType</a></td><td>Matcher&lt;<a href="https://clang.llvm.org/doxygen/classclang_1_1DependentTemplateSpecializationType.html">DependentTemplateSpecializationType</a>&gt;...</td></tr>
+<tr><td colspan="4" class="doc" id="dependentTemplateSpecializationType0"><pre>Matches dependent template specialization types.
+
+Example matches  A<T>::template B<T>
+
+  template<typename T> struct A;
+  template<typename T> struct declToImport {
+    typename A<T>::template B<T> a;
+  };
+</pre></td></tr>
+
 <tr><td>Matcher&lt;<a href="https://clang.llvm.org/doxygen/classclang_1_1Type.html">Type</a>&gt;</td><td class="name" onclick="toggle('deducedTemplateSpecializationType0')"><a name="deducedTemplateSpecializationType0Anchor">deducedTemplateSpecializationType</a></td><td>Matcher&lt;<a href="https://clang.llvm.org/doxygen/classclang_1_1DeducedTemplateSpecializationType.html">DeducedTemplateSpecializationType</a>&gt;...</td></tr>
 <tr><td colspan="4" class="doc" id="deducedTemplateSpecializationType0"><pre>Matches C++17 deduced template specialization types, e.g. deduced class
 template types.
diff --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst
index 2a688a677294f8..e17d22d1e1cdcf 100644
--- a/clang/docs/ReleaseNotes.rst
+++ b/clang/docs/ReleaseNotes.rst
@@ -1113,6 +1113,8 @@ AST Matchers
 
 - Add ``dependentNameType`` matcher to match a dependent name type.
 
+- Add ``dependentTemplateSpecializationType`` matcher to match dependent template specialization types.
+
 clang-format
 ------------
 
diff --git a/clang/include/clang/ASTMatchers/ASTMatchers.h b/clang/include/clang/ASTMatchers/ASTMatchers.h
index 9a046714068a51..1b678f30c5d01c 100644
--- a/clang/include/clang/ASTMatchers/ASTMatchers.h
+++ b/clang/include/clang/ASTMatchers/ASTMatchers.h
@@ -7721,6 +7721,18 @@ AST_MATCHER_P(DecayedType, hasDecayedType, internal::Matcher<QualType>,
 /// \endcode
 extern const AstTypeMatcher<DependentNameType> dependentNameType;
 
+/// Matches dependent template specialization types
+///
+/// Example matches  A<T>::template B<T>
+/// \code
+///   template<typename T> struct A;
+///   template<typename T> struct declToImport {
+///     typename A<T>::template B<T> a;
+///   };
+/// \endcode
+extern const AstTypeMatcher<DependentTemplateSpecializationType>
+    dependentTemplateSpecializationType;
+
 /// Matches declarations whose declaration context, interpreted as a
 /// Decl, matches \c InnerMatcher.
 ///
diff --git a/clang/lib/ASTMatchers/ASTMatchersInternal.cpp b/clang/lib/ASTMatchers/ASTMatchersInternal.cpp
index a47633bf4bae24..9c7943a98d6523 100644
--- a/clang/lib/ASTMatchers/ASTMatchersInternal.cpp
+++ b/clang/lib/ASTMatchers/ASTMatchersInternal.cpp
@@ -1109,6 +1109,8 @@ const AstTypeMatcher<TemplateTypeParmType> templateTypeParmType;
 const AstTypeMatcher<InjectedClassNameType> injectedClassNameType;
 const AstTypeMatcher<DecayedType> decayedType;
 const AstTypeMatcher<DependentNameType> dependentNameType;
+const AstTypeMatcher<DependentTemplateSpecializationType>
+    dependentTemplateSpecializationType;
 AST_TYPELOC_TRAVERSE_MATCHER_DEF(hasElementType,
                                  AST_POLYMORPHIC_SUPPORTED_TYPES(ArrayType,
                                                                  ComplexType));
diff --git a/clang/lib/ASTMatchers/Dynamic/Registry.cpp b/clang/lib/ASTMatchers/Dynamic/Registry.cpp
index bfdee412c53281..97e6bbc093fe46 100644
--- a/clang/lib/ASTMatchers/Dynamic/Registry.cpp
+++ b/clang/lib/ASTMatchers/Dynamic/Registry.cpp
@@ -224,6 +224,7 @@ RegistryMaps::RegistryMaps() {
   REGISTER_MATCHER(declRefExpr);
   REGISTER_MATCHER(dependentNameType);
   REGISTER_MATCHER(dependentScopeDeclRefExpr);
+  REGISTER_MATCHER(dependentTemplateSpecializationType);
   REGISTER_MATCHER(declStmt);
   REGISTER_MATCHER(declaratorDecl);
   REGISTER_MATCHER(decltypeType);
diff --git a/clang/unittests/AST/ASTImporterTest.cpp b/clang/unittests/AST/ASTImporterTest.cpp
index ee1d896f1ca6dc..d197d30df3adf5 100644
--- a/clang/unittests/AST/ASTImporterTest.cpp
+++ b/clang/unittests/AST/ASTImporterTest.cpp
@@ -763,10 +763,6 @@ TEST_P(ImportType, ImportPackExpansion) {
                                    implicitCastExpr(has(declRefExpr()))))))));
 }
 
-const internal::VariadicDynCastAllOfMatcher<Type,
-                                            DependentTemplateSpecializationType>
-    dependentTemplateSpecializationType;
-
 TEST_P(ImportType, ImportDependentTemplateSpecialization) {
   MatchVerifier<Decl> Verifier;
   testImport("template<typename T>"
diff --git a/clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp b/clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp
index b8521e2f957683..9b2a16d1a1edaf 100644
--- a/clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp
+++ b/clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp
@@ -1926,6 +1926,21 @@ TEST_P(ASTMatchersTest, DependentNameType) {
       dependentNameType()));
 }
 
+TEST_P(ASTMatchersTest, DependentTemplateSpecializationType) {
+  if (!GetParam().isCXX()) {
+    return;
+  }
+
+  EXPECT_TRUE(matches(
+      R"(
+      template<typename T> struct A;
+      template<typename T> struct declToImport {
+        typename A<T>::template B<T> a;
+      };
+    )",
+      dependentTemplateSpecializationType()));
+}
+
 TEST_P(ASTMatchersTest, RecordType) {
   EXPECT_TRUE(matches("struct S {}; struct S s;",
                       recordType(hasDeclaration(recordDecl(hasName("S"))))));

caokefan · 2025-01-01T13:36:40Z

Hi @HighCommander4, it seems that I am unable to add reviewers. Could you provide me with some help? Thank you very much

AmrDeveloper · 2025-01-01T17:36:23Z

clang/docs/ReleaseNotes.rst

@@ -1113,6 +1113,8 @@ AST Matchers

 - Add ``dependentNameType`` matcher to match a dependent name type.

+- Add ``dependentTemplateSpecializationType`` matcher to match dependent template specialization types.


Suggested change

- Add ``dependentTemplateSpecializationType`` matcher to match dependent template specialization types.

- Add ``dependentTemplateSpecializationType`` matcher to match a dependent template specialization type.

The same in clang/docs/LibASTMatchersReference.html and clang/include/clang/ASTMatchers/ASTMatchers.h

Got it! Thank you for your correction!

AmrDeveloper · 2025-01-01T17:36:56Z

clang/docs/LibASTMatchersReference.html

+<tr><td>Matcher&lt;<a href="https://clang.llvm.org/doxygen/classclang_1_1Type.html">Type</a>&gt;</td><td class="name" onclick="toggle('dependentTemplateSpecializationType0')"><a name="dependentTemplateSpecializationType0Anchor">dependentTemplateSpecializationType</a></td><td>Matcher&lt;<a href="https://clang.llvm.org/doxygen/classclang_1_1DependentTemplateSpecializationType.html">DependentTemplateSpecializationType</a>&gt;...</td></tr>
+<tr><td colspan="4" class="doc" id="dependentTemplateSpecializationType0"><pre>Matches dependent template specialization types.
+
+Example matches  A<T>::template B<T>


Suggested change

Example matches A<T>::template B<T>

Example matches A<T>::template B<T>

The same in clang/include/clang/ASTMatchers/ASTMatchers.h

HighCommander4

Thanks!

I agree with @AmrDeveloper's comments. Otherwise, this looks pretty good!

HighCommander4 · 2025-01-01T21:18:33Z

clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp

+
+  EXPECT_TRUE(matches(
+      R"(
+      template<typename T> struct A;


nit: please indent the contents of the code one level (two spaces) relative to the beginning of the string (R"(), and the end of the string ()") the same as the beginning

Got it! Thank you for your patience and assistance!

…cher

HighCommander4

Thanks, LGTM!

AmrDeveloper

Thanks, LGTM!

github-actions · 2025-01-03T21:32:22Z

@caokefan Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

llvmbot added the clang Clang issues not falling into any other category label Jan 1, 2025

AmrDeveloper requested changes Jan 1, 2025

View reviewed changes

HighCommander4 reviewed Jan 1, 2025

View reviewed changes

[Clang][ASTMatcher] Add dependentTemplateSpecializationType AST mat…

698464e

…cher

caokefan force-pushed the kefan.cao/ast_matcher_dependent_template_specialization_type branch from a70a9e5 to 698464e Compare January 2, 2025 11:47

HighCommander4 approved these changes Jan 3, 2025

View reviewed changes

caokefan force-pushed the kefan.cao/ast_matcher_dependent_template_specialization_type branch from 9b6af30 to 698464e Compare January 3, 2025 04:15

caokefan requested a review from AmrDeveloper January 3, 2025 04:18

AmrDeveloper approved these changes Jan 3, 2025

View reviewed changes

HighCommander4 merged commit d85b22e into llvm:main Jan 3, 2025
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Clang][ASTMatcher] Add `dependentTemplateSpecializationType` AST mat… #121435

[Clang][ASTMatcher] Add `dependentTemplateSpecializationType` AST mat… #121435

caokefan commented Jan 1, 2025

github-actions bot commented Jan 1, 2025

llvmbot commented Jan 1, 2025

caokefan commented Jan 1, 2025 •

edited

Loading

AmrDeveloper Jan 1, 2025

caokefan Jan 2, 2025

AmrDeveloper Jan 1, 2025

HighCommander4 left a comment

HighCommander4 Jan 1, 2025

caokefan Jan 2, 2025

HighCommander4 left a comment

AmrDeveloper left a comment

github-actions bot commented Jan 3, 2025

		@@ -1113,6 +1113,8 @@ AST Matchers

		- Add ``dependentNameType`` matcher to match a dependent name type.

		- Add ``dependentTemplateSpecializationType`` matcher to match dependent template specialization types.

	Example matches A<T>::template B<T>
	Example matches A<T>::template B<T>

[Clang][ASTMatcher] Add dependentTemplateSpecializationType AST mat… #121435

[Clang][ASTMatcher] Add dependentTemplateSpecializationType AST mat… #121435

Conversation

caokefan commented Jan 1, 2025

github-actions bot commented Jan 1, 2025

llvmbot commented Jan 1, 2025

caokefan commented Jan 1, 2025 • edited Loading

AmrDeveloper Jan 1, 2025

Choose a reason for hiding this comment

caokefan Jan 2, 2025

Choose a reason for hiding this comment

AmrDeveloper Jan 1, 2025

Choose a reason for hiding this comment

HighCommander4 left a comment

Choose a reason for hiding this comment

HighCommander4 Jan 1, 2025

Choose a reason for hiding this comment

caokefan Jan 2, 2025

Choose a reason for hiding this comment

HighCommander4 left a comment

Choose a reason for hiding this comment

AmrDeveloper left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 3, 2025

[Clang][ASTMatcher] Add `dependentTemplateSpecializationType` AST mat… #121435

[Clang][ASTMatcher] Add `dependentTemplateSpecializationType` AST mat… #121435

caokefan commented Jan 1, 2025 •

edited

Loading