X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=pb.h;h=502958be51fa04ce585afa406cdc3e93bc49f8ef;hb=7bcf7ef5796c66125a2a4df1317b55a27adedd89;hp=c075cdec2d3a1294dc1a4eebea240b66766f26b4;hpb=f8364310d3ca85d2cf59019bb4bc5e9ff4c52dc3;p=apps%2Fagl-service-can-low-level.git

diff --git a/pb.h b/pb.h
index c075cdec..502958be 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,23 +17,12 @@
 #define pb_packed
 #endif
 
-/* Lightweight output stream. */
-typedef struct _pb_ostream_t pb_ostream_t;
-struct _pb_ostream_t
-{
-    bool (*callback)(pb_ostream_t *stream, const uint8_t *buf, size_t count);
-    void *state; /* Free field for use by callback implementation */
-    size_t bytes_written;
-};
-
-/*static inline bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
-{
-    bool status = stream->callback(stream, buf, count);
-    stream->bytes_written += count;
-    return status;
-}*/
+/* Handly macro for suppressing unreferenced-parameter compiler warnings.    */
+#ifndef UNUSED
+#define UNUSED(x) (void)(x)
+#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.
  * 
@@ -46,25 +40,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 *
@@ -83,7 +78,8 @@ typedef enum {
     
     /* Works for all required/optional/repeated fields.
      * data_offset points to pb_callback_t structure.
-     * LTYPE is ignored. */
+     * LTYPE should be 0 (it is ignored, but sometimes
+     * used to speculatively index an array). */
     PB_HTYPE_CALLBACK = 0x30
 } pb_packed pb_type_t;
 
@@ -113,14 +109,13 @@ struct _pb_field_t {
 } pb_packed;
 
 /* This structure is used for 'bytes' arrays.
- * It has the number of bytes in the beginning, and after that an array. */
-#define PB_BYTES_ARRAY(buffersize) \
-struct { \
-    size_t size; \
-    uint8_t bytes[buffersize]; \
-}
-
-typedef PB_BYTES_ARRAY(1) pb_bytes_array_t;
+ * It has the number of bytes in the beginning, and after that an array.
+ * Note that actual structs used will have a different length of bytes array.
+ */
+typedef struct {
+    size_t size;
+    uint8_t bytes[1];
+} pb_bytes_array_t;
 
 /* This structure is used for giving the callback function.
  * It is stored in the message structure and filled in by the method that
@@ -137,24 +132,36 @@ typedef PB_BYTES_ARRAY(1) pb_bytes_array_t;
  * 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;
 typedef struct _pb_callback_t pb_callback_t;
 struct _pb_callback_t {
     union {
         bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
-        bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void *arg);
+        bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
     } funcs;
     
     /* Free arg for use by callback */
     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