clang-tidy/portability/StdAllocatorConstCheck.cpp

//===----------------------------------------------------------------------===//
//
// 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::tidy::portability {

void StdAllocatorConstCheck::registerMatchers(MatchFinder *Finder) {
  // Match std::allocator<const T>.
  auto AllocatorConst = qualType(hasCanonicalType(
      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<const T> 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(
          anyOf(templateSpecializationTypeLoc(),
                qualifiedTypeLoc(
                    hasUnqualifiedLoc(templateSpecializationTypeLoc()))),
          loc(qualType(anyOf(
              recordType(hasDeclaration(classTemplateSpecializationDecl(
                  HasContainerName,
                  anyOf(
                      hasTemplateArgument(1, refersToType(AllocatorConst)),
                      hasTemplateArgument(2, refersToType(AllocatorConst)),
                      hasTemplateArgument(3, refersToType(AllocatorConst)))))),
              // Match std::vector<const dependent>
              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<TypeLoc>("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<const T> is a deprecated libc++ "
       "extension; remove const for compatibility with other standard "
       "libraries");
}

} // namespace clang::tidy::portability