DeprecatedIosBaseAliasesCheck.cpp

Go to the documentation of this file.

//===----------------------------------------------------------------------===//
//
// 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 "DeprecatedIosBaseAliasesCheck.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include <optional>
 
using namespace clang::ast_matchers;
 
namespace clang::tidy::modernize {
 
static constexpr std::array<StringRef, 5> DeprecatedTypes = {
    "::std::ios_base::io_state", "::std::ios_base::open_mode",
    "::std::ios_base::seek_dir", "::std::ios_base::streamoff",
    "::std::ios_base::streampos"};
 
static std::optional<const char *> getReplacementType(StringRef Type) {
  return llvm::StringSwitch<std::optional<const char *>>(Type)
      .Case("io_state", "iostate")
      .Case("open_mode", "openmode")
      .Case("seek_dir", "seekdir")
      .Default(std::nullopt);
}
 
void DeprecatedIosBaseAliasesCheck::registerMatchers(MatchFinder *Finder) {
  const auto IoStateDecl =
      typedefDecl(hasAnyName(DeprecatedTypes)).bind("TypeDecl");
  const auto IoStateType = typedefType(hasDeclaration(IoStateDecl));
 
  Finder->addMatcher(typeLoc(loc(IoStateType)).bind("TypeLoc"), this);
}
 
void DeprecatedIosBaseAliasesCheck::check(
    const MatchFinder::MatchResult &Result) {
  const SourceManager &SM = *Result.SourceManager;
 
  const auto *Typedef = Result.Nodes.getNodeAs<TypedefDecl>("TypeDecl");
  const StringRef TypeName = Typedef->getName();
  auto Replacement = getReplacementType(TypeName);
 
  TypeLoc TL = *Result.Nodes.getNodeAs<TypeLoc>("TypeLoc");
  if (const auto QTL = TL.getAs<QualifiedTypeLoc>())
    TL = QTL.getUnqualifiedLoc();
 
  SourceLocation IoStateLoc = TL.castAs<TypedefTypeLoc>().getNameLoc();
  // Do not generate fixits for matches depending on template arguments and
  // macro expansions.
  bool Fix = Replacement && !TL.getType()->isDependentType();
  if (IoStateLoc.isMacroID()) {
    IoStateLoc = SM.getSpellingLoc(IoStateLoc);
    Fix = false;
  }
 
  const SourceLocation EndLoc =
      IoStateLoc.getLocWithOffset(TypeName.size() - 1);
 
  if (Replacement) {
    const char *FixName = *Replacement;
    const auto Builder =
        diag(IoStateLoc, "'std::ios_base::%0' is deprecated; use "
                         "'std::ios_base::%1' instead")
        << TypeName << FixName;
 
    if (Fix)
      Builder << FixItHint::CreateReplacement(SourceRange(IoStateLoc, EndLoc),
                                              FixName);
  } else {
    diag(IoStateLoc, "'std::ios_base::%0' is deprecated") << TypeName;
  }
}
 
} // namespace clang::tidy::modernize