Rename pb_field_iterator_t field 'current' to 'pos'.
[apps/agl-service-can-low-level.git] / pb_decode.h
index 27535c1..35de0a2 100644 (file)
 #include <stdbool.h>
 #include "pb.h"
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /* Lightweight input stream.
  * You can provide a callback function for reading or use
  * pb_istream_from_buffer.
  * Rules for callback:
  * 1) Return false on IO errors. This will cause decoding to abort.
  * 
- * 2) If buf is NULL, read but don't store bytes ("skip input").
- * 
- * 3) You can use state to store your own data (e.g. buffer pointer),
+ * 2) You can use state to store your own data (e.g. buffer pointer),
  * and rely on pb_read to verify that no-body reads past bytes_left.
+ * 
+ * 3) Your callback may be used with substreams, in which case bytes_left
+ * is different than from the main stream. Don't use bytes_left to compute
+ * any pointers.
  */
 struct _pb_istream_t
 {
+#ifdef PB_BUFFER_ONLY
+    /* Callback pointer is not used in buffer-only configuration.
+     * Having an int pointer here allows binary compatibility but
+     * gives an error if someone tries to assign callback function.
+     */
+    int *callback;
+#else
     bool (*callback)(pb_istream_t *stream, uint8_t *buf, size_t count);
+#endif
+
     void *state; /* Free field for use by callback implementation */
     size_t bytes_left;
+    
+#ifndef PB_NO_ERRMSG
+    const char *errmsg;
+#endif
 };
 
 pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
@@ -40,6 +59,12 @@ bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
  */
 bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
 
+/* Same as pb_decode, except does not initialize the destination structure
+ * to default values. This is slightly faster if you need no default values
+ * and just do memset(struct, 0, sizeof(struct)) yourself.
+ */
+bool pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
+
 /* --- Helper functions ---
  * You may want to use these from your caller or callbacks.
  */
@@ -69,6 +94,7 @@ bool pb_decode_fixed64(pb_istream_t *stream, void *dest);
 
 /* Make a limited-length substream for reading a PB_WT_STRING field. */
 bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream);
+void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream);
 
 /* --- Internal functions ---
  * These functions are not terribly useful for the average library user, but
@@ -89,4 +115,8 @@ bool pb_skip_varint(pb_istream_t *stream);
 bool pb_skip_string(pb_istream_t *stream);
 #endif
 
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
 #endif