clang-tools 10.0.0

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
35 class DeprecatedHeadersCheck : public ClangTidyCheck {
36 public:
37 DeprecatedHeadersCheck(StringRef Name, ClangTidyContext *Context)
38 : ClangTidyCheck(Name, Context) {}
39 void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
40 Preprocessor *ModuleExpanderPP) override;
41 };
42
43 } // namespace modernize
44 } // namespace tidy
45 } // namespace clang
46
47 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_C_HEADERS_TO_CXX_H
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::modernize::DeprecatedHeadersCheck
This check replaces deprecated C library headers with their C++ STL alternatives. ...
Definition: DeprecatedHeadersCheck.h:35
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:43
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::bugprone::PP
static Preprocessor * PP
Definition: BadSignalToKillThreadCheck.cpp:28
clang::tidy::modernize::DeprecatedHeadersCheck::DeprecatedHeadersCheck
DeprecatedHeadersCheck(StringRef Name, ClangTidyContext *Context)
Definition: DeprecatedHeadersCheck.h:37
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77