clang-tools  11.0.0
UseTrailingReturnTypeCheck.h
Go to the documentation of this file.
1 //===--- UseTrailingReturnTypeCheck.h - clang-tidy---------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USETRAILINGRETURNTYPECHECK_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USETRAILINGRETURNTYPECHECK_H
12 
13 #include "../ClangTidyCheck.h"
14 #include "clang/Lex/Token.h"
15 
16 namespace clang {
17 namespace tidy {
18 namespace modernize {
19 
21  Token T;
24 };
25 
26 /// Rewrites function signatures to use a trailing return type.
27 ///
28 /// For the user-facing documentation see:
29 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-trailing-type-return.html
31 public:
33  : ClangTidyCheck(Name, Context) {}
34  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
35  return LangOpts.CPlusPlus11;
36  }
37  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
38  void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
39  Preprocessor *ModuleExpanderPP) override;
40  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
41 
42 private:
43  Preprocessor *PP = nullptr;
44 
45  SourceLocation findTrailingReturnTypeSourceLocation(
46  const FunctionDecl &F, const FunctionTypeLoc &FTL, const ASTContext &Ctx,
47  const SourceManager &SM, const LangOptions &LangOpts);
48  llvm::Optional<SmallVector<ClassifiedToken, 8>>
49  classifyTokensBeforeFunctionName(const FunctionDecl &F, const ASTContext &Ctx,
50  const SourceManager &SM,
51  const LangOptions &LangOpts);
52  SourceRange findReturnTypeAndCVSourceRange(const FunctionDecl &F,
53  const ASTContext &Ctx,
54  const SourceManager &SM,
55  const LangOptions &LangOpts);
56  bool keepSpecifiers(std::string &ReturnType, std::string &Auto,
57  SourceRange ReturnTypeCVRange, const FunctionDecl &F,
58  const FriendDecl *Fr, const ASTContext &Ctx,
59  const SourceManager &SM, const LangOptions &LangOpts);
60 };
61 
62 } // namespace modernize
63 } // namespace tidy
64 } // namespace clang
65 
66 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USETRAILINGRETURNTYPECHECK_H
clang::tidy::modernize::ClassifiedToken
Definition: UseTrailingReturnTypeCheck.h:20
clang::tidy::modernize::UseTrailingReturnTypeCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: UseTrailingReturnTypeCheck.cpp:389
clang::tidy::modernize::UseTrailingReturnTypeCheck
Rewrites function signatures to use a trailing return type.
Definition: UseTrailingReturnTypeCheck.h:30
Ctx
Context Ctx
Definition: TUScheduler.cpp:324
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:114
clang::tidy::modernize::ClassifiedToken::isQualifier
bool isQualifier
Definition: UseTrailingReturnTypeCheck.h:22
clang::tidy::modernize::ClassifiedToken::T
Token T
Definition: UseTrailingReturnTypeCheck.h:21
clang::tidy::modernize::UseTrailingReturnTypeCheck::registerPPCallbacks
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
Definition: UseTrailingReturnTypeCheck.cpp:384
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:76
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::modernize::ClassifiedToken::isSpecifier
bool isSpecifier
Definition: UseTrailingReturnTypeCheck.h:23
clang::tidy::modernize::UseTrailingReturnTypeCheck::UseTrailingReturnTypeCheck
UseTrailingReturnTypeCheck(StringRef Name, ClangTidyContext *Context)
Definition: UseTrailingReturnTypeCheck.h:32
clang::tidy::modernize::UseTrailingReturnTypeCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UseTrailingReturnTypeCheck.cpp:374
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::modernize::UseTrailingReturnTypeCheck::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: UseTrailingReturnTypeCheck.h:34
ReturnType
std::string ReturnType
Definition: CodeComplete.cpp:407