[libc++] Add _LIBCPP_ENABLE_NODISCARD and _LIBCPP_NODISCARD_EXT to allow pre-C++2a...
authorRoman Lebedev <lebedev.ri@gmail.com>
Sat, 22 Sep 2018 17:54:48 +0000 (17:54 +0000)
committerRoman Lebedev <lebedev.ri@gmail.com>
Sat, 22 Sep 2018 17:54:48 +0000 (17:54 +0000)
commitc65d39a46473cad3ff87966619f74aa7ea1a44eb
tree6dedbaf250d9ccacd74bc1587194f7a3fc05dffe
parent55b915673065eaf11a88b8beba461fd17d197ef9
[libc++] Add _LIBCPP_ENABLE_NODISCARD and _LIBCPP_NODISCARD_EXT to allow pre-C++2a [[nodiscard]]

Summary:
The `[[nodiscard]]` attribute is intended to help users find bugs where
function return values are ignored when they shouldn't be. After C++17 the
C++ standard has started to declared such library functions as `[[nodiscard]]`.
However, this application is limited and applies only to dialects after C++17.
Users who want help diagnosing misuses of STL functions may desire a more
liberal application of `[[nodiscard]]`.

For this reason libc++ provides an extension that does just that! The
extension must be enabled by defining `_LIBCPP_ENABLE_NODISCARD`. The extended
applications of `[[nodiscard]]` takes two forms:

1. Backporting `[[nodiscard]]` to entities declared as such by the
   standard in newer dialects, but not in the present one.

2. Extended applications of `[[nodiscard]]`, at the libraries discretion,
   applied to entities never declared as such by the standard.

Users may also opt-out of additional applications `[[nodiscard]]` using
additional macros.

Applications of the first form, which backport `[[nodiscard]]` from a newer
dialect may be disabled using macros specific to the dialect it was added. For
example `_LIBCPP_DISABLE_NODISCARD_AFTER_CXX17`.

Applications of the second form, which are pure extensions, may be disabled
by defining `_LIBCPP_DISABLE_NODISCARD_EXT`.

This patch was originally written by me (Roman Lebedev),
then but then reworked by Eric Fiselier.

Reviewers: mclow.lists, thakis, EricWF

Reviewed By: thakis, EricWF

Subscribers: llvm-commits, mclow.lists, lebedev.ri, EricWF, rjmccall, Quuxplusone, cfe-commits, christof

Differential Revision: https://reviews.llvm.org/D45179

llvm-svn: 342808
12 files changed:
libcxx/docs/UsingLibcxx.rst
libcxx/include/__config
libcxx/include/memory
libcxx/test/libcxx/diagnostics/enable_nodiscard.fail.cpp [new file with mode: 0644]
libcxx/test/libcxx/diagnostics/enable_nodiscard_disable_after_cxx17.fail.cpp [new file with mode: 0644]
libcxx/test/libcxx/diagnostics/enable_nodiscard_disable_nodiscard_ext.fail.cpp [new file with mode: 0644]
libcxx/test/libcxx/diagnostics/nodiscard.pass.cpp
libcxx/test/libcxx/diagnostics/nodiscard_aftercxx17.fail.cpp [moved from libcxx/test/libcxx/diagnostics/nodiscard.fail.cpp with 89% similarity]
libcxx/test/libcxx/diagnostics/nodiscard_aftercxx17.pass.cpp [new file with mode: 0644]
libcxx/test/libcxx/diagnostics/nodiscard_extensions.fail.cpp [new file with mode: 0644]
libcxx/test/libcxx/diagnostics/nodiscard_extensions.pass.cpp [new file with mode: 0644]
libcxx/utils/libcxx/test/format.py