SaneCppSerializationText.h implements binary serialization on top of the Reflection library.

Note: You need to include headers from Serialization Adapters in order to use SC::Vector or SC::String or any other serializable class provided by other libraries with this one.

Dependencies

• Dependencies: Reflection, Strings
• All dependencies: Reflection, Strings

Features

JSON Serializer

• Serialize primitive types
• Serialize SC::Vector, SC::Array, SC::String
• Serialize T[N] arrays
• Serialize structs made of above types or other structs

Details

Status

MVP Only JSON has been implemented and it needs additional testing.

JSON Serializer

Architecture

SC::detail::SerializationTextReadVersioned provides common framework for all text / structured formats, walking the data structure using reflection information.
Every writer or reader needs to implement methods like startObject / endObject and startArray / endArray, so that only a minimal amount of work is needed to support a new output format.
So far only JSON format has been implemented, but it would be easily possible adding XML or other formats like YAML if needed.

Also this serializer has an exact and a versioned variant.
The exact json deserializer (SC::detail::SerializationTextReadWriteExact) must receive as input a file with fields in the exact same order as output by the json writer, so it makes it a little bit inflexible but maybe it could provide some performance boost as it's clearly doing less work (even if it should always be measured to verify it's actually faster in the specific use case).

Json Tokenizer

SC::JsonTokenizer verifies the correctness of JSON elements but it will not validate Strings or parse numbers. The design is a stateful streaming tokenizer, so it can ingest documents of arbitrary size. It allocates just a single enum value for every nesting level of json objects. This small allocation can be controlled by the caller through a SC::Vector. The allocation can be eliminated by passing a SC::SmallVector with an bounded level of json nesting. The design of being a tokenizer implies that we are not building any tree / hierarchy / DOM, even if it can be trivially done by just pushing the outputs of the tokenizer into a hierarchical data structure.

Roadmap

Usable

• JSON Escape Strings
• JSON UTF Escapes
• SC::ArenaMap serialization
• SC::SmallVector serialization
• SC::SmallString serialization

Complete Features:

• Streaming serializer

💡 Unplanned Features:

• XML Serializer
• YAML Serializer

Statistics