Added comments to the simplest decode/encode examples.

git-svn-id: https://svn.kapsi.fi/jpa/nanopb@979 e3a754e5-d11d-0410-8d38-ebb782a927b9
This commit is contained in:
Petteri Aimonen
2011-09-18 16:04:45 +00:00
parent b2a696795e
commit d96e9575d4
2 changed files with 25 additions and 6 deletions

View File

@@ -1,11 +1,17 @@
/* A very simple decoding test case, using person.proto. /* A very simple decoding test case, using person.proto.
* Produces output compatible with protoc --decode. * Produces output compatible with protoc --decode.
* Reads the encoded data from stdin and prints the values
* to stdout as text.
*
* Run e.g. ./test_encode1 | ./test_decode1
*/ */
#include <stdio.h> #include <stdio.h>
#include <pb_decode.h> #include <pb_decode.h>
#include "person.pb.h" #include "person.pb.h"
/* This function is called once from main(), it handles
the decoding and printing. */
bool print_person(pb_istream_t *stream) bool print_person(pb_istream_t *stream)
{ {
int i; int i;
@@ -14,6 +20,8 @@ bool print_person(pb_istream_t *stream)
if (!pb_decode(stream, Person_fields, &person)) if (!pb_decode(stream, Person_fields, &person))
return false; return false;
/* Now the decoding is done, rest is just to print stuff out. */
printf("name: \"%s\"\n", person.name); printf("name: \"%s\"\n", person.name);
printf("id: %d\n", person.id); printf("id: %d\n", person.id);
@@ -46,6 +54,7 @@ bool print_person(pb_istream_t *stream)
return true; return true;
} }
/* This binds the pb_istream_t to stdin */
bool callback(pb_istream_t *stream, uint8_t *buf, size_t count) bool callback(pb_istream_t *stream, uint8_t *buf, size_t count)
{ {
FILE *file = (FILE*)stream->state; FILE *file = (FILE*)stream->state;
@@ -53,6 +62,7 @@ bool callback(pb_istream_t *stream, uint8_t *buf, size_t count)
if (buf == NULL) if (buf == NULL)
{ {
/* Skipping data */
while (count-- && fgetc(file) != EOF); while (count-- && fgetc(file) != EOF);
return count == 0; return count == 0;
} }
@@ -72,7 +82,10 @@ int main()
*/ */
pb_istream_t stream = {&callback, stdin, 10000}; pb_istream_t stream = {&callback, stdin, 10000};
if (!print_person(&stream)) if (!print_person(&stream))
{
printf("Parsing failed.\n"); printf("Parsing failed.\n");
return 1;
} else {
return 0; return 0;
}
} }

View File

@@ -1,11 +1,13 @@
/* A very simple encoding test case using person.proto. /* A very simple encoding test case using person.proto.
* Just puts constant data in the fields. * Just puts constant data in the fields and writes the
* data to stdout.
*/ */
#include <stdio.h> #include <stdio.h>
#include <pb_encode.h> #include <pb_encode.h>
#include "person.pb.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) bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
{ {
FILE *file = (FILE*) stream->state; FILE *file = (FILE*) stream->state;
@@ -14,12 +16,16 @@ bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
int main() int main()
{ {
/* Initialize the structure with constants */
Person person = {"Test Person 99", 99, true, "test@person.com", Person person = {"Test Person 99", 99, true, "test@person.com",
1, {{"555-12345678", true, Person_PhoneType_MOBILE}}}; 1, {{"555-12345678", true, Person_PhoneType_MOBILE}}};
/* Prepare the stream, output goes directly to stdout */
pb_ostream_t stream = {&streamcallback, stdout, SIZE_MAX, 0}; pb_ostream_t stream = {&streamcallback, stdout, SIZE_MAX, 0};
pb_encode(&stream, Person_fields, &person); /* Now encode it and check if we succeeded. */
if (pb_encode(&stream, Person_fields, &person))
return 0; return 0; /* Success */
else
return 1; /* Failure */
} }