[clang-format] Add DiagHandler parameter to format::getStyle() #91317

pointhex · 2024-05-07T10:28:32Z

It allows to control of error output for the function.

github-actions · 2024-05-07T10:28:53Z

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be
notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write
permissions for the repository. In which case you can instead tag reviewers by
name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review
by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate
is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

llvmbot · 2024-05-07T10:29:25Z

@llvm/pr-subscribers-clang-format

Author: None (pointhex)

Changes

It allows to control of error output for the function.

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

2 Files Affected:

(modified) clang/include/clang/Format/Format.h (+2-1)
(modified) clang/lib/Format/Format.cpp (+11-8)

diff --git a/clang/include/clang/Format/Format.h b/clang/include/clang/Format/Format.h
index 74893f23210cd..aa6a2a16fa8ec 100644
--- a/clang/include/clang/Format/Format.h
+++ b/clang/include/clang/Format/Format.h
@@ -5385,7 +5385,8 @@ llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
                                      StringRef FallbackStyle,
                                      StringRef Code = "",
                                      llvm::vfs::FileSystem *FS = nullptr,
-                                     bool AllowUnknownOptions = false);
+                                     bool AllowUnknownOptions = false,
+                                     llvm::SourceMgr::DiagHandlerTy DiagHandler = nullptr);
 
 // Guesses the language from the ``FileName`` and ``Code`` to be formatted.
 // Defaults to FormatStyle::LK_Cpp.
diff --git a/clang/lib/Format/Format.cpp b/clang/lib/Format/Format.cpp
index c4eac1c99a663..cf8a2a050a83c 100644
--- a/clang/lib/Format/Format.cpp
+++ b/clang/lib/Format/Format.cpp
@@ -3947,12 +3947,13 @@ const char *DefaultFallbackStyle = "LLVM";
 
 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>>
 loadAndParseConfigFile(StringRef ConfigFile, llvm::vfs::FileSystem *FS,
-                       FormatStyle *Style, bool AllowUnknownOptions) {
+                       FormatStyle *Style, bool AllowUnknownOptions,
+                       llvm::SourceMgr::DiagHandlerTy DiagHandler = nullptr) {
   llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
       FS->getBufferForFile(ConfigFile.str());
   if (auto EC = Text.getError())
     return EC;
-  if (auto EC = parseConfiguration(*Text.get(), Style, AllowUnknownOptions))
+  if (auto EC = parseConfiguration(*Text.get(), Style, AllowUnknownOptions, DiagHandler))
     return EC;
   return Text;
 }
@@ -3960,7 +3961,8 @@ loadAndParseConfigFile(StringRef ConfigFile, llvm::vfs::FileSystem *FS,
 llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
                                      StringRef FallbackStyleName,
                                      StringRef Code, llvm::vfs::FileSystem *FS,
-                                     bool AllowUnknownOptions) {
+                                     bool AllowUnknownOptions,
+                                     llvm::SourceMgr::DiagHandlerTy DiagHandler) {
   FormatStyle Style = getLLVMStyle(guessLanguage(FileName, Code));
   FormatStyle FallbackStyle = getNoStyle();
   if (!getPredefinedStyle(FallbackStyleName, Style.Language, &FallbackStyle))
@@ -3974,7 +3976,7 @@ llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
     StringRef Source = "<command-line>";
     if (std::error_code ec =
             parseConfiguration(llvm::MemoryBufferRef(StyleName, Source), &Style,
-                               AllowUnknownOptions)) {
+                               AllowUnknownOptions, DiagHandler)) {
       return make_string_error("Error parsing -style: " + ec.message());
     }
 
@@ -3994,7 +3996,7 @@ llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
       StyleName.starts_with_insensitive("file:")) {
     auto ConfigFile = StyleName.substr(5);
     llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
-        loadAndParseConfigFile(ConfigFile, FS, &Style, AllowUnknownOptions);
+        loadAndParseConfigFile(ConfigFile, FS, &Style, AllowUnknownOptions, DiagHandler);
     if (auto EC = Text.getError()) {
       return make_string_error("Error reading " + ConfigFile + ": " +
                                EC.message());
@@ -4029,12 +4031,13 @@ llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
   // Reset possible inheritance
   Style.InheritsParentConfig = false;
 
-  auto dropDiagnosticHandler = [](const llvm::SMDiagnostic &, void *) {};
+  auto diagHandlerOrDropHandling =
+      DiagHandler ? DiagHandler : [](llvm::SMDiagnostic const &, void *) {};
 
   auto applyChildFormatTexts = [&](FormatStyle *Style) {
     for (const auto &MemBuf : llvm::reverse(ChildFormatTextToApply)) {
       auto EC = parseConfiguration(*MemBuf, Style, AllowUnknownOptions,
-                                   dropDiagnosticHandler);
+                                   diagHandlerOrDropHandling);
       // It was already correctly parsed.
       assert(!EC);
       static_cast<void>(EC);
@@ -4068,7 +4071,7 @@ llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
       }
 
       llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
-          loadAndParseConfigFile(ConfigFile, FS, &Style, AllowUnknownOptions);
+          loadAndParseConfigFile(ConfigFile, FS, &Style, AllowUnknownOptions, DiagHandler);
       if (auto EC = Text.getError()) {
         if (EC != ParseError::Unsuitable) {
           return make_string_error("Error reading " + ConfigFile + ": " +

github-actions · 2024-05-09T10:08:38Z

✅ With the latest revision this PR passed the C/C++ code formatter.

mydeveloperday · 2024-05-14T06:52:30Z

is there a github issue for this?

pointhex · 2024-05-14T08:19:45Z

@mydeveloperday There is no issue, It is my request. I implemented it without creating an issue or suggestion. Should I?

HazardyKnusperkeks · 2024-05-21T19:23:15Z

For the record, I see no harm in this PR and would also merge it without an issue. Just giving @mydeveloperday a bit more time to answer. :)

pointhex · 2024-06-03T08:25:02Z

Hi @mydeveloperday, friendly reminder :)

mydeveloperday · 2024-06-03T09:50:41Z

Please log an issue explaining the problem you are trying solve, its not clear to me what problem led you to this.

pointhex · 2024-06-03T10:21:33Z

Done: #94205

HazardyKnusperkeks

Now that I see you want to incorporate it into QtCreator I'm even more in favor of adding it. ;)

mydeveloperday

I don't have a major issue, but I think it needs a unit test otherwise we might forget how you are using it.

mydeveloperday · 2024-06-03T23:07:21Z

I also think we need @owenca opinion

owenca

Can you call parseConfiguration() instead of getStyle() in QtCreator while the user is entering code? It seems inefficient to call getStyle() all the time.

clang/lib/Format/Format.cpp

pointhex · 2024-06-04T08:21:14Z

Can you call parseConfiguration() instead of getStyle() in QtCreator while the user is entering code? It seems inefficient to call getStyle() all the time.

I do it in the places where I can use parseConfiguration instead. But in some cases I need getStyle and it's also called quite often. I have one optimisation in my mind, but I would like to have that patch as well anyway.

Am I right that no one has a major issue with the patch? So fixing the "const" issue and adding a unit test will let that in?

clang/lib/Format/Format.cpp

pointhex · 2024-06-11T08:34:17Z

@mydeveloperday @owenca Kind reminder.

owenca · 2024-06-11T08:39:24Z

Am I right that no one has a major issue with the patch? So fixing the "const" issue and adding a unit test will let that in?

Can you add a unit test?

pointhex · 2024-06-11T09:26:29Z

Can you add a unit test?

Yes, no problem, I just didn't get if it is needed or not.

owenca · 2024-06-12T01:49:42Z

@mydeveloperday requested it. See #91317 (review).

There are calls to getStyle() in ConfigParseTest.cpp. Maybe add a test there?

pointhex · 2024-06-13T13:03:28Z

I used to redirect output. I guess that is enough. Maybe, you know a better solution for that.

    auto Style = getStyle("{invalid_key=invalid_value}", "a.h", "LLVM", "", &FS, false);
    ...
    const std::string output = ::testing::internal::GetCapturedStderr();

owenca · 2024-06-14T05:47:43Z

clang/lib/Format/Format.cpp

-  auto dropDiagnosticHandler = [](const llvm::SMDiagnostic &, void *) {};
-


Sorry! We do need it.

No problem.

owenca · 2024-06-14T05:50:39Z

clang/lib/Format/Format.cpp

      auto EC = parseConfiguration(*MemBuf, Style, AllowUnknownOptions,
-                                   dropDiagnosticHandler);
+                                   DiagHandler);


auto applyChildFormatTexts = [&](FormatStyle *Style) { for (const auto &MemBuf : llvm::reverse(ChildFormatTextToApply)) { - auto EC = parseConfiguration(*MemBuf, Style, AllowUnknownOptions, - DiagHandler); + auto EC = + parseConfiguration(*MemBuf, Style, AllowUnknownOptions, + DiagHandler ? DiagHandler : dropDiagnosticHandler); // It was already correctly parsed. assert(!EC); static_cast<void>(EC);

clang/unittests/Format/ConfigParseTest.cpp

owenca · 2024-06-14T07:02:35Z

clang/unittests/Format/ConfigParseTest.cpp

+    // Without output
+    ::testing::internal::CaptureStderr();
+    auto Style1 = getStyle("{invalid_key=invalid_value}",
+                           "a.h",
+                           "LLVM",
+                           "",
+                           &FS,
+                           false,
+                           [](const llvm::SMDiagnostic &, void *) {});
+
+    const std::string output1 = ::testing::internal::GetCapturedStderr();
+
+    ASSERT_FALSE((bool)Style1);
+    ASSERT_TRUE(output1.empty());
+    llvm::consumeError(Style1.takeError());


Suggested change

// Without output

::testing::internal::CaptureStderr();

auto Style1 = getStyle("{invalid_key=invalid_value}",

"a.h",

"LLVM",

"",

&FS,

false,

[](const llvm::SMDiagnostic &, void *) {});

const std::string output1 = ::testing::internal::GetCapturedStderr();

ASSERT_FALSE((bool)Style1);

ASSERT_TRUE(output1.empty());

llvm::consumeError(Style1.takeError());

// Suppress stderr.

testing::internal::CaptureStderr();

auto Style1 = getStyle("{invalid_key=invalid_value}", "a.h", "LLVM", "", &FS,

/*AllowUnknownOptions=*/true,

[](const llvm::SMDiagnostic &, void *) {});

const auto output1 = testing::internal::GetCapturedStderr();

ASSERT_TRUE((bool)Style1);

ASSERT_TRUE(output1.empty());

owenca · 2024-06-14T07:46:33Z

clang/unittests/Format/ConfigParseTest.cpp

+    // With output
+    ::testing::internal::CaptureStderr();
+    llvm::vfs::InMemoryFileSystem FS;
+    auto Style = getStyle("{invalid_key=invalid_value}", "a.h", "LLVM", "", &FS, false);
+
+    const std::string output = ::testing::internal::GetCapturedStderr();
+
+    ASSERT_FALSE((bool)Style);
+    ASSERT_FALSE(output.empty());
+    llvm::consumeError(Style.takeError());


Suggested change

// With output

::testing::internal::CaptureStderr();

llvm::vfs::InMemoryFileSystem FS;

auto Style = getStyle("{invalid_key=invalid_value}", "a.h", "LLVM", "", &FS, false);

const std::string output = ::testing::internal::GetCapturedStderr();

ASSERT_FALSE((bool)Style);

ASSERT_FALSE(output.empty());

llvm::consumeError(Style.takeError());

llvm::vfs::InMemoryFileSystem FS;

// Don't suppress output.

testing::internal::CaptureStderr();

auto Style = getStyle("{invalid_key=invalid_value}", "a.h", "LLVM", "", &FS,

/*AllowUnknownOptions=*/true);

const auto output = testing::internal::GetCapturedStderr();

ASSERT_TRUE((bool)Style);

ASSERT_FALSE(output.empty());

It allows to control of error output for the function.

github-actions · 2024-06-16T20:58:44Z

@pointhex Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested
by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as
the builds can include changes from many authors. It is not uncommon for your
change to be included in a build that fails due to someone else's changes, or
infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself.
This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

pointhex · 2024-06-16T21:25:04Z

@owenca Thanks a lot!

llvmbot added the clang-format label May 7, 2024

pointhex force-pushed the addToGetStyleDiagHandler branch 2 times, most recently from 9cc8bf3 to 3a0808d Compare May 14, 2024 13:30

mydeveloperday requested a review from owenca June 3, 2024 09:55

mydeveloperday changed the title ~~[ClangFormat] Add DiagHandler for getStyle function~~ [clang-format] Add DiagHandler for getStyle function Jun 3, 2024

HazardyKnusperkeks approved these changes Jun 3, 2024

View reviewed changes

mydeveloperday reviewed Jun 3, 2024

View reviewed changes

owenca reviewed Jun 4, 2024

View reviewed changes

clang/lib/Format/Format.cpp Outdated Show resolved Hide resolved

owenca reviewed Jun 5, 2024

View reviewed changes

clang/lib/Format/Format.cpp Outdated Show resolved Hide resolved

clang/lib/Format/Format.cpp Outdated Show resolved Hide resolved

clang/lib/Format/Format.cpp Outdated Show resolved Hide resolved

pointhex force-pushed the addToGetStyleDiagHandler branch from 4a2cefa to 3763408 Compare June 6, 2024 09:37

pointhex force-pushed the addToGetStyleDiagHandler branch from 3763408 to 6c8cc11 Compare June 13, 2024 13:00

owenca reviewed Jun 14, 2024

View reviewed changes

[clang-format] Add DiagHandler for getStyle function

c1e0ad6

It allows to control of error output for the function.

pointhex force-pushed the addToGetStyleDiagHandler branch from 6c8cc11 to c1e0ad6 Compare June 14, 2024 09:18

owenca added 2 commits June 14, 2024 21:24

Fix formatting errors.

d841187

Capitalize and reuse variables.

842bf9d

owenca changed the title ~~[clang-format] Add DiagHandler for getStyle function~~ [clang-format] Add DiagHandler parameter to format::getStyle() Jun 15, 2024

owenca approved these changes Jun 15, 2024

View reviewed changes

owenca merged commit fe9aef0 into llvm:main Jun 16, 2024
5 of 7 checks passed

jpienaar mentioned this pull request Jun 17, 2024

[mlirc] Add missing extern C #95829

Merged

		auto dropDiagnosticHandler = [](const llvm::SMDiagnostic &, void *) {};

[clang-format] Add DiagHandler parameter to format::getStyle() #91317

[clang-format] Add DiagHandler parameter to format::getStyle() #91317

Uh oh!

Conversation

pointhex commented May 7, 2024 • edited by owenca Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 7, 2024

Uh oh!

llvmbot commented May 7, 2024

Uh oh!

github-actions bot commented May 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mydeveloperday commented May 14, 2024

Uh oh!

pointhex commented May 14, 2024

Uh oh!

HazardyKnusperkeks commented May 21, 2024

Uh oh!

pointhex commented Jun 3, 2024

Uh oh!

mydeveloperday commented Jun 3, 2024

Uh oh!

pointhex commented Jun 3, 2024

Uh oh!

HazardyKnusperkeks left a comment

Choose a reason for hiding this comment

Uh oh!

mydeveloperday left a comment

Choose a reason for hiding this comment

Uh oh!

mydeveloperday commented Jun 3, 2024

Uh oh!

owenca left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pointhex commented Jun 4, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pointhex commented Jun 11, 2024

Uh oh!

owenca commented Jun 11, 2024

Uh oh!

pointhex commented Jun 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

owenca commented Jun 12, 2024

Uh oh!

pointhex commented Jun 13, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Jun 16, 2024

Uh oh!

pointhex commented Jun 16, 2024

Uh oh!

Uh oh!

pointhex commented May 7, 2024 •

edited by owenca

Loading

github-actions bot commented May 9, 2024 •

edited

Loading

pointhex commented Jun 11, 2024 •

edited

Loading