X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=pb.h;h=fc74dbd4533370725d984df077d29efd2125b173;hb=95eb4a549981dc556dd30c5d76a6b437bb5ed06d;hp=46d7c2ce1e194b6eb82334da659f207f6232fae2;hpb=a8d0172507d59b73b95f766aa7644147fd060f20;p=apps%2Fagl-service-can-low-level.git

diff --git a/pb.h b/pb.h
index 46d7c2ce..fc74dbd4 100644
--- a/pb.h
+++ b/pb.h
@@ -1,6 +1,11 @@
 #ifndef _PB_H_
 #define _PB_H_
 
+/* pb.h: Common parts for nanopb library.
+ * Most of these are quite low-level stuff. For the high-level interface,
+ * see pb_encode.h or pb_decode.h
+ */
+
 #include <stdint.h>
 #include <stddef.h>
 #include <stdbool.h>
@@ -12,15 +17,18 @@
 #define pb_packed
 #endif
 
-/* Wire types */
-typedef enum {
-    PB_WT_VARINT = 0,
-    PB_WT_64BIT  = 1,
-    PB_WT_STRING = 2,
-    PB_WT_32BIT  = 5
-} pb_wire_type_t;
+/* Handly macro for suppressing unreferenced-parameter compiler warnings.    */
+#ifndef UNUSED
+#define UNUSED(x) (void)(x)
+#endif
+
+/* Number of required fields to keep track of
+ * (change here or on compiler command line). */
+#ifndef PB_MAX_REQUIRED_FIELDS
+#define PB_MAX_REQUIRED_FIELDS 64
+#endif
 
-/* List of possible field types
+/* List of possible field types. These are used in the autogenerated code.
  * Least-significant 4 bits tell the scalar type
  * Most-significant 4 bits specify repeated/required/packed etc.
  * 
@@ -38,25 +46,26 @@ typedef enum {
     /* Numeric types */
     PB_LTYPE_VARINT = 0x00, /* int32, uint32, int64, uint64, bool, enum */
     PB_LTYPE_SVARINT = 0x01, /* sint32, sint64 */
-    PB_LTYPE_FIXED = 0x02, /* fixed32, sfixed32, fixed64, sfixed64, float, double */
+    PB_LTYPE_FIXED32 = 0x02, /* fixed32, sfixed32, float */
+    PB_LTYPE_FIXED64 = 0x03, /* fixed64, sfixed64, double */
     
     /* Marker for last packable field type. */
-    PB_LTYPE_LAST_PACKABLE = 0x02,
+    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 = 0x03,
+    PB_LTYPE_BYTES = 0x04,
     
     /* String with pre-allocated buffer.
      * data_size is the maximum length. */
-    PB_LTYPE_STRING = 0x04,
+    PB_LTYPE_STRING = 0x05,
     
     /* Submessage
      * submsg_fields is pointer to field descriptions */
-    PB_LTYPE_SUBMESSAGE = 0x05,
+    PB_LTYPE_SUBMESSAGE = 0x06,
     
     /* Number of declared LTYPES */
-    PB_LTYPES_COUNT = 6,
+    PB_LTYPES_COUNT = 7,
     
     /******************
      * Modifier flags *
@@ -129,6 +138,8 @@ typedef struct {
  * The encoding callback will receive the actual output stream.
  * It should write all the data in one call, including the field tag and
  * wire type. It can write multiple fields.
+ *
+ * The callback can be null if you want to skip a field.
  */
 typedef struct _pb_istream_t pb_istream_t;
 typedef struct _pb_ostream_t pb_ostream_t;
@@ -143,11 +154,20 @@ struct _pb_callback_t {
     void *arg;
 };
 
+/* Wire types. Library user needs these only in encoder callbacks. */
+typedef enum {
+    PB_WT_VARINT = 0,
+    PB_WT_64BIT  = 1,
+    PB_WT_STRING = 2,
+    PB_WT_32BIT  = 5
+} pb_wire_type_t;
+
 /* These macros are used to declare pb_field_t's in the constant array. */
 #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_LAST_FIELD {0,0,0,0}
 
 
-#endif
\ No newline at end of file
+#endif