Compare commits

..

12 Commits

Author SHA1 Message Date
Petteri Aimonen
5af2c97ecd Add descriptor.proto into the #include exclusion list 2012-06-12 17:51:08 +03:00
Petteri Aimonen
feddc0115c Merge branch 'master' of https://code.google.com/p/nanopb 2012-05-19 21:25:47 +03:00
Petteri Aimonen
f9501ca185 Add better error messages in the generator when libraries cannot be imported.
Fixes issue #5.
2012-05-19 21:25:10 +03:00
Petteri Aimonen
b943290886 Fix 64-bitness warnings in the example.
Fixes issues 9 and 10.
2012-05-19 21:17:24 +03:00
Petteri Aimonen
d1ca88d20e Fixing compiler warnings, mostly related to unused parameters.
Thanks to David Hotham for the patch. Fixes issue 8.
2012-04-18 20:15:36 +03:00
Petteri Aimonen
9fbe9a5de3 Refactoring the field encoder interface.
Replaced the confusing pb_enc_* functions with new pb_encode_* functions that
have a cleaner interface. Updated documentation.

Got rid of the endian_copy stuff in pb_encode.c, instead using C casts to do it automatically.
This makes the code safer and also reduces binary size by about 5%.

Fixes Issue 6.
2012-03-01 13:46:52 +02:00
Petteri Aimonen
0cdc623050 Modified nanopb_generator.py to generate includes for other .proto files.
Implementation was suggested by extremeblue99.
Fixes issue 4.
2012-02-15 17:34:48 +02:00
Petteri Aimonen
f6b08404fa Fixed nanopb_generator.py to read the input file in binary mode. 2012-01-30 10:36:17 +02:00
Petteri Aimonen
b36a1a259a Improved documentation on field decoders. 2012-01-23 18:13:26 +02:00
Petteri Aimonen
113bd7ee87 Fixed issue 1 reported by Erik Rosen:
The size of non-callback bytes-fields was miscalculated, which
caused all following fields in a message to contain garbage.

Previous commit contains a testcase for this.

This fix changes the generated message description. If your protocol uses
bytes-fields, you should regenerate *.pb.c.
2012-01-12 19:08:05 +02:00
Petteri Aimonen
0f6b615ae3 Added an encode/decode test for 'required' fields of all types. 2012-01-12 19:06:33 +02:00
Petteri Aimonen
a1adf39805 Fixed a bug in the generator that caused a compiler error on sfixed32 and sfixed64 fields. 2012-01-12 18:10:12 +02:00
31 changed files with 723 additions and 1562 deletions

View File

@@ -1,5 +1,4 @@
Copyright (c) 2011 Petteri Aimonen <jpa at nanopb.mail.kapsi.fi> Copyright (c) 2011 Petteri Aimonen <jpa at nanopb.mail.kapsi.fi>
Copyright (c) 2011 Michael Poole <mdpoole@troilus.org>
This software is provided 'as-is', without any express or This software is provided 'as-is', without any express or
implied warranty. In no event will the authors be held liable implied warranty. In no event will the authors be held liable

View File

@@ -74,7 +74,7 @@ This is the way to get the size of the message without storing it anywhere::
Person myperson = ...; Person myperson = ...;
pb_ostream_t sizestream = {0}; pb_ostream_t sizestream = {0};
pb_encode(&sizestream, Person_msg, &myperson); pb_encode(&sizestream, Person_fields, &myperson);
printf("Encoded size is %d\n", sizestream.bytes_written); printf("Encoded size is %d\n", sizestream.bytes_written);
**Example 2:** **Example 2:**
@@ -142,7 +142,6 @@ Most Protocol Buffers datatypes have directly corresponding C datatypes, such as
1) Strings, bytes and repeated fields of any type map to callback functions by default. 1) Strings, bytes and repeated fields of any type map to callback functions by default.
2) If there is a special option *(nanopb).max_size* specified in the .proto file, string maps to null-terminated char array and bytes map to a structure containing a char array and a size field. 2) If there is a special option *(nanopb).max_size* specified in the .proto file, string maps to null-terminated char array and bytes map to a structure containing a char array and a size field.
3) If there is a special option *(nanopb).max_count* specified on a repeated field, it maps to an array of whatever type is being repeated. Another field will be created for the actual number of entries stored. 3) If there is a special option *(nanopb).max_count* specified on a repeated field, it maps to an array of whatever type is being repeated. Another field will be created for the actual number of entries stored.
4) The option *(nanopb).pointer* can override the default (false, unless the *-p* option is passed to *nanopb_generator.py*) behavior. If a string, byte, or submessage is generated as a pointer field, and it is repeated (with a maximum count), required, or optional, the members will be pointers rather than in-line data.
=============================================================================== ======================= =============================================================================== =======================
field in .proto autogenerated in .h field in .proto autogenerated in .h
@@ -157,18 +156,12 @@ required bytes data = 1 [(nanopb).max_size = 40];
| uint8_t bytes[40]; | uint8_t bytes[40];
| } Person_data_t; | } Person_data_t;
| Person_data_t data; | Person_data_t data;
required string name = 1 [(nanopb).pointer = true]; char \*name;
required bytes data = 1 [(nanopb).pointer = true]; pb_bytes_t data;
required bytes data = 1 [(nanopb).pointer = true, (nanopb).max_count = 5]; | size_t data_count;
| pb_bytes_t data[5];
required Message msg = 1 [(nanopb).pointer = true]; Message \*msg;
=============================================================================== ======================= =============================================================================== =======================
The maximum lengths are checked in runtime. If string/bytes/array exceeds the allocated length, *pb_decode* will return false. The maximum lengths are checked in runtime. If string/bytes/array exceeds the allocated length, *pb_decode* will return false.
If a pointer-type field is not received, the field will be marked as absent, but the pointer will not be modified. This helps reduce memory fragmentation and churn, but increases worst-case memory usage and means you must use the *Message_has(object, Field)* macro rather than testing for a null pointer. You can use the `pb_clean`_ function to release unused memory in these cases. Note: for the *bytes* datatype, the field length checking may not be exact.
The compiler may add some padding to the *pb_bytes_t* structure, and the nanopb runtime doesn't know how much of the structure size is padding. Therefore it uses the whole length of the structure for storing data, which is not very smart but shouldn't cause problems. In practise, this means that if you specify *(nanopb).max_size=5* on a *bytes* field, you may be able to store 6 bytes there. For the *string* field type, the length limit is exact.
.. _`pb_clean`: reference.html#pb-clean
Field callbacks Field callbacks
=============== ===============
@@ -183,20 +176,16 @@ Encoding callbacks
:: ::
bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg); bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
bool (*encode_buffer)(pb_strstream_t *stream, const pb_field_t *field, const void *arg);
When encoding, the callbacks should write out complete fields, including the wire type and field number tag. The callback can write as many or as few fields as it likes. For example, if you want to write out an array as *repeated* field, you should do it all in a single call. When encoding, the callback should write out complete fields, including the wire type and field number tag. It can write as many or as few fields as it likes. For example, if you want to write out an array as *repeated* field, you should do it all in a single call.
Usually you can use `pb_encode_tag_for_field`_ (or `pb_encbuf_tag_for_field`_ for the *encode_buffer* callback) to encode the wire type and tag number of the field. However, if you want to encode a repeated field as a packed array, you must call `pb_encode_tag`_ (respectively, `pb_encbuf_tag`_) instead to specify a wire type of *PB_WT_STRING*. Usually you can use `pb_encode_tag_for_field`_ to encode the wire type and tag number of the field. However, if you want to encode a repeated field as a packed array, you must call `pb_encode_tag`_ instead to specify a wire type of *PB_WT_STRING*.
If the callback is used in a submessage, *encode* will be called multiple times during a single call to `pb_encode`_. In this case, it must produce the same amount of data every time. If the callback is directly in the main message, or if you are using `pb_encode_buffer`_, the callback is called only once. If the callback is used in a submessage, it will be called multiple times during a single call to `pb_encode`_. In this case, it must produce the same amount of data every time. If the callback is directly in the main message, it is called only once.
.. _`pb_encode`: reference.html#pb-encode .. _`pb_encode`: reference.html#pb-encode
.. _`pb_encode_buffer`: reference.html#pb-encode-buffer
.. _`pb_encode_tag_for_field`: reference.html#pb-encode-tag-for-field .. _`pb_encode_tag_for_field`: reference.html#pb-encode-tag-for-field
.. _`pb_encbuf_tag_for_field`: reference.html#pb-encbuf-tag-for-field
.. _`pb_encode_tag`: reference.html#pb-encode-tag .. _`pb_encode_tag`: reference.html#pb-encode-tag
.. _`pb_encbuf_tag`: reference.html#pb-encbuf-tag
This callback writes out a dynamically sized string:: This callback writes out a dynamically sized string::
@@ -209,17 +198,6 @@ This callback writes out a dynamically sized string::
return pb_encode_string(stream, (uint8_t*)str, strlen(str)); return pb_encode_string(stream, (uint8_t*)str, strlen(str));
} }
The equivalent for in-memory buffers has to write the elements in the opposite order, because the buffer writers prepend their data::
bool write_string_buf(pb_strstream_t *stream, const pb_field_t *field, const void *arg)
{
char *str = get_string_from_somewhere();
if (!pb_encbuf_string(stream, (uint8_t*)str, strlen(str)))
return false;
return pb_encbuf_tag_for_field(stream, field));
}
Decoding callbacks Decoding callbacks
------------------ ------------------
:: ::
@@ -246,10 +224,10 @@ This callback reads multiple integers and prints them::
return true; return true;
} }
Message descriptor Field description array
================== =======================
For using the *pb_encode*, *pb_encode_buffer* and *pb_decode* functions, you need a message descriptor describing the structure you wish to encode. This description is usually autogenerated from .proto file. For using the *pb_encode* and *pb_decode* functions, you need an array of pb_field_t constants describing the structure you wish to encode. This description is usually autogenerated from .proto file.
For example this submessage in the Person.proto file:: For example this submessage in the Person.proto file::
@@ -260,51 +238,22 @@ For example this submessage in the Person.proto file::
} }
} }
generates these declarations and definitions for the structure *Person_PhoneNumber*:: generates this field description array for the structure *Person_PhoneNumber*::
typedef PB_MSG_STRUCT(2) Person_PhoneNumber_msg_t;
extern const Person_PhoneNumber_msg_t Person_PhoneNumber_real_msg;
#define Person_PhoneNumber_msg ((const pb_message_t*)&Person_PhoneNumber_real_msg)
const Person_PhoneNumber_msg_t Person_PhoneNumber_real_msg = {
2,
{
const pb_field_t Person_PhoneNumber_fields[3] = {
{1, PB_HTYPE_REQUIRED | PB_LTYPE_STRING, {1, PB_HTYPE_REQUIRED | PB_LTYPE_STRING,
offsetof(Person_PhoneNumber, number), 0, offsetof(Person_PhoneNumber, number), 0,
pb_membersize(Person_PhoneNumber, number), 0, 0}, pb_membersize(Person_PhoneNumber, number), 0, 0},
{2, PB_HTYPE_OPTIONAL | PB_LTYPE_VARINT, {2, PB_HTYPE_OPTIONAL | PB_LTYPE_VARINT,
pb_delta_end(Person_PhoneNumber, type, number), 0, pb_delta(Person_PhoneNumber, type, number),
pb_delta(Person_PhoneNumber, has_type, type),
pb_membersize(Person_PhoneNumber, type), 0, pb_membersize(Person_PhoneNumber, type), 0,
&Person_PhoneNumber_type_default}, &Person_PhoneNumber_type_default},
} PB_LAST_FIELD
}; };
#define Person_PhoneNumber_has(STRUCT, FIELD) PB_HAS_FIELD(STRUCT, Person_PhoneNumber, FIELD)
#define Person_PhoneNumber_set(STRUCT, FIELD) PB_SET_FIELD(STRUCT, Person_PhoneNumber, FIELD)
#define Person_PhoneNumber_clear(STRUCT, FIELD) PB_CLEAR_FIELD(STRUCT, Person_PhoneNumber, FIELD)
#define Person_PhoneNumber_number_index 0
#define Person_PhoneNumber_number_tag 1
#define Person_PhoneNumber_type_index 1
#define Person_PhoneNumber_type_tag 2
Optional Fields
===============
The *has_fields* member of each generated structure is an array where
each bit indicates the presence of the corresponding (optional) field.
The generated header file provides helper macros to read and update
that array; in the previous example, they are
*Person_PhoneNumber_has*, *Person_PhoneNumber_set* and
*Person_PhoneNumber_clear*.
For convenience, *pb_encode* and *pb_encode_buffer* only check these
bits for optional fields. *pb_decode* sets the corresponding bit for
every field it decodes, whether the field is optional or not.
.. Should there be a section here on pointer fields?
Return values and error handling Return values and error handling
================================ ================================

View File

@@ -14,9 +14,6 @@ Overall structure
For the runtime program, you always need *pb.h* for type declarations. For the runtime program, you always need *pb.h* for type declarations.
Depending on whether you want to encode, decode, or both, you also need *pb_encode.h/c* or *pb_decode.h/c*. Depending on whether you want to encode, decode, or both, you also need *pb_encode.h/c* or *pb_decode.h/c*.
If you only encode into in-memory buffers, *pb_decode_buffer.h/c* should be slightly faster and smaller.
If your *.proto* file encodes submessages or other fields using pointers, you must compile *pb_decode.c* with a preprocessor macro named *MALLOC_HEADER* that is the name of a header with definitions (either as functions or macros) for *calloc()*, *realloc()* and *free()*. For a typical hosted configuration, this should be *<stdlib.h>*.
The high-level encoding and decoding functions take an array of *pb_field_t* structures, which describes the fields of a message structure. Usually you want these autogenerated from a *.proto* file. The tool script *nanopb_generator.py* accomplishes this. The high-level encoding and decoding functions take an array of *pb_field_t* structures, which describes the fields of a message structure. Usually you want these autogenerated from a *.proto* file. The tool script *nanopb_generator.py* accomplishes this.
@@ -28,10 +25,9 @@ So a typical project might include these files:
- pb.h - pb.h
- pb_decode.h and pb_decode.c (needed for decoding messages) - pb_decode.h and pb_decode.c (needed for decoding messages)
- pb_encode.h and pb_encode.c (needed for encoding messages) - pb_encode.h and pb_encode.c (needed for encoding messages)
- pb_encode_buffer.h and pb_encode_buffer.c (for encoding specifically into in-memory buffers)
2) Protocol description (you can have many): 2) Protocol description (you can have many):
- person.proto (just an example) - person.proto (just an example)
- person.pb.c (autogenerated, contains initializers for message descriptors) - person.pb.c (autogenerated, contains initializers for const arrays)
- person.pb.h (autogenerated, contains type declarations) - person.pb.h (autogenerated, contains type declarations)
Features and limitations Features and limitations
@@ -56,7 +52,7 @@ Features and limitations
#) Unknown fields are not preserved when decoding and re-encoding a message. #) Unknown fields are not preserved when decoding and re-encoding a message.
#) Reflection (runtime introspection) is not supported. E.g. you can't request a field by giving its name in a string. #) Reflection (runtime introspection) is not supported. E.g. you can't request a field by giving its name in a string.
#) Numeric arrays are always encoded as packed, even if not marked as packed in .proto. This causes incompatibility with decoders that do not support packed format. #) Numeric arrays are always encoded as packed, even if not marked as packed in .proto. This causes incompatibility with decoders that do not support packed format.
#) Limited support for cyclic references between messages. (The cycle must be broken by making one of the references a pointer or callback field, and objects that have circular references are not detected when encoding.) #) Cyclic references between messages are not supported. They could be supported in callback-mode if there was an option in the generator to set the mode.
Getting started Getting started
=============== ===============
@@ -78,30 +74,17 @@ You should now have in *message.pb.h*::
int32_t value; int32_t value;
} Example; } Example;
typedef PB_MSG_STRUCT(1) Example_msg_t; extern const pb_field_t Example_fields[2];
extern const Example_msg_t Example_real_msg;
#define Example_msg ((const pb_message_t*)&Example_real_msg)
Now in your main program do this to encode a message:: Now in your main program do this to encode a message::
Example mymessage = {42}; Example mymessage = {42};
uint8_t buffer[10]; uint8_t buffer[10];
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer)); pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
pb_encode(&stream, Example_msg, &mymessage); pb_encode(&stream, Example_fields, &mymessage);
After that, buffer will contain the encoded message. After that, buffer will contain the encoded message.
The number of bytes in the message is stored in *stream.bytes_written*. The number of bytes in the message is stored in *stream.bytes_written*.
Using *pb_encode_buffer.h/c* interface is very similar::
Example mymessage = {42};
uint8_t buffer[10];
pb_strstream_t stream = pb_str_from_buffer(buffer, sizeof(buffer));
pb_encode_buffer(&stream, Example_msg, &mymessage);
The encoded message will start at *stream.last* and continue until the
end of *buffer* (that is, it has length *buffer - stream.last*).
You can feed the message to *protoc --decode=Example message.proto* to verify its validity. You can feed the message to *protoc --decode=Example message.proto* to verify its validity.
For complete examples of the simple cases, see *tests/test_decode1.c* and *tests/test_encode1.c*. For an example with network interface, see the *example* subdirectory. For complete examples of the simple cases, see *tests/test_decode1.c* and *tests/test_encode1.c*. For an example with network interface, see the *example* subdirectory.
@@ -125,5 +108,6 @@ This also generates a file called *breakpoints* which includes all lines returni
Wishlist Wishlist
======== ========
#) A specialized encoder for encoding to a memory buffer. Should serialize in reverse order to avoid having to determine submessage size beforehand.
#) A cleaner rewrite of the Python-based source generator. #) A cleaner rewrite of the Python-based source generator.
#) Better performance for 16- and 8-bit platforms: use smaller datatypes where possible. #) Better performance for 16- and 8-bit platforms: use smaller datatypes where possible.

View File

@@ -3,11 +3,7 @@
1) `Overview`_ 1) `Overview`_
2) `Concepts`_ 2) `Concepts`_
3) `API reference`_ 3) `API reference`_
Note: This is the documentation for the *dynamic_alloc_dev* development branch. See here for the
documentation for the latest stable version:
http://koti.kapsi.fi/~jpa/nanopb/docs/index.html
.. _`Overview`: index.html .. _`Overview`: index.html
.. _`Concepts`: concepts.html .. _`Concepts`: concepts.html
.. _`API reference`: reference.html .. _`API reference`: reference.html

View File

@@ -13,9 +13,9 @@ pb_type_t
--------- ---------
Defines the encoder/decoder behaviour that should be used for a field. :: Defines the encoder/decoder behaviour that should be used for a field. ::
typedef uint8_t pb_type_t; typedef enum { ... } pb_type_t;
The low-order nibble of the enumeration values defines the function that can be used for encoding and decoding the field data: The low-order byte of the enumeration values defines the function that can be used for encoding and decoding the field data:
==================== ===== ================================================ ==================== ===== ================================================
LTYPE identifier Value Storage format LTYPE identifier Value Storage format
@@ -28,23 +28,19 @@ PB_LTYPE_STRING 0x04 Null-terminated string.
PB_LTYPE_SUBMESSAGE 0x05 Submessage structure. PB_LTYPE_SUBMESSAGE 0x05 Submessage structure.
==================== ===== ================================================ ==================== ===== ================================================
The high-order nibble defines whether the field is required, optional, repeated or callback, and whether it is a pointer: The high-order byte defines whether the field is required, optional, repeated or callback:
==================== ===== ================================================ ==================== ===== ================================================
HTYPE identifier Value Field handling HTYPE identifier Value Field handling
==================== ===== ================================================ ==================== ===== ================================================
PB_HTYPE_REQUIRED 0x00 Verify that field exists in decoded message. PB_HTYPE_REQUIRED 0x00 Verify that field exists in decoded message.
PB_HTYPE_OPTIONAL 0x10 Use the structure's *has_fields* bit array to PB_HTYPE_OPTIONAL 0x10 Use separate *has_<field>* boolean to specify
specify whether the field is present. whether the field is present.
PB_HTYPE_ARRAY 0x20 A repeated field with preallocated array. PB_HTYPE_ARRAY 0x20 A repeated field with preallocated array.
Separate *<field>_count* for number of items. Separate *<field>_count* for number of items.
PB_HTYPE_CALLBACK 0x30 A field with dynamic storage size, data is PB_HTYPE_CALLBACK 0x30 A field with dynamic storage size, data is
actually a pointer to a structure containing a actually a pointer to a structure containing a
callback function. callback function.
PB_HTYPE_POINTER 0x80 For required, optional and array non-scalar
fields, uses a pointer type (char* for strings,
pb_bytes_t for bytes, or a pointer for
submessages).
==================== ===== ================================================ ==================== ===== ================================================
pb_field_t pb_field_t
@@ -65,7 +61,7 @@ Describes a single structure field with memory position in relation to others. T
:tag: Tag number of the field or 0 to terminate a list of fields. :tag: Tag number of the field or 0 to terminate a list of fields.
:type: LTYPE and HTYPE of the field. :type: LTYPE and HTYPE of the field.
:data_offset: Offset of field data, relative to the end of the previous field. :data_offset: Offset of field data, relative to the end of the previous field.
:size_offset: Offset of *size_t* count for arrays, relative to field data. :size_offset: Offset of *bool* flag for optional fields or *size_t* count for arrays, relative to field data.
:data_size: Size of a single data entry, in bytes. For PB_LTYPE_BYTES, the size of the byte array inside the containing structure. For PB_HTYPE_CALLBACK, size of the C data type if known. :data_size: Size of a single data entry, in bytes. For PB_LTYPE_BYTES, the size of the byte array inside the containing structure. For PB_HTYPE_CALLBACK, size of the C data type if known.
:array_size: Maximum number of entries in an array, if it is an array type. :array_size: Maximum number of entries in an array, if it is an array type.
:ptr: Pointer to default value for optional fields, or to submessage description for PB_LTYPE_SUBMESSAGE. :ptr: Pointer to default value for optional fields, or to submessage description for PB_LTYPE_SUBMESSAGE.
@@ -83,16 +79,6 @@ An byte array with a field for storing the length::
In an actual array, the length of *bytes* may be different. In an actual array, the length of *bytes* may be different.
pb_bytes_t
----------
A byte array with fields for storing the allocated and current lengths::
typedef struct {
size_t alloced;
size_t size;
uint8_t *bytes;
} pb_bytes_array_t;
pb_callback_t pb_callback_t
------------- -------------
Part of a message structure, for fields with type PB_HTYPE_CALLBACK:: Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
@@ -102,7 +88,6 @@ Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
union { union {
bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg); bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg); bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
bool (*encode_buffer)(pb_strstream_t *stream, const pb_field_t *field, const void *arg);
} funcs; } funcs;
void *arg; void *arg;
@@ -110,11 +95,11 @@ Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
The *arg* is passed to the callback when calling. It can be used to store any information that the callback might need. The *arg* is passed to the callback when calling. It can be used to store any information that the callback might need.
When calling `pb_encode`_, *funcs.encode* is used, and similarly when calling `pb_encode_buffer`_, *funcs.encode_buffer* is used, and when calling `pb_decode`_, *funcs.decode* is used. The function pointers are stored in the same memory location but are of incompatible types. You can set the function pointer to NULL to skip the field. When calling `pb_encode`_, *funcs.encode* is used, and similarly when calling `pb_decode`_, *funcs.decode* is used. The function pointers are stored in the same memory location but are of incompatible types. You can set the function pointer to NULL to skip the field.
pb_wire_type_t pb_wire_type_t
-------------- --------------
Protocol Buffers wire types. These are used with `pb_encode_tag`_ and `pb_encbuf_tag`_. :: Protocol Buffers wire types. These are used with `pb_encode_tag`_. ::
typedef enum { typedef enum {
PB_WT_VARINT = 0, PB_WT_VARINT = 0,
@@ -155,26 +140,22 @@ pb_encode
--------- ---------
Encodes the contents of a structure as a protocol buffers message and writes it to output stream. :: Encodes the contents of a structure as a protocol buffers message and writes it to output stream. ::
bool pb_encode(pb_ostream_t *stream, const pb_message_t *msg, const void *src_struct); bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
:stream: Output stream to write to. :stream: Output stream to write to.
:msg: A message descriptor, usually autogenerated. :fields: A field description array, usually autogenerated.
:src_struct: Pointer to the data that will be serialized. :src_struct: Pointer to the data that will be serialized.
:returns: True on success, false on IO error, on detectable errors in field description, or if a field encoder returns false. :returns: True on success, false on IO error, on detectable errors in field description, or if a field encoder returns false.
Normally pb_encode simply walks through the fields description array inside the message descriptor and serializes each field in turn. However, submessages must be serialized twice: first to calculate their size and then to actually write them to output. This causes some constraints for callback fields, which must return the same data on every call. Normally pb_encode simply walks through the fields description array and serializes each field in turn. However, submessages must be serialized twice: first to calculate their size and then to actually write them to output. This causes some constraints for callback fields, which must return the same data on every call.
pb_encode_varint .. sidebar:: Encoding fields manually
----------------
Encodes an unsigned integer in the varint_ format. ::
bool pb_encode_varint(pb_ostream_t *stream, uint64_t value); The functions with names *pb_encode_\** are used when dealing with callback fields. The typical reason for using callbacks is to have an array of unlimited size. In that case, `pb_encode`_ will call your callback function, which in turn will call *pb_encode_\** functions repeatedly to write out values.
:stream: Output stream to write to. 1-10 bytes will be written. The tag of a field must be encoded separately with `pb_encode_tag_for_field`_. After that, you can call exactly one of the content-writing functions to encode the payload of the field. For repeated fields, you can repeat this process multiple times.
:value: Value to encode.
:returns: True on success, false on IO error.
.. _varint: http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints Writing packed arrays is a little bit more involved: you need to use `pb_encode_tag` and specify `PB_WT_STRING` as the wire type. Then you need to know exactly how much data you are going to write, and use `pb_encode_varint`_ to write out the number of bytes before writing the actual data. Substreams can be used to determine the number of bytes beforehand; see `pb_encode_submessage`_ source code for an example.
pb_encode_tag pb_encode_tag
------------- -------------
@@ -184,7 +165,7 @@ Starts a field in the Protocol Buffers binary format: encodes the field number a
:stream: Output stream to write to. 1-5 bytes will be written. :stream: Output stream to write to. 1-5 bytes will be written.
:wiretype: PB_WT_VARINT, PB_WT_64BIT, PB_WT_STRING or PB_WT_32BIT :wiretype: PB_WT_VARINT, PB_WT_64BIT, PB_WT_STRING or PB_WT_32BIT
:field_number: Identifier for the field, defined in the .proto file. :field_number: Identifier for the field, defined in the .proto file. You can get it from field->tag.
:returns: True on success, false on IO error. :returns: True on success, false on IO error.
pb_encode_tag_for_field pb_encode_tag_for_field
@@ -210,208 +191,71 @@ STRING, BYTES, SUBMESSAGE PB_WT_STRING
FIXED32 PB_WT_32BIT FIXED32 PB_WT_32BIT
========================= ============ ========================= ============
pb_encode_varint
----------------
Encodes a signed or unsigned integer in the varint_ format. Works for fields of type `bool`, `enum`, `int32`, `int64`, `uint32` and `uint64`::
bool pb_encode_varint(pb_ostream_t *stream, uint64_t value);
:stream: Output stream to write to. 1-10 bytes will be written.
:value: Value to encode. Just cast e.g. int32_t directly to uint64_t.
:returns: True on success, false on IO error.
.. _varint: http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints
pb_encode_svarint
-----------------
Encodes a signed integer in the 'zig-zagged' format. Works for fields of type `sint32` and `sint64`::
bool pb_encode_svarint(pb_ostream_t *stream, int64_t value);
(parameters are the same as for `pb_encode_varint`_
pb_encode_string pb_encode_string
---------------- ----------------
Writes the length of a string as varint and then contents of the string. Used for writing fields with wire type PB_WT_STRING. :: Writes the length of a string as varint and then contents of the string. Works for fields of type `bytes` and `string`::
bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size); bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size);
:stream: Output stream to write to. :stream: Output stream to write to.
:buffer: Pointer to string data. :buffer: Pointer to string data.
:size: Number of bytes in the string. :size: Number of bytes in the string. Pass `strlen(s)` for strings.
:returns: True on success, false on IO error. :returns: True on success, false on IO error.
.. sidebar:: Field encoders pb_encode_fixed32
The functions with names beginning with *pb_enc_* are called field encoders. Each PB_LTYPE has an own field encoder, which handles translating from C data into Protocol Buffers data.
By using the *data_size* in the field description and by taking advantage of C casting rules, it has been possible to combine many data types to a single LTYPE. For example, *int32*, *uint32*, *int64*, *uint64*, *bool* and *enum* are all handled by *pb_enc_varint*.
Each field encoder only encodes the contents of the field. The tag must be encoded separately with `pb_encode_tag_for_field`_.
You can use the field encoders from your callbacks. Just be aware that the pb_field_t passed to the callback is not directly compatible with most of the encoders. Instead, you must create a new pb_field_t structure and set the data_size according to the data type you pass to *src*.
pb_enc_varint
-------------
Field encoder for PB_LTYPE_VARINT. Takes the first *field->data_size* bytes from src, casts them as *uint64_t* and calls `pb_encode_varint`_. ::
bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
:stream: Output stream to write to.
:field: Field description structure. Only *data_size* matters.
:src: Pointer to start of the field data.
:returns: True on success, false on IO error.
pb_enc_svarint
--------------
Field encoder for PB_LTYPE_SVARINT. Similar to `pb_enc_varint`_, except first zig-zag encodes the value for more efficient negative number encoding. ::
bool pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
(parameters are the same as for `pb_enc_varint`_)
The number is considered negative if the high-order bit of the value is set. On big endian computers, it is the highest bit of *\*src*. On little endian computers, it is the highest bit of *\*(src + field->data_size - 1)*.
pb_enc_fixed32
--------------
Field encoder for PB_LTYPE_FIXED32. Writes the data in little endian order. On big endian computers, reverses the order of bytes. ::
bool pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src);
:stream: Output stream to write to.
:field: Not used.
:src: Pointer to start of the field data.
:returns: True on success, false on IO error.
pb_enc_fixed64
--------------
Field encoder for PB_LTYPE_FIXED64. Writes the data in little endian order. On big endian computers, reverses the order of bytes. ::
bool pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src);
(parameters are the same as for `pb_enc_fixed32`_)
The same function is used for both integers and doubles. This breaks encoding of double values on architectures where they are mixed endian (primarily some arm processors with hardware FPU).
pb_enc_bytes
------------
Field encoder for PB_LTYPE_BYTES. Just calls `pb_encode_string`_. ::
bool pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src);
:stream: Output stream to write to.
:field: Not used.
:src: Pointer to a structure similar to pb_bytes_array_t.
:returns: True on success, false on IO error.
This function expects a pointer to a structure with a *size_t* field at start, and a variable sized byte array after it. The platform-specific field offset is inferred from *pb_bytes_array_t*, which has a byte array of size 1.
pb_enc_string
-------------
Field encoder for PB_LTYPE_STRING. Determines size of string with strlen() and then calls `pb_encode_string`_. ::
bool pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src);
:stream: Output stream to write to.
:field: Not used.
:src: Pointer to a null-terminated string.
:returns: True on success, false on IO error.
pb_enc_submessage
----------------- -----------------
Field encoder for PB_LTYPE_SUBMESSAGE. Calls `pb_encode`_ to perform the actual encoding. :: Writes 4 bytes to stream and swaps bytes on big-endian architectures. Works for fields of type `fixed32`, `sfixed32` and `float`::
bool pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src); bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
:stream: Output stream to write to.
:value: Pointer to a 4-bytes large C variable, for example `uint32_t foo;`.
:returns: True on success, false on IO error.
pb_encode_fixed64
-----------------
Writes 8 bytes to stream and swaps bytes on big-endian architecture. Works for fields of type `fixed64`, `sfixed64` and `double`::
bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
:stream: Output stream to write to.
:value: Pointer to a 8-bytes large C variable, for example `uint64_t foo;`.
:returns: True on success, false on IO error.
pb_encode_submessage
--------------------
Encodes a submessage field, including the size header for it. Works for fields of any message type::
bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
:stream: Output stream to write to. :stream: Output stream to write to.
:field: Field description structure. The *ptr* field must be a pointer to a valid *pb_message_t* descriptor for the submessage. :fields: Pointer to the autogenerated field description array for the submessage type, e.g. `MyMessage_fields`.
:src: Pointer to the structure where submessage data is. :src: Pointer to the structure where submessage data is.
:returns: True on success, false on IO errors, pb_encode errors or if submessage size changes between calls. :returns: True on success, false on IO errors, pb_encode errors or if submessage size changes between calls.
In Protocol Buffers format, the submessage size must be written before the submessage contents. Therefore, this function has to encode the submessage twice in order to know the size beforehand. In Protocol Buffers format, the submessage size must be written before the submessage contents. Therefore, this function has to encode the submessage twice in order to know the size beforehand.
If the submessage contains callback fields, the callback function might misbehave and write out a different amount of data on the second call. This situation is recognized and *false* is returned, but it is up to the caller to ensure that the receiver of the message does not interpret it as valid data. If the submessage contains callback fields, the callback function might misbehave and write out a different amount of data on the second call. This situation is recognized and *false* is returned, but garbage will be written to the output before the problem is detected.
pb_encode_buffer.h
==================
An important note about this module is that data is written from the
back of the buffer to the front. That is, when you call
*pb_buf_write()*, it will place the bytes (in the order you provide
them) before the data currently in the buffer.
pb_strstream_from_buffer
------------------------
Constructs a buffer descriptor. This is just a helper function, it doesn't do anything you couldn't do yourself in a callback function. ::
pb_strstream_t pb_strstream_from_buffer(uint8_t *buf, size_t bufsize);
:buf: Memory buffer to write into.
:bufsize: Maximum number of bytes to write.
:returns: The buffer descriptor.
The descriptor only tracks the amount of space left; it does not count how many bytes have been written.
pb_buf_write
------------
Prepends data to an in-memory buffer. Always use this function, instead of trying to manage the pointers inside the buffer descriptor. ::
bool pb_buf_write(pb_strstream_t *stream, const uint8_t *buf, size_t count);
:stream: Descriptor for buffer to write to.
:buf: Pointer to buffer with the data to be written.
:count: Number of bytes to write.
:returns: True on success, false if maximum length is exceeded.
If there is not enough space, *stream* is not modified.
pb_encode_buffer
----------------
Encodes the contents of a structure as a protocol buffers message and writes it to a buffer. ::
bool pb_encode_buffer(pb_strstream_t *stream, const pb_message_t *msg, const void *src_struct);
:stream: Descriptor for buffer to write to.
:msg: A message descriptor, usually autogenerated.
:src_struct: Pointer to the data that will be serialized.
:returns: True on success, false if the buffer is too small or if a field encoder returns false.
pb_encbuf_varint
----------------
Encodes an unsigned integer in the varint_ format. ::
bool pb_encbuf_varint(pb_strstream_t *stream, uint64_t value);
:stream: Descriptor for buffer to write to. 1-10 bytes will be written.
:value: Value to encode.
:returns: True on success, false on IO error.
.. _varint: http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints
pb_encbuf_tag
-------------
Finishes a field in the Protocol Buffers binary format: encodes the field number and the wire type of the data. ::
bool pb_encbuf_tag(pb_strstream_t *stream, pb_wire_type_t wiretype, int field_number);
:stream: Descriptor for buffer to write to. 1-5 bytes will be written.
:wiretype: PB_WT_VARINT, PB_WT_64BIT, PB_WT_STRING or PB_WT_32BIT
:field_number: Identifier for the field, defined in the .proto file.
:returns: True on success, false on IO error.
pb_encbuf_tag_for_field
-----------------------
Same as `pb_encbuf_tag`_, except takes the parameters from a *pb_field_t* structure. ::
bool pb_encbuf_tag_for_field(pb_strstream_t *stream, const pb_field_t *field);
:stream: Descriptor for buffer to write to. 1-5 bytes will be written.
:field: Field description structure. Usually autogenerated.
:returns: True on success, false on IO error or unknown field type.
This function only considers the LTYPE of the field. You can use it from your field callbacks, because the source generator writes correct LTYPE also for callback type fields.
Wire type mapping is as follows:
========================= ============
LTYPEs Wire type
========================= ============
VARINT, SVARINT PB_WT_VARINT
FIXED64 PB_WT_64BIT
STRING, BYTES, SUBMESSAGE PB_WT_STRING
FIXED32 PB_WT_32BIT
========================= ============
pb_encbuf_string
----------------
Writes the length of a string as varint and then contents of the string. Used for writing fields with wire type PB_WT_STRING. ::
bool pb_encbuf_string(pb_strstream_t *stream, const uint8_t *buffer, size_t size);
:stream: Descriptor for buffer to write to.
:buffer: Pointer to string data.
:size: Number of bytes in the string.
:returns: True on success, false on IO error.
pb_decode.h pb_decode.h
=========== ===========
@@ -471,10 +315,10 @@ pb_decode
--------- ---------
Read and decode all fields of a structure. Reads until EOF on input stream. :: Read and decode all fields of a structure. Reads until EOF on input stream. ::
bool pb_decode(pb_istream_t *stream, const pb_message_t *msg, void *dest_struct); bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
:stream: Input stream to read from. :stream: Input stream to read from.
:msg: A message descriptor. Usually autogenerated. :fields: A field description array. Usually autogenerated.
:dest_struct: Pointer to structure where data will be stored. :dest_struct: Pointer to structure where data will be stored.
:returns: True on success, false on IO error, on detectable errors in field description, if a field encoder returns false or if a required field is missing. :returns: True on success, false on IO error, on detectable errors in field description, if a field encoder returns false or if a required field is missing.
@@ -482,23 +326,9 @@ In Protocol Buffers binary format, EOF is only allowed between fields. If it hap
In addition to EOF, the pb_decode implementation supports terminating a message with a 0 byte. This is compatible with the official Protocol Buffers because 0 is never a valid field tag. In addition to EOF, the pb_decode implementation supports terminating a message with a 0 byte. This is compatible with the official Protocol Buffers because 0 is never a valid field tag.
For optional fields, this function applies the default value and clears the corresponding bit in *has_fields* if the field is not present. For optional fields, this function applies the default value and sets *has_<field>* to false if the field is not present.
pb_clean Because of memory concerns, the detection of missing required fields is not perfect if the structure contains more than 32 fields.
--------
Release and clear all the unused pointers of a structure. ::
bool pb_clean(const pb_message_t *msg, void *dest_struct);
:msg: A message descriptor. Usually autogenerated.
:dest_struct: Pointer to structure to be cleaned.
:returns: True on success, false if one of the unused message fields has a pointer type that this function cannot handle.
For each string or submessage with pointer type, this function calls *free()* on the pointer and sets the pointer to NULL.
For bytes fields with pointer type, this function calls *free()* on the allocated data, nulls that pointer and zeros the size fields in the generated pb_bytes_t structure.
For repeated fields, it applies the corresponding operation above to each unused element of the generated array.
.. sidebar:: Field decoders .. sidebar:: Field decoders
@@ -506,7 +336,12 @@ For repeated fields, it applies the corresponding operation above to each unused
Each field decoder reads and decodes a single value. For arrays, the decoder is called repeatedly. Each field decoder reads and decodes a single value. For arrays, the decoder is called repeatedly.
You can use the decoders from your callbacks. Just be aware that the pb_field_t passed to the callback is not directly compatible with most of the field decoders. Instead, you must create a new pb_field_t structure and set the data_size according to the data type you pass to *dest*. You can use the decoders from your callbacks. Just be aware that the pb_field_t passed to the callback is not directly compatible
with the *varint* field decoders. Instead, you must create a new pb_field_t structure and set the data_size according to the data type
you pass to *dest*, e.g. *field.data_size = sizeof(int);*. Other fields in the *pb_field_t* don't matter.
The field decoder interface is a bit messy as a result of the interface required inside the nanopb library.
Eventually they may be replaced by separate wrapper functions with a more friendly interface.
pb_dec_varint pb_dec_varint
------------- -------------
@@ -533,12 +368,12 @@ pb_dec_fixed32
-------------- --------------
Field decoder for PB_LTYPE_FIXED32. :: Field decoder for PB_LTYPE_FIXED32. ::
bool pb_dec_fixed(pb_istream_t *stream, const pb_field_t *field, void *dest); bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest);
:stream: Input stream to read from. 1-10 bytes will be read. :stream: Input stream to read from. 4 bytes will be read.
:field: Not used. :field: Not used.
:dest: Pointer to destination integer. Must have size of *field->data_size* bytes. :dest: Pointer to destination *int32_t*, *uint32_t* or *float*.
:returns: True on success, false on IO errors or if `pb_decode_varint`_ fails. :returns: True on success, false on IO errors.
This function reads 4 bytes from the input stream. This function reads 4 bytes from the input stream.
On big endian architectures, it then reverses the order of the bytes. On big endian architectures, it then reverses the order of the bytes.
@@ -550,6 +385,11 @@ Field decoder for PB_LTYPE_FIXED64. ::
bool pb_dec_fixed(pb_istream_t *stream, const pb_field_t *field, void *dest); bool pb_dec_fixed(pb_istream_t *stream, const pb_field_t *field, void *dest);
:stream: Input stream to read from. 8 bytes will be read.
:field: Not used.
:dest: Pointer to destination *int64_t*, *uint64_t* or *double*.
:returns: True on success, false on IO errors.
Same as `pb_dec_fixed32`_, except this reads 8 bytes. Same as `pb_dec_fixed32`_, except this reads 8 bytes.
pb_dec_bytes pb_dec_bytes
@@ -558,6 +398,9 @@ Field decoder for PB_LTYPE_BYTES. Reads a length-prefixed block of bytes. ::
bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest); bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest);
**Note:** This is an internal function that is not useful in decoder callbacks. To read bytes fields in callbacks, use
*stream->bytes_left* and `pb_read`_.
:stream: Input stream to read from. :stream: Input stream to read from.
:field: Field description structure. Only *field->data_size* matters. :field: Field description structure. Only *field->data_size* matters.
:dest: Pointer to a structure similar to pb_bytes_array_t. :dest: Pointer to a structure similar to pb_bytes_array_t.
@@ -571,6 +414,9 @@ Field decoder for PB_LTYPE_STRING. Reads a length-prefixed string. ::
bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest); bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest);
**Note:** This is an internal function that is not useful in decoder callbacks. To read string fields in callbacks, use
*stream->bytes_left* and `pb_read`_.
:stream: Input stream to read from. :stream: Input stream to read from.
:field: Field description structure. Only *field->data_size* matters. :field: Field description structure. Only *field->data_size* matters.
:dest: Pointer to a character array of size *field->data_size*. :dest: Pointer to a character array of size *field->data_size*.
@@ -584,10 +430,13 @@ Field decoder for PB_LTYPE_SUBMESSAGE. Calls `pb_decode`_ to perform the actual
bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest) bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest)
**Note:** This is an internal function that is not useful in decoder callbacks. To read submessage fields in callbacks, use
`pb_decode`_ directly.
:stream: Input stream to read from. :stream: Input stream to read from.
:field: Field description structure. Only *field->ptr* matters. :field: Field description structure. Only *field->ptr* matters.
:dest: Pointer to the destination structure. :dest: Pointer to the destination structure.
:returns: True on success, false on IO error or if `pb_decode`_ fails. :returns: True on success, false on IO error or if `pb_decode`_ fails.
The *field->ptr* should be a pointer to *pb_message_t* describing the submessage. The *field->ptr* should be a pointer to *pb_field_t* array describing the submessage.

View File

@@ -27,10 +27,10 @@ bool printfile_callback(pb_istream_t *stream, const pb_field_t *field, void *arg
{ {
FileInfo fileinfo; FileInfo fileinfo;
if (!pb_decode(stream, FileInfo_msg, &fileinfo)) if (!pb_decode(stream, FileInfo_fields, &fileinfo))
return false; return false;
printf("%-10lld %s\n", fileinfo.inode, fileinfo.name); printf("%-10lld %s\n", (long long)fileinfo.inode, fileinfo.name);
return true; return true;
} }
@@ -45,11 +45,11 @@ bool listdir(int fd, char *path)
if (path == NULL) if (path == NULL)
{ {
ListFilesRequest_clear(request, path); request.has_path = false;
} }
else else
{ {
ListFilesRequest_set(request, path); request.has_path = true;
if (strlen(path) + 1 > sizeof(request.path)) if (strlen(path) + 1 > sizeof(request.path))
{ {
fprintf(stderr, "Too long path.\n"); fprintf(stderr, "Too long path.\n");
@@ -59,7 +59,7 @@ bool listdir(int fd, char *path)
strcpy(request.path, path); strcpy(request.path, path);
} }
if (!pb_encode(&output, ListFilesRequest_msg, &request)) if (!pb_encode(&output, ListFilesRequest_fields, &request))
{ {
fprintf(stderr, "Encoding failed.\n"); fprintf(stderr, "Encoding failed.\n");
return false; return false;
@@ -70,7 +70,7 @@ bool listdir(int fd, char *path)
response.file.funcs.decode = &printfile_callback; response.file.funcs.decode = &printfile_callback;
if (!pb_decode(&input, ListFilesResponse_msg, &response)) if (!pb_decode(&input, ListFilesResponse_fields, &response))
{ {
fprintf(stderr, "Decoding failed.\n"); fprintf(stderr, "Decoding failed.\n");
return false; return false;

View File

@@ -10,13 +10,13 @@
static bool write_callback(pb_ostream_t *stream, const uint8_t *buf, size_t count) static bool write_callback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
{ {
int fd = (int)stream->state; int fd = (intptr_t)stream->state;
return send(fd, buf, count, 0) == count; return send(fd, buf, count, 0) == count;
} }
static bool read_callback(pb_istream_t *stream, uint8_t *buf, size_t count) static bool read_callback(pb_istream_t *stream, uint8_t *buf, size_t count)
{ {
int fd = (int)stream->state; int fd = (intptr_t)stream->state;
int result; int result;
if (buf == NULL) if (buf == NULL)
@@ -38,12 +38,12 @@ static bool read_callback(pb_istream_t *stream, uint8_t *buf, size_t count)
pb_ostream_t pb_ostream_from_socket(int fd) pb_ostream_t pb_ostream_from_socket(int fd)
{ {
pb_ostream_t stream = {&write_callback, (void*)fd, SIZE_MAX, 0}; pb_ostream_t stream = {&write_callback, (void*)(intptr_t)fd, SIZE_MAX, 0};
return stream; return stream;
} }
pb_istream_t pb_istream_from_socket(int fd) pb_istream_t pb_istream_from_socket(int fd)
{ {
pb_istream_t stream = {&read_callback, (void*)fd, SIZE_MAX}; pb_istream_t stream = {&read_callback, (void*)(intptr_t)fd, SIZE_MAX};
return stream; return stream;
} }

View File

@@ -38,7 +38,7 @@ bool listdir_callback(pb_ostream_t *stream, const pb_field_t *field, const void
if (!pb_encode_tag_for_field(stream, field)) if (!pb_encode_tag_for_field(stream, field))
return false; return false;
if (!pb_enc_submessage(stream, field, &fileinfo)) if (!pb_encode_submessage(stream, FileInfo_fields, &fileinfo))
return false; return false;
} }
@@ -53,7 +53,7 @@ void handle_connection(int connfd)
pb_ostream_t output = pb_ostream_from_socket(connfd); pb_ostream_t output = pb_ostream_from_socket(connfd);
DIR *directory; DIR *directory;
if (!pb_decode(&input, ListFilesRequest_msg, &request)) if (!pb_decode(&input, ListFilesRequest_fields, &request))
{ {
printf("Decoding failed.\n"); printf("Decoding failed.\n");
return; return;
@@ -67,18 +67,18 @@ void handle_connection(int connfd)
{ {
perror("opendir"); perror("opendir");
ListFilesResponse_set(response, path_error); response.has_path_error = true;
response.path_error = true; response.path_error = true;
response.file.funcs.encode = NULL; response.file.funcs.encode = NULL;
} }
else else
{ {
ListFilesResponse_clear(response, path_error); response.has_path_error = false;
response.file.funcs.encode = &listdir_callback; response.file.funcs.encode = &listdir_callback;
response.file.arg = directory; response.file.arg = directory;
} }
if (!pb_encode(&output, ListFilesResponse_msg, &response)) if (!pb_encode(&output, ListFilesResponse_fields, &response))
{ {
printf("Encoding failed.\n"); printf("Encoding failed.\n");
} }

View File

@@ -1,7 +1,6 @@
// Custom options for defining: // Custom options for defining:
// - Maximum size of string/bytes // - Maximum size of string/bytes
// - Maximum number of elements in array // - Maximum number of elements in array
// - Pointer or in-line representation of non-scalar fields
// //
// These are used by nanopb to generate statically allocable structures // These are used by nanopb to generate statically allocable structures
// for memory-limited environments. // for memory-limited environments.
@@ -11,7 +10,6 @@ import "google/protobuf/descriptor.proto";
message NanoPBOptions { message NanoPBOptions {
optional int32 max_size = 1; optional int32 max_size = 1;
optional int32 max_count = 2; optional int32 max_count = 2;
optional bool pointer = 3;
} }
// Protocol Buffers extension number registry // Protocol Buffers extension number registry

View File

@@ -1,9 +1,28 @@
'''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.''' '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
import google.protobuf.descriptor_pb2 as descriptor try:
import nanopb_pb2 import google.protobuf.descriptor_pb2 as descriptor
except:
print
print "*************************************************************"
print "*** Could not import the Google protobuf Python libraries ***"
print "*** Try installing package 'python-protobuf' or similar. ***"
print "*************************************************************"
print
raise
try:
import nanopb_pb2
except:
print
print "***************************************************************"
print "*** Could not import the precompiled nanopb_pb2.py. ***"
print "*** Run 'make' in the 'generator' folder to update the file.***"
print "***************************************************************"
print
raise
import os.path import os.path
from optparse import OptionParser
# Values are tuple (c type, pb ltype) # Values are tuple (c type, pb ltype)
FieldD = descriptor.FieldDescriptorProto FieldD = descriptor.FieldDescriptorProto
@@ -15,19 +34,13 @@ datatypes = {
FieldD.TYPE_FLOAT: ('float', 'PB_LTYPE_FIXED32'), FieldD.TYPE_FLOAT: ('float', 'PB_LTYPE_FIXED32'),
FieldD.TYPE_INT32: ('int32_t', 'PB_LTYPE_VARINT'), FieldD.TYPE_INT32: ('int32_t', 'PB_LTYPE_VARINT'),
FieldD.TYPE_INT64: ('int64_t', 'PB_LTYPE_VARINT'), FieldD.TYPE_INT64: ('int64_t', 'PB_LTYPE_VARINT'),
FieldD.TYPE_SFIXED32: ('int32_t', 'PB_LTYPE_FIXED'), FieldD.TYPE_SFIXED32: ('int32_t', 'PB_LTYPE_FIXED32'),
FieldD.TYPE_SFIXED64: ('int64_t', 'PB_LTYPE_FIXED'), FieldD.TYPE_SFIXED64: ('int64_t', 'PB_LTYPE_FIXED64'),
FieldD.TYPE_SINT32: ('int32_t', 'PB_LTYPE_SVARINT'), FieldD.TYPE_SINT32: ('int32_t', 'PB_LTYPE_SVARINT'),
FieldD.TYPE_SINT64: ('int64_t', 'PB_LTYPE_SVARINT'), FieldD.TYPE_SINT64: ('int64_t', 'PB_LTYPE_SVARINT'),
FieldD.TYPE_UINT32: ('uint32_t', 'PB_LTYPE_VARINT'), FieldD.TYPE_UINT32: ('uint32_t', 'PB_LTYPE_VARINT'),
FieldD.TYPE_UINT64: ('uint64_t', 'PB_LTYPE_VARINT') FieldD.TYPE_UINT64: ('uint64_t', 'PB_LTYPE_VARINT')
} }
pointable_types = frozenset([
FieldD.TYPE_STRING,
FieldD.TYPE_BYTES,
FieldD.TYPE_MESSAGE
])
options = None
class Names: class Names:
'''Keeps a set of nested names and formats them to C identifier. '''Keeps a set of nested names and formats them to C identifier.
@@ -77,8 +90,6 @@ class Field:
self.max_size = None self.max_size = None
self.max_count = None self.max_count = None
self.array_decl = "" self.array_decl = ""
self.is_pointer = options.pointer
self.is_array = False
# Parse nanopb-specific field options # Parse nanopb-specific field options
if desc.options.HasExtension(nanopb_pb2.nanopb): if desc.options.HasExtension(nanopb_pb2.nanopb):
@@ -87,11 +98,6 @@ class Field:
self.max_size = ext.max_size self.max_size = ext.max_size
if ext.HasField("max_count"): if ext.HasField("max_count"):
self.max_count = ext.max_count self.max_count = ext.max_count
if ext.HasField("pointer"):
self.is_pointer = ext.pointer
if desc.type not in pointable_types:
raise NotImplementedError('Cannot make %s.%s a pointer'
% (struct_name, desc.name))
if desc.HasField('default_value'): if desc.HasField('default_value'):
self.default = desc.default_value self.default = desc.default_value
@@ -110,11 +116,8 @@ class Field:
else: else:
self.htype = 'PB_HTYPE_ARRAY' self.htype = 'PB_HTYPE_ARRAY'
self.array_decl = '[%d]' % self.max_count self.array_decl = '[%d]' % self.max_count
self.is_array = True
else: else:
raise NotImplementedError(desc.label) raise NotImplementedError(desc.label)
if self.is_pointer:
self.htype += ' | PB_HTYPE_POINTER'
# Decide LTYPE and CTYPE # Decide LTYPE and CTYPE
# LTYPE is the low-order nibble of nanopb field description, # LTYPE is the low-order nibble of nanopb field description,
@@ -129,18 +132,14 @@ class Field:
self.default = self.ctype + self.default self.default = self.ctype + self.default
elif desc.type == FieldD.TYPE_STRING: elif desc.type == FieldD.TYPE_STRING:
self.ltype = 'PB_LTYPE_STRING' self.ltype = 'PB_LTYPE_STRING'
if self.is_pointer: if self.max_size is None:
self.ctype = 'char'
elif self.max_size is None:
is_callback = True is_callback = True
else: else:
self.ctype = 'char' self.ctype = 'char'
self.array_decl += '[%d]' % self.max_size self.array_decl += '[%d]' % self.max_size
elif desc.type == FieldD.TYPE_BYTES: elif desc.type == FieldD.TYPE_BYTES:
self.ltype = 'PB_LTYPE_BYTES' self.ltype = 'PB_LTYPE_BYTES'
if self.is_pointer: if self.max_size is None:
self.ctype = 'pb_bytes_t'
elif self.max_size is None:
is_callback = True is_callback = True
else: else:
self.ctype = self.struct_name + self.name + 't' self.ctype = self.struct_name + self.name + 't'
@@ -159,14 +158,13 @@ class Field:
return cmp(self.tag, other.tag) return cmp(self.tag, other.tag)
def __str__(self): def __str__(self):
if self.is_array: if self.htype == 'PB_HTYPE_OPTIONAL':
result = ' bool has_' + self.name + ';\n'
elif self.htype == 'PB_HTYPE_ARRAY':
result = ' size_t ' + self.name + '_count;\n' result = ' size_t ' + self.name + '_count;\n'
else: else:
result = '' result = ''
if self.is_pointer and self.ctype != 'pb_bytes_t': result += ' %s %s%s;' % (self.ctype, self.name, self.array_decl)
result += ' %s *%s%s;' % (self.ctype, self.name, self.array_decl)
else:
result += ' %s %s%s;' % (self.ctype, self.name, self.array_decl)
return result return result
def types(self): def types(self):
@@ -229,24 +227,24 @@ class Field:
else: else:
result += ' pb_delta_end(%s, %s, %s),' % (self.struct_name, self.name, prev_field_name) result += ' pb_delta_end(%s, %s, %s),' % (self.struct_name, self.name, prev_field_name)
if self.is_array: if self.htype == 'PB_HTYPE_OPTIONAL':
result += '\n pb_delta(%s, has_%s, %s),' % (self.struct_name, self.name, self.name)
elif self.htype == 'PB_HTYPE_ARRAY':
result += '\n pb_delta(%s, %s_count, %s),' % (self.struct_name, self.name, self.name) result += '\n pb_delta(%s, %s_count, %s),' % (self.struct_name, self.name, self.name)
else: else:
result += ' 0,' result += ' 0,'
if self.is_array:
if self.htype == 'PB_HTYPE_ARRAY':
result += '\n pb_membersize(%s, %s[0]),' % (self.struct_name, self.name) result += '\n pb_membersize(%s, %s[0]),' % (self.struct_name, self.name)
result += ('\n pb_membersize(%s, %s) / pb_membersize(%s, %s[0]),' result += ('\n pb_membersize(%s, %s) / pb_membersize(%s, %s[0]),'
% (self.struct_name, self.name, self.struct_name, self.name)) % (self.struct_name, self.name, self.struct_name, self.name))
elif self.htype != 'PB_HTYPE_CALLBACK' and not self.is_pointer and self.ltype == 'PB_LTYPE_BYTES':
result += '\n pb_membersize(%s, bytes),' % self.ctype
result += ' 0,'
else: else:
result += '\n pb_membersize(%s, %s),' % (self.struct_name, self.name) result += '\n pb_membersize(%s, %s),' % (self.struct_name, self.name)
result += ' 0,' result += ' 0,'
if self.ltype == 'PB_LTYPE_SUBMESSAGE': if self.ltype == 'PB_LTYPE_SUBMESSAGE':
result += '\n %s_msg}' % self.submsgname result += '\n &%s_fields}' % self.submsgname
elif self.default is None or self.htype == 'PB_HTYPE_CALLBACK': elif self.default is None or self.htype == 'PB_HTYPE_CALLBACK':
result += ' 0}' result += ' 0}'
else: else:
@@ -263,14 +261,12 @@ class Message:
def get_dependencies(self): def get_dependencies(self):
'''Get list of type names that this structure refers to.''' '''Get list of type names that this structure refers to.'''
return [str(field.ctype) for field in self.fields if not return [str(field.ctype) for field in self.fields]
(field.is_pointer or field.htype == 'PB_HTYPE_CALLBACK')]
def __str__(self): def __str__(self):
result = 'struct %s {\n' % self.name result = 'typedef struct {\n'
result += ' uint8_t has_fields[%d];\n' % ((len(self.fields) + 7) / 8)
result += '\n'.join([str(f) for f in self.ordered_fields]) result += '\n'.join([str(f) for f in self.ordered_fields])
result += '\n};' result += '\n} %s;' % self.name
return result return result
def types(self): def types(self):
@@ -281,9 +277,6 @@ class Message:
result += types + '\n' result += types + '\n'
return result return result
def typedef(self):
return 'typedef struct %s %s;' % (self.name, self.name)
def default_decl(self, declaration_only = False): def default_decl(self, declaration_only = False):
result = "" result = ""
for field in self.fields: for field in self.fields:
@@ -292,36 +285,20 @@ class Message:
result += default + '\n' result += default + '\n'
return result return result
def message_declaration(self): def fields_declaration(self):
result = 'typedef PB_MSG_STRUCT(%d) %s_msg_t;\n' % (len(self.fields), self.name) result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields) + 1)
result += 'extern const %s_msg_t %s_real_msg;\n' % (self.name, self.name)
result += '#define %s_msg ((const pb_message_t*)&%s_real_msg)\n' % (self.name, self.name)
return result return result
def message_definition(self): def fields_definition(self):
result = 'const %s_msg_t %s_real_msg = {\n' % (self.name, self.name) result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields) + 1)
result += ' %d, sizeof(%s),\n' % (len(self.fields), self.name)
result += ' {\n\n'
prev = None prev = None
for field in self.ordered_fields: for field in self.ordered_fields:
result += field.pb_field_t(prev) result += field.pb_field_t(prev)
result += ',\n\n' result += ',\n\n'
prev = field.name prev = field.name
result += ' }\n};' result += ' PB_LAST_FIELD\n};'
return result
def field_numbers(self):
result = '#define %s_has(STRUCT, FIELD) PB_HAS_FIELD(STRUCT, %s, FIELD)\n' % (self.name, self.name)
result += '#define %s_set(STRUCT, FIELD) PB_SET_FIELD(STRUCT, %s, FIELD)\n' % (self.name, self.name)
result += '#define %s_clear(STRUCT, FIELD) PB_CLEAR_FIELD(STRUCT, %s, FIELD)\n' % (self.name, self.name)
i = 0
for field in self.ordered_fields:
result += '#define %s_%s_index %d\n' % (self.name, field.name, i)
result += '#define %s_%s_tag %d\n' % (self.name, field.name, field.tag)
i += 1
return result return result
def iterate_messages(desc, names = Names()): def iterate_messages(desc, names = Names()):
@@ -390,7 +367,7 @@ def sort_dependencies(messages):
if msgname in message_by_name: if msgname in message_by_name:
yield message_by_name[msgname] yield message_by_name[msgname]
def generate_header(headername, enums, messages): def generate_header(dependencies, headername, enums, messages):
'''Generate content for a header file. '''Generate content for a header file.
Generates strings, which should be concatenated and stored to file. Generates strings, which should be concatenated and stored to file.
''' '''
@@ -402,15 +379,15 @@ def generate_header(headername, enums, messages):
yield '#define _PB_%s_\n' % symbol yield '#define _PB_%s_\n' % symbol
yield '#include <pb.h>\n\n' yield '#include <pb.h>\n\n'
for dependency in dependencies:
noext = os.path.splitext(dependency)[0]
yield '#include "%s.pb.h"\n' % noext
yield '\n'
yield '/* Enum definitions */\n' yield '/* Enum definitions */\n'
for enum in enums: for enum in enums:
yield str(enum) + '\n\n' yield str(enum) + '\n\n'
yield '/* Struct typedefs */\n'
for msg in messages:
yield msg.typedef() + '\n'
yield '\n'
yield '/* Struct definitions */\n' yield '/* Struct definitions */\n'
for msg in sort_dependencies(messages): for msg in sort_dependencies(messages):
yield msg.types() yield msg.types()
@@ -423,13 +400,8 @@ def generate_header(headername, enums, messages):
yield '/* Struct field encoding specification for nanopb */\n' yield '/* Struct field encoding specification for nanopb */\n'
for msg in messages: for msg in messages:
yield msg.message_declaration() + '\n' yield msg.fields_declaration() + '\n'
yield '\n'
yield '/* Field indexes and tags */\n'
for msg in messages:
yield msg.field_numbers()
yield '\n#endif\n' yield '\n#endif\n'
def generate_source(headername, enums, messages): def generate_source(headername, enums, messages):
@@ -444,39 +416,37 @@ def generate_source(headername, enums, messages):
yield '\n\n' yield '\n\n'
for msg in messages: for msg in messages:
yield msg.message_definition() + '\n\n' yield msg.fields_definition() + '\n\n'
if __name__ == '__main__': if __name__ == '__main__':
import sys import sys
import os.path import os.path
parser = OptionParser(usage="Usage: %prog [options] file.pb", if len(sys.argv) != 2:
epilog= print "Usage: " + sys.argv[0] + " file.pb"
"""file.pb should be compiled from file.proto by: print "where file.pb has been compiled from .proto by:"
protoc -ofile.pb file.proto print "protoc -ofile.pb file.proto"
""") print "Output fill be written to file.pb.h and file.pb.c"
parser.add_option("-p", "--pointer", dest="pointer", sys.exit(1)
action="store_true", default=False,
help="generate pointers for non-scalar fields") data = open(sys.argv[1], 'rb').read()
(options, args) = parser.parse_args()
if len(args) != 1:
parser.error("Please provide exactly one file.pb argument")
data = open(args[0]).read()
fdesc = descriptor.FileDescriptorSet.FromString(data) fdesc = descriptor.FileDescriptorSet.FromString(data)
enums, messages = parse_file(fdesc.file[0]) enums, messages = parse_file(fdesc.file[0])
noext = os.path.splitext(args[0])[0] noext = os.path.splitext(sys.argv[1])[0]
headername = noext + '.pb.h' headername = noext + '.pb.h'
sourcename = noext + '.pb.c' sourcename = noext + '.pb.c'
headerbasename = os.path.basename(headername) headerbasename = os.path.basename(headername)
print "Writing to " + headername + " and " + sourcename print "Writing to " + headername + " and " + sourcename
# List of .proto files that should not be included in the C header file
# even if they are mentioned in the source .proto.
excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto']
dependencies = [d for d in fdesc.file[0].dependency if d not in excludes]
header = open(headername, 'w') header = open(headername, 'w')
for part in generate_header(headerbasename, enums, messages): for part in generate_header(dependencies, headerbasename, enums, messages):
header.write(part) header.write(part)
source = open(sourcename, 'w') source = open(sourcename, 'w')

View File

@@ -7,12 +7,10 @@ from google.protobuf import descriptor_pb2
# @@protoc_insertion_point(imports) # @@protoc_insertion_point(imports)
import google.protobuf.descriptor_pb2
DESCRIPTOR = descriptor.FileDescriptor( DESCRIPTOR = descriptor.FileDescriptor(
name='nanopb.proto', name='nanopb.proto',
package='', package='',
serialized_pb='\n\x0cnanopb.proto\x1a google/protobuf/descriptor.proto\"E\n\rNanoPBOptions\x12\x10\n\x08max_size\x18\x01 \x01(\x05\x12\x11\n\tmax_count\x18\x02 \x01(\x05\x12\x0f\n\x07pointer\x18\x03 \x01(\x08:>\n\x06nanopb\x12\x1d.google.protobuf.FieldOptions\x18\xf2\x07 \x01(\x0b\x32\x0e.NanoPBOptions') serialized_pb='\n\x0cnanopb.proto\x1a google/protobuf/descriptor.proto\"4\n\rNanoPBOptions\x12\x10\n\x08max_size\x18\x01 \x01(\x05\x12\x11\n\tmax_count\x18\x02 \x01(\x05:>\n\x06nanopb\x12\x1d.google.protobuf.FieldOptions\x18\xf2\x07 \x01(\x0b\x32\x0e.NanoPBOptions')
NANOPB_FIELD_NUMBER = 1010 NANOPB_FIELD_NUMBER = 1010
@@ -46,13 +44,6 @@ _NANOPBOPTIONS = descriptor.Descriptor(
message_type=None, enum_type=None, containing_type=None, message_type=None, enum_type=None, containing_type=None,
is_extension=False, extension_scope=None, is_extension=False, extension_scope=None,
options=None), options=None),
descriptor.FieldDescriptor(
name='pointer', full_name='NanoPBOptions.pointer', index=2,
number=3, type=8, cpp_type=7, label=1,
has_default_value=False, default_value=False,
message_type=None, enum_type=None, containing_type=None,
is_extension=False, extension_scope=None,
options=None),
], ],
extensions=[ extensions=[
], ],
@@ -63,10 +54,11 @@ _NANOPBOPTIONS = descriptor.Descriptor(
is_extendable=False, is_extendable=False,
extension_ranges=[], extension_ranges=[],
serialized_start=50, serialized_start=50,
serialized_end=119, serialized_end=102,
) )
DESCRIPTOR.message_types_by_name['NanoPBOptions'] = _NANOPBOPTIONS import google.protobuf.descriptor_pb2
class NanoPBOptions(message.Message): class NanoPBOptions(message.Message):
__metaclass__ = reflection.GeneratedProtocolMessageType __metaclass__ = reflection.GeneratedProtocolMessageType

156
pb.h
View File

@@ -17,6 +17,11 @@
#define pb_packed #define pb_packed
#endif #endif
/* Handly macro for suppressing unreferenced-parameter compiler warnings. */
#ifndef UNUSED
#define UNUSED(x) (void)(x)
#endif
/* List of possible field types. These are used in the autogenerated code. /* List of possible field types. These are used in the autogenerated code.
* Least-significant 4 bits tell the scalar type * Least-significant 4 bits tell the scalar type
* Most-significant 4 bits specify repeated/required/packed etc. * Most-significant 4 bits specify repeated/required/packed etc.
@@ -27,65 +32,58 @@
* SINT* is different, though, because it is zig-zag coded. * SINT* is different, though, because it is zig-zag coded.
*/ */
/************************ typedef enum {
* Field contents types * /************************
************************/ * Field contents types *
************************/
/* Numeric types */
PB_LTYPE_VARINT = 0x00, /* int32, uint32, int64, uint64, bool, enum */
PB_LTYPE_SVARINT = 0x01, /* sint32, sint64 */
PB_LTYPE_FIXED32 = 0x02, /* fixed32, sfixed32, float */
PB_LTYPE_FIXED64 = 0x03, /* fixed64, sfixed64, double */
/* Marker for last packable field type. */
PB_LTYPE_LAST_PACKABLE = 0x03,
/* Byte array with pre-allocated buffer.
* data_size is the length of the allocated PB_BYTES_ARRAY structure. */
PB_LTYPE_BYTES = 0x04,
/* String with pre-allocated buffer.
* data_size is the maximum length. */
PB_LTYPE_STRING = 0x05,
/* Submessage
* submsg_fields is pointer to field descriptions */
PB_LTYPE_SUBMESSAGE = 0x06,
/* Number of declared LTYPES */
PB_LTYPES_COUNT = 7,
/******************
* Modifier flags *
******************/
/* Just the basic, write data at data_offset */
PB_HTYPE_REQUIRED = 0x00,
/* Write true at size_offset */
PB_HTYPE_OPTIONAL = 0x10,
/* Read to pre-allocated array
* Maximum number of entries is array_size,
* actual number is stored at size_offset */
PB_HTYPE_ARRAY = 0x20,
/* Works for all required/optional/repeated fields.
* data_offset points to pb_callback_t structure.
* LTYPE should be 0 (it is ignored, but sometimes
* used to speculatively index an array). */
PB_HTYPE_CALLBACK = 0x30
} pb_packed pb_type_t;
typedef uint8_t pb_type_t; #define PB_HTYPE(x) ((x) & 0xF0)
/* Numeric types */
#define PB_LTYPE_VARINT 0x00 /* int32, uint32, int64, uint64, bool, enum */
#define PB_LTYPE_SVARINT 0x01 /* sint32, sint64 */
#define PB_LTYPE_FIXED32 0x02 /* fixed32, sfixed32, float */
#define PB_LTYPE_FIXED64 0x03 /* fixed64, sfixed64, double */
/* Marker for last packable field type. */
#define PB_LTYPE_LAST_PACKABLE 0x03
/* Byte array with pre-allocated buffer.
* data_size is the length of the allocated PB_BYTES_ARRAY structure. */
#define PB_LTYPE_BYTES 0x04
/* String with pre-allocated buffer.
* data_size is the maximum length. */
#define PB_LTYPE_STRING 0x05
/* Submessage
* submsg_fields is pointer to field descriptions */
#define PB_LTYPE_SUBMESSAGE 0x06
/* Number of declared LTYPES */
#define PB_LTYPES_COUNT 7
/******************
* Modifier flags *
******************/
/* Just the basic, write data at data_offset */
#define PB_HTYPE_REQUIRED 0x00
/* Write true at size_offset */
#define PB_HTYPE_OPTIONAL 0x10
/* Read to pre-allocated array
* Maximum number of entries is array_size,
* actual number is stored at size_offset */
#define PB_HTYPE_ARRAY 0x20
/* Works for all required/optional/repeated fields.
* data_offset points to pb_callback_t structure.
* LTYPE should be 0 (it is ignored, but sometimes
* used to speculatively index an array). */
#define PB_HTYPE_CALLBACK 0x30
/* Indicates that a string, bytes or non-repeated submessage is
* represented using a pointer (char* for string, pb_byptes_array_t
* for bytes).
*/
#define PB_HTYPE_POINTER 0x80
#define PB_POINTER(x) ((x) & PB_HTYPE_POINTER)
#define PB_HTYPE(x) ((x) & 0x70)
#define PB_LTYPE(x) ((x) & 0x0F) #define PB_LTYPE(x) ((x) & 0x0F)
/* This structure is used in auto-generated constants /* This structure is used in auto-generated constants
@@ -104,7 +102,7 @@ struct _pb_field_t {
uint8_t data_size; /* Data size in bytes for a single item */ uint8_t data_size; /* Data size in bytes for a single item */
uint8_t array_size; /* Maximum number of entries in array */ uint8_t array_size; /* Maximum number of entries in array */
/* Pointer to message structure for submessage /* Field definitions for submessage
* OR default value for all other non-array, non-callback types * OR default value for all other non-array, non-callback types
* If null, then field will zeroed. */ * If null, then field will zeroed. */
const void *ptr; const void *ptr;
@@ -119,44 +117,6 @@ typedef struct {
uint8_t bytes[1]; uint8_t bytes[1];
} pb_bytes_array_t; } pb_bytes_array_t;
/* This structure is used for dynamically allocated 'bytes' arrays.
*/
typedef struct {
size_t size;
size_t alloced;
uint8_t *bytes;
} pb_bytes_t;
/* This macro defines the type of a structure for a message with N
* fields.
*/
#define PB_MSG_STRUCT(N) struct { \
unsigned int field_count; \
size_t size; \
pb_field_t fields[N]; \
}
/* This is the visible type for generated message structures.
* The actual number of fields at the end will vary by message type.
*/
typedef PB_MSG_STRUCT(1) pb_message_t;
/* These macros are used to manipulate the has_fields array in
* generated messages.
*/
#define PB_FIELD_INDEX(TYPE, FIELD) TYPE ## _ ## FIELD ## _index
#define PB_FIELD_BYTE(TYPE, FIELD) (PB_FIELD_INDEX(TYPE, FIELD) / 8)
#define PB_FIELD_MASK(TYPE, FIELD) (1 << (PB_FIELD_INDEX(TYPE, FIELD) & 7))
#define PB_HAS_FIELD(STRUCT, TYPE, FIELD) \
(((STRUCT).has_fields[PB_FIELD_BYTE(TYPE, FIELD)] \
& PB_FIELD_MASK(TYPE, FIELD)) != 0)
#define PB_SET_FIELD(STRUCT, TYPE, FIELD) \
((STRUCT).has_fields[PB_FIELD_BYTE(TYPE, FIELD)] \
|= PB_FIELD_MASK(TYPE, FIELD))
#define PB_CLEAR_FIELD(STRUCT, TYPE, FIELD) \
((STRUCT).has_fields[PB_FIELD_BYTE(TYPE, FIELD)] \
&= ~PB_FIELD_MASK(TYPE, FIELD))
/* This structure is used for giving the callback function. /* This structure is used for giving the callback function.
* It is stored in the message structure and filled in by the method that * It is stored in the message structure and filled in by the method that
* calls pb_decode. * calls pb_decode.
@@ -177,13 +137,11 @@ typedef PB_MSG_STRUCT(1) pb_message_t;
*/ */
typedef struct _pb_istream_t pb_istream_t; typedef struct _pb_istream_t pb_istream_t;
typedef struct _pb_ostream_t pb_ostream_t; typedef struct _pb_ostream_t pb_ostream_t;
typedef struct _pb_strstream_t pb_strstream_t;
typedef struct _pb_callback_t pb_callback_t; typedef struct _pb_callback_t pb_callback_t;
struct _pb_callback_t { struct _pb_callback_t {
union { union {
bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg); bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg); bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
bool (*encode_buffer)(pb_strstream_t *stream, const pb_field_t *field, const void *arg);
} funcs; } funcs;
/* Free arg for use by callback */ /* Free arg for use by callback */

View File

@@ -14,9 +14,6 @@
#include "pb.h" #include "pb.h"
#include "pb_decode.h" #include "pb_decode.h"
#include <string.h> #include <string.h>
#ifdef MALLOC_HEADER
# include MALLOC_HEADER
#endif
typedef bool (*pb_decoder_t)(pb_istream_t *stream, const pb_field_t *field, void *dest) checkreturn; typedef bool (*pb_decoder_t)(pb_istream_t *stream, const pb_field_t *field, void *dest) checkreturn;
@@ -78,7 +75,7 @@ static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest)
{ {
uint64_t temp; uint64_t temp;
bool status = pb_decode_varint(stream, &temp); bool status = pb_decode_varint(stream, &temp);
*dest = temp; *dest = (uint32_t)temp;
return status; return status;
} }
@@ -188,7 +185,7 @@ static bool checkreturn make_string_substream(pb_istream_t *stream, pb_istream_t
/* Iterator for pb_field_t list */ /* Iterator for pb_field_t list */
typedef struct { typedef struct {
const pb_message_t *msg; const pb_field_t *start;
const pb_field_t *current; const pb_field_t *current;
int field_index; int field_index;
void *dest_struct; void *dest_struct;
@@ -196,10 +193,9 @@ typedef struct {
void *pSize; void *pSize;
} pb_field_iterator_t; } pb_field_iterator_t;
static void pb_field_init(pb_field_iterator_t *iter, const pb_message_t *msg, void *dest_struct) static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct)
{ {
iter->msg = msg; iter->start = iter->current = fields;
iter->current = msg->fields;
iter->field_index = 0; iter->field_index = 0;
iter->pData = (char*)dest_struct + iter->current->data_offset; iter->pData = (char*)dest_struct + iter->current->data_offset;
iter->pSize = (char*)iter->pData + iter->current->size_offset; iter->pSize = (char*)iter->pData + iter->current->size_offset;
@@ -216,9 +212,9 @@ static bool pb_field_next(pb_field_iterator_t *iter)
iter->current++; iter->current++;
iter->field_index++; iter->field_index++;
if (iter->field_index >= iter->msg->field_count) if (iter->current->tag == 0)
{ {
iter->current = &iter->msg->fields[0]; iter->current = iter->start;
iter->field_index = 0; iter->field_index = 0;
iter->pData = iter->dest_struct; iter->pData = iter->dest_struct;
prev_size = 0; prev_size = 0;
@@ -251,15 +247,13 @@ static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_t
{ {
pb_decoder_t func = PB_DECODERS[PB_LTYPE(iter->current->type)]; pb_decoder_t func = PB_DECODERS[PB_LTYPE(iter->current->type)];
#ifndef MALLOC_HEADER
if (PB_POINTER(iter->current->type))
return false;
#endif
switch (PB_HTYPE(iter->current->type)) switch (PB_HTYPE(iter->current->type))
{ {
case PB_HTYPE_REQUIRED: case PB_HTYPE_REQUIRED:
return func(stream, iter->current, iter->pData);
case PB_HTYPE_OPTIONAL: case PB_HTYPE_OPTIONAL:
*(bool*)iter->pSize = true;
return func(stream, iter->current, iter->pData); return func(stream, iter->current, iter->pData);
case PB_HTYPE_ARRAY: case PB_HTYPE_ARRAY:
@@ -340,22 +334,23 @@ static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_t
} }
/* Initialize message fields to default values, recursively */ /* Initialize message fields to default values, recursively */
static void pb_message_set_to_defaults(const pb_message_t *msg, void *dest_struct) static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct)
{ {
pb_field_iterator_t iter; pb_field_iterator_t iter;
pb_field_init(&iter, msg, dest_struct); pb_field_init(&iter, fields, dest_struct);
/* Initialize the has_fields array to zero. */
memset(dest_struct, 0, (msg->field_count + 7) / 8);
/* Initialize size/has fields and apply default values */ /* Initialize size/has fields and apply default values */
do do
{ {
if (iter.field_index >= msg->field_count) if (iter.current->tag == 0)
continue; continue;
/* Initialize the size field for repeated fields to 0. */ /* Initialize the size field for optional/repeated fields to 0. */
if (PB_HTYPE(iter.current->type) == PB_HTYPE_ARRAY) if (PB_HTYPE(iter.current->type) == PB_HTYPE_OPTIONAL)
{
*(bool*)iter.pSize = false;
}
else if (PB_HTYPE(iter.current->type) == PB_HTYPE_ARRAY)
{ {
*(size_t*)iter.pSize = 0; *(size_t*)iter.pSize = 0;
continue; /* Array is empty, no need to initialize contents */ continue; /* Array is empty, no need to initialize contents */
@@ -368,9 +363,6 @@ static void pb_message_set_to_defaults(const pb_message_t *msg, void *dest_struc
} }
else if (PB_LTYPE(iter.current->type) == PB_LTYPE_SUBMESSAGE) else if (PB_LTYPE(iter.current->type) == PB_LTYPE_SUBMESSAGE)
{ {
if (PB_POINTER(iter.current->type) &&
(*(void**)iter.pData == NULL))
continue;
pb_message_set_to_defaults(iter.current->ptr, iter.pData); pb_message_set_to_defaults(iter.current->ptr, iter.pData);
} }
else if (iter.current->ptr != NULL) else if (iter.current->ptr != NULL)
@@ -388,15 +380,15 @@ static void pb_message_set_to_defaults(const pb_message_t *msg, void *dest_struc
* Decode all fields * * Decode all fields *
*********************/ *********************/
bool checkreturn pb_decode(pb_istream_t *stream, const pb_message_t *msg, void *dest_struct) bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
{ {
uint32_t fields_seen = 0; /* Used to check for required fields */
pb_field_iterator_t iter; pb_field_iterator_t iter;
char *has_fields = dest_struct; int i;
unsigned int i;
pb_message_set_to_defaults(msg, dest_struct); pb_message_set_to_defaults(fields, dest_struct);
pb_field_init(&iter, msg, dest_struct); pb_field_init(&iter, fields, dest_struct);
while (stream->bytes_left) while (stream->bytes_left)
{ {
@@ -425,17 +417,17 @@ bool checkreturn pb_decode(pb_istream_t *stream, const pb_message_t *msg, void *
continue; continue;
} }
has_fields[iter.field_index/8] |= 1 << iter.field_index%8; fields_seen |= 1 << (iter.field_index & 31);
if (!decode_field(stream, wire_type, &iter)) if (!decode_field(stream, wire_type, &iter))
return false; return false;
} }
/* Check that all required fields were present. */ /* Check that all required fields (mod 31) were present. */
for (i = 0; i < msg->field_count; i++) for (i = 0; fields[i].tag != 0; i++)
{ {
if (PB_HTYPE(msg->fields[i].type) == PB_HTYPE_REQUIRED && if (PB_HTYPE(fields[i].type) == PB_HTYPE_REQUIRED &&
!(has_fields[i/8] & 1 << (i%8))) !(fields_seen & (1 << (i & 31))))
{ {
return false; return false;
} }
@@ -444,85 +436,6 @@ bool checkreturn pb_decode(pb_istream_t *stream, const pb_message_t *msg, void *
return true; return true;
} }
#ifdef MALLOC_HEADER
/* Clean a single unused field (or unused array element). */
static bool checkreturn pb_clean_pointer(const pb_field_t *field, void *data)
{
switch (PB_LTYPE(field->type))
{
case PB_LTYPE_BYTES:
{
pb_bytes_t *bytes = (pb_bytes_t*)data;
bytes->size = 0;
bytes->alloced = 0;
free(bytes->bytes);
return true;
}
case PB_LTYPE_STRING:
case PB_LTYPE_SUBMESSAGE:
{
void **obj = (void**)data;
free(*obj);
*obj = NULL;
return true;
}
default:
return false;
}
}
/* Clean unused trailing elements in an array. */
static bool checkreturn pb_clean_array(const pb_field_t *field, void *data, size_t count)
{
unsigned int i;
for (i = count; i < field->array_size; i++)
{
if (!pb_clean_pointer(field, data))
return false;
data = (char*)data + field->data_size;
}
return true;
}
/* Clean unused fields in a message. */
bool pb_clean(const pb_message_t *msg, void *dest_struct)
{
const char *has_fields = dest_struct;
const void *pSize;
char *pData = (char*)dest_struct;
size_t prev_size = 0;
unsigned int i;
for (i = 0; i < msg->field_count; i++)
{
const pb_field_t *field = &msg->fields[i];
bool status;
pData = pData + prev_size + field->data_offset;
pSize = pData + field->size_offset;
prev_size = field->data_size;
if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
prev_size *= field->array_size;
if (!PB_POINTER(field->type))
continue;
else if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
status = pb_clean_array(field, pData, *(size_t*)pSize);
else if (!(has_fields[i/8] & 1 << (i%8)))
status = pb_clean_pointer(field, pData);
else /* pointer field is used */
continue;
if (!status)
return false;
}
return true;
}
#endif
/* Field decoders */ /* Field decoders */
/* Copy destsize bytes from src so that values are casted properly. /* Copy destsize bytes from src so that values are casted properly.
@@ -535,6 +448,7 @@ static void endian_copy(void *dest, void *src, size_t destsize, size_t srcsize)
#ifdef __BIG_ENDIAN__ #ifdef __BIG_ENDIAN__
memcpy(dest, (char*)src + (srcsize - destsize), destsize); memcpy(dest, (char*)src + (srcsize - destsize), destsize);
#else #else
UNUSED(srcsize);
memcpy(dest, src, destsize); memcpy(dest, src, destsize);
#endif #endif
} }
@@ -567,6 +481,7 @@ bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, v
} }
return status; return status;
#else #else
UNUSED(field);
return pb_read(stream, (uint8_t*)dest, 4); return pb_read(stream, (uint8_t*)dest, 4);
#endif #endif
} }
@@ -583,6 +498,7 @@ bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, v
} }
return status; return status;
#else #else
UNUSED(field);
return pb_read(stream, (uint8_t*)dest, 8); return pb_read(stream, (uint8_t*)dest, 8);
#endif #endif
} }
@@ -596,27 +512,10 @@ bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, voi
return false; return false;
x->size = temp; x->size = temp;
if (x->size > field->data_size) /* Check length, noting the space taken by the size_t header. */
if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes))
return false; return false;
#ifdef MALLOC_HEADER
if (PB_POINTER(field->type))
{
pb_bytes_t *x2 = (pb_bytes_t*)dest;
if (x2->alloced < x2->size)
{
void *new_bytes = realloc(x2->bytes, x2->size);
if (!new_bytes)
return false;
x2->alloced = x2->size;
x2->bytes = new_bytes;
}
return pb_read(stream, x2->bytes, x2->size);
}
#endif
return pb_read(stream, x->bytes, x->size); return pb_read(stream, x->bytes, x->size);
} }
@@ -627,21 +526,10 @@ bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, vo
if (!pb_decode_varint32(stream, &size)) if (!pb_decode_varint32(stream, &size))
return false; return false;
if (size > field->data_size - 1) /* Check length, noting the null terminator */
if (size + 1 > field->data_size)
return false; return false;
#ifdef MALLOC_HEADER
if (PB_POINTER(field->type))
{
uint8_t *string = (uint8_t*)realloc(*(uint8_t**)dest, size + 1);
if (!string)
return false;
*(uint8_t**)dest = string;
dest = string;
}
#endif
status = pb_read(stream, (uint8_t*)dest, size); status = pb_read(stream, (uint8_t*)dest, size);
*((uint8_t*)dest + size) = 0; *((uint8_t*)dest + size) = 0;
return status; return status;
@@ -651,7 +539,6 @@ bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field
{ {
bool status; bool status;
pb_istream_t substream; pb_istream_t substream;
const pb_message_t *msg;
if (!make_string_substream(stream, &substream)) if (!make_string_substream(stream, &substream))
return false; return false;
@@ -659,26 +546,7 @@ bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field
if (field->ptr == NULL) if (field->ptr == NULL)
return false; return false;
msg = (const pb_message_t*)field->ptr; status = pb_decode(&substream, (pb_field_t*)field->ptr, dest);
#ifdef MALLOC_HEADER
if (PB_POINTER(field->type))
{
if (*(void**)dest == NULL)
{
void *object = calloc(1, msg->size);
if (!object)
return false;
*(void**)dest = object;
pb_message_set_to_defaults(msg, object);
dest = object;
} else {
dest = *(void**)dest;
}
}
#endif
status = pb_decode(&substream, msg, dest);
stream->state = substream.state; stream->state = substream.state;
return status; return status;
} }

View File

@@ -40,9 +40,9 @@ bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
/* Decode from stream to destination struct. /* Decode from stream to destination struct.
* Returns true on success, false on any failure. * Returns true on success, false on any failure.
* The actual struct pointed to by dest must match the description in msg. * The actual struct pointed to by dest must match the description in fields.
*/ */
bool pb_decode(pb_istream_t *stream, const pb_message_t *msg, void *dest_struct); bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
/* --- Helper functions --- /* --- Helper functions ---
* You may want to use these from your caller or callbacks. * You may want to use these from your caller or callbacks.
@@ -68,10 +68,4 @@ bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest);
bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest); bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest);
bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest); bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest);
/* Release memory and clear pointers for any unused elements of
* dest_struct. This function is only compiled when MALLOC_HEADER is
* defined for pb_decode.c.
*/
bool pb_clean(const pb_message_t *msg, void *dest_struct);
#endif #endif

View File

@@ -3,6 +3,7 @@
* 2011 Petteri Aimonen <jpa@kapsi.fi> * 2011 Petteri Aimonen <jpa@kapsi.fi>
*/ */
#define NANOPB_INTERNALS
#include "pb.h" #include "pb.h"
#include "pb_encode.h" #include "pb_encode.h"
#include <string.h> #include <string.h>
@@ -75,7 +76,7 @@ bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count
static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field, static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field,
const void *pData, size_t count, pb_encoder_t func) const void *pData, size_t count, pb_encoder_t func)
{ {
int i; size_t i;
const void *p; const void *p;
size_t size; size_t size;
@@ -140,17 +141,15 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
return true; return true;
} }
bool checkreturn pb_encode(pb_ostream_t *stream, const pb_message_t *msg, const void *src_struct) bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
{ {
const pb_field_t *field = fields;
const void *pData = src_struct; const void *pData = src_struct;
const void *pSize; const void *pSize;
const char *has_fields = src_struct;
unsigned int i;
size_t prev_size = 0; size_t prev_size = 0;
for (i = 0; i < msg->field_count; i++) while (field->tag != 0)
{ {
const pb_field_t *field = &msg->fields[i];
pb_encoder_t func = PB_ENCODERS[PB_LTYPE(field->type)]; pb_encoder_t func = PB_ENCODERS[PB_LTYPE(field->type)];
pData = (const char*)pData + prev_size + field->data_offset; pData = (const char*)pData + prev_size + field->data_offset;
pSize = (const char*)pData + field->size_offset; pSize = (const char*)pData + field->size_offset;
@@ -161,16 +160,6 @@ bool checkreturn pb_encode(pb_ostream_t *stream, const pb_message_t *msg, const
switch (PB_HTYPE(field->type)) switch (PB_HTYPE(field->type))
{ {
case PB_HTYPE_OPTIONAL:
if (!(has_fields[i/8] & (1 << i%8)))
break;
if (PB_POINTER(field->type)
&& (PB_LTYPE(field->type) == PB_LTYPE_STRING
|| PB_LTYPE(field->type) == PB_LTYPE_SUBMESSAGE)
&& *(void**)pData == NULL)
break;
/* else fall through to required case */
case PB_HTYPE_REQUIRED: case PB_HTYPE_REQUIRED:
if (!pb_encode_tag_for_field(stream, field)) if (!pb_encode_tag_for_field(stream, field))
return false; return false;
@@ -178,6 +167,17 @@ bool checkreturn pb_encode(pb_ostream_t *stream, const pb_message_t *msg, const
return false; return false;
break; break;
case PB_HTYPE_OPTIONAL:
if (*(bool*)pSize)
{
if (!pb_encode_tag_for_field(stream, field))
return false;
if (!func(stream, field, pData))
return false;
}
break;
case PB_HTYPE_ARRAY: case PB_HTYPE_ARRAY:
if (!encode_array(stream, field, pData, *(size_t*)pSize, func)) if (!encode_array(stream, field, pData, *(size_t*)pSize, func))
return false; return false;
@@ -194,6 +194,8 @@ bool checkreturn pb_encode(pb_ostream_t *stream, const pb_message_t *msg, const
break; break;
} }
} }
field++;
} }
return true; return true;
@@ -210,7 +212,7 @@ bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
while (value) while (value)
{ {
buffer[i] = (value & 0x7F) | 0x80; buffer[i] = (uint8_t)((value & 0x7F) | 0x80);
value >>= 7; value >>= 7;
i++; i++;
} }
@@ -219,6 +221,40 @@ bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
return pb_write(stream, buffer, i); return pb_write(stream, buffer, i);
} }
bool checkreturn pb_encode_svarint(pb_ostream_t *stream, int64_t value)
{
uint64_t zigzagged;
if (value < 0)
zigzagged = ~(value << 1);
else
zigzagged = value << 1;
return pb_encode_varint(stream, zigzagged);
}
bool checkreturn pb_encode_fixed32(pb_ostream_t *stream, const void *value)
{
#ifdef __BIG_ENDIAN__
uint8_t *bytes = value;
uint8_t lebytes[4] = {bytes[3], bytes[2], bytes[1], bytes[0]};
return pb_write(stream, lebytes, 4);
#else
return pb_write(stream, (uint8_t*)value, 4);
#endif
}
bool checkreturn pb_encode_fixed64(pb_ostream_t *stream, const void *value)
{
#ifdef __BIG_ENDIAN__
uint8_t *bytes[8] = value;
uint8_t lebytes[8] = {bytes[7], bytes[6], bytes[5], bytes[4],
bytes[3], bytes[2], bytes[1], bytes[0]};
return pb_write(stream, lebytes, 8);
#else
return pb_write(stream, (uint8_t*)value, 8);
#endif
}
bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number) bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number)
{ {
int tag = wiretype | (field_number << 3); int tag = wiretype | (field_number << 3);
@@ -264,108 +300,14 @@ bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, s
return pb_write(stream, buffer, size); return pb_write(stream, buffer, size);
} }
/* Field encoders */ bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
/* Copy srcsize bytes from src so that values are casted properly.
* On little endian machine, copy to start of dest
* On big endian machine, copy to end of dest
* destsize must always be larger than srcsize
*
* Note: This is the reverse of the endian_copy in pb_decode.c.
*/
static void endian_copy(void *dest, const void *src, size_t destsize, size_t srcsize)
{
#ifdef __BIG_ENDIAN__
memcpy((char*)dest + (destsize - srcsize), src, srcsize);
#else
memcpy(dest, src, srcsize);
#endif
}
bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
uint64_t value = 0;
endian_copy(&value, src, sizeof(value), field->data_size);
return pb_encode_varint(stream, value);
}
bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
uint64_t value = 0;
uint64_t zigzagged;
uint64_t signbitmask, xormask;
endian_copy(&value, src, sizeof(value), field->data_size);
signbitmask = (uint64_t)0x80 << (field->data_size * 8 - 8);
xormask = ((uint64_t)-1) >> (64 - field->data_size * 8);
if (value & signbitmask)
zigzagged = ((value ^ xormask) << 1) | 1;
else
zigzagged = value << 1;
return pb_encode_varint(stream, zigzagged);
}
bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
#ifdef __BIG_ENDIAN__
uint8_t bytes[8] = {0};
memcpy(bytes, src, 8);
uint8_t lebytes[8] = {bytes[7], bytes[6], bytes[5], bytes[4],
bytes[3], bytes[2], bytes[1], bytes[0]};
return pb_write(stream, lebytes, 8);
#else
return pb_write(stream, (uint8_t*)src, 8);
#endif
}
bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
#ifdef __BIG_ENDIAN__
uint8_t bytes[4] = {0};
memcpy(bytes, src, 4);
uint8_t lebytes[4] = {bytes[3], bytes[2], bytes[1], bytes[0]};
return pb_write(stream, lebytes, 4);
#else
return pb_write(stream, (uint8_t*)src, 4);
#endif
}
bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
if ((field != NULL) && PB_POINTER(field->type)) {
pb_bytes_t *bytes = (pb_bytes_t*)src;
return pb_encode_string(stream, bytes->bytes, bytes->size);
} else {
pb_bytes_array_t *bytes = (pb_bytes_array_t*)src;
return pb_encode_string(stream, bytes->bytes, bytes->size);
}
}
bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
size_t len;
if ((field != NULL) && PB_POINTER(field->type))
src = *(char**)src;
len = src ? strlen((char*)src) : 0;
return pb_encode_string(stream, (uint8_t*)src, len);
}
bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{ {
/* First calculate the message size using a non-writing substream. */
pb_ostream_t substream = {0}; pb_ostream_t substream = {0};
size_t size; size_t size;
bool status; bool status;
if (field->ptr == NULL) if (!pb_encode(&substream, fields, src_struct))
return false;
if (PB_POINTER(field->type)) {
src = *(void**)src;
if (src == NULL)
return false;
}
if (!pb_encode(&substream, (const pb_message_t*)field->ptr, src))
return false; return false;
size = substream.bytes_written; size = substream.bytes_written;
@@ -386,7 +328,7 @@ bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field
substream.max_size = size; substream.max_size = size;
substream.bytes_written = 0; substream.bytes_written = 0;
status = pb_encode(&substream, (const pb_message_t*)field->ptr, src); status = pb_encode(&substream, fields, src_struct);
stream->bytes_written += substream.bytes_written; stream->bytes_written += substream.bytes_written;
stream->state = substream.state; stream->state = substream.state;
@@ -397,3 +339,68 @@ bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field
return status; return status;
} }
/* Field encoders */
bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
uint64_t value = 0;
switch (field->data_size)
{
case 1: value = *(uint8_t*)src; break;
case 2: value = *(uint16_t*)src; break;
case 4: value = *(uint32_t*)src; break;
case 8: value = *(uint64_t*)src; break;
default: return false;
}
return pb_encode_varint(stream, value);
}
bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
uint64_t value = 0;
switch (field->data_size)
{
case 4: value = *(int32_t*)src; break;
case 8: value = *(int64_t*)src; break;
default: return false;
}
return pb_encode_svarint(stream, value);
}
bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
UNUSED(field);
return pb_encode_fixed64(stream, src);
}
bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
UNUSED(field);
return pb_encode_fixed32(stream, src);
}
bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
pb_bytes_array_t *bytes = (pb_bytes_array_t*)src;
UNUSED(field);
return pb_encode_string(stream, bytes->bytes, bytes->size);
}
bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
UNUSED(field);
return pb_encode_string(stream, (uint8_t*)src, strlen((char*)src));
}
bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
{
if (field->ptr == NULL)
return false;
return pb_encode_submessage(stream, (pb_field_t*)field->ptr, src);
}

View File

@@ -39,34 +39,65 @@ bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
/* Encode struct to given output stream. /* Encode struct to given output stream.
* Returns true on success, false on any failure. * Returns true on success, false on any failure.
* The actual struct pointed to by src_struct must match the description in msg. * The actual struct pointed to by src_struct must match the description in fields.
* All required fields in the struct are assumed to have been filled in. * All required fields in the struct are assumed to have been filled in.
*/ */
bool pb_encode(pb_ostream_t *stream, const pb_message_t *msg, const void *src_struct); bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
/* --- Helper functions --- /* --- Helper functions ---
* You may want to use these from your caller or callbacks. * You may want to use these from your caller or callbacks.
*/ */
bool pb_encode_varint(pb_ostream_t *stream, uint64_t value); /* Encode field header based on LTYPE and field number defined in the field structure.
bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number); * Call this from the callback before writing out field contents. */
/* Encode tag based on LTYPE and field number defined in the field structure. */
bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field); bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field);
/* Write length as varint and then the contents of buffer. */
/* Encode field header by manually specifing wire type. You need to use this if
* you want to write out packed arrays from a callback field. */
bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number);
/* Encode an integer in the varint format.
* This works for bool, enum, int32, int64, uint32 and uint64 field types. */
bool pb_encode_varint(pb_ostream_t *stream, uint64_t value);
/* Encode an integer in the zig-zagged svarint format.
* This works for sint32 and sint64. */
bool pb_encode_svarint(pb_ostream_t *stream, int64_t value);
/* Encode a string or bytes type field. For strings, pass strlen(s) as size. */
bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size); bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size);
/* --- Field encoders --- /* Encode a fixed32, sfixed32 or float value.
* Each encoder writes the content for the field. * You need to pass a pointer to a 4-byte wide C variable. */
* The tag/wire type has been written already. bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
/* Encode a fixed64, sfixed64 or double value.
* You need to pass a pointer to a 8-byte wide C variable. */
bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
/* Encode a submessage field.
* You need to pass the pb_field_t array and pointer to struct, just like with pb_encode().
* This internally encodes the submessage twice, first to calculate message size and then to actually write it out.
*/
bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
/* --- Internal functions ---
* These functions are not terribly useful for the average library user, but
* are exported to make the unit testing and extending nanopb easier.
*/ */
#ifdef NANOPB_INTERNALS
bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src); bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
bool pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src); bool pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
bool pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src); bool pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src);
bool pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src); bool pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src);
bool pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src); bool pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src);
bool pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src); bool pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src);
#endif
/* This function is not recommended for new programs. Use pb_encode_submessage()
* instead, it has the same functionality with a less confusing interface. */
bool pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src); bool pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src);
#endif #endif

View File

@@ -1,362 +0,0 @@
/* pb_encode_buffer.c - encode a protobuf to an in-memory array
*
* 2011 Michael Poole <mdpoole@troilus.org>
* Part of nanopb, 2011 Petteri Aimonen <jpa@kapsi.fi>
*/
#include "pb_encode_buffer.h"
#include <string.h>
#ifdef __GNUC__
/* Verify that we remember to check all return values for proper error propagation */
#define checkreturn __attribute__((warn_unused_result))
#else
#define checkreturn
#endif
typedef bool (*pb_encoder_t)(pb_strstream_t *stream, const pb_field_t *field, const void *src) checkreturn;
static bool pb_encb_varint(pb_strstream_t *stream, const pb_field_t *field, const void *src);
static bool pb_encb_svarint(pb_strstream_t *stream, const pb_field_t *field, const void *src);
static bool pb_encb_fixed32(pb_strstream_t *stream, const pb_field_t *field, const void *src);
static bool pb_encb_fixed64(pb_strstream_t *stream, const pb_field_t *field, const void *src);
static bool pb_encb_bytes(pb_strstream_t *stream, const pb_field_t *field, const void *src);
static bool pb_encb_string(pb_strstream_t *stream, const pb_field_t *field, const void *src);
static bool pb_encb_submessage(pb_strstream_t *stream, const pb_field_t *field, const void *src);
/* --- Function pointers to field encoders ---
* Order in the array must match pb_action_t LTYPE numbering.
*/
static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
&pb_encb_varint,
&pb_encb_svarint,
&pb_encb_fixed32,
&pb_encb_fixed64,
&pb_encb_bytes,
&pb_encb_string,
&pb_encb_submessage
};
/* pb_strstream_t implementation */
pb_strstream_t pb_strstream_from_buffer(uint8_t *buf, size_t bufsize)
{
pb_strstream_t stream;
stream.buffer = buf;
stream.last = buf + bufsize;
return stream;
}
bool pb_buf_write(pb_strstream_t *stream, const uint8_t *buf, size_t count)
{
if (stream->buffer + count > stream->last)
return false;
stream->last -= count;
memcpy(stream->last, buf, count);
return true;
}
/* Main encoding stuff */
/* This function is static for the same reason as the version in
* pb_encode.c.
*/
static bool checkreturn encode_array(pb_strstream_t *stream, const pb_field_t *field,
const void *pData, size_t count, pb_encoder_t func)
{
const void *p;
uint8_t *start;
size_t size;
int i;
if (count == 0)
return true;
start = stream->last;
p = (const char*)pData + field->data_size * count;
if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
{
/* Write the data (in reverse order). */
for (i = 0; i < count; i++)
{
p = (const char*)p - field->data_size;
if (!func(stream, field, p))
return false;
}
/* Write the size. */
size = start - stream->last;
if (!pb_encbuf_varint(stream, size))
return false;
if (!pb_encbuf_tag(stream, PB_WT_STRING, field->tag))
return false;
}
else
{
for (i = 0; i < count; i++)
{
p = (const char*)p - field->data_size;
if (!func(stream, field, p))
return false;
if (!pb_encbuf_tag_for_field(stream, field))
return false;
}
}
return true;
}
bool checkreturn pb_encode_buffer(pb_strstream_t *stream, const pb_message_t *msg, const void *src_struct)
{
const char *has_fields = src_struct;
const uint8_t *pData = src_struct;
const pb_field_t *field;
pb_encoder_t func;
size_t size;
unsigned int i;
/* msg->size includes trailing padding, so we must calculate the
* offset of the last field by counting forward from the start.
*/
for (i = 0; i < msg->field_count; i++)
{
field = &msg->fields[i];
pData += field->data_offset;
size = field->data_size;
if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
size *= field->array_size;
pData += size;
}
/* Iterate through the fields in reverse order. Because we write
* from the end of the buffer, the result is in canonical order.
*/
for (i = msg->field_count; i > 0; pData -= field->data_offset)
{
field = &msg->fields[--i];
func = PB_ENCODERS[PB_LTYPE(field->type)];
size = field->data_size;
if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
size *= field->array_size;
pData -= size;
switch (PB_HTYPE(field->type))
{
case PB_HTYPE_OPTIONAL:
if (!(has_fields[i/8] & (1 << i%8)))
break;
if (PB_POINTER(field->type)
&& (PB_LTYPE(field->type) == PB_LTYPE_STRING
|| PB_LTYPE(field->type) == PB_LTYPE_SUBMESSAGE)
&& *(void**)pData == NULL)
break;
/* else fall through to required case */
case PB_HTYPE_REQUIRED:
if (!func(stream, field, pData))
return false;
if (!pb_encbuf_tag_for_field(stream, field))
return false;
break;
case PB_HTYPE_ARRAY:
size = *(size_t*)(pData + field->size_offset);
if (!encode_array(stream, field, pData, size, func))
return false;
break;
case PB_HTYPE_CALLBACK:
{
pb_callback_t *callback = (pb_callback_t*)pData;
if (callback->funcs.encode_buffer != NULL
&& !callback->funcs.encode_buffer(stream, field, callback->arg))
return false;
break;
}
}
}
return true;
}
/* Helper functions */
bool checkreturn pb_encbuf_varint(pb_strstream_t *stream, uint64_t value)
{
if (stream->last == stream->buffer)
{
return false;
}
else if (value < 128)
{
*--stream->last = value;
return true;
}
else
{
uint8_t buffer[10];
int i = 0;
while (value)
{
buffer[i] = (value & 0x7F) | 0x80;
value >>= 7;
i++;
}
buffer[i-1] &= 0x7F;
return pb_buf_write(stream, buffer, i);
}
}
bool checkreturn pb_encbuf_tag(pb_strstream_t *stream, pb_wire_type_t wiretype, int field_number)
{
int tag = wiretype | (field_number << 3);
return pb_encbuf_varint(stream, tag);
}
bool checkreturn pb_encbuf_tag_for_field(pb_strstream_t *stream, const pb_field_t *field)
{
pb_wire_type_t wiretype;
switch (PB_LTYPE(field->type))
{
case PB_LTYPE_VARINT:
case PB_LTYPE_SVARINT:
wiretype = PB_WT_VARINT;
break;
case PB_LTYPE_FIXED32:
wiretype = PB_WT_32BIT;
break;
case PB_LTYPE_FIXED64:
wiretype = PB_WT_64BIT;
break;
case PB_LTYPE_BYTES:
case PB_LTYPE_STRING:
case PB_LTYPE_SUBMESSAGE:
wiretype = PB_WT_STRING;
break;
default:
return false;
}
return pb_encbuf_tag(stream, wiretype, field->tag);
}
bool checkreturn pb_encbuf_string(pb_strstream_t *stream, const uint8_t *buffer, size_t size)
{
if (!pb_buf_write(stream, buffer, size))
return false;
return pb_encbuf_varint(stream, size);
}
/* Field encoders */
/* Copy srcsize bytes of integer from src so that values are casted properly.
* On little endian machine, copy to start of dest
* On big endian machine, copy to end of dest
* destsize must always be larger than srcsize
*
* Note: This is the reverse of the endian_copy in pb_decode.c.
*/
static void endian_copy(uint64_t *dest, const void *src, size_t srcsize)
{
#ifdef __BIG_ENDIAN__
memcpy((char*)dest + sizeof(*dest) - srcsize, src, srcsize);
#else
memcpy(dest, src, srcsize);
#endif
}
static bool pb_encb_varint(pb_strstream_t *stream, const pb_field_t *field, const void *src)
{
uint64_t value = 0;
endian_copy(&value, src, field->data_size);
return pb_encbuf_varint(stream, value);
}
static bool pb_encb_svarint(pb_strstream_t *stream, const pb_field_t *field, const void *src)
{
uint64_t value = 0;
uint64_t zigzagged;
uint64_t signbitmask = (uint64_t)0x80 << (field->data_size * 8 - 8);
uint64_t xormask = ((uint64_t)-1) >> (64 - field->data_size * 8);
endian_copy(&value, src, field->data_size);
if (value & signbitmask)
zigzagged = ((value ^ xormask) << 1) | 1;
else
zigzagged = value << 1;
return pb_encbuf_varint(stream, zigzagged);
}
static bool pb_encb_fixed32(pb_strstream_t *stream, const pb_field_t *field, const void *src)
{
#ifdef __BIG_ENDIAN__
const uint8_t *bytes = (const uint8_t*)src;
uint8_t lebytes[4] = {bytes[3], bytes[2], bytes[1], bytes[0]};
src = lebytes;
#endif
return pb_buf_write(stream, src, 4);
}
static bool pb_encb_fixed64(pb_strstream_t *stream, const pb_field_t *field, const void *src)
{
#ifdef __BIG_ENDIAN__
const uint8_t *bytes = (const uint8_t*)src;
uint8_t lebytes[8] = {bytes[7], bytes[6], bytes[5], bytes[4],
bytes[3], bytes[2], bytes[1], bytes[0]};
src = lebytes;
#endif
return pb_buf_write(stream, src, 8);
}
static bool pb_encb_bytes(pb_strstream_t *stream, const pb_field_t *field, const void *src)
{
if ((field != NULL) && PB_POINTER(field->type)) {
pb_bytes_t *bytes = (pb_bytes_t*)src;
return pb_encbuf_string(stream, bytes->bytes, bytes->size);
} else {
pb_bytes_array_t *bytes = (pb_bytes_array_t*)src;
return pb_encbuf_string(stream, bytes->bytes, bytes->size);
}
}
static bool pb_encb_string(pb_strstream_t *stream, const pb_field_t *field, const void *src)
{
size_t len;
if ((field != NULL) && PB_POINTER(field->type))
src = *(char**)src;
len = src ? strlen((char*)src) : 0;
return pb_encbuf_string(stream, (uint8_t*)src, len);
}
static bool pb_encb_submessage(pb_strstream_t *stream, const pb_field_t *field, const void *src)
{
uint8_t *start;
size_t size;
if (field->ptr == NULL)
return false;
if (PB_POINTER(field->type)) {
src = *(void**)src;
if (src == NULL)
return false;
}
start = stream->last;
if (!pb_encode_buffer(stream, (const pb_message_t*)field->ptr, src))
return false;
size = start - stream->last;
if (!pb_encbuf_varint(stream, size))
return false;
return true;
}

View File

@@ -1,43 +0,0 @@
#ifndef _PB_ENCODE_BUFFER_H_
#define _PB_ENCODE_BUFFER_H_
/* pb_encode_buffer.h: Functions to encode protocol buffers to an
* in-memory array of bytes. Depends on pb_encode_buffer.c. The main
* function is pb_encode_buffer. You also need an output buffer,
* structures and their field descriptions (just like with pb_decode
* or pb_encode).
*/
#include <stdbool.h>
#include "pb.h"
/* Output stream for an in-memory buffer.
*/
struct _pb_strstream_t
{
uint8_t *buffer;
uint8_t *last;
};
pb_strstream_t pb_strstream_from_buffer(uint8_t *buf, size_t bufsize);
bool pb_buf_write(pb_strstream_t *stream, const uint8_t *buf, size_t count);
/* --- Helper functions ---
* You may want to use these from your caller or callbacks.
*/
bool pb_encbuf_varint(pb_strstream_t *stream, uint64_t value);
bool pb_encbuf_tag(pb_strstream_t *stream, pb_wire_type_t wiretype, int field_number);
/* Encode tag based on LTYPE and field number defined in the field structure. */
bool pb_encbuf_tag_for_field(pb_strstream_t *stream, const pb_field_t *field);
/* Write length as varint and then the contents of buffer. */
bool pb_encbuf_string(pb_strstream_t *stream, const uint8_t *buffer, size_t size);
/* Encode struct to given output stream.
* Returns true on success, false on any failure.
* The actual struct pointed to by src_struct must match the description in msg.
* All required fields in the struct are assumed to have been filled in.
*/
bool pb_encode_buffer(pb_strstream_t *stream, const pb_message_t *msg, const void *src_struct);
#endif

View File

@@ -1,12 +1,12 @@
CFLAGS=-ansi -Wall -Werror -I .. -g -O0 --coverage CFLAGS=-ansi -Wall -Werror -I .. -g -O0 --coverage
LDFLAGS=--coverage LDFLAGS=--coverage
DEPS=../pb_decode.h ../pb_encode.h ../pb_encode_buffer.h ../pb.h person.pb.h callbacks.pb.h unittests.h unittestproto.pb.h DEPS=../pb_decode.h ../pb_encode.h ../pb.h person.pb.h callbacks.pb.h unittests.h unittestproto.pb.h alltypes.pb.h
TESTS=test_decode1 test_encode1 test_decode_callbacks test_encode_callbacks decode_unittests decode_ptr_unittests encode_unittests TESTS=test_decode1 test_encode1 decode_unittests encode_unittests
all: breakpoints $(TESTS) run_unittests all: breakpoints $(TESTS) run_unittests
clean: clean:
rm -f $(TESTS) *.pb.c *.pb.h *.o *.gcda *.gcno rm -f $(TESTS) person.pb* alltypes.pb* *.o *.gcda *.gcno
%.o: %.c %.o: %.c
%.o: %.c $(DEPS) %.o: %.c $(DEPS)
@@ -14,25 +14,19 @@ clean:
pb_encode.o: ../pb_encode.c $(DEPS) pb_encode.o: ../pb_encode.c $(DEPS)
$(CC) $(CFLAGS) -c -o $@ $< $(CC) $(CFLAGS) -c -o $@ $<
pb_encode_buffer.o: ../pb_encode_buffer.c $(DEPS)
$(CC) $(CFLAGS) -c -o $@ $<
pb_decode.o: ../pb_decode.c $(DEPS) pb_decode.o: ../pb_decode.c $(DEPS)
$(CC) $(CFLAGS) -c -o $@ $< $(CC) $(CFLAGS) -c -o $@ $<
pb_ptr_decode.o: ../pb_decode.c $(DEPS)
$(CC) $(CFLAGS) -c -o $@ $<
decode_ptr_unittests.o: decode_unittests.c $(DEPS)
$(CC) $(CFLAGS) -c -o $@ $<
test_decode1: test_decode1.o pb_decode.o person.pb.o test_decode1: test_decode1.o pb_decode.o person.pb.o
test_decode2: test_decode2.o pb_decode.o person.pb.o test_decode2: test_decode2.o pb_decode.o person.pb.o
test_decode3: test_decode3.o pb_decode.o alltypes.pb.o
test_encode1: test_encode1.o pb_encode.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_encode2: test_encode2.o pb_encode.o person.pb.o
test_encode3: test_encode3.o pb_encode.o alltypes.pb.o
test_decode_callbacks: test_decode_callbacks.o pb_decode.o callbacks.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 test_encode_callbacks: test_encode_callbacks.o pb_encode.o callbacks.pb.o
decode_unittests: decode_unittests.o pb_decode.o unittestproto.pb.o decode_unittests: decode_unittests.o pb_decode.o unittestproto.pb.o
pb_ptr_decode.o decode_ptr_unittests.o: CFLAGS += -DMALLOC_HEADER="<stdlib.h>" encode_unittests: encode_unittests.o pb_encode.o unittestproto.pb.o
decode_ptr_unittests: decode_ptr_unittests.o pb_ptr_decode.o unittestproto.pb.o
encode_unittests: encode_unittests.o pb_encode.o pb_encode_buffer.o unittestproto.pb.o
%.pb: %.proto %.pb: %.proto
protoc -I. -I../generator -I/usr/include -o$@ $< protoc -I. -I../generator -I/usr/include -o$@ $<
@@ -45,15 +39,12 @@ breakpoints: ../*.c *.c
coverage: run_unittests coverage: run_unittests
gcov pb_encode.gcda gcov pb_encode.gcda
gcov pb_encode_buffer.gcda
gcov pb_decode.gcda gcov pb_decode.gcda
gcov pb_ptr_decode.gcda
run_unittests: decode_unittests decode_ptr_unittests encode_unittests test_encode1 test_encode2 test_decode1 test_decode2 test_encode_callbacks test_decode_callbacks run_unittests: decode_unittests encode_unittests test_encode1 test_encode2 test_encode3 test_decode1 test_decode2 test_decode3 test_encode_callbacks test_decode_callbacks
rm -f *.gcda rm -f *.gcda
./decode_unittests > /dev/null ./decode_unittests > /dev/null
./decode_ptr_unittests > /dev/null
./encode_unittests > /dev/null ./encode_unittests > /dev/null
[ "`./test_encode1 | ./test_decode1`" = \ [ "`./test_encode1 | ./test_decode1`" = \
@@ -68,5 +59,8 @@ run_unittests: decode_unittests decode_ptr_unittests encode_unittests test_encod
[ "`./test_encode_callbacks | ./test_decode_callbacks`" = \ [ "`./test_encode_callbacks | ./test_decode_callbacks`" = \
"`./test_encode_callbacks | protoc --decode=TestMessage callbacks.proto`" ] "`./test_encode_callbacks | protoc --decode=TestMessage callbacks.proto`" ]
./test_encode3 | ./test_decode3
./test_encode3 | protoc --decode=AllTypes -I. -I../generator -I/usr/include alltypes.proto >/dev/null
run_fuzztest: test_decode2 run_fuzztest: test_decode2
bash -c 'I=1; while true; do cat /dev/urandom | ./test_decode2 > /dev/null; I=$$(($$I+1)); echo -en "\r$$I"; done' bash -c 'I=1; while true; do cat /dev/urandom | ./test_decode2 > /dev/null; I=$$(($$I+1)); echo -en "\r$$I"; done'

40
tests/alltypes.proto Normal file
View File

@@ -0,0 +1,40 @@
import "nanopb.proto";
message SubMessage {
required string substuff1 = 1 [(nanopb).max_size = 16];
required int32 substuff2 = 2;
}
enum MyEnum {
First = 1;
Second = 2;
Truth = 42;
}
message AllTypes {
required int32 req_int32 = 1;
required int64 req_int64 = 2;
required uint32 req_uint32 = 3;
required uint64 req_uint64 = 4;
required sint32 req_sint32 = 5;
required sint64 req_sint64 = 6;
required bool req_bool = 7;
required fixed32 req_fixed32 = 8;
required sfixed32 req_sfixed32= 9;
required float req_float = 10;
required fixed64 req_fixed64 = 11;
required sfixed64 req_sfixed64= 12;
required double req_double = 13;
required string req_string = 14 [(nanopb).max_size = 16];
required bytes req_bytes = 15 [(nanopb).max_size = 16];
required SubMessage req_submsg = 16;
required MyEnum req_enum = 17;
// Just to make sure that the size of the fields has been calculated
// properly, i.e. otherwise a bug in last field might not be detected.
required int32 end = 99;
}

View File

@@ -167,14 +167,22 @@ int main()
{ {
pb_istream_t s; pb_istream_t s;
struct { size_t size; uint8_t bytes[5]; } d; struct { size_t size; uint8_t bytes[5]; } d;
pb_field_t f = {1, PB_LTYPE_BYTES, 0, 0, 5, 0, 0}; pb_field_t f = {1, PB_LTYPE_BYTES, 0, 0, sizeof(d), 0, 0};
COMMENT("Test pb_dec_bytes") COMMENT("Test pb_dec_bytes")
TEST((s = S("\x00"), pb_dec_bytes(&s, &f, &d) && d.size == 0)) TEST((s = S("\x00"), pb_dec_bytes(&s, &f, &d) && d.size == 0))
TEST((s = S("\x01\xFF"), pb_dec_bytes(&s, &f, &d) && d.size == 1 && d.bytes[0] == 0xFF)) TEST((s = S("\x01\xFF"), pb_dec_bytes(&s, &f, &d) && d.size == 1 && d.bytes[0] == 0xFF))
TEST((s = S("\x06xxxxxx"), !pb_dec_bytes(&s, &f, &d)))
TEST((s = S("\x05xxxxx"), pb_dec_bytes(&s, &f, &d) && d.size == 5)) TEST((s = S("\x05xxxxx"), pb_dec_bytes(&s, &f, &d) && d.size == 5))
TEST((s = S("\x05xxxx"), !pb_dec_bytes(&s, &f, &d))) TEST((s = S("\x05xxxx"), !pb_dec_bytes(&s, &f, &d)))
/* Note: the size limit on bytes-fields is not strictly obeyed, as
* the compiler may add some padding to the struct. Using this padding
* is not a very good thing to do, but it is difficult to avoid when
* we use only a single uint8_t to store the size of the field.
* Therefore this tests against a 10-byte string, while otherwise even
* 6 bytes should error out.
*/
TEST((s = S("\x10xxxxxxxxxx"), !pb_dec_bytes(&s, &f, &d)))
} }
{ {
@@ -193,13 +201,13 @@ int main()
IntegerArray dest; IntegerArray dest;
COMMENT("Testing pb_decode with repeated int32 field") COMMENT("Testing pb_decode with repeated int32 field")
TEST((s = S(""), pb_decode(&s, IntegerArray_msg, &dest) && dest.data_count == 0)) TEST((s = S(""), pb_decode(&s, IntegerArray_fields, &dest) && dest.data_count == 0))
TEST((s = S("\x08\x01\x08\x02"), pb_decode(&s, IntegerArray_msg, &dest) TEST((s = S("\x08\x01\x08\x02"), pb_decode(&s, IntegerArray_fields, &dest)
&& dest.data_count == 2 && dest.data[0] == 1 && dest.data[1] == 2)) && dest.data_count == 2 && dest.data[0] == 1 && dest.data[1] == 2))
s = S("\x08\x01\x08\x02\x08\x03\x08\x04\x08\x05\x08\x06\x08\x07\x08\x08\x08\x09\x08\x0A"); s = S("\x08\x01\x08\x02\x08\x03\x08\x04\x08\x05\x08\x06\x08\x07\x08\x08\x08\x09\x08\x0A");
TEST(pb_decode(&s, IntegerArray_msg, &dest) && dest.data_count == 10 && dest.data[9] == 10) TEST(pb_decode(&s, IntegerArray_fields, &dest) && dest.data_count == 10 && dest.data[9] == 10)
s = S("\x08\x01\x08\x02\x08\x03\x08\x04\x08\x05\x08\x06\x08\x07\x08\x08\x08\x09\x08\x0A\x08\x0B"); s = S("\x08\x01\x08\x02\x08\x03\x08\x04\x08\x05\x08\x06\x08\x07\x08\x08\x08\x09\x08\x0A\x08\x0B");
TEST(!pb_decode(&s, IntegerArray_msg, &dest)) TEST(!pb_decode(&s, IntegerArray_fields, &dest))
} }
{ {
@@ -207,17 +215,17 @@ int main()
IntegerArray dest; IntegerArray dest;
COMMENT("Testing pb_decode with packed int32 field") COMMENT("Testing pb_decode with packed int32 field")
TEST((s = S("\x0A\x00"), pb_decode(&s, IntegerArray_msg, &dest) TEST((s = S("\x0A\x00"), pb_decode(&s, IntegerArray_fields, &dest)
&& dest.data_count == 0)) && dest.data_count == 0))
TEST((s = S("\x0A\x01\x01"), pb_decode(&s, IntegerArray_msg, &dest) TEST((s = S("\x0A\x01\x01"), pb_decode(&s, IntegerArray_fields, &dest)
&& dest.data_count == 1 && dest.data[0] == 1)) && dest.data_count == 1 && dest.data[0] == 1))
TEST((s = S("\x0A\x0A\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A"), pb_decode(&s, IntegerArray_msg, &dest) TEST((s = S("\x0A\x0A\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A"), pb_decode(&s, IntegerArray_fields, &dest)
&& dest.data_count == 10 && dest.data[0] == 1 && dest.data[9] == 10)) && dest.data_count == 10 && dest.data[0] == 1 && dest.data[9] == 10))
TEST((s = S("\x0A\x0B\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B"), !pb_decode(&s, IntegerArray_msg, &dest))) TEST((s = S("\x0A\x0B\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B"), !pb_decode(&s, IntegerArray_fields, &dest)))
/* Test invalid wire data */ /* Test invalid wire data */
TEST((s = S("\x0A\xFF"), !pb_decode(&s, IntegerArray_msg, &dest))) TEST((s = S("\x0A\xFF"), !pb_decode(&s, IntegerArray_fields, &dest)))
TEST((s = S("\x0A\x01"), !pb_decode(&s, IntegerArray_msg, &dest))) TEST((s = S("\x0A\x01"), !pb_decode(&s, IntegerArray_fields, &dest)))
} }
{ {
@@ -225,14 +233,14 @@ int main()
IntegerArray dest; IntegerArray dest;
COMMENT("Testing pb_decode with unknown fields") COMMENT("Testing pb_decode with unknown fields")
TEST((s = S("\x18\x0F\x08\x01"), pb_decode(&s, IntegerArray_msg, &dest) TEST((s = S("\x18\x0F\x08\x01"), pb_decode(&s, IntegerArray_fields, &dest)
&& dest.data_count == 1 && dest.data[0] == 1)) && dest.data_count == 1 && dest.data[0] == 1))
TEST((s = S("\x19\x00\x00\x00\x00\x00\x00\x00\x00\x08\x01"), pb_decode(&s, IntegerArray_msg, &dest) TEST((s = S("\x19\x00\x00\x00\x00\x00\x00\x00\x00\x08\x01"), pb_decode(&s, IntegerArray_fields, &dest)
&& dest.data_count == 1 && dest.data[0] == 1)) && dest.data_count == 1 && dest.data[0] == 1))
TEST((s = S("\x1A\x00\x08\x01"), pb_decode(&s, IntegerArray_msg, &dest) TEST((s = S("\x1A\x00\x08\x01"), pb_decode(&s, IntegerArray_fields, &dest)
&& dest.data_count == 1 && dest.data[0] == 1)) && dest.data_count == 1 && dest.data[0] == 1))
TEST((s = S("\x1B\x08\x01"), !pb_decode(&s, IntegerArray_msg, &dest))) TEST((s = S("\x1B\x08\x01"), !pb_decode(&s, IntegerArray_fields, &dest)))
TEST((s = S("\x1D\x00\x00\x00\x00\x08\x01"), pb_decode(&s, IntegerArray_msg, &dest) TEST((s = S("\x1D\x00\x00\x00\x00\x08\x01"), pb_decode(&s, IntegerArray_fields, &dest)
&& dest.data_count == 1 && dest.data[0] == 1)) && dest.data_count == 1 && dest.data[0] == 1))
} }
@@ -246,25 +254,25 @@ int main()
COMMENT("Testing pb_decode with callbacks") COMMENT("Testing pb_decode with callbacks")
/* Single varint */ /* Single varint */
ref.size = 1; ref.bytes[0] = 0x55; ref.size = 1; ref.bytes[0] = 0x55;
TEST((s = S("\x08\x55"), pb_decode(&s, CallbackArray_msg, &dest))) TEST((s = S("\x08\x55"), pb_decode(&s, CallbackArray_fields, &dest)))
/* Packed varint */ /* Packed varint */
ref.size = 3; ref.bytes[0] = ref.bytes[1] = ref.bytes[2] = 0x55; ref.size = 3; ref.bytes[0] = ref.bytes[1] = ref.bytes[2] = 0x55;
TEST((s = S("\x0A\x03\x55\x55\x55"), pb_decode(&s, CallbackArray_msg, &dest))) TEST((s = S("\x0A\x03\x55\x55\x55"), pb_decode(&s, CallbackArray_fields, &dest)))
/* Packed varint with loop */ /* Packed varint with loop */
ref.size = 1; ref.bytes[0] = 0x55; ref.size = 1; ref.bytes[0] = 0x55;
TEST((s = S("\x0A\x03\x55\x55\x55"), pb_decode(&s, CallbackArray_msg, &dest))) TEST((s = S("\x0A\x03\x55\x55\x55"), pb_decode(&s, CallbackArray_fields, &dest)))
/* Single fixed32 */ /* Single fixed32 */
ref.size = 4; ref.bytes[0] = ref.bytes[1] = ref.bytes[2] = ref.bytes[3] = 0xAA; ref.size = 4; ref.bytes[0] = ref.bytes[1] = ref.bytes[2] = ref.bytes[3] = 0xAA;
TEST((s = S("\x0D\xAA\xAA\xAA\xAA"), pb_decode(&s, CallbackArray_msg, &dest))) TEST((s = S("\x0D\xAA\xAA\xAA\xAA"), pb_decode(&s, CallbackArray_fields, &dest)))
/* Single fixed64 */ /* Single fixed64 */
ref.size = 8; memset(ref.bytes, 0xAA, 8); ref.size = 8; memset(ref.bytes, 0xAA, 8);
TEST((s = S("\x09\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA"), pb_decode(&s, CallbackArray_msg, &dest))) TEST((s = S("\x09\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA"), pb_decode(&s, CallbackArray_fields, &dest)))
/* Unsupported field type */ /* Unsupported field type */
TEST((s = S("\x0B\x00"), !pb_decode(&s, CallbackArray_msg, &dest))) TEST((s = S("\x0B\x00"), !pb_decode(&s, CallbackArray_fields, &dest)))
/* Just make sure that our test function works */ /* Just make sure that our test function works */
ref.size = 1; ref.bytes[0] = 0x56; ref.size = 1; ref.bytes[0] = 0x56;
TEST((s = S("\x08\x55"), !pb_decode(&s, CallbackArray_msg, &dest))) TEST((s = S("\x08\x55"), !pb_decode(&s, CallbackArray_fields, &dest)))
} }
{ {
@@ -272,39 +280,11 @@ int main()
IntegerArray dest; IntegerArray dest;
COMMENT("Testing pb_decode message termination") COMMENT("Testing pb_decode message termination")
TEST((s = S(""), pb_decode(&s, IntegerArray_msg, &dest))) TEST((s = S(""), pb_decode(&s, IntegerArray_fields, &dest)))
TEST((s = S("\x00"), pb_decode(&s, IntegerArray_msg, &dest))) TEST((s = S("\x00"), pb_decode(&s, IntegerArray_fields, &dest)))
TEST((s = S("\x08\x01"), pb_decode(&s, IntegerArray_msg, &dest))) TEST((s = S("\x08\x01"), pb_decode(&s, IntegerArray_fields, &dest)))
TEST((s = S("\x08\x01\x00"), pb_decode(&s, IntegerArray_msg, &dest))) TEST((s = S("\x08\x01\x00"), pb_decode(&s, IntegerArray_fields, &dest)))
TEST((s = S("\x08"), !pb_decode(&s, IntegerArray_msg, &dest))) TEST((s = S("\x08"), !pb_decode(&s, IntegerArray_fields, &dest)))
}
{
pb_istream_t s;
PointerContainer dest;
COMMENT("Testing pb_decode with pointer fields")
memset(&dest, 0, sizeof(dest));
#ifdef MALLOC_HEADER
TEST((s = S("\x0A\x01\x61\x12\x01\x62\x1A\x00\x2A\x01\x65\x32\x01\x66"
"\x3A\x00\x42\x01\x63\x4A\x01\x64"),
pb_decode(&s, PointerContainer_msg, &dest)))
TEST(0 == strcmp(dest.text, "a"))
TEST(dest.blob.size == 1 && dest.blob.bytes[0] == 'b')
TEST(dest.submsg != NULL && dest.submsg->data == 10)
TEST(dest.rtext_count == 1 && (0 == strcmp(dest.rtext[0], "e")))
TEST(dest.rblob_count == 1 && dest.rblob[0].size == 1 &&
dest.rblob[0].bytes[0] == 'f')
TEST(dest.rsubmsg_count == 1)
TEST(0 == strcmp(dest.otext, "c"))
TEST(dest.oblob.size == 1 && dest.oblob.bytes[0] == 'd')
TEST(pb_clean(PointerContainer_msg, &dest));
#else
TEST((s = S("\x0A\x01\x61\x12\x01\x62\x2A\x01\x65\x32\x01\x66\x01\x66"
"\x3A\x00\x42\x01\x63\x4A\x01\x64"),
!pb_decode(&s, PointerContainer_msg, &dest)))
#endif
} }
if (status != 0) if (status != 0)

View File

@@ -1,7 +1,8 @@
#define NANOPB_INTERNALS
#include <stdio.h> #include <stdio.h>
#include <string.h> #include <string.h>
#include "pb_encode.h" #include "pb_encode.h"
#include "pb_encode_buffer.h"
#include "unittests.h" #include "unittests.h"
#include "unittestproto.pb.h" #include "unittestproto.pb.h"
@@ -24,14 +25,6 @@ bool fieldcallback(pb_ostream_t *stream, const pb_field_t *field, const void *ar
return pb_encode_varint(stream, value); return pb_encode_varint(stream, value);
} }
bool fieldcallback_buf(pb_strstream_t *stream, const pb_field_t *field, const void *arg)
{
int value = 0x55;
if (!pb_encbuf_varint(stream, value))
return false;
return pb_encbuf_tag_for_field(stream, field);
}
bool crazyfieldcallback(pb_ostream_t *stream, const pb_field_t *field, const void *arg) bool crazyfieldcallback(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
{ {
/* This callback writes different amount of data the second time. */ /* This callback writes different amount of data the second time. */
@@ -42,16 +35,6 @@ bool crazyfieldcallback(pb_ostream_t *stream, const pb_field_t *field, const voi
return pb_encode_varint(stream, *state); return pb_encode_varint(stream, *state);
} }
bool crazyfieldcallback_buf(pb_strstream_t *stream, const pb_field_t *field, const void *arg)
{
/* This callback writes different amount of data the second time. */
uint32_t *state = (uint32_t*)arg;
*state <<= 8;
if (!pb_encbuf_varint(stream, *state))
return false;
return pb_encbuf_tag_for_field(stream, field);
}
/* Check that expression x writes data y. /* Check that expression x writes data y.
* Y is a string, which may contain null bytes. Null terminator is ignored. * Y is a string, which may contain null bytes. Null terminator is ignored.
*/ */
@@ -62,20 +45,6 @@ s = pb_ostream_from_buffer(buffer, sizeof(buffer)), \
memcmp(buffer, y, sizeof(y) - 1) == 0 && \ memcmp(buffer, y, sizeof(y) - 1) == 0 && \
buffer[sizeof(y) - 1] == 0xAA buffer[sizeof(y) - 1] == 0xAA
/* Check that expression x writes data y into s2.
* Y is a string, which may contain null bytes. Null terminator is ignored.
*/
#define WRITES_BUF(x, y) \
memset(buffer, 0xAA, sizeof(buffer)), \
s2 = pb_strstream_from_buffer(buffer, sizeof(buffer)), \
(x) && \
memcmp(s2.last, y, sizeof(y) - 1) == 0 && \
s2.last - buffer == sizeof(buffer) - (sizeof(y) - 1)
/* Check that expression x and y write data z into s and s2, respectively.
*/
#define WRITES_BOTH(x, y, z) (WRITES(x, z)) && (WRITES_BUF(y, z))
int main() int main()
{ {
int status = 0; int status = 0;
@@ -105,81 +74,57 @@ int main()
{ {
uint8_t buffer[30]; uint8_t buffer[30];
pb_ostream_t s; pb_ostream_t s;
pb_strstream_t s2;
COMMENT("Test pb_encode_varint") COMMENT("Test pb_encode_varint")
TEST(WRITES_BOTH(pb_encode_varint(&s, 0), TEST(WRITES(pb_encode_varint(&s, 0), "\0"));
pb_encbuf_varint(&s2, 0), "\0")); TEST(WRITES(pb_encode_varint(&s, 1), "\1"));
TEST(WRITES_BOTH(pb_encode_varint(&s, 1), TEST(WRITES(pb_encode_varint(&s, 0x7F), "\x7F"));
pb_encbuf_varint(&s2, 1), "\1")); TEST(WRITES(pb_encode_varint(&s, 0x80), "\x80\x01"));
TEST(WRITES_BOTH(pb_encode_varint(&s, 0x7F), TEST(WRITES(pb_encode_varint(&s, UINT32_MAX), "\xFF\xFF\xFF\xFF\x0F"));
pb_encbuf_varint(&s2, 0x7F), "\x7F")); TEST(WRITES(pb_encode_varint(&s, UINT64_MAX), "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\x01"));
TEST(WRITES_BOTH(pb_encode_varint(&s, 0x80),
pb_encbuf_varint(&s2, 0x80), "\x80\x01"));
TEST(WRITES_BOTH(pb_encode_varint(&s, UINT32_MAX),
pb_encbuf_varint(&s2, UINT32_MAX),
"\xFF\xFF\xFF\xFF\x0F"));
TEST(WRITES_BOTH(pb_encode_varint(&s, UINT64_MAX),
pb_encbuf_varint(&s2, UINT64_MAX),
"\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\x01"));
} }
{ {
uint8_t buffer[30]; uint8_t buffer[30];
pb_ostream_t s; pb_ostream_t s;
pb_strstream_t s2;
COMMENT("Test pb_encode_tag") COMMENT("Test pb_encode_tag")
TEST(WRITES_BOTH(pb_encode_tag(&s, PB_WT_STRING, 5), TEST(WRITES(pb_encode_tag(&s, PB_WT_STRING, 5), "\x2A"));
pb_encbuf_tag(&s2, PB_WT_STRING, 5), "\x2A")); TEST(WRITES(pb_encode_tag(&s, PB_WT_VARINT, 99), "\x98\x06"));
TEST(WRITES_BOTH(pb_encode_tag(&s, PB_WT_VARINT, 99),
pb_encbuf_tag(&s2, PB_WT_VARINT, 99), "\x98\x06"));
} }
{ {
uint8_t buffer[30]; uint8_t buffer[30];
pb_ostream_t s; pb_ostream_t s;
pb_strstream_t s2;
pb_field_t field = {10, PB_LTYPE_SVARINT}; pb_field_t field = {10, PB_LTYPE_SVARINT};
COMMENT("Test pb_encode_tag_for_field") COMMENT("Test pb_encode_tag_for_field")
TEST(WRITES_BOTH(pb_encode_tag_for_field(&s, &field), TEST(WRITES(pb_encode_tag_for_field(&s, &field), "\x50"));
pb_encbuf_tag_for_field(&s2, &field), "\x50"));
field.type = PB_LTYPE_FIXED64; field.type = PB_LTYPE_FIXED64;
TEST(WRITES_BOTH(pb_encode_tag_for_field(&s, &field), TEST(WRITES(pb_encode_tag_for_field(&s, &field), "\x51"));
pb_encbuf_tag_for_field(&s2, &field), "\x51"));
field.type = PB_LTYPE_STRING; field.type = PB_LTYPE_STRING;
TEST(WRITES_BOTH(pb_encode_tag_for_field(&s, &field), TEST(WRITES(pb_encode_tag_for_field(&s, &field), "\x52"));
pb_encbuf_tag_for_field(&s2, &field), "\x52"));
field.type = PB_LTYPE_FIXED32; field.type = PB_LTYPE_FIXED32;
TEST(WRITES_BOTH(pb_encode_tag_for_field(&s, &field), TEST(WRITES(pb_encode_tag_for_field(&s, &field), "\x55"));
pb_encbuf_tag_for_field(&s2, &field), "\x55"));
} }
{ {
uint8_t buffer[30]; uint8_t buffer[30];
pb_ostream_t s; pb_ostream_t s;
pb_strstream_t s2;
COMMENT("Test pb_encode_string") COMMENT("Test pb_encode_string")
TEST(WRITES_BOTH(pb_encode_string(&s, (const uint8_t*)"abcd", 4), TEST(WRITES(pb_encode_string(&s, (const uint8_t*)"abcd", 4), "\x04""abcd"));
pb_encbuf_string(&s2, (const uint8_t*)"abcd", 4), TEST(WRITES(pb_encode_string(&s, (const uint8_t*)"abcd\x00", 5), "\x05""abcd\x00"));
"\x04""abcd")); TEST(WRITES(pb_encode_string(&s, (const uint8_t*)"", 0), "\x00"));
TEST(WRITES_BOTH(pb_encode_string(&s, (const uint8_t*)"abcd\x00", 5),
pb_encbuf_string(&s2, (const uint8_t*)"abcd\x00", 5),
"\x05""abcd\x00"));
TEST(WRITES_BOTH(pb_encode_string(&s, (const uint8_t*)"", 0),
pb_encbuf_string(&s2, (const uint8_t*)"", 0), "\x00"));
} }
{ {
uint8_t buffer[30]; uint8_t buffer[30];
pb_ostream_t s; pb_ostream_t s;
uint8_t value = 1; uint8_t value = 1;
int8_t svalue = -1;
int32_t max = INT32_MAX; int32_t max = INT32_MAX;
int32_t min = INT32_MIN; int32_t min = INT32_MIN;
int64_t lmax = INT64_MAX; int64_t lmax = INT64_MAX;
@@ -188,8 +133,6 @@ int main()
COMMENT("Test pb_enc_varint and pb_enc_svarint") COMMENT("Test pb_enc_varint and pb_enc_svarint")
TEST(WRITES(pb_enc_varint(&s, &field, &value), "\x01")); TEST(WRITES(pb_enc_varint(&s, &field, &value), "\x01"));
TEST(WRITES(pb_enc_svarint(&s, &field, &svalue), "\x01"));
TEST(WRITES(pb_enc_svarint(&s, &field, &value), "\x02"));
field.data_size = sizeof(max); field.data_size = sizeof(max);
TEST(WRITES(pb_enc_svarint(&s, &field, &max), "\xfe\xff\xff\xff\x0f")); TEST(WRITES(pb_enc_svarint(&s, &field, &max), "\xfe\xff\xff\xff\x0f"));
@@ -248,90 +191,71 @@ int main()
{ {
uint8_t buffer[10]; uint8_t buffer[10];
pb_ostream_t s; pb_ostream_t s;
pb_strstream_t s2; IntegerArray msg = {5, {1, 2, 3, 4, 5}};
IntegerArray msg = {{0}, 5, {1, 2, 3, 4, 5}};
COMMENT("Test pb_encode with int32 array") COMMENT("Test pb_encode with int32 array")
TEST(WRITES_BOTH(pb_encode(&s, IntegerArray_msg, &msg), TEST(WRITES(pb_encode(&s, IntegerArray_fields, &msg), "\x0A\x05\x01\x02\x03\x04\x05"))
pb_encode_buffer(&s2, IntegerArray_msg, &msg),
"\x0A\x05\x01\x02\x03\x04\x05"))
msg.data_count = 0; msg.data_count = 0;
TEST(WRITES_BOTH(pb_encode(&s, IntegerArray_msg, &msg), TEST(WRITES(pb_encode(&s, IntegerArray_fields, &msg), ""))
pb_encode_buffer(&s2, IntegerArray_msg, &msg), ""))
msg.data_count = 10; msg.data_count = 10;
TEST(!pb_encode(&s, IntegerArray_msg, &msg)) TEST(!pb_encode(&s, IntegerArray_fields, &msg))
TEST(!pb_encode_buffer(&s2, IntegerArray_msg, &msg))
} }
{ {
uint8_t buffer[10]; uint8_t buffer[10];
pb_ostream_t s; pb_ostream_t s;
pb_strstream_t s2; FloatArray msg = {1, {99.0f}};
FloatArray msg = {{0}, 1, {99.0f}};
COMMENT("Test pb_encode with float array") COMMENT("Test pb_encode with float array")
TEST(WRITES_BOTH(pb_encode(&s, FloatArray_msg, &msg), TEST(WRITES(pb_encode(&s, FloatArray_fields, &msg),
pb_encode_buffer(&s2, FloatArray_msg, &msg), "\x0A\x04\x00\x00\xc6\x42"))
"\x0A\x04\x00\x00\xc6\x42"))
msg.data_count = 0; msg.data_count = 0;
TEST(WRITES_BOTH(pb_encode(&s, FloatArray_msg, &msg), TEST(WRITES(pb_encode(&s, FloatArray_fields, &msg), ""))
pb_encode_buffer(&s2, FloatArray_msg, &msg), ""))
msg.data_count = 3; msg.data_count = 3;
TEST(!pb_encode(&s, FloatArray_msg, &msg)) TEST(!pb_encode(&s, FloatArray_fields, &msg))
TEST(!pb_encode_buffer(&s2, FloatArray_msg, &msg))
} }
{ {
uint8_t buffer[10]; uint8_t buffer[10];
pb_ostream_t s; pb_ostream_t s;
pb_strstream_t s2;
CallbackArray msg; CallbackArray msg;
COMMENT("Test pb_encode with callback field.")
msg.data.funcs.encode = &fieldcallback; msg.data.funcs.encode = &fieldcallback;
TEST(WRITES(pb_encode(&s, CallbackArray_msg, &msg), "\x08\x55"))
msg.data.funcs.encode_buffer = &fieldcallback_buf; COMMENT("Test pb_encode with callback field.")
TEST(WRITES_BUF(pb_encode_buffer(&s2, CallbackArray_msg, &msg), "\x08\x55")) TEST(WRITES(pb_encode(&s, CallbackArray_fields, &msg), "\x08\x55"))
} }
{ {
uint8_t buffer[10]; uint8_t buffer[10];
pb_ostream_t s; pb_ostream_t s;
pb_strstream_t s2; IntegerContainer msg = {{5, {1,2,3,4,5}}};
IntegerContainer msg = {{0}, {{0}, 5, {1,2,3,4,5}}};
COMMENT("Test pb_encode with packed array in a submessage.") COMMENT("Test pb_encode with packed array in a submessage.")
TEST(WRITES_BOTH(pb_encode(&s, IntegerContainer_msg, &msg), TEST(WRITES(pb_encode(&s, IntegerContainer_fields, &msg),
pb_encode_buffer(&s2, IntegerContainer_msg, &msg), "\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"))
"\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"))
} }
{ {
uint8_t buffer[10]; uint8_t buffer[10];
pb_ostream_t s; pb_ostream_t s;
pb_strstream_t s2;
CallbackContainer msg; CallbackContainer msg;
CallbackContainerContainer msg2; CallbackContainerContainer msg2;
uint32_t state = 1; uint32_t state = 1;
COMMENT("Test pb_encode with callback field in a submessage.")
msg.submsg.data.funcs.encode = &fieldcallback; msg.submsg.data.funcs.encode = &fieldcallback;
msg2.submsg.submsg.data.funcs.encode = &fieldcallback; msg2.submsg.submsg.data.funcs.encode = &fieldcallback;
TEST(WRITES(pb_encode(&s, CallbackContainer_msg, &msg), "\x0A\x02\x08\x55"))
TEST(WRITES(pb_encode(&s, CallbackContainerContainer_msg, &msg2),
"\x0A\x04\x0A\x02\x08\x55"))
msg.submsg.data.funcs.encode_buffer = &fieldcallback_buf; COMMENT("Test pb_encode with callback field in a submessage.")
msg2.submsg.submsg.data.funcs.encode_buffer = &fieldcallback_buf; TEST(WRITES(pb_encode(&s, CallbackContainer_fields, &msg), "\x0A\x02\x08\x55"))
TEST(WRITES_BUF(pb_encode_buffer(&s2, CallbackContainer_msg, &msg), "\x0A\x02\x08\x55")) TEST(WRITES(pb_encode(&s, CallbackContainerContainer_fields, &msg2),
TEST(WRITES_BUF(pb_encode_buffer(&s2, CallbackContainerContainer_msg, &msg2), "\x0A\x04\x0A\x02\x08\x55"))
"\x0A\x04\x0A\x02\x08\x55"))
/* Misbehaving callback: varying output between calls */ /* Misbehaving callback: varying output between calls */
msg.submsg.data.funcs.encode = &crazyfieldcallback; msg.submsg.data.funcs.encode = &crazyfieldcallback;
@@ -339,63 +263,9 @@ int main()
msg2.submsg.submsg.data.funcs.encode = &crazyfieldcallback; msg2.submsg.submsg.data.funcs.encode = &crazyfieldcallback;
msg2.submsg.submsg.data.arg = &state; msg2.submsg.submsg.data.arg = &state;
TEST(!pb_encode(&s, CallbackContainer_msg, &msg)) TEST(!pb_encode(&s, CallbackContainer_fields, &msg))
state = 1; state = 1;
TEST(!pb_encode(&s, CallbackContainerContainer_msg, &msg2)) TEST(!pb_encode(&s, CallbackContainerContainer_fields, &msg2))
msg.submsg.data.funcs.encode_buffer = &crazyfieldcallback_buf;
msg.submsg.data.arg = &state;
msg2.submsg.submsg.data.funcs.encode_buffer = &crazyfieldcallback_buf;
msg2.submsg.submsg.data.arg = &state;
TEST(!pb_encode_buffer(&s2, CallbackContainer_msg, &msg))
state = 1;
TEST(!pb_encode_buffer(&s2, CallbackContainerContainer_msg, &msg2))
}
{
uint8_t buffer[30];
pb_ostream_t s;
pb_strstream_t s2;
PointerContainer msg;
DefaultContainer msg2;
IntegerArray msg3;
COMMENT("Test pb_encode with pointer fields.")
memset(&msg, 0, sizeof(msg));
memset(&msg2, 0, sizeof(msg2));
msg.text = "a";
msg.blob.size = 1;
msg.blob.bytes = (uint8_t*)"b";
msg.submsg = &msg2;
TEST(WRITES_BOTH(pb_encode(&s, PointerContainer_msg, &msg),
pb_encode_buffer(&s2, PointerContainer_msg, &msg),
"\x0A\x01\x61\x12\x01\x62\x1A\x00"))
memset(&msg3, 0, sizeof(msg3));
msg.rtext_count = 1;
msg.rtext[0] = "e";
msg.rblob_count = 1;
msg.rblob[0].size = 1;
msg.rblob[0].bytes = (uint8_t*)"f";
msg.rsubmsg_count = 1;
msg.rsubmsg[0] = &msg3;
TEST(WRITES_BOTH(pb_encode(&s, PointerContainer_msg, &msg),
pb_encode_buffer(&s2, PointerContainer_msg, &msg),
"\x0A\x01\x61\x12\x01\x62\x1A\x00"
"\x2A\x01\x65\x32\x01\x66\x3A\x00"));
PointerContainer_set(msg, otext);
msg.otext = "c";
PointerContainer_set(msg, oblob);
msg.oblob.size = 1;
msg.oblob.bytes = (uint8_t*)"d";
TEST(WRITES_BOTH(pb_encode(&s, PointerContainer_msg, &msg),
pb_encode_buffer(&s2, PointerContainer_msg, &msg),
"\x0A\x01\x61\x12\x01\x62\x1A\x00"
"\x2A\x01\x65\x32\x01\x66\x3A\x00"
"\x42\x01\x63\x4A\x01\x64"));
} }
if (status != 0) if (status != 0)

View File

@@ -17,7 +17,7 @@ bool print_person(pb_istream_t *stream)
int i; int i;
Person person; Person person;
if (!pb_decode(stream, Person_msg, &person)) if (!pb_decode(stream, Person_fields, &person))
return false; return false;
/* Now the decoding is done, rest is just to print stuff out. */ /* Now the decoding is done, rest is just to print stuff out. */
@@ -25,7 +25,7 @@ bool print_person(pb_istream_t *stream)
printf("name: \"%s\"\n", person.name); printf("name: \"%s\"\n", person.name);
printf("id: %ld\n", (long)person.id); printf("id: %ld\n", (long)person.id);
if (Person_has(person, email)) if (person.has_email)
printf("email: \"%s\"\n", person.email); printf("email: \"%s\"\n", person.email);
for (i = 0; i < person.phone_count; i++) for (i = 0; i < person.phone_count; i++)
@@ -34,7 +34,7 @@ bool print_person(pb_istream_t *stream)
printf("phone {\n"); printf("phone {\n");
printf(" number: \"%s\"\n", phone->number); printf(" number: \"%s\"\n", phone->number);
if (Person_PhoneNumber_has(*phone, type)) if (phone->has_type)
{ {
switch (phone->type) switch (phone->type)
{ {

View File

@@ -13,7 +13,7 @@ bool print_person(pb_istream_t *stream)
int i; int i;
Person person; Person person;
if (!pb_decode(stream, Person_msg, &person)) if (!pb_decode(stream, Person_fields, &person))
return false; return false;
/* Now the decoding is done, rest is just to print stuff out. */ /* Now the decoding is done, rest is just to print stuff out. */
@@ -21,7 +21,7 @@ bool print_person(pb_istream_t *stream)
printf("name: \"%s\"\n", person.name); printf("name: \"%s\"\n", person.name);
printf("id: %ld\n", (long)person.id); printf("id: %ld\n", (long)person.id);
if (Person_has(person, email)) if (person.has_email)
printf("email: \"%s\"\n", person.email); printf("email: \"%s\"\n", person.email);
for (i = 0; i < person.phone_count; i++) for (i = 0; i < person.phone_count; i++)
@@ -30,7 +30,7 @@ bool print_person(pb_istream_t *stream)
printf("phone {\n"); printf("phone {\n");
printf(" number: \"%s\"\n", phone->number); printf(" number: \"%s\"\n", phone->number);
if (Person_PhoneNumber_has(*phone, type)) if (phone->has_type)
{ {
switch (phone->type) switch (phone->type)
{ {

70
tests/test_decode3.c Normal file
View File

@@ -0,0 +1,70 @@
/* Tests the decoding of all types. Currently only in the 'required' variety.
* This is the counterpart of test_encode3.
* Run e.g. ./test_encode3 | ./test_decode3
*/
#include <stdio.h>
#include <string.h>
#include <pb_decode.h>
#include "alltypes.pb.h"
#define TEST(x) if (!(x)) { \
printf("Test " #x " failed.\n"); \
return false; \
}
/* This function is called once from main(), it handles
the decoding and checks the fields. */
bool check_alltypes(pb_istream_t *stream)
{
AllTypes alltypes = {};
if (!pb_decode(stream, AllTypes_fields, &alltypes))
return false;
TEST(alltypes.req_int32 == 1001);
TEST(alltypes.req_int64 == 1002);
TEST(alltypes.req_uint32 == 1003);
TEST(alltypes.req_uint64 == 1004);
TEST(alltypes.req_sint32 == 1005);
TEST(alltypes.req_sint64 == 1006);
TEST(alltypes.req_bool == true);
TEST(alltypes.req_fixed32 == 1008);
TEST(alltypes.req_sfixed32 == 1009);
TEST(alltypes.req_float == 1010.0f);
TEST(alltypes.req_fixed64 == 1011);
TEST(alltypes.req_sfixed64 == 1012);
TEST(alltypes.req_double == 1013.0f);
TEST(strcmp(alltypes.req_string, "1014") == 0);
TEST(alltypes.req_bytes.size == 4);
TEST(memcmp(alltypes.req_bytes.bytes, "1015", 4) == 0);
TEST(strcmp(alltypes.req_submsg.substuff1, "1016") == 0);
TEST(alltypes.req_submsg.substuff2 == 1016);
TEST(alltypes.req_enum == MyEnum_Truth);
TEST(alltypes.end == 1099);
return true;
}
int main()
{
/* Read the data into buffer */
uint8_t buffer[512];
size_t count = fread(buffer, 1, sizeof(buffer), stdin);
/* Construct a pb_istream_t for reading from the buffer */
pb_istream_t stream = pb_istream_from_buffer(buffer, count);
/* Decode and print out the stuff */
if (!check_alltypes(&stream))
{
printf("Parsing failed.\n");
return 1;
} else {
return 0;
}
}

View File

@@ -84,7 +84,7 @@ int main()
testmessage.fixed64value.funcs.decode = &print_fixed64; testmessage.fixed64value.funcs.decode = &print_fixed64;
testmessage.fixed64value.arg = "fixed64value: %lld\n"; testmessage.fixed64value.arg = "fixed64value: %lld\n";
if (!pb_decode(&stream, TestMessage_msg, &testmessage)) if (!pb_decode(&stream, TestMessage_fields, &testmessage))
return 1; return 1;
return 0; return 0;

View File

@@ -10,21 +10,17 @@
int main() int main()
{ {
/* Initialize the structure with constants */ /* Initialize the structure with constants */
Person person = {{1 << Person_email_index}, Person person = {"Test Person 99", 99, true, "test@person.com",
"Test Person 99", 99, "test@person.com", 3, {{"555-12345678", true, Person_PhoneType_MOBILE},
3, {{{1 << Person_PhoneNumber_type_index}, {"99-2342", false, 0},
"555-12345678", Person_PhoneType_MOBILE}, {"1234-5678", true, Person_PhoneType_WORK},
{{1 << Person_PhoneNumber_type_index},
"99-2342", 0},
{{1 << Person_PhoneNumber_type_index},
"1234-5678", Person_PhoneType_WORK},
}}; }};
uint8_t buffer[512]; uint8_t buffer[512];
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer)); pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
/* Now encode it and check if we succeeded. */ /* Now encode it and check if we succeeded. */
if (pb_encode(&stream, Person_msg, &person)) if (pb_encode(&stream, Person_fields, &person))
{ {
fwrite(buffer, 1, stream.bytes_written, stdout); fwrite(buffer, 1, stream.bytes_written, stdout);
return 0; /* Success */ return 0; /* Success */

View File

@@ -15,21 +15,17 @@ bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
int main() int main()
{ {
/* Initialize the structure with constants */ /* Initialize the structure with constants */
Person person = {{1 << Person_email_index}, Person person = {"Test Person 99", 99, true, "test@person.com",
"Test Person 99", 99, "test@person.com", 3, {{"555-12345678", true, Person_PhoneType_MOBILE},
3, {{{1 << Person_PhoneNumber_type_index}, {"99-2342", false, 0},
"555-12345678", Person_PhoneType_MOBILE}, {"1234-5678", true, Person_PhoneType_WORK},
{{1 << Person_PhoneNumber_type_index},
"99-2342", 0},
{{1 << Person_PhoneNumber_type_index},
"1234-5678", Person_PhoneType_WORK},
}}; }};
/* Prepare the stream, output goes directly to stdout */ /* 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};
/* Now encode it and check if we succeeded. */ /* Now encode it and check if we succeeded. */
if (pb_encode(&stream, Person_msg, &person)) if (pb_encode(&stream, Person_fields, &person))
return 0; /* Success */ return 0; /* Success */
else else
return 1; /* Failure */ return 1; /* Failure */

50
tests/test_encode3.c Normal file
View File

@@ -0,0 +1,50 @@
/* Attempts to test all the datatypes supported by ProtoBuf.
* Currently only tests the 'required' variety.
*/
#include <stdio.h>
#include <pb_encode.h>
#include "alltypes.pb.h"
int main()
{
/* Initialize the structure with constants */
AllTypes alltypes = {
1001,
1002,
1003,
1004,
1005,
1006,
true,
1008,
1009,
1010.0f,
1011,
1012,
1013.0,
"1014",
{4, "1015"},
{"1016", 1016},
MyEnum_Truth,
1099
};
uint8_t buffer[512];
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
/* Now encode it and check if we succeeded. */
if (pb_encode(&stream, AllTypes_fields, &alltypes))
{
fwrite(buffer, 1, stream.bytes_written, stdout);
return 0; /* Success */
}
else
{
return 1; /* Failure */
}
}

View File

@@ -29,7 +29,7 @@ bool encode_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *a
return false; return false;
uint32_t value = 42; uint32_t value = 42;
return pb_enc_fixed32(stream, field, &value); return pb_encode_fixed32(stream, &value);
} }
bool encode_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *arg) bool encode_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
@@ -38,7 +38,7 @@ bool encode_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *a
return false; return false;
uint64_t value = 42; uint64_t value = 42;
return pb_enc_fixed64(stream, field, &value); return pb_encode_fixed64(stream, &value);
} }
int main() int main()
@@ -52,13 +52,13 @@ int main()
testmessage.fixed32value.funcs.encode = &encode_fixed32; testmessage.fixed32value.funcs.encode = &encode_fixed32;
testmessage.fixed64value.funcs.encode = &encode_fixed64; testmessage.fixed64value.funcs.encode = &encode_fixed64;
TestMessage_set(testmessage, submsg); testmessage.has_submsg = true;
testmessage.submsg.stringvalue.funcs.encode = &encode_string; testmessage.submsg.stringvalue.funcs.encode = &encode_string;
testmessage.submsg.int32value.funcs.encode = &encode_int32; testmessage.submsg.int32value.funcs.encode = &encode_int32;
testmessage.submsg.fixed32value.funcs.encode = &encode_fixed32; testmessage.submsg.fixed32value.funcs.encode = &encode_fixed32;
testmessage.submsg.fixed64value.funcs.encode = &encode_fixed64; testmessage.submsg.fixed64value.funcs.encode = &encode_fixed64;
if (!pb_encode(&stream, TestMessage_msg, &testmessage)) if (!pb_encode(&stream, TestMessage_fields, &testmessage))
return 1; return 1;
if (fwrite(buffer, stream.bytes_written, 1, stdout) != 1) if (fwrite(buffer, stream.bytes_written, 1, stdout) != 1)

View File

@@ -26,28 +26,3 @@ message CallbackContainer {
message CallbackContainerContainer { message CallbackContainerContainer {
required CallbackContainer submsg = 1; required CallbackContainer submsg = 1;
} }
message DefaultContainer {
optional int32 data = 1 [default = 10];
}
message PointerContainer {
required string text = 1 [(nanopb).pointer = true];
required bytes blob = 2 [(nanopb).pointer = true];
required DefaultContainer submsg = 3 [(nanopb).pointer = true];
// This should be rejected:
// required int32 data = 4 [(nanopb).pointer = true];
repeated string rtext = 5 [(nanopb).pointer = true, (nanopb).max_count = 10];
repeated bytes rblob = 6 [(nanopb).pointer = true, (nanopb).max_count = 10];
repeated IntegerArray rsubmsg = 7 [(nanopb).pointer = true, (nanopb).max_count = 10];
optional string otext = 8 [(nanopb).pointer = true];
optional bytes oblob = 9 [(nanopb).pointer = true];
}
message RecursiveRef_A {
optional RecursiveRef_B submsg = 1 [(nanopb).pointer = true];
}
message RecursiveRef_B {
required RecursiveRef_A submsg = 1;
}