pb.h

   1 /* Common parts of the nanopb library. Most of these are quite low-level
   2  * stuff. For the high-level interface, see pb_encode.h and pb_decode.h.
   3  */
   4
   5 #ifndef PB_H_INCLUDED
   6 #define PB_H_INCLUDED
   7
   8 /*****************************************************************
   9  * Nanopb compilation time options. You can change these here by *
  10  * uncommenting the lines, or on the compiler command line.      *
  11  *****************************************************************/
  12
  13 /* Enable support for dynamically allocated fields */
  14 /* #define PB_ENABLE_MALLOC 1 */
  15
  16 /* Define this if your CPU architecture is big endian, i.e. it
  17  * stores the most-significant byte first. */
  18 /* #define __BIG_ENDIAN__ 1 */
  19
  20 /* Define this if your CPU / compiler combination does not support
  21  * unaligned memory access to packed structures. */
  22 /* #define PB_NO_PACKED_STRUCTS 1 */
  23
  24 /* Increase the number of required fields that are tracked.
  25  * A compiler warning will tell if you need this. */
  26 /* #define PB_MAX_REQUIRED_FIELDS 256 */
  27
  28 /* Add support for tag numbers > 255 and fields larger than 255 bytes. */
  29 /* #define PB_FIELD_16BIT 1 */
  30
  31 /* Add support for tag numbers > 65536 and fields larger than 65536 bytes. */
  32 /* #define PB_FIELD_32BIT 1 */
  33
  34 /* Disable support for error messages in order to save some code space. */
  35 /* #define PB_NO_ERRMSG 1 */
  36
  37 /* Disable support for custom streams (support only memory buffers). */
  38 /* #define PB_BUFFER_ONLY 1 */
  39
  40 /* Switch back to the old-style callback function signature.
  41  * This was the default until nanopb-0.2.1. */
  42 /* #define PB_OLD_CALLBACK_STYLE */
  43
  44
  45 /******************************************************************
  46  * You usually don't need to change anything below this line.     *
  47  * Feel free to look around and use the defined macros, though.   *
  48  ******************************************************************/
  49
  50
  51 /* Version of the nanopb library. Just in case you want to check it in
  52  * your own program. */
  53 #define NANOPB_VERSION nanopb-0.3.4-dev
  54
  55 /* Include all the system headers needed by nanopb. You will need the
  56  * definitions of the following:
  57  * - strlen, memcpy, memset functions
  58  * - [u]int8_t, [u]int16_t, [u]int32_t, [u]int64_t
  59  * - size_t
  60  * - bool
  61  *
  62  * If you don't have the standard header files, you can instead provide
  63  * a custom header that defines or includes all this. In that case,
  64  * define PB_SYSTEM_HEADER to the path of this file.
  65  */
  66 #ifdef PB_SYSTEM_HEADER
  67 #include PB_SYSTEM_HEADER
  68 #else
  69 #include <stdint.h>
  70 #include <stddef.h>
  71 #include <stdbool.h>
  72 #include <string.h>
  73
  74 #ifdef PB_ENABLE_MALLOC
  75 #include <stdlib.h>
  76 #endif
  77 #endif
  78
  79 /* Macro for defining packed structures (compiler dependent).
  80  * This just reduces memory requirements, but is not required.
  81  */
  82 #if defined(PB_NO_PACKED_STRUCTS)
  83     /* Disable struct packing */
  84 #   define PB_PACKED_STRUCT_START
  85 #   define PB_PACKED_STRUCT_END
  86 #   define pb_packed
  87 #elif defined(__GNUC__) || defined(__clang__)
  88     /* For GCC and clang */
  89 #   define PB_PACKED_STRUCT_START
  90 #   define PB_PACKED_STRUCT_END
  91 #   define pb_packed __attribute__((packed))
  92 #elif defined(__ICCARM__) || defined(__CC_ARM)
  93     /* For IAR ARM and Keil MDK-ARM compilers */
  94 #   define PB_PACKED_STRUCT_START _Pragma("pack(push, 1)")
  95 #   define PB_PACKED_STRUCT_END _Pragma("pack(pop)")
  96 #   define pb_packed
  97 #elif defined(_MSC_VER) && (_MSC_VER >= 1500)
  98     /* For Microsoft Visual C++ */
  99 #   define PB_PACKED_STRUCT_START __pragma(pack(push, 1))
 100 #   define PB_PACKED_STRUCT_END __pragma(pack(pop))
 101 #   define pb_packed
 102 #else
 103     /* Unknown compiler */
 104 #   define PB_PACKED_STRUCT_START
 105 #   define PB_PACKED_STRUCT_END
 106 #   define pb_packed
 107 #endif
 108
 109 /* Handly macro for suppressing unreferenced-parameter compiler warnings. */
 110 #ifndef PB_UNUSED
 111 #define PB_UNUSED(x) (void)(x)
 112 #endif
 113
 114 /* Compile-time assertion, used for checking compatible compilation options.
 115  * If this does not work properly on your compiler, use
 116  * #define PB_NO_STATIC_ASSERT to disable it.
 117  *
 118  * But before doing that, check carefully the error message / place where it
 119  * comes from to see if the error has a real cause. Unfortunately the error
 120  * message is not always very clear to read, but you can see the reason better
 121  * in the place where the PB_STATIC_ASSERT macro was called.
 122  */
 123 #ifndef PB_NO_STATIC_ASSERT
 124 #ifndef PB_STATIC_ASSERT
 125 #define PB_STATIC_ASSERT(COND,MSG) typedef char PB_STATIC_ASSERT_MSG(MSG, __LINE__, __COUNTER__)[(COND)?1:-1];
 126 #define PB_STATIC_ASSERT_MSG(MSG, LINE, COUNTER) PB_STATIC_ASSERT_MSG_(MSG, LINE, COUNTER)
 127 #define PB_STATIC_ASSERT_MSG_(MSG, LINE, COUNTER) pb_static_assertion_##MSG##LINE##COUNTER
 128 #endif
 129 #else
 130 #define PB_STATIC_ASSERT(COND,MSG)
 131 #endif
 132
 133 /* Number of required fields to keep track of. */
 134 #ifndef PB_MAX_REQUIRED_FIELDS
 135 #define PB_MAX_REQUIRED_FIELDS 64
 136 #endif
 137
 138 #if PB_MAX_REQUIRED_FIELDS < 64
 139 #error You should not lower PB_MAX_REQUIRED_FIELDS from the default value (64).
 140 #endif
 141
 142 /* List of possible field types. These are used in the autogenerated code.
 143  * Least-significant 4 bits tell the scalar type
 144  * Most-significant 4 bits specify repeated/required/packed etc.
 145  */
 146
 147 typedef uint8_t pb_type_t;
 148
 149 /**** Field data types ****/
 150
 151 /* Numeric types */
 152 #define PB_LTYPE_VARINT  0x00 /* int32, int64, enum, bool */
 153 #define PB_LTYPE_UVARINT 0x01 /* uint32, uint64 */
 154 #define PB_LTYPE_SVARINT 0x02 /* sint32, sint64 */
 155 #define PB_LTYPE_FIXED32 0x03 /* fixed32, sfixed32, float */
 156 #define PB_LTYPE_FIXED64 0x04 /* fixed64, sfixed64, double */
 157
 158 /* Marker for last packable field type. */
 159 #define PB_LTYPE_LAST_PACKABLE 0x04
 160
 161 /* Byte array with pre-allocated buffer.
 162  * data_size is the length of the allocated PB_BYTES_ARRAY structure. */
 163 #define PB_LTYPE_BYTES 0x05
 164
 165 /* String with pre-allocated buffer.
 166  * data_size is the maximum length. */
 167 #define PB_LTYPE_STRING 0x06
 168
 169 /* Submessage
 170  * submsg_fields is pointer to field descriptions */
 171 #define PB_LTYPE_SUBMESSAGE 0x07
 172
 173 /* Extension pseudo-field
 174  * The field contains a pointer to pb_extension_t */
 175 #define PB_LTYPE_EXTENSION 0x08
 176
 177 /* Number of declared LTYPES */
 178 #define PB_LTYPES_COUNT 9
 179 #define PB_LTYPE_MASK 0x0F
 180
 181 /**** Field repetition rules ****/
 182
 183 #define PB_HTYPE_REQUIRED 0x00
 184 #define PB_HTYPE_OPTIONAL 0x10
 185 #define PB_HTYPE_REPEATED 0x20
 186 #define PB_HTYPE_ONEOF    0x30
 187 #define PB_HTYPE_MASK     0x30
 188
 189 /**** Field allocation types ****/
 190
 191 #define PB_ATYPE_STATIC   0x00
 192 #define PB_ATYPE_POINTER  0x80
 193 #define PB_ATYPE_CALLBACK 0x40
 194 #define PB_ATYPE_MASK     0xC0
 195
 196 #define PB_ATYPE(x) ((x) & PB_ATYPE_MASK)
 197 #define PB_HTYPE(x) ((x) & PB_HTYPE_MASK)
 198 #define PB_LTYPE(x) ((x) & PB_LTYPE_MASK)
 199
 200 /* Data type used for storing sizes of struct fields
 201  * and array counts.
 202  */
 203 #if defined(PB_FIELD_32BIT)
 204 #define PB_SIZE_MAX ((uint32_t)-1)
 205     typedef uint32_t pb_size_t;
 206     typedef int32_t pb_ssize_t;
 207 #elif defined(PB_FIELD_16BIT)
 208 #define PB_SIZE_MAX ((uint16_t)-1)
 209     typedef uint16_t pb_size_t;
 210     typedef int16_t pb_ssize_t;
 211 #else
 212 #define PB_SIZE_MAX ((uint8_t)-1)
 213     typedef uint8_t pb_size_t;
 214     typedef int8_t pb_ssize_t;
 215 #endif
 216
 217 /* This structure is used in auto-generated constants
 218  * to specify struct fields.
 219  * You can change field sizes if you need structures
 220  * larger than 256 bytes or field tags larger than 256.
 221  * The compiler should complain if your .proto has such
 222  * structures. Fix that by defining PB_FIELD_16BIT or
 223  * PB_FIELD_32BIT.
 224  */
 225 PB_PACKED_STRUCT_START
 226 typedef struct pb_field_s pb_field_t;
 227 struct pb_field_s {
 228     pb_size_t tag;
 229     pb_type_t type;
 230     pb_size_t data_offset; /* Offset of field data, relative to previous field. */
 231     pb_ssize_t size_offset; /* Offset of array size or has-boolean, relative to data */
 232     pb_size_t data_size; /* Data size in bytes for a single item */
 233     pb_size_t array_size; /* Maximum number of entries in array */
 234
 235     /* Field definitions for submessage
 236      * OR default value for all other non-array, non-callback types
 237      * If null, then field will zeroed. */
 238     const void *ptr;
 239 } pb_packed;
 240 PB_PACKED_STRUCT_END
 241
 242 /* Make sure that the standard integer types are of the expected sizes.
 243  * All kinds of things may break otherwise.. atleast all fixed* types.
 244  *
 245  * If you get errors here, it probably means that your stdint.h is not
 246  * correct for your platform.
 247  */
 248 PB_STATIC_ASSERT(sizeof(int8_t) == 1, INT8_T_WRONG_SIZE)
 249 PB_STATIC_ASSERT(sizeof(uint8_t) == 1, UINT8_T_WRONG_SIZE)
 250 PB_STATIC_ASSERT(sizeof(int16_t) == 2, INT16_T_WRONG_SIZE)
 251 PB_STATIC_ASSERT(sizeof(uint16_t) == 2, UINT16_T_WRONG_SIZE)
 252 PB_STATIC_ASSERT(sizeof(int32_t) == 4, INT32_T_WRONG_SIZE)
 253 PB_STATIC_ASSERT(sizeof(uint32_t) == 4, UINT32_T_WRONG_SIZE)
 254 PB_STATIC_ASSERT(sizeof(int64_t) == 8, INT64_T_WRONG_SIZE)
 255 PB_STATIC_ASSERT(sizeof(uint64_t) == 8, UINT64_T_WRONG_SIZE)
 256
 257 /* This structure is used for 'bytes' arrays.
 258  * It has the number of bytes in the beginning, and after that an array.
 259  * Note that actual structs used will have a different length of bytes array.
 260  */
 261 #define PB_BYTES_ARRAY_T(n) struct { pb_size_t size; uint8_t bytes[n]; }
 262 #define PB_BYTES_ARRAY_T_ALLOCSIZE(n) ((size_t)n + offsetof(pb_bytes_array_t, bytes))
 263
 264 struct pb_bytes_array_s {
 265     pb_size_t size;
 266     uint8_t bytes[1];
 267 };
 268 typedef struct pb_bytes_array_s pb_bytes_array_t;
 269
 270 /* This structure is used for giving the callback function.
 271  * It is stored in the message structure and filled in by the method that
 272  * calls pb_decode.
 273  *
 274  * The decoding callback will be given a limited-length stream
 275  * If the wire type was string, the length is the length of the string.
 276  * If the wire type was a varint/fixed32/fixed64, the length is the length
 277  * of the actual value.
 278  * The function may be called multiple times (especially for repeated types,
 279  * but also otherwise if the message happens to contain the field multiple
 280  * times.)
 281  *
 282  * The encoding callback will receive the actual output stream.
 283  * It should write all the data in one call, including the field tag and
 284  * wire type. It can write multiple fields.
 285  *
 286  * The callback can be null if you want to skip a field.
 287  */
 288 typedef struct pb_istream_s pb_istream_t;
 289 typedef struct pb_ostream_s pb_ostream_t;
 290 typedef struct pb_callback_s pb_callback_t;
 291 struct pb_callback_s {
 292 #ifdef PB_OLD_CALLBACK_STYLE
 293     /* Deprecated since nanopb-0.2.1 */
 294     union {
 295         bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
 296         bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
 297     } funcs;
 298 #else
 299     /* New function signature, which allows modifying arg contents in callback. */
 300     union {
 301         bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg);
 302         bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg);
 303     } funcs;
 304 #endif
 305
 306     /* Free arg for use by callback */
 307     void *arg;
 308 };
 309
 310 /* Wire types. Library user needs these only in encoder callbacks. */
 311 typedef enum {
 312     PB_WT_VARINT = 0,
 313     PB_WT_64BIT  = 1,
 314     PB_WT_STRING = 2,
 315     PB_WT_32BIT  = 5
 316 } pb_wire_type_t;
 317
 318 /* Structure for defining the handling of unknown/extension fields.
 319  * Usually the pb_extension_type_t structure is automatically generated,
 320  * while the pb_extension_t structure is created by the user. However,
 321  * if you want to catch all unknown fields, you can also create a custom
 322  * pb_extension_type_t with your own callback.
 323  */
 324 typedef struct pb_extension_type_s pb_extension_type_t;
 325 typedef struct pb_extension_s pb_extension_t;
 326 struct pb_extension_type_s {
 327     /* Called for each unknown field in the message.
 328      * If you handle the field, read off all of its data and return true.
 329      * If you do not handle the field, do not read anything and return true.
 330      * If you run into an error, return false.
 331      * Set to NULL for default handler.
 332      */
 333     bool (*decode)(pb_istream_t *stream, pb_extension_t *extension,
 334                    uint32_t tag, pb_wire_type_t wire_type);
 335
 336     /* Called once after all regular fields have been encoded.
 337      * If you have something to write, do so and return true.
 338      * If you do not have anything to write, just return true.
 339      * If you run into an error, return false.
 340      * Set to NULL for default handler.
 341      */
 342     bool (*encode)(pb_ostream_t *stream, const pb_extension_t *extension);
 343
 344     /* Free field for use by the callback. */
 345     const void *arg;
 346 };
 347
 348 struct pb_extension_s {
 349     /* Type describing the extension field. Usually you'll initialize
 350      * this to a pointer to the automatically generated structure. */
 351     const pb_extension_type_t *type;
 352
 353     /* Destination for the decoded data. This must match the datatype
 354      * of the extension field. */
 355     void *dest;
 356
 357     /* Pointer to the next extension handler, or NULL.
 358      * If this extension does not match a field, the next handler is
 359      * automatically called. */
 360     pb_extension_t *next;
 361
 362     /* The decoder sets this to true if the extension was found.
 363      * Ignored for encoding. */
 364     bool found;
 365 };
 366
 367 /* Memory allocation functions to use. You can define pb_realloc and
 368  * pb_free to custom functions if you want. */
 369 #ifdef PB_ENABLE_MALLOC
 370 #   ifndef pb_realloc
 371 #       define pb_realloc(ptr, size) realloc(ptr, size)
 372 #   endif
 373 #   ifndef pb_free
 374 #       define pb_free(ptr) free(ptr)
 375 #   endif
 376 #endif
 377
 378 /* This is used to inform about need to regenerate .pb.h/.pb.c files. */
 379 #define PB_PROTO_HEADER_VERSION 30
 380
 381 /* These macros are used to declare pb_field_t's in the constant array. */
 382 /* Size of a structure member, in bytes. */
 383 #define pb_membersize(st, m) (sizeof ((st*)0)->m)
 384 /* Number of entries in an array. */
 385 #define pb_arraysize(st, m) (pb_membersize(st, m) / pb_membersize(st, m[0]))
 386 /* Delta from start of one member to the start of another member. */
 387 #define pb_delta(st, m1, m2) ((int)offsetof(st, m1) - (int)offsetof(st, m2))
 388 /* Marks the end of the field list */
 389 #define PB_LAST_FIELD {0,(pb_type_t) 0,0,0,0,0,0}
 390
 391 /* Macros for filling in the data_offset field */
 392 /* data_offset for first field in a message */
 393 #define PB_DATAOFFSET_FIRST(st, m1, m2) (offsetof(st, m1))
 394 /* data_offset for subsequent fields */
 395 #define PB_DATAOFFSET_OTHER(st, m1, m2) (offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
 396 /* Choose first/other based on m1 == m2 (deprecated, remains for backwards compatibility) */
 397 #define PB_DATAOFFSET_CHOOSE(st, m1, m2) (int)(offsetof(st, m1) == offsetof(st, m2) \
 398                                   ? PB_DATAOFFSET_FIRST(st, m1, m2) \
 399                                   : PB_DATAOFFSET_OTHER(st, m1, m2))
 400
 401 /* Required fields are the simplest. They just have delta (padding) from
 402  * previous field end, and the size of the field. Pointer is used for
 403  * submessages and default values.
 404  */
 405 #define PB_REQUIRED_STATIC(tag, st, m, fd, ltype, ptr) \
 406     {tag, PB_ATYPE_STATIC | PB_HTYPE_REQUIRED | ltype, \
 407     fd, 0, pb_membersize(st, m), 0, ptr}
 408
 409 /* Optional fields add the delta to the has_ variable. */
 410 #define PB_OPTIONAL_STATIC(tag, st, m, fd, ltype, ptr) \
 411     {tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
 412     fd, \
 413     pb_delta(st, has_ ## m, m), \
 414     pb_membersize(st, m), 0, ptr}
 415
 416 /* Repeated fields have a _count field and also the maximum number of entries. */
 417 #define PB_REPEATED_STATIC(tag, st, m, fd, ltype, ptr) \
 418     {tag, PB_ATYPE_STATIC | PB_HTYPE_REPEATED | ltype, \
 419     fd, \
 420     pb_delta(st, m ## _count, m), \
 421     pb_membersize(st, m[0]), \
 422     pb_arraysize(st, m), ptr}
 423
 424 /* Allocated fields carry the size of the actual data, not the pointer */
 425 #define PB_REQUIRED_POINTER(tag, st, m, fd, ltype, ptr) \
 426     {tag, PB_ATYPE_POINTER | PB_HTYPE_REQUIRED | ltype, \
 427     fd, 0, pb_membersize(st, m[0]), 0, ptr}
 428
 429 /* Optional fields don't need a has_ variable, as information would be redundant */
 430 #define PB_OPTIONAL_POINTER(tag, st, m, fd, ltype, ptr) \
 431     {tag, PB_ATYPE_POINTER | PB_HTYPE_OPTIONAL | ltype, \
 432     fd, 0, pb_membersize(st, m[0]), 0, ptr}
 433
 434 /* Repeated fields have a _count field and a pointer to array of pointers */
 435 #define PB_REPEATED_POINTER(tag, st, m, fd, ltype, ptr) \
 436     {tag, PB_ATYPE_POINTER | PB_HTYPE_REPEATED | ltype, \
 437     fd, pb_delta(st, m ## _count, m), \
 438     pb_membersize(st, m[0]), 0, ptr}
 439
 440 /* Callbacks are much like required fields except with special datatype. */
 441 #define PB_REQUIRED_CALLBACK(tag, st, m, fd, ltype, ptr) \
 442     {tag, PB_ATYPE_CALLBACK | PB_HTYPE_REQUIRED | ltype, \
 443     fd, 0, pb_membersize(st, m), 0, ptr}
 444
 445 #define PB_OPTIONAL_CALLBACK(tag, st, m, fd, ltype, ptr) \
 446     {tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
 447     fd, 0, pb_membersize(st, m), 0, ptr}
 448
 449 #define PB_REPEATED_CALLBACK(tag, st, m, fd, ltype, ptr) \
 450     {tag, PB_ATYPE_CALLBACK | PB_HTYPE_REPEATED | ltype, \
 451     fd, 0, pb_membersize(st, m), 0, ptr}
 452
 453 /* Optional extensions don't have the has_ field, as that would be redundant. */
 454 #define PB_OPTEXT_STATIC(tag, st, m, fd, ltype, ptr) \
 455     {tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
 456     0, \
 457     0, \
 458     pb_membersize(st, m), 0, ptr}
 459
 460 #define PB_OPTEXT_POINTER(tag, st, m, fd, ltype, ptr) \
 461     PB_OPTIONAL_POINTER(tag, st, m, fd, ltype, ptr)
 462
 463 #define PB_OPTEXT_CALLBACK(tag, st, m, fd, ltype, ptr) \
 464     PB_OPTIONAL_CALLBACK(tag, st, m, fd, ltype, ptr)
 465
 466 /* The mapping from protobuf types to LTYPEs is done using these macros. */
 467 #define PB_LTYPE_MAP_BOOL       PB_LTYPE_VARINT
 468 #define PB_LTYPE_MAP_BYTES      PB_LTYPE_BYTES
 469 #define PB_LTYPE_MAP_DOUBLE     PB_LTYPE_FIXED64
 470 #define PB_LTYPE_MAP_ENUM       PB_LTYPE_VARINT
 471 #define PB_LTYPE_MAP_UENUM      PB_LTYPE_UVARINT
 472 #define PB_LTYPE_MAP_FIXED32    PB_LTYPE_FIXED32
 473 #define PB_LTYPE_MAP_FIXED64    PB_LTYPE_FIXED64
 474 #define PB_LTYPE_MAP_FLOAT      PB_LTYPE_FIXED32
 475 #define PB_LTYPE_MAP_INT32      PB_LTYPE_VARINT
 476 #define PB_LTYPE_MAP_INT64      PB_LTYPE_VARINT
 477 #define PB_LTYPE_MAP_MESSAGE    PB_LTYPE_SUBMESSAGE
 478 #define PB_LTYPE_MAP_SFIXED32   PB_LTYPE_FIXED32
 479 #define PB_LTYPE_MAP_SFIXED64   PB_LTYPE_FIXED64
 480 #define PB_LTYPE_MAP_SINT32     PB_LTYPE_SVARINT
 481 #define PB_LTYPE_MAP_SINT64     PB_LTYPE_SVARINT
 482 #define PB_LTYPE_MAP_STRING     PB_LTYPE_STRING
 483 #define PB_LTYPE_MAP_UINT32     PB_LTYPE_UVARINT
 484 #define PB_LTYPE_MAP_UINT64     PB_LTYPE_UVARINT
 485 #define PB_LTYPE_MAP_EXTENSION  PB_LTYPE_EXTENSION
 486
 487 /* This is the actual macro used in field descriptions.
 488  * It takes these arguments:
 489  * - Field tag number
 490  * - Field type:   BOOL, BYTES, DOUBLE, ENUM, UENUM, FIXED32, FIXED64,
 491  *                 FLOAT, INT32, INT64, MESSAGE, SFIXED32, SFIXED64
 492  *                 SINT32, SINT64, STRING, UINT32, UINT64 or EXTENSION
 493  * - Field rules:  REQUIRED, OPTIONAL or REPEATED
 494  * - Allocation:   STATIC or CALLBACK
 495  * - Placement: FIRST or OTHER, depending on if this is the first field in structure.
 496  * - Message name
 497  * - Field name
 498  * - Previous field name (or field name again for first field)
 499  * - Pointer to default value or submsg fields.
 500  */
 501
 502 #define PB_FIELD(tag, type, rules, allocation, placement, message, field, prevfield, ptr) \
 503         PB_ ## rules ## _ ## allocation(tag, message, field, \
 504         PB_DATAOFFSET_ ## placement(message, field, prevfield), \
 505         PB_LTYPE_MAP_ ## type, ptr)
 506
 507 /* Field description for oneof fields. This requires taking into account the
 508  * union name also, that's why a separate set of macros is needed.
 509  */
 510 #define PB_ONEOF_STATIC(u, tag, st, m, fd, ltype, ptr) \
 511     {tag, PB_ATYPE_STATIC | PB_HTYPE_ONEOF | ltype, \
 512     fd, pb_delta(st, which_ ## u, u.m), \
 513     pb_membersize(st, u.m), 0, ptr}
 514
 515 #define PB_ONEOF_POINTER(u, tag, st, m, fd, ltype, ptr) \
 516     {tag, PB_ATYPE_POINTER | PB_HTYPE_ONEOF | ltype, \
 517     fd, pb_delta(st, which_ ## u, u.m), \
 518     pb_membersize(st, u.m[0]), 0, ptr}
 519
 520 #define PB_ONEOF_FIELD(union_name, tag, type, rules, allocation, placement, message, field, prevfield, ptr) \
 521         PB_ ## rules ## _ ## allocation(union_name, tag, message, field, \
 522         PB_DATAOFFSET_ ## placement(message, union_name.field, prevfield), \
 523         PB_LTYPE_MAP_ ## type, ptr)
 524
 525 /* These macros are used for giving out error messages.
 526  * They are mostly a debugging aid; the main error information
 527  * is the true/false return value from functions.
 528  * Some code space can be saved by disabling the error
 529  * messages if not used.
 530  *
 531  * PB_SET_ERROR() sets the error message if none has been set yet.
 532  *                msg must be a constant string literal.
 533  * PB_GET_ERROR() always returns a pointer to a string.
 534  * PB_RETURN_ERROR() sets the error and returns false from current
 535  *                   function.
 536  */
 537 #ifdef PB_NO_ERRMSG
 538 #define PB_SET_ERROR(stream, msg) PB_UNUSED(stream)
 539 #define PB_GET_ERROR(stream) "(errmsg disabled)"
 540 #else
 541 #define PB_SET_ERROR(stream, msg) (stream->errmsg = (stream)->errmsg ? (stream)->errmsg : (msg))
 542 #define PB_GET_ERROR(stream) ((stream)->errmsg ? (stream)->errmsg : "(none)")
 543 #endif
 544
 545 #define PB_RETURN_ERROR(stream, msg) return PB_SET_ERROR(stream, msg), false
 546
 547 #endif