pb_decode.h

   1 #ifndef _PB_DECODE_H_
   2 #define _PB_DECODE_H_
   3
   4 /* pb_decode.h: Functions to decode protocol buffers. Depends on pb_decode.c.
   5  * The main function is pb_decode. You will also need to create an input
   6  * stream, which is easiest to do with pb_istream_from_buffer().
   7  *
   8  * You also need structures and their corresponding pb_field_t descriptions.
   9  * These are usually generated from .proto-files with a script.
  10  */
  11
  12 #include <stdbool.h>
  13 #include "pb.h"
  14
  15 /* Lightweight input stream.
  16  * You can provide a callback function for reading or use
  17  * pb_istream_from_buffer.
  18  *
  19  * Rules for callback:
  20  * 1) Return false on IO errors. This will cause decoding to abort.
  21  *
  22  * 2) If buf is NULL, read but don't store bytes ("skip input").
  23  *
  24  * 3) You can use state to store your own data (e.g. buffer pointer),
  25  * and rely on pb_read to verify that no-body reads past bytes_left.
  26  */
  27 struct _pb_istream_t
  28 {
  29     bool (*callback)(pb_istream_t *stream, uint8_t *buf, size_t count);
  30     void *state; /* Free field for use by callback implementation */
  31     size_t bytes_left;
  32 };
  33
  34 pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
  35 bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
  36
  37 /* Decode from stream to destination struct.
  38  * Returns true on success, false on any failure.
  39  * The actual struct pointed to by dest must match the description in fields.
  40  */
  41 bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
  42
  43 /* --- Helper functions ---
  44  * You may want to use these from your caller or callbacks.
  45  */
  46
  47 bool pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, uint32_t *tag, bool *eof);
  48 bool pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type);
  49
  50 bool pb_decode_varint(pb_istream_t *stream, uint64_t *dest);
  51
  52 bool pb_skip_varint(pb_istream_t *stream);
  53 bool pb_skip_string(pb_istream_t *stream);
  54
  55 /* --- Field decoders ---
  56  * Each decoder takes stream and field description, and a pointer to the field
  57  * in the destination struct (dest = struct_addr + field->data_offset).
  58  * For arrays, these functions are called repeatedly.
  59  */
  60
  61 bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest);
  62 bool pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest);
  63 bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest);
  64 bool pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest);
  65
  66 bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest);
  67 bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest);
  68 bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest);
  69
  70 #endif