This is a small library for creating and manipulating arbitrarily sized bitstrings. There is support for static sized (and stack allocated) aswell as heap allocated (and resizable) bitstrings. It is published at platformio and has all batteries included to work with ESP-IDF.
This code is licensed under the MIT license.
There are two ways of adding this library to your project. You could either:
Just run the following line to add this library to your components directory.
git submodule add https://github.com/aberratic/bitstring.git componentsIf you are not using ESP IDF and its configuration system take care of setting the configuration below.
Add to your platformio.ini the following line:
lib_deps = aberratic/Bitstring @ ^2.1.0Furthermore to use menuconfig you need to add the following line to your project CMakeLists.txt
list(APPEND EXTRA_COMPONENT_DIRS ".pio/libdeps/esp32dev/Bitstring")There is one compile time configuration value:
CONFIG_BITSTRING_ENABLE_BOUND_CHECKS
This setting enable out of bound checks. When a OOB access occurs and this setting is enabled the app will panic. If this setting is disabled and a OOB access occurs the behavior is undefined.
I recommend to enable this setting.
Just look into include/bitstring.h or bitstring/bitstring_static.h. It is well documented. There are also examples in the examples directory.
| Version | Changes |
|---|---|
| 2.1.0 | Added functions to get indexes of the next set/unset bit |
| 2.0.4 | Minor cleanup of unused variables. Also enabled -Wall |
| 2.0.3 | Fixed a bug with false strncat string sizes. |
| 2.0.2 | |
| 2.0.1 | |
| 2.0 | Renamed CONFIG_BITSTREAM_ENABLE_BOUND_CHECKS to |
| CONFIG_BITSTRING_ENABLE_BOUND_CHECKS | |
| Added support for stack allocated / static sized bitstrings | |
| Added examples | |
| 1.0 | Renamed bstr_err_t variants |
| Added function attributes | |
| Added two unit tests for bstr_resize() | |
| 0.2 | Added bstr_ffus(), to find first unset bit |
| 0.1 | Initial Release |