mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-15 16:36:03 +08:00
4a88884b39
* 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>
45 lines
3.1 KiB
Markdown
45 lines
3.1 KiB
Markdown
00---
|
|
title: "Generators"
|
|
---
|
|
|
|
Some templates within the ETL are designed to support a variable number of template parameters. To accommodate this, these template classes have a number of specialisations to handle each variant. The ETL sets this number to a reasonable default, but there will almost certainly be circumstances where these are too small for the project at hand.
|
|
|
|
To this end, the ETL supplies 'generators' to enable the creation of customised variants of these template classes.
|
|
|
|
The code generation is handled by a Python library called `COG`. This allows Python code to be embedded within the C++. When `COG` is run on the generator header, it will produce a customised version of that header.
|
|
|
|
The naming convention used is
|
|
The generator file: `xxxx_generator.h`
|
|
The output file: `xxxx.h`
|
|
The script: `generate_xxxx.bat`
|
|
|
|
The script `generate.bat` will run all of the generate scripts.
|
|
|
|
e.g.
|
|
Running the `COG` script on the generator `type_traits_generator.h` will create `type_traits.h`
|
|
|
|
The syntax for processing a generator file is
|
|
`python -m cogapp -d -e -o<output> -D<parameter>=<N> <generator>`
|
|
|
|
e.g.
|
|
`python -m cogapp -d -e -otype_traits.h -DIsOneOf=16 type_traits_generator.h`
|
|
The line above will create type_traits.h with the ability to handle up to 16 types in the `etl::is_one_of` structure.
|
|
|
|
All of the generator files may be processed by running the script `generate.bat`
|
|
There are generator scripts for each generator header.
|
|
This can be run as a command line batch file under Windows or as a script under Linux (if set to 'executable')
|
|
|
|
**Defined generators**
|
|
|
|
|
|
| Functionality | Generator | Output | Parameters | Notes |
|
|
| -------------------- | ---------------------------- | ------------------ | ---------- | ----- |
|
|
| Finite State Machine | `fsm_generator.h` | `fsm.h` | Handlers | Defines the maximum number of events that can be handled |
|
|
| Message Router | `message_router_generator.h` | `message_router.h` | Handlers | Defines the maximum number of messages that can be handled |
|
|
| Smallest | `smallest_generator.h` | `smallest.h` | NTypes | Defines the maximum number of types that can be declared |
|
|
| Largest | `largest_generator.h` | `largest.h` | NTypes | Defines the maximum number of types that can be declared |
|
|
| Type Traits | `type_traits_generator.h` | `type_traits.h` | NTypes | Defines the maximum number of types that can be declared in the class `etl::is_one_of` |
|
|
| Type Lookup | `type_lookup_generator.h` | `type_lookup.h` | NTypes | Defines the maximum number of types that can be declared in the classes `etl::type_id_lookup` and `etl::type_type_lookup` |
|
|
| Type Select | `type_select_generator.h` | `type_select.h` | NTypes | Defines the maximum number of types that can be declared in the class `etl::type_select` |
|
|
| Variant Pool | `variant_pool_generator.h` | `variant_pool.h` | NTypes | Defines the maximum number of types that can be declared |
|