57 lines · c
1//===----------------------------------------------------------------------===//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-exception6//7//===----------------------------------------------------------------------===//8 9#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PROBOUNDSAVOIDUNCHECKEDCONTAINERACCESSCHECK_H10#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PROBOUNDSAVOIDUNCHECKEDCONTAINERACCESSCHECK_H11 12#include "../ClangTidyCheck.h"13 14namespace clang::tidy::cppcoreguidelines {15 16/// Flags calls to operator[] in STL containers and suggests replacing it with17/// safe alternatives.18///19/// See20/// https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#slcon3-avoid-bounds-errors21/// For the user-facing documentation see:22/// https://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/pro-bounds-avoid-unchecked-container-access.html23class ProBoundsAvoidUncheckedContainerAccessCheck : public ClangTidyCheck {24public:25 ProBoundsAvoidUncheckedContainerAccessCheck(StringRef Name,26 ClangTidyContext *Context);27 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {28 return LangOpts.CPlusPlus;29 }30 void registerMatchers(ast_matchers::MatchFinder *Finder) override;31 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;32 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;33 34 enum FixModes { None, At, Function };35 36private:37 // A list of class names that are excluded from the warning38 std::vector<llvm::StringRef> ExcludedClasses;39 // Setting which fix to suggest40 FixModes FixMode;41 llvm::StringRef FixFunction;42 llvm::StringRef FixFunctionEmptyArgs;43};44} // namespace clang::tidy::cppcoreguidelines45 46namespace clang::tidy {47template <>48struct OptionEnumMapping<49 cppcoreguidelines::ProBoundsAvoidUncheckedContainerAccessCheck::FixModes> {50 static ArrayRef<std::pair<51 cppcoreguidelines::ProBoundsAvoidUncheckedContainerAccessCheck::FixModes,52 StringRef>>53 getEnumMapping();54};55} // namespace clang::tidy56#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PROBOUNDSAVOIDUNCHECKEDCONTAINERACCESSCHECK_H57