clang-tools  14.0.0git
AvoidNSObjectNewCheck.h
Go to the documentation of this file.
1 //===--- AvoidNSObjectNewCheck.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_GOOGLE_AVOIDNSOBJECTNEWCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_AVOIDNSOBJECTNEWCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace google {
17 namespace objc {
18 
19 /// This check finds Objective-C code that uses +new to create object instances,
20 /// or overrides +new in classes. Both are forbidden by Google's Objective-C
21 /// style guide.
22 ///
23 /// For the user-facing documentation see:
24 /// http://clang.llvm.org/extra/clang-tidy/checks/google-avoid-nsobject-new.html
26 public:
28  : ClangTidyCheck(Name, Context) {}
29  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
30  return LangOpts.ObjC;
31  }
32  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
33  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
34 };
35 
36 } // namespace objc
37 } // namespace google
38 } // namespace tidy
39 } // namespace clang
40 
41 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_AVOIDNSOBJECTNEWCHECK_H
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::google::objc::AvoidNSObjectNewCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: AvoidNSObjectNewCheck.h:29
clang::tidy::google::objc::AvoidNSObjectNewCheck::AvoidNSObjectNewCheck
AvoidNSObjectNewCheck(StringRef Name, ClangTidyContext *Context)
Definition: AvoidNSObjectNewCheck.h:27
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::google::objc::AvoidNSObjectNewCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
clang::tidy::google::objc::AvoidNSObjectNewCheck
This check finds Objective-C code that uses +new to create object instances, or overrides +new in cla...
Definition: AvoidNSObjectNewCheck.h:25
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::google::objc::AvoidNSObjectNewCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.