/* SPDX-FileCopyrightText: 2017 Sergio Martins SPDX-License-Identifier: LGPL-2.0-or-later */ #ifndef CLAZY_CONTEXT_H #define CLAZY_CONTEXT_H #include "SuppressionManager.h" #include "clazy_stl.h" #include #include #include #include #include #include #include #include #include #include #include // ClazyContext is just a struct to share data and code between all checks namespace clang { class CompilerInstance; class ASTContext; class ParentMap; class SourceManager; class CXXMethodDecl; class Decl; } class AccessSpecifierManager; class PreProcessorVisitor; class FixItExporter; class ClazyContext { public: using WarningReporter = std::function &fixits)>; enum ClazyOption { ClazyOption_None = 0, ClazyOption_ExportFixes = 1, ClazyOption_OnlyQt = 4, // Ignore non-Qt files. This is done by bailing out if QT_CORE_LIB is not set. ClazyOption_QtDeveloper = 8, // For running clazy on Qt itself, optional, but honours specific guidelines ClazyOption_VisitImplicitCode = 16, // Inspect compiler generated code aswell, useful for custom checks, if they need it ClazyOption_IgnoreIncludedFiles = 32 // Only warn for the current file being compiled, not on includes (useful for performance reasons); note that the // check has to support this feature i.e. has clazy::CheckBase::Option_CanIgnoreIncludes set }; using ClazyOptions = int; using OptionalFileEntryRef = clang::CustomizableOptional; explicit ClazyContext(clang::ASTContext *context, // maybe null, in case we lazy initialize it clang::SourceManager &manager, const clang::LangOptions &lo, const clang::PreprocessorOptions &pp, const std::string &headerFilter, const std::string &ignoreDirs, std::string exportFixesFilename, const std::vector &translationUnitPaths, ClazyOptions opts, std::optional warningReporter = std::nullopt, bool isClangTidy = false); ~ClazyContext(); void registerPreprocessorCallbacks(clang::Preprocessor &pp); bool usingPreCompiledHeaders() const; bool userDisabledWError() const { return m_noWerror; } bool exportFixesEnabled() const { return options & ClazyOption_ExportFixes; } bool isQtDeveloper() const { return options & ClazyOption_QtDeveloper; } bool ignoresIncludedFiles() const { return options & ClazyOption_IgnoreIncludedFiles; } bool isVisitImplicitCode() const { return options & ClazyContext::ClazyOption_VisitImplicitCode; } bool isOptionSet(const std::string &optionName) const { return clazy::contains(extraOptions, optionName); } bool fileMatchesLoc(const std::unique_ptr ®ex, clang::SourceLocation loc, ClazyContext::OptionalFileEntryRef &file) const { if (!regex) { return false; } if (!file) { clang::FileID fid = sm.getDecomposedExpansionLoc(loc).first; file = sm.getFileEntryRefForID(fid); if (!file) { return false; } } return regex->match(file->getName()); } bool shouldIgnoreFile(clang::SourceLocation loc) const { // 1. Process the regexp that excludes files ClazyContext::OptionalFileEntryRef file; if (ignoreDirsRegex) { const bool matches = fileMatchesLoc(ignoreDirsRegex, loc, file); if (matches) { return true; } } // 2. Process the regexp that includes files. Has lower priority. if (!headerFilterRegex || isMainFile(loc)) { return false; } const bool matches = fileMatchesLoc(headerFilterRegex, loc, file); if (!file) { return false; } return !matches; } bool isMainFile(clang::SourceLocation loc) const { if (loc.isMacroID()) { loc = sm.getExpansionLoc(loc); } return sm.isInFileID(loc, sm.getMainFileID()); } bool treatAsError(const std::string &checkName) const { return clazy::contains(m_checksPromotedToErrors, checkName); } bool isQt() const; std::string qtNamespace() const; /** * While the preprocessor visitor is running, we might not have initialized this. * Before VisitStmt/VisitDecl/any AST callback in the CheckBase instance is run, this will be set! */ clang::ASTContext *astContext; clang::SourceManager &sm; const clang::LangOptions &lo; // Can be deducted from ASTContext, but we might want to lazy initialize the context AccessSpecifierManager *accessSpecifierManager = nullptr; PreProcessorVisitor *preprocessorVisitor = nullptr; SuppressionManager suppressionManager; const bool m_noWerror; std::vector m_checksPromotedToErrors; clang::ParentMap *parentMap = nullptr; const ClazyOptions options; const std::vector extraOptions; FixItExporter *exporter = nullptr; clang::CXXMethodDecl *lastMethodDecl = nullptr; clang::FunctionDecl *lastFunctionDecl = nullptr; clang::Decl *lastDecl = nullptr; std::unique_ptr headerFilterRegex; std::unique_ptr ignoreDirsRegex; const std::vector m_translationUnitPaths; const clang::PreprocessorOptions m_pp; const WarningReporter p_warningReporter; const bool m_isClangTidy; }; #endif