summaryrefslogtreecommitdiff
path: root/compilerplugins/clang/weakbase.cxx
blob: f6f7c8db01be717ff7e7900cea9a03b111e0c34e (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
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
/* -*- 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"

/**
 * Check for multiple copies of WeakBase in base classes
 */
namespace
{
class WeakBase : public loplugin::FilteringPlugin<WeakBase>
{
public:
    explicit WeakBase(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 WeakBase::VisitCXXRecordDecl(CXXRecordDecl const* recordDecl)
{
    if (ignoreLocation(recordDecl))
    {
        return true;
    }
    //    StringRef aFileName = getFilenameOfLocation(
    //        compiler.getSourceManager().getSpellingLoc(fieldDecl->getBeginLoc()));

    //    if (loplugin::hasPathnamePrefix(aFileName, SRCDIR "/chart2/source/"))
    //        return true;
    //    if (loplugin::isSamePathname(aFileName, SRCDIR "/include/sfx2/recentdocsview.hxx"))
    //        return true;
    //    if (loplugin::isSamePathname(aFileName, SRCDIR "/include/sfx2/templatelocalview.hxx"))
    //        return true;
    //    if (loplugin::isSamePathname(aFileName, SRCDIR "/store/source/stortree.hxx")
    //        || loplugin::isSamePathname(aFileName, SRCDIR "/store/source/stordata.hxx"))
    //        return true;
    //    if (loplugin::isSamePathname(aFileName, SRCDIR "/sw/source/uibase/inc/dbtree.hxx"))
    //        return true;

    recordDecl = recordDecl->getCanonicalDecl();
    if (!recordDecl->hasDefinition())
        return true;

    int noWeakBases = 0;
    int noWeakObjects = 0;
    bool foundVirtualWeakBase = false;
    bool foundVirtualOWeakObject = false;
    std::string basePaths1;
    std::string basePaths2;
    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;
        bool isWeakBase(loplugin::DeclCheck(baseCXXRecordDecl)
                            .Struct("WeakBase")
                            .Namespace("tools")
                            .GlobalNamespace());
        bool isOWeakObject(loplugin::DeclCheck(baseCXXRecordDecl)
                               .Class("OWeakObject")
                               .Namespace("cppu")
                               .GlobalNamespace());
        if (isWeakBase)
        {
            if (cxxBaseSpecifier->isVirtual())
                foundVirtualWeakBase = true;
            else
                ++noWeakBases;
        }
        else if (isOWeakObject)
        {
            if (cxxBaseSpecifier->isVirtual())
                foundVirtualOWeakObject = true;
            else
                ++noWeakObjects;
        }
        else
            return false;
        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 (isWeakBase)
        {
            if (!basePaths1.empty())
                basePaths1 += ", ";
            basePaths1 += sPath;
        }
        else
        {
            if (!basePaths2.empty())
                basePaths2 += ", ";
            basePaths2 += sPath;
        }
        return false;
    };

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

    if (foundVirtualWeakBase && noWeakBases > 0)
        report(DiagnosticsEngine::Warning,
               "found one virtual base and one or more normal bases of tools::WeakBase, through "
               "inheritance paths %0",
               recordDecl->getBeginLoc())
            << basePaths1;
    else if (!foundVirtualWeakBase && noWeakBases > 1)
        report(DiagnosticsEngine::Warning,
               "found multiple copies of tools::WeakBase, through inheritance paths %0",
               recordDecl->getBeginLoc())
            << basePaths1;

    if (foundVirtualOWeakObject && noWeakObjects > 0)
        report(DiagnosticsEngine::Warning,
               "found one virtual base and one or more normal bases of cppu::OWeakObject, through "
               "inheritance paths %0",
               recordDecl->getBeginLoc())
            << basePaths2;
    else if (!foundVirtualOWeakObject && noWeakObjects > 1)
        report(DiagnosticsEngine::Warning,
               "found multiple copies of cppu::OWeakObject, through inheritance paths %0",
               recordDecl->getBeginLoc())
            << basePaths2;

    return true;
}

loplugin::Plugin::Registration<WeakBase> weakbase("weakbase");

} // namespace

#endif // LO_CLANG_SHARED_PLUGINS

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