clang-tools  17.0.0git
AssertEquals.h
Go to the documentation of this file.
1 //===--- AssertEquals.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 THIRD_PARTY_LLVM_LLVM_PROJECT_CLANG_TOOLS_EXTRA_CLANG_TIDY_OBJC_OBJCASSERTEQUALS_H_
10 #define THIRD_PARTY_LLVM_LLVM_PROJECT_CLANG_TOOLS_EXTRA_CLANG_TIDY_OBJC_OBJCASSERTEQUALS_H_
11 
12 #include "../ClangTidyCheck.h"
13 #include "clang/ASTMatchers/ASTMatchFinder.h"
14 
15 namespace clang::tidy::objc {
16 
17 /// Warn if XCTAssertEqual() or XCTAssertNotEqual() is used with at least one
18 /// operands of type NSString*.
19 ///
20 /// For the user-facing documentation see:
21 /// http://clang.llvm.org/extra/clang-tidy/checks/objc/assert-equals.html
22 class AssertEquals final : public ClangTidyCheck {
23 public:
24  AssertEquals(StringRef Name, ClangTidyContext *Context)
25  : ClangTidyCheck(Name, Context) {}
26  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
27  return LangOpts.ObjC;
28  }
29  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
30  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
31 };
32 
33 } // namespace clang::tidy::objc
34 
35 #endif // THIRD_PARTY_LLVM_LLVM_PROJECT_CLANG_TOOLS_EXTRA_CLANG_TIDY_OBJC_OBJCASSERTEQUALS_H_
clang::tidy::objc::AssertEquals::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: AssertEquals.cpp:28
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:53
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::AssertEquals::AssertEquals
AssertEquals(StringRef Name, ClangTidyContext *Context)
Definition: AssertEquals.h:24
clang::tidy::objc::AssertEquals::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: AssertEquals.h:26
clang::tidy::objc::AssertEquals::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: AssertEquals.cpp:44
clang::tidy::objc
Definition: AssertEquals.cpp:16
LangOpts
const LangOptions * LangOpts
Definition: ExtractFunction.cpp:374
clang::tidy::objc::AssertEquals
Warn if XCTAssertEqual() or XCTAssertNotEqual() is used with at least one operands of type NSString*.
Definition: AssertEquals.h:22