clang-tools  17.0.0git
ComparisonInTempFailureRetryCheck.h
Go to the documentation of this file.
1 //===--- ComparisonInTempFailureRetryCheck.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_ANDROID_COMPARISONINTEMPFAILURERETRYCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_COMPARISONINTEMPFAILURERETRYCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/ADT/StringRef.h"
15 #include <string>
16 
17 namespace clang::tidy::android {
18 
19 /// Attempts to catch calls to TEMP_FAILURE_RETRY with a top-level comparison
20 /// operation, like `TEMP_FAILURE_RETRY(read(...) != N)`. In these cases, the
21 /// comparison should go outside of the TEMP_FAILURE_RETRY.
22 ///
23 /// TEMP_FAILURE_RETRY is a macro provided by both glibc and Bionic.
25 public:
27  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
28  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
29  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
30 
31 private:
32  const StringRef RawRetryList;
33  SmallVector<StringRef, 5> RetryMacros;
34 };
35 
36 } // namespace clang::tidy::android
37 
38 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_COMPARISONINTEMPFAILURERETRYCHECK_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:114
clang::tidy::android::ComparisonInTempFailureRetryCheck
Attempts to catch calls to TEMP_FAILURE_RETRY with a top-level comparison operation,...
Definition: ComparisonInTempFailureRetryCheck.h:24
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:53
clang::tidy::android
Definition: AndroidTidyModule.cpp:31
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:68
clang::tidy::android::ComparisonInTempFailureRetryCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: ComparisonInTempFailureRetryCheck.cpp:26
Name
Token Name
Definition: MacroToEnumCheck.cpp:87
clang::tidy::android::ComparisonInTempFailureRetryCheck::ComparisonInTempFailureRetryCheck
ComparisonInTempFailureRetryCheck(StringRef Name, ClangTidyContext *Context)
Definition: ComparisonInTempFailureRetryCheck.cpp:19
clang::tidy::android::ComparisonInTempFailureRetryCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: ComparisonInTempFailureRetryCheck.cpp:31
clang::tidy::android::ComparisonInTempFailureRetryCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: ComparisonInTempFailureRetryCheck.cpp:54