[Index] Set OrigD before D is changed.

[akyrtzi]

Is it possible to add a regression test case ? I assume this is fixing some issue, we should make sure we don't regress again.

[ioeric]

In D49476#1167294, @akyrtzi wrote:

Is it possible to add a regression test case ? I assume this is fixing some issue, we should make sure we don't regress again.

This fixes a downstream use case where we use OrigD. AFAICT, c-index-test is used to tests the index library, but it doesn't seem to use OrigD at all. We could probably add a flag to c-index-test to optionally print out OrigD. I didn't go down this path because I thought this change is trivial and doesn't break any existing changes. If you think optionally checking OrigD is reasonable, I'd be happy to add that with a test case.

[akyrtzi]

CXIndexDataConsumer.cpp uses ASTNode.OrigD, that code is exercised when you run c-index-test -index-file <...>. I'd recommend to at least check if that command would produce a different output for the test case that you detected originally.

[ioeric]

• try to add a test case.

[ioeric]

In D49476#1168604, @akyrtzi wrote:

CXIndexDataConsumer.cpp uses ASTNode.OrigD, that code is exercised when you run c-index-test -index-file <...>. I'd recommend to at least check if that command would produce a different output for the test case that you detected originally.

Thanks for the pointer!

I've given this a try but still didn't manage to come up with a test that would produce different outputs. Basically, what I'm trying to achieve is to get the original (implicit) template instantiation declarations from their references (see the added test case). This is hard to verify with c-index-test because 1) for declarations, although OrigD is used in the test, implicit instantiations are simply discarded (https://github.com/llvm-mirror/clang/blob/master/lib/Index/IndexingContext.cpp#L354) and 2) for references, c-index-test doesn't use OrigD to print symbol info.

Let me know if there is a better approach.

[akyrtzi]

Good enough, thanks for looking into this!

cfe/trunk/lib/Index/IndexingContext.cpp

case IndexingOptions::SystemSymbolFilterKind::DeclarationsOnly:
       if (!shouldReportOccurrenceForSystemDeclOnlyMode(IsRef, Roles, Relations))
         return true;
       break;
     case IndexingOptions::SystemSymbolFilterKind::All:
       break;
     }
   }
 
+  if (!OrigD)
+    OrigD = D;
+
   if (isTemplateImplicitInstantiation(D)) {
     if (!IsRef)
       return true;
     D = adjustTemplateImplicitInstantiation(D);
     if (!D)
       return true;
     assert(!isTemplateImplicitInstantiation(D));
   }
 
-  if (!OrigD)
-    OrigD = D;
-
   if (IsRef)
     Roles |= (unsigned)SymbolRole::Reference;
   else if (isDeclADefinition(OrigD, ContainerDC, *Ctx))
     Roles |= (unsigned)SymbolRole::Definition;
   else
     Roles |= (unsigned)SymbolRole::Declaration;
 
   D = getCanonicalDecl(D);

cfe/trunk/test/Index/index-template-specialization.cpp

+template <typename T>
+class Foo {
+public:
+  void f(T t) {}
+};
+
+void g() {
+  Foo<int> foo;
+  foo.f(0);
+}
+
+// FIXME: if c-index-test uses OrigD for symbol info, refererences below should
+// refer to template specialization decls.
+// RUN: env CINDEXTEST_INDEXIMPLICITTEMPLATEINSTANTIATIONS=1 c-index-test -index-file %s | FileCheck %s
+// CHECK: [indexDeclaration]: kind: c++-class-template | name: Foo
+// CHECK-NEXT: [indexDeclaration]: kind: c++-instance-method | name: f
+// CHECK-NEXT: [indexDeclaration]: kind: function | name: g
+// CHECK-NEXT: [indexEntityReference]: kind: c++-class-template | name: Foo | USR: c:@ST>1#T@Foo
+// CHECK-NEXT: [indexEntityReference]: kind: c++-instance-method | name: f | USR: c:@ST>1#T@Foo@F@f#t0.0#

cfe/trunk/tools/c-index-test/c-index-test.c

static unsigned getIndexOptions(void) {
   unsigned index_opts;
   index_opts = 0;
   if (getenv("CINDEXTEST_SUPPRESSREFS"))
     index_opts |= CXIndexOpt_SuppressRedundantRefs;
   if (getenv("CINDEXTEST_INDEXLOCALSYMBOLS"))
     index_opts |= CXIndexOpt_IndexFunctionLocalSymbols;
   if (!getenv("CINDEXTEST_DISABLE_SKIPPARSEDBODIES"))
     index_opts |= CXIndexOpt_SkipParsedBodiesInSession;
+  if (getenv("CINDEXTEST_INDEXIMPLICITTEMPLATEINSTANTIATIONS"))
+    index_opts |= CXIndexOpt_IndexImplicitTemplateInstantiations;
 
   return index_opts;
 }
 
 static int index_compile_args(int num_args, const char **args,
                               CXIndexAction idxAction,
                               ImportedASTFilesData *importedASTs,
                               const char *check_prefix) {

cfe/trunk/tools/libclang/Indexing.cpp

 //===----------------------------------------------------------------------===//
 // clang_indexSourceFileUnit Implementation
 //===----------------------------------------------------------------------===//
 
 static IndexingOptions getIndexingOptionsFromCXOptions(unsigned index_options) {
   IndexingOptions IdxOpts;
   if (index_options & CXIndexOpt_IndexFunctionLocalSymbols)
     IdxOpts.IndexFunctionLocals = true;
+  if (index_options & CXIndexOpt_IndexImplicitTemplateInstantiations)
+    IdxOpts.IndexImplicitInstantiation = true;
   return IdxOpts;
 }
 
 struct IndexSessionData {
   CXIndex CIdx;
   std::unique_ptr<SessionSkipBodyData> SkipBodyData;
 
   explicit IndexSessionData(CXIndex cIdx)