xref: /aosp_15_r20/external/pigweed/pw_polyfill/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)

.. _module-pw_polyfill:

===========
pw_polyfill
===========
The ``pw_polyfill`` module supports compiling code against different C++
standards.

--------------------------------------------------
Adapt code to compile with different C++ standards
--------------------------------------------------

C++ standard macro
==================
``pw_polyfill/standard.h`` provides macros for checking if a C++ or C standard
is supported.

.. doxygendefine:: PW_CXX_STANDARD_IS_SUPPORTED
.. doxygendefine:: PW_C_STANDARD_IS_SUPPORTED

Language feature macros
=======================
``pw_polyfill/language_feature_macros.h`` provides macros for adapting code to
work with or without C++ language features.

.. list-table::
  :header-rows: 1

  * - Macro
    - Feature
    - Description
    - Feature test macro
  * - ``PW_CONSTEXPR_CPP20``
    - ``constexpr``
    - ``constexpr`` if compiling for C++20
    - ``__cplusplus >= 202002L``
  * - ``PW_CONSTEVAL``
    - ``consteval``
    - ``consteval`` if supported by the compiler
    - ``__cpp_consteval``
  * - ``PW_CONSTINIT``
    - ``constinit``
    - ``constinit`` in clang and GCC 10+
    - ``__cpp_constinit``

In GN, Bazel, or CMake, depend on ``$dir_pw_polyfill``, ``//pw_polyfill``,
or ``pw_polyfill``, respectively, to access these features. In other build
systems, add ``pw_polyfill/public`` as an include path.

API reference
-------------
.. doxygenfile:: pw_polyfill/language_feature_macros.h
   :sections: define

------------------------------------------------
Backport new C++ features to older C++ standards
------------------------------------------------
Pigweed backports a few C++ features to older C++ standards. These features are
provided in the ``pw`` namespace. If the features are provided by the toolchain,
the ``pw`` versions are aliases of the ``std`` versions.

List of backported features
===========================

These features are documented here, but are not implemented in ``pw_polyfill``.
See the listed Pigweed module for more information on each feature.

.. list-table::
  :header-rows: 1

  * - Header
    - Feature
    - Pigweed module and header
    - Polyfill name
  * - ``<array>``
    - ``std::to_array``
    - :ref:`module-pw_containers`/to_array.h
    - ``pw::containers::to_array``
  * - ``<bit>``
    - ``std::endian``
    - :ref:`module-pw_bytes`/bit.h
    - ``pw::endian``
  * - ``<expected>``
    - ``std::expected``
    - :ref:`module-pw_result`/expected.h
    - ``pw::expected``
  * - ``<span>``
    - ``std::span``
    - :ref:`module-pw_span`/span.h
    - ``pw::span``

------------------------------------------------
Adapt code to compile with different C standards
------------------------------------------------

.. _module-pw_polyfill-static_assert:

static_assert
=============

``pw_polyfill/static_assert.h`` provides C23-style ``static_assert`` for older
C standards. As in C23, the message argument is optional.

.. literalinclude:: c_test.c
   :start-after: [static_assert-example]
   :end-before: [static_assert-example]
   :language: c

.. tip::

   Use ``pw_polyfill/static_assert.h`` rather than ``<assert.h>`` to provide
   ``static_assert`` in C. ``<assert.h>`` provides a ``#define static_assert
   _Static_assert`` macro prior to C23, but its ``static_assert`` does not
   support C23 semantics (optional message argument), and it defines the
   unwanted ``assert`` macro.

------
Zephyr
------
To enable ``pw_polyfill`` for Zephyr add ``CONFIG_PIGWEED_POLYFILL=y`` to the
project's configuration.