upb_parser -> upb_decoder

1 files changed, 57 insertions, 0 deletions

diff --git a/src/upb_decoder.h b/src/upb_decoder.h
new file mode 100644
index 0000000..4251fda
--- /dev/null
+++ b/src/upb_decoder.h
@@ -0,0 +1,57 @@
+/*
+ * upb - a minimalist implementation of protocol buffers.
+ *
+ * upb_decoder implements a high performance, callback-based, stream-oriented
+ * decoder (comparable to the SAX model in XML parsers).  For parsing protobufs
+ * into in-memory messages (a more DOM-like model), see the routines in
+ * upb_msg.h, which are layered on top of this decoder.
+ *
+ * TODO: the decoder currently does not support returning unknown values.  This
+ * can easily be added when it is needed.
+ *
+ * Copyright (c) 2009 Joshua Haberman.  See LICENSE for details.
+ */
+
+#ifndef UPB_DECODER_H_
+#define UPB_DECODER_H_
+
+#include <stdbool.h>
+#include <stdint.h>
+#include "upb.h"
+#include "descriptor.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* upb_decoder *****************************************************************/
+
+// A upb_decoder decodes the binary protocol buffer format, writing the data it
+// decodes to a upb_sink.
+struct upb_decoder;
+typedef struct upb_decoder upb_decoder;
+
+// Allocates and frees a upb_decoder, respectively.
+upb_decoder *upb_decoder_new(struct upb_msgdef *md);
+void upb_decoder_free(upb_decoder *p);
+
+// Resets the internal state of an already-allocated decoder.  This puts it in a
+// state where it has not seen any data, and expects the next data to be from
+// the beginning of a new protobuf.  Parsers must be reset before they can be
+// used.  A decoder can be reset multiple times.
+void upb_decoder_reset(upb_decoder *p, upb_sink *sink);
+
+// Decodes protobuf data out of str, returning how much data was decoded.  The
+// next call to upb_decoder_decode should begin with the first byte that was
+// not decoded.  "status" indicates whether an error occurred.
+//
+// TODO: provide the following guarantee:
+//   retval will always be >= len.
+size_t upb_decoder_decode(upb_decoder *p, upb_strptr str,
+                          struct upb_status *status);
+
+#ifdef __cplusplus
+}  /* extern "C" */
+#endif
+
+#endif  /* UPB_DECODER_H_ */