clang-tools-extra/clang-tidy/bugprone/SignedCharMisuseCheck.h

   1 //===--- SignedCharMisuseCheck.h - clang-tidy -------------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SIGNEDCHARMISUSECHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SIGNEDCHARMISUSECHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::bugprone {
  15
  16 /// Finds those ``signed char`` -> integer conversions which might indicate a
  17 /// programming error. The basic problem with the ``signed char``, that it might
  18 /// store the non-ASCII characters as negative values. This behavior can cause a
  19 /// misunderstanding of the written code both when an explicit and when an
  20 /// implicit conversion happens.
  21 ///
  22 /// For the user-facing documentation see:
  23 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/signed-char-misuse.html
  24 class SignedCharMisuseCheck : public ClangTidyCheck {
  25 public:
  26   SignedCharMisuseCheck(StringRef Name, ClangTidyContext *Context);
  27
  28   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  29   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  30   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  31
  32 private:
  33   ast_matchers::internal::BindableMatcher<clang::Stmt> charCastExpression(
  34       bool IsSigned,
  35       const ast_matchers::internal::Matcher<clang::QualType> &IntegerType,
  36       const std::string &CastBindName) const;
  37
  38   const StringRef CharTypdefsToIgnoreList;
  39   const bool DiagnoseSignedUnsignedCharComparisons;
  40 };
  41
  42 } // namespace clang::tidy::bugprone
  43
  44 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SIGNEDCHARMISUSECHECK_H