clang-tools 10.0.0

ForbiddenSubclassingCheck.h
Go to the documentation of this file.
1 //===--- ForbiddenSubclassingCheck.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_OBJC_FORBIDDEN_SUBCLASSING_CHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_OBJC_FORBIDDEN_SUBCLASSING_CHECK_H
11
12 #include "../ClangTidyCheck.h"
13 #include "llvm/ADT/StringRef.h"
14 #include <string>
15 #include <vector>
16
17 namespace clang {
18 namespace tidy {
19 namespace objc {
20
21 /// Finds Objective-C classes which have a superclass which is
22 /// documented to not support subclassing.
23 ///
24 /// For the user-facing documentation see:
25 /// http://clang.llvm.org/extra/clang-tidy/checks/objc-forbidden-subclassing.html
26 class ForbiddenSubclassingCheck : public ClangTidyCheck {
27 public:
28 ForbiddenSubclassingCheck(StringRef Name, ClangTidyContext *Context);
29 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
30 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
31 void storeOptions(ClangTidyOptions::OptionMap &Options) override;
32
33 private:
34 const std::vector<std::string> ForbiddenSuperClassNames;
35 };
36
37 } // namespace objc
38 } // namespace tidy
39 } // namespace clang
40
41 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_OBJC_FORBIDDEN_SUBCLASSING_CHECK_H
clang::tidy::objc::ForbiddenSubclassingCheck
Finds Objective-C classes which have a superclass which is documented to not support subclassing...
Definition: ForbiddenSubclassingCheck.h:26
clang::tidy::objc::ForbiddenSubclassingCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: ForbiddenSubclassingCheck.cpp:51
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::objc::ForbiddenSubclassingCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Options) override
Should store all options supported by this check with their current values or default values for opti...
Definition: ForbiddenSubclassingCheck.cpp:84
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:184
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, std::string > OptionMap
Definition: ClangTidyOptions.h:97
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::objc::ForbiddenSubclassingCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: ForbiddenSubclassingCheck.cpp:69
clang::tidy::objc::ForbiddenSubclassingCheck::ForbiddenSubclassingCheck
ForbiddenSubclassingCheck(StringRef Name, ClangTidyContext *Context)
Definition: ForbiddenSubclassingCheck.cpp:42
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77