clang-tools  17.0.0git
AvoidNSErrorInitCheck.h
Go to the documentation of this file.
1 //===--- AvoidNSErrorInitCheck.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_AVOIDNSERRORINITCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_OBJC_AVOIDNSERRORINITCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang::tidy::objc {
15 
16 /// Finds usages of -[NSError init]. It is not the proper way of creating
17 /// NSError. errorWithDomain:code:userInfo: should be used instead.
18 ///
19 /// For the user-facing documentation see:
20 /// http://clang.llvm.org/extra/clang-tidy/checks/objc/avoid-nserror-init.html
22  public:
24  : ClangTidyCheck(Name, Context) {}
25  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
26  return LangOpts.ObjC;
27  }
28  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
29  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
30 };
31 
32 } // namespace clang::tidy::objc
33 
34 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_OBJC_AVOIDNSERRORINITCHECK_H
clang::tidy::objc::AvoidNSErrorInitCheck::AvoidNSErrorInitCheck
AvoidNSErrorInitCheck(StringRef Name, ClangTidyContext *Context)
Definition: AvoidNSErrorInitCheck.h:23
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:53
clang::tidy::objc::AvoidNSErrorInitCheck::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: AvoidNSErrorInitCheck.h:25
clang::tidy::objc::AvoidNSErrorInitCheck
Finds usages of -[NSError init].
Definition: AvoidNSErrorInitCheck.h:21
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:68
Name
Token Name
Definition: MacroToEnumCheck.cpp:87
clang::tidy::objc::AvoidNSErrorInitCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: AvoidNSErrorInitCheck.cpp:17
clang::tidy::objc
Definition: AssertEquals.cpp:16
LangOpts
const LangOptions * LangOpts
Definition: ExtractFunction.cpp:374
clang::tidy::objc::AvoidNSErrorInitCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: AvoidNSErrorInitCheck.cpp:24