summaryrefslogtreecommitdiff
path: root/core/upb_glue.h
diff options
context:
space:
mode:
authorJoshua Haberman <joshua@reverberate.org>2011-02-05 18:53:32 -0800
committerJoshua Haberman <joshua@reverberate.org>2011-02-05 18:53:32 -0800
commit3affb319260263efc3cee502896d9f981186c7da (patch)
tree6d519e32a23dc1d3b03c3da0791fd2ea00f154f4 /core/upb_glue.h
parente170259e4ababf39829fa9339fdf0817e38c949e (diff)
Tons of work: we're close to passing test_vs_proto2 again.
Diffstat (limited to 'core/upb_glue.h')
-rw-r--r--core/upb_glue.h42
1 files changed, 42 insertions, 0 deletions
diff --git a/core/upb_glue.h b/core/upb_glue.h
new file mode 100644
index 0000000..61111f5
--- /dev/null
+++ b/core/upb_glue.h
@@ -0,0 +1,42 @@
+/*
+ * upb - a minimalist implementation of protocol buffers.
+ *
+ * upb's core components like upb_decoder and upb_msg are carefully designed to
+ * avoid depending on each other for maximum orthogonality. In other words,
+ * you can use a upb_decoder to decode into *any* kind of structure; upb_msg is
+ * just one such structure. You can use upb_decoder without having to link in
+ * upb_msg.
+ *
+ * However, for convenience we provide functions here for doing common
+ * operations like deserializing protobuf binary format into a upb_msg. The
+ * compromise is that this file drags in almost all of upb as a dependency,
+ * which could be undesirable if you're trying to use a trimmed-down build of
+ * upb.
+ *
+ * Copyright (c) 2011 Joshua Haberman. See LICENSE for details.
+ */
+
+#ifndef UPB_GLUE_H
+#define UPB_GLUE_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Forward-declares so we don't have to include everything in this .h file.
+// Clients should use the regular, typedef'd names (eg. upb_string).
+struct _upb_string;
+struct _upb_msg;
+struct _upb_msgdef;
+struct _upb_status;
+
+// Decodes the given string, which must be in protobuf binary format, to the
+// given upb_msg with msgdef "md", storing the status of the operation in "s".
+void upb_strtomsg(struct _upb_string *str, struct _upb_msg *msg,
+ struct _upb_msgdef *md, struct _upb_status *s);
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback