diff --git a/libcxx/docs/ReleaseNotes.rst b/libcxx/docs/ReleaseNotes.rst index 9a77a5c23f30b..47042c4af1649 100644 --- a/libcxx/docs/ReleaseNotes.rst +++ b/libcxx/docs/ReleaseNotes.rst @@ -4,7 +4,6 @@ .. toctree:: :hidden: - ReleaseNotes/18 ReleaseNotes/19 .. The release notes are in versioned files, but we make sure to keep publishing diff --git a/libcxx/docs/ReleaseNotes/18.rst b/libcxx/docs/ReleaseNotes/18.rst deleted file mode 100644 index 4f7b9b362e5e6..0000000000000 --- a/libcxx/docs/ReleaseNotes/18.rst +++ /dev/null @@ -1,345 +0,0 @@ -=========================================== -Libc++ 18.0.0 (In-Progress) Release Notes -=========================================== - -.. contents:: - :local: - :depth: 2 - -Written by the `Libc++ Team `_ - -.. warning:: - - These are in-progress notes for the upcoming libc++ 18.0.0 release. - Release notes for previous releases can be found on - `the Download Page `_. - -Introduction -============ - -This document contains the release notes for the libc++ C++ Standard Library, -part of the LLVM Compiler Infrastructure, release 18.0.0. Here we describe the -status of libc++ in some detail, including major improvements from the previous -release and new feature work. For the general LLVM release notes, see `the LLVM -documentation `_. All LLVM releases may -be downloaded from the `LLVM releases web site `_. - -For more information about libc++, please see the `Libc++ Web Site -`_ or the `LLVM Web Site `_. - -Note that if you are reading this file from a Git checkout or the -main Libc++ web page, this document applies to the *next* release, not -the current one. To see the release notes for a specific release, please -see the `releases page `_. - -What's New in Libc++ 18.0.0? -============================== - -The main focus of the libc++ team has been to implement new C++20, C++23, -and C++26 features. - -New hardened modes for the library have been added, replacing the legacy debug mode that was -removed in the LLVM 17 release. Unlike the legacy debug mode, some of these hardening modes are -also intended to be used in production. See :ref:`hardening` for more details. - -Work on the ranges support has progressed. See -:ref:`ranges-status` for the current status. - -Work on the experimental C++23 module support has progressed. The ``std.compat`` -module is available and the feature is retroactively available in C++20. See -:ref:`ModulesInLibcxx` for more information. - -Work on the experimental C++17 Parallel STL has progressed. See -:ref:`pstl-status` for the current status. - -Work on the experimental C++17 SIMD support has progressed. See -:ref:`parallelism-status` for the current status. - - -Implemented Papers ------------------- -- P2093R14 - Formatted output -- P2539R4 - Should the output of ``std::print`` to a terminal be synchronized with the underlying stream? -- P2497R0 - Testing for success or failure of ```` functions -- P2697R1 - Interfacing ``bitset`` with ``string_view`` -- P2443R1 - ``views::chunk_by`` -- P2538R1 - ADL-proof ``std::projected`` -- P2614R2 - Deprecate ``numeric_limits::has_denorm`` -- P0053R7 - C++ Synchronized Buffered Ostream (in the experimental library) -- P2467R1 - Support exclusive mode for fstreams -- P0020R6 - Floating Point Atomic -- P2905R2 - Runtime format strings -- P2918R2 - Runtime format strings II -- P2871R3 - Remove Deprecated Unicode Conversion Facets from C++26 -- P2870R3 - Remove ``basic_string::reserve()`` -- P2909R4 - Fix formatting of code units as integers (Dude, where’s my ``char``?) -- P2821R5 - ``span.at()`` -- P0521R0 - Proposed Resolution for CA 14 (``shared_ptr`` ``use_count/unique``) -- P0543R3 - Saturation arithmetic -- P1759R6 - Native handles and file streams -- P2868R3 - Remove Deprecated ``std::allocator`` Typedef From C++26 -- P2517R1 - Add a conditional ``noexcept`` specification to ``std::apply`` -- P2447R6 - ``span`` over initializer list - - -Improvements and New Features ------------------------------ - -- ``std::ranges::count`` and ``std::ranges::find`` are now optimized for - ``std::vector::iterator``, which can lead up to 350x performance - improvements. - -- ``std::for_each`` has been optimized for segmented iterators like ``std::deque::iterator`` in C++23 and - later, which can lead up to 40x performance improvements. - -- The library now provides several hardening modes under which common cases of library undefined behavior will be turned - into a reliable program termination. The ``fast`` hardening mode enables a set of security-critical checks with - minimal runtime overhead; the ``extensive`` hardening mode additionally enables relatively cheap checks that catch - common logic errors but aren't necessarily security-critical; and the ``debug`` hardening mode enables all available - checks, some of which might be very expensive. Vendors can configure which hardening mode is enabled by default with - the ``LIBCXX_HARDENING_MODE`` variable at CMake configuration time. Users can control which hardening mode is enabled - on a per translation unit basis using the ``_LIBCPP_HARDENING_MODE`` macro. See :ref:`the hardening documentation - ` for more details. - -- The ``_LIBCPP_ENABLE_CXX26_REMOVED_CODECVT`` macro has been added to make - the declarations in ```` available. - -- The ``_LIBCPP_ENABLE_CXX26_REMOVED_STRING_RESERVE`` macro has been added to make - the function ``std::basic_string<...>::reserve()`` available. - -- The ``_LIBCPP_ENABLE_CXX26_REMOVED_ALLOCATOR_MEMBERS`` macro has been added to make - the function ``allocator::is_always_equal`` available. - -- The ``_LIBCPP_ENABLE_CXX20_REMOVED_SHARED_PTR_UNIQUE`` macro has been added to make - the function ``std::shared_ptr<...>::unique()`` available. - -- The cmake option ``LIBCXX_ENABLE_STD_MODULES`` has been removed. The test - infrastructure no longer depends on a modern CMake, it works with the minimal - required LLVM version (3.20.0). - -- The ``.cppm`` files of experimental standard library modules can now be - installed. By default, they are not installed. This can be enabled by - configuring CMake with ``-DLIBCXX_INSTALL_MODULES=ON``. The installation - directory can be configured with the CMake option - ``-DLIBCXX_INSTALL_MODULE_DIR=``. The default location is - ``${PREFIX}/share/libc++/v1``. - -- AddressSanitizer annotations have been added to ``std::basic_string``. - These annotations are enabled for all allocators by default. - It's only enabled for long strings, strings using the small buffer optimization are not annotated. - -- The libc++ source code has been formatted with ``clang-format``. This - `discourse thread `_ - contains information how to rebase downstream patches. - -Deprecations and Removals -------------------------- - -- Availability macros which will never trigger an error have been removed. This includes anything that has been - introduced before macOS 10.13, iOS 12, tvOS 12 and watchOS 4. This shouldn't affect anybody, since AppleClang 15 - doesn't support any older OSes. If you are a vendor and make use of these macros, please inform the libc++ team so we - can re-introduce them and consider upstreaming support for your platform. - -- The non-conforming constructor ``std::future_error(std::error_code)`` has been removed. Please use the - ``std::future_error(std::future_errc)`` constructor provided in C++17 instead. - -- `P1957 `_ has been implemented in Clang and libc++ removed a code path that led to - narrowing conversions in ``std::variant`` behaving in a non-standard way. This may change how some uses of - ``std::variant``'s constructor behave in user code. The ``_LIBCPP_ENABLE_NARROWING_CONVERSIONS_IN_VARIANT`` - macro is provided to restore the previous behavior, and it will be supported in the LLVM 18 release only. - In LLVM 19 and beyond, ``_LIBCPP_ENABLE_NARROWING_CONVERSIONS_IN_VARIANT`` will not be honored anymore. - -- Overriding ``__libcpp_verbose_abort`` no longer has any effect on library assertions. The only supported way - to customize the assertion handler that gets invoked when a hardening assertion fails is now by setting the - ``LIBCXX_ASSERTION_HANDLER_FILE`` CMake variable and providing a custom header. See the documentation on - overriding the default assertion handler for details. The ability to override ``__libcpp_verbose_abort`` - will be removed in an upcoming release in favor of the new overriding mechanism. - -- In safe mode (which is now equivalent to the ``extensive`` hardening mode), a failed assertion will now - generate a trap rather than a call to verbose abort. - -- The ``_LIBCPP_AVAILABILITY_CUSTOM_VERBOSE_ABORT_PROVIDED`` macro is not honored anymore in LLVM 18. - Please see the updated documentation about the hardening modes in libc++ and in particular on - overriding the default assertion handler. - -- The headers ````, ````, ````, - ````, ````, ````, ````, - ````, ````, ````, - and ```` have been removed in LLVM 18, as all their contents will have been - implemented in namespace ``std`` for at least two releases. - -- The macro ``_LIBCPP_ENABLE_CXX20_REMOVED_ALLOCATOR_MEMBERS`` has been deprecated and will be removed - in LLVM 19. This macro used to re-enable redundant members of ``std::allocator`` like ``pointer``, - ``reference``, ``rebind``, ``address``, ``max_size``, ``construct``, ``destroy``, and the two-argument - overload of ``allocate``. However, this led to the library being non-conforming due to incorrect - constexpr-ness. - -- The macros ``_LIBCPP_ENABLE_CXX17_REMOVED_FEATURES`` and - ``_LIBCPP_ENABLE_CXX20_REMOVED_FEATURES`` have been deprecated and - will be removed in LLVM 19. These macros used to re-enable all features - that were removed in the C++17 and C++20 standards. Instead of using these - macros, please use the macros to re-enable individual features. - -- The macro ``_LIBCPP_INLINE_VISIBILITY`` has been deprecated in LLVM 18 and - will be removed entirely in LLVM 19. The macro ``_LIBCPP_HIDE_FROM_ABI`` is - the drop-in replacement. - -- The macro ``_VSTD`` has been deprecated in LLVM 18 and will be removed - entirely in LLVM 19. The code ``std`` is the drop-in replacement. - - -Upcoming Deprecations and Removals ----------------------------------- - -- The ability to override ``__libcpp_verbose_abort`` will be removed in an upcoming release. - -LLVM 19 -~~~~~~~ - -- The ``LIBCXX_EXECUTOR`` CMake variable has been deprecated. LLVM 19 will - completely remove support for the ``*_EXECUTOR`` variables. - -- The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable that was used to enable the safe mode will be deprecated and setting - it will trigger an error; use the ``LIBCXX_HARDENING_MODE`` variable with the value ``extensive`` instead. Similarly, - the ``_LIBCPP_ENABLE_ASSERTIONS`` macro will be deprecated (setting it to ``1`` still enables the extensive mode in - the LLVM 19 release while also issuing a deprecation warning). See :ref:`the hardening documentation - ` for more details. - -- The base template for ``std::char_traits`` has been marked as deprecated and will be removed in LLVM 19. If you - are using ``std::char_traits`` with types other than ``char``, ``wchar_t``, ``char8_t``, ``char16_t``, ``char32_t`` - or a custom character type for which you specialized ``std::char_traits``, your code will stop working when we - remove the base template. The Standard does not mandate that a base template is provided, and such a base template - is bound to be incorrect for some types, which could currently cause unexpected behavior while going undetected. - Note that the ``_LIBCPP_CHAR_TRAITS_REMOVE_BASE_SPECIALIZATION`` macro can be defined in LLVM 18 to eagerly remove - the specialization and prepare code bases for the unconditional removal in LLVM 19. - -- The ``_LIBCPP_ENABLE_NARROWING_CONVERSIONS_IN_VARIANT`` macro that changed the behavior for narrowing conversions - in ``std::variant`` will be removed in LLVM 19. - -- The ``_LIBCPP_ENABLE_CXX20_REMOVED_ALLOCATOR_MEMBERS`` macro has been deprecated in LLVM 18 and will be removed - entirely in LLVM 19. - -- The ``_LIBCPP_ENABLE_CXX17_REMOVED_FEATURES`` and - ``_LIBCPP_ENABLE_CXX20_REMOVED_FEATURES`` macros have been deprecated - in LLVM 18 and will be removed entirely in LLVM 19. - -- The macro ``_LIBCPP_INLINE_VISIBILITY`` has been deprecated in LLVM 18 and - will be removed entirely in LLVM 19. - -- The macro ``_VSTD`` has been deprecated in LLVM 18 and will be removed - entirely in LLVM 19. - -LLVM 20 -~~~~~~~ - -- The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable and the ``_LIBCPP_ENABLE_ASSERTIONS`` macro that were used to enable - the safe mode will be removed. - - -ABI Affecting Changes ---------------------- - -- When the shared/static library is built with ``-fno-exceptions``, the behavior of ``operator new`` was changed - to make it standards-conforming. In LLVM 17 and before, the throwing versions of ``operator new`` would return - ``nullptr`` upon failure to allocate, when the shared/static library was built with exceptions disabled. This - was non-conforming, since the throwing versions of ``operator new`` are never expected to return ``nullptr``, and - this non-conformance could actually lead to miscompiles in subtle cases. - - Starting in LLVM 18, the throwing versions of ``operator new`` will abort the program when they fail to allocate - if the shared/static library has been built with ``-fno-exceptions``. This is consistent with the behavior of all - other potentially-throwing functions in the library, which abort the program instead of throwing when ``-fno-exceptions`` - is used. - - Furthermore, when the shared/static library is built with ``-fno-exceptions``, users who override the throwing - version of ``operator new`` will now need to also override the ``std::nothrow_t`` version of ``operator new`` if - they want to use it. Indeed, this is because there is no way to implement a conforming ``operator new(nothrow)`` - from a conforming potentially-throwing ``operator new`` when compiled with ``-fno-exceptions``. In that case, using - ``operator new(nothrow)`` without overriding it explicitly but after overriding the throwing ``operator new`` will - result in an error. - - Note that this change only impacts vendors/users that build the shared/static library themselves and pass - ``-DLIBCXX_ENABLE_EXCEPTIONS=OFF``, which is not the default configuration. If you are using the default - configuration of the library, the libc++ shared/static library will be built with exceptions enabled, and - there is no change between LLVM 17 and LLVM 18, even for users who build their own code using ``-fno-exceptions``. - -- The symbol of a non-visible function part of ``std::system_error`` was removed. - This is not a breaking change as the private function ``__init`` was never referenced internally outside of the dylib. - -- This release of libc++ added missing visibility annotations on some types in the library. Users compiling with - ``-fvisbility=hidden`` may notice that additional type infos from libc++ are being exported from their ABI. This is - the correct behavior in almost all cases since exporting the RTTI is required for these types to work properly with - ``dynamic_cast``, exceptions and other mechanisms across binaries. However, if you intend to use libc++ purely as an - internal implementation detail (i.e. you use libc++ as a static archive and never export libc++ symbols from your ABI) - and you notice changes to your exported symbols list, then this means that you were not properly preventing libc++ - symbols from being part of your ABI. - -- The name mangling for instantiations of ``std::projected`` has changed in order to implement P2538R1. This technically - results in an ABI break, however in practice we expect uses of ``std::projected`` in ABI-sensitive places to be - extremely rare. Any error resulting from this change should result in a link-time error. - -- The internal alignment requirements for heap allocations inside ``std::string`` has decreased from 16 to 8. This - saves memory since string requests fewer additional bytes than it did previously. However, this also changes the - return value of ``std::string::max_size`` and can cause code compiled against older libc++ versions but linked at - runtime to a new version to throw a different exception when attempting allocations that are too large - (``std::bad_alloc`` vs ``std::length_error``). - -- The layout of some range adaptors that use the ``movable-box`` exposition-only type as an implementation - detail has changed in order to fix a `bug `_ which could result in - overwriting user data following the ``movable-box``. - This bug was caused by incorrect usage of the ``[[no_unique_address]]`` attribute inside the implementation of ``movable-box``. - This fix affects the layout of the following views: ``take_while_view``, ``filter_view``, ``single_view``, ``drop_while_view``, - ``repeat_view``, ``transform_view``, ``chunk_by_view``. In order to avoid silent breakage as a result of this fix, an ABI tag has been added to - these views such that their mangled name will be different starting in this version of libc++. - As a result, attempting to call a function that expects one of these views will fail to link until the code has been rebuilt - against a matching version of libc++. In practice, we believe it is unusual for these views to appear at ABI boundaries so this - should not be a major problem for most users. However it is probably worth auditing ranges-heavy code for ABI boundaries that - would contain these views, or for types that contain these views as members and which are passed across ABI boundaries. - -- Some properties of libc++ may cause ODR-violations when mixing multiple libc++ - instances. To avoid these, often benign, ODR-violations the ODR-affecting - properties are now part of the ABI tag. The ODR-affecting properties are: - - - library version (This was part of the ABI tag prior to LLVM 18.) - - exceptions vs no-exceptions - - hardening mode - - This should not be ABI-affecting except that libc++ will be more robust - against different configurations of it being used in different translation - units. - -- The amount of padding bytes available for use at the end of certain ``std::expected`` instantiations has changed in this - release. This is an ABI break for any code that held a ``std::expected`` member with ``[[no_unique_address]]`` in an - ABI-facing type. In those cases, the layout of the enclosing type will change, breaking the ABI. However, the - ``std::expected`` member requires a few characteristics in order to be affected by this change: - - - A type equivalent to ``union {T ; E}`` needs to have more than one byte of padding available. - - The ``std::expected`` member must have been in a situation where its padding bytes were previously reused by - another object, which can happen in a few cases (this is probably not exhaustive): - - - It is a member with ``[[no_unique_address]]`` applied to it, and it is followed by another data member, or - - It is a member with ``[[no_unique_address]]`` applied to it, and it is the last member of the user-defined type, - and that user-defined type is used in ways that its padding bytes can be reused, or - - It is inherited from - - We expect that this will not be a very frequent occurrence. However, there is unfortunately no technique we can use - in the library to catch such misuse. Indeed, even applying an ABI tag to ``std::expected`` would not help since ABI - tags are not propagated to containing types. As a result, if you notice very difficult to explain bugs around the - usage of a ``std::expected``, you should consider checking whether you are hitting this ABI break. This change was - done to fix `#70494 `_ and the vendor communication is handled - in `#70820 `_. - - -Build System Changes --------------------- - -- The ``LIBCXX_EXECUTOR`` CMake variable has been deprecated. If you are relying on this, the new replacement is - passing ``-Dexecutor=...`` to ``llvm-lit``. Alternatively, this flag can be made persistent in the generated test - configuration file by passing ``-DLIBCXX_TEST_PARAMS=executor=...``. This also applies to the ``LIBUWIND_EXECTOR`` - and ``LIBCXXABI_EXECUTOR`` CMake variables. LLVM 19 will completely remove support for the ``*_EXECUTOR`` variables. - -- ``LIBCXXABI_USE_LLVM_UNWINDER`` and ``COMPILER_RT_USE_LLVM_UNWINDER`` switched defaults from ``OFF`` to ``ON``. - This means that by default, libc++abi and compiler-rt will link against the LLVM provided ``libunwind`` library - instead of the system-provided unwinding library. If you are building the LLVM runtimes with the goal of shipping - them so that they can interoperate with other system-provided libraries that might be using a different unwinding - library (such as ``libgcc_s``), you should pass ``LIBCXXABI_USE_LLVM_UNWINDER=OFF`` and ``COMPILER_RT_USE_LLVM_UNWINDER=OFF`` - to make sure the system-provided unwinding library is used by the LLVM runtimes. diff --git a/libcxx/docs/ReleaseNotes/19.rst b/libcxx/docs/ReleaseNotes/19.rst index 3d79def336a87..e167d21e39f93 100644 --- a/libcxx/docs/ReleaseNotes/19.rst +++ b/libcxx/docs/ReleaseNotes/19.rst @@ -40,8 +40,7 @@ and C++26 features. Experimental support for the time zone database has progressed. -Work on the ranges support has progressed. See -:ref:`ranges-status` for the current status. +Work on the ranges support has progressed. Work on the experimental C++17 Parallel STL has progressed. See :ref:`pstl-status` for the current status. diff --git a/libcxx/docs/Status/Ranges.rst b/libcxx/docs/Status/Ranges.rst deleted file mode 100644 index cdbf68393b739..0000000000000 --- a/libcxx/docs/Status/Ranges.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. _ranges-status: - -================================ -libc++ Ranges Status -================================ - -.. include:: ../Helpers/Styles.rst - -.. contents:: - :local: - - -Overview -================================ - -This document contains the status of the Ranges library in libc++. It is used to track -both the status of the sub-projects of the ranges library and who is assigned to these -sub-projects. This is imperative to effective implementation so that work is not -duplicated and implementors are not blocked by each other. - -If you are interested in contributing to the libc++ Ranges library, please send a message -to the #libcxx channel in the LLVM discord. Please *do not* start working on any of the -*assigned* items below. - - -Major features -======================================= - -.. csv-table:: - :file: RangesMajorFeatures.csv - :header-rows: 1 - :widths: auto - -Views -======================================= - -.. csv-table:: - :file: RangesViews.csv - :header-rows: 1 - :widths: auto - -Algorithms -======================================= - -.. csv-table:: - :file: RangesAlgorithms.csv - :header-rows: 1 - :widths: auto diff --git a/libcxx/docs/Status/RangesAlgorithms.csv b/libcxx/docs/Status/RangesAlgorithms.csv deleted file mode 100644 index 469ea21a76aab..0000000000000 --- a/libcxx/docs/Status/RangesAlgorithms.csv +++ /dev/null @@ -1,18 +0,0 @@ -Standard,Algorithm,Assignee,CL,Status -C++20,all C++20 algorithms,N/A,N/A,✅ -C++23,`find_last `_,Nicole Mazzuca,`#99312 `_,Complete -C++23,`find_last_if `_,Nicole Mazzuca,`#99312 `_,Complete -C++23,`find_last_if_not `_,Nicole Mazzuca,`#99312 `_,Complete -C++23,`starts_with `_,Zijun Zhao,`D150735 `_,Complete -C++23,`ends_with `_,Zijun Zhao, `D150831 `_,Complete -C++23,`shift_left `_,Unassigned,No patch yet,Not started -C++23,`shift_right `_,Unassigned,No patch yet,Not started -C++23,`iota (algorithm) `_,Unassigned,No patch yet,Not started -C++23,`fold `_,Unassigned,No patch yet,Not started -C++23,`contains `_,Zijun Zhao, `#65148 `_,Complete -C++23,`fold_left_with_iter `_,Christopher Di Bella,N/A,Complete -C++23,`fold_left `_,Christopher Di Bella,N/A,Complete -C++23,`fold_left_first_with_iter `_,Christopher Di Bella,N/A,In progress -C++23,`fold_left_first `_,Christopher Di Bella,N/A,In progress -C++23,`fold_right `_,Christopher Di Bella,N/A,In progress -C++23,`fold_right_last `_,Christopher Di Bella,N/A,In progress diff --git a/libcxx/docs/Status/RangesMajorFeatures.csv b/libcxx/docs/Status/RangesMajorFeatures.csv deleted file mode 100644 index d00fbce9edf48..0000000000000 --- a/libcxx/docs/Status/RangesMajorFeatures.csv +++ /dev/null @@ -1,5 +0,0 @@ -Standard,Name,Assignee,CL,Status -C++23,`ranges::to `_,Konstantin Varlamov,`D142335 `_,Complete -C++23,`Pipe support for user-defined range adaptors `_,"Louis Dionne, Jakub Mazurkiewicz, and Xiaoyang Liu",Various,Complete -C++23,`Formatting Ranges `_,Mark de Wever,Various,Complete -C++20,`Stashing stashing iterators for proper flattening `_,Jakub Mazurkiewicz,Various,In progress diff --git a/libcxx/docs/Status/RangesViews.csv b/libcxx/docs/Status/RangesViews.csv deleted file mode 100644 index f141656eb131a..0000000000000 --- a/libcxx/docs/Status/RangesViews.csv +++ /dev/null @@ -1,38 +0,0 @@ -Standard,View,Assignee,CL,Status -C++20,`empty `_,Zoe Carver,`D103208 `_,✅ -C++20,`single `_,Zoe Carver,`D106840 `_,✅ -C++20,`iota (view) `_,Zoe Carver,`D107396 `_,✅ -C++20,`all `_,Zoe Carver,`D102028 `_,✅ -C++20,`ref_view `_,Zoe Carver,`D102020 `_,✅ -C++20,`owning_view `_,Arthur O'Dwyer,`D116894 `_,✅ -C++20,`filter `_,Louis Dionne,`D109086 `_,✅ -C++20,`transform `_,Zoe Carver,`D103056 `_,✅ -C++20,`take `_,Zoe Carver,`D106507 `_,✅ -C++20,`take_while `_,Hui Xie,`D134952 `_,✅ -C++20,`drop `_,Zoe Carver,`D102037 `_,✅ -C++20,`drop_while `_,Hui Xie,`D135460 `_,✅ -C++20,`join `_,Zoe Carver,`D107671 `_,✅ -C++20,`split `_,Hui Xie,`D142063 `_,✅ -C++20,`lazy_split `_,Zoe Carver and Konstantin Varlamov,`D107500 `_,✅ -C++20,`counted `_,Zoe Carver,`D106923 `_,✅ -C++20,`common `_,Zoe Carver,`D105753 `_,✅ -C++20,`reverse `_,Zoe Carver,`D107096 `_,✅ -C++20,`elements / keys / values `_,Hui Xie,`D136268 `_,✅ -C++20,`istream `_,Hui Xie,`D133317 `_,✅ -,,,, -,,,, -,,,, -C++23,`repeat `_,Yrong,`D141699 `_,✅ -C++23,`cartesian_product `_,Unassigned,No patch yet,Not started -C++23,`zip `_,Hui Xie,`D122806 `_,✅ -C++23,`zip_transform `_,Hui Xie,No patch yet,Not started -C++23,`adjacent `_,Hui Xie,No patch yet,Not started -C++23,`adjacent_transform `_,Hui Xie,No patch yet,Not started -C++23,`join_with `_,Jakub Mazurkiewicz,`65536 `_,In progress -C++23,`slide `_,Will Hawkins,`67146 `_,In Progress -C++23,`chunk `_,Unassigned,No patch yet,Not started -C++23,`chunk_by `_,Jakub Mazurkiewicz,`D144767 `_,✅ -C++23,`as_const `_,Unassigned,No patch yet,Not started -C++23,`as_rvalue `_,Nikolas Klauser,`D137637 `_,✅ -C++23,`stride `_,Hristo Hristov and Will Hawkins,`D156924 `_,In Progress -C++23,`enumerate `_,Hristo Hristov,`D157193 `_,In Progress diff --git a/libcxx/docs/Status/Spaceship.rst b/libcxx/docs/Status/Spaceship.rst deleted file mode 100644 index d596c1128dbf6..0000000000000 --- a/libcxx/docs/Status/Spaceship.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. spaceship-status: - -============================================== -libc++ Spaceship Operator Status (operator<=>) -============================================== - -.. include:: ../Helpers/Styles.rst - -.. contents:: - :local: - - -Overview -================================ - -This document contains the status of the C++20 spaceship operator support -in libc++. It is used to track both the status of the sub-projects of the effort -and who is assigned to these sub-projects. This is imperative to effective -implementation so that work is not duplicated and implementors are not blocked -by each other. - -If you are interested in contributing to this effort, please send a message -to the #libcxx channel in the LLVM discord. Please *do not* start working on any -of the assigned items below. - - -Sub-Projects in the Implementation Effort -========================================= - -.. csv-table:: - :file: SpaceshipProjects.csv - :header-rows: 1 - :widths: auto - -.. note:: - - .. [#note-strongorder] ``std::strong_order(long double, long double)`` is not yet implemented. - - -Misc. Items and TODOs -==================================== - -(Note: files with required updates will contain the TODO at the beginning of the -list item so they can be easily found via global search.) - - -Paper and Issue Status -==================================== - -.. csv-table:: - :file: SpaceshipPapers.csv - :header-rows: 1 - :widths: auto diff --git a/libcxx/docs/Status/SpaceshipPapers.csv b/libcxx/docs/Status/SpaceshipPapers.csv deleted file mode 100644 index 1ab64a9caf86a..0000000000000 --- a/libcxx/docs/Status/SpaceshipPapers.csv +++ /dev/null @@ -1,12 +0,0 @@ -"Number","Name","Status","First released version" -`P1614R2 `_,The Mothership has Landed,|Complete|,19.0 -`P2404R3 `_,"Relaxing ``equality_comparable_with``'s, ``totally_ordered_with``'s, and ``three_way_comparable_with``'s common reference requirements to support move-only types",, -`LWG3330 `_,Include ```` from most library headers,"|Complete|","13.0" -`LWG3347 `_,"``std::pair`` now requires ``T`` and ``U`` to be *less-than-comparable*",|Nothing To Do|, -`LWG3350 `_,Simplify return type of ``lexicographical_compare_three_way``,|Nothing To Do|, -`LWG3360 `_,``three_way_comparable_with`` is inconsistent with similar concepts,|Nothing To Do|, -`LWG3380 `_,``common_type`` and comparison categories,|Nothing To Do|, -`LWG3395 `_,Definition for *three-way* comparison needs to be updated,|Nothing To Do|, -`P0905R1 `_,Symmetry for spaceship,|Complete|,7.0 -`P1120R0 `_,Consistency improvements for ``<=>`` and other comparison operators,, -`LWG3431 `_,``<=>`` for containers should require ``three_way_comparable`` instead of ``<=>``,, diff --git a/libcxx/docs/Status/SpaceshipProjects.csv b/libcxx/docs/Status/SpaceshipProjects.csv deleted file mode 100644 index 4dc43cdbbd08f..0000000000000 --- a/libcxx/docs/Status/SpaceshipProjects.csv +++ /dev/null @@ -1,202 +0,0 @@ -Section,Description,Dependencies,Assignee,Complete -- `5.1 Clause 16: Library Introduction `_,,,, -| `[expos.only.func] `_,"| `synth-three-way `_ -| `synth-three-way-result `_",[cmp.concept],Kent Ross,|Complete| -- `5.2 Clause 17: Language support library `_,,,, -| `[support.limits.general] `_,|,None,Unassigned,|Nothing To Do| -| `[type.info] `_,| remove ops `typeinfo `_,None,Adrian Vogelsgesang,|Complete| -| `[compare.syn] `_,,"| [cmp.concept] -| [cmp.result] -| [cmp.object] -| [cmp.alg]",Unassigned,|Complete| -"| `[cmp.weakeq] `_ -| `[cmp.strongeq] `_",| removed by `P1959R0 `_,None,Unassigned,|Nothing To Do| -"| `[cmp.partialord] `_ -| `[cmp.weakord] `_ -| `[cmp.strongord] `_",| remove ops `*_ordering `_,None,Christopher Di Bella,|Complete| -| `[cmp.concept] `_,"| `three_way_comparable `_ -| `three_way_comparable_with `_",None,Ruslan Arutyunyan,|Complete| -| `[cmp.result] `_,| `compare_three_way_result `_,None,Arthur O'Dwyer,|Complete| -| `[comparisons.three.way] `_,| `compare_three_way `_,[cmp.concept],Arthur O'Dwyer,|Complete| -| `[cmp.alg] `_,"| `strong_order `_ -| `weak_order `_ -| `partial_order `_ -| `strong_order_fallback `_ -| `weak_order_fallback `_ -| `partial_order_fallback `_",None,Arthur O'Dwyer,|Complete| [#note-strongorder]_ -"| `[coroutine.syn] `_ -| `[coroutine.handle.compare] `_",| `coroutine_handle `_,[comparisons.three.way],Chuanqi Xu,|Complete| -- `5.3 Clause 18: Concepts Library `_,,,, -- `5.4 Clause 19: Diagnostics Library `_,,,, -| `[system.error.syn] `_,|,"| [syserr.errcat.nonvirtuals] -| [syserr.compare]",Unassigned,|Complete| -"| `[syserr.errcat.overview] `_ -| `[syserr.errcat.nonvirtuals] `_",| `error_category `_,[comparisons.three.way],Adrian Vogelsgesang,|Complete| -| `[syserr.compare] `_,"| `error_code `_ -| `error_condition `_",None,Adrian Vogelsgesang,|Complete| -- `5.5 Clause 20: General utilities library `_,,,, -"| `[utility.syn] `_ -| `[pairs.pair] `_ -| `[pairs.spec] `_",| `pair `_,[expos.only.func],Kent Ross,|Complete| -"| `[tuple.syn] `_ -| `[tuple.rel] `_",| `tuple `_,[expos.only.func],Kent Ross,|Complete| -"| `[optional.syn] `_ -| `[optional.relops] `_ -| `[optional.nullops] `_ -| `[optional.comp.with.t] `_","| `optional `_ -| `nullopt `_",None,Hristo Hristov,|Complete| -"| `[variant.syn] `_ -| `[variant.relops] `_ -| `[variant.monostate.relops] `_","| `monostate `_ -| `variant `_",None,Kent Ross,|Complete| -"| `[template.bitset] `_ -| `[bitset.members] `_","| remove ops `bitset `_",None,Hristo Hristov,|Complete| -| `[memory.syn] `_,|,None,Unassigned,|Complete| -| `[allocator.globals] `_,| remove ops `allocator `_,None,Hristo Hristov,|Complete| -| `[unique.ptr.special] `_,| `unique_ptr `_,[comparisons.three.way],Adrian Vogelsgesang,|Complete| -| `[util.smartptr.shared.cmp] `_,| `shared_ptr `_,[comparisons.three.way],Adrian Vogelsgesang,|Complete| -"| `[mem.res.syn] `_ -| `[mem.res.eq] `_ -| `[mem.poly.allocator.eq] `_","| -| remove ops `memory_resource `_ -| remove ops `polymorphic_allocator `_",None,Hristo Hristov,|Complete| -"| `[allocator.adaptor.syn] `_ -| `[scoped.adaptor.operators] `_",| remove ops `scoped_allocator_adaptor `_,None,Hristo Hristov,|Complete| -"| `[functional.syn] `_ -| `[range.cmp] `_ -| `[func.wrap.func] `_ -| `[func.wrap.func.nullptr] `_",| remove ops `function `_,None,Hristo Hristov,|Complete| -| `[meta.unary.prop] `_,| replaced by `issue LWG3354 `_,None,Unassigned,|Nothing To Do| -| `[meta.trans.other] `_,| removed by `issue LWG3380 `_,None,Unassigned,|Nothing To Do| -"| `[type.index.overview] `_ -| `[type.index.members] `_",| `type_index `_,None,Adrian Vogelsgesang,|Complete| -| `[charconv.syn] `_,| `to_chars_result `_,None,Mark de Wever,|Complete| -| `[charconv.syn] `_,| `from_chars_result `_,None,Mark de Wever,|Complete| -- `5.6 Clause 21: Strings library `_,,,, -"| `[char.traits.specializations.char] `_ -| `[char.traits.specializations.char8.t] `_ -| `[char.traits.specializations.char16.t] `_ -| `[char.traits.specializations.char32.t] `_ -| `[char.traits.specializations.wchar.t] `_ -| `[string.syn] `_ -| `[string.cmp] `_",| `basic_string `_,None,Mark de Wever,|Complete| -"| `[string.view.synop] `_ -| `[string.view.comparison] `_",| `basic_string_view `_,None,Mark de Wever,|Complete| -- `5.7 Clause 22: Containers library `_,,,, -| `[container.requirements.general] `_,|,None,Mark de Wever,|Complete| -| `[array.syn] `_ (`general `_),| `array `_,[expos.only.func],"| Adrian Vogelsgesang -| Hristo Hristov",|Complete| -| `[deque.syn] `_ (`general `_),| `deque `_,[expos.only.func],Hristo Hristov,|Complete| -| `[forward.list.syn] `_ (`general `_),| `forward_list `_,[expos.only.func],Hristo Hristov,|Complete| -| `[list.syn] `_ (`general `_),| `list `_,[expos.only.func],Adrian Vogelsgesang,|Complete| -| `[vector.syn] `_ (`general `_),| `vector `_,[expos.only.func],"| Adrian Vogelsgesang -| Hristo Hristov",|Complete| -| `[array.overview] `_ (`general `_),| removed by `issue LWG3347 `_,None,"| Adrian Vogelsgesang -| Hristo Hristov",|Complete| -| `[associative.map.syn] `_ (`general `_),"| `map `_ -| `multimap `_",[expos.only.func],Hristo Hristov,|Complete| -| `[associative.set.syn] `_ (`general `_),"| `multiset `_ -| `set `_",[expos.only.func],Hristo Hristov,|Complete| -| `[unord.map.syn] `_,"| remove ops `unordered_map `_ -| remove ops `unordered_multimap `_",None,Hristo Hristov,|Complete| -| `[unordered.set.syn] `_,"| remove ops `unordered_set `_ -| remove ops `unordered_multiset `_",None,Hristo Hristov,|Complete| -| `[queue.syn] `_,| `queue `_,None,Hristo Hristov,|Complete| -| `[stack.syn] `_,| `stack `_,None,Hristo Hristov,|Complete| -| `[queue.ops] `_,| `queue `_,None,Hristo Hristov,|Complete| -| `[stack.ops] `_,| `stack `_,None,Hristo Hristov,|Complete| -- `5.8 Clause 23: Iterators library `_,,,, -| `[iterator.synopsis] `_,|,None,Unassigned,|Complete| -| `[reverse.iter.cmp] `_,| `reverse_iterator `_,None,Mikhail Maltsev,|Complete| -"| `[move.iterator] `_ -| `[move.iter.op.comp] `_",| `move_iterator `_,None,Arthur O'Dwyer,|Complete| -"| `[common.iterator] `_ -| `[common.iter.cmp] `_",| `common_iterator `_,None,Zoe Carver,|Complete| -"| `[counted.iterator] `_ -| `[counted.iter.cmp] `_",| `counted_iterator `_,None,Zoe Carver,|Complete| -| `[unreachable.sentinel] `_,| `unreachable_sentinel_t `_,None,Zoe Carver,|Complete| -"| `[istream.iterator] `_ -| `[istream.iterator.ops] `_",| remove ops `istream_iterator `_,None,Konstantin Varlamov,|Complete| -"| `[istreambuf.iterator] `_ -| `[istreambuf.iterator.ops] `_",| remove ops `istreambuf_iterator `_,None,Konstantin Varlamov,|Complete| -- `5.9 Clause 24: Ranges library `_,,,, -| `[range.iota.iterator] `_,| `ranges::iota_view::iterator `_,[concepts.cmp],Arthur O'Dwyer,|Complete| -| `[range.iota.sentinel] `_,| remove ops `iota_view::sentinel `_,None,Zoe Carver,|Complete| -| `[range.filter.iterator] `_,| remove ops `filter_view::iterator `_,None,Louis Dionne,|Complete| -| `[range.filter.sentinel] `_,| remove ops `filter_view::sentinel `_,None,Louis Dionne,|Complete| -| `[range.transform.iterator] `_,| `ranges::transform_view::iterator `_,[concepts.cmp],Arthur O'Dwyer,|Complete| -| `[range.transform.sentinel] `_,| remove ops `transform_view::sentinel `_,None,Zoe Carver,|Complete| -| `[range.take.sentinel] `_,| remove ops `take_view::sentinel `_,None,Konstantin Varlamov,|Complete| -| `[range.join.iterator] `_,| remove ops `join_view::iterator `_,None,Zoe Carver,|Complete| -| `[range.join.sentinel] `_,| remove ops `join_view::sentinel `_,None,Zoe Carver,|Complete| -| `[range.split.outer] `_,| remove ops `split_view::outer_iterator `_,None,Hui Xie,|Complete| -| `[range.split.inner] `_,| remove ops `split_view::inner_iterator `_,None,Hui Xie,|Complete| -- `5.10 Clause 25: Algorithms library `_,,,, -"| `[algorithm.syn] `_ -| `[alg.three.way] `_",| `lexicographical_compare_three_way `_,[comparisons.three.way],Adrian Vogelsgesang,|Complete| -- `5.11 Clause 26: Numerics library `_,,,, -"| `[complex.syn] `_ -| `[complex.ops] `_",| remove ops `complex `_,None,Hristo Hristov,|Complete| -"| `[class.slice.overview] `_ -| `[slice.ops] `_",| `slice `_,None,Hristo Hristov,|Complete| -- `5.12 Clause 27: Time library `_,,,, -| `[time.syn] `_,|,None,Mark de Wever,|Complete| -| `[time.duration.comparisons] `_, `chrono::duration `_, None, Hristo Hristov, |Complete| -| `[time.point.comparisons] `_, `chrono::time_point `_, None, Hristo Hristov, |Complete| -"| `[time.cal.day.nonmembers] `_ -| `[time.cal.month.nonmembers] `_ -| `[time.cal.year.nonmembers] `_ -| `[time.cal.md.nonmembers] `_ -| `[time.cal.mdlast] `_ -| `[time.cal.ym.nonmembers] `_ -| `[time.cal.ymd.nonmembers] `_ -| `[time.cal.ymdlast.nonmembers] `_","| `chrono::day `_ -| `chrono::month `_ -| `chrono::year `_ -| `chrono::month_day `_ -| `chrono::month_day_last `_ -| `chrono::year_month `_ -| `chrono::year_month_day `_ -| `chrono::year_month_day_last `_",None,Mark de Wever,|Complete| -"| `[time.cal.wd] `_ -| `[time.cal.wdidx] `_ -| `[time.cal.wdlast] `_ -| `[time.cal.mwd] `_ -| `[time.cal.mwdlast] `_ -| `[time.cal.ymwd] `_ -| `[time.cal.ymwdlast] `_","| `weekday `_ -| `weekday_indexed `_ -| `weekday_last `_ -| `month_weekday `_ -| `month_weekday_last `_ -| `year_month_weekday `_ -| `year_month_weekday_last `_",None,Hristo Hristov,|Complete| -`[time.zone.nonmembers] `_,"`chrono::time_zone`",,Mark de Wever,|Complete| -`[time.zone.zonedtime.nonmembers] `_,"`chrono::zoned_time`",,Mark de Wever,|Complete| -`[time.zone.leap.nonmembers] `_,"`chrono::time_leap_seconds`",,Mark de Wever,|Complete| -`[time.zone.link.nonmembers] `_,"`chrono::time_zone_link`",,Mark de Wever,|Complete| -- `5.13 Clause 28: Localization library `_,,,, -"| `[locale] `_ -| `[locale.operators] `_",| remove ops `locale `_,None,Hristo Hristov,|Complete| -- `5.14 Clause 29: Input/output library `_,,,, -| `[fs.filesystem.syn] `_,| `filesystem::space_info `_,None,Adrian Vogelsgesang,|Complete| -"| `[fs.class.path] `_ -| `[fs.path.nonmember] `_",| `filesystem::path `_,None,Adrian Vogelsgesang,|Complete| -| `[fs.class.file.status] `_,| `file_status `_,None,Hristo Hristov,|Complete| -"| `[fs.class.directory.entry] `_ -| `[fs.dir.entry.obs] `_",| `filesystem::directory_entry `_,None,Adrian Vogelsgesang,|Complete| -- `5.15 Clause 30: Regular expressions library `_,,,, -| `[re.syn] `_,|,None,Mark de Wever,|Complete| -| `[re.submatch.op] `_,| `sub_match `_,None,Mark de Wever,|Complete| -| `[re.results.nonmember] `_,| remove ops `match_results`,None,Mark de Wever,|Complete| -"| `[re.regiter] `_, -| `[re.regiter.comp] `_",| remove ops `regex_iterator`,None,Mark de Wever,|Complete| -"| `[re.tokiter] `_ -| `[re.tokiter.comp] `_",| remove ops `regex_token_iterator`,None,Mark de Wever,|Complete| -- `5.16 Clause 31: Atomic operations library `_,,,, -- `5.17 Clause 32: Thread support library `_,,,, -| `[thread.thread.id] `_,| `thread::id `_,None,Adrian Vogelsgesang,|Complete| -Misc (Not part of R1614),,,, -| `[range.elements.iterator] `_,| `ranges::elements_view::iterator `_,[concepts.cmp],Hui Xie,|Complete| -| `[stacktrace.entry.cmp] `_,| `stacktrace_entry `_,None,Nikolas Klauser,|In Progress| -| `[stacktrace.basic.cmp] `_,| `basic_stacktrace `_,[alg.three.way],Nikolas Klauser,|In Progress| diff --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst index 4bca3ccc8fa06..97bf297c82b90 100644 --- a/libcxx/docs/index.rst +++ b/libcxx/docs/index.rst @@ -51,8 +51,6 @@ Getting Started with libc++ Status/Format Status/Parallelism Status/PSTL - Status/Ranges - Status/Spaceship Status/SpecialMath Status/Zip