summaryrefslogtreecommitdiff
path: root/compilerplugins/clang/empty.cxx
blob: d5129d29dd3cfbb4a0c65e2b4888e9d0f0c3efed (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
 * 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 <cassert>

#include "check.hxx"
#include "plugin.hxx"

// Warn about checks whether a container is empty done via an (expensive) call to obtain the
// container's size.  For now only handles cases involving strlen.

namespace
{
BinaryOperatorKind reverse(BinaryOperatorKind op)
{
    switch (op)
    {
        case BO_LT:
            return BO_GE;
        case BO_GT:
            return BO_LE;
        case BO_LE:
            return BO_GT;
        case BO_GE:
            return BO_LT;
        case BO_EQ:
        case BO_NE:
            return op;
        default:
            abort();
    }
}

class Empty : public loplugin::FilteringPlugin<Empty>
{
public:
    explicit Empty(loplugin::InstantiationData const& data)
        : FilteringPlugin(data)
    {
    }

    bool VisitBinaryOperator(BinaryOperator const* expr)
    {
        if (expr->isRelationalOp() || expr->isEqualityOp())
        {
            visitComparison(expr);
        }
        return true;
    }

private:
    void run() override { TraverseDecl(compiler.getASTContext().getTranslationUnitDecl()); }

    void visitComparison(BinaryOperator const* expr, CallExpr const* lhs, Expr const* rhs,
                         BinaryOperatorKind op)
    {
        auto const fdecl = lhs->getDirectCallee();
        if (fdecl == nullptr)
        {
            return;
        }
        loplugin::DeclCheck dc(fdecl);
        if (!(dc.Function("strlen").StdNamespace() || dc.Function("strlen").GlobalNamespace()))
        {
            return;
        }
        if (rhs->isValueDependent())
        {
            return;
        }
        auto const val = rhs->getIntegerConstantExpr(compiler.getASTContext());
        if (!val)
        {
            return;
        }
        switch (op)
        {
            case BO_LT:
                if (val->getExtValue() == 1)
                {
                    report(DiagnosticsEngine::Warning,
                           "replace a comparison like 'strlen(e) < 1' with 'e[0] == '\\0''",
                           expr->getExprLoc())
                        << expr->getSourceRange();
                }
                break;
            case BO_GT:
                if (val->getExtValue() == 0)
                {
                    report(DiagnosticsEngine::Warning,
                           "replace a comparison like 'strlen(e) > 0' with 'e[0] != '\\0''",
                           expr->getExprLoc())
                        << expr->getSourceRange();
                }
                break;
            case BO_LE:
                if (val->getExtValue() == 0)
                {
                    report(DiagnosticsEngine::Warning,
                           "replace a comparison like 'strlen(e) <= 0' with 'e[0] == '\\0''",
                           expr->getExprLoc())
                        << expr->getSourceRange();
                }
                break;
            case BO_GE:
                if (val->getExtValue() == 1)
                {
                    report(DiagnosticsEngine::Warning,
                           "replace a comparison like 'strlen(e) >= 1' with 'e[0] != '\\0''",
                           expr->getExprLoc())
                        << expr->getSourceRange();
                }
                break;
            case BO_EQ:
                if (val->getExtValue() == 0)
                {
                    report(DiagnosticsEngine::Warning,
                           "replace a comparison like 'strlen(e) == 0' with 'e[0] == '\\0''",
                           expr->getExprLoc())
                        << expr->getSourceRange();
                }
                break;
            case BO_NE:
                if (val->getExtValue() == 0)
                {
                    report(DiagnosticsEngine::Warning,
                           "replace a comparison like 'strlen(e) != 0' with 'e[0] != '\\0''",
                           expr->getExprLoc())
                        << expr->getSourceRange();
                }
                break;
            default:
                assert(false);
        }
    }

    void visitComparison(BinaryOperator const* expr)
    {
        if (ignoreLocation(expr))
        {
            return;
        }
        if (auto const call = dyn_cast<CallExpr>(expr->getLHS()->IgnoreParenImpCasts()))
        {
            visitComparison(expr, call, expr->getRHS(), expr->getOpcode());
        }
        else if (auto const call = dyn_cast<CallExpr>(expr->getRHS()->IgnoreParenImpCasts()))
        {
            visitComparison(expr, call, expr->getLHS(), reverse(expr->getOpcode()));
        }
    }
};

loplugin::Plugin::Registration<Empty> emptyRegistration("empty");
}

#endif // LO_CLANG_SHARED_PLUGINS

/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */