summaryrefslogtreecommitdiffstats
path: root/compilerplugins/clang/pointerbool.cxx
blob: 66c6a04b3697fb374bde558efd23e67648fc1af5 (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
/* -*- 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 <clang/AST/CXXInheritance.h>
#include "plugin.hxx"
#include "check.hxx"

/**
  Look for calls where the param is bool but the call-site-arg is pointer.
*/
#ifndef LO_CLANG_SHARED_PLUGINS

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

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

    bool VisitCallExpr(CallExpr const*);

private:
    llvm::Optional<APSInt> getCallValue(const Expr* arg);
};

bool PointerBool::VisitCallExpr(CallExpr const* callExpr)
{
    if (ignoreLocation(callExpr))
        return true;
    // TODO this doesn't currently work, the args and the params don't seem to line up
    if (isa<CXXOperatorCallExpr>(callExpr))
        return true;
    const FunctionDecl* functionDecl;
    if (isa<CXXMemberCallExpr>(callExpr))
    {
        functionDecl = dyn_cast<CXXMemberCallExpr>(callExpr)->getMethodDecl();
    }
    else
    {
        functionDecl = callExpr->getDirectCallee();
    }
    if (!functionDecl)
        return true;

    unsigned len = std::min(callExpr->getNumArgs(), functionDecl->getNumParams());
    for (unsigned i = 0; i < len; ++i)
    {
        auto param = functionDecl->getParamDecl(i);
        auto paramTC = loplugin::TypeCheck(param->getType());
        if (!paramTC.AnyBoolean())
            continue;
        auto arg = callExpr->getArg(i)->IgnoreImpCasts();
        auto argTC = loplugin::TypeCheck(arg->getType());
        if (argTC.AnyBoolean())
            continue;
        // sal_Bool is sometimes disguised
        if (isa<SubstTemplateTypeParmType>(arg->getType()))
            if (arg->getType()->getUnqualifiedDesugaredType()->isSpecificBuiltinType(
                    clang::BuiltinType::UChar))
                continue;
        if (arg->getType()->isDependentType())
            continue;
        if (arg->getType()->isIntegerType())
        {
            auto ret = getCallValue(arg);
            if (ret.hasValue() && (ret.getValue() == 1 || ret.getValue() == 0))
                continue;
            // something like: priv->m_nLOKFeatures & LOK_FEATURE_DOCUMENT_PASSWORD
            if (isa<BinaryOperator>(arg->IgnoreParenImpCasts()))
                continue;
            // something like: pbEmbolden ? FcTrue : FcFalse
            if (isa<ConditionalOperator>(arg->IgnoreParenImpCasts()))
                continue;
        }
        report(DiagnosticsEngine::Warning,
               "possibly unwanted implicit conversion when calling bool param", arg->getExprLoc())
            << arg->getSourceRange();
        report(DiagnosticsEngine::Note, "method here", param->getLocation())
            << param->getSourceRange();
    }
    return true;
}

llvm::Optional<APSInt> PointerBool::getCallValue(const Expr* arg)
{
    arg = arg->IgnoreParenCasts();
    if (auto defArg = dyn_cast<CXXDefaultArgExpr>(arg))
    {
        arg = defArg->getExpr()->IgnoreParenCasts();
    }
    // ignore this, it seems to trigger an infinite recursion
    if (isa<UnaryExprOrTypeTraitExpr>(arg))
    {
        return llvm::Optional<APSInt>();
    }
    APSInt x1;
    if (compat::EvaluateAsInt(arg, x1, compiler.getASTContext()))
    {
        return x1;
    }
    return llvm::Optional<APSInt>();
}

loplugin::Plugin::Registration<PointerBool> pointerbool("pointerbool");

} // namespace

#endif // LO_CLANG_SHARED_PLUGINS

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