Fixed a bug related to submessage encoding into memory buffer.

Stream state was not copied back from substream in pb_enc_submessage,
which caused garbage output if the stream callback modified the state.

Expanded tests to cover this problem.

Thanks to Paweł Pery for debugging and reporting this problem.


git-svn-id: https://svn.kapsi.fi/jpa/nanopb@1089 e3a754e5-d11d-0410-8d38-ebb782a927b9

pb_encode.c

@@ -376,6 +376,7 @@ bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field
     status = pb_encode(&substream, (pb_field_t*)field->ptr, src);
     
     stream->bytes_written += substream.bytes_written;
+    stream->state = substream.state;
     
     if (substream.bytes_written != size)
         return false;

tests/Makefile

@@ -19,6 +19,7 @@ pb_decode.o: ../pb_decode.c $(DEPS)
 
 test_decode1: test_decode1.o pb_decode.o person.pb.o
 test_encode1: test_encode1.o pb_encode.o person.pb.o
+test_encode2: test_encode2.o pb_encode.o person.pb.o
 test_decode_callbacks: test_decode_callbacks.o pb_decode.o callbacks.pb.o
 test_encode_callbacks: test_encode_callbacks.o pb_encode.o callbacks.pb.o
 decode_unittests: decode_unittests.o pb_decode.o unittestproto.pb.o
@@ -37,7 +38,7 @@ coverage: run_unittests
 	gcov pb_encode.gcda
 	gcov pb_decode.gcda
 
-run_unittests: decode_unittests encode_unittests test_encode1 test_decode1 test_encode_callbacks test_decode_callbacks
+run_unittests: decode_unittests encode_unittests test_encode1 test_encode2 test_decode1 test_encode_callbacks test_decode_callbacks
 	rm -f *.gcda
 	
 	./decode_unittests > /dev/null
@@ -46,6 +47,9 @@ run_unittests: decode_unittests encode_unittests test_encode1 test_decode1 test_
 	[ "`./test_encode1 | ./test_decode1`" = \
 	"`./test_encode1 | protoc --decode=Person -I. -I../generator -I/usr/include person.proto`" ]
 
+	[ "`./test_encode2 | ./test_decode1`" = \
+	"`./test_encode2 | protoc --decode=Person -I. -I../generator -I/usr/include person.proto`" ]
+	
 	[ "`./test_encode_callbacks | ./test_decode_callbacks`" = \
 	"`./test_encode_callbacks | protoc --decode=TestMessage callbacks.proto`" ]
 

tests/test_decode1.c

@@ -34,6 +34,8 @@ bool print_person(pb_istream_t *stream)
         printf("phone {\n");
         printf("  number: \"%s\"\n", phone->number);
         
+        if (phone->has_type)
+        {
             switch (phone->type)
             {
                 case Person_PhoneType_WORK:
@@ -48,6 +50,7 @@ bool print_person(pb_istream_t *stream)
                     printf("  type: MOBILE\n");
                     break;
             }
+        }
         printf("}\n");
     }
     

tests/test_encode1.c

@@ -1,31 +1,32 @@
 /* A very simple encoding test case using person.proto.
- * Just puts constant data in the fields and writes the
+ * Just puts constant data in the fields and encodes into
- * data to stdout.
+ * buffer, which is then written to stdout.
  */
 
 #include <stdio.h>
 #include <pb_encode.h>
 #include "person.pb.h"
 
-/* This binds the pb_ostream_t into the stdout stream */
-bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
-{
-    FILE *file = (FILE*) stream->state;
-    return fwrite(buf, 1, count, file) == count;
-}
-
 int main()
 {
     /* Initialize the structure with constants */
     Person person = {"Test Person 99", 99, true, "test@person.com",
-        1, {{"555-12345678", true, Person_PhoneType_MOBILE}}};
+        3, {{"555-12345678", true, Person_PhoneType_MOBILE},
+            {"99-2342", false, 0},
+            {"1234-5678", true, Person_PhoneType_WORK},
+        }};
 
-    /* Prepare the stream, output goes directly to stdout */
+    uint8_t buffer[512];
-    pb_ostream_t stream = {&streamcallback, stdout, SIZE_MAX, 0};
+    pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
     
     /* Now encode it and check if we succeeded. */
     if (pb_encode(&stream, Person_fields, &person))
+    {
+        fwrite(buffer, stream.bytes_written, 1, stdout);
         return 0; /* Success */
+    }
     else
+    {
         return 1; /* Failure */
     }
+}

tests/test_encode2.c

@@ -0,0 +1,32 @@
+/* Same as test_encode1.c, except writes directly to stdout.
+ */
+
+#include <stdio.h>
+#include <pb_encode.h>
+#include "person.pb.h"
+
+/* This binds the pb_ostream_t into the stdout stream */
+bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
+{
+    FILE *file = (FILE*) stream->state;
+    return fwrite(buf, 1, count, file) == count;
+}
+
+int main()
+{
+    /* Initialize the structure with constants */
+    Person person = {"Test Person 99", 99, true, "test@person.com",
+        3, {{"555-12345678", true, Person_PhoneType_MOBILE},
+            {"99-2342", false, 0},
+            {"1234-5678", true, Person_PhoneType_WORK},
+        }};
+    
+    /* Prepare the stream, output goes directly to stdout */
+    pb_ostream_t stream = {&streamcallback, stdout, SIZE_MAX, 0};
+    
+    /* Now encode it and check if we succeeded. */
+    if (pb_encode(&stream, Person_fields, &person))
+        return 0; /* Success */
+    else
+        return 1; /* Failure */
+}