strepsirrhini/office-gobmx
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
office-gobmx/compilerplugins/clang/xmlimport.cxx
Stephan Bergmann d1a2b80b9d Bump compiler plugins Clang baseline to 12.0.1 
...as discussed in the mail thread starting at
<https://lists.freedesktop.org/archives/libreoffice/2020-November/086234.html>
"Bump --enable-compiler-plugins Clang baseline?" (and now picked up again at
<https://lists.freedesktop.org/archives/libreoffice/2022-February/088459.html>
"Re: Bump --enable-compiler-plugins Clang baseline?"), and clean up
compilerplugins/clang/ accordingly

Change-Id: I5e81c6fdcc363aeefd6227606225b526fdf7ac16
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/129989
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2022-02-17 21:45:06 +01:00

394 lines
14 KiB
C++
Raw Blame History

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* Based on LLVM/Clang.
*
* This file is distributed under the University of Illinois Open Source
* License. See LICENSE.TXT for details.
*
*/
#ifndef LO_CLANG_SHARED_PLUGINS
#include "plugin.hxx"
#include "check.hxx"
#include "config_clang.h"
#include <iostream>
#include <unordered_map>
#include "clang/AST/CXXInheritance.h"
/*
* This is a compile-time checker.
*
* Check that when we override SvXmlImportContext, and we override createFastChildContext,
* we have also overridden startFastElement, or the fast-parser stuff will not work
* correctly.
*/
namespace
{
class XmlImport : public loplugin::FilteringPlugin<XmlImport>
{
public:
explicit XmlImport(loplugin::InstantiationData const& data)
: FilteringPlugin(data)
{
}
bool preRun() override
{
StringRef fn(handler.getMainFileName());
if (loplugin::isSamePathname(fn, SRCDIR "/xmloff/source/core/xmlictxt.cxx"))
return false;
if (loplugin::isSamePathname(fn, SRCDIR "/xmloff/source/core/xmlimp.cxx"))
return false;
// These are mostly classes delegating calls to other classes
if (loplugin::isSamePathname(fn, SRCDIR "/xmloff/source/text/XMLTextFrameContext.cxx"))
return false;
if (loplugin::isSamePathname(fn, SRCDIR "/xmloff/source/draw/ximpshap.cxx"))
return false;
if (loplugin::isSamePathname(fn, SRCDIR "/xmloff/source/table/XMLTableImport.cxx"))
return false;
if (loplugin::isSamePathname(fn,
SRCDIR "/sc/source/filter/xml/XMLTrackedChangesContext.cxx"))
return false;
if (loplugin::isSamePathname(fn, SRCDIR "/sc/source/filter/xml/xmlannoi.cxx"))
return false;
// this class specifically wants to prevent some endFastElement processing happening in its superclass
if (loplugin::isSamePathname(fn, SRCDIR
"/xmloff/source/text/XMLIndexBibliographySourceContext.cxx"))
return false;
// calling mxSlaveContext
if (loplugin::isSamePathname(fn, SRCDIR "/xmloff/source/draw/XMLNumberStyles.cxx"))
return false;
return true;
}
void run() override
{
if (preRun())
{
TraverseDecl(compiler.getASTContext().getTranslationUnitDecl());
}
}
bool VisitCXXMethodDecl(const CXXMethodDecl*);
bool VisitCXXMemberCallExpr(const CXXMemberCallExpr*);
bool VisitBinaryOperator(const BinaryOperator*);
bool VisitSwitchStmt(const SwitchStmt*);
bool VisitCallExpr(const CallExpr*);
private:
bool isXmlTokEnum(const Expr*);
bool isUInt16(const Expr*);
bool isUInt16(QualType);
std::unordered_map<const CXXRecordDecl*, const CXXMethodDecl*> startFastElementSet;
std::unordered_map<const CXXRecordDecl*, const CXXMethodDecl*> StartElementSet;
std::unordered_map<const CXXRecordDecl*, const CXXMethodDecl*> endFastElementSet;
std::unordered_map<const CXXRecordDecl*, const CXXMethodDecl*> EndElementSet;
std::unordered_map<const CXXRecordDecl*, const CXXMethodDecl*> charactersSet;
std::unordered_map<const CXXRecordDecl*, const CXXMethodDecl*> CharactersSet;
};
bool XmlImport::VisitCXXMethodDecl(const CXXMethodDecl* methodDecl)
{
auto beginLoc = methodDecl->getBeginLoc();
if (!beginLoc.isValid() || ignoreLocation(beginLoc))
return true;
if (!methodDecl->getIdentifier())
return true;
auto cxxRecordDecl = methodDecl->getParent();
if (!cxxRecordDecl || !cxxRecordDecl->getIdentifier())
return true;
if (loplugin::DeclCheck(cxxRecordDecl).Class("SvXMLImportContext"))
return true;
if (!loplugin::isDerivedFrom(cxxRecordDecl, [](Decl const* decl) -> bool {
auto const dc = loplugin::DeclCheck(decl);
return bool(dc.ClassOrStruct("SvXMLImportContext").GlobalNamespace());
}))
return true;
auto name = methodDecl->getName();
if (name == "startFastElement")
startFastElementSet.insert({ cxxRecordDecl, methodDecl });
else if (name == "StartElement")
StartElementSet.insert({ cxxRecordDecl, methodDecl });
else if (name == "endFastElement")
endFastElementSet.insert({ cxxRecordDecl, methodDecl });
else if (name == "EndElement")
EndElementSet.insert({ cxxRecordDecl, methodDecl });
else if (name == "characters")
{
if (methodDecl->getNumParams() == 1)
charactersSet.insert({ cxxRecordDecl, methodDecl });
}
else if (name == "Characters")
{
if (methodDecl->getNumParams() == 1)
CharactersSet.insert({ cxxRecordDecl, methodDecl });
}
{
auto it1 = endFastElementSet.find(cxxRecordDecl);
auto it2 = EndElementSet.find(cxxRecordDecl);
if (it1 != endFastElementSet.end() && it2 != EndElementSet.end())
{
auto methodDecl1 = it1->second;
report(DiagnosticsEngine::Warning, "cannot override both endFastElement and EndElement",
methodDecl1->getBeginLoc())
<< methodDecl1->getSourceRange();
auto methodDecl2 = it2->second;
report(DiagnosticsEngine::Warning, "cannot override both endFastElement and EndElement",
methodDecl2->getBeginLoc())
<< methodDecl2->getSourceRange();
}
}
{
auto it1 = startFastElementSet.find(cxxRecordDecl);
auto it2 = StartElementSet.find(cxxRecordDecl);
if (it1 != startFastElementSet.end() && it2 != StartElementSet.end())
{
auto methodDecl1 = it1->second;
report(DiagnosticsEngine::Warning,
"cannot override both startFastElement and StartElement",
methodDecl1->getBeginLoc())
<< methodDecl1->getSourceRange();
auto methodDecl2 = it2->second;
report(DiagnosticsEngine::Warning,
"cannot override both startFastElement and StartElement",
methodDecl2->getBeginLoc())
<< methodDecl2->getSourceRange();
}
}
{
auto it1 = charactersSet.find(cxxRecordDecl);
auto it2 = CharactersSet.find(cxxRecordDecl);
if (it1 != charactersSet.end() && it2 != CharactersSet.end())
{
auto methodDecl1 = it1->second;
report(DiagnosticsEngine::Warning, "cannot override both characters and Characters",
methodDecl1->getBeginLoc())
<< methodDecl1->getSourceRange();
auto methodDecl2 = it2->second;
report(DiagnosticsEngine::Warning, "cannot override both characters and Characters",
methodDecl2->getBeginLoc())
<< methodDecl2->getSourceRange();
}
}
auto checkEmpty = [&]() {
if (!methodDecl->isThisDeclarationADefinition())
return;
auto compoundStmt = dyn_cast_or_null<CompoundStmt>(methodDecl->getBody());
if (compoundStmt == nullptr || compoundStmt->size() > 0)
return;
report(DiagnosticsEngine::Warning, "empty, should be removed", methodDecl->getBeginLoc())
<< methodDecl->getSourceRange();
auto canonicalDecl = methodDecl->getCanonicalDecl();
if (canonicalDecl != methodDecl)
report(DiagnosticsEngine::Note, "definition here", canonicalDecl->getBeginLoc())
<< canonicalDecl->getSourceRange();
};
auto checkOnlyReturn = [&]() {
if (!methodDecl->isThisDeclarationADefinition())
return;
auto compoundStmt = dyn_cast_or_null<CompoundStmt>(methodDecl->getBody());
if (compoundStmt == nullptr || compoundStmt->size() > 1)
return;
auto returnStmt = dyn_cast_or_null<ReturnStmt>(*compoundStmt->body_begin());
if (!returnStmt)
return;
auto cxxConstructExpr
= dyn_cast_or_null<CXXConstructExpr>(returnStmt->getRetValue()->IgnoreImplicit());
if (!cxxConstructExpr)
return;
if (cxxConstructExpr->getNumArgs() != 1)
return;
if (!isa<CXXNullPtrLiteralExpr>(cxxConstructExpr->getArg(0)->IgnoreImplicit()))
return;
report(DiagnosticsEngine::Warning, "empty, should be removed", methodDecl->getBeginLoc())
<< methodDecl->getSourceRange();
auto canonicalDecl = methodDecl->getCanonicalDecl();
if (canonicalDecl != methodDecl)
report(DiagnosticsEngine::Note, "definition here", canonicalDecl->getBeginLoc())
<< canonicalDecl->getSourceRange();
};
if (name == "startFastElement")
checkEmpty();
else if (name == "endFastElement")
checkEmpty();
else if (name == "characters")
checkEmpty();
else if (name == "createFastChildContext")
checkOnlyReturn();
else if (name == "createUnknownChildContext")
checkOnlyReturn();
return true;
}
bool XmlImport::VisitCXXMemberCallExpr(const CXXMemberCallExpr* callExpr)
{
auto beginLoc = callExpr->getBeginLoc();
if (!beginLoc.isValid() || ignoreLocation(callExpr))
return true;
CXXMethodDecl* methodDecl = callExpr->getMethodDecl();
if (!methodDecl || !methodDecl->getIdentifier())
return true;
auto cxxRecordDecl = methodDecl->getParent();
if (!cxxRecordDecl || !cxxRecordDecl->getIdentifier())
return true;
if (!loplugin::DeclCheck(cxxRecordDecl).Class("SvXMLImportContext"))
return true;
auto name = methodDecl->getName();
if (name == "startFastElement" || name == "characters" || name == "endFastElement"
|| name == "createFastChildContext" || name == "createUnknownChildContext"
|| name == "StartElement" || name == "EndElement" || name == "Characters"
|| name == "CreateChildContext")
{
/**
* Calling this superclass method from a subclass method will mess with the fallback logic in the superclass.
*/
report(DiagnosticsEngine::Warning, "don't call this superclass method",
callExpr->getBeginLoc())
<< callExpr->getSourceRange();
}
return true;
}
bool XmlImport::VisitBinaryOperator(const BinaryOperator* binaryOp)
{
auto beginLoc = binaryOp->getBeginLoc();
if (!beginLoc.isValid() || ignoreLocation(binaryOp))
return true;
auto op = binaryOp->getOpcode();
if (op != BO_EQ && op != BO_NE)
return true;
auto check2 = [&](const Expr* expr) -> void {
if (!isUInt16(expr))
report(DiagnosticsEngine::Warning,
"comparing XML_TOK enum to 'sal_uInt32', expected sal_uInt16",
binaryOp->getBeginLoc())
<< binaryOp->getSourceRange();
};
if (isXmlTokEnum(binaryOp->getLHS()))
check2(binaryOp->getRHS());
else if (isXmlTokEnum(binaryOp->getRHS()))
check2(binaryOp->getLHS());
return true;
}
bool XmlImport::VisitSwitchStmt(const SwitchStmt* switchStmt)
{
auto beginLoc = switchStmt->getBeginLoc();
if (!beginLoc.isValid() || ignoreLocation(switchStmt))
return true;
if (isUInt16(switchStmt->getCond()))
return true;
// if the condition is an enum type, ignore this switch
auto condEnumType = switchStmt->getCond()
->IgnoreImplicit()
->getType()
->getUnqualifiedDesugaredType()
->getAs<EnumType>();
if (condEnumType)
return true;
auto switchCaseStmt = switchStmt->getSwitchCaseList();
for (; switchCaseStmt != nullptr; switchCaseStmt = switchCaseStmt->getNextSwitchCase())
{
auto caseStmt = dyn_cast<CaseStmt>(switchCaseStmt);
if (!caseStmt)
continue;
if (!isXmlTokEnum(caseStmt->getLHS()))
continue;
report(DiagnosticsEngine::Warning,
"comparing XML_TOK enum to 'sal_uInt32', expected sal_uInt16",
caseStmt->getBeginLoc())
<< caseStmt->getSourceRange();
}
return true;
}
bool XmlImport::VisitCallExpr(const CallExpr* callExpr)
{
auto beginLoc = callExpr->getBeginLoc();
if (!beginLoc.isValid() || ignoreLocation(callExpr))
return true;
const FunctionDecl* functionDecl;
if (isa<CXXMemberCallExpr>(callExpr))
functionDecl = dyn_cast<CXXMemberCallExpr>(callExpr)->getMethodDecl();
else
functionDecl = callExpr->getDirectCallee();
if (!functionDecl)
return true;
for (unsigned i = 0; i != callExpr->getNumArgs(); ++i)
{
auto argExpr = callExpr->getArg(i)->IgnoreImplicit();
if (!isXmlTokEnum(argExpr))
continue;
// if the condition is an enum type, ignore this switch
auto condEnumType = functionDecl->getParamDecl(i)
->getType()
->getUnqualifiedDesugaredType()
->getAs<EnumType>();
if (condEnumType)
continue;
if (isUInt16(functionDecl->getParamDecl(i)->getType()))
return true;
report(DiagnosticsEngine::Warning,
"passing XML_TOK enum to 'sal_Int32', wrong param or XML token type",
callExpr->getBeginLoc())
<< callExpr->getSourceRange();
}
return true;
}
bool XmlImport::isXmlTokEnum(const Expr* expr)
{
expr = expr->IgnoreImplicit();
// check that we have an unscoped enum type
auto condEnumType = expr->getType()->getUnqualifiedDesugaredType()->getAs<EnumType>();
if (!condEnumType || condEnumType->getDecl()->isScoped())
return false;
auto declRefExpr = dyn_cast<DeclRefExpr>(expr);
if (!declRefExpr)
return false;
auto enumConstant = dyn_cast<EnumConstantDecl>(declRefExpr->getDecl());
if (!enumConstant)
return false;
return enumConstant->getIdentifier() && enumConstant->getName().startswith("XML_TOK_");
}
bool XmlImport::isUInt16(const Expr* expr)
{
expr = expr->IgnoreImplicit();
return isUInt16(expr->getType());
}
bool XmlImport::isUInt16(QualType qt)
{
if (qt->isSpecificBuiltinType(BuiltinType::UShort))
return true;
return bool(loplugin::TypeCheck(qt).Typedef("sal_uInt16"));
}
loplugin::Plugin::Registration<XmlImport> xmlimport("xmlimport");
} // namespace
#endif // LO_CLANG_SHARED_PLUGINS
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in a new issue View git blame Copy permalink