/protoc-gen-erlang

Plugin module to protoc to support Erlang protocol buffers.

Primary LanguageC++OtherNOASSERTION

This is a plug module for google’s protoc to produce erlang code. Currently it’s only tested on Ubuntu 10.10 using libprotoc 2.4.1 and Erlang R14, but there’s nothing in any of it that should preclude different versions or compilation on Windows.

Features

  • Nested messages and enums within Erlang.
  • Default values.
  • Encoding and decoding packed repeated fields.
  • Supports all protobuf language specs.
  • Triq based testing.

Installation

Install development versions of protoc. I compiled from source. The makefile shows how to compile and run the code.

Key points:

  • protoc-gen-erlang and protoc have to be in the path.
  • —erlang-out should point the base directory of a standard OTP app and will create files in include, src, and optionally test.
  • —erlang-out=triq_tests:$DIR will create triq based tests to check round trip encode/decode of messages, as well as exported domain functions for every message type.
  • Generated code is dependent on http://github.com/TensorWrench/libprotobuf.git
  • Optional tests are dependent upon http://github.com/krestenkrab/triq.git

The erl_protobuf_test module contains a sampling of .proto files. Adding any .proto file to it will add it to the test suite.