Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.29 KB

README.md

File metadata and controls

50 lines (36 loc) · 1.29 KB
Raw

atdcpp

atdcpp takes type definitions in the ATD format and derives C++ classes that can read and write JSON data. This saves the developer the labor writing boilerplate that converts between dicts and classes.

This allows safe interoperability with other languages supported by ATD such as OCaml, Java, Python or Scala.

See the sample input type definitions everything.atd and the C++ output everything.hpp.

This implementation makes use of the RapidJson C++ library.

Requirements

Requirements for building and testing atdcpp:

  • Opam and dependencies installed from the atd project root with make setup.
  • gcc / clang
  • librapidjson

Requirements for generating C++ code:

  • the atdcpp executable

Requirements for compiling the generated C++ code:

  • A working C++ compiler (gcc / clang)
  • The rapidjson library

Documentation

  • TODO

Development notes

Build or rebuild with make. Test with make test.

Running the tests is done from the atdcpp/ main folder with make test.

We have two kinds of tests for atdcpp:

  • code generation and C++ tests:
    • they generate C++ code from ATD files and compare the C++ output against the expectations.
    • the generated code is executed by some tests.