[clang-tidy] Add portability-std-allocator-const check
authorFangrui Song <i@maskray.me>
Thu, 14 Apr 2022 18:13:41 +0000 (11:13 -0700)
committerFangrui Song <i@maskray.me>
Thu, 14 Apr 2022 18:13:41 +0000 (11:13 -0700)
commitb9ca972b1ff0548a831fe416cec8d39f7e569c94
tree04071af68b1a64657557ff9e285b4548604b6ef9
parent78d70a1c976934587e6d4c5698c348b8f09d9d96
[clang-tidy] Add portability-std-allocator-const check

Report use of `std::vector<const T>` (and similar containers of const
elements). These are now allowed in standard C++ due to undefined
`std::allocator<const T>`. They do not compile with libstdc++ or MSVC.
Future libc++ will remove the extension (D120996).
See docs/clang-tidy/checks/portability-std-allocator-const.rst for detail.

I have attempted clean-up in a large code base. Here are some statistics:

* 98% are related to the container `std::vector`, among `deque/forward_list/list/multiset/queue/set/stack/vector`.
* 24% are related to `std::vector<const std::string>`.
* Both `std::vector<const absl::string_view>` and `std::vector<const int>` contribute 2%. The other contributors spread over various class types.

The check can be useful to other large code bases and may serve as an example
for future libc++ strictness improvement.

Note: on MSVC where -fdelayed-template-parsing is the default, the check cannot
catch cases in uninstantiated templates.

Reviewed By: sammccall

Differential Revision: https://reviews.llvm.org/D123655
clang-tools-extra/clang-tidy/portability/CMakeLists.txt
clang-tools-extra/clang-tidy/portability/PortabilityTidyModule.cpp
clang-tools-extra/clang-tidy/portability/StdAllocatorConstCheck.cpp [new file with mode: 0644]
clang-tools-extra/clang-tidy/portability/StdAllocatorConstCheck.h [new file with mode: 0644]
clang-tools-extra/docs/ReleaseNotes.rst
clang-tools-extra/docs/clang-tidy/checks/list.rst
clang-tools-extra/docs/clang-tidy/checks/portability-std-allocator-const.rst [new file with mode: 0644]
clang-tools-extra/test/clang-tidy/checkers/portability-std-allocator-const.cpp [new file with mode: 0644]