blob: 80eddf7bcee79ff51189686a6980dd4295bcfd3f [file] [log] [blame]
//===--- RestrictSystemIncludesCheck.h - clang-tidy --------------*- C++-*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "../ClangTidyCheck.h"
#include "../GlobList.h"
#include "clang/Lex/PPCallbacks.h"
namespace clang {
namespace tidy {
namespace portability {
/// Checks for allowed includes and suggests removal of any others. If no
/// includes are specified, the check will exit without issuing any warnings.
/// For the user-facing documentation see:
class RestrictSystemIncludesCheck : public ClangTidyCheck {
RestrictSystemIncludesCheck(StringRef Name, ClangTidyContext *Context,
std::string DefaultAllowedIncludes = "*")
: ClangTidyCheck(Name, Context),
AllowedIncludes(Options.get("Includes", DefaultAllowedIncludes)),
AllowedIncludesGlobList(AllowedIncludes) {}
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
Preprocessor *ModuleExpanderPP) override;
void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
bool contains(StringRef FileName) {
return AllowedIncludesGlobList.contains(FileName);
std::string AllowedIncludes;
GlobList AllowedIncludesGlobList;
class RestrictedIncludesPPCallbacks : public PPCallbacks {
explicit RestrictedIncludesPPCallbacks(RestrictSystemIncludesCheck &Check,
const SourceManager &SM)
: Check(Check), SM(SM) {}
void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok,
StringRef FileName, bool IsAngled,
CharSourceRange FilenameRange, const FileEntry *File,
StringRef SearchPath, StringRef RelativePath,
const Module *Imported,
SrcMgr::CharacteristicKind FileType) override;
void EndOfMainFile() override;
struct IncludeDirective {
IncludeDirective() = default;
IncludeDirective(SourceLocation Loc, CharSourceRange Range,
StringRef Filename, StringRef FullPath, bool IsInMainFile)
: Loc(Loc), Range(Range), IncludeFile(Filename), IncludePath(FullPath),
IsInMainFile(IsInMainFile) {}
SourceLocation Loc; // '#' location in the include directive
CharSourceRange Range; // SourceRange for the file name
std::string IncludeFile; // Filename as a string
std::string IncludePath; // Full file path as a string
bool IsInMainFile; // Whether or not the include is in the main file
using FileIncludes = llvm::SmallVector<IncludeDirective, 8>;
llvm::SmallDenseMap<FileID, FileIncludes> IncludeDirectives;
RestrictSystemIncludesCheck &Check;
const SourceManager &SM;
} // namespace portability
} // namespace tidy
} // namespace clang