1 //===--- EasilySwappableParametersCheck.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_EASILYSWAPPABLEPARAMETERSCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_EASILYSWAPPABLEPARAMETERSCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace bugprone {
17 
18 /// Finds function definitions where parameters of convertible types follow
19 /// each other directly, making call sites prone to calling the function with
20 /// swapped (or badly ordered) arguments.
21 ///
22 /// For the user-facing documentation see:
23 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/easily-swappable-parameters.html
24 class EasilySwappableParametersCheck : public ClangTidyCheck {
25 public:
26   EasilySwappableParametersCheck(StringRef Name, ClangTidyContext *Context);
27   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
28   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
29   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
30 
31   /// The minimum length of an adjacent swappable parameter range required for
32   /// a diagnostic.
33   const std::size_t MinimumLength;
34 
35   /// The parameter names (as written in the source text) to be ignored.
36   const std::vector<StringRef> IgnoredParameterNames;
37 
38   /// The parameter typename suffixes (as written in the source code) to be
39   /// ignored.
40   const std::vector<StringRef> IgnoredParameterTypeSuffixes;
41 
42   /// Whether to consider differently qualified versions of the same type
43   /// mixable.
44   const bool QualifiersMix;
45 
46   /// Whether to model implicit conversions "in full" (conditions apply)
47   /// during analysis and consider types that are implicitly convertible to
48   /// one another mixable.
49   const bool ModelImplicitConversions;
50 
51   /// If enabled, diagnostics for parameters that are used together in a
52   /// similar way are not emitted.
53   const bool SuppressParametersUsedTogether;
54 
55   /// The number of characters two parameter names might be dissimilar at
56   /// either end for the report about the parameters to be silenced.
57   /// E.g. the names "LHS" and "RHS" are 1-dissimilar suffixes of each other,
58   /// while "Text1" and "Text2" are 1-dissimilar prefixes of each other.
59   const std::size_t NamePrefixSuffixSilenceDissimilarityTreshold;
60 };
61 
62 } // namespace bugprone
63 } // namespace tidy
64 } // namespace clang
65 
66 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_EASILYSWAPPABLEPARAMETERSCHECK_H
67