clang-tools 10.0.0

DurationFactoryScaleCheck.h
Go to the documentation of this file.
1 //===--- DurationFactoryScaleCheck.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_ABSEIL_DURATIONFACTORYSCALECHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ABSEIL_DURATIONFACTORYSCALECHECK_H
11
12 #include "../ClangTidy.h"
13
14 namespace clang {
15 namespace tidy {
16 namespace abseil {
17
18 /// This check finds cases where the incorrect `Duration` factory function is
19 /// being used by looking for scaling constants inside the factory argument
20 /// and suggesting a more appropriate factory. It also looks for the special
21 /// case of zero and suggests `ZeroDuration()`.
22 ///
23 /// For the user-facing documentation see:
24 /// http://clang.llvm.org/extra/clang-tidy/checks/abseil-duration-factory-scale.html
25 class DurationFactoryScaleCheck : public ClangTidyCheck {
26 public:
27 DurationFactoryScaleCheck(StringRef Name, ClangTidyContext *Context)
28 : ClangTidyCheck(Name, Context) {}
29 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
30 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
31 };
32
33 } // namespace abseil
34 } // namespace tidy
35 } // namespace clang
36
37 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ABSEIL_DURATIONFACTORYSCALECHECK_H
clang::tidy::abseil::DurationFactoryScaleCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: DurationFactoryScaleCheck.cpp:140
clang::tidy::abseil::DurationFactoryScaleCheck::DurationFactoryScaleCheck
DurationFactoryScaleCheck(StringRef Name, ClangTidyContext *Context)
Definition: DurationFactoryScaleCheck.h:27
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::abseil::DurationFactoryScaleCheck
This check finds cases where the incorrect Duration factory function is being used by looking for sca...
Definition: DurationFactoryScaleCheck.h:25
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77
clang::tidy::abseil::DurationFactoryScaleCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: DurationFactoryScaleCheck.cpp:118