d7a17540f8
Added `.clang-tidy` config as discussed in [RFC](https://discourse.llvm.org/t/rfc-create-hardened-clang-tidy-config-for-clang-tidy-directory/87247). Added `bugprone`, `readability`, `modernize`, `performance` checks that didn't create many warnings. Fixed minor warnings to make `/clang-tidy` directory complaint with `clang-tidy-20`. Disabled checks will be enabled in future PRs after fixing their warnings.
96 lines
3.6 KiB
C++
96 lines
3.6 KiB
C++
//===--- UseRangesCheck.h - clang-tidy --------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_UTILS_USERANGESCHECK_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_UTILS_USERANGESCHECK_H
|
|
|
|
#include "../ClangTidyCheck.h"
|
|
#include "IncludeInserter.h"
|
|
#include "clang/AST/Decl.h"
|
|
#include "clang/AST/Expr.h"
|
|
#include "clang/Basic/Diagnostic.h"
|
|
#include "llvm/ADT/IntrusiveRefCntPtr.h"
|
|
#include "llvm/ADT/StringMap.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include <optional>
|
|
|
|
namespace clang::tidy::utils {
|
|
|
|
/// Base class for handling converting std iterator algorithms to a range
|
|
/// equivalent.
|
|
class UseRangesCheck : public ClangTidyCheck {
|
|
public:
|
|
struct Indexes {
|
|
enum Replace { First, Second };
|
|
unsigned BeginArg;
|
|
unsigned EndArg = BeginArg + 1;
|
|
Replace ReplaceArg = First;
|
|
};
|
|
|
|
using Signature = SmallVector<Indexes, 2>;
|
|
|
|
struct ReverseIteratorDescriptor {
|
|
StringRef ReverseAdaptorName;
|
|
std::optional<StringRef> ReverseHeader;
|
|
ArrayRef<std::pair<StringRef, StringRef>> FreeReverseNames;
|
|
bool IsPipeSyntax = false;
|
|
};
|
|
|
|
class Replacer : public llvm::RefCountedBase<Replacer> {
|
|
public:
|
|
/// Gets the name to replace a function with, return std::nullopt for a
|
|
/// replacement where we just call a different overload.
|
|
virtual std::optional<std::string>
|
|
getReplaceName(const NamedDecl &OriginalName) const = 0;
|
|
|
|
/// Gets the header needed to access the replaced function
|
|
/// Return std::nullopt if no new header is needed.
|
|
virtual std::optional<std::string>
|
|
getHeaderInclusion(const NamedDecl &OriginalName) const;
|
|
|
|
/// Gets an array of all the possible overloads for a function with indexes
|
|
/// where begin and end arguments are.
|
|
virtual ArrayRef<Signature> getReplacementSignatures() const = 0;
|
|
virtual ~Replacer() = default;
|
|
};
|
|
|
|
using ReplacerMap = llvm::StringMap<llvm::IntrusiveRefCntPtr<Replacer>>;
|
|
|
|
UseRangesCheck(StringRef Name, ClangTidyContext *Context);
|
|
/// Gets a map of function to replace and methods to create the replacements
|
|
virtual ReplacerMap getReplacerMap() const = 0;
|
|
/// Create a diagnostic for the CallExpr
|
|
/// Override this to support custom diagnostic messages
|
|
virtual DiagnosticBuilder createDiag(const CallExpr &Call);
|
|
|
|
virtual std::optional<ReverseIteratorDescriptor> getReverseDescriptor() const;
|
|
|
|
/// Gets the fully qualified names of begin and end functions.
|
|
/// The functions must take the container as their one and only argument
|
|
/// `::std::begin` and `::std::end` are a common example
|
|
virtual ArrayRef<std::pair<StringRef, StringRef>>
|
|
getFreeBeginEndMethods() const;
|
|
|
|
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
|
|
Preprocessor *ModuleExpanderPP) final;
|
|
void registerMatchers(ast_matchers::MatchFinder *Finder) final;
|
|
void check(const ast_matchers::MatchFinder::MatchResult &Result) final;
|
|
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override;
|
|
void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
|
|
std::optional<TraversalKind> getCheckTraversalKind() const override;
|
|
|
|
private:
|
|
std::vector<llvm::IntrusiveRefCntPtr<Replacer>> Replacers;
|
|
std::optional<ReverseIteratorDescriptor> ReverseDescriptor;
|
|
IncludeInserter Inserter;
|
|
};
|
|
|
|
} // namespace clang::tidy::utils
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_UTILS_USERANGESCHECK_H
|