clang-tools  14.0.0git
TypePromotionInMathFnCheck.h
Go to the documentation of this file.
1 //===--- TypePromotionInMathFnCheck.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_PERFORMANCE_TYPE_PROMOTION_IN_MATH_FN_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_TYPE_PROMOTION_IN_MATH_FN_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "../utils/IncludeInserter.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace performance {
18 
19 /// Finds calls to C math library functions with implicit float to double
20 /// promotions.
21 ///
22 /// For example, warns on ::sin(0.f), because this funciton's parameter is a
23 /// double. You probably meant to call std::sin(0.f) (in C++), or sinf(0.f) (in
24 /// C).
25 ///
26 /// For the user-facing documentation see:
27 /// http://clang.llvm.org/extra/clang-tidy/checks/performance-type-promotion-in-math-fn.html
29 public:
31 
32  void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
33  Preprocessor *ModuleExpanderPP) override;
34  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
35  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
36  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
37 
38 private:
39  utils::IncludeInserter IncludeInserter;
40 };
41 
42 } // namespace performance
43 } // namespace tidy
44 } // namespace clang
45 
46 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_PERFORMANCE_TYPE_PROMOTION_IN_MATH_FN_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::utils::IncludeInserter
Produces fixes to insert specified includes to source files, if not yet present.
Definition: IncludeInserter.h:55
clang::tidy::performance::TypePromotionInMathFnCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: TypePromotionInMathFnCheck.cpp:156
clang::tidy::performance::TypePromotionInMathFnCheck
Finds calls to C math library functions with implicit float to double promotions.
Definition: TypePromotionInMathFnCheck.h:28
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::performance::TypePromotionInMathFnCheck::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: TypePromotionInMathFnCheck.cpp:43
clang::tidy::performance::TypePromotionInMathFnCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: TypePromotionInMathFnCheck.cpp:48
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::bugprone::PP
static Preprocessor * PP
Definition: BadSignalToKillThreadCheck.cpp:29
clang::tidy::performance::TypePromotionInMathFnCheck::TypePromotionInMathFnCheck
TypePromotionInMathFnCheck(StringRef Name, ClangTidyContext *Context)
Definition: TypePromotionInMathFnCheck.cpp:31
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::performance::TypePromotionInMathFnCheck::registerPPCallbacks
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
Definition: TypePromotionInMathFnCheck.cpp:38