[AST] Update introspection API to use const-ref for copyable types

[njames93]

LG with 1 nit.

clang/lib/Tooling/DumpTool/generate_cxx_src_locs.py

14

nit: Any reason not to use set notation here?

clang/include/clang/Tooling/NodeIntrospection.h

struct NodeLocationAccessors {
   SourceRangeMap RangeAccessors;
 };
 
 namespace NodeIntrospection {
 bool hasIntrospectionSupport();
 NodeLocationAccessors GetLocations(clang::Stmt const *Object);
 NodeLocationAccessors GetLocations(clang::Decl const *Object);
 NodeLocationAccessors GetLocations(clang::CXXCtorInitializer const *Object);
-NodeLocationAccessors GetLocations(clang::NestedNameSpecifierLoc const *);
-NodeLocationAccessors GetLocations(clang::TemplateArgumentLoc const *);
+NodeLocationAccessors GetLocations(clang::NestedNameSpecifierLoc const &);
+NodeLocationAccessors GetLocations(clang::TemplateArgumentLoc const &);
 NodeLocationAccessors GetLocations(clang::CXXBaseSpecifier const *);
 NodeLocationAccessors GetLocations(clang::TypeLoc const &);
 NodeLocationAccessors GetLocations(clang::DynTypedNode const &Node);
 } // namespace NodeIntrospection
 } // namespace tooling
 } // namespace clang
 #endif

clang/lib/Tooling/CMakeLists.txt

 NodeLocationAccessors NodeIntrospection::GetLocations(clang::Decl const *) {
   return {};
 }
 NodeLocationAccessors NodeIntrospection::GetLocations(
     clang::CXXCtorInitializer const *) {
   return {};
 }
 NodeLocationAccessors NodeIntrospection::GetLocations(
-    clang::NestedNameSpecifierLoc const*) {
+    clang::NestedNameSpecifierLoc const&) {
   return {};
 }
 NodeLocationAccessors NodeIntrospection::GetLocations(
-    clang::TemplateArgumentLoc const*) {
+    clang::TemplateArgumentLoc const&) {
   return {};
 }
 NodeLocationAccessors NodeIntrospection::GetLocations(
     clang::CXXBaseSpecifier const*) {
   return {};
 }
 NodeLocationAccessors NodeIntrospection::GetLocations(
     clang::TypeLoc const&) {

clang/lib/Tooling/DumpTool/generate_cxx_src_locs.py

 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 import os
 import sys
 import json
 
 import argparse
 
 class Generator(object):
 
     implementationContent = ''
 
+    RefClades = {"NestedNameSpecifierLoc", "TemplateArgumentLoc", "TypeLoc"}
+
     def __init__(self, templateClasses):
         self.templateClasses = templateClasses
 
     def GeneratePrologue(self):
 
         self.implementationContent += \
             """
 /*===- Generated file -------------------------------------------*- C++ -*-===*\

 
 private:
 std::vector<clang::TypeLoc> &TLRG;
 };
 """
 
     def GenerateBaseGetLocationsDeclaration(self, CladeName):
         InstanceDecoration = "*"
-        if CladeName == "TypeLoc":
+        if CladeName in self.RefClades:
             InstanceDecoration = "&"
 
         self.implementationContent += \
             """
 void GetLocationsImpl(SharedLocationCall const& Prefix,
     clang::{0} const {1}Object, SourceLocationMap &Locs,
     SourceRangeMap &Rngs,
     std::vector<clang::TypeLoc> &TypeLocRecursionGuard);
def GenerateFiles(self, OutputFile):
             f.write(self.implementationContent)
 
     def GenerateBaseGetLocationsFunction(self, ASTClassNames,
             ClassEntries, CladeName, InheritanceMap,
             CreateLocalRecursionGuard):
 
         MethodReturnType = 'NodeLocationAccessors'
         InstanceDecoration = "*"
-        if CladeName == "TypeLoc":
+        if CladeName in self.RefClades:
             InstanceDecoration = "&"
 
         Signature = \
             'GetLocations(clang::{0} const {1}Object)'.format(
                 CladeName, InstanceDecoration)
         ImplSignature = \
             """
     GetLocationsImpl(SharedLocationCall const& Prefix,
""".format(CladeName, InstanceDecoration)
             RecursionPopper RAII(TypeLocRecursionGuard);
                 """
 
         RecursionGuardParam = ''
         if not CreateLocalRecursionGuard:
             RecursionGuardParam = ', TypeLocRecursionGuard'
 
         ArgPrefix = '*'
-        if CladeName == "TypeLoc":
+        if CladeName in self.RefClades:
             ArgPrefix = ''
         self.implementationContent += \
             'GetLocations{0}(Prefix, {1}Object, Locs, Rngs {2});'.format(
                 CladeName, ArgPrefix, RecursionGuardParam)
 
         if CladeName == "TypeLoc":
             self.implementationContent += \
                 '''
def GenerateDynNodeVisitor(self, CladeNames):
             + ' NodeIntrospection::' + Signature + '{'
 
         for CladeName in CladeNames:
             self.implementationContent += \
                 """
     if (const auto *N = Node.get<{0}>())
     """.format(CladeName)
             ArgPrefix = ""
-            if CladeName == "TypeLoc":
+            if CladeName in self.RefClades:
                 ArgPrefix = "*"
             self.implementationContent += \
             """
       return GetLocations({0}const_cast<{1} *>(N));""".format(ArgPrefix, CladeName)
 
         self.implementationContent += '\nreturn {}; }'
 
     def GenerateEpilogue(self):

 NodeLocationAccessors NodeIntrospection::GetLocations(clang::Decl const *) {
   return {};
 }
 NodeLocationAccessors NodeIntrospection::GetLocations(
     clang::CXXCtorInitializer const *) {
   return {};
 }
 NodeLocationAccessors NodeIntrospection::GetLocations(
-    clang::NestedNameSpecifierLoc const*) {
+    clang::NestedNameSpecifierLoc const&) {
   return {};
 }
 NodeLocationAccessors NodeIntrospection::GetLocations(
-    clang::TemplateArgumentLoc const*) {
+    clang::TemplateArgumentLoc const&) {
   return {};
 }
 NodeLocationAccessors NodeIntrospection::GetLocations(
     clang::CXXBaseSpecifier const*) {
   return {};
 }
 NodeLocationAccessors NodeIntrospection::GetLocations(
     clang::TypeLoc const&) {

clang/unittests/Introspection/IntrospectionTest.cpp

)cpp",
 
   auto BoundNodes = ast_matchers::match(
       decl(hasDescendant(nestedNameSpecifierLoc().bind("nns"))), TU, Ctx);
 
   EXPECT_EQ(BoundNodes.size(), 1u);
 
   const auto *NNS = BoundNodes[0].getNodeAs<NestedNameSpecifierLoc>("nns");
 
-  auto Result = NodeIntrospection::GetLocations(NNS);
+  auto Result = NodeIntrospection::GetLocations(*NNS);
 
   auto ExpectedLocations =
       FormatExpected<SourceLocation>(Result.LocationAccessors);
 
   EXPECT_THAT(
       ExpectedLocations,
       UnorderedElementsAre(
           STRING_LOCATION_PAIR(NNS, getBeginLoc()),
)cpp",
 
   auto BoundNodes = ast_matchers::match(
       decl(hasDescendant(templateArgumentLoc().bind("ta"))), TU, Ctx);
 
   EXPECT_EQ(BoundNodes.size(), 1u);
 
   const auto *TA = BoundNodes[0].getNodeAs<TemplateArgumentLoc>("ta");
 
-  auto Result = NodeIntrospection::GetLocations(TA);
+  auto Result = NodeIntrospection::GetLocations(*TA);
 
   auto ExpectedLocations =
       FormatExpected<SourceLocation>(Result.LocationAccessors);
 
   // clang-format off
   EXPECT_THAT(ExpectedLocations,
               UnorderedElementsAre(
 STRING_LOCATION_PAIR(TA, getLocation()),
)cpp",
 
   auto BoundNodes = ast_matchers::match(
       decl(hasDescendant(templateArgumentLoc().bind("ta"))), TU, Ctx);
 
   EXPECT_EQ(BoundNodes.size(), 1u);
 
   const auto *TA = BoundNodes[0].getNodeAs<TemplateArgumentLoc>("ta");
 
-  auto Result = NodeIntrospection::GetLocations(TA);
+  auto Result = NodeIntrospection::GetLocations(*TA);
 
   auto ExpectedLocations =
       FormatExpected<SourceLocation>(Result.LocationAccessors);
 
   EXPECT_THAT(ExpectedLocations,
               UnorderedElementsAre(STRING_LOCATION_PAIR(TA, getLocation())));
 
   auto ExpectedRanges = FormatExpected<SourceRange>(Result.RangeAccessors);
)cpp",
 
   auto BoundNodes = ast_matchers::match(
       decl(hasDescendant(templateArgumentLoc().bind("ta"))), TU, Ctx);
 
   EXPECT_EQ(BoundNodes.size(), 1u);
 
   const auto *TA = BoundNodes[0].getNodeAs<TemplateArgumentLoc>("ta");
 
-  auto Result = NodeIntrospection::GetLocations(TA);
+  auto Result = NodeIntrospection::GetLocations(*TA);
 
   auto ExpectedLocations =
       FormatExpected<SourceLocation>(Result.LocationAccessors);
 
   EXPECT_THAT(ExpectedLocations,
               UnorderedElementsAre(STRING_LOCATION_PAIR(TA, getLocation())));
 
   auto ExpectedRanges = FormatExpected<SourceRange>(Result.RangeAccessors);
)cpp",
 
   auto BoundNodes = ast_matchers::match(
       decl(hasDescendant(templateArgumentLoc().bind("ta"))), TU, Ctx);
 
   EXPECT_EQ(BoundNodes.size(), 1u);
 
   const auto *TA = BoundNodes[0].getNodeAs<TemplateArgumentLoc>("ta");
 
-  auto Result = NodeIntrospection::GetLocations(TA);
+  auto Result = NodeIntrospection::GetLocations(*TA);
 
   auto ExpectedLocations =
       FormatExpected<SourceLocation>(Result.LocationAccessors);
 
   EXPECT_THAT(ExpectedLocations,
               UnorderedElementsAre(STRING_LOCATION_PAIR(TA, getLocation())));
 
   auto ExpectedRanges = FormatExpected<SourceRange>(Result.RangeAccessors);
)cpp",
 
   auto BoundNodes = ast_matchers::match(
       decl(hasDescendant(templateArgumentLoc().bind("ta"))), TU, Ctx);
 
   EXPECT_EQ(BoundNodes.size(), 1u);
 
   const auto *TA = BoundNodes[0].getNodeAs<TemplateArgumentLoc>("ta");
 
-  auto Result = NodeIntrospection::GetLocations(TA);
+  auto Result = NodeIntrospection::GetLocations(*TA);
 
   auto ExpectedLocations =
       FormatExpected<SourceLocation>(Result.LocationAccessors);
 
   EXPECT_THAT(
       ExpectedLocations,
       UnorderedElementsAre(STRING_LOCATION_PAIR(TA, getLocation()),
                            STRING_LOCATION_PAIR(TA, getTemplateNameLoc())));
)cpp",
 
   auto BoundNodes = ast_matchers::match(
       decl(hasDescendant(templateArgumentLoc().bind("ta"))), TU, Ctx);
 
   EXPECT_EQ(BoundNodes.size(), 1u);
 
   const auto *TA = BoundNodes[0].getNodeAs<TemplateArgumentLoc>("ta");
 
-  auto Result = NodeIntrospection::GetLocations(TA);
+  auto Result = NodeIntrospection::GetLocations(*TA);
 
   auto ExpectedLocations =
       FormatExpected<SourceLocation>(Result.LocationAccessors);
 
   EXPECT_THAT(
       ExpectedLocations,
       UnorderedElementsAre(STRING_LOCATION_PAIR(TA, getLocation()),
                            STRING_LOCATION_PAIR(TA, getTemplateNameLoc()),
)cpp",
 
   auto BoundNodes = ast_matchers::match(
       decl(hasDescendant(templateArgumentLoc().bind("ta"))), TU, Ctx);
 
   EXPECT_EQ(BoundNodes.size(), 1u);
 
   const auto *TA = BoundNodes[0].getNodeAs<TemplateArgumentLoc>("ta");
 
-  auto Result = NodeIntrospection::GetLocations(TA);
+  auto Result = NodeIntrospection::GetLocations(*TA);
 
   auto ExpectedLocations =
       FormatExpected<SourceLocation>(Result.LocationAccessors);
 
   EXPECT_THAT(ExpectedLocations,
               UnorderedElementsAre(STRING_LOCATION_PAIR(TA, getLocation())));
 
   auto ExpectedRanges = FormatExpected<SourceRange>(Result.RangeAccessors);
)cpp",
 
   auto BoundNodes = ast_matchers::match(
       decl(hasDescendant(templateArgumentLoc().bind("ta"))), TU, Ctx);
 
   EXPECT_EQ(BoundNodes.size(), 1u);
 
   const auto *TA = BoundNodes[0].getNodeAs<TemplateArgumentLoc>("ta");
 
-  auto Result = NodeIntrospection::GetLocations(TA);
+  auto Result = NodeIntrospection::GetLocations(*TA);
 
   auto ExpectedLocations =
       FormatExpected<SourceLocation>(Result.LocationAccessors);
 
   // clang-format off
   EXPECT_THAT(ExpectedLocations,
               UnorderedElementsAre(
 STRING_LOCATION_PAIR(TA, getLocation()),