VOC / Mbed 2 deprecated Dumb_box_rev2

test

Dependencies:   Nanopb iSerial mbed BaseJpegDecode FatFileSystem SDFileSystem RingBuffer Camera_LS_Y201

Nanopb/pb.h@0:d69efd0ee139, 2014-09-18 (annotated)

Committer:
cgraham
Date:
Thu Sep 18 15:21:47 2014 +0000
Revision:
0:d69efd0ee139
test

Who changed what in which revision?

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