[Format] Fix detection of languages when reading from stdin

[bhamiltoncx]

The code cleanup in #74794 accidentally broke detection of languages by reading file content from stdin, e.g. via clang-format -dump-config - < /path/to/filename.

This PR adds unit and integration tests to reproduce the issue and adds a fix.

Fixes: #79023

[llvmbot]

@llvm/pr-subscribers-clang-format

Author: Ben Hamilton (Ben Gertzfield) (bhamiltoncx)

Changes

The code cleanup in #74794 accidentally broke detection of languages by reading file content from stdin, e.g. via clang-format -dump-config - < /path/to/filename.

This PR adds unit and integration tests to reproduce the issue and adds a fix.

Fixes: #79023

---

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

3 Files Affected:

• (added) clang/test/Format/dump-config-objc-stdin.m (+5)
• (modified) clang/tools/clang-format/ClangFormat.cpp (+13-11)
• (modified) clang/unittests/Format/FormatTestObjC.cpp (+8)

diff --git a/clang/test/Format/dump-config-objc-stdin.m b/clang/test/Format/dump-config-objc-stdin.m
new file mode 100644
index 000000000000000..b22ff7b3328caa5
--- /dev/null
+++ b/clang/test/Format/dump-config-objc-stdin.m
@@ -0,0 +1,5 @@
+// RUN: clang-format -dump-config - < %s | FileCheck %s
+
+// CHECK: Language: ObjC
+@interface Foo
+@end
diff --git a/clang/tools/clang-format/ClangFormat.cpp b/clang/tools/clang-format/ClangFormat.cpp
index 49ab7677a3ee9c2..9cd61ed903a551b 100644
--- a/clang/tools/clang-format/ClangFormat.cpp
+++ b/clang/tools/clang-format/ClangFormat.cpp
@@ -547,18 +547,20 @@ static void PrintVersion(raw_ostream &OS) {
 // Dump the configuration.
 static int dumpConfig(bool IsSTDIN) {
   std::unique_ptr<llvm::MemoryBuffer> Code;
-  // We can't read the code to detect the language if there's no file name.
-  if (!IsSTDIN) {
-    // Read in the code in case the filename alone isn't enough to detect the
-    // language.
-    ErrorOr<std::unique_ptr<MemoryBuffer>> CodeOrErr =
-        MemoryBuffer::getFileOrSTDIN(FileNames[0]);
-    if (std::error_code EC = CodeOrErr.getError()) {
-      llvm::errs() << EC.message() << "\n";
-      return 1;
-    }
-    Code = std::move(CodeOrErr.get());
+
+  // FileNames should have at least "-" in it even if no file was specified.
+  assert(!FileNames.empty());
+
+  // Read in the code in case the filename alone isn't enough to detect the
+  // language.
+  ErrorOr<std::unique_ptr<MemoryBuffer>> CodeOrErr =
+      MemoryBuffer::getFileOrSTDIN(FileNames[0]);
+  if (std::error_code EC = CodeOrErr.getError()) {
+    llvm::errs() << EC.message() << "\n";
+    return 1;
   }
+  Code = std::move(CodeOrErr.get());
+
   llvm::Expected<clang::format::FormatStyle> FormatStyle =
       clang::format::getStyle(Style, IsSTDIN ? AssumeFileName : FileNames[0],
                               FallbackStyle, Code ? Code->getBuffer() : "");
diff --git a/clang/unittests/Format/FormatTestObjC.cpp b/clang/unittests/Format/FormatTestObjC.cpp
index cd4f9d934127bfd..d2c3459e0f846d7 100644
--- a/clang/unittests/Format/FormatTestObjC.cpp
+++ b/clang/unittests/Format/FormatTestObjC.cpp
@@ -31,6 +31,14 @@ class FormatTestObjC : public FormatTestBase {
   _verifyIncompleteFormat(__FILE__, __LINE__, __VA_ARGS__)
 #define verifyFormat(...) _verifyFormat(__FILE__, __LINE__, __VA_ARGS__)
 
+TEST(FormatTestObjCStyle, DetectsObjCInStdin) {
+  auto Style = getStyle("LLVM", "<stdin>", "none",
+                        "@interface\n"
+                        "- (id)init;");
+  ASSERT_TRUE((bool)Style);
+  EXPECT_EQ(FormatStyle::LK_ObjC, Style->Language);
+}
+
 TEST(FormatTestObjCStyle, DetectsObjCInHeaders) {
   auto Style = getStyle("LLVM", "a.h", "none",
                         "@interface\n"

[owenca]

@bhamiltoncx Thanks for the fix! Nevertheless, it seems that this triggered a new regression. See #80621.

[bhamiltoncx]

Interesting! Might be because you changed the logic to always read from stdin if no args are specified? I wasn't quite sure what that part of your change was about.

…

On Sun, Feb 4, 2024, 16:04 Owen Pan ***@***.***> wrote: @bhamiltoncx <https://github.com/bhamiltoncx> Thanks for the fix! Nevertheless, it seems that this triggered a new regression. See #80621 <#80621>. — Reply to this email directly, view it on GitHub <#79051 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAFEAU6ZI65Q27DTXAXXT5TYSAHYFAVCNFSM6AAAAABCF2LVHOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMRVHE2TQMZYGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[owenca]

Probably. See #80628 for a fix.