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