EasilySwappableParametersCheck.cpp File Reference

#include "EasilySwappableParametersCheck.h"
#include "../utils/OptionsUtils.h"
#include "clang/AST/ASTContext.h"
#include "clang/AST/RecursiveASTVisitor.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/Lex/Lexer.h"
#include "llvm/ADT/SmallSet.h"
#include "llvm/Support/Debug.h"
#include <optional>

Go to the source code of this file.

Classes
class	clang::tidy::bugprone::filter::SimilarlyUsedParameterPairSuppressor
	Helper class that is used to detect if two parameters of the same function are used in a similar fashion, to suppress the result. More...

Namespaces
namespace	clang
	===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
namespace	clang::tidy
namespace	clang::tidy::bugprone
namespace	clang::tidy::bugprone::filter
namespace	clang::tidy::bugprone::model
namespace	clang::tidy::bugprone::filter::relatedness_heuristic
	This namespace contains the implementations for the suppression of diagnostics from similarly-used ("related") parameters.

Macros
#define	DEBUG_TYPE   "EasilySwappableParametersCheck"

Typedefs
using	clang::tidy::bugprone::TheCheck = EasilySwappableParametersCheck
template<typename T, std::size_t N = SmallDataStructureSize>
using	clang::tidy::bugprone::filter::relatedness_heuristic::ParamToSmallSetMap
template<typename T, std::size_t N = SmallDataStructureSize>
using	clang::tidy::bugprone::filter::relatedness_heuristic::ParamToSmallPtrSetMap

Functions
static bool	clang::tidy::bugprone::filter::isIgnoredParameter (const TheCheck &Check, const ParmVarDecl *Node)
	Returns whether the parameter's name or the parameter's type's name is configured by the user to be ignored from analysis and diagnostic.
static bool	clang::tidy::bugprone::filter::isSimilarlyUsedParameter (const SimilarlyUsedParameterPairSuppressor &Suppressor, const ParmVarDecl *Param1, const ParmVarDecl *Param2)
static bool	clang::tidy::bugprone::filter::prefixSuffixCoverUnderThreshold (std::size_t Threshold, StringRef Str1, StringRef Str2)
	Returns whether the two strings are prefixes or suffixes of each other with at most Threshold characters differing on the non-common end.
	clang::tidy::bugprone::model::LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE ()
static bool	clang::tidy::bugprone::model::hasFlag (MixFlags Data, MixFlags SearchedFlag)
	Returns whether the SearchedFlag is turned on in the Data.
static std::string	clang::tidy::bugprone::model::formatMixFlags (MixFlags F)
	Formats the MixFlags enum into a useful, user-readable representation.
static MixData	clang::tidy::bugprone::model::isLRefEquallyBindingToType (const TheCheck &Check, const LValueReferenceType *LRef, QualType Ty, const ASTContext &Ctx, bool IsRefRHS, ImplicitConversionModellingMode ImplicitMode)
	Calculates if the reference binds an expression of the given type.
static MixData	clang::tidy::bugprone::model::approximateImplicitConversion (const TheCheck &Check, QualType LType, QualType RType, const ASTContext &Ctx, ImplicitConversionModellingMode ImplicitMode)
	Returns whether an expression of LType can be used in an RType context, as per the implicit conversion rules.
static bool	clang::tidy::bugprone::model::isUselessSugar (const Type *T)
static NonCVRQualifiersResult	clang::tidy::bugprone::model::getNonCVRQualifiers (const ASTContext &Ctx, QualType LType, QualType RType)
	Returns if the two types are qualified in a way that ever after equating or removing local CVR qualification, even if the unqualified types would mix, the qualified ones don't, because there are some other local qualifiers that aren't equal.
static MixData	clang::tidy::bugprone::model::calculateMixability (const TheCheck &Check, QualType LType, QualType RType, const ASTContext &Ctx, ImplicitConversionModellingMode ImplicitMode)
	Approximate the way how LType and RType might refer to "essentially the same" type, in a sense that at a particular call site, an expression of type LType and RType might be successfully passed to a variable (in our specific case, a parameter) of type RType and LType, respectively.
static bool	clang::tidy::bugprone::model::isDerivedToBase (const CXXRecordDecl *Derived, const CXXRecordDecl *Base)
static std::optional< QualType >	clang::tidy::bugprone::model::approximateStandardConversionSequence (const TheCheck &Check, QualType From, QualType To, const ASTContext &Ctx)
static std::optional< ConversionSequence >	clang::tidy::bugprone::model::tryConversionOperators (const TheCheck &Check, const CXXRecordDecl *RD, QualType ToType)
static std::optional< ConversionSequence >	clang::tidy::bugprone::model::tryConvertingConstructors (const TheCheck &Check, QualType FromType, const CXXRecordDecl *RD)
static MixableParameterRange	clang::tidy::bugprone::model::modelMixingRange (const TheCheck &Check, const FunctionDecl *FD, std::size_t StartIndex, const filter::SimilarlyUsedParameterPairSuppressor &UsageBasedSuppressor)
template<typename MapTy, typename ElemTy>
static bool	clang::tidy::bugprone::filter::relatedness_heuristic::lazyMapOfSetsIntersectionExists (const MapTy &Map, const ElemTy &E1, const ElemTy &E2)
	Returns whether the sets mapped to the two elements in the map have at least one element in common.
static void	clang::tidy::bugprone::filter::padStringAtEnd (SmallVectorImpl< char > &Str, std::size_t ToLen)
static void	clang::tidy::bugprone::filter::padStringAtBegin (SmallVectorImpl< char > &Str, std::size_t ToLen)
static bool	clang::tidy::bugprone::filter::isCommonPrefixWithoutSomeCharacters (std::size_t N, StringRef S1, StringRef S2)
static bool	clang::tidy::bugprone::filter::isCommonSuffixWithoutSomeCharacters (std::size_t N, StringRef S1, StringRef S2)
static unsigned	clang::tidy::bugprone::clampMinimumLength (const unsigned Value)
	Returns the DefaultMinimumLength if the Value of requested minimum length is less than 2.
static SmallString< 64 >	clang::tidy::bugprone::getName (const NamedDecl *ND)
	Returns the diagnostic-friendly name of the node, or empty string.
static SmallString< 64 >	clang::tidy::bugprone::getNameOrUnnamed (const NamedDecl *ND)
	Returns the diagnostic-friendly name of the node, or a constant value.
static bool	clang::tidy::bugprone::needsToPrintTypeInDiagnostic (const model::Mix &M)
	Returns whether a particular Mix between two parameters should have the types involved diagnosed to the user.
static bool	clang::tidy::bugprone::needsToElaborateImplicitConversion (const model::Mix &M)
	Returns whether a particular Mix between the two parameters should have implicit conversions elaborated.

Variables
static constexpr std::size_t	clang::tidy::bugprone::DefaultMinimumLength = 2
	The default value for the MinimumLength check option.
static constexpr StringRef	clang::tidy::bugprone::DefaultIgnoredParameterNames
	The default value for ignored parameter names.
static constexpr StringRef	clang::tidy::bugprone::DefaultIgnoredParameterTypeSuffixes
	The default value for ignored parameter type suffixes.
static constexpr bool	clang::tidy::bugprone::DefaultQualifiersMix = false
	The default value for the QualifiersMix check option.
static constexpr bool	clang::tidy::bugprone::DefaultModelImplicitConversions = true
	The default value for the ModelImplicitConversions check option.
static constexpr bool	clang::tidy::bugprone::DefaultSuppressParametersUsedTogether = true
	The default value for suppressing diagnostics about parameters that are used together.
static constexpr std::size_t	clang::tidy::bugprone::DefaultNamePrefixSuffixSilenceDissimilarityTreshold = 1
	The default value for the NamePrefixSuffixSilenceDissimilarityThreshold check option.
static constexpr std::size_t	clang::tidy::bugprone::filter::relatedness_heuristic::SmallDataStructureSize = 4

Macro Definition Documentation

DEBUG_TYPE

#define DEBUG_TYPE   "EasilySwappableParametersCheck"

Definition at line 17 of file EasilySwappableParametersCheck.cpp.