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
35 class DeprecatedHeadersCheck : public ClangTidyCheck {
36 public:
37   DeprecatedHeadersCheck(StringRef Name, ClangTidyContext *Context);
isLanguageVersionSupported(const LangOptions & LangOpts)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
65