blob: 0c1d2edd7eb4b77995732ef79294a4e0caba2985 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
# BinaryMapping
…is a collection of C++ templates which may be used to map binary structures into tuples and various other structures.
These structures can then be traversed using integrated containers and iterators. This is useful for many kinds of data serialization tasks.
A explanation of an earlier version of this template library can be found on this [blog]. The source code is available via both [Github] and [cgit].
## Current features
* Support for any kind of flat structure that can be expressed using integral types and arbitrarily sized byte-arrays
* Support for serialization in either big or little endianess
* Offers Container and Iterator templates for fast traversal of collections of tuples or other structures
* Support for developing custom types to be used in the Container and Iterator templates
* Support for nesting structures inside each other
* BitField template offers bit-level access to ByteField byte-arrays
* Doesn't require any external libraries besides the GNU libraries `endian.h`
* Header only library because of heavy usage of template metaprogramming
* Unit Tests based on GoogleTest
* MIT license
## Usage example
~~~
BinaryMapping::Container<
BinaryMapping::Tuple<
BinaryMapping::LittleEndian,
std::uint32_t,
std::int16_t,
BinaryMapping::ByteField<3>,
std::uint8_t
>
> container(10);
for ( auto&& tuple : container ) {
tuple.set<0>(UINT32_MAX);
tuple.set<1>(INT16_MAX);
tuple.set<2>({1, 2, 3});
tuple.set<3>(42);
}
std::uint32_t test = container.at(5).get<0>();
~~~
{: .language-cpp}
The code listed above defines a container of a tuple consisting of a `std::uint32_t`, `std::int16_t`, 3-byte and `std::uint8_t` field with little endianess, instantiates a buffer containing ten instances of this tuple, iterates through all 10 elements, gives them values, transparently converts to the correct endianess and extracts the value of the first field of the fifth tuple contained in the buffer. In short: BinaryMapping is a library that abstracts endianess aware serializing of binary structures into structures, containers and iterators. If you are interested in further details of the usage of all features provided by BinaryMapping don't hesitate to check out the [documentation].
[blog]: /article/mapping_binary_structures_as_tuples_using_template_metaprogramming
[Github]: https://github.com/KnairdA/BinaryMapping/
[cgit]: http://code.kummerlaender.eu/BinaryMapping/
[documentation]: https://github.com/KnairdA/BinaryMapping/blob/master/docs/
|
