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) You can use state to store your own data (e.g. buffer pointer),
  23  * and rely on pb_read to verify that no-body reads past bytes_left.
  24  *
  25  * 3) Your callback may be used with substreams, in which case bytes_left
  26  * is different than from the main stream. Don't use bytes_left to compute
  27  * any pointers.
  28  */
  29 struct _pb_istream_t
  30 {
  31     bool (*callback)(pb_istream_t *stream, uint8_t *buf, size_t count);
  32     void *state; /* Free field for use by callback implementation */
  33     size_t bytes_left;
  34
  35 #ifndef PB_NO_ERRMSG
  36     const char *errmsg;
  37 #endif
  38 };
  39
  40 pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
  41 bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
  42
  43 /* Decode from stream to destination struct.
  44  * Returns true on success, false on any failure.
  45  * The actual struct pointed to by dest must match the description in fields.
  46  */
  47 bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
  48
  49 /* Same as pb_decode, except does not initialize the destination structure
  50  * to default values. This is slightly faster if you need no default values
  51  * and just do memset(struct, 0, sizeof(struct)) yourself.
  52  */
  53 bool pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
  54
  55 /* --- Helper functions ---
  56  * You may want to use these from your caller or callbacks.
  57  */
  58
  59 /* Decode the tag for the next field in the stream. Gives the wire type and
  60  * field tag. At end of the message, returns false and sets eof to true. */
  61 bool pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, uint32_t *tag, bool *eof);
  62
  63 /* Skip the field payload data, given the wire type. */
  64 bool pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type);
  65
  66 /* Decode an integer in the varint format. This works for bool, enum, int32,
  67  * int64, uint32 and uint64 field types. */
  68 bool pb_decode_varint(pb_istream_t *stream, uint64_t *dest);
  69
  70 /* Decode an integer in the zig-zagged svarint format. This works for sint32
  71  * and sint64. */
  72 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest);
  73
  74 /* Decode a fixed32, sfixed32 or float value. You need to pass a pointer to
  75  * a 4-byte wide C variable. */
  76 bool pb_decode_fixed32(pb_istream_t *stream, void *dest);
  77
  78 /* Decode a fixed64, sfixed64 or double value. You need to pass a pointer to
  79  * a 8-byte wide C variable. */
  80 bool pb_decode_fixed64(pb_istream_t *stream, void *dest);
  81
  82 /* Make a limited-length substream for reading a PB_WT_STRING field. */
  83 bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream);
  84 void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream);
  85
  86 /* --- Internal functions ---
  87  * These functions are not terribly useful for the average library user, but
  88  * are exported to make the unit testing and extending nanopb easier.
  89  */
  90
  91 #ifdef NANOPB_INTERNALS
  92 bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest);
  93 bool pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest);
  94 bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest);
  95 bool pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest);
  96
  97 bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest);
  98 bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest);
  99 bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest);
 100
 101 bool pb_skip_varint(pb_istream_t *stream);
 102 bool pb_skip_string(pb_istream_t *stream);
 103 #endif
 104
 105 #endif