[cfe-dev] [llvm-dev] Should functions returning bool return true or false on success?

[Keane, Erich via cfe-dev]

IMO, bool is the wrong type to return here.  We have an unambiguous alternative here specifically for this reason: llvm::Error/llvm::ErrorSuccess.

From: cfe-dev [mailto:cfe-dev-bounces at lists.llvm.org] On Behalf Of Philip Reames via cfe-dev
Sent: Monday, September 17, 2018 11:15 AM
To: Nico Weber <thakis at chromium.org>; llvm-dev <llvm-dev at lists.llvm.org>; cfe-dev <cfe-dev at lists.llvm.org>
Subject: Re: [cfe-dev] [llvm-dev] Should functions returning bool return true or false on success?


my vote: true for success, false for failure

Philip

On 09/17/2018 10:57 AM, Nico Weber via llvm-dev wrote:
Hi,

in https://reviews.llvm.org/D52143 there's some uncertainty if LLVM code prefers

  if (!Function())
    // Call to function failed, deal with it

or

  if (Function())
    // Call to function failed, deal with it

(Note that this is about functions returning bool, not int.)

Folks on that review feel that returning true on success is probably what we want, but it's not documented anywhere and we do have both forms in the codebase.

True on success seems more common:
http://llvm-cs.pcc.me.uk/?q=true+on+success
http://llvm-cs.pcc.me.uk/?q=true+on+error

Does anyone have a pointer to previous on-list discussion on this? If not, this thread could be the place where we sort this out once and for all :-)

Apologies for the bike-sheddy topic.

Nico




_______________________________________________

LLVM Developers mailing list

llvm-dev at lists.llvm.org<mailto:llvm-dev at lists.llvm.org>

http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-dev/attachments/20180917/2d9f509d/attachment.html>