[clang-tidy] misc-include-cleaner suggests the wrong header for std::ranges::upper_bound

[yalavrinenko]

For the following example

#include <algorithm>

struct Foo {
  int value;
  double bar() const { return value * 2; }
};

int main() {
  std::vector<Foo> v;
  const double to_find = 10;
  std::ranges::upper_bound(v, to_find, std::less{}, &Foo::bar);

  return 0;
}

misc-include-cleaner emits errors

*/sandbox.cpp:57:16: error: no header providing "std::ranges::binary_search" is directly included [misc-include-cleaner,-warnings-as-errors]
   33 |   std::ranges::binary_search(v, to_find, std::less{}, &Foo::bar);

as well as

sandbox.cpp:35:1: error: included header algorithm is not used directly [misc-include-cleaner,-warnings-as-errors]

The suggested fix is #include <bits/ranges_algo.h> that seems incorrect.

The same function std::ranges::sort from this header (<bits/ranges_algo.h>) is handled perfectly.

[llvmbot]

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

Author: None (yalavrinenko)

For the following example ```c++ #include <algorithm>

struct Foo {
int value;
double bar() const { return value * 2; }
};

int main() {
std::vector<Foo> v;
const double to_find = 10;
std::ranges::upper_bound(v, to_find, std::less{}, &Foo::bar);

return 0;
}

`misc-include-cleaner` emits errors

*/sandbox.cpp:57:16: error: no header providing "std::ranges::binary_search" is directly included [misc-include-cleaner,-warnings-as-errors]
33 | std::ranges::binary_search(v, to_find, std::less{}, &Foo::bar);

as well as

sandbox.cpp:35:1: error: included header algorithm is not used directly [misc-include-cleaner,-warnings-as-errors]

The suggested fix is `#include <bits/ranges_algo.h>` that seems incorrect.

The same function `std::ranges::sort` from this header (`<bits/ranges_algo.h>`) is handled perfectly. 
</details>

[srpgilles]

I got a very similar one:

warning: no header providing "std::ranges::binary_search" is directly included [misc-include-cleaner]

in a file where there is already a include <algorithm> which is the right choice according to CppReference.

The only difference with OP is that I get no suggested fix.

[kadircet]

FWIW, https://github.com/llvm/llvm-project/blob/main/clang/lib/Tooling/Inclusions/Stdlib/StdSpecialSymbolMap.inc and https://github.com/llvm/llvm-project/blob/main/clang/lib/Tooling/Inclusions/Stdlib/StdSymbolMap.inc are the mappings used by clang-tooling for figuring out the relationship between a STL symbol and its provider headers.

It's generated by parsing cppreference through https://github.com/llvm/llvm-project/blob/main/clang/tools/include-mapping/gen_std.py and some hand curation on top. In case anyone wants to tackle such issues

[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: None (yalavrinenko)

For the following example ```c++ #include <algorithm>

struct Foo {
int value;
double bar() const { return value * 2; }
};

int main() {
std::vector<Foo> v;
const double to_find = 10;
std::ranges::upper_bound(v, to_find, std::less{}, &Foo::bar);

return 0;
}

`misc-include-cleaner` emits errors

*/sandbox.cpp:57:16: error: no header providing "std::ranges::binary_search" is directly included [misc-include-cleaner,-warnings-as-errors]
33 | std::ranges::binary_search(v, to_find, std::less{}, &Foo::bar);

as well as

sandbox.cpp:35:1: error: included header algorithm is not used directly [misc-include-cleaner,-warnings-as-errors]

The suggested fix is `#include <bits/ranges_algo.h>` that seems incorrect.

The same function `std::ranges::sort` from this header (`<bits/ranges_algo.h>`) is handled perfectly. 
</details>