clang-include-cleaner - replaces chrono with bits/chrono

[PiotrZSL]

Issues found:

a)

+#include <bits/basic_string.h>
+#include <string>

b)

-#include <chrono>
+#include <bits/chrono.h>

Tested version from LLVM 17.0.2

misc-include-cleaner provide more information:

160   - DiagnosticName:  misc-include-cleaner
161     DiagnosticMessage:
162       Message:         'no header providing "std::operator""s" is directly included'
163       FilePath:        'some-file.cpp'
164       FileOffset:      982
165       Replacements:
166         - FilePath:        'some-file.cpp'
167           Offset:          52
168           Length:          0
169           ReplacementText: "#include <bits/basic_string.h>\n"

And:

304   - DiagnosticName:  misc-include-cleaner
305     DiagnosticMessage:
306       Message:         'no header providing "std::chrono::ceil" is directly included'
307       FilePath:        'some-file.cpp'
308       FileOffset:      3133
309       Replacements:
310         - FilePath:        'some-file.cpp'
311           Offset:          43
312           Length:          0
313           ReplacementText: "#include <bits/chrono.h>\n"

When <chrono> is already included.

[llvmbot]

@llvm/issue-subscribers-clang-include-cleaner

Issues found:

a)

+#include <bits/basic_string.h>
+#include <string>

b)

-#include <chrono>
+#include <bits/chrono.h>

Tested version from LLVM 17.0.2

misc-include-cleaner provide more information:

160   - DiagnosticName:  misc-include-cleaner
161     DiagnosticMessage:
162       Message:         'no header providing "std::operator""s" is directly included'
163       FilePath:        'some-file.cpp'
164       FileOffset:      982
165       Replacements:
166         - FilePath:        'some-file.cpp'
167           Offset:          52
168           Length:          0
169           ReplacementText: "#include <bits/basic_string.h>\n"

And:

304   - DiagnosticName:  misc-include-cleaner
305     DiagnosticMessage:
306       Message:         'no header providing "std::chrono::ceil" is directly included'
307       FilePath:        'some-file.cpp'
308       FileOffset:      3133
309       Replacements:
310         - FilePath:        'some-file.cpp'
311           Offset:          43
312           Length:          0
313           ReplacementText: "#include <bits/chrono.h>\n"

When <chrono> is already included.

[ZedThree]

I've just bumped into this with std::string_literals::operator""s, I get a warning that

no header providing "std::operator""s" is directly included

which can only be silenced by including bits/basic_string.h. It would be nice to teach misc-include-cleaner about these implementation details.

Here's a minimal reproducer on Compiler Explorer:

https://godbolt.org/z/r9Tzrs4nx

[kaimast]

I've just bumped into this with std::string_literals::operator""s, I get a warning that

I still see this error a year later.

[andrea-cassioli-maersk]

same issue here, quite annoying

[kadircet]

the one for std::chrono::ceil should be fixed with c0ce44e.

the one with UDLs is because we don't have support for that in stdlib-recognizer in https://github.com/llvm/llvm-project/blob/main/clang/lib/Tooling/Inclusions/Stdlib/StandardLibrary.cpp#L276. i think this is something that we can improve, if anyone is willing to contribute some patches

[llvmbot]

Hi!

This issue may be a good introductory issue for people new to working on LLVM. If you would like to work on this issue, your first steps are:

1. Check that no other contributor has already been assigned to this issue. If you believe that no one is actually working on it despite an assignment, ping the person. After one week without a response, the assignee may be changed.
2. In the comments of this issue, request for it to be assigned to you, or just create a pull request after following the steps below. Mention this issue in the description of the pull request.
3. Fix the issue locally.
4. Run the test suite locally. Remember that the subdirectories under test/ create fine-grained testing targets, so you can e.g. use make check-clang-ast to only run Clang's AST tests.
5. Create a Git commit.
6. Run git clang-format HEAD~1 to format your changes.
7. Open a pull request to the upstream repository on GitHub. Detailed instructions can be found in GitHub's documentation. Mention this issue in the description of the pull request.

If you have any further questions about this issue, don't hesitate to ask via a comment in the thread below.

[llvmbot]

@llvm/issue-subscribers-good-first-issue

Author: Piotr Zegar (PiotrZSL)

Issues found:

a)

+#include <bits/basic_string.h>
+#include <string>

b)

-#include <chrono>
+#include <bits/chrono.h>

Tested version from LLVM 17.0.2

misc-include-cleaner provide more information:

160   - DiagnosticName:  misc-include-cleaner
161     DiagnosticMessage:
162       Message:         'no header providing "std::operator""s" is directly included'
163       FilePath:        'some-file.cpp'
164       FileOffset:      982
165       Replacements:
166         - FilePath:        'some-file.cpp'
167           Offset:          52
168           Length:          0
169           ReplacementText: "#include <bits/basic_string.h>\n"

And:

304   - DiagnosticName:  misc-include-cleaner
305     DiagnosticMessage:
306       Message:         'no header providing "std::chrono::ceil" is directly included'
307       FilePath:        'some-file.cpp'
308       FileOffset:      3133
309       Replacements:
310         - FilePath:        'some-file.cpp'
311           Offset:          43
312           Length:          0
313           ReplacementText: "#include <bits/chrono.h>\n"

When <chrono> is already included.

[andrea-cassioli-maersk]

@kadircet unfortunately I would not know where to start to contribute to the code...

[LindaSummer]

Hi @kadircet ,

I'm a newbie of llvm and want to make some contribution.

Could it be assigned to me? I'll try my best to fix it. 😊

Best Regards,
Edward