mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-16 00:46:03 +08:00
* 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>
96 lines
2.2 KiB
Markdown
96 lines
2.2 KiB
Markdown
---
|
|
title: "Interfacing with C"
|
|
weight: 3
|
|
---
|
|
|
|
Interfacing ETL containers with contiguous storage to a C API is fairly easy to do.
|
|
|
|
This is a C function that copies `count` characters , starting from `a`, to a buffer pointed to by `start`.
|
|
|
|
```cpp
|
|
size_t CFunctionCopyToBuffer(char* start, size_t count)
|
|
{
|
|
size_t i = 0;
|
|
while (i < count)
|
|
{
|
|
*p++ = 'a' + i;
|
|
++i;
|
|
}
|
|
return i;
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
**Array**
|
|
The ETL array is simply a C array wrapped in a C++ interface.
|
|
|
|
```cpp
|
|
size_t length;
|
|
|
|
etl::array<char, 26> buffer;
|
|
|
|
length = CFunctionCopyToBuffer(buffer.data(), buffer.max_size() / 2);
|
|
```
|
|
|
|
Array contains `[ a, b, c, d, e, f, g, h, i, j, k, l, m ]`
|
|
|
|
---
|
|
|
|
**Vector**
|
|
To use a `vector` with C, you must make room for the expected new data, and then adjust to the new size after copying.
|
|
|
|
```cpp
|
|
etl::vector<char, 26> buffer;
|
|
|
|
// Make the vector as big as it can be.
|
|
buffer.uninitialized_resize(buffer.max_size());
|
|
|
|
size_t newLength = CFunctionCopyToBuffer(buffer.data(), buffer.max_size() / 2);
|
|
|
|
// Now adjust it back to the actual new size.
|
|
buffer.resize(newLength);
|
|
```
|
|
|
|
Vector contains `[ a, b, c, d, e, f, g, h, i, j, k, l, m ]`
|
|
|
|
---
|
|
|
|
**String**
|
|
Strings are terminated with null characters. We can use this to easily adjust the length after copying.
|
|
|
|
```cpp
|
|
etl::string<26> buffer;
|
|
|
|
// Ensure that the string's free space are terminator characters.
|
|
buffer.initialize_free_space();
|
|
|
|
CFunctionCopyToBuffer(buffer.data(), buffer.max_size() / 2);
|
|
|
|
// Trim the string length at the first null terminator.
|
|
buffer.trim_to_terminator();
|
|
```
|
|
|
|
String contains `"abcdefghijklm"`
|
|
|
|
```cpp
|
|
// Lets add some more characters.
|
|
// Start at data_end() so we append to what's already there.
|
|
// We'll use the alternative method to adjust the string length.
|
|
// We could still use trim_to_terminator() if we wanted to.
|
|
|
|
// Remember the current size.
|
|
size_t oldSize = buffer.size();
|
|
|
|
// Make the string as big as it can be.
|
|
buffer.uninitialized_resize(buffer.max_size());
|
|
|
|
// Append the characters.
|
|
size_t appendedSize = CFunctionCopyToBuffer(buffer.data_end(), buffer.max_size() / 2);
|
|
|
|
// Now adjust it back to the actual new size.
|
|
buffer.uninitialized_resize(oldSize + appendedSize);
|
|
```
|
|
|
|
String contains `"abcdefghijklmabcdefghijklm"`
|