Compare commits
59 Commits
nanopb-0.2
...
dev_tests_
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9f93d39f72 | ||
|
|
d395768c8d | ||
|
|
b9f14bddf7 | ||
|
|
e2e9980627 | ||
|
|
0bbcb7b367 | ||
|
|
696a01bf14 | ||
|
|
f04ab838ab | ||
|
|
e681dd0d75 | ||
|
|
4dccf28ba9 | ||
|
|
262c62676c | ||
|
|
d7f3a74388 | ||
|
|
4aef194a99 | ||
|
|
81cf30034b | ||
|
|
dd72698508 | ||
|
|
f15093e8bd | ||
|
|
b663909fb6 | ||
|
|
ba40cacd3c | ||
|
|
1f13e8cd2c | ||
|
|
64947cb382 | ||
|
|
0343e2bcfe | ||
|
|
ebddda9b5c | ||
|
|
7c5e184c26 | ||
|
|
f064c2c48a | ||
|
|
3c10e6fa71 | ||
|
|
a01856f4ab | ||
|
|
bb985e9927 | ||
|
|
314460c2a5 | ||
|
|
0ed3158560 | ||
|
|
4b705bf64b | ||
|
|
6e9e532927 | ||
|
|
68dd0171bc | ||
|
|
a1cec46b3e | ||
|
|
bfd7cb36b9 | ||
|
|
ef741ea530 | ||
|
|
26b52b79ad | ||
|
|
d2063ff0b6 | ||
|
|
9939910833 | ||
|
|
6a02298584 | ||
|
|
a968233777 | ||
|
|
710465a8e0 | ||
|
|
384e686fe6 | ||
|
|
214b0eae8a | ||
|
|
6f3740f74e | ||
|
|
1396dce2ae | ||
|
|
6468f23d23 | ||
|
|
03e5393072 | ||
|
|
d580b225e8 | ||
|
|
0352647118 | ||
|
|
9b6641ac64 | ||
|
|
5f3bf35e01 | ||
|
|
6f8dbc73eb | ||
|
|
e1b8a555f3 | ||
|
|
60109c0be1 | ||
|
|
96d4016838 | ||
|
|
a9c88f5570 | ||
|
|
d2e3c1ad93 | ||
|
|
5522e02133 | ||
|
|
64bf72d73d | ||
|
|
104710b26c |
20
.gitignore
vendored
20
.gitignore
vendored
@@ -7,6 +7,7 @@
|
|||||||
*.pb
|
*.pb
|
||||||
*~
|
*~
|
||||||
*.tar.gz
|
*.tar.gz
|
||||||
|
.sconsign.dblite
|
||||||
julkaisu.txt
|
julkaisu.txt
|
||||||
docs/*.html
|
docs/*.html
|
||||||
docs/generator_flow.png
|
docs/generator_flow.png
|
||||||
@@ -18,22 +19,3 @@ example_avr_double/test_conversions
|
|||||||
example_unions/decode
|
example_unions/decode
|
||||||
example_unions/encode
|
example_unions/encode
|
||||||
generator/nanopb_pb2.pyc
|
generator/nanopb_pb2.pyc
|
||||||
tests/decode_unittests
|
|
||||||
tests/encode_unittests
|
|
||||||
tests/test_compiles
|
|
||||||
tests/test_decode1
|
|
||||||
tests/test_decode2
|
|
||||||
tests/test_decode3
|
|
||||||
tests/test_decode3_buf
|
|
||||||
tests/test_decode_callbacks
|
|
||||||
tests/test_encode1
|
|
||||||
tests/test_encode2
|
|
||||||
tests/test_encode3
|
|
||||||
tests/test_encode3_buf
|
|
||||||
tests/test_encode_callbacks
|
|
||||||
tests/test_missing_fields
|
|
||||||
tests/test_multiple_files
|
|
||||||
tests/bc_decode
|
|
||||||
tests/bc_encode
|
|
||||||
tests/breakpoints
|
|
||||||
|
|
||||||
|
|||||||
26
CHANGELOG
26
CHANGELOG
@@ -1,3 +1,29 @@
|
|||||||
|
nanopb-0.2.2
|
||||||
|
Add support for extension fields (issue 17)
|
||||||
|
Fix unknown fields in empty message (issue 78)
|
||||||
|
Include the field tags in the generated .pb.h file.
|
||||||
|
Add pb_decode_delimited and pb_encode_delimited wrapper functions (issue 74)
|
||||||
|
Add a section in top of pb.h for changing compilation settings (issue 76)
|
||||||
|
Documentation improvements (issues 12, 77 and others)
|
||||||
|
Improved tests
|
||||||
|
|
||||||
|
nanopb-0.2.1
|
||||||
|
NOTE: The default callback function signature has changed.
|
||||||
|
If you don't want to update your code, define PB_OLD_CALLBACK_STYLE.
|
||||||
|
|
||||||
|
Change the callback function to use void** (issue 69)
|
||||||
|
Add support for defining the nanopb options in a separate file (issue 12)
|
||||||
|
Add support for packed structs in IAR and MSVC (in addition to GCC) (issue 66)
|
||||||
|
Implement error message support for the encoder side (issue 7)
|
||||||
|
Handle unterminated strings when encoding (issue 68)
|
||||||
|
Fix bug with empty strings in repeated string callbacks (issue 73)
|
||||||
|
Fix regression in 0.2.0 with optional callback fields (issue 70)
|
||||||
|
Fix bugs with empty message types (issues 64, 65)
|
||||||
|
Fix some compiler warnings on clang (issue 67)
|
||||||
|
Some portability improvements (issues 60, 62)
|
||||||
|
Various new generator options
|
||||||
|
Improved tests
|
||||||
|
|
||||||
nanopb-0.2.0
|
nanopb-0.2.0
|
||||||
NOTE: This release requires you to regenerate all .pb.c
|
NOTE: This release requires you to regenerate all .pb.c
|
||||||
files. Files generated by older versions will not
|
files. Files generated by older versions will not
|
||||||
|
|||||||
94
compat/pb_syshdr.h
Normal file
94
compat/pb_syshdr.h
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
/* This is an example of a header file for platforms/compilers that do
|
||||||
|
* not come with stdint.h/stddef.h/stdbool.h/string.h. To use it, define
|
||||||
|
* PB_SYSTEM_HEADER as "pb_syshdr.h", including the quotes, and add the
|
||||||
|
* compat folder to your include path.
|
||||||
|
*
|
||||||
|
* It is very likely that you will need to customize this file to suit
|
||||||
|
* your platform. For any compiler that supports C99, this file should
|
||||||
|
* not be necessary.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef _PB_SYSHDR_H_
|
||||||
|
#define _PB_SYSHDR_H_
|
||||||
|
|
||||||
|
/* stdint.h subset */
|
||||||
|
#ifdef HAVE_STDINT_H
|
||||||
|
#include <stdint.h>
|
||||||
|
#else
|
||||||
|
/* You will need to modify these to match the word size of your platform. */
|
||||||
|
typedef signed char int8_t;
|
||||||
|
typedef unsigned char uint8_t;
|
||||||
|
typedef signed short int16_t;
|
||||||
|
typedef unsigned short uint16_t;
|
||||||
|
typedef signed int int32_t;
|
||||||
|
typedef unsigned int uint32_t;
|
||||||
|
typedef signed long long int64_t;
|
||||||
|
typedef unsigned long long uint64_t;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* stddef.h subset */
|
||||||
|
#ifdef HAVE_STDDEF_H
|
||||||
|
#include <stddef.h>
|
||||||
|
#else
|
||||||
|
|
||||||
|
typedef uint32_t size_t;
|
||||||
|
#define offsetof(st, m) ((size_t)(&((st *)0)->m))
|
||||||
|
|
||||||
|
#ifndef NULL
|
||||||
|
#define NULL 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* stdbool.h subset */
|
||||||
|
#ifdef HAVE_STDBOOL_H
|
||||||
|
#include <stdbool.h>
|
||||||
|
#else
|
||||||
|
|
||||||
|
#ifndef __cplusplus
|
||||||
|
typedef int bool;
|
||||||
|
#define false 0
|
||||||
|
#define true 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* string.h subset */
|
||||||
|
#ifdef HAVE_STRING_H
|
||||||
|
#include <string.h>
|
||||||
|
#else
|
||||||
|
|
||||||
|
/* Implementations are from the Public Domain C Library (PDCLib). */
|
||||||
|
static size_t strlen( const char * s )
|
||||||
|
{
|
||||||
|
size_t rc = 0;
|
||||||
|
while ( s[rc] )
|
||||||
|
{
|
||||||
|
++rc;
|
||||||
|
}
|
||||||
|
return rc;
|
||||||
|
}
|
||||||
|
|
||||||
|
static void * memcpy( void *s1, const void *s2, size_t n )
|
||||||
|
{
|
||||||
|
char * dest = (char *) s1;
|
||||||
|
const char * src = (const char *) s2;
|
||||||
|
while ( n-- )
|
||||||
|
{
|
||||||
|
*dest++ = *src++;
|
||||||
|
}
|
||||||
|
return s1;
|
||||||
|
}
|
||||||
|
|
||||||
|
static void * memset( void * s, int c, size_t n )
|
||||||
|
{
|
||||||
|
unsigned char * p = (unsigned char *) s;
|
||||||
|
while ( n-- )
|
||||||
|
{
|
||||||
|
*p++ = (unsigned char) c;
|
||||||
|
}
|
||||||
|
return s;
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif
|
||||||
@@ -10,47 +10,40 @@ The things outlined here are the underlying concepts of the nanopb design.
|
|||||||
|
|
||||||
Proto files
|
Proto files
|
||||||
===========
|
===========
|
||||||
All Protocol Buffers implementations use .proto files to describe the message format.
|
All Protocol Buffers implementations use .proto files to describe the message
|
||||||
The point of these files is to be a portable interface description language.
|
format. The point of these files is to be a portable interface description
|
||||||
|
language.
|
||||||
|
|
||||||
Compiling .proto files for nanopb
|
Compiling .proto files for nanopb
|
||||||
---------------------------------
|
---------------------------------
|
||||||
Nanopb uses the Google's protoc compiler to parse the .proto file, and then a python script to generate the C header and source code from it::
|
Nanopb uses the Google's protoc compiler to parse the .proto file, and then a
|
||||||
|
python script to generate the C header and source code from it::
|
||||||
|
|
||||||
user@host:~$ protoc -omessage.pb message.proto
|
user@host:~$ protoc -omessage.pb message.proto
|
||||||
user@host:~$ python ../generator/nanopb_generator.py message.pb
|
user@host:~$ python ../generator/nanopb_generator.py message.pb
|
||||||
Writing to message.h and message.c
|
Writing to message.h and message.c
|
||||||
user@host:~$
|
user@host:~$
|
||||||
|
|
||||||
Compiling .proto files with nanopb options
|
Modifying generator behaviour
|
||||||
------------------------------------------
|
-----------------------------
|
||||||
Nanopb defines two extensions for message fields described in .proto files: *max_size* and *max_count*.
|
Using generator options, you can set maximum sizes for fields in order to
|
||||||
These are the maximum size of a string and maximum count of items in an array::
|
allocate them statically. The preferred way to do this is to create an .options
|
||||||
|
file with the same name as your .proto file::
|
||||||
|
|
||||||
required string name = 1 [(nanopb).max_size = 40];
|
# Foo.proto
|
||||||
repeated PhoneNumber phone = 4 [(nanopb).max_count = 5];
|
message Foo {
|
||||||
|
required string name = 1;
|
||||||
|
}
|
||||||
|
|
||||||
To use these extensions, you need to place an import statement in the beginning of the file::
|
::
|
||||||
|
|
||||||
import "nanopb.proto";
|
# Foo.options
|
||||||
|
Foo.name max_size:16
|
||||||
|
|
||||||
This file, in turn, requires the file *google/protobuf/descriptor.proto*. This is usually installed under */usr/include*. Therefore, to compile a .proto file which uses options, use a protoc command similar to::
|
For more information on this, see the `Proto file options`_ section in the
|
||||||
|
reference manual.
|
||||||
protoc -I/usr/include -Inanopb/generator -I. -omessage.pb message.proto
|
|
||||||
|
|
||||||
The options can be defined in file, message and field scopes::
|
|
||||||
|
|
||||||
option (nanopb_fileopt).max_size = 20; // File scope
|
|
||||||
message Message
|
|
||||||
{
|
|
||||||
option (nanopb_msgopt).max_size = 30; // Message scope
|
|
||||||
required string fieldsize = 1 [(nanopb).max_size = 40]; // Field scope
|
|
||||||
}
|
|
||||||
|
|
||||||
It is also possible to give the options on command line, but then they will affect the whole file. For example::
|
|
||||||
|
|
||||||
user@host:~$ python ../generator/nanopb_generator.py -s 'max_size: 20' message.pb
|
|
||||||
|
|
||||||
|
.. _`Proto file options`: reference.html#proto-file-options
|
||||||
|
|
||||||
Streams
|
Streams
|
||||||
=======
|
=======
|
||||||
@@ -181,7 +174,9 @@ Field callbacks
|
|||||||
===============
|
===============
|
||||||
When a field has dynamic length, nanopb cannot statically allocate storage for it. Instead, it allows you to handle the field in whatever way you want, using a callback function.
|
When a field has dynamic length, nanopb cannot statically allocate storage for it. Instead, it allows you to handle the field in whatever way you want, using a callback function.
|
||||||
|
|
||||||
The `pb_callback_t`_ structure contains a function pointer and a *void* pointer you can use for passing data to the callback. If the function pointer is NULL, the field will be skipped. The actual behavior of the callback function is different in encoding and decoding modes.
|
The `pb_callback_t`_ structure contains a function pointer and a *void* pointer called *arg* you can use for passing data to the callback. If the function pointer is NULL, the field will be skipped. A pointer to the *arg* is passed to the function, so that it can modify it and retrieve the value.
|
||||||
|
|
||||||
|
The actual behavior of the callback function is different in encoding and decoding modes. In encoding mode, the callback is called once and should write out everything, including field tags. In decoding mode, the callback is called repeatedly for every data item.
|
||||||
|
|
||||||
.. _`pb_callback_t`: reference.html#pb-callback-t
|
.. _`pb_callback_t`: reference.html#pb-callback-t
|
||||||
|
|
||||||
@@ -189,7 +184,7 @@ 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, void * const *arg);
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
@@ -203,7 +198,7 @@ If the callback is used in a submessage, it will be called multiple times during
|
|||||||
|
|
||||||
This callback writes out a dynamically sized string::
|
This callback writes out a dynamically sized string::
|
||||||
|
|
||||||
bool write_string(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
|
bool write_string(pb_ostream_t *stream, const pb_field_t *field, void * const *arg)
|
||||||
{
|
{
|
||||||
char *str = get_string_from_somewhere();
|
char *str = get_string_from_somewhere();
|
||||||
if (!pb_encode_tag_for_field(stream, field))
|
if (!pb_encode_tag_for_field(stream, field))
|
||||||
@@ -216,7 +211,7 @@ Decoding callbacks
|
|||||||
------------------
|
------------------
|
||||||
::
|
::
|
||||||
|
|
||||||
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);
|
||||||
|
|
||||||
When decoding, the callback receives a length-limited substring that reads the contents of a single field. The field tag has already been read. For *string* and *bytes*, the length value has already been parsed, and is available at *stream->bytes_left*.
|
When decoding, the callback receives a length-limited substring that reads the contents of a single field. The field tag has already been read. For *string* and *bytes*, the length value has already been parsed, and is available at *stream->bytes_left*.
|
||||||
|
|
||||||
@@ -226,7 +221,7 @@ The callback will be called multiple times for repeated fields. For packed field
|
|||||||
|
|
||||||
This callback reads multiple integers and prints them::
|
This callback reads multiple integers and prints them::
|
||||||
|
|
||||||
bool read_ints(pb_istream_t *stream, const pb_field_t *field, void *arg)
|
bool read_ints(pb_istream_t *stream, const pb_field_t *field, void **arg)
|
||||||
{
|
{
|
||||||
while (stream->bytes_left)
|
while (stream->bytes_left)
|
||||||
{
|
{
|
||||||
@@ -261,6 +256,50 @@ generates this field description array for the structure *Person_PhoneNumber*::
|
|||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
|
Extension fields
|
||||||
|
================
|
||||||
|
Protocol Buffers supports a concept of `extension fields`_, which are
|
||||||
|
additional fields to a message, but defined outside the actual message.
|
||||||
|
The definition can even be in a completely separate .proto file.
|
||||||
|
|
||||||
|
The base message is declared as extensible by keyword *extensions* in
|
||||||
|
the .proto file::
|
||||||
|
|
||||||
|
message MyMessage {
|
||||||
|
.. fields ..
|
||||||
|
extensions 100 to 199;
|
||||||
|
}
|
||||||
|
|
||||||
|
For each extensible message, *nanopb_generator.py* declares an additional
|
||||||
|
callback field called *extensions*. The field and associated datatype
|
||||||
|
*pb_extension_t* forms a linked list of handlers. When an unknown field is
|
||||||
|
encountered, the decoder calls each handler in turn until either one of them
|
||||||
|
handles the field, or the list is exhausted.
|
||||||
|
|
||||||
|
The actual extensions are declared using the *extend* keyword in the .proto,
|
||||||
|
and are in the global namespace::
|
||||||
|
|
||||||
|
extend MyMessage {
|
||||||
|
optional int32 myextension = 100;
|
||||||
|
}
|
||||||
|
|
||||||
|
For each extension, *nanopb_generator.py* creates a constant of type
|
||||||
|
*pb_extension_type_t*. To link together the base message and the extension,
|
||||||
|
you have to:
|
||||||
|
|
||||||
|
1. Allocate storage for your field, matching the datatype in the .proto.
|
||||||
|
For example, for a *int32* field, you need a *int32_t* variable to store
|
||||||
|
the value.
|
||||||
|
2. Create a *pb_extension_t* constant, with pointers to your variable and
|
||||||
|
to the generated *pb_extension_type_t*.
|
||||||
|
3. Set the *message.extensions* pointer to point to the *pb_extension_t*.
|
||||||
|
|
||||||
|
An example of this is available in *tests/test_encode_extensions.c* and
|
||||||
|
*tests/test_decode_extensions.c*.
|
||||||
|
|
||||||
|
.. _`extension fields`: https://developers.google.com/protocol-buffers/docs/proto#extensions
|
||||||
|
|
||||||
|
|
||||||
Return values and error handling
|
Return values and error handling
|
||||||
================================
|
================================
|
||||||
|
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ Features and limitations
|
|||||||
#) Allows specifying maximum size for strings and arrays, so that they can be allocated statically.
|
#) Allows specifying maximum size for strings and arrays, so that they can be allocated statically.
|
||||||
#) No malloc needed: everything can be allocated statically or on the stack.
|
#) No malloc needed: everything can be allocated statically or on the stack.
|
||||||
#) You can use either encoder or decoder alone to cut the code size in half.
|
#) You can use either encoder or decoder alone to cut the code size in half.
|
||||||
#) Support for most protobuf features, including: all data types, nested submessages, default values, repeated and optional fields, packed arrays.
|
#) Support for most protobuf features, including: all data types, nested submessages, default values, repeated and optional fields, packed arrays, extension fields.
|
||||||
#) Callback mechanism for handling messages larger than can fit in available RAM.
|
#) Callback mechanism for handling messages larger than can fit in available RAM.
|
||||||
#) Extensive set of tests.
|
#) Extensive set of tests.
|
||||||
|
|
||||||
@@ -103,6 +103,8 @@ Nanopb should compile with most ansi-C compatible compilers. It however requires
|
|||||||
|
|
||||||
If these header files do not come with your compiler, you should be able to find suitable replacements online. Mostly the requirements are very simple, just a few basic functions and typedefs.
|
If these header files do not come with your compiler, you should be able to find suitable replacements online. Mostly the requirements are very simple, just a few basic functions and typedefs.
|
||||||
|
|
||||||
|
Alternatively, you can define *PB_SYSTEM_HEADER*, which should be the name of a single header file including all the necessary definitions.
|
||||||
|
|
||||||
Debugging and testing
|
Debugging and testing
|
||||||
=====================
|
=====================
|
||||||
Extensive unittests are included under the *tests* folder. Just type *make* there to run the tests.
|
Extensive unittests are included under the *tests* folder. Just type *make* there to run the tests.
|
||||||
|
|||||||
@@ -6,29 +6,187 @@ Nanopb: API reference
|
|||||||
|
|
||||||
.. contents ::
|
.. contents ::
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Compilation options
|
Compilation options
|
||||||
===================
|
===================
|
||||||
The following options can be specified using -D switch given to the C compiler:
|
The following options can be specified in one of two ways:
|
||||||
|
|
||||||
|
1. Using the -D switch on the C compiler command line.
|
||||||
|
2. By #defining them at the top of pb.h.
|
||||||
|
|
||||||
|
You must have the same settings for the nanopb library and all code that
|
||||||
|
includes pb.h.
|
||||||
|
|
||||||
|
============================ ================================================
|
||||||
|
__BIG_ENDIAN__ Set this if your platform stores integers and
|
||||||
|
floats in big-endian format. Mixed-endian
|
||||||
|
systems (different layout for ints and floats)
|
||||||
|
are currently not supported.
|
||||||
|
NANOPB_INTERNALS Set this to expose the field encoder functions
|
||||||
|
that are hidden since nanopb-0.1.3.
|
||||||
|
PB_MAX_REQUIRED_FIELDS Maximum number of required fields to check for
|
||||||
|
presence. Default value is 64. Increases stack
|
||||||
|
usage 1 byte per every 8 fields. Compiler
|
||||||
|
warning will tell if you need this.
|
||||||
|
PB_FIELD_16BIT Add support for tag numbers > 255 and fields
|
||||||
|
larger than 255 bytes or 255 array entries.
|
||||||
|
Increases code size 3 bytes per each field.
|
||||||
|
Compiler error will tell if you need this.
|
||||||
|
PB_FIELD_32BIT Add support for tag numbers > 65535 and fields
|
||||||
|
larger than 65535 bytes or 65535 array entries.
|
||||||
|
Increases code size 9 bytes per each field.
|
||||||
|
Compiler error will tell if you need this.
|
||||||
|
PB_NO_ERRMSG Disables the support for error messages; only
|
||||||
|
error information is the true/false return
|
||||||
|
value. Decreases the code size by a few hundred
|
||||||
|
bytes.
|
||||||
|
PB_BUFFER_ONLY Disables the support for custom streams. Only
|
||||||
|
supports encoding and decoding with memory
|
||||||
|
buffers. Speeds up execution and decreases code
|
||||||
|
size slightly.
|
||||||
|
PB_OLD_CALLBACK_STYLE Use the old function signature (void\* instead
|
||||||
|
of void\*\*) for callback fields. This was the
|
||||||
|
default until nanopb-0.2.1.
|
||||||
|
PB_SYSTEM_HEADER Replace the standard header files with a single
|
||||||
|
header file. It should define all the required
|
||||||
|
functions and typedefs listed on the
|
||||||
|
`overview page`_. Value must include quotes,
|
||||||
|
for example *#define PB_SYSTEM_HEADER "foo.h"*.
|
||||||
|
============================ ================================================
|
||||||
|
|
||||||
|
The PB_MAX_REQUIRED_FIELDS, PB_FIELD_16BIT and PB_FIELD_32BIT settings allow
|
||||||
|
raising some datatype limits to suit larger messages. Their need is recognized
|
||||||
|
automatically by C-preprocessor #if-directives in the generated .pb.h files.
|
||||||
|
The default setting is to use the smallest datatypes (least resources used).
|
||||||
|
|
||||||
|
.. _`overview page`: index.html#compiler-requirements
|
||||||
|
|
||||||
|
|
||||||
|
Proto file options
|
||||||
|
==================
|
||||||
|
The generator behaviour can be adjusted using these options, defined in the
|
||||||
|
'nanopb.proto' file in the generator folder:
|
||||||
|
|
||||||
|
============================ ================================================
|
||||||
|
max_size Allocated size for *bytes* and *string* fields.
|
||||||
|
max_count Allocated number of entries in arrays
|
||||||
|
(*repeated* fields).
|
||||||
|
type Type of the generated field. Default value
|
||||||
|
is *FT_DEFAULT*, which selects automatically.
|
||||||
|
You can use *FT_CALLBACK*, *FT_STATIC* or
|
||||||
|
*FT_IGNORE* to force a callback field, a static
|
||||||
|
field or to completely ignore the field.
|
||||||
|
long_names Prefix the enum name to the enum value in
|
||||||
|
definitions, i.e. *EnumName_EnumValue*. Enabled
|
||||||
|
by default.
|
||||||
|
packed_struct Make the generated structures packed.
|
||||||
|
NOTE: This cannot be used on CPUs that break
|
||||||
|
on unaligned accesses to variables.
|
||||||
|
============================ ================================================
|
||||||
|
|
||||||
|
These options can be defined for the .proto files before they are converted
|
||||||
|
using the nanopb-generatory.py. There are three ways to define the options:
|
||||||
|
|
||||||
|
1. Using a separate .options file.
|
||||||
|
This is the preferred way as of nanopb-0.2.1, because it has the best
|
||||||
|
compatibility with other protobuf libraries.
|
||||||
|
2. Defining the options on the command line of nanopb_generator.py.
|
||||||
|
This only makes sense for settings that apply to a whole file.
|
||||||
|
3. Defining the options in the .proto file using the nanopb extensions.
|
||||||
|
This is the way used in nanopb-0.1, and will remain supported in the
|
||||||
|
future. It however sometimes causes trouble when using the .proto file
|
||||||
|
with other protobuf libraries.
|
||||||
|
|
||||||
|
The effect of the options is the same no matter how they are given. The most
|
||||||
|
common purpose is to define maximum size for string fields in order to
|
||||||
|
statically allocate them.
|
||||||
|
|
||||||
|
Defining the options in a .options file
|
||||||
|
---------------------------------------
|
||||||
|
The preferred way to define options is to have a separate file
|
||||||
|
'myproto.options' in the same directory as the 'myproto.proto'. ::
|
||||||
|
|
||||||
|
# myproto.proto
|
||||||
|
message MyMessage {
|
||||||
|
required string name = 1;
|
||||||
|
repeated int32 ids = 4;
|
||||||
|
}
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
# myproto.options
|
||||||
|
MyMessage.name max_size:40
|
||||||
|
MyMessage.ids max_count:5
|
||||||
|
|
||||||
|
The generator will automatically search for this file and read the
|
||||||
|
options from it. The file format is as follows:
|
||||||
|
|
||||||
|
* Lines starting with '#' or '//' are regarded as comments.
|
||||||
|
* Blank lines are ignored.
|
||||||
|
* All other lines should start with a field name pattern, followed by one or
|
||||||
|
more options. For example: *"MyMessage.myfield max_size:5 max_count:10"*.
|
||||||
|
* The field name pattern is matched against a string of form *'Message.field'*.
|
||||||
|
For nested messages, the string is *'Message.SubMessage.field'*.
|
||||||
|
* The field name pattern may use the notation recognized by Python fnmatch():
|
||||||
|
|
||||||
|
- *\** matches any part of string, like 'Message.\*' for all fields
|
||||||
|
- *\?* matches any single character
|
||||||
|
- *[seq]* matches any of characters 's', 'e' and 'q'
|
||||||
|
- *[!seq]* matches any other character
|
||||||
|
|
||||||
|
* The options are written as *'option_name:option_value'* and several options
|
||||||
|
can be defined on same line, separated by whitespace.
|
||||||
|
* Options defined later in the file override the ones specified earlier, so
|
||||||
|
it makes sense to define wildcard options first in the file and more specific
|
||||||
|
ones later.
|
||||||
|
|
||||||
|
If preferred, the name of the options file can be set using the command line
|
||||||
|
switch *-f* to nanopb_generator.py.
|
||||||
|
|
||||||
|
Defining the options on command line
|
||||||
|
------------------------------------
|
||||||
|
The nanopb_generator.py has a simple command line option *-s OPTION:VALUE*.
|
||||||
|
The setting applies to the whole file that is being processed.
|
||||||
|
|
||||||
|
Defining the options in the .proto file
|
||||||
|
---------------------------------------
|
||||||
|
The .proto file format allows defining custom options for the fields.
|
||||||
|
The nanopb library comes with *nanopb.proto* which does exactly that, allowing
|
||||||
|
you do define the options directly in the .proto file::
|
||||||
|
|
||||||
|
import "nanopb.proto";
|
||||||
|
|
||||||
|
message MyMessage {
|
||||||
|
required string name = 1 [(nanopb).max_size = 40];
|
||||||
|
repeated int32 ids = 4 [(nanopb).max_count = 5];
|
||||||
|
}
|
||||||
|
|
||||||
|
A small complication is that you have to set the include path of protoc so that
|
||||||
|
nanopb.proto can be found. This file, in turn, requires the file
|
||||||
|
*google/protobuf/descriptor.proto*. This is usually installed under
|
||||||
|
*/usr/include*. Therefore, to compile a .proto file which uses options, use a
|
||||||
|
protoc command similar to::
|
||||||
|
|
||||||
|
protoc -I/usr/include -Inanopb/generator -I. -omessage.pb message.proto
|
||||||
|
|
||||||
|
The options can be defined in file, message and field scopes::
|
||||||
|
|
||||||
|
option (nanopb_fileopt).max_size = 20; // File scope
|
||||||
|
message Message
|
||||||
|
{
|
||||||
|
option (nanopb_msgopt).max_size = 30; // Message scope
|
||||||
|
required string fieldsize = 1 [(nanopb).max_size = 40]; // Field scope
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
============================ ================================================================================================
|
|
||||||
__BIG_ENDIAN__ Set this if your platform stores integers and floats in big-endian format.
|
|
||||||
Mixed-endian systems (different layout for ints and floats) are currently not supported.
|
|
||||||
NANOPB_INTERNALS Set this to expose the field encoder functions that are hidden since nanopb-0.1.3.
|
|
||||||
PB_MAX_REQUIRED_FIELDS Maximum number of required fields to check for presence. Default value is 64. Increases stack
|
|
||||||
usage 1 byte per every 8 fields. Compiler warning will tell if you need this.
|
|
||||||
PB_FIELD_16BIT Add support for tag numbers > 255 and fields larger than 255 bytes or 255 array entries.
|
|
||||||
Increases code size 3 bytes per each field. Compiler error will tell if you need this.
|
|
||||||
PB_FIELD_32BIT Add support for tag numbers > 65535 and fields larger than 65535 bytes or 65535 array entries.
|
|
||||||
Increases code size 9 bytes per each field. Compiler error will tell if you need this.
|
|
||||||
PB_NO_ERRMSG Disables the support for error messages; only error information is the true/false return value.
|
|
||||||
Decreases the code size by a few hundred bytes.
|
|
||||||
PB_BUFFER_ONLY Disables the support for custom streams. Only supports encoding to memory buffers.
|
|
||||||
Speeds up execution and decreases code size slightly.
|
|
||||||
============================ ================================================================================================
|
|
||||||
|
|
||||||
The PB_MAX_REQUIRED_FIELDS, PB_FIELD_16BIT and PB_FIELD_32BIT settings allow raising some datatype limits to suit larger messages.
|
|
||||||
Their need is recognized automatically by C-preprocessor #if-directives in the generated .pb.h files. The default setting is to use
|
|
||||||
the smallest datatypes (least resources used).
|
|
||||||
|
|
||||||
pb.h
|
pb.h
|
||||||
====
|
====
|
||||||
@@ -122,14 +280,16 @@ Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
|
|||||||
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, void * const *arg);
|
||||||
} funcs;
|
} funcs;
|
||||||
|
|
||||||
void *arg;
|
void *arg;
|
||||||
};
|
};
|
||||||
|
|
||||||
The *arg* is passed to the callback when calling. It can be used to store any information that the callback might need.
|
A pointer to the *arg* is passed to the callback when calling. It can be used to store any information that the callback might need.
|
||||||
|
|
||||||
|
Previously the function received just the value of *arg* instead of a pointer to it. This old behaviour can be enabled by defining *PB_OLD_CALLBACK_STYLE*.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
@@ -144,6 +304,76 @@ Protocol Buffers wire types. These are used with `pb_encode_tag`_. ::
|
|||||||
PB_WT_32BIT = 5
|
PB_WT_32BIT = 5
|
||||||
} pb_wire_type_t;
|
} pb_wire_type_t;
|
||||||
|
|
||||||
|
pb_extension_type_t
|
||||||
|
-------------------
|
||||||
|
Defines the handler functions and auxiliary data for a field that extends
|
||||||
|
another message. Usually autogenerated by *nanopb_generator.py*::
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
bool (*decode)(pb_istream_t *stream, pb_extension_t *extension,
|
||||||
|
uint32_t tag, pb_wire_type_t wire_type);
|
||||||
|
bool (*encode)(pb_ostream_t *stream, const pb_extension_t *extension);
|
||||||
|
const void *arg;
|
||||||
|
} pb_extension_type_t;
|
||||||
|
|
||||||
|
In the normal case, the function pointers are *NULL* and the decoder and
|
||||||
|
encoder use their internal implementations. The internal implementations
|
||||||
|
assume that *arg* points to a *pb_field_t* that describes the field in question.
|
||||||
|
|
||||||
|
To implement custom processing of unknown fields, you can provide pointers
|
||||||
|
to your own functions. Their functionality is mostly the same as for normal
|
||||||
|
callback fields, except that they get called for any unknown field when decoding.
|
||||||
|
|
||||||
|
pb_extension_t
|
||||||
|
--------------
|
||||||
|
Ties together the extension field type and the storage for the field value::
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
const pb_extension_type_t *type;
|
||||||
|
void *dest;
|
||||||
|
pb_extension_t *next;
|
||||||
|
} pb_extension_t;
|
||||||
|
|
||||||
|
:type: Pointer to the structure that defines the callback functions.
|
||||||
|
:dest: Pointer to the variable that stores the field value
|
||||||
|
(as used by the default extension callback functions.)
|
||||||
|
:next: Pointer to the next extension handler, or *NULL*.
|
||||||
|
|
||||||
|
PB_GET_ERROR
|
||||||
|
------------
|
||||||
|
Get the current error message from a stream, or a placeholder string if
|
||||||
|
there is no error message::
|
||||||
|
|
||||||
|
#define PB_GET_ERROR(stream) (string expression)
|
||||||
|
|
||||||
|
This should be used for printing errors, for example::
|
||||||
|
|
||||||
|
if (!pb_decode(...))
|
||||||
|
{
|
||||||
|
printf("Decode failed: %s\n", PB_GET_ERROR(stream));
|
||||||
|
}
|
||||||
|
|
||||||
|
The macro only returns pointers to constant strings (in code memory),
|
||||||
|
so that there is no need to release the returned pointer.
|
||||||
|
|
||||||
|
PB_RETURN_ERROR
|
||||||
|
---------------
|
||||||
|
Set the error message and return false::
|
||||||
|
|
||||||
|
#define PB_RETURN_ERROR(stream,msg) (sets error and returns false)
|
||||||
|
|
||||||
|
This should be used to handle error conditions inside nanopb functions
|
||||||
|
and user callback functions::
|
||||||
|
|
||||||
|
if (error_condition)
|
||||||
|
{
|
||||||
|
PB_RETURN_ERROR(stream, "something went wrong");
|
||||||
|
}
|
||||||
|
|
||||||
|
The *msg* parameter must be a constant string.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
pb_encode.h
|
pb_encode.h
|
||||||
===========
|
===========
|
||||||
|
|
||||||
@@ -293,6 +523,17 @@ In Protocol Buffers format, the submessage size must be written before the subme
|
|||||||
|
|
||||||
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.
|
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_decode.h
|
pb_decode.h
|
||||||
===========
|
===========
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@
|
|||||||
#include "fileproto.pb.h"
|
#include "fileproto.pb.h"
|
||||||
#include "common.h"
|
#include "common.h"
|
||||||
|
|
||||||
bool printfile_callback(pb_istream_t *stream, const pb_field_t *field, void *arg)
|
bool printfile_callback(pb_istream_t *stream, const pb_field_t *field, void **arg)
|
||||||
{
|
{
|
||||||
FileInfo fileinfo;
|
FileInfo fileinfo;
|
||||||
|
|
||||||
|
|||||||
13
example/fileproto.options
Normal file
13
example/fileproto.options
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# This file defines the nanopb-specific options for the messages defined
|
||||||
|
# in fileproto.proto.
|
||||||
|
#
|
||||||
|
# If you come from high-level programming background, the hardcoded
|
||||||
|
# maximum lengths may disgust you. However, if your microcontroller only
|
||||||
|
# has a few kB of ram to begin with, setting reasonable limits for
|
||||||
|
# filenames is ok.
|
||||||
|
#
|
||||||
|
# On the other hand, using the callback interface, it is not necessary
|
||||||
|
# to set a limit on the number of files in the response.
|
||||||
|
|
||||||
|
ListFilesRequest.path max_size:128
|
||||||
|
FileInfo.name max_size:128
|
||||||
@@ -1,22 +1,14 @@
|
|||||||
import "nanopb.proto";
|
|
||||||
|
|
||||||
// This defines protocol for a simple server that lists files.
|
// This defines protocol for a simple server that lists files.
|
||||||
//
|
//
|
||||||
// If you come from high-level programming background, the hardcoded
|
// See also the nanopb-specific options in fileproto.options.
|
||||||
// maximum lengths may disgust you. However, if your microcontroller only
|
|
||||||
// has a few kB of ram to begin with, setting reasonable limits for
|
|
||||||
// filenames is ok.
|
|
||||||
//
|
|
||||||
// On the other hand, using the callback interface, it is not necessary
|
|
||||||
// to set a limit on the number of files in the response.
|
|
||||||
|
|
||||||
message ListFilesRequest {
|
message ListFilesRequest {
|
||||||
optional string path = 1 [default = "/", (nanopb).max_size = 128];
|
optional string path = 1 [default = "/"];
|
||||||
}
|
}
|
||||||
|
|
||||||
message FileInfo {
|
message FileInfo {
|
||||||
required uint64 inode = 1;
|
required uint64 inode = 1;
|
||||||
required string name = 2 [(nanopb).max_size = 128];
|
required string name = 2;
|
||||||
}
|
}
|
||||||
|
|
||||||
message ListFilesResponse {
|
message ListFilesResponse {
|
||||||
|
|||||||
@@ -23,9 +23,9 @@
|
|||||||
#include "fileproto.pb.h"
|
#include "fileproto.pb.h"
|
||||||
#include "common.h"
|
#include "common.h"
|
||||||
|
|
||||||
bool listdir_callback(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
|
bool listdir_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg)
|
||||||
{
|
{
|
||||||
DIR *dir = (DIR*) arg;
|
DIR *dir = (DIR*) *arg;
|
||||||
struct dirent *file;
|
struct dirent *file;
|
||||||
FileInfo fileinfo;
|
FileInfo fileinfo;
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,9 @@ enum FieldType {
|
|||||||
FT_IGNORE = 3; // Ignore the field completely.
|
FT_IGNORE = 3; // Ignore the field completely.
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// This is the inner options message, which basically defines options for
|
||||||
|
// a field. When it is used in message or file scope, it applies to all
|
||||||
|
// fields.
|
||||||
message NanoPBOptions {
|
message NanoPBOptions {
|
||||||
// Allocated size for 'bytes' and 'string' fields.
|
// Allocated size for 'bytes' and 'string' fields.
|
||||||
optional int32 max_size = 1;
|
optional int32 max_size = 1;
|
||||||
@@ -30,9 +33,14 @@ message NanoPBOptions {
|
|||||||
optional bool long_names = 4 [default = true];
|
optional bool long_names = 4 [default = true];
|
||||||
|
|
||||||
// Add 'packed' attribute to generated structs.
|
// Add 'packed' attribute to generated structs.
|
||||||
|
// Note: this cannot be used on CPUs that break on unaligned
|
||||||
|
// accesses to variables.
|
||||||
optional bool packed_struct = 5 [default = false];
|
optional bool packed_struct = 5 [default = false];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Extensions to protoc 'Descriptor' type in order to define options
|
||||||
|
// inside a .proto file.
|
||||||
|
//
|
||||||
// Protocol Buffers extension number registry
|
// Protocol Buffers extension number registry
|
||||||
// --------------------------------
|
// --------------------------------
|
||||||
// Project: Nanopb
|
// Project: Nanopb
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
'''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
|
'''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
|
||||||
nanopb_version = "nanopb-0.2.0"
|
nanopb_version = "nanopb-0.2.3-dev"
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import google.protobuf.descriptor_pb2 as descriptor
|
import google.protobuf.descriptor_pb2 as descriptor
|
||||||
|
import google.protobuf.text_format as text_format
|
||||||
except:
|
except:
|
||||||
print
|
print
|
||||||
print "*************************************************************"
|
print "*************************************************************"
|
||||||
@@ -54,9 +55,7 @@ datatypes = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
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.'''
|
||||||
You can subclass this with your own implementation.
|
|
||||||
'''
|
|
||||||
def __init__(self, parts = ()):
|
def __init__(self, parts = ()):
|
||||||
if isinstance(parts, Names):
|
if isinstance(parts, Names):
|
||||||
parts = parts.parts
|
parts = parts.parts
|
||||||
@@ -187,7 +186,7 @@ class Field:
|
|||||||
return cmp(self.tag, other.tag)
|
return cmp(self.tag, other.tag)
|
||||||
|
|
||||||
def __str__(self):
|
def __str__(self):
|
||||||
if self.rules == 'OPTIONAL':
|
if self.rules == 'OPTIONAL' and self.allocation == 'STATIC':
|
||||||
result = ' bool has_' + self.name + ';\n'
|
result = ' bool has_' + self.name + ';\n'
|
||||||
elif self.rules == 'REPEATED' and self.allocation == 'STATIC':
|
elif self.rules == 'REPEATED' and self.allocation == 'STATIC':
|
||||||
result = ' size_t ' + self.name + '_count;\n'
|
result = ' size_t ' + self.name + '_count;\n'
|
||||||
@@ -236,6 +235,11 @@ class Field:
|
|||||||
else:
|
else:
|
||||||
return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
|
return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
|
||||||
|
|
||||||
|
def tags(self):
|
||||||
|
'''Return the #define for the tag number of this field.'''
|
||||||
|
identifier = '%s_%s_tag' % (self.struct_name, self.name)
|
||||||
|
return '#define %-40s %d\n' % (identifier, self.tag)
|
||||||
|
|
||||||
def pb_field_t(self, prev_field_name):
|
def pb_field_t(self, prev_field_name):
|
||||||
'''Return the pb_field_t initializer to use in the constant array.
|
'''Return the pb_field_t initializer to use in the constant array.
|
||||||
prev_field_name is the name of the previous field or None.
|
prev_field_name is the name of the previous field or None.
|
||||||
@@ -271,8 +275,72 @@ class Field:
|
|||||||
return max(self.tag, self.max_size, self.max_count)
|
return max(self.tag, self.max_size, self.max_count)
|
||||||
|
|
||||||
|
|
||||||
|
class ExtensionRange(Field):
|
||||||
|
def __init__(self, struct_name, range_start, field_options):
|
||||||
|
'''Implements a special pb_extension_t* field in an extensible message
|
||||||
|
structure. The range_start signifies the index at which the extensions
|
||||||
|
start. Not necessarily all tags above this are extensions, it is merely
|
||||||
|
a speed optimization.
|
||||||
|
'''
|
||||||
|
self.tag = range_start
|
||||||
|
self.struct_name = struct_name
|
||||||
|
self.name = 'extensions'
|
||||||
|
self.pbtype = 'EXTENSION'
|
||||||
|
self.rules = 'OPTIONAL'
|
||||||
|
self.allocation = 'CALLBACK'
|
||||||
|
self.ctype = 'pb_extension_t'
|
||||||
|
self.array_decl = ''
|
||||||
|
self.default = None
|
||||||
|
self.max_size = 0
|
||||||
|
self.max_count = 0
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return ' pb_extension_t *extensions;'
|
||||||
|
|
||||||
|
def types(self):
|
||||||
|
return None
|
||||||
|
|
||||||
|
def tags(self):
|
||||||
|
return ''
|
||||||
|
|
||||||
|
class ExtensionField(Field):
|
||||||
|
def __init__(self, struct_name, desc, field_options):
|
||||||
|
self.fullname = struct_name + desc.name
|
||||||
|
self.extendee_name = names_from_type_name(desc.extendee)
|
||||||
|
Field.__init__(self, self.fullname + 'struct', desc, field_options)
|
||||||
|
|
||||||
|
if self.rules != 'OPTIONAL':
|
||||||
|
self.skip = True
|
||||||
|
else:
|
||||||
|
self.skip = False
|
||||||
|
self.rules = 'OPTEXT'
|
||||||
|
|
||||||
|
def extension_decl(self):
|
||||||
|
'''Declaration of the extension type in the .pb.h file'''
|
||||||
|
if self.skip:
|
||||||
|
msg = '/* Extension field %s was skipped because only "optional"\n' % self.fullname
|
||||||
|
msg +=' type of extension fields is currently supported. */\n'
|
||||||
|
return msg
|
||||||
|
|
||||||
|
return 'extern const pb_extension_type_t %s;\n' % self.fullname
|
||||||
|
|
||||||
|
def extension_def(self):
|
||||||
|
'''Definition of the extension type in the .pb.c file'''
|
||||||
|
|
||||||
|
if self.skip:
|
||||||
|
return ''
|
||||||
|
|
||||||
|
result = 'typedef struct {\n'
|
||||||
|
result += str(self)
|
||||||
|
result += '\n} %s;\n\n' % self.struct_name
|
||||||
|
result += ('static const pb_field_t %s_field = \n %s;\n\n' %
|
||||||
|
(self.fullname, self.pb_field_t(None)))
|
||||||
|
result += 'const pb_extension_type_t %s = {\n' % self.fullname
|
||||||
|
result += ' NULL,\n'
|
||||||
|
result += ' NULL,\n'
|
||||||
|
result += ' &%s_field\n' % self.fullname
|
||||||
|
result += '};\n'
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -286,10 +354,16 @@ class Message:
|
|||||||
self.fields = []
|
self.fields = []
|
||||||
|
|
||||||
for f in desc.field:
|
for f in desc.field:
|
||||||
field_options = get_nanopb_suboptions(f, message_options)
|
field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
|
||||||
if field_options.type != nanopb_pb2.FT_IGNORE:
|
if field_options.type != nanopb_pb2.FT_IGNORE:
|
||||||
self.fields.append(Field(self.name, f, field_options))
|
self.fields.append(Field(self.name, f, field_options))
|
||||||
|
|
||||||
|
if len(desc.extension_range) > 0:
|
||||||
|
field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions')
|
||||||
|
range_start = min([r.start for r in desc.extension_range])
|
||||||
|
if field_options.type != nanopb_pb2.FT_IGNORE:
|
||||||
|
self.fields.append(ExtensionRange(self.name, range_start, field_options))
|
||||||
|
|
||||||
self.packed = message_options.packed_struct
|
self.packed = message_options.packed_struct
|
||||||
self.ordered_fields = self.fields[:]
|
self.ordered_fields = self.fields[:]
|
||||||
self.ordered_fields.sort()
|
self.ordered_fields.sort()
|
||||||
@@ -300,6 +374,12 @@ class Message:
|
|||||||
|
|
||||||
def __str__(self):
|
def __str__(self):
|
||||||
result = 'typedef struct _%s {\n' % self.name
|
result = 'typedef struct _%s {\n' % self.name
|
||||||
|
|
||||||
|
if not self.ordered_fields:
|
||||||
|
# Empty structs are not allowed in C standard.
|
||||||
|
# Therefore add a dummy field if an empty message occurs.
|
||||||
|
result += ' uint8_t dummy_field;'
|
||||||
|
|
||||||
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}'
|
||||||
|
|
||||||
@@ -307,6 +387,11 @@ class Message:
|
|||||||
result += ' pb_packed'
|
result += ' pb_packed'
|
||||||
|
|
||||||
result += ' %s;' % self.name
|
result += ' %s;' % self.name
|
||||||
|
|
||||||
|
if self.packed:
|
||||||
|
result = 'PB_PACKED_STRUCT_START\n' + result
|
||||||
|
result += '\nPB_PACKED_STRUCT_END'
|
||||||
|
|
||||||
return result
|
return result
|
||||||
|
|
||||||
def types(self):
|
def types(self):
|
||||||
@@ -343,9 +428,6 @@ class Message:
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# Processing of entire .proto files
|
# Processing of entire .proto files
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -365,11 +447,23 @@ def iterate_messages(desc, names = Names()):
|
|||||||
for x in iterate_messages(submsg, sub_names):
|
for x in iterate_messages(submsg, sub_names):
|
||||||
yield x
|
yield x
|
||||||
|
|
||||||
|
def iterate_extensions(desc, names = Names()):
|
||||||
|
'''Recursively find all extensions.
|
||||||
|
For each, yield name, FieldDescriptorProto.
|
||||||
|
'''
|
||||||
|
for extension in desc.extension:
|
||||||
|
yield names, extension
|
||||||
|
|
||||||
|
for subname, subdesc in iterate_messages(desc, names):
|
||||||
|
for extension in subdesc.extension:
|
||||||
|
yield subname, extension
|
||||||
|
|
||||||
def parse_file(fdesc, file_options):
|
def parse_file(fdesc, file_options):
|
||||||
'''Takes a FileDescriptorProto and returns tuple (enum, messages).'''
|
'''Takes a FileDescriptorProto and returns tuple (enums, messages, extensions).'''
|
||||||
|
|
||||||
enums = []
|
enums = []
|
||||||
messages = []
|
messages = []
|
||||||
|
extensions = []
|
||||||
|
|
||||||
if fdesc.package:
|
if fdesc.package:
|
||||||
base_name = Names(fdesc.package.split('.'))
|
base_name = Names(fdesc.package.split('.'))
|
||||||
@@ -377,16 +471,21 @@ def parse_file(fdesc, file_options):
|
|||||||
base_name = Names()
|
base_name = Names()
|
||||||
|
|
||||||
for enum in fdesc.enum_type:
|
for enum in fdesc.enum_type:
|
||||||
enum_options = get_nanopb_suboptions(enum, file_options)
|
enum_options = get_nanopb_suboptions(enum, file_options, base_name + enum.name)
|
||||||
enums.append(Enum(base_name, enum, enum_options))
|
enums.append(Enum(base_name, enum, enum_options))
|
||||||
|
|
||||||
for names, message in iterate_messages(fdesc, base_name):
|
for names, message in iterate_messages(fdesc, base_name):
|
||||||
message_options = get_nanopb_suboptions(message, file_options)
|
message_options = get_nanopb_suboptions(message, file_options, names)
|
||||||
messages.append(Message(names, message, message_options))
|
messages.append(Message(names, message, message_options))
|
||||||
for enum in message.enum_type:
|
for enum in message.enum_type:
|
||||||
enum_options = get_nanopb_suboptions(enum, message_options)
|
enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
|
||||||
enums.append(Enum(names, enum, enum_options))
|
enums.append(Enum(names, enum, enum_options))
|
||||||
|
|
||||||
|
for names, extension in iterate_extensions(fdesc, base_name):
|
||||||
|
field_options = get_nanopb_suboptions(extension, file_options, names)
|
||||||
|
if field_options.type != nanopb_pb2.FT_IGNORE:
|
||||||
|
extensions.append(ExtensionField(names, extension, field_options))
|
||||||
|
|
||||||
# Fix field default values where enum short names are used.
|
# Fix field default values where enum short names are used.
|
||||||
for enum in enums:
|
for enum in enums:
|
||||||
if not enum.options.long_names:
|
if not enum.options.long_names:
|
||||||
@@ -396,7 +495,7 @@ def parse_file(fdesc, file_options):
|
|||||||
idx = enum.value_longnames.index(field.default)
|
idx = enum.value_longnames.index(field.default)
|
||||||
field.default = enum.values[idx][0]
|
field.default = enum.values[idx][0]
|
||||||
|
|
||||||
return enums, messages
|
return enums, messages, extensions
|
||||||
|
|
||||||
def toposort2(data):
|
def toposort2(data):
|
||||||
'''Topological sort.
|
'''Topological sort.
|
||||||
@@ -439,7 +538,7 @@ def make_identifier(headername):
|
|||||||
result += '_'
|
result += '_'
|
||||||
return result
|
return result
|
||||||
|
|
||||||
def generate_header(dependencies, headername, enums, messages, options):
|
def generate_header(dependencies, headername, enums, messages, extensions, options):
|
||||||
'''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.
|
||||||
'''
|
'''
|
||||||
@@ -450,11 +549,17 @@ def generate_header(dependencies, headername, enums, messages, options):
|
|||||||
symbol = make_identifier(headername)
|
symbol = make_identifier(headername)
|
||||||
yield '#ifndef _PB_%s_\n' % symbol
|
yield '#ifndef _PB_%s_\n' % symbol
|
||||||
yield '#define _PB_%s_\n' % symbol
|
yield '#define _PB_%s_\n' % symbol
|
||||||
yield '#include <pb.h>\n\n'
|
try:
|
||||||
|
yield options.libformat % ('pb.h')
|
||||||
|
except TypeError:
|
||||||
|
# no %s specified - use whatever was passed in as options.libformat
|
||||||
|
yield options.libformat
|
||||||
|
yield '\n'
|
||||||
|
|
||||||
for dependency in dependencies:
|
for dependency in dependencies:
|
||||||
noext = os.path.splitext(dependency)[0]
|
noext = os.path.splitext(dependency)[0]
|
||||||
yield '#include "%s.%s.h"\n' % (noext,options.extension)
|
yield options.genformat % (noext + '.' + options.extension + '.h')
|
||||||
|
yield '\n'
|
||||||
|
|
||||||
yield '#ifdef __cplusplus\n'
|
yield '#ifdef __cplusplus\n'
|
||||||
yield 'extern "C" {\n'
|
yield 'extern "C" {\n'
|
||||||
@@ -469,11 +574,23 @@ def generate_header(dependencies, headername, enums, messages, options):
|
|||||||
yield msg.types()
|
yield msg.types()
|
||||||
yield str(msg) + '\n\n'
|
yield str(msg) + '\n\n'
|
||||||
|
|
||||||
|
if extensions:
|
||||||
|
yield '/* Extensions */\n'
|
||||||
|
for extension in extensions:
|
||||||
|
yield extension.extension_decl()
|
||||||
|
yield '\n'
|
||||||
|
|
||||||
yield '/* Default values for struct fields */\n'
|
yield '/* Default values for struct fields */\n'
|
||||||
for msg in messages:
|
for msg in messages:
|
||||||
yield msg.default_decl(True)
|
yield msg.default_decl(True)
|
||||||
yield '\n'
|
yield '\n'
|
||||||
|
|
||||||
|
yield '/* Field tags (for use in manual encoding/decoding) */\n'
|
||||||
|
for msg in sort_dependencies(messages):
|
||||||
|
for field in msg.fields:
|
||||||
|
yield field.tags()
|
||||||
|
yield '\n'
|
||||||
|
|
||||||
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.fields_declaration() + '\n'
|
yield msg.fields_declaration() + '\n'
|
||||||
@@ -485,12 +602,13 @@ def generate_header(dependencies, headername, enums, messages, options):
|
|||||||
# End of header
|
# End of header
|
||||||
yield '\n#endif\n'
|
yield '\n#endif\n'
|
||||||
|
|
||||||
def generate_source(headername, enums, messages):
|
def generate_source(headername, enums, messages, extensions):
|
||||||
'''Generate content for a source file.'''
|
'''Generate content for a source file.'''
|
||||||
|
|
||||||
yield '/* Automatically generated nanopb constant definitions */\n'
|
yield '/* Automatically generated nanopb constant definitions */\n'
|
||||||
yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
|
yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
|
||||||
yield '#include "%s"\n\n' % headername
|
yield options.genformat % (headername)
|
||||||
|
yield '\n'
|
||||||
|
|
||||||
for msg in messages:
|
for msg in messages:
|
||||||
yield msg.default_decl(False)
|
yield msg.default_decl(False)
|
||||||
@@ -500,6 +618,10 @@ def generate_source(headername, enums, messages):
|
|||||||
for msg in messages:
|
for msg in messages:
|
||||||
yield msg.fields_definition() + '\n\n'
|
yield msg.fields_definition() + '\n\n'
|
||||||
|
|
||||||
|
for ext in extensions:
|
||||||
|
yield ext.extension_def() + '\n'
|
||||||
|
|
||||||
|
# Add checks for numeric limits
|
||||||
if messages:
|
if messages:
|
||||||
count_required_fields = lambda m: len([f for f in msg.fields if f.rules == 'REQUIRED'])
|
count_required_fields = lambda m: len([f for f in msg.fields if f.rules == 'REQUIRED'])
|
||||||
largest_msg = max(messages, key = count_required_fields)
|
largest_msg = max(messages, key = count_required_fields)
|
||||||
@@ -511,7 +633,6 @@ def generate_source(headername, enums, messages):
|
|||||||
yield ' setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
|
yield ' setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
|
||||||
yield '#endif\n'
|
yield '#endif\n'
|
||||||
|
|
||||||
# Add checks for numeric limits
|
|
||||||
worst = 0
|
worst = 0
|
||||||
worst_field = ''
|
worst_field = ''
|
||||||
checks = []
|
checks = []
|
||||||
@@ -566,36 +687,46 @@ def generate_source(headername, enums, messages):
|
|||||||
|
|
||||||
yield '\n'
|
yield '\n'
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# Command line interface
|
# Options parsing for the .proto files
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
import sys
|
from fnmatch import fnmatch
|
||||||
import os.path
|
|
||||||
from optparse import OptionParser
|
|
||||||
import google.protobuf.text_format as text_format
|
|
||||||
|
|
||||||
optparser = OptionParser(
|
def read_options_file(infile):
|
||||||
usage = "Usage: nanopb_generator.py [options] file.pb ...",
|
'''Parse a separate options file to list:
|
||||||
epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
|
[(namemask, options), ...]
|
||||||
"Output will be written to file.pb.h and file.pb.c.")
|
'''
|
||||||
optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
|
results = []
|
||||||
help="Exclude file from generated #include list.")
|
for line in infile:
|
||||||
optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default="pb",
|
line = line.strip()
|
||||||
help="use extension instead of 'pb' for generated files.")
|
if not line or line.startswith('//') or line.startswith('#'):
|
||||||
optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
|
continue
|
||||||
help="Don't print anything except errors.")
|
|
||||||
optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
|
|
||||||
help="Print more information.")
|
|
||||||
optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
|
|
||||||
help="Set generator option (max_size, max_count etc.).")
|
|
||||||
|
|
||||||
def get_nanopb_suboptions(subdesc, options):
|
parts = line.split(None, 1)
|
||||||
|
opts = nanopb_pb2.NanoPBOptions()
|
||||||
|
text_format.Merge(parts[1], opts)
|
||||||
|
results.append((parts[0], opts))
|
||||||
|
|
||||||
|
return results
|
||||||
|
|
||||||
|
class Globals:
|
||||||
|
'''Ugly global variables, should find a good way to pass these.'''
|
||||||
|
verbose_options = False
|
||||||
|
separate_options = []
|
||||||
|
|
||||||
|
def get_nanopb_suboptions(subdesc, options, name):
|
||||||
'''Get copy of options, and merge information from subdesc.'''
|
'''Get copy of options, and merge information from subdesc.'''
|
||||||
new_options = nanopb_pb2.NanoPBOptions()
|
new_options = nanopb_pb2.NanoPBOptions()
|
||||||
new_options.CopyFrom(options)
|
new_options.CopyFrom(options)
|
||||||
|
|
||||||
|
# Handle options defined in a separate file
|
||||||
|
dotname = '.'.join(name.parts)
|
||||||
|
for namemask, options in Globals.separate_options:
|
||||||
|
if fnmatch(dotname, namemask):
|
||||||
|
new_options.MergeFrom(options)
|
||||||
|
|
||||||
|
# Handle options defined in .proto
|
||||||
if isinstance(subdesc.options, descriptor.FieldOptions):
|
if isinstance(subdesc.options, descriptor.FieldOptions):
|
||||||
ext_type = nanopb_pb2.nanopb
|
ext_type = nanopb_pb2.nanopb
|
||||||
elif isinstance(subdesc.options, descriptor.FileOptions):
|
elif isinstance(subdesc.options, descriptor.FileOptions):
|
||||||
@@ -611,8 +742,44 @@ def get_nanopb_suboptions(subdesc, options):
|
|||||||
ext = subdesc.options.Extensions[ext_type]
|
ext = subdesc.options.Extensions[ext_type]
|
||||||
new_options.MergeFrom(ext)
|
new_options.MergeFrom(ext)
|
||||||
|
|
||||||
|
if Globals.verbose_options:
|
||||||
|
print "Options for " + dotname + ":"
|
||||||
|
print text_format.MessageToString(new_options)
|
||||||
|
|
||||||
return new_options
|
return new_options
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Command line interface
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
import sys
|
||||||
|
import os.path
|
||||||
|
from optparse import OptionParser
|
||||||
|
|
||||||
|
optparser = OptionParser(
|
||||||
|
usage = "Usage: nanopb_generator.py [options] file.pb ...",
|
||||||
|
epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
|
||||||
|
"Output will be written to file.pb.h and file.pb.c.")
|
||||||
|
optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
|
||||||
|
help="Exclude file from generated #include list.")
|
||||||
|
optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default="pb",
|
||||||
|
help="Set extension to use instead of 'pb' for generated files. [default: %default]")
|
||||||
|
optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
|
||||||
|
help="Set name of a separate generator options file.")
|
||||||
|
optparser.add_option("-Q", "--generated-include-format", dest="genformat",
|
||||||
|
metavar="FORMAT", default='#include "%s"\n',
|
||||||
|
help="Set format string to use for including other .pb.h files. [default: %default]")
|
||||||
|
optparser.add_option("-L", "--library-include-format", dest="libformat",
|
||||||
|
metavar="FORMAT", default='#include <%s>\n',
|
||||||
|
help="Set format string to use for including the nanopb pb.h header. [default: %default]")
|
||||||
|
optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
|
||||||
|
help="Don't print anything except errors.")
|
||||||
|
optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
|
||||||
|
help="Print more information.")
|
||||||
|
optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
|
||||||
|
help="Set generator option (max_size, max_count etc.).")
|
||||||
|
|
||||||
def process(filenames, options):
|
def process(filenames, options):
|
||||||
'''Process the files given on the command line.'''
|
'''Process the files given on the command line.'''
|
||||||
|
|
||||||
@@ -623,6 +790,8 @@ def process(filenames, options):
|
|||||||
if options.quiet:
|
if options.quiet:
|
||||||
options.verbose = False
|
options.verbose = False
|
||||||
|
|
||||||
|
Globals.verbose_options = options.verbose
|
||||||
|
|
||||||
toplevel_options = nanopb_pb2.NanoPBOptions()
|
toplevel_options = nanopb_pb2.NanoPBOptions()
|
||||||
for s in options.settings:
|
for s in options.settings:
|
||||||
text_format.Merge(s, toplevel_options)
|
text_format.Merge(s, toplevel_options)
|
||||||
@@ -631,13 +800,24 @@ def process(filenames, options):
|
|||||||
data = open(filename, 'rb').read()
|
data = open(filename, 'rb').read()
|
||||||
fdesc = descriptor.FileDescriptorSet.FromString(data)
|
fdesc = descriptor.FileDescriptorSet.FromString(data)
|
||||||
|
|
||||||
file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options)
|
# Check if any separate options are specified
|
||||||
|
try:
|
||||||
|
optfilename = options.options_file % os.path.splitext(filename)[0]
|
||||||
|
except TypeError:
|
||||||
|
# No %s specified, use the filename as-is
|
||||||
|
optfilename = options.options_file
|
||||||
|
|
||||||
if options.verbose:
|
if options.verbose:
|
||||||
print "Options for " + filename + ":"
|
print 'Reading options from ' + optfilename
|
||||||
print text_format.MessageToString(file_options)
|
|
||||||
|
|
||||||
enums, messages = parse_file(fdesc.file[0], file_options)
|
if os.path.isfile(optfilename):
|
||||||
|
Globals.separate_options = read_options_file(open(optfilename, "rU"))
|
||||||
|
else:
|
||||||
|
Globals.separate_options = []
|
||||||
|
|
||||||
|
# Parse the file
|
||||||
|
file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options, Names([filename]))
|
||||||
|
enums, messages, extensions = parse_file(fdesc.file[0], file_options)
|
||||||
|
|
||||||
noext = os.path.splitext(filename)[0]
|
noext = os.path.splitext(filename)[0]
|
||||||
headername = noext + '.' + options.extension + '.h'
|
headername = noext + '.' + options.extension + '.h'
|
||||||
@@ -653,11 +833,12 @@ def process(filenames, options):
|
|||||||
dependencies = [d for d in fdesc.file[0].dependency if d not in excludes]
|
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(dependencies, headerbasename, enums, messages, options):
|
for part in generate_header(dependencies, headerbasename, enums,
|
||||||
|
messages, extensions, options):
|
||||||
header.write(part)
|
header.write(part)
|
||||||
|
|
||||||
source = open(sourcename, 'w')
|
source = open(sourcename, 'w')
|
||||||
for part in generate_source(headerbasename, enums, messages):
|
for part in generate_source(headerbasename, enums, messages, extensions):
|
||||||
source.write(part)
|
source.write(part)
|
||||||
|
|
||||||
return True
|
return True
|
||||||
|
|||||||
202
pb.h
202
pb.h
@@ -1,25 +1,96 @@
|
|||||||
|
/* Common parts of the nanopb library. Most of these are quite low-level
|
||||||
|
* stuff. For the high-level interface, see pb_encode.h and pb_decode.h.
|
||||||
|
*/
|
||||||
|
|
||||||
#ifndef _PB_H_
|
#ifndef _PB_H_
|
||||||
#define _PB_H_
|
#define _PB_H_
|
||||||
|
|
||||||
/* pb.h: Common parts for nanopb library.
|
/*****************************************************************
|
||||||
* Most of these are quite low-level stuff. For the high-level interface,
|
* Nanopb compilation time options. You can change these here by *
|
||||||
* see pb_encode.h or pb_decode.h
|
* uncommenting the lines, or on the compiler command line. *
|
||||||
|
*****************************************************************/
|
||||||
|
|
||||||
|
/* Define this if your CPU architecture is big endian, i.e. it
|
||||||
|
* stores the most-significant byte first. */
|
||||||
|
/* #define __BIG_ENDIAN__ 1 */
|
||||||
|
|
||||||
|
/* Increase the number of required fields that are tracked.
|
||||||
|
* A compiler warning will tell if you need this. */
|
||||||
|
/* #define PB_MAX_REQUIRED_FIELDS 256 */
|
||||||
|
|
||||||
|
/* Add support for tag numbers > 255 and fields larger than 255 bytes. */
|
||||||
|
/* #define PB_FIELD_16BIT 1 */
|
||||||
|
|
||||||
|
/* Add support for tag numbers > 65536 and fields larger than 65536 bytes. */
|
||||||
|
/* #define PB_FIELD_32BIT 1 */
|
||||||
|
|
||||||
|
/* Disable support for error messages in order to save some code space. */
|
||||||
|
/* #define PB_NO_ERRMSG 1 */
|
||||||
|
|
||||||
|
/* Disable support for custom streams (support only memory buffers). */
|
||||||
|
/* #define PB_BUFFER_ONLY 1 */
|
||||||
|
|
||||||
|
/* Switch back to the old-style callback function signature.
|
||||||
|
* This was the default until nanopb-0.2.1. */
|
||||||
|
/* #define PB_OLD_CALLBACK_STYLE */
|
||||||
|
|
||||||
|
|
||||||
|
/******************************************************************
|
||||||
|
* You usually don't need to change anything below this line. *
|
||||||
|
* Feel free to look around and use the defined macros, though. *
|
||||||
|
******************************************************************/
|
||||||
|
|
||||||
|
|
||||||
|
/* Version of the nanopb library. Just in case you want to check it in
|
||||||
|
* your own program. */
|
||||||
|
#define NANOPB_VERSION nanopb-0.2.3-dev
|
||||||
|
|
||||||
|
/* Include all the system headers needed by nanopb. You will need the
|
||||||
|
* definitions of the following:
|
||||||
|
* - strlen, memcpy, memset functions
|
||||||
|
* - [u]int8_t, [u]int16_t, [u]int32_t, [u]int64_t
|
||||||
|
* - size_t
|
||||||
|
* - bool
|
||||||
|
*
|
||||||
|
* If you don't have the standard header files, you can instead provide
|
||||||
|
* a custom header that defines or includes all this. In that case,
|
||||||
|
* define PB_SYSTEM_HEADER to the path of this file.
|
||||||
*/
|
*/
|
||||||
|
#ifdef PB_SYSTEM_HEADER
|
||||||
#define NANOPB_VERSION nanopb-0.2.0
|
#include PB_SYSTEM_HEADER
|
||||||
|
#else
|
||||||
#include <stdint.h>
|
#include <stdint.h>
|
||||||
#include <stddef.h>
|
#include <stddef.h>
|
||||||
#include <stdbool.h>
|
#include <stdbool.h>
|
||||||
|
#include <string.h>
|
||||||
#ifdef __GNUC__
|
|
||||||
/* This just reduces memory requirements, but is not required. */
|
|
||||||
#define pb_packed __attribute__((packed))
|
|
||||||
#else
|
|
||||||
#define pb_packed
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* Handly macro for suppressing unreferenced-parameter compiler warnings. */
|
/* Macro for defining packed structures (compiler dependent).
|
||||||
|
* This just reduces memory requirements, but is not required.
|
||||||
|
*/
|
||||||
|
#if defined(__GNUC__) || defined(__clang__)
|
||||||
|
/* For GCC and clang */
|
||||||
|
# define PB_PACKED_STRUCT_START
|
||||||
|
# define PB_PACKED_STRUCT_END
|
||||||
|
# define pb_packed __attribute__((packed))
|
||||||
|
#elif defined(__ICCARM__)
|
||||||
|
/* For IAR ARM compiler */
|
||||||
|
# define PB_PACKED_STRUCT_START _Pragma("pack(push, 1)")
|
||||||
|
# define PB_PACKED_STRUCT_END _Pragma("pack(pop)")
|
||||||
|
# define pb_packed
|
||||||
|
#elif defined(_MSC_VER) && (_MSC_VER >= 1500)
|
||||||
|
/* For Microsoft Visual C++ */
|
||||||
|
# define PB_PACKED_STRUCT_START __pragma(pack(push, 1))
|
||||||
|
# define PB_PACKED_STRUCT_END __pragma(pack(pop))
|
||||||
|
# define pb_packed
|
||||||
|
#else
|
||||||
|
/* Unknown compiler */
|
||||||
|
# define PB_PACKED_STRUCT_START
|
||||||
|
# define PB_PACKED_STRUCT_END
|
||||||
|
# define pb_packed
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Handly macro for suppressing unreferenced-parameter compiler warnings. */
|
||||||
#ifndef UNUSED
|
#ifndef UNUSED
|
||||||
#define UNUSED(x) (void)(x)
|
#define UNUSED(x) (void)(x)
|
||||||
#endif
|
#endif
|
||||||
@@ -33,8 +104,7 @@
|
|||||||
#define STATIC_ASSERT_MSG_(MSG, LINE, COUNTER) static_assertion_##MSG##LINE##COUNTER
|
#define STATIC_ASSERT_MSG_(MSG, LINE, COUNTER) static_assertion_##MSG##LINE##COUNTER
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* Number of required fields to keep track of
|
/* Number of required fields to keep track of. */
|
||||||
* (change here or on compiler command line). */
|
|
||||||
#ifndef PB_MAX_REQUIRED_FIELDS
|
#ifndef PB_MAX_REQUIRED_FIELDS
|
||||||
#define PB_MAX_REQUIRED_FIELDS 64
|
#define PB_MAX_REQUIRED_FIELDS 64
|
||||||
#endif
|
#endif
|
||||||
@@ -55,9 +125,7 @@
|
|||||||
|
|
||||||
typedef uint8_t pb_type_t;
|
typedef uint8_t pb_type_t;
|
||||||
|
|
||||||
/************************
|
/**** Field data types ****/
|
||||||
* Field contents types *
|
|
||||||
************************/
|
|
||||||
|
|
||||||
/* Numeric types */
|
/* Numeric types */
|
||||||
#define PB_LTYPE_VARINT 0x00 /* int32, uint32, int64, uint64, bool, enum */
|
#define PB_LTYPE_VARINT 0x00 /* int32, uint32, int64, uint64, bool, enum */
|
||||||
@@ -80,22 +148,22 @@ typedef uint8_t pb_type_t;
|
|||||||
* submsg_fields is pointer to field descriptions */
|
* submsg_fields is pointer to field descriptions */
|
||||||
#define PB_LTYPE_SUBMESSAGE 0x06
|
#define PB_LTYPE_SUBMESSAGE 0x06
|
||||||
|
|
||||||
|
/* Extension pseudo-field
|
||||||
|
* The field contains a pointer to pb_extension_t */
|
||||||
|
#define PB_LTYPE_EXTENSION 0x07
|
||||||
|
|
||||||
/* Number of declared LTYPES */
|
/* Number of declared LTYPES */
|
||||||
#define PB_LTYPES_COUNT 7
|
#define PB_LTYPES_COUNT 8
|
||||||
#define PB_LTYPE_MASK 0x0F
|
#define PB_LTYPE_MASK 0x0F
|
||||||
|
|
||||||
/**************************
|
/**** Field repetition rules ****/
|
||||||
* Field repetition rules *
|
|
||||||
**************************/
|
|
||||||
|
|
||||||
#define PB_HTYPE_REQUIRED 0x00
|
#define PB_HTYPE_REQUIRED 0x00
|
||||||
#define PB_HTYPE_OPTIONAL 0x10
|
#define PB_HTYPE_OPTIONAL 0x10
|
||||||
#define PB_HTYPE_REPEATED 0x20
|
#define PB_HTYPE_REPEATED 0x20
|
||||||
#define PB_HTYPE_MASK 0x30
|
#define PB_HTYPE_MASK 0x30
|
||||||
|
|
||||||
/********************
|
/**** Field allocation types ****/
|
||||||
* Allocation types *
|
|
||||||
********************/
|
|
||||||
|
|
||||||
#define PB_ATYPE_STATIC 0x00
|
#define PB_ATYPE_STATIC 0x00
|
||||||
#define PB_ATYPE_CALLBACK 0x40
|
#define PB_ATYPE_CALLBACK 0x40
|
||||||
@@ -113,6 +181,7 @@ typedef uint8_t pb_type_t;
|
|||||||
* structures. Fix that by defining PB_FIELD_16BIT or
|
* structures. Fix that by defining PB_FIELD_16BIT or
|
||||||
* PB_FIELD_32BIT.
|
* PB_FIELD_32BIT.
|
||||||
*/
|
*/
|
||||||
|
PB_PACKED_STRUCT_START
|
||||||
typedef struct _pb_field_t pb_field_t;
|
typedef struct _pb_field_t pb_field_t;
|
||||||
struct _pb_field_t {
|
struct _pb_field_t {
|
||||||
|
|
||||||
@@ -144,6 +213,18 @@ struct _pb_field_t {
|
|||||||
* If null, then field will zeroed. */
|
* If null, then field will zeroed. */
|
||||||
const void *ptr;
|
const void *ptr;
|
||||||
} pb_packed;
|
} pb_packed;
|
||||||
|
PB_PACKED_STRUCT_END
|
||||||
|
|
||||||
|
/* Make sure that the standard integer types are of the expected sizes.
|
||||||
|
* All kinds of things may break otherwise.. atleast all fixed* types. */
|
||||||
|
STATIC_ASSERT(sizeof(int8_t) == 1, INT8_T_WRONG_SIZE)
|
||||||
|
STATIC_ASSERT(sizeof(uint8_t) == 1, UINT8_T_WRONG_SIZE)
|
||||||
|
STATIC_ASSERT(sizeof(int16_t) == 2, INT16_T_WRONG_SIZE)
|
||||||
|
STATIC_ASSERT(sizeof(uint16_t) == 2, UINT16_T_WRONG_SIZE)
|
||||||
|
STATIC_ASSERT(sizeof(int32_t) == 4, INT32_T_WRONG_SIZE)
|
||||||
|
STATIC_ASSERT(sizeof(uint32_t) == 4, UINT32_T_WRONG_SIZE)
|
||||||
|
STATIC_ASSERT(sizeof(int64_t) == 8, INT64_T_WRONG_SIZE)
|
||||||
|
STATIC_ASSERT(sizeof(uint64_t) == 8, UINT64_T_WRONG_SIZE)
|
||||||
|
|
||||||
/* This structure is used for 'bytes' arrays.
|
/* This structure is used for 'bytes' arrays.
|
||||||
* It has the number of bytes in the beginning, and after that an array.
|
* It has the number of bytes in the beginning, and after that an array.
|
||||||
@@ -178,10 +259,19 @@ 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_callback_t pb_callback_t;
|
typedef struct _pb_callback_t pb_callback_t;
|
||||||
struct _pb_callback_t {
|
struct _pb_callback_t {
|
||||||
|
#ifdef PB_OLD_CALLBACK_STYLE
|
||||||
|
/* Deprecated since nanopb-0.2.1 */
|
||||||
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);
|
||||||
} funcs;
|
} funcs;
|
||||||
|
#else
|
||||||
|
/* New function signature, which allows modifying arg contents in callback. */
|
||||||
|
union {
|
||||||
|
bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg);
|
||||||
|
bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg);
|
||||||
|
} funcs;
|
||||||
|
#endif
|
||||||
|
|
||||||
/* Free arg for use by callback */
|
/* Free arg for use by callback */
|
||||||
void *arg;
|
void *arg;
|
||||||
@@ -195,11 +285,56 @@ typedef enum {
|
|||||||
PB_WT_32BIT = 5
|
PB_WT_32BIT = 5
|
||||||
} pb_wire_type_t;
|
} pb_wire_type_t;
|
||||||
|
|
||||||
|
/* Structure for defining the handling of unknown/extension fields.
|
||||||
|
* Usually the pb_extension_type_t structure is automatically generated,
|
||||||
|
* while the pb_extension_t structure is created by the user. However,
|
||||||
|
* if you want to catch all unknown fields, you can also create a custom
|
||||||
|
* pb_extension_type_t with your own callback.
|
||||||
|
*/
|
||||||
|
typedef struct _pb_extension_type_t pb_extension_type_t;
|
||||||
|
typedef struct _pb_extension_t pb_extension_t;
|
||||||
|
struct _pb_extension_type_t {
|
||||||
|
/* Called for each unknown field in the message.
|
||||||
|
* If you handle the field, read off all of its data and return true.
|
||||||
|
* If you do not handle the field, do not read anything and return true.
|
||||||
|
* If you run into an error, return false.
|
||||||
|
* Set to NULL for default handler.
|
||||||
|
*/
|
||||||
|
bool (*decode)(pb_istream_t *stream, pb_extension_t *extension,
|
||||||
|
uint32_t tag, pb_wire_type_t wire_type);
|
||||||
|
|
||||||
|
/* Called once after all regular fields have been encoded.
|
||||||
|
* If you have something to write, do so and return true.
|
||||||
|
* If you do not have anything to write, just return true.
|
||||||
|
* If you run into an error, return false.
|
||||||
|
* Set to NULL for default handler.
|
||||||
|
*/
|
||||||
|
bool (*encode)(pb_ostream_t *stream, const pb_extension_t *extension);
|
||||||
|
|
||||||
|
/* Free field for use by the callback. */
|
||||||
|
const void *arg;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct _pb_extension_t {
|
||||||
|
/* Type describing the extension field. Usually you'll initialize
|
||||||
|
* this to a pointer to the automatically generated structure. */
|
||||||
|
const pb_extension_type_t *type;
|
||||||
|
|
||||||
|
/* Destination for the decoded data. This must match the datatype
|
||||||
|
* of the extension field. */
|
||||||
|
void *dest;
|
||||||
|
|
||||||
|
/* Pointer to the next extension handler, or NULL.
|
||||||
|
* If this extension does not match a field, the next handler is
|
||||||
|
* automatically called. */
|
||||||
|
pb_extension_t *next;
|
||||||
|
};
|
||||||
|
|
||||||
/* These macros are used to declare pb_field_t's in the constant array. */
|
/* These macros are used to declare pb_field_t's in the constant array. */
|
||||||
#define pb_membersize(st, m) (sizeof ((st*)0)->m)
|
#define pb_membersize(st, m) (sizeof ((st*)0)->m)
|
||||||
#define pb_arraysize(st, m) (pb_membersize(st, m) / pb_membersize(st, m[0]))
|
#define pb_arraysize(st, m) (pb_membersize(st, m) / pb_membersize(st, m[0]))
|
||||||
#define pb_delta(st, m1, m2) ((int)offsetof(st, m1) - (int)offsetof(st, m2))
|
#define pb_delta(st, m1, m2) ((int)offsetof(st, m1) - (int)offsetof(st, m2))
|
||||||
#define pb_delta_end(st, m1, m2) (offsetof(st, m1) == offsetof(st, m2) \
|
#define pb_delta_end(st, m1, m2) (int)(offsetof(st, m1) == offsetof(st, m2) \
|
||||||
? offsetof(st, m1) \
|
? offsetof(st, m1) \
|
||||||
: offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
|
: offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
|
||||||
#define PB_LAST_FIELD {0,(pb_type_t) 0,0,0,0,0,0}
|
#define PB_LAST_FIELD {0,(pb_type_t) 0,0,0,0,0,0}
|
||||||
@@ -240,6 +375,17 @@ typedef enum {
|
|||||||
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_REPEATED | ltype, \
|
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_REPEATED | ltype, \
|
||||||
pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
|
pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
|
||||||
|
|
||||||
|
/* Optional extensions don't have the has_ field, as that would be redundant. */
|
||||||
|
#define PB_OPTEXT_STATIC(tag, st, m, pm, ltype, ptr) \
|
||||||
|
{tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
|
||||||
|
0, \
|
||||||
|
0, \
|
||||||
|
pb_membersize(st, m), 0, ptr}
|
||||||
|
|
||||||
|
#define PB_OPTEXT_CALLBACK(tag, st, m, pm, ltype, ptr) \
|
||||||
|
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
|
||||||
|
0, 0, pb_membersize(st, m), 0, ptr}
|
||||||
|
|
||||||
/* The mapping from protobuf types to LTYPEs is done using these macros. */
|
/* The mapping from protobuf types to LTYPEs is done using these macros. */
|
||||||
#define PB_LTYPE_MAP_BOOL PB_LTYPE_VARINT
|
#define PB_LTYPE_MAP_BOOL PB_LTYPE_VARINT
|
||||||
#define PB_LTYPE_MAP_BYTES PB_LTYPE_BYTES
|
#define PB_LTYPE_MAP_BYTES PB_LTYPE_BYTES
|
||||||
@@ -258,13 +404,14 @@ typedef enum {
|
|||||||
#define PB_LTYPE_MAP_STRING PB_LTYPE_STRING
|
#define PB_LTYPE_MAP_STRING PB_LTYPE_STRING
|
||||||
#define PB_LTYPE_MAP_UINT32 PB_LTYPE_VARINT
|
#define PB_LTYPE_MAP_UINT32 PB_LTYPE_VARINT
|
||||||
#define PB_LTYPE_MAP_UINT64 PB_LTYPE_VARINT
|
#define PB_LTYPE_MAP_UINT64 PB_LTYPE_VARINT
|
||||||
|
#define PB_LTYPE_MAP_EXTENSION PB_LTYPE_EXTENSION
|
||||||
|
|
||||||
/* This is the actual macro used in field descriptions.
|
/* This is the actual macro used in field descriptions.
|
||||||
* It takes these arguments:
|
* It takes these arguments:
|
||||||
* - Field tag number
|
* - Field tag number
|
||||||
* - Field type: BOOL, BYTES, DOUBLE, ENUM, FIXED32, FIXED64,
|
* - Field type: BOOL, BYTES, DOUBLE, ENUM, FIXED32, FIXED64,
|
||||||
* FLOAT, INT32, INT64, MESSAGE, SFIXED32, SFIXED64
|
* FLOAT, INT32, INT64, MESSAGE, SFIXED32, SFIXED64
|
||||||
* SINT32, SINT64, STRING, UINT32 or UINT64
|
* SINT32, SINT64, STRING, UINT32, UINT64 or EXTENSION
|
||||||
* - Field rules: REQUIRED, OPTIONAL or REPEATED
|
* - Field rules: REQUIRED, OPTIONAL or REPEATED
|
||||||
* - Allocation: STATIC or CALLBACK
|
* - Allocation: STATIC or CALLBACK
|
||||||
* - Message name
|
* - Message name
|
||||||
@@ -277,6 +424,7 @@ typedef enum {
|
|||||||
PB_ ## rules ## _ ## allocation(tag, message, field, prevfield, \
|
PB_ ## rules ## _ ## allocation(tag, message, field, prevfield, \
|
||||||
PB_LTYPE_MAP_ ## type, ptr)
|
PB_LTYPE_MAP_ ## type, ptr)
|
||||||
|
|
||||||
|
|
||||||
/* These macros are used for giving out error messages.
|
/* These macros are used for giving out error messages.
|
||||||
* They are mostly a debugging aid; the main error information
|
* They are mostly a debugging aid; the main error information
|
||||||
* is the true/false return value from functions.
|
* is the true/false return value from functions.
|
||||||
|
|||||||
205
pb_decode.c
205
pb_decode.c
@@ -14,7 +14,6 @@
|
|||||||
#define NANOPB_INTERNALS
|
#define NANOPB_INTERNALS
|
||||||
#include "pb.h"
|
#include "pb.h"
|
||||||
#include "pb_decode.h"
|
#include "pb_decode.h"
|
||||||
#include <string.h>
|
|
||||||
|
|
||||||
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;
|
||||||
|
|
||||||
@@ -29,7 +28,8 @@ static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
|
|||||||
|
|
||||||
&pb_dec_bytes,
|
&pb_dec_bytes,
|
||||||
&pb_dec_string,
|
&pb_dec_string,
|
||||||
&pb_dec_submessage
|
&pb_dec_submessage,
|
||||||
|
NULL /* extensions */
|
||||||
};
|
};
|
||||||
|
|
||||||
/**************
|
/**************
|
||||||
@@ -280,7 +280,7 @@ void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream)
|
|||||||
/* Iterator for pb_field_t list */
|
/* Iterator for pb_field_t list */
|
||||||
typedef struct {
|
typedef struct {
|
||||||
const pb_field_t *start; /* Start of the pb_field_t array */
|
const pb_field_t *start; /* Start of the pb_field_t array */
|
||||||
const pb_field_t *current; /* Current position of the iterator */
|
const pb_field_t *pos; /* Current position of the iterator */
|
||||||
unsigned field_index; /* Zero-based index of the field. */
|
unsigned field_index; /* Zero-based index of the field. */
|
||||||
unsigned required_field_index; /* Zero-based index that counts only the required fields */
|
unsigned required_field_index; /* Zero-based index that counts only the required fields */
|
||||||
void *dest_struct; /* Pointer to the destination structure to decode to */
|
void *dest_struct; /* Pointer to the destination structure to decode to */
|
||||||
@@ -290,33 +290,36 @@ typedef struct {
|
|||||||
|
|
||||||
static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct)
|
static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct)
|
||||||
{
|
{
|
||||||
iter->start = iter->current = fields;
|
iter->start = iter->pos = fields;
|
||||||
iter->field_index = 0;
|
iter->field_index = 0;
|
||||||
iter->required_field_index = 0;
|
iter->required_field_index = 0;
|
||||||
iter->pData = (char*)dest_struct + iter->current->data_offset;
|
iter->pData = (char*)dest_struct + iter->pos->data_offset;
|
||||||
iter->pSize = (char*)iter->pData + iter->current->size_offset;
|
iter->pSize = (char*)iter->pData + iter->pos->size_offset;
|
||||||
iter->dest_struct = dest_struct;
|
iter->dest_struct = dest_struct;
|
||||||
}
|
}
|
||||||
|
|
||||||
static bool pb_field_next(pb_field_iterator_t *iter)
|
static bool pb_field_next(pb_field_iterator_t *iter)
|
||||||
{
|
{
|
||||||
bool notwrapped = true;
|
bool notwrapped = true;
|
||||||
size_t prev_size = iter->current->data_size;
|
size_t prev_size = iter->pos->data_size;
|
||||||
|
|
||||||
if (PB_ATYPE(iter->current->type) == PB_ATYPE_STATIC &&
|
if (PB_ATYPE(iter->pos->type) == PB_ATYPE_STATIC &&
|
||||||
PB_HTYPE(iter->current->type) == PB_HTYPE_REPEATED)
|
PB_HTYPE(iter->pos->type) == PB_HTYPE_REPEATED)
|
||||||
{
|
{
|
||||||
prev_size *= iter->current->array_size;
|
prev_size *= iter->pos->array_size;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (PB_HTYPE(iter->current->type) == PB_HTYPE_REQUIRED)
|
if (iter->pos->tag == 0)
|
||||||
|
return false; /* Only happens with empty message types */
|
||||||
|
|
||||||
|
if (PB_HTYPE(iter->pos->type) == PB_HTYPE_REQUIRED)
|
||||||
iter->required_field_index++;
|
iter->required_field_index++;
|
||||||
|
|
||||||
iter->current++;
|
iter->pos++;
|
||||||
iter->field_index++;
|
iter->field_index++;
|
||||||
if (iter->current->tag == 0)
|
if (iter->pos->tag == 0)
|
||||||
{
|
{
|
||||||
iter->current = iter->start;
|
iter->pos = iter->start;
|
||||||
iter->field_index = 0;
|
iter->field_index = 0;
|
||||||
iter->required_field_index = 0;
|
iter->required_field_index = 0;
|
||||||
iter->pData = iter->dest_struct;
|
iter->pData = iter->dest_struct;
|
||||||
@@ -324,8 +327,8 @@ static bool pb_field_next(pb_field_iterator_t *iter)
|
|||||||
notwrapped = false;
|
notwrapped = false;
|
||||||
}
|
}
|
||||||
|
|
||||||
iter->pData = (char*)iter->pData + prev_size + iter->current->data_offset;
|
iter->pData = (char*)iter->pData + prev_size + iter->pos->data_offset;
|
||||||
iter->pSize = (char*)iter->pData + iter->current->size_offset;
|
iter->pSize = (char*)iter->pData + iter->pos->size_offset;
|
||||||
return notwrapped;
|
return notwrapped;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -334,8 +337,11 @@ static bool checkreturn pb_field_find(pb_field_iterator_t *iter, uint32_t tag)
|
|||||||
unsigned start = iter->field_index;
|
unsigned start = iter->field_index;
|
||||||
|
|
||||||
do {
|
do {
|
||||||
if (iter->current->tag == tag)
|
if (iter->pos->tag == tag &&
|
||||||
|
PB_LTYPE(iter->pos->type) != PB_LTYPE_EXTENSION)
|
||||||
|
{
|
||||||
return true;
|
return true;
|
||||||
|
}
|
||||||
pb_field_next(iter);
|
pb_field_next(iter);
|
||||||
} while (iter->field_index != start);
|
} while (iter->field_index != start);
|
||||||
|
|
||||||
@@ -351,17 +357,17 @@ static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t
|
|||||||
pb_type_t type;
|
pb_type_t type;
|
||||||
pb_decoder_t func;
|
pb_decoder_t func;
|
||||||
|
|
||||||
type = iter->current->type;
|
type = iter->pos->type;
|
||||||
func = PB_DECODERS[PB_LTYPE(type)];
|
func = PB_DECODERS[PB_LTYPE(type)];
|
||||||
|
|
||||||
switch (PB_HTYPE(type))
|
switch (PB_HTYPE(type))
|
||||||
{
|
{
|
||||||
case PB_HTYPE_REQUIRED:
|
case PB_HTYPE_REQUIRED:
|
||||||
return func(stream, iter->current, iter->pData);
|
return func(stream, iter->pos, iter->pData);
|
||||||
|
|
||||||
case PB_HTYPE_OPTIONAL:
|
case PB_HTYPE_OPTIONAL:
|
||||||
*(bool*)iter->pSize = true;
|
*(bool*)iter->pSize = true;
|
||||||
return func(stream, iter->current, iter->pData);
|
return func(stream, iter->pos, iter->pData);
|
||||||
|
|
||||||
case PB_HTYPE_REPEATED:
|
case PB_HTYPE_REPEATED:
|
||||||
if (wire_type == PB_WT_STRING
|
if (wire_type == PB_WT_STRING
|
||||||
@@ -374,10 +380,10 @@ static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t
|
|||||||
if (!pb_make_string_substream(stream, &substream))
|
if (!pb_make_string_substream(stream, &substream))
|
||||||
return false;
|
return false;
|
||||||
|
|
||||||
while (substream.bytes_left && *size < iter->current->array_size)
|
while (substream.bytes_left && *size < iter->pos->array_size)
|
||||||
{
|
{
|
||||||
void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
|
void *pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size);
|
||||||
if (!func(&substream, iter->current, pItem))
|
if (!func(&substream, iter->pos, pItem))
|
||||||
{
|
{
|
||||||
status = false;
|
status = false;
|
||||||
break;
|
break;
|
||||||
@@ -395,12 +401,12 @@ static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t
|
|||||||
{
|
{
|
||||||
/* Repeated field */
|
/* Repeated field */
|
||||||
size_t *size = (size_t*)iter->pSize;
|
size_t *size = (size_t*)iter->pSize;
|
||||||
void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
|
void *pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size);
|
||||||
if (*size >= iter->current->array_size)
|
if (*size >= iter->pos->array_size)
|
||||||
PB_RETURN_ERROR(stream, "array overflow");
|
PB_RETURN_ERROR(stream, "array overflow");
|
||||||
|
|
||||||
(*size)++;
|
(*size)++;
|
||||||
return func(stream, iter->current, pItem);
|
return func(stream, iter->pos, pItem);
|
||||||
}
|
}
|
||||||
|
|
||||||
default:
|
default:
|
||||||
@@ -412,6 +418,12 @@ static bool checkreturn decode_callback_field(pb_istream_t *stream, pb_wire_type
|
|||||||
{
|
{
|
||||||
pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
|
pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
|
||||||
|
|
||||||
|
#ifdef PB_OLD_CALLBACK_STYLE
|
||||||
|
void *arg = pCallback->arg;
|
||||||
|
#else
|
||||||
|
void **arg = &(pCallback->arg);
|
||||||
|
#endif
|
||||||
|
|
||||||
if (pCallback->funcs.decode == NULL)
|
if (pCallback->funcs.decode == NULL)
|
||||||
return pb_skip_field(stream, wire_type);
|
return pb_skip_field(stream, wire_type);
|
||||||
|
|
||||||
@@ -422,11 +434,11 @@ static bool checkreturn decode_callback_field(pb_istream_t *stream, pb_wire_type
|
|||||||
if (!pb_make_string_substream(stream, &substream))
|
if (!pb_make_string_substream(stream, &substream))
|
||||||
return false;
|
return false;
|
||||||
|
|
||||||
while (substream.bytes_left)
|
do
|
||||||
{
|
{
|
||||||
if (!pCallback->funcs.decode(&substream, iter->current, pCallback->arg))
|
if (!pCallback->funcs.decode(&substream, iter->pos, arg))
|
||||||
PB_RETURN_ERROR(stream, "callback failed");
|
PB_RETURN_ERROR(stream, "callback failed");
|
||||||
}
|
} while (substream.bytes_left);
|
||||||
|
|
||||||
pb_close_string_substream(stream, &substream);
|
pb_close_string_substream(stream, &substream);
|
||||||
return true;
|
return true;
|
||||||
@@ -445,13 +457,13 @@ static bool checkreturn decode_callback_field(pb_istream_t *stream, pb_wire_type
|
|||||||
return false;
|
return false;
|
||||||
substream = pb_istream_from_buffer(buffer, size);
|
substream = pb_istream_from_buffer(buffer, size);
|
||||||
|
|
||||||
return pCallback->funcs.decode(&substream, iter->current, pCallback->arg);
|
return pCallback->funcs.decode(&substream, iter->pos, arg);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
|
static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
|
||||||
{
|
{
|
||||||
switch (PB_ATYPE(iter->current->type))
|
switch (PB_ATYPE(iter->pos->type))
|
||||||
{
|
{
|
||||||
case PB_ATYPE_STATIC:
|
case PB_ATYPE_STATIC:
|
||||||
return decode_static_field(stream, wire_type, iter);
|
return decode_static_field(stream, wire_type, iter);
|
||||||
@@ -464,6 +476,70 @@ static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_t
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Default handler for extension fields. Expects a pb_field_t structure
|
||||||
|
* in extension->type->arg. */
|
||||||
|
static bool checkreturn default_extension_handler(pb_istream_t *stream,
|
||||||
|
pb_extension_t *extension, uint32_t tag, pb_wire_type_t wire_type)
|
||||||
|
{
|
||||||
|
const pb_field_t *field = (const pb_field_t*)extension->type->arg;
|
||||||
|
pb_field_iterator_t iter;
|
||||||
|
bool dummy;
|
||||||
|
|
||||||
|
if (field->tag != tag)
|
||||||
|
return true;
|
||||||
|
|
||||||
|
iter.start = field;
|
||||||
|
iter.pos = field;
|
||||||
|
iter.field_index = 0;
|
||||||
|
iter.required_field_index = 0;
|
||||||
|
iter.dest_struct = extension->dest;
|
||||||
|
iter.pData = extension->dest;
|
||||||
|
iter.pSize = &dummy;
|
||||||
|
|
||||||
|
return decode_field(stream, wire_type, &iter);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Try to decode an unknown field as an extension field. Tries each extension
|
||||||
|
* decoder in turn, until one of them handles the field or loop ends. */
|
||||||
|
static bool checkreturn decode_extension(pb_istream_t *stream,
|
||||||
|
uint32_t tag, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
|
||||||
|
{
|
||||||
|
pb_extension_t *extension = *(pb_extension_t* const *)iter->pData;
|
||||||
|
size_t pos = stream->bytes_left;
|
||||||
|
|
||||||
|
while (extension && pos == stream->bytes_left)
|
||||||
|
{
|
||||||
|
bool status;
|
||||||
|
if (extension->type->decode)
|
||||||
|
status = extension->type->decode(stream, extension, tag, wire_type);
|
||||||
|
else
|
||||||
|
status = default_extension_handler(stream, extension, tag, wire_type);
|
||||||
|
|
||||||
|
if (!status)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
extension = extension->next;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Step through the iterator until an extension field is found or until all
|
||||||
|
* entries have been checked. There can be only one extension field per
|
||||||
|
* message. Returns false if no extension field is found. */
|
||||||
|
static bool checkreturn find_extension_field(pb_field_iterator_t *iter)
|
||||||
|
{
|
||||||
|
unsigned start = iter->field_index;
|
||||||
|
|
||||||
|
do {
|
||||||
|
if (PB_LTYPE(iter->pos->type) == PB_LTYPE_EXTENSION)
|
||||||
|
return true;
|
||||||
|
pb_field_next(iter);
|
||||||
|
} while (iter->field_index != start);
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
/* Initialize message fields to default values, recursively */
|
/* Initialize message fields to default values, recursively */
|
||||||
static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct)
|
static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct)
|
||||||
{
|
{
|
||||||
@@ -474,9 +550,9 @@ static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_str
|
|||||||
do
|
do
|
||||||
{
|
{
|
||||||
pb_type_t type;
|
pb_type_t type;
|
||||||
type = iter.current->type;
|
type = iter.pos->type;
|
||||||
|
|
||||||
if (iter.current->tag == 0)
|
if (iter.pos->tag == 0)
|
||||||
continue;
|
continue;
|
||||||
|
|
||||||
if (PB_ATYPE(type) == PB_ATYPE_STATIC)
|
if (PB_ATYPE(type) == PB_ATYPE_STATIC)
|
||||||
@@ -493,17 +569,17 @@ static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_str
|
|||||||
}
|
}
|
||||||
|
|
||||||
/* Initialize field contents to default value */
|
/* Initialize field contents to default value */
|
||||||
if (PB_LTYPE(iter.current->type) == PB_LTYPE_SUBMESSAGE)
|
if (PB_LTYPE(iter.pos->type) == PB_LTYPE_SUBMESSAGE)
|
||||||
{
|
{
|
||||||
pb_message_set_to_defaults((const pb_field_t *) iter.current->ptr, iter.pData);
|
pb_message_set_to_defaults((const pb_field_t *) iter.pos->ptr, iter.pData);
|
||||||
}
|
}
|
||||||
else if (iter.current->ptr != NULL)
|
else if (iter.pos->ptr != NULL)
|
||||||
{
|
{
|
||||||
memcpy(iter.pData, iter.current->ptr, iter.current->data_size);
|
memcpy(iter.pData, iter.pos->ptr, iter.pos->data_size);
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
memset(iter.pData, 0, iter.current->data_size);
|
memset(iter.pData, 0, iter.pos->data_size);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
else if (PB_ATYPE(type) == PB_ATYPE_CALLBACK)
|
else if (PB_ATYPE(type) == PB_ATYPE_CALLBACK)
|
||||||
@@ -520,6 +596,7 @@ static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_str
|
|||||||
bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
|
bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
|
||||||
{
|
{
|
||||||
uint8_t fields_seen[(PB_MAX_REQUIRED_FIELDS + 7) / 8] = {0}; /* Used to check for required fields */
|
uint8_t fields_seen[(PB_MAX_REQUIRED_FIELDS + 7) / 8] = {0}; /* Used to check for required fields */
|
||||||
|
uint32_t extension_range_start = 0;
|
||||||
pb_field_iterator_t iter;
|
pb_field_iterator_t iter;
|
||||||
|
|
||||||
pb_field_init(&iter, fields, dest_struct);
|
pb_field_init(&iter, fields, dest_struct);
|
||||||
@@ -540,13 +617,36 @@ bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[
|
|||||||
|
|
||||||
if (!pb_field_find(&iter, tag))
|
if (!pb_field_find(&iter, tag))
|
||||||
{
|
{
|
||||||
|
/* No match found, check if it matches an extension. */
|
||||||
|
if (tag >= extension_range_start)
|
||||||
|
{
|
||||||
|
if (!find_extension_field(&iter))
|
||||||
|
extension_range_start = (uint32_t)-1;
|
||||||
|
else
|
||||||
|
extension_range_start = iter.pos->tag;
|
||||||
|
|
||||||
|
if (tag >= extension_range_start)
|
||||||
|
{
|
||||||
|
size_t pos = stream->bytes_left;
|
||||||
|
|
||||||
|
if (!decode_extension(stream, tag, wire_type, &iter))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (pos != stream->bytes_left)
|
||||||
|
{
|
||||||
|
/* The field was handled */
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/* No match found, skip data */
|
/* No match found, skip data */
|
||||||
if (!pb_skip_field(stream, wire_type))
|
if (!pb_skip_field(stream, wire_type))
|
||||||
return false;
|
return false;
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (PB_HTYPE(iter.current->type) == PB_HTYPE_REQUIRED
|
if (PB_HTYPE(iter.pos->type) == PB_HTYPE_REQUIRED
|
||||||
&& iter.required_field_index < PB_MAX_REQUIRED_FIELDS)
|
&& iter.required_field_index < PB_MAX_REQUIRED_FIELDS)
|
||||||
{
|
{
|
||||||
fields_seen[iter.required_field_index >> 3] |= (uint8_t)(1 << (iter.required_field_index & 7));
|
fields_seen[iter.required_field_index >> 3] |= (uint8_t)(1 << (iter.required_field_index & 7));
|
||||||
@@ -567,11 +667,11 @@ bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[
|
|||||||
unsigned i;
|
unsigned i;
|
||||||
do {
|
do {
|
||||||
req_field_count = iter.required_field_index;
|
req_field_count = iter.required_field_index;
|
||||||
last_type = iter.current->type;
|
last_type = iter.pos->type;
|
||||||
} while (pb_field_next(&iter));
|
} while (pb_field_next(&iter));
|
||||||
|
|
||||||
/* Fixup if last field was also required. */
|
/* Fixup if last field was also required. */
|
||||||
if (PB_HTYPE(last_type) == PB_HTYPE_REQUIRED)
|
if (PB_HTYPE(last_type) == PB_HTYPE_REQUIRED && iter.pos->tag)
|
||||||
req_field_count++;
|
req_field_count++;
|
||||||
|
|
||||||
/* Check the whole bytes */
|
/* Check the whole bytes */
|
||||||
@@ -595,6 +695,19 @@ bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void
|
|||||||
return pb_decode_noinit(stream, fields, dest_struct);
|
return pb_decode_noinit(stream, fields, dest_struct);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
|
||||||
|
{
|
||||||
|
pb_istream_t substream;
|
||||||
|
bool status;
|
||||||
|
|
||||||
|
if (!pb_make_string_substream(stream, &substream))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
status = pb_decode(&substream, fields, dest_struct);
|
||||||
|
pb_close_string_substream(stream, &substream);
|
||||||
|
return status;
|
||||||
|
}
|
||||||
|
|
||||||
/* Field decoders */
|
/* Field decoders */
|
||||||
|
|
||||||
bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
|
bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
|
||||||
@@ -656,7 +769,8 @@ bool pb_decode_fixed64(pb_istream_t *stream, void *dest)
|
|||||||
bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
|
bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
|
||||||
{
|
{
|
||||||
uint64_t value;
|
uint64_t value;
|
||||||
bool status = pb_decode_varint(stream, &value);
|
if (!pb_decode_varint(stream, &value))
|
||||||
|
return false;
|
||||||
|
|
||||||
switch (field->data_size)
|
switch (field->data_size)
|
||||||
{
|
{
|
||||||
@@ -667,13 +781,14 @@ bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, vo
|
|||||||
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
||||||
}
|
}
|
||||||
|
|
||||||
return status;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
|
bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
|
||||||
{
|
{
|
||||||
int64_t value;
|
int64_t value;
|
||||||
bool status = pb_decode_svarint(stream, &value);
|
if (!pb_decode_svarint(stream, &value))
|
||||||
|
return false;
|
||||||
|
|
||||||
switch (field->data_size)
|
switch (field->data_size)
|
||||||
{
|
{
|
||||||
@@ -682,7 +797,7 @@ bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, v
|
|||||||
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
||||||
}
|
}
|
||||||
|
|
||||||
return status;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest)
|
bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest)
|
||||||
|
|||||||
89
pb_decode.h
89
pb_decode.h
@@ -1,34 +1,29 @@
|
|||||||
|
/* pb_decode.h: Functions to decode protocol buffers. Depends on pb_decode.c.
|
||||||
|
* The main function is pb_decode. You also need an input stream, and the
|
||||||
|
* field descriptions created by nanopb_generator.py.
|
||||||
|
*/
|
||||||
|
|
||||||
#ifndef _PB_DECODE_H_
|
#ifndef _PB_DECODE_H_
|
||||||
#define _PB_DECODE_H_
|
#define _PB_DECODE_H_
|
||||||
|
|
||||||
/* pb_decode.h: Functions to decode protocol buffers. Depends on pb_decode.c.
|
|
||||||
* The main function is pb_decode. You will also need to create an input
|
|
||||||
* stream, which is easiest to do with pb_istream_from_buffer().
|
|
||||||
*
|
|
||||||
* You also need structures and their corresponding pb_field_t descriptions.
|
|
||||||
* These are usually generated from .proto-files with a script.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <stdbool.h>
|
|
||||||
#include "pb.h"
|
#include "pb.h"
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* Lightweight input stream.
|
/* Structure for defining custom input streams. You will need to provide
|
||||||
* You can provide a callback function for reading or use
|
* a callback function to read the bytes from your storage, which can be
|
||||||
* pb_istream_from_buffer.
|
* for example a file or a network socket.
|
||||||
|
*
|
||||||
|
* The callback must conform to these rules:
|
||||||
*
|
*
|
||||||
* Rules for callback:
|
|
||||||
* 1) Return false on IO errors. This will cause decoding to abort.
|
* 1) Return false on IO errors. This will cause decoding to abort.
|
||||||
*
|
|
||||||
* 2) You can use state to store your own data (e.g. buffer pointer),
|
* 2) You can use state to store your own data (e.g. buffer pointer),
|
||||||
* and rely on pb_read to verify that no-body reads past bytes_left.
|
* and rely on pb_read to verify that no-body reads past bytes_left.
|
||||||
*
|
|
||||||
* 3) Your callback may be used with substreams, in which case bytes_left
|
* 3) Your callback may be used with substreams, in which case bytes_left
|
||||||
* is different than from the main stream. Don't use bytes_left to compute
|
* is different than from the main stream. Don't use bytes_left to compute
|
||||||
* any pointers.
|
* any pointers.
|
||||||
*/
|
*/
|
||||||
struct _pb_istream_t
|
struct _pb_istream_t
|
||||||
{
|
{
|
||||||
@@ -50,24 +45,64 @@ struct _pb_istream_t
|
|||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
|
/***************************
|
||||||
bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
|
* Main decoding functions *
|
||||||
|
***************************/
|
||||||
|
|
||||||
/* Decode from stream to destination struct.
|
/* Decode a single protocol buffers message from input stream into a C structure.
|
||||||
* 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 fields.
|
* The actual struct pointed to by dest must match the description in fields.
|
||||||
|
* Callback fields of the destination structure must be initialized by caller.
|
||||||
|
* All other fields will be initialized by this function.
|
||||||
|
*
|
||||||
|
* Example usage:
|
||||||
|
* MyMessage msg = {};
|
||||||
|
* uint8_t buffer[64];
|
||||||
|
* pb_istream_t stream;
|
||||||
|
*
|
||||||
|
* // ... read some data into buffer ...
|
||||||
|
*
|
||||||
|
* stream = pb_istream_from_buffer(buffer, count);
|
||||||
|
* pb_decode(&stream, MyMessage_fields, &msg);
|
||||||
*/
|
*/
|
||||||
bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
|
bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
|
||||||
|
|
||||||
/* Same as pb_decode, except does not initialize the destination structure
|
/* Same as pb_decode, except does not initialize the destination structure
|
||||||
* to default values. This is slightly faster if you need no default values
|
* to default values. This is slightly faster if you need no default values
|
||||||
* and just do memset(struct, 0, sizeof(struct)) yourself.
|
* and just do memset(struct, 0, sizeof(struct)) yourself.
|
||||||
|
*
|
||||||
|
* This can also be used for 'merging' two messages, i.e. update only the
|
||||||
|
* fields that exist in the new message.
|
||||||
*/
|
*/
|
||||||
bool pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
|
bool pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
|
||||||
|
|
||||||
/* --- Helper functions ---
|
/* Same as pb_decode, except expects the stream to start with the message size
|
||||||
* You may want to use these from your caller or callbacks.
|
* encoded as varint. Corresponds to parseDelimitedFrom() in Google's
|
||||||
|
* protobuf API.
|
||||||
*/
|
*/
|
||||||
|
bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************
|
||||||
|
* Functions for manipulating streams *
|
||||||
|
**************************************/
|
||||||
|
|
||||||
|
/* Create an input stream for reading from a memory buffer.
|
||||||
|
*
|
||||||
|
* Alternatively, you can use a custom stream that reads directly from e.g.
|
||||||
|
* a file or a network socket.
|
||||||
|
*/
|
||||||
|
pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
|
||||||
|
|
||||||
|
/* Function to read from a pb_istream_t. You can use this if you need to
|
||||||
|
* read some custom header data, or to read data in field callbacks.
|
||||||
|
*/
|
||||||
|
bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
|
||||||
|
|
||||||
|
|
||||||
|
/************************************************
|
||||||
|
* Helper functions for writing field callbacks *
|
||||||
|
************************************************/
|
||||||
|
|
||||||
/* Decode the tag for the next field in the stream. Gives the wire type and
|
/* Decode the tag for the next field in the stream. Gives the wire type and
|
||||||
* field tag. At end of the message, returns false and sets eof to true. */
|
* field tag. At end of the message, returns false and sets eof to true. */
|
||||||
@@ -96,10 +131,10 @@ bool pb_decode_fixed64(pb_istream_t *stream, void *dest);
|
|||||||
bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream);
|
bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream);
|
||||||
void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream);
|
void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream);
|
||||||
|
|
||||||
/* --- 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.
|
* Internal / legacy functions *
|
||||||
*/
|
*******************************/
|
||||||
|
|
||||||
#ifdef NANOPB_INTERNALS
|
#ifdef NANOPB_INTERNALS
|
||||||
bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
||||||
|
|||||||
160
pb_encode.c
160
pb_encode.c
@@ -6,7 +6,6 @@
|
|||||||
#define NANOPB_INTERNALS
|
#define NANOPB_INTERNALS
|
||||||
#include "pb.h"
|
#include "pb.h"
|
||||||
#include "pb_encode.h"
|
#include "pb_encode.h"
|
||||||
#include <string.h>
|
|
||||||
|
|
||||||
/* The warn_unused_result attribute appeared first in gcc-3.4.0 */
|
/* The warn_unused_result attribute appeared first in gcc-3.4.0 */
|
||||||
#if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
|
#if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
|
||||||
@@ -29,7 +28,8 @@ static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
|
|||||||
|
|
||||||
&pb_enc_bytes,
|
&pb_enc_bytes,
|
||||||
&pb_enc_string,
|
&pb_enc_string,
|
||||||
&pb_enc_submessage
|
&pb_enc_submessage,
|
||||||
|
NULL /* extensions */
|
||||||
};
|
};
|
||||||
|
|
||||||
/* pb_ostream_t implementation */
|
/* pb_ostream_t implementation */
|
||||||
@@ -56,6 +56,9 @@ pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize)
|
|||||||
stream.state = buf;
|
stream.state = buf;
|
||||||
stream.max_size = bufsize;
|
stream.max_size = bufsize;
|
||||||
stream.bytes_written = 0;
|
stream.bytes_written = 0;
|
||||||
|
#ifndef PB_NO_ERRMSG
|
||||||
|
stream.errmsg = NULL;
|
||||||
|
#endif
|
||||||
return stream;
|
return stream;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -64,14 +67,14 @@ bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count
|
|||||||
if (stream->callback != NULL)
|
if (stream->callback != NULL)
|
||||||
{
|
{
|
||||||
if (stream->bytes_written + count > stream->max_size)
|
if (stream->bytes_written + count > stream->max_size)
|
||||||
return false;
|
PB_RETURN_ERROR(stream, "stream full");
|
||||||
|
|
||||||
#ifdef PB_BUFFER_ONLY
|
#ifdef PB_BUFFER_ONLY
|
||||||
if (!buf_write(stream, buf, count))
|
if (!buf_write(stream, buf, count))
|
||||||
return false;
|
PB_RETURN_ERROR(stream, "io error");
|
||||||
#else
|
#else
|
||||||
if (!stream->callback(stream, buf, count))
|
if (!stream->callback(stream, buf, count))
|
||||||
return false;
|
PB_RETURN_ERROR(stream, "io error");
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -81,10 +84,7 @@ bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count
|
|||||||
|
|
||||||
/* Main encoding stuff */
|
/* Main encoding stuff */
|
||||||
|
|
||||||
/* Callbacks don't need this function because they usually know the data type
|
/* Encode a static array. Handles the size calculations and possible packing. */
|
||||||
* without examining the field structure.
|
|
||||||
* Therefore it is static for now.
|
|
||||||
*/
|
|
||||||
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)
|
||||||
{
|
{
|
||||||
@@ -95,6 +95,7 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
|
|||||||
if (count == 0)
|
if (count == 0)
|
||||||
return true;
|
return true;
|
||||||
|
|
||||||
|
/* We always pack arrays if the datatype allows it. */
|
||||||
if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
|
if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
|
||||||
{
|
{
|
||||||
if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
|
if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
|
||||||
@@ -111,7 +112,7 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
|
|||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
pb_ostream_t sizestream = {0,0,0,0};
|
pb_ostream_t sizestream = PB_OSTREAM_SIZING;
|
||||||
p = pData;
|
p = pData;
|
||||||
for (i = 0; i < count; i++)
|
for (i = 0; i < count; i++)
|
||||||
{
|
{
|
||||||
@@ -153,13 +154,21 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool checkreturn encode_static_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData)
|
/* Encode a field with static allocation, i.e. one whose data is stored
|
||||||
|
* in the structure itself. */
|
||||||
|
static bool checkreturn encode_static_field(pb_ostream_t *stream,
|
||||||
|
const pb_field_t *field, const void *pData)
|
||||||
{
|
{
|
||||||
pb_encoder_t func;
|
pb_encoder_t func;
|
||||||
const void *pSize;
|
const void *pSize;
|
||||||
|
bool dummy = true;
|
||||||
|
|
||||||
func = PB_ENCODERS[PB_LTYPE(field->type)];
|
func = PB_ENCODERS[PB_LTYPE(field->type)];
|
||||||
pSize = (const char*)pData + field->size_offset;
|
|
||||||
|
if (field->size_offset)
|
||||||
|
pSize = (const char*)pData + field->size_offset;
|
||||||
|
else
|
||||||
|
pSize = &dummy;
|
||||||
|
|
||||||
switch (PB_HTYPE(field->type))
|
switch (PB_HTYPE(field->type))
|
||||||
{
|
{
|
||||||
@@ -187,23 +196,84 @@ bool checkreturn encode_static_field(pb_ostream_t *stream, const pb_field_t *fie
|
|||||||
break;
|
break;
|
||||||
|
|
||||||
default:
|
default:
|
||||||
return false;
|
PB_RETURN_ERROR(stream, "invalid field type");
|
||||||
}
|
}
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool checkreturn encode_callback_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData)
|
/* Encode a field with callback semantics. This means that a user function is
|
||||||
|
* called to provide and encode the actual data. */
|
||||||
|
static bool checkreturn encode_callback_field(pb_ostream_t *stream,
|
||||||
|
const pb_field_t *field, const void *pData)
|
||||||
{
|
{
|
||||||
const pb_callback_t *callback = (const pb_callback_t*)pData;
|
const pb_callback_t *callback = (const pb_callback_t*)pData;
|
||||||
|
|
||||||
|
#ifdef PB_OLD_CALLBACK_STYLE
|
||||||
|
const void *arg = callback->arg;
|
||||||
|
#else
|
||||||
|
void * const *arg = &(callback->arg);
|
||||||
|
#endif
|
||||||
|
|
||||||
if (callback->funcs.encode != NULL)
|
if (callback->funcs.encode != NULL)
|
||||||
{
|
{
|
||||||
if (!callback->funcs.encode(stream, field, callback->arg))
|
if (!callback->funcs.encode(stream, field, arg))
|
||||||
return false;
|
PB_RETURN_ERROR(stream, "callback error");
|
||||||
}
|
}
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Encode a single field of any callback or static type. */
|
||||||
|
static bool checkreturn encode_field(pb_ostream_t *stream,
|
||||||
|
const pb_field_t *field, const void *pData)
|
||||||
|
{
|
||||||
|
switch (PB_ATYPE(field->type))
|
||||||
|
{
|
||||||
|
case PB_ATYPE_STATIC:
|
||||||
|
return encode_static_field(stream, field, pData);
|
||||||
|
|
||||||
|
case PB_ATYPE_CALLBACK:
|
||||||
|
return encode_callback_field(stream, field, pData);
|
||||||
|
|
||||||
|
default:
|
||||||
|
PB_RETURN_ERROR(stream, "invalid field type");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Default handler for extension fields. Expects to have a pb_field_t
|
||||||
|
* pointer in the extension->type->arg field. */
|
||||||
|
static bool checkreturn default_extension_handler(pb_ostream_t *stream,
|
||||||
|
const pb_extension_t *extension)
|
||||||
|
{
|
||||||
|
const pb_field_t *field = (const pb_field_t*)extension->type->arg;
|
||||||
|
return encode_field(stream, field, extension->dest);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Walk through all the registered extensions and give them a chance
|
||||||
|
* to encode themselves. */
|
||||||
|
static bool checkreturn encode_extension_field(pb_ostream_t *stream,
|
||||||
|
const pb_field_t *field, const void *pData)
|
||||||
|
{
|
||||||
|
const pb_extension_t *extension = *(const pb_extension_t* const *)pData;
|
||||||
|
UNUSED(field);
|
||||||
|
|
||||||
|
while (extension)
|
||||||
|
{
|
||||||
|
bool status;
|
||||||
|
if (extension->type->encode)
|
||||||
|
status = extension->type->encode(stream, extension);
|
||||||
|
else
|
||||||
|
status = default_extension_handler(stream, extension);
|
||||||
|
|
||||||
|
if (!status)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
extension = extension->next;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], 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 pb_field_t *field = fields;
|
||||||
@@ -222,19 +292,16 @@ bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], cons
|
|||||||
prev_size *= field->array_size;
|
prev_size *= field->array_size;
|
||||||
}
|
}
|
||||||
|
|
||||||
switch (PB_ATYPE(field->type))
|
if (PB_LTYPE(field->type) == PB_LTYPE_EXTENSION)
|
||||||
{
|
{
|
||||||
case PB_ATYPE_STATIC:
|
/* Special case for the extension field placeholder */
|
||||||
if (!encode_static_field(stream, field, pData))
|
if (!encode_extension_field(stream, field, pData))
|
||||||
return false;
|
return false;
|
||||||
break;
|
}
|
||||||
|
else
|
||||||
case PB_ATYPE_CALLBACK:
|
{
|
||||||
if (!encode_callback_field(stream, field, pData))
|
/* Regular field */
|
||||||
return false;
|
if (!encode_field(stream, field, pData))
|
||||||
break;
|
|
||||||
|
|
||||||
default:
|
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -244,6 +311,11 @@ bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], cons
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
|
||||||
|
{
|
||||||
|
return pb_encode_submessage(stream, fields, src_struct);
|
||||||
|
}
|
||||||
|
|
||||||
/* Helper functions */
|
/* Helper functions */
|
||||||
bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
|
bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
|
||||||
{
|
{
|
||||||
@@ -340,7 +412,7 @@ bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t
|
|||||||
break;
|
break;
|
||||||
|
|
||||||
default:
|
default:
|
||||||
return false;
|
PB_RETURN_ERROR(stream, "invalid field type");
|
||||||
}
|
}
|
||||||
|
|
||||||
return pb_encode_tag(stream, wiretype, field->tag);
|
return pb_encode_tag(stream, wiretype, field->tag);
|
||||||
@@ -357,7 +429,7 @@ bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, s
|
|||||||
bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
|
bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
|
||||||
{
|
{
|
||||||
/* First calculate the message size using a non-writing substream. */
|
/* First calculate the message size using a non-writing substream. */
|
||||||
pb_ostream_t substream = {0,0,0,0};
|
pb_ostream_t substream = PB_OSTREAM_SIZING;
|
||||||
size_t size;
|
size_t size;
|
||||||
bool status;
|
bool status;
|
||||||
|
|
||||||
@@ -373,7 +445,7 @@ bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fie
|
|||||||
return pb_write(stream, NULL, size); /* Just sizing */
|
return pb_write(stream, NULL, size); /* Just sizing */
|
||||||
|
|
||||||
if (stream->bytes_written + size > stream->max_size)
|
if (stream->bytes_written + size > stream->max_size)
|
||||||
return false;
|
PB_RETURN_ERROR(stream, "stream full");
|
||||||
|
|
||||||
/* Use a substream to verify that a callback doesn't write more than
|
/* Use a substream to verify that a callback doesn't write more than
|
||||||
* what it did the first time. */
|
* what it did the first time. */
|
||||||
@@ -381,14 +453,20 @@ bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fie
|
|||||||
substream.state = stream->state;
|
substream.state = stream->state;
|
||||||
substream.max_size = size;
|
substream.max_size = size;
|
||||||
substream.bytes_written = 0;
|
substream.bytes_written = 0;
|
||||||
|
#ifndef PB_NO_ERRMSG
|
||||||
|
substream.errmsg = NULL;
|
||||||
|
#endif
|
||||||
|
|
||||||
status = pb_encode(&substream, fields, src_struct);
|
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;
|
||||||
|
#ifndef PB_NO_ERRMSG
|
||||||
|
stream->errmsg = substream.errmsg;
|
||||||
|
#endif
|
||||||
|
|
||||||
if (substream.bytes_written != size)
|
if (substream.bytes_written != size)
|
||||||
return false;
|
PB_RETURN_ERROR(stream, "submsg size changed");
|
||||||
|
|
||||||
return status;
|
return status;
|
||||||
}
|
}
|
||||||
@@ -405,7 +483,7 @@ bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, co
|
|||||||
case 2: value = *(const uint16_t*)src; break;
|
case 2: value = *(const uint16_t*)src; break;
|
||||||
case 4: value = *(const uint32_t*)src; break;
|
case 4: value = *(const uint32_t*)src; break;
|
||||||
case 8: value = *(const uint64_t*)src; break;
|
case 8: value = *(const uint64_t*)src; break;
|
||||||
default: return false;
|
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
||||||
}
|
}
|
||||||
|
|
||||||
return pb_encode_varint(stream, value);
|
return pb_encode_varint(stream, value);
|
||||||
@@ -419,7 +497,7 @@ bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, c
|
|||||||
{
|
{
|
||||||
case 4: value = *(const int32_t*)src; break;
|
case 4: value = *(const int32_t*)src; break;
|
||||||
case 8: value = *(const int64_t*)src; break;
|
case 8: value = *(const int64_t*)src; break;
|
||||||
default: return false;
|
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
||||||
}
|
}
|
||||||
|
|
||||||
return pb_encode_svarint(stream, value);
|
return pb_encode_svarint(stream, value);
|
||||||
@@ -446,14 +524,22 @@ bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, con
|
|||||||
|
|
||||||
bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
|
bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
|
||||||
{
|
{
|
||||||
UNUSED(field);
|
/* strnlen() is not always available, so just use a for-loop */
|
||||||
return pb_encode_string(stream, (const uint8_t*)src, strlen((const char*)src));
|
size_t size = 0;
|
||||||
|
const char *p = (const char*)src;
|
||||||
|
while (size < field->data_size && *p != '\0')
|
||||||
|
{
|
||||||
|
size++;
|
||||||
|
p++;
|
||||||
|
}
|
||||||
|
|
||||||
|
return pb_encode_string(stream, (const uint8_t*)src, size);
|
||||||
}
|
}
|
||||||
|
|
||||||
bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
|
bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
|
||||||
{
|
{
|
||||||
if (field->ptr == NULL)
|
if (field->ptr == NULL)
|
||||||
return false;
|
PB_RETURN_ERROR(stream, "invalid field descriptor");
|
||||||
|
|
||||||
return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);
|
return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);
|
||||||
}
|
}
|
||||||
|
|||||||
118
pb_encode.h
118
pb_encode.h
@@ -1,34 +1,28 @@
|
|||||||
|
/* pb_encode.h: Functions to encode protocol buffers. Depends on pb_encode.c.
|
||||||
|
* The main function is pb_encode. You also need an output stream, and the
|
||||||
|
* field descriptions created by nanopb_generator.py.
|
||||||
|
*/
|
||||||
|
|
||||||
#ifndef _PB_ENCODE_H_
|
#ifndef _PB_ENCODE_H_
|
||||||
#define _PB_ENCODE_H_
|
#define _PB_ENCODE_H_
|
||||||
|
|
||||||
/* pb_encode.h: Functions to encode protocol buffers. Depends on pb_encode.c.
|
|
||||||
* The main function is pb_encode. You also need an output stream, structures
|
|
||||||
* and their field descriptions (just like with pb_decode).
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <stdbool.h>
|
|
||||||
#include "pb.h"
|
#include "pb.h"
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* Lightweight output stream.
|
/* Structure for defining custom output streams. You will need to provide
|
||||||
* You can provide callback for writing or use pb_ostream_from_buffer.
|
* a callback function to write the bytes to your storage, which can be
|
||||||
|
* for example a file or a network socket.
|
||||||
*
|
*
|
||||||
* Alternatively, callback can be NULL in which case the stream will just
|
* The callback must conform to these rules:
|
||||||
* count the number of bytes that would have been written. In this case
|
|
||||||
* max_size is not checked.
|
|
||||||
*
|
*
|
||||||
* Rules for callback:
|
|
||||||
* 1) Return false on IO errors. This will cause encoding to abort.
|
* 1) Return false on IO errors. This will cause encoding to abort.
|
||||||
*
|
|
||||||
* 2) You can use state to store your own data (e.g. buffer pointer).
|
* 2) You can use state to store your own data (e.g. buffer pointer).
|
||||||
*
|
|
||||||
* 3) pb_write will update bytes_written after your callback runs.
|
* 3) pb_write will update bytes_written after your callback runs.
|
||||||
*
|
* 4) Substreams will modify max_size and bytes_written. Don't use them
|
||||||
* 4) Substreams will modify max_size and bytes_written. Don't use them to
|
* to calculate any pointers.
|
||||||
* calculate any pointers.
|
|
||||||
*/
|
*/
|
||||||
struct _pb_ostream_t
|
struct _pb_ostream_t
|
||||||
{
|
{
|
||||||
@@ -43,31 +37,84 @@ struct _pb_ostream_t
|
|||||||
#else
|
#else
|
||||||
bool (*callback)(pb_ostream_t *stream, const uint8_t *buf, size_t count);
|
bool (*callback)(pb_ostream_t *stream, const uint8_t *buf, size_t count);
|
||||||
#endif
|
#endif
|
||||||
void *state; /* Free field for use by callback implementation */
|
void *state; /* Free field for use by callback implementation. */
|
||||||
size_t max_size; /* Limit number of output bytes written (or use SIZE_MAX). */
|
size_t max_size; /* Limit number of output bytes written (or use SIZE_MAX). */
|
||||||
size_t bytes_written;
|
size_t bytes_written; /* Number of bytes written so far. */
|
||||||
|
|
||||||
|
#ifndef PB_NO_ERRMSG
|
||||||
|
const char *errmsg;
|
||||||
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
|
/***************************
|
||||||
bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
|
* Main encoding functions *
|
||||||
|
***************************/
|
||||||
|
|
||||||
/* Encode struct to given output stream.
|
/* Encode a single protocol buffers message from C structure into a 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 fields.
|
* 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.
|
||||||
|
*
|
||||||
|
* Example usage:
|
||||||
|
* MyMessage msg = {};
|
||||||
|
* uint8_t buffer[64];
|
||||||
|
* pb_ostream_t stream;
|
||||||
|
*
|
||||||
|
* msg.field1 = 42;
|
||||||
|
* stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
||||||
|
* pb_encode(&stream, MyMessage_fields, &msg);
|
||||||
*/
|
*/
|
||||||
bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
|
bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
|
||||||
|
|
||||||
/* --- Helper functions ---
|
/* Same as pb_encode, but prepends the length of the message as a varint.
|
||||||
* You may want to use these from your caller or callbacks.
|
* Corresponds to writeDelimitedTo() in Google's protobuf API.
|
||||||
*/
|
*/
|
||||||
|
bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
|
||||||
|
|
||||||
/* Encode field header based on LTYPE and field number defined in the field structure.
|
/**************************************
|
||||||
* Call this from the callback before writing out field contents. */
|
* Functions for manipulating streams *
|
||||||
|
**************************************/
|
||||||
|
|
||||||
|
/* Create an output stream for writing into a memory buffer.
|
||||||
|
* The number of bytes written can be found in stream.bytes_written after
|
||||||
|
* encoding the message.
|
||||||
|
*
|
||||||
|
* Alternatively, you can use a custom stream that writes directly to e.g.
|
||||||
|
* a file or a network socket.
|
||||||
|
*/
|
||||||
|
pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
|
||||||
|
|
||||||
|
/* Pseudo-stream for measuring the size of a message without actually storing
|
||||||
|
* the encoded data.
|
||||||
|
*
|
||||||
|
* Example usage:
|
||||||
|
* MyMessage msg = {};
|
||||||
|
* pb_ostream_t stream = PB_OSTREAM_SIZING;
|
||||||
|
* pb_encode(&stream, MyMessage_fields, &msg);
|
||||||
|
* printf("Message size is %d\n", stream.bytes_written);
|
||||||
|
*/
|
||||||
|
#ifndef PB_NO_ERRMSG
|
||||||
|
#define PB_OSTREAM_SIZING {0,0,0,0,0}
|
||||||
|
#else
|
||||||
|
#define PB_OSTREAM_SIZING {0,0,0,0}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Function to write into a pb_ostream_t stream. You can use this if you need
|
||||||
|
* to append or prepend some custom headers to the message.
|
||||||
|
*/
|
||||||
|
bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
|
||||||
|
|
||||||
|
|
||||||
|
/************************************************
|
||||||
|
* Helper functions for writing field callbacks *
|
||||||
|
************************************************/
|
||||||
|
|
||||||
|
/* Encode field header based on type and field number defined in the field
|
||||||
|
* structure. Call this from the callback before writing out field contents. */
|
||||||
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);
|
||||||
|
|
||||||
/* Encode field header by manually specifing wire type. You need to use this if
|
/* Encode field header by manually specifing wire type. You need to use this
|
||||||
* you want to write out packed arrays from a callback field. */
|
* 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, uint32_t field_number);
|
bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number);
|
||||||
|
|
||||||
/* Encode an integer in the varint format.
|
/* Encode an integer in the varint format.
|
||||||
@@ -90,15 +137,16 @@ bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
|
|||||||
bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
|
bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
|
||||||
|
|
||||||
/* Encode a submessage field.
|
/* Encode a submessage field.
|
||||||
* You need to pass the pb_field_t array and pointer to struct, just like with pb_encode().
|
* You need to pass the pb_field_t array and pointer to struct, just like
|
||||||
* This internally encodes the submessage twice, first to calculate message size and then to actually write it out.
|
* 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);
|
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.
|
* Internal / legacy functions *
|
||||||
*/
|
*******************************/
|
||||||
|
|
||||||
#ifdef NANOPB_INTERNALS
|
#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);
|
||||||
|
|||||||
131
tests/Makefile
131
tests/Makefile
@@ -1,131 +1,6 @@
|
|||||||
CFLAGS=-ansi -Wall -Werror -I .. -g -O0
|
all:
|
||||||
DEPS=../pb_decode.h ../pb_encode.h ../pb.h person.pb.h \
|
scons
|
||||||
callbacks2.pb.h callbacks.pb.h unittests.h unittestproto.pb.h \
|
|
||||||
alltypes.pb.h missing_fields.pb.h
|
|
||||||
TESTS= decode_unittests encode_unittests \
|
|
||||||
test_decode1 test_decode2 test_decode3 test_decode3_buf \
|
|
||||||
test_encode1 test_encode2 test_encode3 test_encode3_buf \
|
|
||||||
test_decode_callbacks test_encode_callbacks \
|
|
||||||
test_missing_fields test_no_messages test_funny_name \
|
|
||||||
test_multiple_files test_cxxcompile test_options \
|
|
||||||
bc_encode bc_decode
|
|
||||||
|
|
||||||
# More strict checks for the core part of nanopb
|
|
||||||
CC_VERSION=$(shell $(CC) -v 2>&1)
|
|
||||||
CFLAGS_CORE=
|
|
||||||
ifneq (,$(findstring gcc,$(CC_VERSION)))
|
|
||||||
CFLAGS_CORE=-pedantic -Wextra -Wcast-qual -Wlogical-op -Wconversion
|
|
||||||
CFLAGS+=--coverage
|
|
||||||
LDFLAGS+=--coverage
|
|
||||||
endif
|
|
||||||
ifneq (,$(findstring clang,$(CC_VERSION)))
|
|
||||||
CFLAGS_CORE=-pedantic -Wextra -Wcast-qual -Wconversion
|
|
||||||
endif
|
|
||||||
|
|
||||||
all: breakpoints $(TESTS) run_unittests
|
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f $(TESTS) person.pb* alltypes.pb* *.o *.gcda *.gcno *.pb.h *.pb.c
|
scons -c
|
||||||
|
|
||||||
%.pb.o: %.pb.c %.pb.h
|
|
||||||
$(CC) $(CFLAGS) $(CFLAGS_CORE) -c -o $@ $<
|
|
||||||
|
|
||||||
%.o: %.c
|
|
||||||
%.o: %.c $(DEPS)
|
|
||||||
$(CC) $(CFLAGS) -c -o $@ $<
|
|
||||||
|
|
||||||
pb_encode.o: ../pb_encode.c $(DEPS)
|
|
||||||
$(CC) $(CFLAGS) $(CFLAGS_CORE) -c -o $@ $<
|
|
||||||
pb_decode.o: ../pb_decode.c $(DEPS)
|
|
||||||
$(CC) $(CFLAGS) $(CFLAGS_CORE) -c -o $@ $<
|
|
||||||
|
|
||||||
# Test for compilability with c++ compiler
|
|
||||||
|
|
||||||
pb_encode.cxx.o: ../pb_encode.c $(DEPS)
|
|
||||||
$(CXX) $(CFLAGS) $(CFLAGS_CORE) -c -o $@ $<
|
|
||||||
pb_decode.cxx.o: ../pb_decode.c $(DEPS)
|
|
||||||
$(CXX) $(CFLAGS) $(CFLAGS_CORE) -c -o $@ $<
|
|
||||||
|
|
||||||
# Test for PB_BUF_ONLY compilation option
|
|
||||||
|
|
||||||
pb_encode.buf.o: ../pb_encode.c $(DEPS)
|
|
||||||
$(CC) -DPB_BUFFER_ONLY $(CFLAGS) $(CFLAGS_CORE) -c -o $@ $<
|
|
||||||
pb_decode.buf.o: ../pb_decode.c $(DEPS)
|
|
||||||
$(CC) -DPB_BUFFER_ONLY $(CFLAGS) $(CFLAGS_CORE) -c -o $@ $<
|
|
||||||
%.buf.o: %.c $(DEPS)
|
|
||||||
$(CC) -DPB_BUFFER_ONLY $(CFLAGS) -c -o $@ $<
|
|
||||||
test_encode3_buf: test_encode3.buf.o pb_encode.buf.o alltypes.pb.o
|
|
||||||
$(CC) $(LDFLAGS) $^ -o $@
|
|
||||||
test_decode3_buf: test_decode3.buf.o pb_decode.buf.o alltypes.pb.o
|
|
||||||
$(CC) $(LDFLAGS) $^ -o $@
|
|
||||||
|
|
||||||
test_cxxcompile: pb_encode.cxx.o pb_decode.cxx.o
|
|
||||||
test_decode1: test_decode1.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_encode2: test_encode2.o pb_encode.o person.pb.o
|
|
||||||
test_encode3: test_encode3.o pb_encode.o alltypes.pb.o
|
|
||||||
test_multiple_files: test_multiple_files.o pb_encode.o callbacks2.pb.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_missing_fields: test_missing_fields.o pb_encode.o pb_decode.o missing_fields.pb.o
|
|
||||||
decode_unittests: decode_unittests.o pb_decode.o unittestproto.pb.o
|
|
||||||
encode_unittests: encode_unittests.o pb_encode.o unittestproto.pb.o
|
|
||||||
test_no_messages: no_messages.pb.h no_messages.pb.c no_messages.pb.o
|
|
||||||
test_funny_name: funny-proto+name.pb.h funny-proto+name.pb.o
|
|
||||||
bc_encode: bc_alltypes.pb.o pb_encode.o bc_encode.o
|
|
||||||
bc_decode: bc_alltypes.pb.o pb_decode.o bc_decode.o
|
|
||||||
|
|
||||||
%.pb: %.proto
|
|
||||||
protoc -I. -I../generator -I/usr/include -o$@ $<
|
|
||||||
|
|
||||||
%.pb.c %.pb.h: %.pb ../generator/nanopb_generator.py
|
|
||||||
python ../generator/nanopb_generator.py $<
|
|
||||||
|
|
||||||
breakpoints: ../*.c *.c
|
|
||||||
grep -n 'return false;' $^ | cut -d: -f-2 | xargs -n 1 echo b > $@
|
|
||||||
|
|
||||||
coverage: run_unittests
|
|
||||||
gcov pb_encode.gcda
|
|
||||||
gcov pb_decode.gcda
|
|
||||||
|
|
||||||
run_unittests: $(TESTS)
|
|
||||||
rm -f *.gcda
|
|
||||||
|
|
||||||
./decode_unittests > /dev/null
|
|
||||||
./encode_unittests > /dev/null
|
|
||||||
|
|
||||||
[ "`./test_encode1 | ./test_decode1`" = \
|
|
||||||
"`./test_encode1 | protoc --decode=Person -I. -I../generator -I/usr/include person.proto`" ]
|
|
||||||
|
|
||||||
[ "`./test_encode2 | ./test_decode1`" = \
|
|
||||||
"`./test_encode2 | protoc --decode=Person -I. -I../generator -I/usr/include person.proto`" ]
|
|
||||||
|
|
||||||
[ "`./test_encode2 | ./test_decode2`" = \
|
|
||||||
"`./test_encode2 | protoc --decode=Person -I. -I../generator -I/usr/include person.proto`" ]
|
|
||||||
|
|
||||||
[ "`./test_decode2 < person_with_extra_field.pb`" = \
|
|
||||||
"`./test_encode2 | ./test_decode2`" ]
|
|
||||||
|
|
||||||
[ "`./test_encode_callbacks | ./test_decode_callbacks`" = \
|
|
||||||
"`./test_encode_callbacks | protoc --decode=TestMessage callbacks.proto`" ]
|
|
||||||
|
|
||||||
./test_encode3 | ./test_decode3
|
|
||||||
./test_encode3 1 | ./test_decode3 1
|
|
||||||
./test_encode3 1 | protoc --decode=AllTypes -I. -I../generator -I/usr/include alltypes.proto >/dev/null
|
|
||||||
./test_encode3_buf 1 | ./test_decode3_buf 1
|
|
||||||
./bc_encode | ./bc_decode
|
|
||||||
|
|
||||||
./test_missing_fields
|
|
||||||
|
|
||||||
test_options: options.pb.h options.expected options.pb.o
|
|
||||||
cat options.expected | while read -r p; do \
|
|
||||||
if ! grep -q "$$p" $<; then \
|
|
||||||
echo Expected: "$$p"; \
|
|
||||||
exit 1; \
|
|
||||||
fi \
|
|
||||||
done
|
|
||||||
|
|
||||||
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'
|
|
||||||
|
|||||||
109
tests/SConstruct
Normal file
109
tests/SConstruct
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
Help('''
|
||||||
|
Type 'scons' to build and run all the available test cases.
|
||||||
|
It will automatically detect your platform and C compiler and
|
||||||
|
build appropriately.
|
||||||
|
|
||||||
|
You can modify the behavious using following options:
|
||||||
|
CC Name of C compiler
|
||||||
|
CXX Name of C++ compiler
|
||||||
|
CCFLAGS Flags to pass to the C compiler
|
||||||
|
CXXFLAGS Flags to pass to the C++ compiler
|
||||||
|
|
||||||
|
For example, for a clang build, use:
|
||||||
|
scons CC=clang CXX=clang++
|
||||||
|
''')
|
||||||
|
|
||||||
|
import os
|
||||||
|
env = Environment(ENV = os.environ)
|
||||||
|
|
||||||
|
# Allow overriding the compiler with scons CC=???
|
||||||
|
if 'CC' in ARGUMENTS: env.Replace(CC = ARGUMENTS['CC'])
|
||||||
|
if 'CXX' in ARGUMENTS: env.Replace(CXX = ARGUMENTS['CXX'])
|
||||||
|
if 'CFLAGS' in ARGUMENTS: env.Append(CCFLAGS = ARGUMENTS['CFLAGS'])
|
||||||
|
if 'CXXFLAGS' in ARGUMENTS: env.Append(CCFLAGS = ARGUMENTS['CXXFLAGS'])
|
||||||
|
|
||||||
|
# Add the builders defined in site_init.py
|
||||||
|
add_nanopb_builders(env)
|
||||||
|
|
||||||
|
# Path to the files shared by tests, and to the nanopb core.
|
||||||
|
env.Append(CPPPATH = ["#../", "#common"])
|
||||||
|
|
||||||
|
# Path for finding nanopb.proto
|
||||||
|
env.Append(PROTOCPATH = '#../generator')
|
||||||
|
|
||||||
|
# Check the compilation environment, unless we are just cleaning up.
|
||||||
|
if not env.GetOption('clean'):
|
||||||
|
conf = Configure(env)
|
||||||
|
|
||||||
|
# If the platform doesn't support C99, use our own header file instead.
|
||||||
|
stdbool = conf.CheckCHeader('stdbool.h')
|
||||||
|
stdint = conf.CheckCHeader('stdint.h')
|
||||||
|
stddef = conf.CheckCHeader('stddef.h')
|
||||||
|
string = conf.CheckCHeader('string.h')
|
||||||
|
if not stdbool or not stdint or not stddef or not string:
|
||||||
|
conf.env.Append(CPPDEFINES = {'PB_SYSTEM_HEADER': '\\"pb_syshdr.h\\"'})
|
||||||
|
conf.env.Append(CPPPATH = "#../compat")
|
||||||
|
|
||||||
|
if stdbool: conf.env.Append(CPPDEFINES = {'HAVE_STDBOOL_H': 1})
|
||||||
|
if stdint: conf.env.Append(CPPDEFINES = {'HAVE_STDINT_H': 1})
|
||||||
|
if stddef: conf.env.Append(CPPDEFINES = {'HAVE_STDDEF_H': 1})
|
||||||
|
if string: conf.env.Append(CPPDEFINES = {'HAVE_STRING_H': 1})
|
||||||
|
|
||||||
|
# Check if we can use pkg-config to find protobuf include path
|
||||||
|
status, output = conf.TryAction('pkg-config protobuf --variable=includedir > $TARGET')
|
||||||
|
if status:
|
||||||
|
conf.env.Append(PROTOCPATH = output.strip())
|
||||||
|
else:
|
||||||
|
conf.env.Append(PROTOCPATH = '/usr/include')
|
||||||
|
|
||||||
|
# Check if libmudflap is available (only with GCC)
|
||||||
|
if 'gcc' in env['CC']:
|
||||||
|
if conf.CheckLib('mudflap'):
|
||||||
|
conf.env.Append(CCFLAGS = '-fmudflap')
|
||||||
|
conf.env.Append(LINKFLAGS = '-lmudflap -fmudflap')
|
||||||
|
|
||||||
|
# End the config stuff
|
||||||
|
env = conf.Finish()
|
||||||
|
|
||||||
|
# Initialize the CCFLAGS according to the compiler
|
||||||
|
if 'gcc' in env['CC']:
|
||||||
|
# GNU Compiler Collection
|
||||||
|
|
||||||
|
# Debug info, warnings as errors
|
||||||
|
env.Append(CFLAGS = '-ansi -pedantic -g -O0 -Wall -Werror --coverage -fstack-protector-all')
|
||||||
|
env.Append(LINKFLAGS = '--coverage')
|
||||||
|
|
||||||
|
# More strict checks on the nanopb core
|
||||||
|
env.Append(CORECFLAGS = '-Wextra -Wcast-qual -Wlogical-op -Wconversion')
|
||||||
|
elif 'clang' in env['CC']:
|
||||||
|
# CLang
|
||||||
|
env.Append(CFLAGS = '-ansi -pedantic -g -O0 -Wall -Werror')
|
||||||
|
env.Append(CORECFLAGS = ' -Wextra -Wcast-qual -Wconversion')
|
||||||
|
elif 'cl' in env['CC']:
|
||||||
|
# Microsoft Visual C++
|
||||||
|
|
||||||
|
# Debug info on, warning level 2 for tests, warnings as errors
|
||||||
|
env.Append(CFLAGS = '/Zi /W2 /WX')
|
||||||
|
env.Append(LINKFLAGS = '/DEBUG')
|
||||||
|
|
||||||
|
# More strict checks on the nanopb core
|
||||||
|
env.Append(CORECFLAGS = '/W4')
|
||||||
|
|
||||||
|
# PB_RETURN_ERROR triggers C4127 because of while(0)
|
||||||
|
env.Append(CFLAGS = '/wd4127')
|
||||||
|
elif 'tcc' in env['CC']:
|
||||||
|
# Tiny C Compiler
|
||||||
|
env.Append(CFLAGS = '-Wall -Werror -g')
|
||||||
|
|
||||||
|
env.SetDefault(CORECFLAGS = '')
|
||||||
|
|
||||||
|
if 'clang++' in env['CXX']:
|
||||||
|
env.Append(CXXFLAGS = '-g -O0 -Wall -Werror -Wextra -Wno-missing-field-initializers')
|
||||||
|
elif 'g++' in env['CXX']:
|
||||||
|
env.Append(CXXFLAGS = '-g -O0 -Wall -Werror -Wextra -Wno-missing-field-initializers')
|
||||||
|
elif 'cl' in env['CXX']:
|
||||||
|
env.Append(CXXFLAGS = '/Zi /W2 /WX')
|
||||||
|
|
||||||
|
# Now include the SConscript files from all subdirectories
|
||||||
|
SConscript(Glob('*/SConscript'), exports = 'env')
|
||||||
|
|
||||||
12
tests/alltypes/SConscript
Normal file
12
tests/alltypes/SConscript
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Build and run a test that encodes and decodes a message that contains
|
||||||
|
# all of the Protocol Buffers data types.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
env.NanopbProto("alltypes")
|
||||||
|
enc = env.Program(["encode_alltypes.c", "alltypes.pb.c", "#common/pb_encode.o"])
|
||||||
|
dec = env.Program(["decode_alltypes.c", "alltypes.pb.c", "#common/pb_decode.o"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_alltypes.output"])
|
||||||
|
|
||||||
3
tests/alltypes/alltypes.options
Normal file
3
tests/alltypes/alltypes.options
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
* max_size:16
|
||||||
|
* max_count:5
|
||||||
|
|
||||||
@@ -1,11 +1,13 @@
|
|||||||
import "nanopb.proto";
|
|
||||||
|
|
||||||
message SubMessage {
|
message SubMessage {
|
||||||
required string substuff1 = 1 [(nanopb).max_size = 16, default = "1"];
|
required string substuff1 = 1 [default = "1"];
|
||||||
required int32 substuff2 = 2 [default = 2];
|
required int32 substuff2 = 2 [default = 2];
|
||||||
optional fixed32 substuff3 = 3 [default = 3];
|
optional fixed32 substuff3 = 3 [default = 3];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
message EmptyMessage {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
enum MyEnum {
|
enum MyEnum {
|
||||||
Zero = 0;
|
Zero = 0;
|
||||||
First = 1;
|
First = 1;
|
||||||
@@ -30,32 +32,34 @@ message AllTypes {
|
|||||||
required sfixed64 req_sfixed64= 12;
|
required sfixed64 req_sfixed64= 12;
|
||||||
required double req_double = 13;
|
required double req_double = 13;
|
||||||
|
|
||||||
required string req_string = 14 [(nanopb).max_size = 16];
|
required string req_string = 14;
|
||||||
required bytes req_bytes = 15 [(nanopb).max_size = 16];
|
required bytes req_bytes = 15;
|
||||||
required SubMessage req_submsg = 16;
|
required SubMessage req_submsg = 16;
|
||||||
required MyEnum req_enum = 17;
|
required MyEnum req_enum = 17;
|
||||||
|
required EmptyMessage req_emptymsg = 18;
|
||||||
|
|
||||||
|
|
||||||
repeated int32 rep_int32 = 21 [(nanopb).max_count = 5];
|
repeated int32 rep_int32 = 21;
|
||||||
repeated int64 rep_int64 = 22 [(nanopb).max_count = 5];
|
repeated int64 rep_int64 = 22;
|
||||||
repeated uint32 rep_uint32 = 23 [(nanopb).max_count = 5];
|
repeated uint32 rep_uint32 = 23;
|
||||||
repeated uint64 rep_uint64 = 24 [(nanopb).max_count = 5];
|
repeated uint64 rep_uint64 = 24;
|
||||||
repeated sint32 rep_sint32 = 25 [(nanopb).max_count = 5];
|
repeated sint32 rep_sint32 = 25;
|
||||||
repeated sint64 rep_sint64 = 26 [(nanopb).max_count = 5];
|
repeated sint64 rep_sint64 = 26;
|
||||||
repeated bool rep_bool = 27 [(nanopb).max_count = 5];
|
repeated bool rep_bool = 27;
|
||||||
|
|
||||||
repeated fixed32 rep_fixed32 = 28 [(nanopb).max_count = 5];
|
repeated fixed32 rep_fixed32 = 28;
|
||||||
repeated sfixed32 rep_sfixed32= 29 [(nanopb).max_count = 5];
|
repeated sfixed32 rep_sfixed32= 29;
|
||||||
repeated float rep_float = 30 [(nanopb).max_count = 5];
|
repeated float rep_float = 30;
|
||||||
|
|
||||||
repeated fixed64 rep_fixed64 = 31 [(nanopb).max_count = 5];
|
repeated fixed64 rep_fixed64 = 31;
|
||||||
repeated sfixed64 rep_sfixed64= 32 [(nanopb).max_count = 5];
|
repeated sfixed64 rep_sfixed64= 32;
|
||||||
repeated double rep_double = 33 [(nanopb).max_count = 5];
|
repeated double rep_double = 33;
|
||||||
|
|
||||||
repeated string rep_string = 34 [(nanopb).max_size = 16, (nanopb).max_count = 5];
|
repeated string rep_string = 34;
|
||||||
repeated bytes rep_bytes = 35 [(nanopb).max_size = 16, (nanopb).max_count = 5];
|
repeated bytes rep_bytes = 35;
|
||||||
repeated SubMessage rep_submsg = 36 [(nanopb).max_count = 5];
|
repeated SubMessage rep_submsg = 36;
|
||||||
repeated MyEnum rep_enum = 37 [(nanopb).max_count = 5];
|
repeated MyEnum rep_enum = 37;
|
||||||
|
repeated EmptyMessage rep_emptymsg = 38;
|
||||||
|
|
||||||
optional int32 opt_int32 = 41 [default = 4041];
|
optional int32 opt_int32 = 41 [default = 4041];
|
||||||
optional int64 opt_int64 = 42 [default = 4042];
|
optional int64 opt_int64 = 42 [default = 4042];
|
||||||
@@ -73,13 +77,17 @@ message AllTypes {
|
|||||||
optional sfixed64 opt_sfixed64= 52 [default = 4052];
|
optional sfixed64 opt_sfixed64= 52 [default = 4052];
|
||||||
optional double opt_double = 53 [default = 4053];
|
optional double opt_double = 53 [default = 4053];
|
||||||
|
|
||||||
optional string opt_string = 54 [(nanopb).max_size = 16, default = "4054"];
|
optional string opt_string = 54 [default = "4054"];
|
||||||
optional bytes opt_bytes = 55 [(nanopb).max_size = 16, default = "4055"];
|
optional bytes opt_bytes = 55 [default = "4055"];
|
||||||
optional SubMessage opt_submsg = 56;
|
optional SubMessage opt_submsg = 56;
|
||||||
optional MyEnum opt_enum = 57 [default = Second];
|
optional MyEnum opt_enum = 57 [default = Second];
|
||||||
|
optional EmptyMessage opt_emptymsg = 58;
|
||||||
|
|
||||||
// Just to make sure that the size of the fields has been calculated
|
// 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.
|
// properly, i.e. otherwise a bug in last field might not be detected.
|
||||||
required int32 end = 99;
|
required int32 end = 99;
|
||||||
|
|
||||||
|
|
||||||
|
extensions 200 to 255;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -8,6 +8,7 @@
|
|||||||
#include <stdlib.h>
|
#include <stdlib.h>
|
||||||
#include <pb_decode.h>
|
#include <pb_decode.h>
|
||||||
#include "alltypes.pb.h"
|
#include "alltypes.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
#define TEST(x) if (!(x)) { \
|
#define TEST(x) if (!(x)) { \
|
||||||
printf("Test " #x " failed.\n"); \
|
printf("Test " #x " failed.\n"); \
|
||||||
@@ -76,6 +77,7 @@ bool check_alltypes(pb_istream_t *stream, int mode)
|
|||||||
TEST(alltypes.rep_submsg[4].substuff3 == 2016 && alltypes.rep_submsg[0].substuff3 == 3);
|
TEST(alltypes.rep_submsg[4].substuff3 == 2016 && alltypes.rep_submsg[0].substuff3 == 3);
|
||||||
|
|
||||||
TEST(alltypes.rep_enum_count == 5 && alltypes.rep_enum[4] == MyEnum_Truth && alltypes.rep_enum[0] == MyEnum_Zero);
|
TEST(alltypes.rep_enum_count == 5 && alltypes.rep_enum[4] == MyEnum_Truth && alltypes.rep_enum[0] == MyEnum_Zero);
|
||||||
|
TEST(alltypes.rep_emptymsg_count == 5);
|
||||||
|
|
||||||
if (mode == 0)
|
if (mode == 0)
|
||||||
{
|
{
|
||||||
@@ -120,6 +122,7 @@ bool check_alltypes(pb_istream_t *stream, int mode)
|
|||||||
TEST(alltypes.opt_submsg.substuff3 == 3);
|
TEST(alltypes.opt_submsg.substuff3 == 3);
|
||||||
TEST(alltypes.has_opt_enum == false);
|
TEST(alltypes.has_opt_enum == false);
|
||||||
TEST(alltypes.opt_enum == MyEnum_Second);
|
TEST(alltypes.opt_enum == MyEnum_Second);
|
||||||
|
TEST(alltypes.has_opt_emptymsg == false);
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
@@ -164,6 +167,7 @@ bool check_alltypes(pb_istream_t *stream, int mode)
|
|||||||
TEST(alltypes.opt_submsg.substuff3 == 3);
|
TEST(alltypes.opt_submsg.substuff3 == 3);
|
||||||
TEST(alltypes.has_opt_enum == true);
|
TEST(alltypes.has_opt_enum == true);
|
||||||
TEST(alltypes.opt_enum == MyEnum_Truth);
|
TEST(alltypes.opt_enum == MyEnum_Truth);
|
||||||
|
TEST(alltypes.has_opt_emptymsg == true);
|
||||||
}
|
}
|
||||||
|
|
||||||
TEST(alltypes.end == 1099);
|
TEST(alltypes.end == 1099);
|
||||||
@@ -173,15 +177,19 @@ bool check_alltypes(pb_istream_t *stream, int mode)
|
|||||||
|
|
||||||
int main(int argc, char **argv)
|
int main(int argc, char **argv)
|
||||||
{
|
{
|
||||||
|
uint8_t buffer[1024];
|
||||||
|
size_t count;
|
||||||
|
pb_istream_t stream;
|
||||||
|
|
||||||
/* Whether to expect the optional values or the default values. */
|
/* Whether to expect the optional values or the default values. */
|
||||||
int mode = (argc > 1) ? atoi(argv[1]) : 0;
|
int mode = (argc > 1) ? atoi(argv[1]) : 0;
|
||||||
|
|
||||||
/* Read the data into buffer */
|
/* Read the data into buffer */
|
||||||
uint8_t buffer[1024];
|
SET_BINARY_MODE(stdin);
|
||||||
size_t count = fread(buffer, 1, sizeof(buffer), stdin);
|
count = fread(buffer, 1, sizeof(buffer), stdin);
|
||||||
|
|
||||||
/* Construct a pb_istream_t for reading from the buffer */
|
/* Construct a pb_istream_t for reading from the buffer */
|
||||||
pb_istream_t stream = pb_istream_from_buffer(buffer, count);
|
stream = pb_istream_from_buffer(buffer, count);
|
||||||
|
|
||||||
/* Decode and print out the stuff */
|
/* Decode and print out the stuff */
|
||||||
if (!check_alltypes(&stream, mode))
|
if (!check_alltypes(&stream, mode))
|
||||||
@@ -6,6 +6,7 @@
|
|||||||
#include <string.h>
|
#include <string.h>
|
||||||
#include <pb_encode.h>
|
#include <pb_encode.h>
|
||||||
#include "alltypes.pb.h"
|
#include "alltypes.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
int main(int argc, char **argv)
|
int main(int argc, char **argv)
|
||||||
{
|
{
|
||||||
@@ -64,6 +65,7 @@ int main(int argc, char **argv)
|
|||||||
alltypes.rep_submsg[4].substuff3 = 2016;
|
alltypes.rep_submsg[4].substuff3 = 2016;
|
||||||
|
|
||||||
alltypes.rep_enum_count = 5; alltypes.rep_enum[4] = MyEnum_Truth;
|
alltypes.rep_enum_count = 5; alltypes.rep_enum[4] = MyEnum_Truth;
|
||||||
|
alltypes.rep_emptymsg_count = 5;
|
||||||
|
|
||||||
if (mode != 0)
|
if (mode != 0)
|
||||||
{
|
{
|
||||||
@@ -107,22 +109,26 @@ int main(int argc, char **argv)
|
|||||||
alltypes.opt_submsg.substuff2 = 3056;
|
alltypes.opt_submsg.substuff2 = 3056;
|
||||||
alltypes.has_opt_enum = true;
|
alltypes.has_opt_enum = true;
|
||||||
alltypes.opt_enum = MyEnum_Truth;
|
alltypes.opt_enum = MyEnum_Truth;
|
||||||
|
alltypes.has_opt_emptymsg = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
alltypes.end = 1099;
|
alltypes.end = 1099;
|
||||||
|
|
||||||
uint8_t buffer[1024];
|
{
|
||||||
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
uint8_t buffer[1024];
|
||||||
|
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, AllTypes_fields, &alltypes))
|
if (pb_encode(&stream, AllTypes_fields, &alltypes))
|
||||||
{
|
{
|
||||||
fwrite(buffer, 1, stream.bytes_written, stdout);
|
SET_BINARY_MODE(stdout);
|
||||||
return 0; /* Success */
|
fwrite(buffer, 1, stream.bytes_written, stdout);
|
||||||
}
|
return 0; /* Success */
|
||||||
else
|
}
|
||||||
{
|
else
|
||||||
fprintf(stderr, "Encoding failed!\n");
|
{
|
||||||
return 1; /* Failure */
|
fprintf(stderr, "Encoding failed: %s\n", PB_GET_ERROR(&stream));
|
||||||
|
return 1; /* Failure */
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
11
tests/backwards_compatibility/SConscript
Normal file
11
tests/backwards_compatibility/SConscript
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Check that the old generated .pb.c/.pb.h files are still compatible with the
|
||||||
|
# current version of nanopb.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
enc = env.Program(["encode_legacy.c", "alltypes_legacy.c", "#common/pb_encode.o"])
|
||||||
|
dec = env.Program(["decode_legacy.c", "alltypes_legacy.c", "#common/pb_decode.o"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_legacy.output"])
|
||||||
|
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
* incompatible changes made to the generator in future versions.
|
* incompatible changes made to the generator in future versions.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "alltypes.pb.h"
|
#include "alltypes_legacy.h"
|
||||||
|
|
||||||
const char SubMessage_substuff1_default[16] = "1";
|
const char SubMessage_substuff1_default[16] = "1";
|
||||||
const int32_t SubMessage_substuff2_default = 2;
|
const int32_t SubMessage_substuff2_default = 2;
|
||||||
@@ -1,16 +1,16 @@
|
|||||||
/* Tests the decoding of all types.
|
/* Tests the decoding of all types.
|
||||||
* This is a backwards-compatibility test, using bc_alltypes.pb.h.
|
* This is a backwards-compatibility test, using alltypes_legacy.h.
|
||||||
* It is similar to test_decode3, but duplicated in order to allow
|
* It is similar to decode_alltypes, but duplicated in order to allow
|
||||||
* test_decode3 to test any new features introduced later.
|
* decode_alltypes to test any new features introduced later.
|
||||||
*
|
*
|
||||||
* Run e.g. ./bc_encode | ./bc_decode
|
* Run e.g. ./encode_legacy | ./decode_legacy
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
#include <stdlib.h>
|
#include <stdlib.h>
|
||||||
#include <pb_decode.h>
|
#include <pb_decode.h>
|
||||||
#include "bc_alltypes.pb.h"
|
#include "alltypes_legacy.h"
|
||||||
|
|
||||||
#define TEST(x) if (!(x)) { \
|
#define TEST(x) if (!(x)) { \
|
||||||
printf("Test " #x " failed.\n"); \
|
printf("Test " #x " failed.\n"); \
|
||||||
@@ -1,14 +1,15 @@
|
|||||||
/* Attempts to test all the datatypes supported by ProtoBuf.
|
/* Attempts to test all the datatypes supported by ProtoBuf.
|
||||||
* This is a backwards-compatibility test, using bc_alltypes.pb.h.
|
* This is a backwards-compatibility test, using alltypes_legacy.h.
|
||||||
* It is similar to test_encode3, but duplicated in order to allow
|
* It is similar to encode_alltypes, but duplicated in order to allow
|
||||||
* test_encode3 to test any new features introduced later.
|
* encode_alltypes to test any new features introduced later.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <stdlib.h>
|
#include <stdlib.h>
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
#include <pb_encode.h>
|
#include <pb_encode.h>
|
||||||
#include "bc_alltypes.pb.h"
|
#include "alltypes_legacy.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
int main(int argc, char **argv)
|
int main(int argc, char **argv)
|
||||||
{
|
{
|
||||||
@@ -114,18 +115,21 @@ int main(int argc, char **argv)
|
|||||||
|
|
||||||
alltypes.end = 1099;
|
alltypes.end = 1099;
|
||||||
|
|
||||||
uint8_t buffer[1024];
|
{
|
||||||
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
uint8_t buffer[1024];
|
||||||
|
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, AllTypes_fields, &alltypes))
|
if (pb_encode(&stream, AllTypes_fields, &alltypes))
|
||||||
{
|
{
|
||||||
fwrite(buffer, 1, stream.bytes_written, stdout);
|
SET_BINARY_MODE(stdout);
|
||||||
return 0; /* Success */
|
fwrite(buffer, 1, stream.bytes_written, stdout);
|
||||||
}
|
return 0; /* Success */
|
||||||
else
|
}
|
||||||
{
|
else
|
||||||
fprintf(stderr, "Encoding failed!\n");
|
{
|
||||||
return 1; /* Failure */
|
fprintf(stderr, "Encoding failed!\n");
|
||||||
|
return 1; /* Failure */
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
12
tests/basic_buffer/SConscript
Normal file
12
tests/basic_buffer/SConscript
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Build and run a basic round-trip test using memory buffer encoding.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
enc = env.Program(["encode_buffer.c", "#common/person.pb.c", "#common/pb_encode.o"])
|
||||||
|
dec = env.Program(["decode_buffer.c", "#common/person.pb.c", "#common/pb_decode.o"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_buffer.output"])
|
||||||
|
env.Decode(["encode_buffer.output", "#common/person.proto"], MESSAGE = "Person")
|
||||||
|
env.Compare(["decode_buffer.output", "encode_buffer.decoded"])
|
||||||
|
|
||||||
@@ -9,6 +9,7 @@
|
|||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <pb_decode.h>
|
#include <pb_decode.h>
|
||||||
#include "person.pb.h"
|
#include "person.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
/* This function is called once from main(), it handles
|
/* This function is called once from main(), it handles
|
||||||
the decoding and printing. */
|
the decoding and printing. */
|
||||||
@@ -59,9 +60,13 @@ bool print_person(pb_istream_t *stream)
|
|||||||
|
|
||||||
int main()
|
int main()
|
||||||
{
|
{
|
||||||
/* Read the data into buffer */
|
|
||||||
uint8_t buffer[512];
|
uint8_t buffer[512];
|
||||||
size_t count = fread(buffer, 1, sizeof(buffer), stdin);
|
pb_istream_t stream;
|
||||||
|
size_t count;
|
||||||
|
|
||||||
|
/* Read the data into buffer */
|
||||||
|
SET_BINARY_MODE(stdin);
|
||||||
|
count = fread(buffer, 1, sizeof(buffer), stdin);
|
||||||
|
|
||||||
if (!feof(stdin))
|
if (!feof(stdin))
|
||||||
{
|
{
|
||||||
@@ -70,7 +75,7 @@ int main()
|
|||||||
}
|
}
|
||||||
|
|
||||||
/* Construct a pb_istream_t for reading from the buffer */
|
/* Construct a pb_istream_t for reading from the buffer */
|
||||||
pb_istream_t stream = pb_istream_from_buffer(buffer, count);
|
stream = pb_istream_from_buffer(buffer, count);
|
||||||
|
|
||||||
/* Decode and print out the stuff */
|
/* Decode and print out the stuff */
|
||||||
if (!print_person(&stream))
|
if (!print_person(&stream))
|
||||||
@@ -6,9 +6,13 @@
|
|||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <pb_encode.h>
|
#include <pb_encode.h>
|
||||||
#include "person.pb.h"
|
#include "person.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
int main()
|
int main()
|
||||||
{
|
{
|
||||||
|
uint8_t buffer[512];
|
||||||
|
pb_ostream_t stream;
|
||||||
|
|
||||||
/* Initialize the structure with constants */
|
/* Initialize the structure with constants */
|
||||||
Person person = {"Test Person 99", 99, true, "test@person.com",
|
Person person = {"Test Person 99", 99, true, "test@person.com",
|
||||||
3, {{"555-12345678", true, Person_PhoneType_MOBILE},
|
3, {{"555-12345678", true, Person_PhoneType_MOBILE},
|
||||||
@@ -16,17 +20,19 @@ int main()
|
|||||||
{"1234-5678", true, Person_PhoneType_WORK},
|
{"1234-5678", true, Person_PhoneType_WORK},
|
||||||
}};
|
}};
|
||||||
|
|
||||||
uint8_t buffer[512];
|
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_fields, &person))
|
if (pb_encode(&stream, Person_fields, &person))
|
||||||
{
|
{
|
||||||
|
/* Write the result data to stdout */
|
||||||
|
SET_BINARY_MODE(stdout);
|
||||||
fwrite(buffer, 1, stream.bytes_written, stdout);
|
fwrite(buffer, 1, stream.bytes_written, stdout);
|
||||||
return 0; /* Success */
|
return 0; /* Success */
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
|
fprintf(stderr, "Encoding failed: %s\n", PB_GET_ERROR(&stream));
|
||||||
return 1; /* Failure */
|
return 1; /* Failure */
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
12
tests/basic_stream/SConscript
Normal file
12
tests/basic_stream/SConscript
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Build and run a basic round-trip test using direct stream encoding.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
enc = env.Program(["encode_stream.c", "#common/person.pb.c", "#common/pb_encode.o"])
|
||||||
|
dec = env.Program(["decode_stream.c", "#common/person.pb.c", "#common/pb_decode.o"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_stream.output"])
|
||||||
|
env.Decode(["encode_stream.output", "#common/person.proto"], MESSAGE = "Person")
|
||||||
|
env.Compare(["decode_stream.output", "encode_stream.decoded"])
|
||||||
|
|
||||||
@@ -4,6 +4,7 @@
|
|||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <pb_decode.h>
|
#include <pb_decode.h>
|
||||||
#include "person.pb.h"
|
#include "person.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
/* This function is called once from main(), it handles
|
/* This function is called once from main(), it handles
|
||||||
the decoding and printing.
|
the decoding and printing.
|
||||||
@@ -69,10 +70,10 @@ bool callback(pb_istream_t *stream, uint8_t *buf, size_t count)
|
|||||||
|
|
||||||
int main()
|
int main()
|
||||||
{
|
{
|
||||||
/* Maximum size is specified to prevent infinite length messages from
|
pb_istream_t stream = {&callback, NULL, SIZE_MAX};
|
||||||
* hanging this in the fuzz test.
|
stream.state = stdin;
|
||||||
*/
|
SET_BINARY_MODE(stdin);
|
||||||
pb_istream_t stream = {&callback, stdin, 10000};
|
|
||||||
if (!print_person(&stream))
|
if (!print_person(&stream))
|
||||||
{
|
{
|
||||||
printf("Parsing failed: %s\n", PB_GET_ERROR(&stream));
|
printf("Parsing failed: %s\n", PB_GET_ERROR(&stream));
|
||||||
@@ -4,6 +4,7 @@
|
|||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <pb_encode.h>
|
#include <pb_encode.h>
|
||||||
#include "person.pb.h"
|
#include "person.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
/* This binds the pb_ostream_t into the stdout stream */
|
/* This binds the pb_ostream_t into the stdout stream */
|
||||||
bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
|
bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
|
||||||
@@ -22,11 +23,18 @@ int main()
|
|||||||
}};
|
}};
|
||||||
|
|
||||||
/* 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, NULL, SIZE_MAX, 0};
|
||||||
|
stream.state = stdout;
|
||||||
|
SET_BINARY_MODE(stdout);
|
||||||
|
|
||||||
/* Now encode it and check if we succeeded. */
|
/* Now encode it and check if we succeeded. */
|
||||||
if (pb_encode(&stream, Person_fields, &person))
|
if (pb_encode(&stream, Person_fields, &person))
|
||||||
|
{
|
||||||
return 0; /* Success */
|
return 0; /* Success */
|
||||||
|
}
|
||||||
else
|
else
|
||||||
|
{
|
||||||
|
fprintf(stderr, "Encoding failed: %s\n", PB_GET_ERROR(&stream));
|
||||||
return 1; /* Failure */
|
return 1; /* Failure */
|
||||||
|
}
|
||||||
}
|
}
|
||||||
23
tests/buffer_only/SConscript
Normal file
23
tests/buffer_only/SConscript
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# Run the alltypes test case, but compile with PB_BUFFER_ONLY=1
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
# Take copy of the files for custom build.
|
||||||
|
c = Copy("$TARGET", "$SOURCE")
|
||||||
|
env.Command("pb_encode.c", "#../pb_encode.c", c)
|
||||||
|
env.Command("pb_decode.c", "#../pb_decode.c", c)
|
||||||
|
env.Command("alltypes.pb.h", "#alltypes/alltypes.pb.h", c)
|
||||||
|
env.Command("alltypes.pb.c", "#alltypes/alltypes.pb.c", c)
|
||||||
|
env.Command("encode_alltypes.c", "#alltypes/encode_alltypes.c", c)
|
||||||
|
env.Command("decode_alltypes.c", "#alltypes/decode_alltypes.c", c)
|
||||||
|
|
||||||
|
# Define the compilation options
|
||||||
|
opts = env.Clone()
|
||||||
|
opts.Append(CPPDEFINES = {'PB_BUFFER_ONLY': 1})
|
||||||
|
|
||||||
|
# Now build and run the test normally.
|
||||||
|
enc = opts.Program(["encode_alltypes.c", "alltypes.pb.c", "pb_encode.c"])
|
||||||
|
dec = opts.Program(["decode_alltypes.c", "alltypes.pb.c", "pb_decode.c"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_alltypes.output"])
|
||||||
14
tests/callbacks/SConscript
Normal file
14
tests/callbacks/SConscript
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# Test the functionality of the callback fields.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
env.NanopbProto("callbacks")
|
||||||
|
enc = env.Program(["encode_callbacks.c", "callbacks.pb.c", "#common/pb_encode.o"])
|
||||||
|
dec = env.Program(["decode_callbacks.c", "callbacks.pb.c", "#common/pb_decode.o"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_callbacks.output"])
|
||||||
|
|
||||||
|
env.Decode(["encode_callbacks.output", "callbacks.proto"], MESSAGE = "TestMessage")
|
||||||
|
env.Compare(["decode_callbacks.output", "encode_callbacks.decoded"])
|
||||||
|
|
||||||
@@ -11,5 +11,6 @@ message TestMessage {
|
|||||||
repeated fixed32 fixed32value = 3;
|
repeated fixed32 fixed32value = 3;
|
||||||
repeated fixed64 fixed64value = 4;
|
repeated fixed64 fixed64value = 4;
|
||||||
optional SubMessage submsg = 5;
|
optional SubMessage submsg = 5;
|
||||||
|
repeated string repeatedstring = 6;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -5,8 +5,9 @@
|
|||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <pb_decode.h>
|
#include <pb_decode.h>
|
||||||
#include "callbacks.pb.h"
|
#include "callbacks.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
bool print_string(pb_istream_t *stream, const pb_field_t *field, void *arg)
|
bool print_string(pb_istream_t *stream, const pb_field_t *field, void **arg)
|
||||||
{
|
{
|
||||||
uint8_t buffer[1024] = {0};
|
uint8_t buffer[1024] = {0};
|
||||||
|
|
||||||
@@ -20,51 +21,54 @@ bool print_string(pb_istream_t *stream, const pb_field_t *field, void *arg)
|
|||||||
/* Print the string, in format comparable with protoc --decode.
|
/* Print the string, in format comparable with protoc --decode.
|
||||||
* Format comes from the arg defined in main().
|
* Format comes from the arg defined in main().
|
||||||
*/
|
*/
|
||||||
printf((char*)arg, buffer);
|
printf((char*)*arg, buffer);
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool print_int32(pb_istream_t *stream, const pb_field_t *field, void *arg)
|
bool print_int32(pb_istream_t *stream, const pb_field_t *field, void **arg)
|
||||||
{
|
{
|
||||||
uint64_t value;
|
uint64_t value;
|
||||||
if (!pb_decode_varint(stream, &value))
|
if (!pb_decode_varint(stream, &value))
|
||||||
return false;
|
return false;
|
||||||
|
|
||||||
printf((char*)arg, (long)value);
|
printf((char*)*arg, (long)value);
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool print_fixed32(pb_istream_t *stream, const pb_field_t *field, void *arg)
|
bool print_fixed32(pb_istream_t *stream, const pb_field_t *field, void **arg)
|
||||||
{
|
{
|
||||||
uint32_t value;
|
uint32_t value;
|
||||||
if (!pb_decode_fixed32(stream, &value))
|
if (!pb_decode_fixed32(stream, &value))
|
||||||
return false;
|
return false;
|
||||||
|
|
||||||
printf((char*)arg, (long)value);
|
printf((char*)*arg, (long)value);
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool print_fixed64(pb_istream_t *stream, const pb_field_t *field, void *arg)
|
bool print_fixed64(pb_istream_t *stream, const pb_field_t *field, void **arg)
|
||||||
{
|
{
|
||||||
uint64_t value;
|
uint64_t value;
|
||||||
if (!pb_decode_fixed64(stream, &value))
|
if (!pb_decode_fixed64(stream, &value))
|
||||||
return false;
|
return false;
|
||||||
|
|
||||||
printf((char*)arg, (long long)value);
|
printf((char*)*arg, (long)value);
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
int main()
|
int main()
|
||||||
{
|
{
|
||||||
uint8_t buffer[1024];
|
uint8_t buffer[1024];
|
||||||
size_t length = fread(buffer, 1, 1024, stdin);
|
size_t length;
|
||||||
pb_istream_t stream = pb_istream_from_buffer(buffer, length);
|
pb_istream_t stream;
|
||||||
|
|
||||||
/* Note: empty initializer list initializes the struct with all-0.
|
/* Note: empty initializer list initializes the struct with all-0.
|
||||||
* This is recommended so that unused callbacks are set to NULL instead
|
* This is recommended so that unused callbacks are set to NULL instead
|
||||||
* of crashing at runtime.
|
* of crashing at runtime.
|
||||||
*/
|
*/
|
||||||
TestMessage testmessage = {};
|
TestMessage testmessage = {{{NULL}}};
|
||||||
|
|
||||||
|
SET_BINARY_MODE(stdin);
|
||||||
|
length = fread(buffer, 1, 1024, stdin);
|
||||||
|
stream = pb_istream_from_buffer(buffer, length);
|
||||||
|
|
||||||
testmessage.submsg.stringvalue.funcs.decode = &print_string;
|
testmessage.submsg.stringvalue.funcs.decode = &print_string;
|
||||||
testmessage.submsg.stringvalue.arg = "submsg {\n stringvalue: \"%s\"\n";
|
testmessage.submsg.stringvalue.arg = "submsg {\n stringvalue: \"%s\"\n";
|
||||||
@@ -73,7 +77,7 @@ int main()
|
|||||||
testmessage.submsg.fixed32value.funcs.decode = &print_fixed32;
|
testmessage.submsg.fixed32value.funcs.decode = &print_fixed32;
|
||||||
testmessage.submsg.fixed32value.arg = " fixed32value: %ld\n";
|
testmessage.submsg.fixed32value.arg = " fixed32value: %ld\n";
|
||||||
testmessage.submsg.fixed64value.funcs.decode = &print_fixed64;
|
testmessage.submsg.fixed64value.funcs.decode = &print_fixed64;
|
||||||
testmessage.submsg.fixed64value.arg = " fixed64value: %lld\n}\n";
|
testmessage.submsg.fixed64value.arg = " fixed64value: %ld\n}\n";
|
||||||
|
|
||||||
testmessage.stringvalue.funcs.decode = &print_string;
|
testmessage.stringvalue.funcs.decode = &print_string;
|
||||||
testmessage.stringvalue.arg = "stringvalue: \"%s\"\n";
|
testmessage.stringvalue.arg = "stringvalue: \"%s\"\n";
|
||||||
@@ -82,7 +86,9 @@ int main()
|
|||||||
testmessage.fixed32value.funcs.decode = &print_fixed32;
|
testmessage.fixed32value.funcs.decode = &print_fixed32;
|
||||||
testmessage.fixed32value.arg = "fixed32value: %ld\n";
|
testmessage.fixed32value.arg = "fixed32value: %ld\n";
|
||||||
testmessage.fixed64value.funcs.decode = &print_fixed64;
|
testmessage.fixed64value.funcs.decode = &print_fixed64;
|
||||||
testmessage.fixed64value.arg = "fixed64value: %lld\n";
|
testmessage.fixed64value.arg = "fixed64value: %ld\n";
|
||||||
|
testmessage.repeatedstring.funcs.decode = &print_string;
|
||||||
|
testmessage.repeatedstring.arg = "repeatedstring: \"%s\"\n";
|
||||||
|
|
||||||
if (!pb_decode(&stream, TestMessage_fields, &testmessage))
|
if (!pb_decode(&stream, TestMessage_fields, &testmessage))
|
||||||
return 1;
|
return 1;
|
||||||
@@ -4,8 +4,9 @@
|
|||||||
#include <string.h>
|
#include <string.h>
|
||||||
#include <pb_encode.h>
|
#include <pb_encode.h>
|
||||||
#include "callbacks.pb.h"
|
#include "callbacks.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
bool encode_string(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
|
bool encode_string(pb_ostream_t *stream, const pb_field_t *field, void * const *arg)
|
||||||
{
|
{
|
||||||
char *str = "Hello world!";
|
char *str = "Hello world!";
|
||||||
|
|
||||||
@@ -15,7 +16,7 @@ bool encode_string(pb_ostream_t *stream, const pb_field_t *field, const void *ar
|
|||||||
return pb_encode_string(stream, (uint8_t*)str, strlen(str));
|
return pb_encode_string(stream, (uint8_t*)str, strlen(str));
|
||||||
}
|
}
|
||||||
|
|
||||||
bool encode_int32(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
|
bool encode_int32(pb_ostream_t *stream, const pb_field_t *field, void * const *arg)
|
||||||
{
|
{
|
||||||
if (!pb_encode_tag_for_field(stream, field))
|
if (!pb_encode_tag_for_field(stream, field))
|
||||||
return false;
|
return false;
|
||||||
@@ -23,29 +24,49 @@ bool encode_int32(pb_ostream_t *stream, const pb_field_t *field, const void *arg
|
|||||||
return pb_encode_varint(stream, 42);
|
return pb_encode_varint(stream, 42);
|
||||||
}
|
}
|
||||||
|
|
||||||
bool encode_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
|
bool encode_fixed32(pb_ostream_t *stream, const pb_field_t *field, void * const *arg)
|
||||||
{
|
{
|
||||||
|
uint32_t value = 42;
|
||||||
|
|
||||||
if (!pb_encode_tag_for_field(stream, field))
|
if (!pb_encode_tag_for_field(stream, field))
|
||||||
return false;
|
return false;
|
||||||
|
|
||||||
uint32_t value = 42;
|
|
||||||
return pb_encode_fixed32(stream, &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, void * const *arg)
|
||||||
{
|
{
|
||||||
|
uint64_t value = 42;
|
||||||
|
|
||||||
if (!pb_encode_tag_for_field(stream, field))
|
if (!pb_encode_tag_for_field(stream, field))
|
||||||
return false;
|
return false;
|
||||||
|
|
||||||
uint64_t value = 42;
|
|
||||||
return pb_encode_fixed64(stream, &value);
|
return pb_encode_fixed64(stream, &value);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
bool encode_repeatedstring(pb_ostream_t *stream, const pb_field_t *field, void * const *arg)
|
||||||
|
{
|
||||||
|
char *str[4] = {"Hello world!", "", "Test", "Test2"};
|
||||||
|
int i;
|
||||||
|
|
||||||
|
for (i = 0; i < 4; i++)
|
||||||
|
{
|
||||||
|
if (!pb_encode_tag_for_field(stream, field))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (!pb_encode_string(stream, (uint8_t*)str[i], strlen(str[i])))
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
int main()
|
int main()
|
||||||
{
|
{
|
||||||
uint8_t buffer[1024];
|
uint8_t buffer[1024];
|
||||||
pb_ostream_t stream = pb_ostream_from_buffer(buffer, 1024);
|
pb_ostream_t stream;
|
||||||
TestMessage testmessage = {};
|
TestMessage testmessage = {{{NULL}}};
|
||||||
|
|
||||||
|
stream = pb_ostream_from_buffer(buffer, 1024);
|
||||||
|
|
||||||
testmessage.stringvalue.funcs.encode = &encode_string;
|
testmessage.stringvalue.funcs.encode = &encode_string;
|
||||||
testmessage.int32value.funcs.encode = &encode_int32;
|
testmessage.int32value.funcs.encode = &encode_int32;
|
||||||
@@ -58,9 +79,12 @@ int main()
|
|||||||
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;
|
||||||
|
|
||||||
|
testmessage.repeatedstring.funcs.encode = &encode_repeatedstring;
|
||||||
|
|
||||||
if (!pb_encode(&stream, TestMessage_fields, &testmessage))
|
if (!pb_encode(&stream, TestMessage_fields, &testmessage))
|
||||||
return 1;
|
return 1;
|
||||||
|
|
||||||
|
SET_BINARY_MODE(stdout);
|
||||||
if (fwrite(buffer, stream.bytes_written, 1, stdout) != 1)
|
if (fwrite(buffer, stream.bytes_written, 1, stdout) != 1)
|
||||||
return 2;
|
return 2;
|
||||||
|
|
||||||
17
tests/common/SConscript
Normal file
17
tests/common/SConscript
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# Build the common files needed by multiple test cases
|
||||||
|
|
||||||
|
Import('env')
|
||||||
|
|
||||||
|
# Protocol definitions for the encode/decode_unittests
|
||||||
|
env.NanopbProto("unittestproto")
|
||||||
|
|
||||||
|
# Protocol definitions for basic_buffer/stream tests
|
||||||
|
env.NanopbProto("person")
|
||||||
|
|
||||||
|
# Binaries of the pb_decode.c and pb_encode.c
|
||||||
|
# These are built using more strict warning flags.
|
||||||
|
strict = env.Clone()
|
||||||
|
strict.Append(CFLAGS = strict['CORECFLAGS'])
|
||||||
|
strict.Object("pb_decode.o", "#../pb_decode.c")
|
||||||
|
strict.Object("pb_encode.o", "#../pb_encode.c")
|
||||||
|
|
||||||
17
tests/common/test_helpers.h
Normal file
17
tests/common/test_helpers.h
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
/* Compatibility helpers for the test programs. */
|
||||||
|
|
||||||
|
#ifndef _TEST_HELPERS_H_
|
||||||
|
#define _TEST_HELPERS_H_
|
||||||
|
|
||||||
|
#ifdef _WIN32
|
||||||
|
#include <io.h>
|
||||||
|
#include <fcntl.h>
|
||||||
|
#define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY)
|
||||||
|
|
||||||
|
#else
|
||||||
|
#define SET_BINARY_MODE(file)
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#endif
|
||||||
@@ -8,6 +8,10 @@ message FloatArray {
|
|||||||
repeated float data = 1 [(nanopb).max_count = 10];
|
repeated float data = 1 [(nanopb).max_count = 10];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
message StringMessage {
|
||||||
|
required string data = 1 [(nanopb).max_size = 10];
|
||||||
|
}
|
||||||
|
|
||||||
message CallbackArray {
|
message CallbackArray {
|
||||||
// We cheat a bit and use this message for testing other types, too.
|
// We cheat a bit and use this message for testing other types, too.
|
||||||
// Nanopb does not care about the actual defined data type for callback
|
// Nanopb does not care about the actual defined data type for callback
|
||||||
20
tests/cxx_main_program/SConscript
Normal file
20
tests/cxx_main_program/SConscript
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Run the alltypes test case, but compile it as C++ instead.
|
||||||
|
# In fact, compile the entire nanopb using C++ compiler.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
# Copy the files to .cxx extension in order to force C++ build.
|
||||||
|
c = Copy("$TARGET", "$SOURCE")
|
||||||
|
env.Command("pb_encode.cxx", "#../pb_encode.c", c)
|
||||||
|
env.Command("pb_decode.cxx", "#../pb_decode.c", c)
|
||||||
|
env.Command("alltypes.pb.h", "#alltypes/alltypes.pb.h", c)
|
||||||
|
env.Command("alltypes.pb.cxx", "#alltypes/alltypes.pb.c", c)
|
||||||
|
env.Command("encode_alltypes.cxx", "#alltypes/encode_alltypes.c", c)
|
||||||
|
env.Command("decode_alltypes.cxx", "#alltypes/decode_alltypes.c", c)
|
||||||
|
|
||||||
|
# Now build and run the test normally.
|
||||||
|
enc = env.Program(["encode_alltypes.cxx", "alltypes.pb.cxx", "pb_encode.cxx"])
|
||||||
|
dec = env.Program(["decode_alltypes.cxx", "alltypes.pb.cxx", "pb_decode.cxx"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_alltypes.output"])
|
||||||
4
tests/decode_unittests/SConscript
Normal file
4
tests/decode_unittests/SConscript
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
Import('env')
|
||||||
|
p = env.Program(["decode_unittests.c", "#common/unittestproto.pb.c", "#common/pb_decode.o"])
|
||||||
|
env.RunTest(p)
|
||||||
|
|
||||||
@@ -19,11 +19,11 @@ bool stream_callback(pb_istream_t *stream, uint8_t *buf, size_t count)
|
|||||||
}
|
}
|
||||||
|
|
||||||
/* Verifies that the stream passed to callback matches the byte array pointed to by arg. */
|
/* Verifies that the stream passed to callback matches the byte array pointed to by arg. */
|
||||||
bool callback_check(pb_istream_t *stream, const pb_field_t *field, void *arg)
|
bool callback_check(pb_istream_t *stream, const pb_field_t *field, void **arg)
|
||||||
{
|
{
|
||||||
int i;
|
int i;
|
||||||
uint8_t byte;
|
uint8_t byte;
|
||||||
pb_bytes_array_t *ref = (pb_bytes_array_t*) arg;
|
pb_bytes_array_t *ref = (pb_bytes_array_t*) *arg;
|
||||||
|
|
||||||
for (i = 0; i < ref->size; i++)
|
for (i = 0; i < ref->size; i++)
|
||||||
{
|
{
|
||||||
@@ -289,6 +289,16 @@ int main()
|
|||||||
TEST((s = S("\x08"), !pb_decode(&s, IntegerArray_fields, &dest)))
|
TEST((s = S("\x08"), !pb_decode(&s, IntegerArray_fields, &dest)))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
pb_istream_t s;
|
||||||
|
IntegerContainer dest = {{0}};
|
||||||
|
|
||||||
|
COMMENT("Testing pb_decode_delimited")
|
||||||
|
TEST((s = S("\x09\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"),
|
||||||
|
pb_decode_delimited(&s, IntegerContainer_fields, &dest)) &&
|
||||||
|
dest.submsg.data_count == 5)
|
||||||
|
}
|
||||||
|
|
||||||
if (status != 0)
|
if (status != 0)
|
||||||
fprintf(stdout, "\n\nSome tests FAILED!\n");
|
fprintf(stdout, "\n\nSome tests FAILED!\n");
|
||||||
|
|
||||||
5
tests/encode_unittests/SConscript
Normal file
5
tests/encode_unittests/SConscript
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
# Build and run the stand-alone unit tests for the nanopb encoder part.
|
||||||
|
|
||||||
|
Import('env')
|
||||||
|
p = env.Program(["encode_unittests.c", "#common/unittestproto.pb.c", "#common/pb_encode.o"])
|
||||||
|
env.RunTest(p)
|
||||||
@@ -17,7 +17,7 @@ bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool fieldcallback(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
|
bool fieldcallback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg)
|
||||||
{
|
{
|
||||||
int value = 0x55;
|
int value = 0x55;
|
||||||
if (!pb_encode_tag_for_field(stream, field))
|
if (!pb_encode_tag_for_field(stream, field))
|
||||||
@@ -25,7 +25,7 @@ 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 crazyfieldcallback(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
|
bool crazyfieldcallback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg)
|
||||||
{
|
{
|
||||||
/* This callback writes different amount of data the second time. */
|
/* This callback writes different amount of data the second time. */
|
||||||
uint32_t *state = (uint32_t*)arg;
|
uint32_t *state = (uint32_t*)arg;
|
||||||
@@ -180,12 +180,14 @@ int main()
|
|||||||
{
|
{
|
||||||
uint8_t buffer[30];
|
uint8_t buffer[30];
|
||||||
pb_ostream_t s;
|
pb_ostream_t s;
|
||||||
char value[] = "xyzzy";
|
char value[30] = "xyzzy";
|
||||||
|
|
||||||
COMMENT("Test pb_enc_string")
|
COMMENT("Test pb_enc_string")
|
||||||
TEST(WRITES(pb_enc_string(&s, NULL, &value), "\x05xyzzy"))
|
TEST(WRITES(pb_enc_string(&s, &StringMessage_fields[0], &value), "\x05xyzzy"))
|
||||||
value[0] = '\0';
|
value[0] = '\0';
|
||||||
TEST(WRITES(pb_enc_string(&s, NULL, &value), "\x00"))
|
TEST(WRITES(pb_enc_string(&s, &StringMessage_fields[0], &value), "\x00"))
|
||||||
|
memset(value, 'x', 30);
|
||||||
|
TEST(WRITES(pb_enc_string(&s, &StringMessage_fields[0], &value), "\x0Axxxxxxxxxx"))
|
||||||
}
|
}
|
||||||
|
|
||||||
{
|
{
|
||||||
@@ -242,6 +244,16 @@ int main()
|
|||||||
"\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"))
|
"\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
uint8_t buffer[20];
|
||||||
|
pb_ostream_t s;
|
||||||
|
IntegerContainer msg = {{5, {1,2,3,4,5}}};
|
||||||
|
|
||||||
|
COMMENT("Test pb_encode_delimited.")
|
||||||
|
TEST(WRITES(pb_encode_delimited(&s, IntegerContainer_fields, &msg),
|
||||||
|
"\x09\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;
|
||||||
16
tests/extensions/SConscript
Normal file
16
tests/extensions/SConscript
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# Test the support for extension fields.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
# We use the files from the alltypes test case
|
||||||
|
incpath = env.Clone()
|
||||||
|
incpath.Append(PROTOCPATH = '#alltypes')
|
||||||
|
incpath.Append(CPPPATH = '#alltypes')
|
||||||
|
|
||||||
|
incpath.NanopbProto("extensions")
|
||||||
|
enc = incpath.Program(["encode_extensions.c", "extensions.pb.c", "#alltypes/alltypes.pb$OBJSUFFIX", "#common/pb_encode.o"])
|
||||||
|
dec = incpath.Program(["decode_extensions.c", "extensions.pb.c", "#alltypes/alltypes.pb$OBJSUFFIX", "#common/pb_decode.o"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_extensions.output"])
|
||||||
|
|
||||||
58
tests/extensions/decode_extensions.c
Normal file
58
tests/extensions/decode_extensions.c
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
/* Test decoding of extension fields. */
|
||||||
|
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <pb_decode.h>
|
||||||
|
#include "alltypes.pb.h"
|
||||||
|
#include "extensions.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
|
#define TEST(x) if (!(x)) { \
|
||||||
|
printf("Test " #x " failed.\n"); \
|
||||||
|
return 2; \
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(int argc, char **argv)
|
||||||
|
{
|
||||||
|
uint8_t buffer[1024];
|
||||||
|
size_t count;
|
||||||
|
pb_istream_t stream;
|
||||||
|
|
||||||
|
AllTypes alltypes = {0};
|
||||||
|
int32_t extensionfield1;
|
||||||
|
pb_extension_t ext1;
|
||||||
|
ExtensionMessage extensionfield2;
|
||||||
|
pb_extension_t ext2;
|
||||||
|
|
||||||
|
/* Read the message data */
|
||||||
|
SET_BINARY_MODE(stdin);
|
||||||
|
count = fread(buffer, 1, sizeof(buffer), stdin);
|
||||||
|
stream = pb_istream_from_buffer(buffer, count);
|
||||||
|
|
||||||
|
/* Add the extensions */
|
||||||
|
alltypes.extensions = &ext1;
|
||||||
|
|
||||||
|
ext1.type = &AllTypes_extensionfield1;
|
||||||
|
ext1.dest = &extensionfield1;
|
||||||
|
ext1.next = &ext2;
|
||||||
|
|
||||||
|
ext2.type = &ExtensionMessage_AllTypes_extensionfield2;
|
||||||
|
ext2.dest = &extensionfield2;
|
||||||
|
ext2.next = NULL;
|
||||||
|
|
||||||
|
/* Decode the message */
|
||||||
|
if (!pb_decode(&stream, AllTypes_fields, &alltypes))
|
||||||
|
{
|
||||||
|
printf("Parsing failed: %s\n", PB_GET_ERROR(&stream));
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Check that the extensions decoded properly */
|
||||||
|
TEST(extensionfield1 == 12345)
|
||||||
|
TEST(strcmp(extensionfield2.test1, "test") == 0)
|
||||||
|
TEST(extensionfield2.test2 == 54321)
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
50
tests/extensions/encode_extensions.c
Normal file
50
tests/extensions/encode_extensions.c
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
/* Tests extension fields.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <pb_encode.h>
|
||||||
|
#include "alltypes.pb.h"
|
||||||
|
#include "extensions.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
|
int main(int argc, char **argv)
|
||||||
|
{
|
||||||
|
uint8_t buffer[1024];
|
||||||
|
pb_ostream_t stream;
|
||||||
|
|
||||||
|
AllTypes alltypes = {0};
|
||||||
|
int32_t extensionfield1 = 12345;
|
||||||
|
pb_extension_t ext1;
|
||||||
|
ExtensionMessage extensionfield2 = {"test", 54321};
|
||||||
|
pb_extension_t ext2;
|
||||||
|
|
||||||
|
/* Set up the extensions */
|
||||||
|
alltypes.extensions = &ext1;
|
||||||
|
|
||||||
|
ext1.type = &AllTypes_extensionfield1;
|
||||||
|
ext1.dest = &extensionfield1;
|
||||||
|
ext1.next = &ext2;
|
||||||
|
|
||||||
|
ext2.type = &ExtensionMessage_AllTypes_extensionfield2;
|
||||||
|
ext2.dest = &extensionfield2;
|
||||||
|
ext2.next = NULL;
|
||||||
|
|
||||||
|
/* Set up the output stream */
|
||||||
|
stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
||||||
|
|
||||||
|
/* Now encode the message and check if we succeeded. */
|
||||||
|
if (pb_encode(&stream, AllTypes_fields, &alltypes))
|
||||||
|
{
|
||||||
|
SET_BINARY_MODE(stdout);
|
||||||
|
fwrite(buffer, 1, stream.bytes_written, stdout);
|
||||||
|
return 0; /* Success */
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
fprintf(stderr, "Encoding failed: %s\n", PB_GET_ERROR(&stream));
|
||||||
|
return 1; /* Failure */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
1
tests/extensions/extensions.options
Normal file
1
tests/extensions/extensions.options
Normal file
@@ -0,0 +1 @@
|
|||||||
|
* max_size:16
|
||||||
17
tests/extensions/extensions.proto
Normal file
17
tests/extensions/extensions.proto
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
import 'alltypes.proto';
|
||||||
|
|
||||||
|
extend AllTypes {
|
||||||
|
optional int32 AllTypes_extensionfield1 = 255;
|
||||||
|
}
|
||||||
|
|
||||||
|
message ExtensionMessage {
|
||||||
|
extend AllTypes {
|
||||||
|
optional ExtensionMessage AllTypes_extensionfield2 = 254;
|
||||||
|
required ExtensionMessage AllTypes_extensionfield3 = 253;
|
||||||
|
repeated ExtensionMessage AllTypes_extensionfield4 = 252;
|
||||||
|
}
|
||||||
|
|
||||||
|
required string test1 = 1;
|
||||||
|
required int32 test2 = 2;
|
||||||
|
}
|
||||||
|
|
||||||
10
tests/extra_fields/SConscript
Normal file
10
tests/extra_fields/SConscript
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Test that the decoder properly handles unknown fields in the input.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
dec = env.GetBuildPath('#basic_buffer/${PROGPREFIX}decode_buffer${PROGSUFFIX}')
|
||||||
|
env.RunTest('person_with_extra_field.output', [dec, "person_with_extra_field.pb"])
|
||||||
|
env.Compare(["person_with_extra_field.output", "person_with_extra_field.expected"])
|
||||||
|
|
||||||
|
dec2 = env.GetBuildPath('#alltypes/${PROGPREFIX}decode_alltypes${PROGSUFFIX}')
|
||||||
|
env.RunTest('alltypes_with_extra_fields.output', [dec2, 'alltypes_with_extra_fields.pb'])
|
||||||
BIN
tests/extra_fields/alltypes_with_extra_fields.pb
Normal file
BIN
tests/extra_fields/alltypes_with_extra_fields.pb
Normal file
Binary file not shown.
14
tests/extra_fields/person_with_extra_field.expected
Normal file
14
tests/extra_fields/person_with_extra_field.expected
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
name: "Test Person 99"
|
||||||
|
id: 99
|
||||||
|
email: "test@person.com"
|
||||||
|
phone {
|
||||||
|
number: "555-12345678"
|
||||||
|
type: MOBILE
|
||||||
|
}
|
||||||
|
phone {
|
||||||
|
number: "99-2342"
|
||||||
|
}
|
||||||
|
phone {
|
||||||
|
number: "1234-5678"
|
||||||
|
type: WORK
|
||||||
|
}
|
||||||
24
tests/field_size_16/SConscript
Normal file
24
tests/field_size_16/SConscript
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Run the alltypes test case, but compile with PB_FIELD_16BIT=1.
|
||||||
|
# Also the .proto file has been modified to have high indexes.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
# Take copy of the files for custom build.
|
||||||
|
c = Copy("$TARGET", "$SOURCE")
|
||||||
|
env.Command("pb_encode.c", "#../pb_encode.c", c)
|
||||||
|
env.Command("pb_decode.c", "#../pb_decode.c", c)
|
||||||
|
env.Command("encode_alltypes.c", "#alltypes/encode_alltypes.c", c)
|
||||||
|
env.Command("decode_alltypes.c", "#alltypes/decode_alltypes.c", c)
|
||||||
|
|
||||||
|
env.NanopbProto("alltypes")
|
||||||
|
|
||||||
|
# Define the compilation options
|
||||||
|
opts = env.Clone()
|
||||||
|
opts.Append(CPPDEFINES = {'PB_FIELD_16BIT': 1})
|
||||||
|
|
||||||
|
# Now build and run the test normally.
|
||||||
|
enc = opts.Program(["encode_alltypes.c", "alltypes.pb.c", "pb_encode.c"])
|
||||||
|
dec = opts.Program(["decode_alltypes.c", "alltypes.pb.c", "pb_decode.c"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_alltypes.output"])
|
||||||
3
tests/field_size_16/alltypes.options
Normal file
3
tests/field_size_16/alltypes.options
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
* max_size:16
|
||||||
|
* max_count:5
|
||||||
|
|
||||||
90
tests/field_size_16/alltypes.proto
Normal file
90
tests/field_size_16/alltypes.proto
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
message SubMessage {
|
||||||
|
required string substuff1 = 1 [default = "1"];
|
||||||
|
required int32 substuff2 = 2 [default = 2];
|
||||||
|
optional fixed32 substuff3 = 65535 [default = 3];
|
||||||
|
}
|
||||||
|
|
||||||
|
message EmptyMessage {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
enum MyEnum {
|
||||||
|
Zero = 0;
|
||||||
|
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;
|
||||||
|
required bytes req_bytes = 15;
|
||||||
|
required SubMessage req_submsg = 16;
|
||||||
|
required MyEnum req_enum = 17;
|
||||||
|
required EmptyMessage req_emptymsg = 18;
|
||||||
|
|
||||||
|
|
||||||
|
repeated int32 rep_int32 = 21;
|
||||||
|
repeated int64 rep_int64 = 22;
|
||||||
|
repeated uint32 rep_uint32 = 23;
|
||||||
|
repeated uint64 rep_uint64 = 24;
|
||||||
|
repeated sint32 rep_sint32 = 25;
|
||||||
|
repeated sint64 rep_sint64 = 26;
|
||||||
|
repeated bool rep_bool = 27;
|
||||||
|
|
||||||
|
repeated fixed32 rep_fixed32 = 28;
|
||||||
|
repeated sfixed32 rep_sfixed32= 29;
|
||||||
|
repeated float rep_float = 30;
|
||||||
|
|
||||||
|
repeated fixed64 rep_fixed64 = 10031;
|
||||||
|
repeated sfixed64 rep_sfixed64= 10032;
|
||||||
|
repeated double rep_double = 10033;
|
||||||
|
|
||||||
|
repeated string rep_string = 10034;
|
||||||
|
repeated bytes rep_bytes = 10035;
|
||||||
|
repeated SubMessage rep_submsg = 10036;
|
||||||
|
repeated MyEnum rep_enum = 10037;
|
||||||
|
repeated EmptyMessage rep_emptymsg = 10038;
|
||||||
|
|
||||||
|
optional int32 opt_int32 = 10041 [default = 4041];
|
||||||
|
optional int64 opt_int64 = 10042 [default = 4042];
|
||||||
|
optional uint32 opt_uint32 = 10043 [default = 4043];
|
||||||
|
optional uint64 opt_uint64 = 10044 [default = 4044];
|
||||||
|
optional sint32 opt_sint32 = 10045 [default = 4045];
|
||||||
|
optional sint64 opt_sint64 = 10046 [default = 4046];
|
||||||
|
optional bool opt_bool = 10047 [default = false];
|
||||||
|
|
||||||
|
optional fixed32 opt_fixed32 = 10048 [default = 4048];
|
||||||
|
optional sfixed32 opt_sfixed32= 10049 [default = 4049];
|
||||||
|
optional float opt_float = 10050 [default = 4050];
|
||||||
|
|
||||||
|
optional fixed64 opt_fixed64 = 10051 [default = 4051];
|
||||||
|
optional sfixed64 opt_sfixed64= 10052 [default = 4052];
|
||||||
|
optional double opt_double = 10053 [default = 4053];
|
||||||
|
|
||||||
|
optional string opt_string = 10054 [default = "4054"];
|
||||||
|
optional bytes opt_bytes = 10055 [default = "4055"];
|
||||||
|
optional SubMessage opt_submsg = 10056;
|
||||||
|
optional MyEnum opt_enum = 10057 [default = Second];
|
||||||
|
optional EmptyMessage opt_emptymsg = 10058;
|
||||||
|
|
||||||
|
// 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 = 10099;
|
||||||
|
}
|
||||||
|
|
||||||
24
tests/field_size_32/SConscript
Normal file
24
tests/field_size_32/SConscript
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Run the alltypes test case, but compile with PB_FIELD_32BIT=1.
|
||||||
|
# Also the .proto file has been modified to have high indexes.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
# Take copy of the files for custom build.
|
||||||
|
c = Copy("$TARGET", "$SOURCE")
|
||||||
|
env.Command("pb_encode.c", "#../pb_encode.c", c)
|
||||||
|
env.Command("pb_decode.c", "#../pb_decode.c", c)
|
||||||
|
env.Command("encode_alltypes.c", "#alltypes/encode_alltypes.c", c)
|
||||||
|
env.Command("decode_alltypes.c", "#alltypes/decode_alltypes.c", c)
|
||||||
|
|
||||||
|
env.NanopbProto("alltypes")
|
||||||
|
|
||||||
|
# Define the compilation options
|
||||||
|
opts = env.Clone()
|
||||||
|
opts.Append(CPPDEFINES = {'PB_FIELD_32BIT': 1})
|
||||||
|
|
||||||
|
# Now build and run the test normally.
|
||||||
|
enc = opts.Program(["encode_alltypes.c", "alltypes.pb.c", "pb_encode.c"])
|
||||||
|
dec = opts.Program(["decode_alltypes.c", "alltypes.pb.c", "pb_decode.c"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_alltypes.output"])
|
||||||
3
tests/field_size_32/alltypes.options
Normal file
3
tests/field_size_32/alltypes.options
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
* max_size:16
|
||||||
|
* max_count:5
|
||||||
|
|
||||||
90
tests/field_size_32/alltypes.proto
Normal file
90
tests/field_size_32/alltypes.proto
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
message SubMessage {
|
||||||
|
required string substuff1 = 1 [default = "1"];
|
||||||
|
required int32 substuff2 = 2 [default = 2];
|
||||||
|
optional fixed32 substuff3 = 12365535 [default = 3];
|
||||||
|
}
|
||||||
|
|
||||||
|
message EmptyMessage {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
enum MyEnum {
|
||||||
|
Zero = 0;
|
||||||
|
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;
|
||||||
|
required bytes req_bytes = 15;
|
||||||
|
required SubMessage req_submsg = 16;
|
||||||
|
required MyEnum req_enum = 17;
|
||||||
|
required EmptyMessage req_emptymsg = 18;
|
||||||
|
|
||||||
|
|
||||||
|
repeated int32 rep_int32 = 21;
|
||||||
|
repeated int64 rep_int64 = 22;
|
||||||
|
repeated uint32 rep_uint32 = 23;
|
||||||
|
repeated uint64 rep_uint64 = 24;
|
||||||
|
repeated sint32 rep_sint32 = 25;
|
||||||
|
repeated sint64 rep_sint64 = 26;
|
||||||
|
repeated bool rep_bool = 27;
|
||||||
|
|
||||||
|
repeated fixed32 rep_fixed32 = 28;
|
||||||
|
repeated sfixed32 rep_sfixed32= 29;
|
||||||
|
repeated float rep_float = 30;
|
||||||
|
|
||||||
|
repeated fixed64 rep_fixed64 = 10031;
|
||||||
|
repeated sfixed64 rep_sfixed64= 10032;
|
||||||
|
repeated double rep_double = 10033;
|
||||||
|
|
||||||
|
repeated string rep_string = 10034;
|
||||||
|
repeated bytes rep_bytes = 10035;
|
||||||
|
repeated SubMessage rep_submsg = 10036;
|
||||||
|
repeated MyEnum rep_enum = 10037;
|
||||||
|
repeated EmptyMessage rep_emptymsg = 10038;
|
||||||
|
|
||||||
|
optional int32 opt_int32 = 10041 [default = 4041];
|
||||||
|
optional int64 opt_int64 = 10042 [default = 4042];
|
||||||
|
optional uint32 opt_uint32 = 10043 [default = 4043];
|
||||||
|
optional uint64 opt_uint64 = 10044 [default = 4044];
|
||||||
|
optional sint32 opt_sint32 = 10045 [default = 4045];
|
||||||
|
optional sint64 opt_sint64 = 10046 [default = 4046];
|
||||||
|
optional bool opt_bool = 10047 [default = false];
|
||||||
|
|
||||||
|
optional fixed32 opt_fixed32 = 10048 [default = 4048];
|
||||||
|
optional sfixed32 opt_sfixed32= 10049 [default = 4049];
|
||||||
|
optional float opt_float = 10050 [default = 4050];
|
||||||
|
|
||||||
|
optional fixed64 opt_fixed64 = 10051 [default = 4051];
|
||||||
|
optional sfixed64 opt_sfixed64= 10052 [default = 4052];
|
||||||
|
optional double opt_double = 10053 [default = 4053];
|
||||||
|
|
||||||
|
optional string opt_string = 10054 [default = "4054"];
|
||||||
|
optional bytes opt_bytes = 10055 [default = "4055"];
|
||||||
|
optional SubMessage opt_submsg = 10056;
|
||||||
|
optional MyEnum opt_enum = 10057 [default = Second];
|
||||||
|
optional EmptyMessage opt_emptymsg = 10058;
|
||||||
|
|
||||||
|
// 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 = 13432099;
|
||||||
|
}
|
||||||
|
|
||||||
8
tests/missing_fields/SConscript
Normal file
8
tests/missing_fields/SConscript
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Check that the decoder properly detects when required fields are missing.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
env.NanopbProto("missing_fields")
|
||||||
|
test = env.Program(["missing_fields.c", "missing_fields.pb.c", "#common/pb_encode.o", "#common/pb_decode.o"])
|
||||||
|
env.RunTest(test)
|
||||||
|
|
||||||
@@ -7,12 +7,13 @@
|
|||||||
|
|
||||||
int main()
|
int main()
|
||||||
{
|
{
|
||||||
uint8_t buffer[512] = {};
|
uint8_t buffer[512];
|
||||||
|
|
||||||
/* Create a message with one missing field */
|
/* Create a message with one missing field */
|
||||||
{
|
{
|
||||||
MissingField msg = {};
|
MissingField msg = {0};
|
||||||
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
||||||
|
|
||||||
if (!pb_encode(&stream, MissingField_fields, &msg))
|
if (!pb_encode(&stream, MissingField_fields, &msg))
|
||||||
{
|
{
|
||||||
printf("Encode failed.\n");
|
printf("Encode failed.\n");
|
||||||
@@ -22,7 +23,7 @@ int main()
|
|||||||
|
|
||||||
/* Test that it decodes properly if we don't require that field */
|
/* Test that it decodes properly if we don't require that field */
|
||||||
{
|
{
|
||||||
MissingField msg = {};
|
MissingField msg = {0};
|
||||||
pb_istream_t stream = pb_istream_from_buffer(buffer, sizeof(buffer));
|
pb_istream_t stream = pb_istream_from_buffer(buffer, sizeof(buffer));
|
||||||
|
|
||||||
if (!pb_decode(&stream, MissingField_fields, &msg))
|
if (!pb_decode(&stream, MissingField_fields, &msg))
|
||||||
@@ -34,7 +35,7 @@ int main()
|
|||||||
|
|
||||||
/* Test that it does *not* decode properly if we require the field */
|
/* Test that it does *not* decode properly if we require the field */
|
||||||
{
|
{
|
||||||
AllFields msg = {};
|
AllFields msg = {0};
|
||||||
pb_istream_t stream = pb_istream_from_buffer(buffer, sizeof(buffer));
|
pb_istream_t stream = pb_istream_from_buffer(buffer, sizeof(buffer));
|
||||||
|
|
||||||
if (pb_decode(&stream, AllFields_fields, &msg))
|
if (pb_decode(&stream, AllFields_fields, &msg))
|
||||||
13
tests/multiple_files/SConscript
Normal file
13
tests/multiple_files/SConscript
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# Test that multiple .proto files don't cause name collisions.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
incpath = env.Clone()
|
||||||
|
incpath.Append(PROTOCPATH = '#multiple_files')
|
||||||
|
|
||||||
|
incpath.NanopbProto("callbacks")
|
||||||
|
incpath.NanopbProto("callbacks2")
|
||||||
|
test = incpath.Program(["test_multiple_files.c", "callbacks.pb.c", "callbacks2.pb.c"])
|
||||||
|
|
||||||
|
env.RunTest(test)
|
||||||
|
|
||||||
16
tests/multiple_files/callbacks.proto
Normal file
16
tests/multiple_files/callbacks.proto
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
message SubMessage {
|
||||||
|
optional string stringvalue = 1;
|
||||||
|
repeated int32 int32value = 2;
|
||||||
|
repeated fixed32 fixed32value = 3;
|
||||||
|
repeated fixed64 fixed64value = 4;
|
||||||
|
}
|
||||||
|
|
||||||
|
message TestMessage {
|
||||||
|
optional string stringvalue = 1;
|
||||||
|
repeated int32 int32value = 2;
|
||||||
|
repeated fixed32 fixed32value = 3;
|
||||||
|
repeated fixed64 fixed64value = 4;
|
||||||
|
optional SubMessage submsg = 5;
|
||||||
|
repeated string repeatedstring = 6;
|
||||||
|
}
|
||||||
|
|
||||||
12
tests/multiple_files/test_multiple_files.c
Normal file
12
tests/multiple_files/test_multiple_files.c
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
/*
|
||||||
|
* Tests if this still compiles when multiple .proto files are involved.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <pb_encode.h>
|
||||||
|
#include "callbacks2.pb.h"
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
23
tests/no_errmsg/SConscript
Normal file
23
tests/no_errmsg/SConscript
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# Run the alltypes test case, but compile with PB_NO_ERRMSG=1
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
# Take copy of the files for custom build.
|
||||||
|
c = Copy("$TARGET", "$SOURCE")
|
||||||
|
env.Command("pb_encode.c", "#../pb_encode.c", c)
|
||||||
|
env.Command("pb_decode.c", "#../pb_decode.c", c)
|
||||||
|
env.Command("alltypes.pb.h", "#alltypes/alltypes.pb.h", c)
|
||||||
|
env.Command("alltypes.pb.c", "#alltypes/alltypes.pb.c", c)
|
||||||
|
env.Command("encode_alltypes.c", "#alltypes/encode_alltypes.c", c)
|
||||||
|
env.Command("decode_alltypes.c", "#alltypes/decode_alltypes.c", c)
|
||||||
|
|
||||||
|
# Define the compilation options
|
||||||
|
opts = env.Clone()
|
||||||
|
opts.Append(CPPDEFINES = {'PB_NO_ERRMSG': 1})
|
||||||
|
|
||||||
|
# Now build and run the test normally.
|
||||||
|
enc = opts.Program(["encode_alltypes.c", "alltypes.pb.c", "pb_encode.c"])
|
||||||
|
dec = opts.Program(["decode_alltypes.c", "alltypes.pb.c", "pb_decode.c"])
|
||||||
|
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_alltypes.output"])
|
||||||
7
tests/no_messages/SConscript
Normal file
7
tests/no_messages/SConscript
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# Test that a .proto file without any messages compiles fine.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
env.NanopbProto("no_messages")
|
||||||
|
env.Object('no_messages.pb.c')
|
||||||
|
|
||||||
9
tests/options/SConscript
Normal file
9
tests/options/SConscript
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# Test that the generator options work as expected.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
env.NanopbProto("options")
|
||||||
|
env.Object('options.pb.c')
|
||||||
|
|
||||||
|
env.Match(['options.pb.h', 'options.expected'])
|
||||||
|
|
||||||
111
tests/site_scons/site_init.py
Normal file
111
tests/site_scons/site_init.py
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import re
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Make terminal colors work on windows
|
||||||
|
import colorama
|
||||||
|
colorama.init()
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
def add_nanopb_builders(env):
|
||||||
|
'''Add the necessary builder commands for nanopb tests.'''
|
||||||
|
|
||||||
|
# Build command for building .pb from .proto using protoc
|
||||||
|
def proto_actions(source, target, env, for_signature):
|
||||||
|
esc = env['ESCAPE']
|
||||||
|
dirs = ' '.join(['-I' + esc(env.GetBuildPath(d)) for d in env['PROTOCPATH']])
|
||||||
|
return '$PROTOC $PROTOCFLAGS %s -o%s %s' % (dirs, esc(str(target[0])), esc(str(source[0])))
|
||||||
|
|
||||||
|
proto_file_builder = Builder(generator = proto_actions,
|
||||||
|
suffix = '.pb',
|
||||||
|
src_suffix = '.proto')
|
||||||
|
env.Append(BUILDERS = {'Proto': proto_file_builder})
|
||||||
|
env.SetDefault(PROTOC = 'protoc')
|
||||||
|
env.SetDefault(PROTOCPATH = ['.'])
|
||||||
|
|
||||||
|
# Build command for running nanopb generator
|
||||||
|
import os.path
|
||||||
|
def nanopb_targets(target, source, env):
|
||||||
|
basename = os.path.splitext(str(source[0]))[0]
|
||||||
|
target.append(basename + '.pb.h')
|
||||||
|
return target, source
|
||||||
|
|
||||||
|
nanopb_file_builder = Builder(action = '$NANOPB_GENERATOR $NANOPB_FLAGS $SOURCE',
|
||||||
|
suffix = '.pb.c',
|
||||||
|
src_suffix = '.pb',
|
||||||
|
emitter = nanopb_targets)
|
||||||
|
env.Append(BUILDERS = {'Nanopb': nanopb_file_builder})
|
||||||
|
env.SetDefault(NANOPB_GENERATOR = 'python ' + env.GetBuildPath("#../generator/nanopb_generator.py"))
|
||||||
|
env.SetDefault(NANOPB_FLAGS = '-q')
|
||||||
|
|
||||||
|
# Combined method to run both protoc and nanopb generator
|
||||||
|
def run_protoc_and_nanopb(env, source):
|
||||||
|
b1 = env.Proto(source)
|
||||||
|
b2 = env.Nanopb(source)
|
||||||
|
return b1 + b2
|
||||||
|
env.AddMethod(run_protoc_and_nanopb, "NanopbProto")
|
||||||
|
|
||||||
|
# Build command that runs a test program and saves the output
|
||||||
|
def run_test(target, source, env):
|
||||||
|
if len(source) > 1:
|
||||||
|
infile = open(str(source[1]))
|
||||||
|
else:
|
||||||
|
infile = None
|
||||||
|
|
||||||
|
pipe = subprocess.Popen(str(source[0]),
|
||||||
|
stdin = infile,
|
||||||
|
stdout = open(str(target[0]), 'w'),
|
||||||
|
stderr = sys.stderr)
|
||||||
|
result = pipe.wait()
|
||||||
|
if result == 0:
|
||||||
|
print '\033[32m[ OK ]\033[0m Ran ' + str(source[0])
|
||||||
|
else:
|
||||||
|
print '\033[31m[FAIL]\033[0m Program ' + str(source[0]) + ' returned ' + str(result)
|
||||||
|
return result
|
||||||
|
|
||||||
|
run_test_builder = Builder(action = run_test,
|
||||||
|
suffix = '.output')
|
||||||
|
env.Append(BUILDERS = {'RunTest': run_test_builder})
|
||||||
|
|
||||||
|
# Build command that decodes a message using protoc
|
||||||
|
def decode_actions(source, target, env, for_signature):
|
||||||
|
dirs = ' '.join(['-I' + env.GetBuildPath(d) for d in env['PROTOCPATH']])
|
||||||
|
return '$PROTOC $PROTOCFLAGS %s --decode=%s %s <%s >%s' % (dirs, env['MESSAGE'], source[1], source[0], target[0])
|
||||||
|
|
||||||
|
decode_builder = Builder(generator = decode_actions,
|
||||||
|
suffix = '.decoded')
|
||||||
|
env.Append(BUILDERS = {'Decode': decode_builder})
|
||||||
|
|
||||||
|
# Build command that asserts that two files be equal
|
||||||
|
def compare_files(target, source, env):
|
||||||
|
data1 = open(str(source[0]), 'rb').read()
|
||||||
|
data2 = open(str(source[1]), 'rb').read()
|
||||||
|
if data1 == data2:
|
||||||
|
print '\033[32m[ OK ]\033[0m Files equal: ' + str(source[0]) + ' and ' + str(source[1])
|
||||||
|
return 0
|
||||||
|
else:
|
||||||
|
print '\033[31m[FAIL]\033[0m Files differ: ' + str(source[0]) + ' and ' + str(source[1])
|
||||||
|
return 1
|
||||||
|
|
||||||
|
compare_builder = Builder(action = compare_files,
|
||||||
|
suffix = '.equal')
|
||||||
|
env.Append(BUILDERS = {'Compare': compare_builder})
|
||||||
|
|
||||||
|
# Build command that checks that each pattern in source2 is found in source1.
|
||||||
|
def match_files(target, source, env):
|
||||||
|
data = open(str(source[0]), 'rU').read()
|
||||||
|
patterns = open(str(source[1]))
|
||||||
|
for pattern in patterns:
|
||||||
|
if pattern.strip() and not re.search(pattern.strip(), data, re.MULTILINE):
|
||||||
|
print '\033[31m[FAIL]\033[0m Pattern not found in ' + str(source[0]) + ': ' + pattern
|
||||||
|
return 1
|
||||||
|
else:
|
||||||
|
print '\033[32m[ OK ]\033[0m All patterns found in ' + str(source[0])
|
||||||
|
return 0
|
||||||
|
|
||||||
|
match_builder = Builder(action = match_files, suffix = '.matched')
|
||||||
|
env.Append(BUILDERS = {'Match': match_builder})
|
||||||
|
|
||||||
|
|
||||||
7
tests/special_characters/SConscript
Normal file
7
tests/special_characters/SConscript
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# Test that special characters in .proto filenames work.
|
||||||
|
|
||||||
|
Import('env')
|
||||||
|
|
||||||
|
env.Proto("funny-proto+name has.characters.proto")
|
||||||
|
env.Nanopb("funny-proto+name has.characters.pb.c", "funny-proto+name has.characters.pb")
|
||||||
|
env.Object("funny-proto+name has.characters.pb.c")
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
/*
|
|
||||||
* Tests if still compile if typedefs are redfefined in STATIC_ASSERTS when
|
|
||||||
* proto file includes another poto file
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <stdio.h>
|
|
||||||
#include <pb_encode.h>
|
|
||||||
#include "callbacks2.pb.h"
|
|
||||||
|
|
||||||
int main()
|
|
||||||
{
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
|
|
||||||
Test Person7foobar@foobar.com"
|
|
||||||
555-12345678
|
|
||||||
Reference in New Issue
Block a user