clang-tools  11.0.0
ForbiddenSubclassingCheck.cpp
Go to the documentation of this file.
1 //===--- ForbiddenSubclassingCheck.cpp - clang-tidy -----------------------===//
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 
10 #include "clang/AST/ASTContext.h"
11 #include "clang/ASTMatchers/ASTMatchFinder.h"
12 #include "llvm/ADT/Hashing.h"
13 #include "llvm/ADT/SmallVector.h"
14 #include "../utils/OptionsUtils.h"
15 
16 using namespace clang::ast_matchers;
17 
18 namespace clang {
19 namespace tidy {
20 namespace objc {
21 
22 namespace {
23 
24 constexpr char DefaultForbiddenSuperClassNames[] =
25  "ABNewPersonViewController;"
26  "ABPeoplePickerNavigationController;"
27  "ABPersonViewController;"
28  "ABUnknownPersonViewController;"
29  "NSHashTable;"
30  "NSMapTable;"
31  "NSPointerArray;"
32  "NSPointerFunctions;"
33  "NSTimer;"
34  "UIActionSheet;"
35  "UIAlertView;"
36  "UIImagePickerController;"
37  "UITextInputMode;"
38  "UIWebView";
39 
40 } // namespace
41 
42 ForbiddenSubclassingCheck::ForbiddenSubclassingCheck(
43  StringRef Name,
44  ClangTidyContext *Context)
45  : ClangTidyCheck(Name, Context),
46  ForbiddenSuperClassNames(
47  utils::options::parseStringList(
48  Options.get("ClassNames", DefaultForbiddenSuperClassNames))) {
49 }
50 
52  Finder->addMatcher(
53  objcInterfaceDecl(
54  isDerivedFrom(
55  objcInterfaceDecl(
56  hasAnyName(
57  std::vector<StringRef>(
58  ForbiddenSuperClassNames.begin(),
59  ForbiddenSuperClassNames.end())))
60  .bind("superclass")))
61  .bind("subclass"),
62  this);
63 }
64 
66  const MatchFinder::MatchResult &Result) {
67  const auto *SubClass = Result.Nodes.getNodeAs<ObjCInterfaceDecl>(
68  "subclass");
69  assert(SubClass != nullptr);
70  const auto *SuperClass = Result.Nodes.getNodeAs<ObjCInterfaceDecl>(
71  "superclass");
72  assert(SuperClass != nullptr);
73  diag(SubClass->getLocation(),
74  "Objective-C interface %0 subclasses %1, which is not "
75  "intended to be subclassed")
76  << SubClass
77  << SuperClass;
78 }
79 
82  Options.store(
83  Opts,
84  "ForbiddenSuperClassNames",
85  utils::options::serializeStringList(ForbiddenSuperClassNames));
86 }
87 
88 } // namespace objc
89 } // namespace tidy
90 } // namespace clang
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:114
ForbiddenSubclassingCheck.h
clang::ast_matchers
Definition: AbseilMatcher.h:14
clang::tidy::utils::options::serializeStringList
std::string serializeStringList(ArrayRef< std::string > Strings)
Serialize a sequence of names that can be parsed by parseStringList.
Definition: OptionsUtils.cpp:30
clang::tidy::utils::options::parseStringList
std::vector< std::string > parseStringList(StringRef Option)
Parse a semicolon separated list of strings.
Definition: OptionsUtils.cpp:18
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:80
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:471
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:76
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::ClangTidyCheck::diag
DiagnosticBuilder diag(SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
Add a diagnostic with the check's name.
Definition: ClangTidyCheck.cpp:55
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:65
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::ClangTidyCheck::OptionsView::store
void store(ClangTidyOptions::OptionMap &Options, StringRef LocalName, StringRef Value) const
Stores an option with the check-local name LocalName with string value Value to Options.
Definition: ClangTidyCheck.cpp:152
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:111