blob: a1fade5277f009bef4e739754a5acbe5a8443803 [file] [log] [blame]
//===--- EasilySwappableParametersCheck.h - clang-tidy ----------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "../ClangTidyCheck.h"
namespace clang {
namespace tidy {
namespace bugprone {
/// Finds function definitions where parameters of convertible types follow
/// each other directly, making call sites prone to calling the function with
/// swapped (or badly ordered) arguments.
/// For the user-facing documentation see:
class EasilySwappableParametersCheck : public ClangTidyCheck {
EasilySwappableParametersCheck(StringRef Name, ClangTidyContext *Context);
void registerMatchers(ast_matchers::MatchFinder *Finder) override;
void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
/// The minimum length of an adjacent swappable parameter range required for
/// a diagnostic.
const std::size_t MinimumLength;
/// The parameter names (as written in the source text) to be ignored.
const std::vector<std::string> IgnoredParameterNames;
/// The parameter typename suffixes (as written in the source code) to be
/// ignored.
const std::vector<std::string> IgnoredParameterTypeSuffixes;
/// Whether to consider differently qualified versions of the same type
/// mixable.
const bool QualifiersMix;
/// Whether to model implicit conversions "in full" (conditions apply)
/// during analysis and consider types that are implicitly convertible to
/// one another mixable.
const bool ModelImplicitConversions;
/// If enabled, diagnostics for parameters that are used together in a
/// similar way are not emitted.
const bool SuppressParametersUsedTogether;
/// The number of characters two parameter names might be dissimilar at
/// either end for the report about the parameters to be silenced.
/// E.g. the names "LHS" and "RHS" are 1-dissimilar suffixes of each other,
/// while "Text1" and "Text2" are 1-dissimilar prefixes of each other.
const std::size_t NamePrefixSuffixSilenceDissimilarityTreshold;
} // namespace bugprone
} // namespace tidy
} // namespace clang