summaryrefslogtreecommitdiffstats
path: root/pb.h
diff options
context:
space:
mode:
authorPetteri Aimonen <jpa@git.mail.kapsi.fi>2013-02-21 19:38:56 +0200
committerPetteri Aimonen <jpa@git.mail.kapsi.fi>2013-02-21 19:38:56 +0200
commit5442e690f65fd09e7a44437da02fb7e14af6fe8f (patch)
treeecb8e53aec39dc51f6160d1664e4e50cd4996e64 /pb.h
parent5b536d40a11edb3161f2f19609c2b51899c354b0 (diff)
parent80a2d33fa9a835564b44fe97ba34e713901cf4fb (diff)
Merge branch 'dev-0.2'
Diffstat (limited to 'pb.h')
-rw-r--r--pb.h180
1 files changed, 125 insertions, 55 deletions
diff --git a/pb.h b/pb.h
index bca31022..dd06c69b 100644
--- a/pb.h
+++ b/pb.h
@@ -6,7 +6,7 @@
* see pb_encode.h or pb_decode.h
*/
-#define NANOPB_VERSION nanopb-0.1.9.1-dev
+#define NANOPB_VERSION nanopb-0.2.0-dev
#include <stdint.h>
#include <stddef.h>
@@ -53,60 +53,55 @@
* SINT* is different, though, because it is zig-zag coded.
*/
-typedef enum {
- /************************
- * Field contents types *
- ************************/
-
- /* Numeric types */
- PB_LTYPE_VARINT = 0x00, /* int32, uint32, int64, uint64, bool, enum */
- PB_LTYPE_SVARINT = 0x01, /* sint32, sint64 */
- PB_LTYPE_FIXED32 = 0x02, /* fixed32, sfixed32, float */
- PB_LTYPE_FIXED64 = 0x03, /* fixed64, sfixed64, double */
-
- /* Marker for last packable field type. */
- PB_LTYPE_LAST_PACKABLE = 0x03,
-
- /* Byte array with pre-allocated buffer.
- * data_size is the length of the allocated PB_BYTES_ARRAY structure. */
- PB_LTYPE_BYTES = 0x04,
-
- /* String with pre-allocated buffer.
- * data_size is the maximum length. */
- PB_LTYPE_STRING = 0x05,
-
- /* Submessage
- * submsg_fields is pointer to field descriptions */
- PB_LTYPE_SUBMESSAGE = 0x06,
-
- /* Number of declared LTYPES */
- PB_LTYPES_COUNT = 7,
- PB_LTYPE_MASK = 0x0F,
-
- /******************
- * Modifier flags *
- ******************/
-
- /* Just the basic, write data at data_offset */
- PB_HTYPE_REQUIRED = 0x00,
-
- /* Write true at size_offset */
- PB_HTYPE_OPTIONAL = 0x10,
-
- /* Read to pre-allocated array
- * Maximum number of entries is array_size,
- * actual number is stored at size_offset */
- PB_HTYPE_ARRAY = 0x20,
-
- /* Works for all required/optional/repeated fields.
- * data_offset points to pb_callback_t structure.
- * LTYPE should be valid or 0 (it is ignored, but
- * sometimes used to speculatively index an array). */
- PB_HTYPE_CALLBACK = 0x30,
-
- PB_HTYPE_MASK = 0xF0
-} pb_packed pb_type_t;
+typedef uint8_t pb_type_t;
+
+/************************
+ * Field contents types *
+ ************************/
+
+/* Numeric types */
+#define PB_LTYPE_VARINT 0x00 /* int32, uint32, int64, uint64, bool, enum */
+#define PB_LTYPE_SVARINT 0x01 /* sint32, sint64 */
+#define PB_LTYPE_FIXED32 0x02 /* fixed32, sfixed32, float */
+#define PB_LTYPE_FIXED64 0x03 /* fixed64, sfixed64, double */
+
+/* Marker for last packable field type. */
+#define PB_LTYPE_LAST_PACKABLE 0x03
+
+/* Byte array with pre-allocated buffer.
+ * data_size is the length of the allocated PB_BYTES_ARRAY structure. */
+#define PB_LTYPE_BYTES 0x04
+/* String with pre-allocated buffer.
+ * data_size is the maximum length. */
+#define PB_LTYPE_STRING 0x05
+
+/* Submessage
+ * submsg_fields is pointer to field descriptions */
+#define PB_LTYPE_SUBMESSAGE 0x06
+
+/* Number of declared LTYPES */
+#define PB_LTYPES_COUNT 7
+#define PB_LTYPE_MASK 0x0F
+
+/**************************
+ * Field repetition rules *
+ **************************/
+
+#define PB_HTYPE_REQUIRED 0x00
+#define PB_HTYPE_OPTIONAL 0x10
+#define PB_HTYPE_REPEATED 0x20
+#define PB_HTYPE_MASK 0x30
+
+/********************
+ * Allocation types *
+ ********************/
+
+#define PB_ATYPE_STATIC 0x00
+#define PB_ATYPE_CALLBACK 0x40
+#define PB_ATYPE_MASK 0xC0
+
+#define PB_ATYPE(x) ((x) & PB_ATYPE_MASK)
#define PB_HTYPE(x) ((x) & PB_HTYPE_MASK)
#define PB_LTYPE(x) ((x) & PB_LTYPE_MASK)
@@ -204,9 +199,84 @@ typedef enum {
#define pb_membersize(st, m) (sizeof ((st*)0)->m)
#define pb_arraysize(st, m) (pb_membersize(st, m) / pb_membersize(st, m[0]))
#define pb_delta(st, m1, m2) ((int)offsetof(st, m1) - (int)offsetof(st, m2))
-#define pb_delta_end(st, m1, m2) (offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
+#define pb_delta_end(st, m1, m2) (offsetof(st, m1) == offsetof(st, m2) \
+ ? offsetof(st, m1) \
+ : offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
#define PB_LAST_FIELD {0,(pb_type_t) 0,0,0,0,0,0}
+/* Required fields are the simplest. They just have delta (padding) from
+ * previous field end, and the size of the field. Pointer is used for
+ * submessages and default values.
+ */
+#define PB_REQUIRED_STATIC(tag, st, m, pm, ltype, ptr) \
+ {tag, PB_ATYPE_STATIC | PB_HTYPE_REQUIRED | ltype, \
+ pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
+
+/* Optional fields add the delta to the has_ variable. */
+#define PB_OPTIONAL_STATIC(tag, st, m, pm, ltype, ptr) \
+ {tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
+ pb_delta_end(st, m, pm), \
+ pb_delta(st, has_ ## m, m), \
+ pb_membersize(st, m), 0, ptr}
+
+/* Repeated fields have a _count field and also the maximum number of entries. */
+#define PB_REPEATED_STATIC(tag, st, m, pm, ltype, ptr) \
+ {tag, PB_ATYPE_STATIC | PB_HTYPE_REPEATED | ltype, \
+ pb_delta_end(st, m, pm), \
+ pb_delta(st, m ## _count, m), \
+ pb_membersize(st, m[0]), \
+ pb_arraysize(st, m), ptr}
+
+/* Callbacks are much like required fields except with special datatype. */
+#define PB_REQUIRED_CALLBACK(tag, st, m, pm, ltype, ptr) \
+ {tag, PB_ATYPE_CALLBACK | PB_HTYPE_REQUIRED | ltype, \
+ pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
+
+#define PB_OPTIONAL_CALLBACK(tag, st, m, pm, ltype, ptr) \
+ {tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
+ pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
+
+#define PB_REPEATED_CALLBACK(tag, st, m, pm, ltype, ptr) \
+ {tag, PB_ATYPE_CALLBACK | PB_HTYPE_REPEATED | ltype, \
+ pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
+
+/* The mapping from protobuf types to LTYPEs is done using these macros. */
+#define PB_LTYPE_MAP_BOOL PB_LTYPE_VARINT
+#define PB_LTYPE_MAP_BYTES PB_LTYPE_BYTES
+#define PB_LTYPE_MAP_DOUBLE PB_LTYPE_FIXED64
+#define PB_LTYPE_MAP_ENUM PB_LTYPE_VARINT
+#define PB_LTYPE_MAP_FIXED32 PB_LTYPE_FIXED32
+#define PB_LTYPE_MAP_FIXED64 PB_LTYPE_FIXED64
+#define PB_LTYPE_MAP_FLOAT PB_LTYPE_FIXED32
+#define PB_LTYPE_MAP_INT32 PB_LTYPE_VARINT
+#define PB_LTYPE_MAP_INT64 PB_LTYPE_VARINT
+#define PB_LTYPE_MAP_MESSAGE PB_LTYPE_SUBMESSAGE
+#define PB_LTYPE_MAP_SFIXED32 PB_LTYPE_FIXED32
+#define PB_LTYPE_MAP_SFIXED64 PB_LTYPE_FIXED64
+#define PB_LTYPE_MAP_SINT32 PB_LTYPE_SVARINT
+#define PB_LTYPE_MAP_SINT64 PB_LTYPE_SVARINT
+#define PB_LTYPE_MAP_STRING PB_LTYPE_STRING
+#define PB_LTYPE_MAP_UINT32 PB_LTYPE_VARINT
+#define PB_LTYPE_MAP_UINT64 PB_LTYPE_VARINT
+
+/* This is the actual macro used in field descriptions.
+ * It takes these arguments:
+ * - Field tag number
+ * - Field type: BOOL, BYTES, DOUBLE, ENUM, FIXED32, FIXED64,
+ * FLOAT, INT32, INT64, MESSAGE, SFIXED32, SFIXED64
+ * SINT32, SINT64, STRING, UINT32 or UINT64
+ * - Field rules: REQUIRED, OPTIONAL or REPEATED
+ * - Allocation: STATIC or CALLBACK
+ * - Message name
+ * - Field name
+ * - Previous field name (or field name again for first field)
+ * - Pointer to default value or submsg fields.
+ */
+
+#define PB_FIELD(tag, type, rules, allocation, message, field, prevfield, ptr) \
+ PB_ ## rules ## _ ## allocation(tag, message, field, prevfield, \
+ PB_LTYPE_MAP_ ## type, ptr)
+
/* These macros are used for giving out error messages.
* They are mostly a debugging aid; the main error information
* is the true/false return value from functions.