From dd47ab750b584a320bf61d58a3965a03f3871c1b Mon Sep 17 00:00:00 2001 From: Nico Weber Date: Thu, 14 Apr 2022 09:20:51 -0400 Subject: [PATCH] Revert "[clang-tidy] Add portability-std-allocator-const check" This reverts commit 73da7eed8fac84c9005518740f12d58389998d95. Breaks check-clang-tools on Windows, see comment on https://reviews.llvm.org/D123655 --- .../clang-tidy/portability/CMakeLists.txt | 1 - .../portability/PortabilityTidyModule.cpp | 3 - .../portability/StdAllocatorConstCheck.cpp | 71 -------------- .../portability/StdAllocatorConstCheck.h | 37 -------- clang-tools-extra/docs/ReleaseNotes.rst | 8 -- .../docs/clang-tidy/checks/list.rst | 1 - .../portability-std-allocator-const.rst | 31 ------ .../portability-std-allocator-const.cpp | 94 ------------------- 8 files changed, 246 deletions(-) delete mode 100644 clang-tools-extra/clang-tidy/portability/StdAllocatorConstCheck.cpp delete mode 100644 clang-tools-extra/clang-tidy/portability/StdAllocatorConstCheck.h delete mode 100644 clang-tools-extra/docs/clang-tidy/checks/portability-std-allocator-const.rst delete mode 100644 clang-tools-extra/test/clang-tidy/checkers/portability-std-allocator-const.cpp diff --git a/clang-tools-extra/clang-tidy/portability/CMakeLists.txt b/clang-tools-extra/clang-tidy/portability/CMakeLists.txt index 579e459bc72b..a0de5871e036 100644 --- a/clang-tools-extra/clang-tidy/portability/CMakeLists.txt +++ b/clang-tools-extra/clang-tidy/portability/CMakeLists.txt @@ -7,7 +7,6 @@ add_clang_library(clangTidyPortabilityModule PortabilityTidyModule.cpp RestrictSystemIncludesCheck.cpp SIMDIntrinsicsCheck.cpp - StdAllocatorConstCheck.cpp LINK_LIBS clangTidy diff --git a/clang-tools-extra/clang-tidy/portability/PortabilityTidyModule.cpp b/clang-tools-extra/clang-tidy/portability/PortabilityTidyModule.cpp index 1e4f1d5de1d9..c87a119aa81f 100644 --- a/clang-tools-extra/clang-tidy/portability/PortabilityTidyModule.cpp +++ b/clang-tools-extra/clang-tidy/portability/PortabilityTidyModule.cpp @@ -11,7 +11,6 @@ #include "../ClangTidyModuleRegistry.h" #include "RestrictSystemIncludesCheck.h" #include "SIMDIntrinsicsCheck.h" -#include "StdAllocatorConstCheck.h" namespace clang { namespace tidy { @@ -24,8 +23,6 @@ public: "portability-restrict-system-includes"); CheckFactories.registerCheck( "portability-simd-intrinsics"); - CheckFactories.registerCheck( - "portability-std-allocator-const"); } }; diff --git a/clang-tools-extra/clang-tidy/portability/StdAllocatorConstCheck.cpp b/clang-tools-extra/clang-tidy/portability/StdAllocatorConstCheck.cpp deleted file mode 100644 index a95048d71ef9..000000000000 --- a/clang-tools-extra/clang-tidy/portability/StdAllocatorConstCheck.cpp +++ /dev/null @@ -1,71 +0,0 @@ -//===-- StdAllocatorConstCheck.cpp - clang-tidy --------------------------===// -// -// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. -// See https://llvm.org/LICENSE.txt for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -// -//===----------------------------------------------------------------------===// - -#include "StdAllocatorConstCheck.h" -#include "clang/ASTMatchers/ASTMatchFinder.h" - -using namespace clang::ast_matchers; - -namespace clang { -namespace tidy { -namespace portability { - -void StdAllocatorConstCheck::registerMatchers(MatchFinder *Finder) { - // Match std::allocator. - auto allocatorConst = - recordType(hasDeclaration(classTemplateSpecializationDecl( - hasName("::std::allocator"), - hasTemplateArgument(0, refersToType(qualType(isConstQualified())))))); - - auto hasContainerName = - hasAnyName("::std::vector", "::std::deque", "::std::list", - "::std::multiset", "::std::set", "::std::unordered_multiset", - "::std::unordered_set", "::absl::flat_hash_set"); - - // Match `std::vector var;` and other common containers like deque, - // list, and absl::flat_hash_set. Containers like queue and stack use deque - // but do not directly use std::allocator as a template argument, so they - // aren't caught. - Finder->addMatcher( - typeLoc( - templateSpecializationTypeLoc(), - loc(hasUnqualifiedDesugaredType(anyOf( - recordType(hasDeclaration(classTemplateSpecializationDecl( - hasContainerName, - anyOf( - hasTemplateArgument(1, refersToType(allocatorConst)), - hasTemplateArgument(2, refersToType(allocatorConst)), - hasTemplateArgument(3, refersToType(allocatorConst)))))), - // Match std::vector - templateSpecializationType( - templateArgumentCountIs(1), - hasTemplateArgument( - 0, refersToType(qualType(isConstQualified()))), - hasDeclaration(namedDecl(hasContainerName))))))) - .bind("type_loc"), - this); -} - -void StdAllocatorConstCheck::check(const MatchFinder::MatchResult &Result) { - const auto *T = Result.Nodes.getNodeAs("type_loc"); - if (!T) - return; - // Exclude TypeLoc matches in STL headers. - if (isSystem(Result.Context->getSourceManager().getFileCharacteristic( - T->getBeginLoc()))) - return; - - diag(T->getBeginLoc(), - "container using std::allocator is a deprecated libc++ " - "extension; remove const for compatibility with other standard " - "libraries"); -} - -} // namespace portability -} // namespace tidy -} // namespace clang diff --git a/clang-tools-extra/clang-tidy/portability/StdAllocatorConstCheck.h b/clang-tools-extra/clang-tidy/portability/StdAllocatorConstCheck.h deleted file mode 100644 index 98a7b473e17e..000000000000 --- a/clang-tools-extra/clang-tidy/portability/StdAllocatorConstCheck.h +++ /dev/null @@ -1,37 +0,0 @@ -//===--- StdAllocatorConstT.h - clang-tidy -----------------------*- C++-*-===// -// -// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. -// See https://llvm.org/LICENSE.txt for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -// -//===----------------------------------------------------------------------===// - -#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PORTABILITY_STDALLOCATORCONSTCHECK_H -#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PORTABILITY_STDALLOCATORCONSTCHECK_H - -#include "../ClangTidyCheck.h" - -namespace clang { -namespace tidy { -namespace portability { - -/// Report use of ``std::vector`` (and similar containers of const -/// elements). These are not allowed in standard C++ due to undefined -/// ``std::allocator``. They do not compile with libstdc++ or MSVC. -/// -/// For the user-facing documentation see: -/// http://clang.llvm.org/extra/clang-tidy/checks/portability-std-allocator-const.html -class StdAllocatorConstCheck : public ClangTidyCheck { -public: - StdAllocatorConstCheck(StringRef Name, ClangTidyContext *Context) - : ClangTidyCheck(Name, Context) {} - - void registerMatchers(ast_matchers::MatchFinder *Finder) override; - void check(const ast_matchers::MatchFinder::MatchResult &Result) override; -}; - -} // namespace portability -} // namespace tidy -} // namespace clang - -#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PORTABILITY_STDALLOCATORCONSTCHECK_H diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst index 5392ab5758f5..870a043c6b81 100644 --- a/clang-tools-extra/docs/ReleaseNotes.rst +++ b/clang-tools-extra/docs/ReleaseNotes.rst @@ -117,14 +117,6 @@ New checks Replaces groups of adjacent macros with an unscoped anonymous enum. -- New :doc:`portability-std-allocator-const ` check. - - Report use of ``std::vector`` (and similar containers of const - elements). These are not allowed in standard C++ due to undefined - ``std::allocator``. They do not compile with libstdc++ or MSVC. - Future libc++ will remove the extension (`D120996 - `). - New check aliases ^^^^^^^^^^^^^^^^^ diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst index 6b3a6d83a361..e9367216ac51 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/list.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst @@ -289,7 +289,6 @@ Clang-Tidy Checks `performance-unnecessary-value-param `_, "Yes" `portability-restrict-system-includes `_, "Yes" `portability-simd-intrinsics `_, - `portability-std-allocator-const `_, `readability-avoid-const-params-in-decls `_, "Yes" `readability-braces-around-statements `_, "Yes" `readability-const-return-type `_, "Yes" diff --git a/clang-tools-extra/docs/clang-tidy/checks/portability-std-allocator-const.rst b/clang-tools-extra/docs/clang-tidy/checks/portability-std-allocator-const.rst deleted file mode 100644 index 31463c2b65dd..000000000000 --- a/clang-tools-extra/docs/clang-tidy/checks/portability-std-allocator-const.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. title:: clang-tidy - portability-std-allocator-const - -portability-std-allocator-const -=============================== - -Report use of ``std::vector`` (and similar containers of const -elements). These are not allowed in standard C++, and should usually be -``std::vector`` instead." - -Per C++ ``[allocator.requirements.general]``: "T is any cv-unqualified object -type", ``std::allocator`` is undefined. Many standard containers use -``std::allocator`` by default and therefore their ``const T`` instantiations are -undefined. - -libc++ defines ``std::allocator`` as an extension which will be removed -in the future. - -libstdc++ and MSVC do not support ``std::allocator``: - -.. code:: c++ - - // libstdc++ has a better diagnostic since https://gcc.gnu.org/bugzilla/show_bug.cgi?id=48101 - std::deque deque; // error: static assertion failed: std::deque must have a non-const, non-volatile value_type - std::set set; // error: static assertion failed: std::set must have a non-const, non-volatile value_type - std::vector vector; // error: static assertion failed: std::vector must have a non-const, non-volatile value_type - - // MSVC - // error C2338: static_assert failed: 'The C++ Standard forbids containers of const elements because allocator is ill-formed.' - -Code bases only compiled with libc++ may accrue such undefined usage. This -check finds such code and prevents backsliding while clean-up is ongoing. diff --git a/clang-tools-extra/test/clang-tidy/checkers/portability-std-allocator-const.cpp b/clang-tools-extra/test/clang-tidy/checkers/portability-std-allocator-const.cpp deleted file mode 100644 index e6155592f33b..000000000000 --- a/clang-tools-extra/test/clang-tidy/checkers/portability-std-allocator-const.cpp +++ /dev/null @@ -1,94 +0,0 @@ -// RUN: %check_clang_tidy -std=c++11-or-later %s portability-std-allocator-const %t -- - -namespace std { -typedef unsigned size_t; - -template -class allocator {}; -template -class hash {}; -template -class equal_to {}; -template -class less {}; - -template > -class deque {}; -template > -class forward_list {}; -template > -class list {}; -template > -class vector {}; - -template , class A = std::allocator> -class multiset {}; -template , class A = std::allocator> -class set {}; -template , class Eq = std::equal_to, class A = std::allocator> -class unordered_multiset {}; -template , class Eq = std::equal_to, class A = std::allocator> -class unordered_set {}; - -template > -class stack {}; -} // namespace std - -namespace absl { -template , class Eq = std::equal_to, class A = std::allocator> -class flat_hash_set {}; -} // namespace absl - -template -class allocator {}; - -void simple(const std::vector &v, std::deque *d) { - // CHECK-MESSAGES: [[#@LINE-1]]:24: warning: container using std::allocator is a deprecated libc++ extension; remove const for compatibility with other standard libraries - // CHECK-MESSAGES: [[#@LINE-2]]:52: warning: container - std::list l; - // CHECK-MESSAGES: [[#@LINE-1]]:8: warning: container - - std::multiset ms; - // CHECK-MESSAGES: [[#@LINE-1]]:8: warning: container - std::set> s; - // CHECK-MESSAGES: [[#@LINE-1]]:8: warning: container - std::unordered_multiset ums; - // CHECK-MESSAGES: [[#@LINE-1]]:8: warning: container - std::unordered_set us; - // CHECK-MESSAGES: [[#@LINE-1]]:8: warning: container - - absl::flat_hash_set fhs; - // CHECK-MESSAGES: [[#@LINE-1]]:9: warning: container - - using my_vector = std::vector; - // CHECK-MESSAGES: [[#@LINE-1]]:26: warning: container - my_vector v1; - using my_vector2 = my_vector; - - std::vector neg1; - std::vector neg2; // not const T - std::vector> neg3; // not use std::allocator - std::allocator a; // not caught, but rare - std::forward_list forward; // not caught, but rare - std::stack stack; // not caught, but rare -} - -template -void temp1() { - std::vector v; - // CHECK-MESSAGES: [[#@LINE-1]]:8: warning: container - - std::vector neg1; - std::forward_list neg2; -} -void use_temp1() { temp1(); } - -template -void temp2() { - // Match std::vector for the uninstantiated temp2. - std::vector v; - // CHECK-MESSAGES: [[#@LINE-1]]:8: warning: container - - std::vector neg1; - std::forward_list neg2; -}