summaryrefslogtreecommitdiff
path: root/compilerplugins/clang/commaoperator.cxx
blob: 3ba1c89c4be2b28b79206d7bfe4d4c1a2c8d7a51 (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
/* -*- 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 <cassert>
#include <string>
#include <iostream>
#include <fstream>
#include <set>

#include "plugin.hxx"

/**
the comma operator is best used sparingly
*/

namespace {

Stmt const * lookThroughExprWithCleanups(Stmt const * stmt) {
    if (auto const e = dyn_cast_or_null<ExprWithCleanups>(stmt)) {
        return e->getSubExpr();
    }
    return stmt;
}

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

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

    bool TraverseForStmt(ForStmt * stmt) {
        auto const saved1 = ignore1_;
        ignore1_ = lookThroughExprWithCleanups(stmt->getInit());
        auto const saved2 = ignore2_;
        ignore2_ = lookThroughExprWithCleanups(stmt->getInc());
        auto const ret = RecursiveASTVisitor::TraverseForStmt(stmt);
        ignore1_ = saved1;
        ignore2_ = saved2;
        return ret;
    }

    bool TraverseWhileStmt(WhileStmt * stmt) {
        auto const saved1 = ignore1_;
        ignore1_ = lookThroughExprWithCleanups(stmt->getCond());
        auto const ret = RecursiveASTVisitor::TraverseWhileStmt(stmt);
        ignore1_ = saved1;
        return ret;
    }

    bool TraverseParenExpr(ParenExpr * expr) {
        auto const saved1 = ignore1_;
        ignore1_ = expr->getSubExpr();
        auto const ret = RecursiveASTVisitor::TraverseParenExpr(expr);
        ignore1_ = saved1;
        return ret;
    }

    bool TraverseBinaryOperator(BinaryOperator * expr) {
        if (expr->getOpcode() != BO_Comma) {
            return RecursiveASTVisitor::TraverseBinaryOperator(expr);
        }
        if (!WalkUpFromBinaryOperator(expr)) {
            return false;
        }
        auto const saved1 = ignore1_;
        ignore1_ = expr->getLHS();
        auto const ret = TraverseStmt(expr->getLHS())
            && TraverseStmt(expr->getRHS());
        ignore1_ = saved1;
        return ret;
    }

    bool VisitBinaryOperator(const BinaryOperator* );

private:
    Stmt const * ignore1_ = nullptr;
    Stmt const * ignore2_ = nullptr;
};

bool CommaOperator::VisitBinaryOperator(const BinaryOperator* binaryOp)
{
    if (binaryOp->getOpcode() != BO_Comma) {
        return true;
    }
    if (binaryOp == ignore1_ || binaryOp == ignore2_) {
        return true;
    }
    if (ignoreLocation(binaryOp)) {
        return true;
    }
    // Ignore FD_SET expanding to "...} while(0, 0)" in some Microsoft
    // winsock2.h (TODO: improve heuristic of determining that the whole
    // binaryOp is part of a single macro body expansion):
    if (compiler.getSourceManager().isMacroBodyExpansion(
            binaryOp->getBeginLoc())
        && compiler.getSourceManager().isMacroBodyExpansion(
            binaryOp->getOperatorLoc())
        && compiler.getSourceManager().isMacroBodyExpansion(
            binaryOp->getEndLoc())
        && ignoreLocation(
            compiler.getSourceManager().getSpellingLoc(
                binaryOp->getOperatorLoc())))
    {
        return true;
    }
    report(
        DiagnosticsEngine::Warning, "comma operator hides code",
        binaryOp->getOperatorLoc())
      << binaryOp->getSourceRange();
    return true;
}


loplugin::Plugin::Registration< CommaOperator > X("commaoperator", true);

}

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