clang-tools  15.0.0git
DeprecatedHeadersCheck.h
Go to the documentation of this file.
1 //===--- DeprecatedHeadersCheck.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_MODERNIZE_C_HEADERS_TO_CXX_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_C_HEADERS_TO_CXX_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace modernize {
17 
18 /// This check replaces deprecated C library headers with their C++ STL
19 /// alternatives.
20 ///
21 /// Before:
22 /// ~~~{.cpp}
23 /// #include <header.h>
24 /// ~~~
25 ///
26 /// After:
27 /// ~~~{.cpp}
28 /// #include <cheader>
29 /// ~~~
30 ///
31 /// Example: ``<stdio.h> => <cstdio>``
32 ///
33 /// For the user-facing documentation see:
34 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize/deprecated-headers.html
36 public:
37  DeprecatedHeadersCheck(StringRef Name, ClangTidyContext *Context);
38  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
39  return LangOpts.CPlusPlus;
40  }
41  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
42  void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
43  Preprocessor *ModuleExpanderPP) override;
44  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
45  void onEndOfTranslationUnit() override;
46  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
47 
48  struct IncludeMarker {
49  std::string Replacement;
50  StringRef FileName;
51  SourceRange ReplacementRange;
52  SourceLocation DiagLoc;
53  };
54 
55 private:
56  std::vector<IncludeMarker> IncludesToBeProcessed;
57  bool CheckHeaderFile;
58 };
59 
60 } // namespace modernize
61 } // namespace tidy
62 } // namespace clang
63 
64 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_C_HEADERS_TO_CXX_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::modernize::DeprecatedHeadersCheck::IncludeMarker::Replacement
std::string Replacement
Definition: DeprecatedHeadersCheck.h:49
clang::tidy::modernize::DeprecatedHeadersCheck::IncludeMarker::FileName
StringRef FileName
Definition: DeprecatedHeadersCheck.h:50
clang::tidy::modernize::DeprecatedHeadersCheck::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: DeprecatedHeadersCheck.h:38
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:53
clang::tidy::modernize::DeprecatedHeadersCheck::IncludeMarker::ReplacementRange
SourceRange ReplacementRange
Definition: DeprecatedHeadersCheck.h:51
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:67
clang::tidy::modernize::DeprecatedHeadersCheck::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: DeprecatedHeadersCheck.cpp:84
clang::tidy::modernize::DeprecatedHeadersCheck
This check replaces deprecated C library headers with their C++ STL alternatives.
Definition: DeprecatedHeadersCheck.h:35
clang::tidy::modernize::DeprecatedHeadersCheck::onEndOfTranslationUnit
void onEndOfTranslationUnit() override
Definition: DeprecatedHeadersCheck.cpp:105
Name
Token Name
Definition: MacroToEnumCheck.cpp:89
clang::tidy::bugprone::PP
static Preprocessor * PP
Definition: BadSignalToKillThreadCheck.cpp:29
clang::tidy::modernize::DeprecatedHeadersCheck::registerPPCallbacks
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
Definition: DeprecatedHeadersCheck.cpp:88
clang::tidy::modernize::DeprecatedHeadersCheck::DeprecatedHeadersCheck
DeprecatedHeadersCheck(StringRef Name, ClangTidyContext *Context)
Definition: DeprecatedHeadersCheck.cpp:79
clang::tidy::modernize::DeprecatedHeadersCheck::IncludeMarker
Definition: DeprecatedHeadersCheck.h:48
clang::tidy::modernize::DeprecatedHeadersCheck::IncludeMarker::DiagLoc
SourceLocation DiagLoc
Definition: DeprecatedHeadersCheck.h:52
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
LangOpts
const LangOptions * LangOpts
Definition: ExtractFunction.cpp:366
clang::tidy::modernize::DeprecatedHeadersCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: DeprecatedHeadersCheck.cpp:94
clang::tidy::modernize::DeprecatedHeadersCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: DeprecatedHeadersCheck.cpp:109