etl/macros.md at 1ca5bb012fd155ac0d3ddfaafeeba5578059c9a2

coffee/etl

mirror of https://github.com/ETLCPP/etl.git synced 2026-06-15 08:26:04 +08:00

John Wellbelove 4a88884b39

Issue/add hugo support for documentation (#1449 )

* Add ranges

* Initial Hugo setup

* Work in progress

* Added selection for local or remote site

* Updated to 'light' theme

* Changed to using Hextra Hugo theme

* Changed to using Hextra Hugo theme

* Changed to Hextra Hugo theme

* Change to Hextra Hugo theme

* Updated Hugo setup.

* Updated Hugo setup.

# Conflicts:
#	docs/releases/_index.md

* Work in progress

* Added new fonts

Added new documentation

* Latest documentation updates

* Latest documentation updates

# Conflicts:
#	docs/containers/array.md
#	docs/containers/array_view.md
#	docs/containers/array_wrapper.md
#	docs/containers/bip_buffer_spsc_atomic.md
#	docs/containers/bitset.md
#	docs/containers/indirect_vector.md
#	docs/containers/vector.md
#	docs/getting-started/compilers.md

* Added bloom_filter markdown doc

* Added more documentation

Updated CSS for light and dark modes

* Fixed some menus

Added mode documentation files

* Updated CSS rules

Added badges to home page
Added uniqur_ptr + pool tutorial

* Fixed formatting on the home page markdown

Modified light amd dark code formatting

* Updated unique_ptr-with-pool

* Added container and shared message tutorials

* Updates to documentation

* Added const_multimap

* Updated source-formatting.md

* Added initial raw text files form Web site editor

* Innore coverage build directory

* Exported raw text documentation files from the web site editor

* Hugo updates

* Added Hugo intalation and markdown descriptions

* More addition to the documentation

* Added closure.md and updates to delegate.md

* Added format.md

* Added documentation for etl::delegate_observable, etl::function, Base64 codec

* Added io_port documentation

* Added basic_format_spec

* Added documentation for string_stream and string utilities.

* Added more documentation

Updated the documentation CSS

* Added documentation for clocks, day, duration

* Added more documentation for chrono classes

Updated callouts

* More chrono documentation

* Completed chrono documentation

* Maths functions documentation

* Completed maths documentation

* Completed maths documentation

* Completed maths documentation

* Completed maths documentation

* Added multiple documentation files

* Added iterator.md

* Added debug_count.md and versions.md

* Added debug_count.md and versions.md

* Added more documentation

* More documentation

* Added some design pattern documentation

Modified some of the layout files
Modified the About documentation

* Converted more documentation pages

Modified the site CSS

* Added more documentation

Moced some documentation files to new directories

* Added more documentation

Tweaks to CSS

* Added callback_timer_deferred_locked documentation

* Added callback_timer_locked documentation

* More documentation updates

* More documentation updates

* More documentation updates

* New documentation files.

Harmonised file name format

* New documentation files.

* Multiple document updates

* Multiple document updates

* Final conversion of web pages

* Updates before PR

* Updates before PR

* Updates before PR

# Conflicts:
#	docs/blog/_index.md

* Final pre PR updates

* Updates to message framework documentation

* Renamed directory

* Fix spelling

* Added author and date to blog files

Moved documentation files merged from development

* Fixed 'Description' typo

* Fix typos

# Conflicts:
#	docs/IO/io_port.md
#	docs/containers/sets/const-multiset.md
#	docs/containers/sets/const-set.md
#	docs/maths/correlation.md
#	docs/maths/gamma.md

* Renamed two files to lower case

* Minor renaming

* Added author and date

* Updated callout on bresenham_line.md

Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset.
Updated the Python 'update_release.py' to copy 'version.txt'

* Replace space in filename with hyphen.

Added more information to hugo-commands.md

* Replace space in filename with hyphen.

Added more information to hugo-commands.md

# Conflicts:
#	docs/getting-started/view-the-docs-locally/hugo-commands.md

* Added a link to pseudo_moving_average.md

* Updated title pages for groups

* Fixed missing 404 for non-existent pages

* Fixed coordinate variable names in the 'Calculating the intersection' example

---------

Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de>
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com>
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>

2026-06-06 13:12:44 +01:00

14 KiB

Raw Blame History

title
Macros

Many of the features or options in the ETL can be selected by defining the appropriate macros. Some macros are defined by the ETL.

Some of the following macros are presented as C++ constants. See ETL Traits

User defined

These may be defined in the project settings or the user created etl_profile.h.

Macro	Description
`ETL_NO_CHECKS`	`ETL_ASSERT` has no effect.
`ETL_THROW_EXCEPTIONS`	`ETL_ASSERT` throws the specified exception.
`ETL_THROW_EXCEPTIONS` + `ETL_LOG_ERRORS`	`ETL_ASSERT` calls the error handler then throws an exception.
`ETL_LOG_ERRORS`	`ETL_ASSERT` calls the error handler then asserts.
`ETL_LOG_ERRORS` + `NDEBUG`	`ETL_ASSERT` calls the error handler.
`ETL_CHECK_PUSH_POP`	Pushes and pops to containers are checked for bounds.
`ETL_VERBOSE_ERRORS`	If this is defined then error messages are output in their long form.
`ETL_BITSET_ELEMENT_TYPE`	If this is defined, then it will become the type used for elements in the `bitset` class. Default is `uint_least8_t`
`ETL_FSM_STATE_ID_TYPE`	If this is defined, then it will become the type used for FSM state id numbers. `Default is uint_least8_t`.
`ETL_MESSAGE_ID_TYPE`	If this is defined, then it will become the type used for message id numbers. `Default is uint_least8_t`.
`ETL_TIMER_SEMAPHORE_TYPE`	If this is defined, then it will become the type used for the type for the timer guard variable. This must be a type that cannot be interrupted during a read/modify/write cycle. Default is `etl::atomic_uint32_t`.
`ETL_ISTRING_REPAIR_ENABLE`	Define this if you wish to `memcpy` ETL strings and repair them via an `istring` pointer or reference. Warning: This will make the container a virtual class.
`ETL_IVECTOR_REPAIR_ENABLE`	Define this if you wish to memcpy ETL vectors and repair them via an `ivector` pointer or reference. Warning: This will make the container a virtual class.
`ETL_IDEQUE_REPAIR_ENABLE`	Define this if you wish to memcpy ETL deques and repair them via an `ideque` pointer or reference. Warning: This will make the container a virtual class.
`ETL_STLPORT`	This must be defined in the user library profile when using STLPort as the standard library implementation.
`ETL_NO_STL`	If defined, the ETL will not use definitions from the STL. Instead it will use its own reverse engineered versions.
`ETL_FORCE_EXPLICIT_STRING_CONVERSION_FROM_CHAR`	If defined, the ETL will force `string`, `wstring`, `u8string`, `u16string`, `u32string`, and `string_view` to have explicit construction from a character pointer.
`ETL_STRING_TRUNCATION_IS_ERROR`	If defined, then a string truncation will result in an `etl::string_truncation` error being emitted.
`ETL_ENABLE_ERROR_ON_STRING_TRUNCATION`	See above.
`ETL_ARRAY_VIEW_IS_MUTABLE`	If defined, then `etl::array_view` is mutable.
`ETL_POLYMORPHIC_BITSET`	Defining any one of these will make the corresponding container polymorphic, turning the protected non-virtual destructor to public virtual.
`ETL_POLYMORPHIC_DEQUE`
`ETL_POLYMORPHIC_FLAT_MAP`
`ETL_POLYMORPHIC_FLAT_MULTIMAP`
`ETL_POLYMORPHIC_FLAT_SET`
`ETL_POLYMORPHIC_FLAT_MULTISET`
`ETL_POLYMORPHIC_FORWARD_LIST`
`ETL_POLYMORPHIC_LIST`
`ETL_POLYMORPHIC_MAP`
`ETL_POLYMORPHIC_MULTIMAP`
`ETL_POLYMORPHIC_SET`
`ETL_POLYMORPHIC_MULTISET`
`ETL_POLYMORPHIC_QUEUE`
`ETL_POLYMORPHIC_STACK`
`ETL_POLYMORPHIC_REFERENCE_FLAT_MAP`
`ETL_POLYMORPHIC_REFERENCE_FLAT_MULTIMAP`
`ETL_POLYMORPHIC_REFERENCE_FLAT_SET`
`ETL_POLYMORPHIC_REFERENCE_FLAT_MULTISET`
`ETL_POLYMORPHIC_UNORDERED_MAP`
`ETL_POLYMORPHIC_UNORDERED_MULTIMAP`
`ETL_POLYMORPHIC_UNORDERED_SET`
`ETL_POLYMORPHIC_UNORDERED_MULTISET`
`ETL_POLYMORPHIC_STRINGS`
`ETL_POLYMORPHIC_POOL`
`ETL_POLYMORPHIC_VECTOR`
`ETL_POLYMORPHIC_CONTAINERS`	If defined then all containers are polymorphic.
`ETL_POLYMORPHIC_MESSAGES`	If defined then `etl::imessage` is virtual.
`ETL_MESSAGES_ARE_VIRTUAL`	`ETL_MESSAGES_ARE_VIRTUAL` is deprecated and may be removed. Only valid before 19.4.1 Messages are virtual, by default, from 19.4.1
`ETL_USE_TYPE_TRAITS_BUILTINS`	Forces the ETL to use calls compiler built-ins. Sets all of them to be 1 if not already defined. If not defined `ETL_USE_BUILTIN_IS_ASSIGNABLE` then `ETL_USE_BUILTIN_IS_ASSIGNABLE = 1` If not defined ETL_USE_BUILTIN_IS_CONSTRUCTIBLE then `ETL_USE_BUILTIN_IS_CONSTRUCTIBLE = 1` If not `ETL_USE_BUILTIN_IS_TRIVIALLY_CONSTRUCTIBLE` then `ETL_USE_BUILTIN_IS_TRIVIALLY_CONSTRUCTIBLE = 1` If not defined `ETL_USE_BUILTIN_IS_TRIVIALLY_DESTRUCTIBLE` then `ETL_USE_BUILTIN_IS_TRIVIALLY_DESTRUCTIBLE = 1` If not defined `ETL_USE_BUILTIN_IS_TRIVIALLY_COPYABLE` then `ETL_USE_BUILTIN_IS_TRIVIALLY_COPYABLE = 1` `ETL_TARGET_DEVICE_GENERIC` Only `ETL_TARGET_DEVICE_ARM_CORTEX_M0` and `ETL_TARGET_DEVICE_ARM` and `ETL_TARGET_DEVICE_ARM_CORTEX_M0_PLUS` are currently used in the ETL code to disable `etl::atomic`.
`ETL_NO_LIBC_WCHAR_H`	Define if the libc++ used has not been compiled for `wchar_t` support.

ETL defined

Defined in platform.h

Macro	Description
`ETL_DEBUG`	This is defined as `1` if `DEBUG` or `_DEBUG` is defined. Otherwise `0`.
`ETL_8BIT_SUPPORT`	This is defined as `1` if the platform supports 8 bit char types, otherwise 0. Deprecated.
`ETL_CONSTEXPR`	If `ETL_CPP11_SUPPORTED` is defined as `1` then this macro is defined as `constexpr`, otherwise defined as blank.
`ETL_CONSTEXPR11`	If `ETL_CPP11_SUPPORTED` is defined as `1` then this macro is defined as `constexpr`, otherwise defined as blank.
`ETL_CONSTEXPR14`	If `ETL_CPP14_SUPPORTED` is defined as `1` then this macro is defined as `constexpr`, otherwise defined as blank.
`ETL_CONSTEXPR17`	If `ETL_CPP17_SUPPORTED` is defined as `1` then this macro is defined as `constexpr`, otherwise defined as blank.
`ETL_IF_CONSTEXPR`	If `ETL_CPP17_SUPPORTED` is defined as `1` then this macro is defined as `constexpr`, otherwise defined as blank.
`ETL_CONSTANT`	If `ETL_CPP11_SUPPORTED` is defined as `1` then this macro is defined as `constexpr`, otherwise defined as `const`.
`ETL_NOEXCEPT`	If `ETL_CPP11_SUPPORTED` is defined as `1` then this macro is defined as `noexcept`, otherwise defined as blank.
`ETL_NOEXCEPT_EXPR(expression)`	If `ETL_CPP11_SUPPORTED` is defined as `1` then this macro is defined as `noexcept(expression)`, otherwise defined as blank.
`ETL_NODISCARD`	If `ETL_CPP11_SUPPORTED` is defined as `1` then this macro is defined as `[[nodiscard]]`, otherwise defined as blank.
`ETL_DEPRECATED`	If `ETL_CPP14_SUPPORTED` is defined as `1` then this macro is defined as `[[deprecated]]`, otherwise defined as blank.
`ETL_DEPRECATED_REASON(reason)`	If `ETL_CPP14_SUPPORTED` is defined as `1` then this macro is defined as `[[deprecated(reason)]]`, otherwise defined as blank.
`ETL_FALLTHROUGH`	If `ETL_CPP17_SUPPORTED` is defined as `1` then this macro is defined as `[[falltrough]]`, otherwise defined as blank.
`ETL_NORETURN`	If `ETL_CPP11_SUPPORTED` is defined as `1` then this macro is defined as `[[noreturn]]`, otherwise defined as blank.
`ETL_OR_STD`	If ETL_NO_STL is defined and ETL_IN_UNIT_TEST is not then `ETL_OR_STD` is defined as `etl`, otherwise it is defined as `std`.
`ETL_IN_UNIT_TEST`	If defined, then the code is being compiled in the unit tests. For internal ETL use only.
`ETL_HAS_ATOMIC`	This is defined as `1` if the compiler supplies an atomic class, otherwise `0`.
`ETL_INLINE_VAR`	If `ETL_CPP17_SUPPORTED` is defined as `1` then this macro is defined as `inline`, otherwise defined as blank.
`ETL_USING_STL`	This macro will be defined as `0` & `1` dependant of whether `ETL_NO_STL` is defined or not.
`ETL_NOT_USING_STL`	Inversion of `ETL_USING_STL`.
`ETL_USING_STLPORT`	This macro will be defined as `0` & `1` dependant of whether `ETL_STLPORT` is defined or not.
`ETL_NOT_USING_STLPORT`	Inversion of `ETL_USING_STLPORT`.
`ETL_USING_8BIT_TYPES`	This macro will be defined as `0` & `1` dependant of whether `CHAR_BIT == 8` or not.
`ETL_NOT_USING_8BIT_TYPES`	Inversion of `ETL_USING_8BIT_TYPES`.
`ETL_USING_64BIT_TYPES`	This macro will be defined as `0` & `1` dependant of whether `ETL_NO_64BIT_TYPES` is defined or not.
`ETL_NOT_USING_64BIT_TYPES`	Inversion of `ETL_USING_64BIT_TYPES`.
`ETL_HAS_ISTRING_REPAIR`	Set to `1` if the repair functionality for `etl::istring` is enabled, otherwise `0`.
`ETL_HAS_IVECTOR_REPAIR`	Set to `1` if the repair functionality for `etl::ivector` is enabled, otherwise `0`.
`ETL_HAS_IDEQUE_REPAIR`	Set to `1` if the repair functionality for `etl::ideque` is enabled, otherwise `0`.
`ETL_IS_DEBUG_BUILD`	Set to `1` if in a debug build, otherwise `0`.
`ETL_HAS_POLYMORPHIC_MESSAGES`	Set to `1` if messages are polymorphic, otherwise `0`.
`ETL_HAS_ERROR_ON_STRING_TRUNCATION`	Set to `1` if truncated strings are an error, otherwise `0`.
`ETL_USING_LIBC_WCHAR_H`	These macros will be defined as `0` & `1` dependant of whether `ETL_NO_LIBC_WCHAR_H` is defined or not.
`ETL_NOT_USING_LIBC_WCHAR_H`	Inversion of `ETL_USING_LIBC_WCHAR_H`.
`ETL_USING_CPP11`	This is defined as `1` if the compiler supports C++11, otherwise `0`.
`ETL_USING_CPP14`	This is defined as `1` if the compiler supports C++14, otherwise `0`.
`ETL_USING_CPP17`	This is defined as `1` if the compiler supports C++17, otherwise `0`.
`ETL_USING_CPP20`	This is defined as `1` if the compiler supports C++20, otherwise `0`.
`ETL_USING_CPP23`	This is defined as `1` if the compiler supports C++23, otherwise `0`.

These may be user defined in etl_profile.h, or automatically determined in platform.h.

Macro	Description
`ETL_CPP11_SUPPORTED`	This is defined as `1` if the compiler supports C++11, otherwise `0`.
`ETL_CPP14_SUPPORTED`	This is defined as `1` if the compiler supports C++14, otherwise `0`.
`ETL_CPP17_SUPPORTED`	This is defined as `1` if the compiler supports C++17, otherwise `0`.
`ETL_CPP20_SUPPORTED`	This is defined as `1` if the compiler supports C++20, otherwise `0`.
`ETL_CPP23_SUPPORTED`	This is defined as `1` if the compiler supports C++23, otherwise `0`.
`ETL_NO_NULLPTR_SUPPORT`	This is defined as `1` if compiler does not support `nullptr`, otherwise `0`.
`ETL_NO_LARGE_CHAR_SUPPORT`	This is defined as `1` if the compiler does not support `char16_t` or `char32_t` types, otherwise `0`.
`ETL_CPP11_TYPE_TRAITS_IS_TRIVIAL_SUPPORTED`	This is defined as `1` if compiler supports the `std::is_trivially_xxx` set of traits, otherwise `0`.

`ETL_COMPILER_IAR`	One of these will be defined.
`ETL_COMPILER_GREEN_HILLS`
`ETL_COMPILER_INTEL`
`ETL_COMPILER_MICROSOFT`
`ETL_COMPILER_GCC`
`ETL_COMPILER_CLANG`
`ETL_COMPILER_ARM`
`ETL_COMPILER_TEXAS_INSTRUMENTS`
`ETL_COMPILER_GENERIC`

`ETL_COMPILER_VERSION	These will be defined as the compiler version numbers, if available.
`ETL_COMPILER_FULL_VERSION`

`ETL_DEVELOPMENT_OS_WINDOWS`	One of these will be defined.
`ETL_DEVELOPMENT_OS_LINUX`
`ETL_DEVELOPMENT_OS_UNIX`
`ETL_DEVELOPMENT_OS_APPLE`
`ETL_DEVELOPMENT_OS_BSD`
`ETL_DEVELOPMENT_OS_GENERIC`

`ETL_NO_CPP_NAN_SUPPORT`	If defined, indicates that the compiler does not support nan(), nanf() or nanl(). Automatically defined if using CodeWorks for ARM.

14 KiB Raw Blame History

User defined

ETL defined

14 KiB

Raw Blame History