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

   1 //===--- UnusedLocalNonTrivialVariableCheck.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_UNUSEDLOCALNONTRIVIALVARIABLECHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNUSEDLOCALNONTRIVIALVARIABLECHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::bugprone {
  15
  16 /// Warns when a local non trivial variable is unused within a function. By
  17 /// default std::.*mutex and std::future are included.
  18 ///
  19 /// The check supports these options:
  20 ///   - 'IncludeTypes': a semicolon-separated list of regular expressions
  21 ///                     matching types to ensure must be used.
  22 ///   - 'ExcludeTypes': a semicolon-separated list of regular expressions
  23 ///                     matching types that are excluded from the
  24 ///                     'IncludeTypes' matches.
  25 ///
  26 /// For the user-facing documentation see:
  27 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/unused-local-non-trivial-variable.html
  28 class UnusedLocalNonTrivialVariableCheck : public ClangTidyCheck {
  29 public:
  30   UnusedLocalNonTrivialVariableCheck(StringRef Name, ClangTidyContext *Context);
  31   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  32   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  33   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  34   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override;
  35   std::optional<TraversalKind> getCheckTraversalKind() const override;
  36
  37 private:
  38   const std::vector<StringRef> IncludeTypes;
  39   const std::vector<StringRef> ExcludeTypes;
  40 };
  41
  42 } // namespace clang::tidy::bugprone
  43
  44 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNUSEDLOCALNONTRIVIALVARIABLECHECK_H