/* SPDX-FileCopyrightText: 2015 Klarälvdalens Datakonsult AB a KDAB Group company info@kdab.com SPDX-FileContributor: SĂ©rgio Martins SPDX-FileCopyrightText: 2015-2017 Sergio Martins SPDX-License-Identifier: LGPL-2.0-or-later */ #ifndef CHECK_BASE_H #define CHECK_BASE_H #include "ClazyContext.h" #include "clazy_stl.h" // IWYU pragma: keep #include #include #include #include #include #include #include #include #include #include #include #include namespace clazy { using OptionalFileEntryRef = clang::CustomizableOptional; } namespace clang { class CXXMethodDecl; class Stmt; class Decl; class TranslationUnitDecl; class FixItHint; class PresumedLoc; class SourceLocation; class PreprocessorOptions; class LangOptions; class MacroArgs; class MacroDefinition; class MacroDirective; class MacroInfo; class SourceManager; class Token; } class CheckBase; enum CheckLevel { // See README.md for what each level does CheckLevelUndefined = -1, CheckLevel0 = 0, CheckLevel1, CheckLevel2, ManualCheckLevel, MaxCheckLevel = CheckLevel2, DefaultCheckLevel = CheckLevel1 }; class ClazyPreprocessorCallbacks : public clang::PPCallbacks { public: ClazyPreprocessorCallbacks(const ClazyPreprocessorCallbacks &) = delete; explicit ClazyPreprocessorCallbacks(CheckBase *check); void MacroExpands(const clang::Token &MacroNameTok, const clang::MacroDefinition &, clang::SourceRange, const clang::MacroArgs *) override; void MacroDefined(const clang::Token &MacroNameTok, const clang::MacroDirective *) override; void Defined(const clang::Token &MacroNameTok, const clang::MacroDefinition &, clang::SourceRange Range) override; void Ifdef(clang::SourceLocation, const clang::Token &MacroNameTok, const clang::MacroDefinition &) override; void Ifndef(clang::SourceLocation Loc, const clang::Token &MacroNameTok, const clang::MacroDefinition &) override; void If(clang::SourceLocation loc, clang::SourceRange conditionRange, clang::PPCallbacks::ConditionValueKind conditionValue) override; void Elif(clang::SourceLocation loc, clang::SourceRange conditionRange, clang::PPCallbacks::ConditionValueKind ConditionValue, clang::SourceLocation ifLoc) override; void Else(clang::SourceLocation loc, clang::SourceLocation ifLoc) override; void Endif(clang::SourceLocation loc, clang::SourceLocation ifLoc) override; void InclusionDirective(clang::SourceLocation HashLoc, const clang::Token &IncludeTok, llvm::StringRef FileName, bool IsAngled, clang::CharSourceRange FilenameRange, clazy::OptionalFileEntryRef File, llvm::StringRef SearchPath, llvm::StringRef RelativePath, const clang::Module *SuggestedModule, bool ModuleImported, clang::SrcMgr::CharacteristicKind FileType) override; private: CheckBase *const check; }; class ClazyAstMatcherCallback : public clang::ast_matchers::MatchFinder::MatchCallback { public: explicit ClazyAstMatcherCallback(CheckBase *check); protected: CheckBase *const m_check; }; class CheckBase { public: enum Option { Option_None = 0, Option_CanIgnoreIncludes = 1 }; using Options = int; using List = std::vector; explicit CheckBase(const std::string &name, Options = Option_None); CheckBase(const CheckBase &other) = delete; virtual ~CheckBase(); std::string name() const { return m_name; } void emitWarning(const clang::Decl *, const std::string &error, bool printWarningTag = true); void emitWarning(const clang::Stmt *, const std::string &error, bool printWarningTag = true); void emitWarning(clang::SourceLocation loc, const std::string &error, bool printWarningTag = true); void emitWarning(clang::SourceLocation loc, std::string error, const std::vector &fixits, bool printWarningTag = true); void emitInternalError(clang::SourceLocation loc, std::string error); virtual void registerASTMatchers(clang::ast_matchers::MatchFinder &) { } bool canIgnoreIncludes() const { return m_options & Option_CanIgnoreIncludes; } virtual void VisitStmt(clang::Stmt *stm); virtual void VisitDecl(clang::Decl *decl); void enablePreProcessorCallbacks(clang::Preprocessor &pp); // Lazy initialized for clang-tidy plugin. Value will be assigned before Visit* methods are called const ClazyContext *m_context = nullptr; protected: virtual void VisitMacroExpands(const clang::Token ¯oNameTok, const clang::SourceRange &, const clang::MacroInfo *minfo = nullptr); virtual void VisitMacroDefined(const clang::Token ¯oNameTok); virtual void VisitDefined(const clang::Token ¯oNameTok, const clang::SourceRange &); virtual void VisitIfdef(clang::SourceLocation, const clang::Token &); virtual void VisitIfndef(clang::SourceLocation, const clang::Token &); virtual void VisitIf(clang::SourceLocation loc, clang::SourceRange conditionRange, clang::PPCallbacks::ConditionValueKind conditionValue); virtual void VisitElif(clang::SourceLocation loc, clang::SourceRange conditionRange, clang::PPCallbacks::ConditionValueKind ConditionValue, clang::SourceLocation ifLoc); virtual void VisitElse(clang::SourceLocation loc, clang::SourceLocation ifLoc); virtual void VisitEndif(clang::SourceLocation loc, clang::SourceLocation ifLoc); virtual void VisitInclusionDirective(clang::SourceLocation HashLoc, const clang::Token &IncludeTok, llvm::StringRef FileName, bool IsAngled, clang::CharSourceRange FilenameRange, clazy::OptionalFileEntryRef File, llvm::StringRef SearchPath, llvm::StringRef RelativePath, const clang::Module *SuggestedModule, bool ModuleImported, clang::SrcMgr::CharacteristicKind FileType); bool shouldIgnoreFile(clang::SourceLocation) const; void reallyEmitWarning(clang::SourceLocation loc, const std::string &error, const std::vector &fixits); void queueManualFixitWarning(clang::SourceLocation loc, const std::string &message = {}); bool warningAlreadyEmitted(clang::SourceLocation loc) const; bool manualFixitAlreadyQueued(clang::SourceLocation loc) const; bool isOptionSet(const std::string &optionName) const; // 3 shortcuts for stuff that litter the codebase all over. const clang::SourceManager &sm() const { return m_context->sm; } const clang::LangOptions &lo() const { return m_context->lo; } clang::ASTContext *astContext() const { return m_context->astContext; } std::string qtNamespaced(const std::string &className) const { const std::string qtNsp = m_context->qtNamespace(); return qtNsp.empty() ? className : qtNsp + "::" + className; } std::string trimQtNamespace(std::string &&name) const { if (!m_context->qtNamespace().empty() && name.starts_with(m_context->qtNamespace() + "::")) { name.erase(0, m_context->qtNamespace().size() + 2); } return name; } const std::string m_name; std::vector m_filesToIgnore; private: std::string tag() const; friend class ClazyPreprocessorCallbacks; friend class ClazyAstMatcherCallback; ClazyPreprocessorCallbacks *const m_preprocessorCallbacks; std::vector m_emittedWarningsInMacro; std::vector m_emittedManualFixItsWarningsInMacro; std::vector> m_queuedManualInterventionWarnings; const Options m_options; }; #endif