summaryrefslogtreecommitdiff
path: root/compilerplugins/clang/refcountingbase.cxx
blob: dddc7335e8d5b98c0a68c22d04263f37a9edf3f0 (plain)
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
/* -*- 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/.
 */

#ifndef LO_CLANG_SHARED_PLUGINS

#include <string>
#include <iostream>
#include <map>
#include <set>

#include "plugin.hxx"
#include "check.hxx"
#include "clang/AST/CXXInheritance.h"

/**
 * Make sure a class does not have multiple reference-counting base classes
 */
namespace
{
class RefCountingBase : public loplugin::FilteringPlugin<RefCountingBase>
{
public:
    explicit RefCountingBase(loplugin::InstantiationData const& data)
        : FilteringPlugin(data)
    {
    }

    bool preRun() override { return compiler.getLangOpts().CPlusPlus; }

    void run() override
    {
        if (preRun())
        {
            TraverseDecl(compiler.getASTContext().getTranslationUnitDecl());
        }
    }

    bool VisitCXXRecordDecl(CXXRecordDecl const*);
};

bool RefCountingBase::VisitCXXRecordDecl(CXXRecordDecl const* recordDecl)
{
    if (ignoreLocation(recordDecl))
        return true;
    if (!recordDecl->isThisDeclarationADefinition())
        return true;

    int virtualWeakBase = 0;
    int virtualOWeakObject = 0;
    int virtualSimpleReferenceObject = 0;
    int virtualSvRefBase = 0;
    int virtualXmlImportContenxt = 0;
    int virtualVclReferenceBase = 0;
    int noRefCountingBases = 0;
    std::string basePaths;
    auto BaseMatchesCallback = [&](const CXXBaseSpecifier* cxxBaseSpecifier, CXXBasePath& Paths) {
        if (!cxxBaseSpecifier->getType().getTypePtr())
            return false;
        const CXXRecordDecl* baseCXXRecordDecl = cxxBaseSpecifier->getType()->getAsCXXRecordDecl();
        if (!baseCXXRecordDecl)
            return false;
        if (baseCXXRecordDecl->isInvalidDecl())
            return false;

        if (baseCXXRecordDecl->getName() != "WeakBase" // tools::WeakBase
            && baseCXXRecordDecl->getName() != "OWeakObject" // cppu::WeakBase
            && baseCXXRecordDecl->getName()
                   != "SimpleReferenceObject" // salhelper::SimpleReferenceObject
            && baseCXXRecordDecl->getName() != "SvRefBase" // tool::SvRefBase
            && baseCXXRecordDecl->getName() != "SvXMLImportContext" // in xmloff
            && baseCXXRecordDecl->getName() != "VclReferenceBase") // in vcl
            return false;
        if (cxxBaseSpecifier->isVirtual())
        {
            if (baseCXXRecordDecl->getName() == "WeakBase")
                virtualWeakBase = 1;
            else if (baseCXXRecordDecl->getName() != "OWeakObject")
                virtualOWeakObject = 1;
            else if (baseCXXRecordDecl->getName() != "SimpleReferenceObject")
                virtualSimpleReferenceObject = 1;
            else if (baseCXXRecordDecl->getName() != "SvRefBase")
                virtualSvRefBase = 1;
            else if (baseCXXRecordDecl->getName() != "SvXMLImportContext")
                virtualXmlImportContenxt = 1;
            else if (baseCXXRecordDecl->getName() != "VclReferenceBase")
                virtualVclReferenceBase = 1;
            else
                assert(false);
        }
        else
            ++noRefCountingBases;
        std::string sPath;
        for (CXXBasePathElement const& pathElement : Paths)
        {
            if (!sPath.empty())
            {
                sPath += "->";
            }
            if (pathElement.Class->hasDefinition())
                sPath += pathElement.Class->getNameAsString();
            else
                sPath += "???";
        }
        sPath += "->";
        sPath += baseCXXRecordDecl->getNameAsString();
        if (!basePaths.empty())
            basePaths += ", ";
        basePaths += sPath;
        return false;
    };

    CXXBasePaths aPaths;
    recordDecl->lookupInBases(BaseMatchesCallback, aPaths);

    int total = virtualWeakBase + virtualOWeakObject + virtualSimpleReferenceObject
                + virtualSvRefBase + virtualXmlImportContenxt + virtualVclReferenceBase
                + noRefCountingBases;
    if (total > 1)
    {
        report(DiagnosticsEngine::Warning,
               "this class has multiple copies of a reference-counting base class, through "
               "inheritance paths %0",
               recordDecl->getBeginLoc())
            << basePaths << recordDecl->getSourceRange();
    }
    return true;
}

loplugin::Plugin::Registration<RefCountingBase> refcountingbase("refcountingbase", true);

} // namespace

#endif // LO_CLANG_SHARED_PLUGINS

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */