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