[clang-c] Visit ranged for initializer

[kiloalphaindia]

Summary

Visit the ranged for init statement when using C-Interface.

[kiloalphaindia]

Can we get this into release/17.x still?

[aaron.ballman]

In D158923#4619375, @kiloalphaindia wrote:

Can we get this into release/17.x still?

Alas, but no -- 17.x changes are being limited to just fixes for critical issues/regressions at this point. (Once we start issuing release candidates, new features typically are not ported onto the release branch.)

Thank you for this! Can you also add a release note about the changes to clang/docs/ReleaseNotes.rst?

clang/tools/libclang/CIndex.cpp

2834–2836

AddStmt() already knows how to handle a null pointer.

clang/unittests/libclang/LibclangTest.cpp

1142–1166

Just tiny nits, no functional changes.

clang/tools/libclang/CIndex.cpp

void EnqueueVisitor::VisitCXXCatchStmt(const CXXCatchStmt *S) {
   EnqueueChildren(S);
   AddDecl(S->getExceptionDecl());
 }
 
 void EnqueueVisitor::VisitCXXForRangeStmt(const CXXForRangeStmt *S) {
   AddStmt(S->getBody());
   AddStmt(S->getRangeInit());
   AddDecl(S->getLoopVariable());
+  if (auto *init = S->getInit()) {
+    AddStmt(init);
+  }
 }
 
 void EnqueueVisitor::VisitDeclRefExpr(const DeclRefExpr *DR) {
   if (DR->hasExplicitTemplateArgs())
     AddExplicitTemplateArgs(DR->getTemplateArgs(), DR->getNumTemplateArgs());
   WL.push_back(DeclRefExprParts(DR, Parent));
 }
 void EnqueueVisitor::VisitDependentScopeDeclRefExpr(

clang/unittests/libclang/LibclangTest.cpp

Traverse([&](CXCursor cursor, CXCursor parent) -> CXChildVisitResult {
     }
     return CXChildVisit_Recurse;
   });
   ASSERT_TRUE(typeRefCsr.has_value());
   EXPECT_EQ(fromCXString(clang_getCursorSpelling(*typeRefCsr)),
             "class ns1::Class1");
 }
 
+TEST_F(LibclangParseTest, VisitCXXForRangeStmt_InitStmt) {
+  const char testSource[] = R"cpp(
+void fun()
+{
+    char text[] = "test";
+    for (int init = 0; auto x:text) {}
+}
+)cpp";
+  std::string fileName = "main.cpp";
+  WriteFile(fileName, testSource);
+  const char *Args[] = {"-xc++", "-std=c++20"};
+  ClangTU = clang_parseTranslationUnit(Index, fileName.c_str(), Args,
+                                       std::size(Args), nullptr, 0, TUFlags);
+
+  bool found = false;
+  ;
+  Traverse([&](CXCursor cursor, CXCursor parent) -> CXChildVisitResult {
+    if (cursor.kind == CXCursor_VarDecl &&
+        fromCXString(clang_getCursorSpelling(cursor)) == "init") {
+      found = true;
+      return CXChildVisit_Break;
+    }
+    return CXChildVisit_Recurse;
+  });
+  ASSERT_TRUE(found);
+}
+
 TEST_F(LibclangParseTest, BinaryOperator) {
   std::string Main = "main.cpp";
   WriteFile(Main, "int foo() { return 5 + 9; }");
   ClangTU = clang_parseTranslationUnit(Index, Main.c_str(), nullptr, 0, nullptr,
                                        0, TUFlags);
 
   Traverse([](CXCursor cursor, CXCursor parent) -> CXChildVisitResult {
     if (cursor.kind == CXCursor_BinaryOperator) {