summaryrefslogtreecommitdiff
path: root/DESIGN.md
diff options
context:
space:
mode:
authorJoshua Haberman <jhaberman@gmail.com>2019-05-15 14:00:56 -0700
committerJoshua Haberman <jhaberman@gmail.com>2019-05-15 14:00:56 -0700
commit4d89a44b2626ca52998344b95f6f86ea068c4e56 (patch)
treecaeff10d42a7ced0f6f7a474db122251131d9e3d /DESIGN.md
parentae107c7ab983f22791897569ec7b8356e76d72fb (diff)
Some revisions to README.md and DESIGN.md.
Diffstat (limited to 'DESIGN.md')
-rw-r--r--DESIGN.md33
1 files changed, 11 insertions, 22 deletions
diff --git a/DESIGN.md b/DESIGN.md
index 4e6dc04..a7a8a28 100644
--- a/DESIGN.md
+++ b/DESIGN.md
@@ -2,9 +2,6 @@
μpb Design
----------
-**NOTE:** the design described here is being implemented currently, but is not
-yet complete. The repo is in heavy transition right now.
-
μpb has the following design goals:
- C89 compatible.
@@ -62,22 +59,14 @@ link μpb will never need to worry about this.
TODO
----
-The current state of the repo is quite different than what is described above.
-Here are the major items that need to be implemented.
-
-1. implement the core generic protobuf binary encoder/decoder that uses a
- `upb_msglayout*`.
-2. remove all mention of handlers, sink, etc. from core into their own module.
- All of the handlers stuff needs substantial revision, but moving it out of
- core is the first priority.
-3. move all of the def/refcounted stuff out of core. The defs also need
- substantial revision, but moving them out of core is the first priority.
-4. revise our generated code until it is in a state where we feel comfortable
- committing to API/ABI stability for it. This may involve moving different
- parts of the generated code into separate files, like keeping the serialized
- descriptor in a separate file from the compact msglayout.
-5. revise all of the existing encoders/decoders and handlers. We probably
- will want to keep handlers, since they let us decouple encoders/decoders
- from `upb_msg`, but we need to simplify all of that a LOT. Likely we will
- want to make handlers only per-message instead of per-field, except for
- variable-length fields.
+1. revise our generated code until it is in a state where we feel comfortable
+ committing to API/ABI stability for it. In particular there is an open
+ question of whether non-ABI-compatible field accesses should have a
+ fastpath different from the ABI-compatible field access.
+1. Add missing features (maps, extensions, unknown fields).
+1. Flesh out C++ wrappers.
+1. *(lower-priority)*: revise all of the existing encoders/decoders and
+ handlers. We probably will want to keep handlers, since they let us decouple
+ encoders/decoders from `upb_msg`, but we need to simplify all of that a LOT.
+ Likely we will want to make handlers only per-message instead of per-field,
+ except for variable-length fields.
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback