feat: Support code nav for template parameters (#133)

varungandhi-src · web-flow · commit d304f4776eea · 2023-03-23T12:37:42.000+09:00
diff --git a/indexer/Indexer.cc b/indexer/Indexer.cc
@@ -12,6 +12,7 @@
 #include "clang/AST/ASTContext.h"
 #include "clang/AST/Decl.h"
 #include "clang/AST/DeclCXX.h"
+#include "clang/AST/DeclTemplate.h"
 #include "clang/AST/Expr.h"
 #include "clang/AST/RawCommentList.h"
 #include "clang/AST/TypeLoc.h"
@@ -28,6 +29,7 @@
 #include "indexer/Indexer.h"
 #include "indexer/Path.h"
 #include "indexer/ScipExtras.h"
+#include "indexer/SymbolFormatter.h"
 
 namespace scip_clang {
 
@@ -524,6 +526,52 @@ void TuIndexer::saveTagTypeLoc(const clang::TagTypeLoc &tagTypeLoc) {
   }
 }
 
+#define SAVE_TEMPLATE_PARM(name_)                                          \
+  void TuIndexer::save##name_##Decl(const clang::name_##Decl &decl) {      \
+    if (auto optSymbol = this->symbolFormatter.get##name_##Symbol(decl)) { \
+      this->saveDefinition(*optSymbol, decl.getLocation(), std::nullopt);  \
+    }                                                                      \
+  }
+FOR_EACH_TEMPLATE_PARM_TO_BE_INDEXED(SAVE_TEMPLATE_PARM)
+#undef SAVE_TEMPLATE_PARM
+
+void TuIndexer::saveTemplateTypeParmTypeLoc(
+    const clang::TemplateTypeParmTypeLoc &templateTypeParmTypeLoc) {
+  if (auto optSymbol = this->symbolFormatter.getTemplateTypeParmSymbol(
+          *templateTypeParmTypeLoc.getDecl())) {
+    this->saveReference(*optSymbol, templateTypeParmTypeLoc.getNameLoc());
+  }
+}
+
+void TuIndexer::saveTemplateSpecializationTypeLoc(
+    const clang::TemplateSpecializationTypeLoc &templateSpecializationTypeLoc) {
+  auto *templateSpecializationType = templateSpecializationTypeLoc.getTypePtr();
+  auto templateName = templateSpecializationType->getTemplateName();
+  using Kind = clang::TemplateName::NameKind;
+  switch (templateName.getKind()) {
+  case Kind::Template: {
+    if (auto *templateTemplateParmDecl =
+            llvm::dyn_cast<clang::TemplateTemplateParmDecl>(
+                templateName.getAsTemplateDecl())) {
+      if (auto optSymbol = this->symbolFormatter.getTemplateTemplateParmSymbol(
+              *templateTemplateParmDecl)) {
+        this->saveReference(*optSymbol,
+                            templateSpecializationTypeLoc.getTemplateNameLoc());
+      }
+    }
+    break;
+  }
+  case Kind::OverloadedTemplate:
+  case Kind::AssumedTemplate:
+  case Kind::QualifiedTemplate:
+  case Kind::DependentTemplate:
+  case Kind::SubstTemplateTemplateParm:
+  case Kind::SubstTemplateTemplateParmPack:
+  case Kind::UsingTemplate:
+    break;
+  }
+}
+
 void TuIndexer::saveTypedefNameDecl(
     const clang::TypedefNameDecl &typedefNameDecl) {
   auto optSymbol = this->symbolFormatter.getNamedDeclSymbol(typedefNameDecl);
diff --git a/indexer/Indexer.h b/indexer/Indexer.h
@@ -27,7 +27,9 @@
 
 #define FOR_EACH_TYPE_TO_BE_INDEXED(F) \
   F(Enum)                              \
-  F(Record)
+  F(Record)                            \
+  F(TemplateSpecialization)            \
+  F(TemplateTypeParm)
 
 namespace clang {
 #define FORWARD_DECLARE(DeclName) class DeclName##Decl;
diff --git a/indexer/SymbolFormatter.cc b/indexer/SymbolFormatter.cc
@@ -9,6 +9,7 @@
 
 #include "clang/AST/Decl.h"
 #include "clang/AST/DeclCXX.h"
+#include "clang/AST/DeclTemplate.h"
 #include "clang/Basic/SourceLocation.h"
 #include "clang/Basic/SourceManager.h"
 #include "llvm/Support/raw_ostream.h"
@@ -331,7 +332,10 @@ SymbolFormatter::getBindingSymbol(const clang::BindingDecl &bindingDecl) {
 }
 
 std::optional<std::string_view>
-SymbolFormatter::getNextLocalSymbol(const clang::ValueDecl &decl) {
+SymbolFormatter::getNextLocalSymbol(const clang::NamedDecl &decl) {
+  if (decl.getDeclName().isEmpty()) {
+    return {};
+  }
   return this->getSymbolCached(decl, [&]() -> std::optional<std::string> {
     auto loc = this->sourceManager.getExpansionLoc(decl.getLocation());
     auto defFileId = this->sourceManager.getFileID(loc);
@@ -467,12 +471,17 @@ SymbolFormatter::getNamespaceSymbol(const clang::NamespaceDecl &namespaceDecl) {
 std::optional<std::string_view>
 SymbolFormatter::getLocalVarOrParmSymbol(const clang::VarDecl &varDecl) {
   ENFORCE(varDecl.isLocalVarDeclOrParm());
-  if (varDecl.getName().empty()) {
-    return {};
-  }
   return this->getNextLocalSymbol(varDecl);
 }
 
+#define GET_AS_LOCAL(name_)                                            \
+  std::optional<std::string_view> SymbolFormatter::get##name_##Symbol( \
+      const clang::name_##Decl &decl) {                                \
+    return this->getNextLocalSymbol(decl);                             \
+  }
+FOR_EACH_TEMPLATE_PARM_TO_BE_INDEXED(GET_AS_LOCAL)
+#undef GET_AS_LOCAL
+
 std::optional<std::string_view> SymbolFormatter::getTypedefNameSymbol(
     const clang::TypedefNameDecl &typedefNameDecl) {
   return this->getSymbolCached(
diff --git a/indexer/SymbolFormatter.h b/indexer/SymbolFormatter.h
@@ -23,10 +23,18 @@
   F(Field)                             \
   F(Function)                          \
   F(Namespace)                         \
+  F(NonTypeTemplateParm)               \
   F(Record)                            \
+  F(TemplateTemplateParm)              \
+  F(TemplateTypeParm)                  \
   F(TypedefName)                       \
   F(Var)
 
+#define FOR_EACH_TEMPLATE_PARM_TO_BE_INDEXED(F) \
+  F(NonTypeTemplateParm)                        \
+  F(TemplateTemplateParm)                       \
+  F(TemplateTypeParm)
+
 namespace clang {
 #define FORWARD_DECLARE(DeclName) class DeclName##Decl;
 FOR_EACH_DECL_TO_BE_INDEXED(FORWARD_DECLARE)
@@ -132,7 +140,7 @@ class SymbolFormatter final {
   getSymbolCached(const clang::Decl &,
                   absl::FunctionRef<std::optional<std::string>()>);
 
-  std::optional<std::string_view> getNextLocalSymbol(const clang::ValueDecl &);
+  std::optional<std::string_view> getNextLocalSymbol(const clang::NamedDecl &);
 
   /// Format the string to a buffer stored by `this` and return a view to it.
   template <typename... T>
diff --git a/test/index/functions/ctors_dtors.snapshot.cc b/test/index/functions/ctors_dtors.snapshot.cc
@@ -1,21 +1,31 @@
   // extra-args: -std=c++20
   
   template<class T> struct remove_ref      { typedef T type; };
+//               ^ definition local 0
 //                         ^^^^^^^^^^ definition [..] remove_ref#
+//                                                   ^ reference local 0
 //                                                     ^^^^ definition [..] remove_ref#type#
   template<class T> struct remove_ref<T&>  { typedef T type; };
+//               ^ definition local 1
 //                         ^^^^^^^^^^ definition [..] remove_ref#
+//                                    ^ reference local 1
+//                                                   ^ reference local 1
 //                                                     ^^^^ definition [..] remove_ref#type#
   template<class T> struct remove_ref<T&&> { typedef T type; };
+//               ^ definition local 2
 //                         ^^^^^^^^^^ definition [..] remove_ref#
+//                                    ^ reference local 2
+//                                                   ^ reference local 2
 //                                                     ^^^^ definition [..] remove_ref#type#
   
   template <typename T>
+//                   ^ definition local 3
   typename remove_ref<T>::type&& move(T&& arg) {
 //                               ^^^^ definition [..] move(721d19cf58c53974).
-//                                        ^^^ definition local 0
+//                                    ^ reference local 3
+//                                        ^^^ definition local 4
     return static_cast<typename remove_ref<T>::type&&>(arg);
-//                                                     ^^^ reference local 0
+//                                                     ^^^ reference local 4
   }
   
   struct C {
@@ -55,68 +65,68 @@
 //     ^^^^^^^^^^ definition [..] test_ctors(49f6e7a06ebc5aa8).
     C c0;
 //  ^ reference [..] C#
-//    ^^ definition local 1
+//    ^^ definition local 5
     D d0;
 //  ^ reference [..] D#
-//    ^^ definition local 2
+//    ^^ definition local 6
     C c1{};
 //  ^ reference [..] C#
-//    ^^ definition local 3
+//    ^^ definition local 7
     D d1{};
 //  ^ reference [..] D#
-//    ^^ definition local 4
+//    ^^ definition local 8
     C c2{0, 1};
 //  ^ reference [..] C#
-//    ^^ definition local 5
+//    ^^ definition local 9
     // TODO: Figure out a minimal stub for std::initializer_list,
     // which we can use here, without running into Clang's
     // "cannot compile this weird std::initializer_list yet" error
     // D d2{0, 1};
     C c3{move(c1)};
 //  ^ reference [..] C#
-//    ^^ definition local 6
-//            ^^ reference local 3
+//    ^^ definition local 10
+//            ^^ reference local 7
     D d3{move(d1)};
 //  ^ reference [..] D#
-//    ^^ definition local 7
-//            ^^ reference local 4
+//    ^^ definition local 11
+//            ^^ reference local 8
   
     C c4 = {};
 //  ^ reference [..] C#
-//    ^^ definition local 8
+//    ^^ definition local 12
     D d4 = {};
 //  ^ reference [..] D#
-//    ^^ definition local 9
+//    ^^ definition local 13
     C c5 = C();
 //  ^ reference [..] C#
-//    ^^ definition local 10
+//    ^^ definition local 14
 //         ^ reference [..] C#
     D d5 = D();
 //  ^ reference [..] D#
-//    ^^ definition local 11
+//    ^^ definition local 15
 //         ^ reference [..] D#
     C c6 = {0, 1};
 //  ^ reference [..] C#
-//    ^^ definition local 12
+//    ^^ definition local 16
     // Uncomment after adding initializer_list
     // D d6 = {0, 1};
   
     C c7 = {.x = 0};
 //  ^ reference [..] C#
-//    ^^ definition local 13
+//    ^^ definition local 17
     C c8 = {.x = 0, .y = 1};
 //  ^ reference [..] C#
-//    ^^ definition local 14
+//    ^^ definition local 18
     C c9 = C{0, 1};
 //  ^ reference [..] C#
-//    ^^ definition local 15
+//    ^^ definition local 19
 //         ^ reference [..] C#
     C c10 = move(c1);
 //  ^ reference [..] C#
-//    ^^^ definition local 16
-//               ^^ reference local 3
+//    ^^^ definition local 20
+//               ^^ reference local 7
     D d10 = move(d1);
 //  ^ reference [..] D#
-//    ^^^ definition local 17
-//               ^^ reference local 4
+//    ^^^ definition local 21
+//               ^^ reference local 8
   }
diff --git a/test/index/functions/operators.snapshot.cc b/test/index/functions/operators.snapshot.cc
@@ -271,6 +271,7 @@
   
   template <A a> // since C++20
 //          ^ reference [..] A#
+//            ^ definition local 25
   void operator ""_a_op() { return; }
 //     ^^^^^^^^ definition [..] `operator""_a_op`(49f6e7a06ebc5aa8).
   
diff --git a/test/index/types/bad_tagdecl.snapshot.cc b/test/index/types/bad_tagdecl.snapshot.cc
@@ -10,22 +10,32 @@
   // See NOTE(def: missing-definition-for-tagdecl)
   
   template<bool B, class T = void>
+//              ^ definition local 0
+//                       ^ definition local 1
   struct enable_if {};
 //       ^^^^^^^^^ definition [..] enable_if#
    
   template<class T>
+//               ^ definition local 2
   struct enable_if<true, T> { typedef T type; };
 //       ^^^^^^^^^ definition [..] enable_if#
+//                       ^ reference local 2
+//                                    ^ reference local 2
 //                                      ^^^^ definition [..] enable_if#type#
   
   template< bool B, class T = void >
+//               ^ definition local 3
+//                        ^ definition local 4
   using enable_if_t = typename enable_if<B,T>::type;
 //      ^^^^^^^^^^^ definition [..] enable_if_t#
   
   template <typename T, typename Enable = void> struct MyTemplate { };
+//                   ^ definition local 5
+//                               ^^^^^^ definition local 6
 //                                                     ^^^^^^^^^^ definition [..] MyTemplate#
   
   template <class T>
+//                ^ definition local 7
   struct ShouldEnable { static bool const value = false; };
 //       ^^^^^^^^^^^^ definition [..] ShouldEnable#
 //                                        ^^^^^ definition [..] ShouldEnable#value.
diff --git a/test/index/types/templates.cc b/test/index/types/templates.cc
@@ -0,0 +1,14 @@
+// extra-args: -std=c++17
+
+template <typename ...Args>
+struct S0 {
+  void f(Args... args) {}
+};
+
+template <typename A, typename B, template <typename> typename F>
+F<B> fmap(A f(B), F<A> fa) {
+  return fa.fmap(f);
+}
+
+template <int N>
+void f(int arr[N]) {}
diff --git a/test/index/types/templates.snapshot.cc b/test/index/types/templates.snapshot.cc
@@ -0,0 +1,37 @@
+  // extra-args: -std=c++17
+  
+  template <typename ...Args>
+//                      ^^^^ definition local 0
+  struct S0 {
+//       ^^ definition [..] S0#
+    void f(Args... args) {}
+//       ^ definition [..] S0#f(f327490b5edb0dcb).
+//         ^^^^ reference local 0
+//                 ^^^^ definition local 1
+  };
+  
+  template <typename A, typename B, template <typename> typename F>
+//                   ^ definition local 2
+//                               ^ definition local 3
+//                                                               ^ definition local 4
+  F<B> fmap(A f(B), F<A> fa) {
+//^ reference local 4
+//  ^ reference local 3
+//     ^^^^ definition [..] fmap(48b319d339a486cb).
+//          ^ reference local 2
+//            ^ definition local 5
+//              ^ reference local 3
+//                  ^ reference local 4
+//                    ^ reference local 2
+//                       ^^ definition local 6
+    return fa.fmap(f);
+//         ^^ reference local 6
+//                 ^ reference local 5
+  }
+  
+  template <int N>
+//              ^ definition local 7
+  void f(int arr[N]) {}
+//     ^ definition [..] f(11b0e290e57a7e53).
+//           ^^^ definition local 8
+//               ^ reference local 7
diff --git a/test/index/types/types.snapshot.cc b/test/index/types/types.snapshot.cc
