1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#include "clang/AST/Attr.h"
#include "check.hxx"
#include "plugin.hxx"
/*
Look for member functions that can be static
*/
namespace {
class StaticMethods:
public loplugin::FilteringPlugin<StaticMethods>
{
private:
bool bVisitedThis;
public:
explicit StaticMethods(loplugin::InstantiationData const & data): FilteringPlugin(data), bVisitedThis(false) {}
void run() override
{ TraverseDecl(compiler.getASTContext().getTranslationUnitDecl()); }
bool TraverseCXXMethodDecl(const CXXMethodDecl * decl);
bool VisitCXXThisExpr(const CXXThisExpr *) { bVisitedThis = true; return true; }
// these two indicate that we hit something that makes our analysis unreliable
bool VisitUnresolvedMemberExpr(const UnresolvedMemberExpr *) { bVisitedThis = true; return true; }
bool VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *) { bVisitedThis = true; return true; }
private:
StringRef getFilename(SourceLocation loc);
};
bool BaseCheckNotTestFixtureSubclass(const CXXRecordDecl *BaseDefinition) {
if (loplugin::TypeCheck(BaseDefinition).Class("TestFixture").Namespace("CppUnit").GlobalNamespace()) {
return false;
}
return true;
}
bool isDerivedFromTestFixture(const CXXRecordDecl *decl) {
if (!decl->hasDefinition())
return false;
if (// not sure what hasAnyDependentBases() does,
// but it avoids classes we don't want, e.g. WeakAggComponentImplHelper1
!decl->hasAnyDependentBases() &&
!decl->forallBases(BaseCheckNotTestFixtureSubclass)) {
return true;
}
return false;
}
StringRef StaticMethods::getFilename(SourceLocation loc)
{
SourceLocation spellingLocation = compiler.getSourceManager().getSpellingLoc(loc);
return getFilenameOfLocation(spellingLocation);
}
bool startsWith(const std::string& rStr, const char* pSubStr) {
return rStr.compare(0, strlen(pSubStr), pSubStr) == 0;
}
bool StaticMethods::TraverseCXXMethodDecl(const CXXMethodDecl * pCXXMethodDecl) {
if (ignoreLocation(pCXXMethodDecl)) {
return true;
}
if (!pCXXMethodDecl->isInstance() || pCXXMethodDecl->isVirtual() || !pCXXMethodDecl->doesThisDeclarationHaveABody() || pCXXMethodDecl->isLateTemplateParsed()) {
return true;
}
if (pCXXMethodDecl->getOverloadedOperator() != OverloadedOperatorKind::OO_None || pCXXMethodDecl->hasAttr<OverrideAttr>()) {
return true;
}
if (isa<CXXConstructorDecl>(pCXXMethodDecl) || isa<CXXDestructorDecl>(pCXXMethodDecl) || isa<CXXConversionDecl>(pCXXMethodDecl)) {
return true;
}
if (isInUnoIncludeFile(pCXXMethodDecl)) {
return true;
}
if (pCXXMethodDecl->getTemplateSpecializationKind() == TSK_ExplicitSpecialization)
return true;
// the CppUnit stuff uses macros and methods that can't be changed
if (isDerivedFromTestFixture(pCXXMethodDecl->getParent())) {
return true;
}
// don't mess with the backwards compatibility stuff
if (loplugin::isSamePathname(getFilename(compat::getBeginLoc(pCXXMethodDecl)), SRCDIR "/cppuhelper/source/compat.cxx")) {
return true;
}
// the DDE has a dummy implementation on Linux and a real one on Windows
auto aFilename = getFilename(compat::getBeginLoc(pCXXMethodDecl->getCanonicalDecl()));
if (loplugin::isSamePathname(aFilename, SRCDIR "/include/svl/svdde.hxx")) {
return true;
}
auto cdc = loplugin::DeclCheck(pCXXMethodDecl->getParent());
// special case having something to do with static initialisation
// sal/osl/all/utility.cxx
if (cdc.Class("OGlobalTimer").Namespace("osl").GlobalNamespace()) {
return true;
}
// leave the TopLeft() method alone for consistency with the other "corner" methods
if (cdc.Class("BitmapInfoAccess").GlobalNamespace()) {
return true;
}
// the unotools and svl config code stuff is doing weird stuff with a reference-counted statically allocated pImpl class
if (loplugin::hasPathnamePrefix(aFilename, SRCDIR "/include/unotools/")) {
return true;
}
if (loplugin::hasPathnamePrefix(aFilename, SRCDIR "/include/svl/")) {
return true;
}
if (loplugin::hasPathnamePrefix(aFilename, SRCDIR "/include/framework/") || loplugin::hasPathnamePrefix(aFilename, SRCDIR "/framework/")) {
return true;
}
// there is some odd stuff happening here I don't fully understand, leave it for now
if (loplugin::hasPathnamePrefix(aFilename, SRCDIR "/include/canvas/") || loplugin::hasPathnamePrefix(aFilename, SRCDIR "/canvas/")) {
return true;
}
// classes that have static data and some kind of weird reference-counting trick in its constructor
if (cdc.Class("LinguOptions").GlobalNamespace()
|| (cdc.Class("EditableExtendedColorConfig").Namespace("svtools")
.GlobalNamespace())
|| (cdc.Class("ExtendedColorConfig").Namespace("svtools")
.GlobalNamespace())
|| cdc.Class("SvtMiscOptions").GlobalNamespace()
|| cdc.Class("SvtAccessibilityOptions").GlobalNamespace()
|| cdc.Class("ColorConfig").Namespace("svtools").GlobalNamespace()
|| cdc.Class("SvtOptionsDrawinglayer").GlobalNamespace()
|| cdc.Class("SvtMenuOptions").GlobalNamespace()
|| cdc.Class("SvtToolPanelOptions").GlobalNamespace()
|| cdc.Class("SvtSlideSorterBarOptions").GlobalNamespace()
|| (cdc.Class("SharedResources").Namespace("connectivity")
.GlobalNamespace())
|| (cdc.Class("OParseContextClient").Namespace("svxform")
.GlobalNamespace())
|| cdc.Class("OLimitedFormats").Namespace("frm").GlobalNamespace())
{
return true;
}
auto fdc = loplugin::DeclCheck(pCXXMethodDecl);
// only empty on Linux, not on windows
if ((fdc.Function("GetVisualRepresentationInNativeFormat_Impl")
.Class("OleEmbeddedObject").GlobalNamespace())
|| (fdc.Function("GetRidOfComponent").Class("OleEmbeddedObject")
.GlobalNamespace())
|| (fdc.Function("isProfileLocked").Class("ProfileAccess")
.Namespace("mozab").Namespace("connectivity").GlobalNamespace())
|| cdc.Class("SbxDecimal").GlobalNamespace()
|| fdc.Function("Call").Class("SbiDllMgr").GlobalNamespace()
|| fdc.Function("FreeDll").Class("SbiDllMgr").GlobalNamespace()
|| (fdc.Function("InitializeDde").Class("SfxApplication")
.GlobalNamespace())
|| (fdc.Function("RemoveDdeTopic").Class("SfxApplication")
.GlobalNamespace())
|| (fdc.Function("UpdateSkiaStatus").Class("OfaViewTabPage")
.GlobalNamespace())
|| (fdc.Function("ReleaseData").Class("ScannerManager")
.GlobalNamespace()))
{
return true;
}
// debugging stuff
if (fdc.Function("dump").Class("InternalData").Namespace("chart")
.GlobalNamespace())
{
return true;
}
// used in a function-pointer-table
if ((cdc.Class("SbiRuntime").GlobalNamespace()
&& startsWith(pCXXMethodDecl->getNameAsString(), "Step"))
|| (cdc.Class("OoxFormulaParserImpl").AnonymousNamespace().Namespace("xls").Namespace("oox")
.GlobalNamespace())
|| cdc.Class("SwTableFormula").GlobalNamespace()
|| (cdc.Class("BiffFormulaParserImpl").Namespace("xls").Namespace("oox")
.GlobalNamespace())
|| (fdc.Function("Read_F_Shape").Class("SwWW8ImplReader")
.GlobalNamespace())
|| (fdc.Function("Read_Majority").Class("SwWW8ImplReader")
.GlobalNamespace())
|| fdc.Function("Ignore").Class("SwWrtShell").GlobalNamespace())
{
return true;
}
// have no idea why this can't be static, but 'make check' fails with it so...
if (fdc.Function("resolveRelationshipsOfTypeFromOfficeDoc").Class("Shape")
.Namespace("drawingml").Namespace("oox").GlobalNamespace())
{
return true;
}
// template magic
if (fdc.Function("getValue").Class("ColumnBatch").GlobalNamespace()
|| cdc.Class("TitleImpl").GlobalNamespace()
|| (fdc.Function("getDefaultPropertyName").Class("DefaultReturnHelper")
.Namespace("vba").Namespace("ooo").GlobalNamespace()))
{
return true;
}
// depends on config options
if ((fdc.Function("autoInstallFontLangSupport").Class("PrintFontManager")
.Namespace("psp").GlobalNamespace())
|| fdc.Function("AllocateFrame").Class("GtkSalFrame").GlobalNamespace()
|| (fdc.Function("TriggerPaintEvent").Class("GtkSalFrame")
.GlobalNamespace()))
{
return true;
}
bVisitedThis = false;
TraverseStmt(pCXXMethodDecl->getBody());
if (bVisitedThis) {
return true;
}
report(
DiagnosticsEngine::Warning,
"this member function can be declared static",
pCXXMethodDecl->getCanonicalDecl()->getLocation())
<< pCXXMethodDecl->getCanonicalDecl()->getSourceRange();
FunctionDecl const * def;
if (pCXXMethodDecl->isDefined(def)
&& def != pCXXMethodDecl->getCanonicalDecl())
{
report(DiagnosticsEngine::Note, "defined here:", def->getLocation())
<< def->getSourceRange();
}
return true;
}
loplugin::Plugin::Registration<StaticMethods> X("staticmethods");
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|