From 4a8b9be46c9485a35383b52d400ba086d3f40ace Mon Sep 17 00:00:00 2001
From: Joshua Haberman <jhaberman@gmail.com>
Date: Wed, 31 Aug 2011 20:03:59 -0700
Subject: Header cleanup, clarify/correct comments for interfaces.

---
 upb/pb/decoder.c |  9 +--------
 upb/pb/decoder.h | 28 +++++++++-------------------
 upb/pb/glue.c    |  7 +++++--
 3 files changed, 15 insertions(+), 29 deletions(-)

(limited to 'upb/pb')

diff --git a/upb/pb/decoder.c b/upb/pb/decoder.c
index fd04efc..ff39685 100644
--- a/upb/pb/decoder.c
+++ b/upb/pb/decoder.c
@@ -400,7 +400,7 @@ static void upb_decoder_skip(void *_d, upb_dispatcher_frame *top,
 #endif
 }
 
-void upb_decoder_initforhandlers(upb_decoder *d, upb_handlers *handlers) {
+void upb_decoder_init(upb_decoder *d, upb_handlers *handlers) {
   upb_dispatcher_init(
       &d->dispatcher, handlers, upb_decoder_skip, upb_decoder_exit2, d);
 #ifdef UPB_USE_JIT_X64
@@ -423,13 +423,6 @@ void upb_decoder_initforhandlers(upb_decoder *d, upb_handlers *handlers) {
   }
 }
 
-void upb_decoder_initformsgdef(upb_decoder *d, upb_msgdef *m) {
-  upb_handlers *h = upb_handlers_new();
-  upb_accessors_reghandlers(h, m);
-  upb_decoder_initforhandlers(d, h);
-  upb_handlers_unref(h);
-}
-
 void upb_decoder_reset(upb_decoder *d, upb_bytesrc *bytesrc, uint64_t start_ofs,
                        uint64_t end_ofs, void *closure) {
   upb_dispatcher_frame *f = upb_dispatcher_reset(&d->dispatcher, closure);
diff --git a/upb/pb/decoder.h b/upb/pb/decoder.h
index 921697a..2232c52 100644
--- a/upb/pb/decoder.h
+++ b/upb/pb/decoder.h
@@ -5,13 +5,8 @@
  * Author: Josh Haberman <jhaberman@gmail.com>
  *
  * upb_decoder implements a high performance, streaming decoder for protobuf
- * data that works by implementing upb_src and getting its data from a
- * upb_bytesrc.
- *
- * The decoder does not currently support non-blocking I/O, in the sense that
- * if the bytesrc returns UPB_STATUS_TRYAGAIN it is not possible to resume the
- * decoder when data becomes available again.  Support for this could be added,
- * but it would add complexity and perhaps cost efficiency also.
+ * data that works by getting its input data from a upb_bytesrc and calling
+ * into a upb_handlers.
  */
 
 #ifndef UPB_DECODER_H_
@@ -36,18 +31,18 @@ typedef struct _upb_decoder {
   upb_status *status;         // Where we will store any errors that occur.
   upb_strref strref;          // For passing string data to callbacks.
 
-  // Offsets for the region we currently have ref'd.
+  // Offsets for the bytesrc region we currently have ref'd.
   uint64_t refstart_ofs, refend_ofs;
 
-  // Current buffer and its stream offset.
+  // Current input buffer and its stream offset.
   const char *buf, *ptr, *end;
   uint64_t bufstart_ofs, bufend_ofs;
 
   // Stream offset for the end of the top-level message, if any.
   uint64_t end_ofs;
 
-  // Buf offset as of which we've delivered calbacks; needed for rollback on
-  // UPB_TRYAGAIN (or in the future, UPB_SUSPEND).
+  // Buf offset as of which we've delivered calbacks; needed for rollback if
+  // a callback returns UPB_BREAK.
   const char *completed_ptr;
 
   // End of the delimited region, relative to ptr, or NULL if not in this buf.
@@ -66,6 +61,7 @@ typedef struct _upb_decoder {
   struct dasm_State *dynasm;
 #endif
 
+  // For exiting the decoder on error.
   sigjmp_buf exitjmp;
 } upb_decoder;
 
@@ -75,14 +71,8 @@ typedef struct _upb_decoder {
 
 // Initializes/uninitializes a decoder for calling into the given handlers
 // or to write into the given msgdef, given its accessors).  Takes a ref
-// on the handlers or msgdef.
-void upb_decoder_initforhandlers(upb_decoder *d, upb_handlers *h);
-
-// Equivalent to:
-//   upb_accessors_reghandlers(m, h);
-//   upb_decoder_initforhandlers(d, h);
-// except possibly more efficient, by using cached state in the msgdef.
-void upb_decoder_initformsgdef(upb_decoder *d, upb_msgdef *m);
+// on the handlers.
+void upb_decoder_init(upb_decoder *d, upb_handlers *h);
 void upb_decoder_uninit(upb_decoder *d);
 
 // Resets the internal state of an already-allocated decoder.  This puts it in a
diff --git a/upb/pb/glue.c b/upb/pb/glue.c
index 8034c54..6981aa2 100644
--- a/upb/pb/glue.c
+++ b/upb/pb/glue.c
@@ -19,7 +19,10 @@ void upb_strtomsg(const char *str, size_t len, void *msg, upb_msgdef *md,
   upb_stringsrc_reset(&strsrc, str, len);
 
   upb_decoder d;
-  upb_decoder_initformsgdef(&d, md);
+  upb_handlers *h = upb_handlers_new();
+  upb_accessors_reghandlers(h, md);
+  upb_decoder_init(&d, h);
+  upb_handlers_unref(h);
   upb_decoder_reset(&d, upb_stringsrc_bytesrc(&strsrc), 0, UINT64_MAX, msg);
   upb_decoder_decode(&d, status);
 
@@ -63,7 +66,7 @@ upb_def **upb_load_descriptor(const char *str, size_t len, int *n,
   upb_descreader_reghandlers(h);
 
   upb_decoder d;
-  upb_decoder_initforhandlers(&d, h);
+  upb_decoder_init(&d, h);
   upb_handlers_unref(h);
   upb_descreader r;
   upb_descreader_init(&r);
-- 
cgit v1.2.3