/* SPDX-FileCopyrightText: 2016 Sergio Martins SPDX-License-Identifier: LGPL-2.0-or-later */ #include "incorrect-emit.h" #include "AccessSpecifierManager.h" #include "ClazyContext.h" #include "HierarchyUtils.h" #include "Utils.h" #include #include #include #include #include #include #include #include #include #include using namespace clang; IncorrectEmit::IncorrectEmit(const std::string &name, Options options) : CheckBase(name, options) { m_emitLocations.reserve(30); // bootstrap it m_filesToIgnore = {"moc_", ".moc"}; } size_t countUntilNonSpaceOrParen(const char *start, size_t prefixLen) { size_t count = prefixLen; start += prefixLen; // Skip spaces and '(' characters while (*start && (isspace(*start) || *start == '(')) { ++count; ++start; } return count; } void IncorrectEmit::VisitMacroExpands(const Token &MacroNameTok, const SourceRange &range, const MacroInfo *info) { IdentifierInfo *ii = MacroNameTok.getIdentifierInfo(); if (!ii) { return; } const bool isEmit = ii->getName() == "emit"; const bool isQEmit = ii->getName() == "Q_EMIT"; if (isEmit || isQEmit) { const char *start = sm().getCharacterData(range.getBegin()); const size_t char_offset = countUntilNonSpaceOrParen(start, isEmit ? strlen("emit") : strlen("Q_EMIT")); SourceLocation newLocation = range.getBegin().getLocWithOffset(char_offset); m_emitLocations.push_back(newLocation); } } void IncorrectEmit::VisitStmt(Stmt *stmt) { auto *methodCall = dyn_cast(stmt); if (!methodCall || !methodCall->getCalleeDecl()) { return; } const AccessSpecifierManager *accessSpecifierManager = m_context->accessSpecifierManager; auto *method = dyn_cast(methodCall->getCalleeDecl()); if (!method || !accessSpecifierManager) { return; } if (shouldIgnoreFile(stmt->getBeginLoc())) { return; } if (Stmt *parent = clazy::parent(m_context->parentMap, methodCall)) { // Check if we're inside a chained call, such as: emit d_func()->mySignal() // We're not interested in the d_func() call, so skip it if (clazy::getFirstParentOfType(m_context->parentMap, parent)) { return; } } const QtAccessSpecifierType type = accessSpecifierManager->qtAccessSpecifierType(method); if (type == QtAccessSpecifier_Unknown) { return; } const bool hasEmit = hasEmitKeyboard(methodCall); const std::string methodName = method->getQualifiedNameAsString(); const bool isSignal = type == QtAccessSpecifier_Signal; if (isSignal && !hasEmit) { emitWarning(stmt, "Missing emit keyword on signal call " + methodName); } else if (!isSignal && hasEmit) { emitWarning(stmt, "Emit keyword being used with non-signal " + methodName); } if (isSignal) { checkCallSignalInsideCTOR(methodCall); } } void IncorrectEmit::checkCallSignalInsideCTOR(CXXMemberCallExpr *callExpr) { if (!m_context->lastMethodDecl) { return; } auto *ctorDecl = dyn_cast(m_context->lastMethodDecl); if (!ctorDecl) { return; } Expr *implicitArg = callExpr->getImplicitObjectArgument(); if (!implicitArg || !isa(implicitArg)) { // emit other->sig() is ok return; } if (clazy::getFirstParentOfType(m_context->parentMap, callExpr) != nullptr) { return; // Emit is inside a lambda, it's fine } emitWarning(callExpr->getBeginLoc(), "Emitting inside constructor probably has no effect"); } bool IncorrectEmit::hasEmitKeyboard(CXXMemberCallExpr *call) const { SourceLocation callLoc = call->getBeginLoc(); if (callLoc.isMacroID()) { callLoc = sm().getFileLoc(callLoc); } return std::any_of(m_emitLocations.begin(), m_emitLocations.end(), [&callLoc](const SourceLocation &emitLoc) { return callLoc == emitLoc; }); }