Noel Grandin 91b4e45316 new loplugin: pointerbool
look for possibly bogus implicit conversions to bool when passing
(normally pointer) args to bool params.

this plugin comes in the wake of a couple of bugs caused by refactoring,
where some of the call sites were not currently updated.

Of the changes, the following are real bugs:

desktop/../dp_persmap.cxx

StartInputFieldDlg
    in sw/../fldmgr.cxx
which occurred as a result of
    commit 39d719a80d8c87856c84e3ecd569d45fa6f8a30e
    Date:   Tue May 3 11:39:37 2016 +0200
    tdf#99529 sw: don't pop up input field dialog before inserting field

CSerializationURLEncoded::encode_and_append in
    forms/../serialization_urlencoded.cxx

XclExpCFImpl::XclExpCFImpl
    in sc/../xecontent.cxx
I have no idea how to properly fix this, just made a guess.

SwDocTest::test64kPageDescs
    in sw/qa/core/uwriter.cxx
which looks like a simple copy/paste error.

Change-Id: I795ebd5ef485a1d36863dc27fe13832989f5a441
Reviewed-on: https://gerrit.libreoffice.org/48291
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Tested-by: Noel Grandin <noel.grandin@collabora.co.uk>
2018-01-23 10:41:38 +01:00

125 lines
3.8 KiB
C++

/* -*- 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.
*/
namespace
{
class PointerBool : public RecursiveASTVisitor<PointerBool>, public loplugin::Plugin
{
public:
explicit PointerBool(loplugin::InstantiationData const& data)
: Plugin(data)
{
}
virtual void run() override { 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();
arg->getType()->dump();
}
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 (arg->EvaluateAsInt(x1, compiler.getASTContext()))
{
return x1;
}
return llvm::Optional<APSInt>();
}
loplugin::Plugin::Registration<PointerBool> X("pointerbool", true);
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */