https://github.com/jeremyletang/sad

Non intrusive, header only serialization framework
https://github.com/jeremyletang/sad

Last synced: about 1 month ago
JSON representation

Non intrusive, header only serialization framework

• Host: GitHub
• URL: https://github.com/jeremyletang/sad
• Owner: jeremyletang
• License: mit
• Created: 2016-02-10T16:41:16.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-22T17:43:09.000Z (almost 9 years ago)
• Last Synced: 2024-10-22T07:08:31.135Z (3 months ago)
• Language: C++
• Homepage:
• Size: 63.5 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## SAD

*SAD* is an header only, non intrusive serialization library for C++.

It should allow you to serialize your C++ struct / class (models), without having to implement any 

interface, just using function template specialization.

The library is designed to work with multiple backend, for now I'm working on a simple std::basic_ostream and a jsoncpp backend

*SAD* is a work in progress and mostly just build for the fun of doing templates, you should not use it in a real project.

## A simple Example

```C++

#include 

#include 

#include 

#include 

#include 

#include 

// define your model

template 

struct person {

    std::string name;

    T age;

    person() = default;

    person(const std::string name, T age)

    : name(name), age(age) {}

};

// specialize the sad::schema function for you model

namespace sad {

template 

struct schema> : sad::base_scheam> {

    using sad::base_schema>::operator();

    decltype(auto) operator()(person& p) {

        return sad::make_schema(

            sad::f("name", p.name),

            sad::f("age", p.age)

        );

    }

};

}

int main() {

    // instanciate our model

    const auto p = person{"balek", 25};

    // serialize using the basic_ostream serializer

    // initialized with std::cout

    sad::serialize(sad::backend::ostream_serializer{std::cout}, p);

}

```

## Installation

*SAD* use C++14 features, so you won't be able to build it with a compiler not recent enough (clang >= 3.4 && gcc >= 5.0).

As specified earlier, *SAD* is an header only library, you just need to clone the repository, 

and copy everthing from the include folder inside your project.

You will only need to install locally the different libraries used internally depending of the backend you use.

## API Reference

TODO

## Tests

You can build the test suite using cmake to generate a build system for you plateform.

CMake will first download the required libraries to build the tests (googletest, and the backends dependencies).

You can specifies to build the test using this kind of command line:

```Shell

> mkdir build && cd build

> cmake -DBUILD_TESTS=ON -DWITH_JSONCPP_BACKEND=ON ..

> make

```

The first argument specify that we want to build the tests, the second one that we enable the 

jsoncpp backend.

## License

*SAD* is licensed under the MIT license, you can find a copy of the license at the root of the repository.