pb.h

   1 #ifndef _PB_H_
   2 #define _PB_H_
   3
   4 /* pb.h: Common parts for nanopb library.
   5  * Most of these are quite low-level stuff. For the high-level interface,
   6  * see pb_encode.h or pb_decode.h
   7  */
   8
   9 #include <stdint.h>
  10 #include <stddef.h>
  11 #include <stdbool.h>
  12
  13 #ifdef __GNUC__
  14 /* This just reduces memory requirements, but is not required. */
  15 #define pb_packed __attribute__((packed))
  16 #else
  17 #define pb_packed
  18 #endif
  19
  20 /* List of possible field types. These are used in the autogenerated code.
  21  * Least-significant 4 bits tell the scalar type
  22  * Most-significant 4 bits specify repeated/required/packed etc.
  23  *
  24  * INT32 and UINT32 are treated the same, as are (U)INT64 and (S)FIXED*
  25  * These types are simply casted to correct field type when they are
  26  * assigned to the memory pointer.
  27  * SINT* is different, though, because it is zig-zag coded.
  28  */
  29
  30 typedef enum {
  31     /************************
  32      * Field contents types *
  33      ************************/
  34
  35     /* Numeric types */
  36     PB_LTYPE_VARINT = 0x00, /* int32, uint32, int64, uint64, bool, enum */
  37     PB_LTYPE_SVARINT = 0x01, /* sint32, sint64 */
  38     PB_LTYPE_FIXED32 = 0x02, /* fixed32, sfixed32, float */
  39     PB_LTYPE_FIXED64 = 0x03, /* fixed64, sfixed64, double */
  40
  41     /* Marker for last packable field type. */
  42     PB_LTYPE_LAST_PACKABLE = 0x03,
  43
  44     /* Byte array with pre-allocated buffer.
  45      * data_size is the length of the allocated PB_BYTES_ARRAY structure. */
  46     PB_LTYPE_BYTES = 0x04,
  47
  48     /* String with pre-allocated buffer.
  49      * data_size is the maximum length. */
  50     PB_LTYPE_STRING = 0x05,
  51
  52     /* Submessage
  53      * submsg_fields is pointer to field descriptions */
  54     PB_LTYPE_SUBMESSAGE = 0x06,
  55
  56     /* Number of declared LTYPES */
  57     PB_LTYPES_COUNT = 7,
  58
  59     /******************
  60      * Modifier flags *
  61      ******************/
  62
  63     /* Just the basic, write data at data_offset */
  64     PB_HTYPE_REQUIRED = 0x00,
  65
  66     /* Write true at size_offset */
  67     PB_HTYPE_OPTIONAL = 0x10,
  68
  69     /* Read to pre-allocated array
  70      * Maximum number of entries is array_size,
  71      * actual number is stored at size_offset */
  72     PB_HTYPE_ARRAY = 0x20,
  73
  74     /* Works for all required/optional/repeated fields.
  75      * data_offset points to pb_callback_t structure.
  76      * LTYPE should be 0 (it is ignored, but sometimes
  77      * used to speculatively index an array). */
  78     PB_HTYPE_CALLBACK = 0x30
  79 } pb_packed pb_type_t;
  80
  81 #define PB_HTYPE(x) ((x) & 0xF0)
  82 #define PB_LTYPE(x) ((x) & 0x0F)
  83
  84 /* This structure is used in auto-generated constants
  85  * to specify struct fields.
  86  * You can change field sizes here if you need structures
  87  * larger than 256 bytes or field tags larger than 256.
  88  * The compiler should complain if your .proto has such
  89  * structures ("initializer too large for type").
  90  */
  91 typedef struct _pb_field_t pb_field_t;
  92 struct _pb_field_t {
  93     uint8_t tag;
  94     pb_type_t type;
  95     uint8_t data_offset; /* Offset of field data, relative to previous field. */
  96     int8_t size_offset; /* Offset of array size or has-boolean, relative to data */
  97     uint8_t data_size; /* Data size in bytes for a single item */
  98     uint8_t array_size; /* Maximum number of entries in array */
  99
 100     /* Field definitions for submessage
 101      * OR default value for all other non-array, non-callback types
 102      * If null, then field will zeroed. */
 103     const void *ptr;
 104 } pb_packed;
 105
 106 /* This structure is used for 'bytes' arrays.
 107  * It has the number of bytes in the beginning, and after that an array.
 108  * Note that actual structs used will have a different length of bytes array.
 109  */
 110 typedef struct {
 111     size_t size;
 112     uint8_t bytes[1];
 113 } pb_bytes_array_t;
 114
 115 /* This structure is used for giving the callback function.
 116  * It is stored in the message structure and filled in by the method that
 117  * calls pb_decode.
 118  *
 119  * The decoding callback will be given a limited-length stream
 120  * If the wire type was string, the length is the length of the string.
 121  * If the wire type was a varint/fixed32/fixed64, the length is the length
 122  * of the actual value.
 123  * The function may be called multiple times (especially for repeated types,
 124  * but also otherwise if the message happens to contain the field multiple
 125  * times.)
 126  *
 127  * The encoding callback will receive the actual output stream.
 128  * It should write all the data in one call, including the field tag and
 129  * wire type. It can write multiple fields.
 130  *
 131  * The callback can be null if you want to skip a field.
 132  */
 133 typedef struct _pb_istream_t pb_istream_t;
 134 typedef struct _pb_ostream_t pb_ostream_t;
 135 typedef struct _pb_callback_t pb_callback_t;
 136 struct _pb_callback_t {
 137     union {
 138         bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
 139         bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
 140     } funcs;
 141
 142     /* Free arg for use by callback */
 143     void *arg;
 144 };
 145
 146 /* Wire types. Library user needs these only in encoder callbacks. */
 147 typedef enum {
 148     PB_WT_VARINT = 0,
 149     PB_WT_64BIT  = 1,
 150     PB_WT_STRING = 2,
 151     PB_WT_32BIT  = 5
 152 } pb_wire_type_t;
 153
 154 /* These macros are used to declare pb_field_t's in the constant array. */
 155 #define pb_membersize(st, m) (sizeof ((st*)0)->m)
 156 #define pb_arraysize(st, m) (pb_membersize(st, m) / pb_membersize(st, m[0]))
 157 #define pb_delta(st, m1, m2) ((int)offsetof(st, m1) - (int)offsetof(st, m2))
 158 #define pb_delta_end(st, m1, m2) (offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
 159 #define PB_LAST_FIELD {0,0,0,0}
 160
 161
 162 #endif