Compare commits
123 Commits
dev_perfor
...
nanopb-0.2
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
906c8283b5 | ||
|
|
4546bb92dc | ||
|
|
18e71bbfe2 | ||
|
|
585cd0356e | ||
|
|
bb51ee655b | ||
|
|
125b49bf24 | ||
|
|
da8210b947 | ||
|
|
10ef575d46 | ||
|
|
7c9a8a132b | ||
|
|
ae7b9a3bd3 | ||
|
|
156139f112 | ||
|
|
26f7341094 | ||
|
|
2b334015af | ||
|
|
435ccbfdf7 | ||
|
|
b1cb035373 | ||
|
|
6d0e0695d0 | ||
|
|
dde71cb426 | ||
|
|
1fc90ab4c4 | ||
|
|
440a53f859 | ||
|
|
3bdbd4dc48 | ||
|
|
8be8b7e41a | ||
|
|
94422ad456 | ||
|
|
1d42f72f40 | ||
|
|
2abd27c91c | ||
|
|
6e08773153 | ||
|
|
d7cadaa46f | ||
|
|
d344bda28a | ||
|
|
05e2dc20f3 | ||
|
|
c61660b3ea | ||
|
|
45c1a32e50 | ||
|
|
ef31774cd9 | ||
|
|
480b39cc0a | ||
|
|
ec517e2108 | ||
|
|
8c2dda67a1 | ||
|
|
58b3a22d6d | ||
|
|
356535da9b | ||
|
|
f4146edf01 | ||
|
|
8da15d8b80 | ||
|
|
bc4ded3b43 | ||
|
|
ef07635e35 | ||
|
|
25516b0591 | ||
|
|
414e637867 | ||
|
|
4ae3b2e566 | ||
|
|
4f37c083d5 | ||
|
|
ed93db08dc | ||
|
|
cd9004089f | ||
|
|
ee5b12c537 | ||
|
|
9cc19a5e99 | ||
|
|
eff9e11150 | ||
|
|
5813144246 | ||
|
|
171d64734a | ||
|
|
321ca6c1d5 | ||
|
|
935a26ab1c | ||
|
|
d7af99434a | ||
|
|
564bdc8448 | ||
|
|
dcdd7f98fd | ||
|
|
287207841d | ||
|
|
0074deba9a | ||
|
|
4d69cc2f3e | ||
|
|
c7b4ce0293 | ||
|
|
cd3af3272d | ||
|
|
ed564186e1 | ||
|
|
86d6983156 | ||
|
|
0848255d4a | ||
|
|
51f0e47295 | ||
|
|
49bd3f35a0 | ||
|
|
2bfd497eea | ||
|
|
e83fbd18d3 | ||
|
|
388d4de833 | ||
|
|
2363af29a2 | ||
|
|
283a8f36cb | ||
|
|
8accc25710 | ||
|
|
73142ba082 | ||
|
|
f47410ea4b | ||
|
|
fd9a79a06d | ||
|
|
9ada7e7525 | ||
|
|
59cba0beea | ||
|
|
152c2c910c | ||
|
|
2b72815036 | ||
|
|
61ad04afd5 | ||
|
|
9f93d39f72 | ||
|
|
d395768c8d | ||
|
|
b9f14bddf7 | ||
|
|
840e213b9f | ||
|
|
e2e9980627 | ||
|
|
0bbcb7b367 | ||
|
|
696a01bf14 | ||
|
|
f04ab838ab | ||
|
|
e681dd0d75 | ||
|
|
4dccf28ba9 | ||
|
|
5b9ad17dc2 | ||
|
|
4821e7f457 | ||
|
|
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 |
41
.gitignore
vendored
41
.gitignore
vendored
@@ -5,35 +5,24 @@
|
|||||||
*.pb.c
|
*.pb.c
|
||||||
*.pb.h
|
*.pb.h
|
||||||
*.pb
|
*.pb
|
||||||
|
*.pyc
|
||||||
|
*_pb2.py
|
||||||
*~
|
*~
|
||||||
*.tar.gz
|
*.tar.gz
|
||||||
|
.sconsign.dblite
|
||||||
|
config.log
|
||||||
|
.sconf_temp
|
||||||
|
tests/build
|
||||||
julkaisu.txt
|
julkaisu.txt
|
||||||
|
dist
|
||||||
docs/*.html
|
docs/*.html
|
||||||
docs/generator_flow.png
|
docs/generator_flow.png
|
||||||
example/client
|
examples/simple/simple
|
||||||
example/server
|
examples/network_server/client
|
||||||
example_avr_double/decode_double
|
examples/network_server/server
|
||||||
example_avr_double/encode_double
|
examples/using_double_on_avr/decode_double
|
||||||
example_avr_double/test_conversions
|
examples/using_double_on_avr/encode_double
|
||||||
example_unions/decode
|
examples/using_double_on_avr/test_conversions
|
||||||
example_unions/encode
|
examples/using_union_messages/decode
|
||||||
|
examples/using_union_messages/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
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,55 @@
|
|||||||
nanopb-0.2.0
|
nanopb-0.2.5 (2014-01-01)
|
||||||
|
Fix a bug with encoding negative values in int32 fields (issue 97)
|
||||||
|
Create binary packages of the generator + dependencies (issue 47)
|
||||||
|
Add support for pointer-type fields to the encoder (part of issue 80)
|
||||||
|
Fixed path in FindNanopb.cmake (issue 94)
|
||||||
|
Improved tests
|
||||||
|
|
||||||
|
nanopb-0.2.4 (2013-11-07)
|
||||||
|
Remove the deprecated NANOPB_INTERNALS functions from public API.
|
||||||
|
Document the security model.
|
||||||
|
Check array and bytes max sizes when encoding (issue 90)
|
||||||
|
Add #defines for maximum encoded message size (issue 89)
|
||||||
|
Add #define tags for extension fields (issue 93)
|
||||||
|
Fix MISRA C violations (issue 91)
|
||||||
|
Clean up pb_field_t definition with typedefs.
|
||||||
|
|
||||||
|
nanopb-0.2.3 (2013-09-18)
|
||||||
|
Improve compatibility by removing ternary operator from initializations (issue 88)
|
||||||
|
Fix build error on Visual C++ (issue 84, patch by Markus Schwarzenberg)
|
||||||
|
Don't stop on unsupported extension fields (issue 83)
|
||||||
|
Add an example pb_syshdr.h file for non-C99 compilers
|
||||||
|
Reorganize tests and examples into subfolders (issue 63)
|
||||||
|
Switch from Makefiles to scons for building the tests
|
||||||
|
Make the tests buildable on Windows
|
||||||
|
|
||||||
|
nanopb-0.2.2 (2013-08-18)
|
||||||
|
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 (2013-04-14)
|
||||||
|
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 (2013-03-02)
|
||||||
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
|
||||||
compile anymore.
|
compile anymore.
|
||||||
@@ -11,7 +62,7 @@ nanopb-0.2.0
|
|||||||
Add option to give file extension to generator (by Michael Haberler)
|
Add option to give file extension to generator (by Michael Haberler)
|
||||||
Documentation updates
|
Documentation updates
|
||||||
|
|
||||||
nanopb-0.1.9
|
nanopb-0.1.9 (2013-02-13)
|
||||||
Fixed error message bugs (issues 52, 56)
|
Fixed error message bugs (issues 52, 56)
|
||||||
Sanitize #ifndef filename (issue 50)
|
Sanitize #ifndef filename (issue 50)
|
||||||
Performance improvements
|
Performance improvements
|
||||||
@@ -22,13 +73,13 @@ nanopb-0.1.9
|
|||||||
Added generator option to make message structs packed. (issue 49)
|
Added generator option to make message structs packed. (issue 49)
|
||||||
Add more test cases.
|
Add more test cases.
|
||||||
|
|
||||||
nanopb-0.1.8
|
nanopb-0.1.8 (2012-12-13)
|
||||||
Fix bugs in the enum short names introduced in 0.1.7 (issues 42, 43)
|
Fix bugs in the enum short names introduced in 0.1.7 (issues 42, 43)
|
||||||
Fix STATIC_ASSERT macro when using multiple .proto files. (issue 41)
|
Fix STATIC_ASSERT macro when using multiple .proto files. (issue 41)
|
||||||
Fix missing initialization of istream.errmsg
|
Fix missing initialization of istream.errmsg
|
||||||
Make tests/Makefile work for non-gcc compilers (issue 40)
|
Make tests/Makefile work for non-gcc compilers (issue 40)
|
||||||
|
|
||||||
nanopb-0.1.7
|
nanopb-0.1.7 (2012-11-11)
|
||||||
Remove "skip" mode from pb_istream_t callbacks. Example implementation had a bug. (issue 37)
|
Remove "skip" mode from pb_istream_t callbacks. Example implementation had a bug. (issue 37)
|
||||||
Add option to use shorter names for enum values (issue 38)
|
Add option to use shorter names for enum values (issue 38)
|
||||||
Improve options support in generator (issues 12, 30)
|
Improve options support in generator (issues 12, 30)
|
||||||
@@ -38,19 +89,19 @@ nanopb-0.1.7
|
|||||||
Add buffer size check in example (issue 34)
|
Add buffer size check in example (issue 34)
|
||||||
Fix build warnings on MS compilers (issue 33)
|
Fix build warnings on MS compilers (issue 33)
|
||||||
|
|
||||||
nanopb-0.1.6
|
nanopb-0.1.6 (2012-09-02)
|
||||||
Reorganize the field decoder interface (issue 2)
|
Reorganize the field decoder interface (issue 2)
|
||||||
Improve performance in submessage decoding (issue 28)
|
Improve performance in submessage decoding (issue 28)
|
||||||
Implement error messages in the decoder side (issue 7)
|
Implement error messages in the decoder side (issue 7)
|
||||||
Extended testcases (alltypes test is now complete).
|
Extended testcases (alltypes test is now complete).
|
||||||
Fix some compiler warnings (issues 25, 26, 27, 32).
|
Fix some compiler warnings (issues 25, 26, 27, 32).
|
||||||
|
|
||||||
nanopb-0.1.5
|
nanopb-0.1.5 (2012-08-04)
|
||||||
Fix bug in decoder with packed arrays (issue 23).
|
Fix bug in decoder with packed arrays (issue 23).
|
||||||
Extended testcases.
|
Extended testcases.
|
||||||
Fix some compiler warnings.
|
Fix some compiler warnings.
|
||||||
|
|
||||||
nanopb-0.1.4
|
nanopb-0.1.4 (2012-07-05)
|
||||||
Add compile-time options for easy-to-use >255 field support.
|
Add compile-time options for easy-to-use >255 field support.
|
||||||
Improve the detection of missing required fields.
|
Improve the detection of missing required fields.
|
||||||
Added example on how to handle union messages.
|
Added example on how to handle union messages.
|
||||||
@@ -58,20 +109,20 @@ nanopb-0.1.4
|
|||||||
Fix problems that stopped the code from compiling with some compilers.
|
Fix problems that stopped the code from compiling with some compilers.
|
||||||
Fix some compiler warnings.
|
Fix some compiler warnings.
|
||||||
|
|
||||||
nanopb-0.1.3
|
nanopb-0.1.3 (2012-06-12)
|
||||||
Refactor the field encoder interface.
|
Refactor the field encoder interface.
|
||||||
Improve generator error messages (issue 5)
|
Improve generator error messages (issue 5)
|
||||||
Add descriptor.proto into the #include exclusion list
|
Add descriptor.proto into the #include exclusion list
|
||||||
Fix some compiler warnings.
|
Fix some compiler warnings.
|
||||||
|
|
||||||
nanopb-0.1.2
|
nanopb-0.1.2 (2012-02-15)
|
||||||
Make the generator to generate include for other .proto files (issue 4).
|
Make the generator to generate include for other .proto files (issue 4).
|
||||||
Fixed generator not working on Windows (issue 3)
|
Fixed generator not working on Windows (issue 3)
|
||||||
|
|
||||||
nanopb-0.1.1
|
nanopb-0.1.1 (2012-01-14)
|
||||||
Fixed bug in encoder with 'bytes' fields (issue 1).
|
Fixed bug in encoder with 'bytes' fields (issue 1).
|
||||||
Fixed a bug in the generator that caused a compiler error on sfixed32 and sfixed64 fields.
|
Fixed a bug in the generator that caused a compiler error on sfixed32 and sfixed64 fields.
|
||||||
Extended testcases.
|
Extended testcases.
|
||||||
|
|
||||||
nanopb-0.1.0
|
nanopb-0.1.0 (2012-01-06)
|
||||||
First stable release.
|
First stable release.
|
||||||
11
README
11
README
@@ -1,11 +0,0 @@
|
|||||||
Nanopb is a small code-size Protocol Buffers implementation.
|
|
||||||
|
|
||||||
Homepage: http://kapsi.fi/~jpa/nanopb/
|
|
||||||
|
|
||||||
To compile the library, you'll need these libraries:
|
|
||||||
protobuf-compiler python-protobuf libprotobuf-dev
|
|
||||||
|
|
||||||
The only runtime dependencies are memset() and memcpy().
|
|
||||||
|
|
||||||
To run the tests, run make under the tests folder.
|
|
||||||
If it completes without error, everything is fine.
|
|
||||||
61
README.txt
Normal file
61
README.txt
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
Nanopb is a small code-size Protocol Buffers implementation in ansi C. It is
|
||||||
|
especially suitable for use in microcontrollers, but fits any memory
|
||||||
|
restricted system.
|
||||||
|
|
||||||
|
Homepage: http://kapsi.fi/~jpa/nanopb/
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Using the nanopb library
|
||||||
|
========================
|
||||||
|
To use the nanopb library, you need to do two things:
|
||||||
|
|
||||||
|
1) Compile your .proto files for nanopb, using protoc.
|
||||||
|
2) Include pb_encode.c and pb_decode.c in your project.
|
||||||
|
|
||||||
|
The easiest way to get started is to study the project in "examples/simple".
|
||||||
|
It contains a Makefile, which should work directly under most Linux systems.
|
||||||
|
However, for any other kind of build system, see the manual steps in
|
||||||
|
README.txt in that folder.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Using the Protocol Buffers compiler (protoc)
|
||||||
|
============================================
|
||||||
|
The nanopb generator is implemented as a plugin for the Google's own protoc
|
||||||
|
compiler. This has the advantage that there is no need to reimplement the
|
||||||
|
basic parsing of .proto files. However, it does mean that you need the
|
||||||
|
Google's protobuf library in order to run the generator.
|
||||||
|
|
||||||
|
If you have downloaded a binary package for nanopb (either Windows, Linux or
|
||||||
|
Mac OS X version), the 'protoc' binary is included in the 'generator-bin'
|
||||||
|
folder. In this case, you are ready to go. Simply run this command:
|
||||||
|
|
||||||
|
generator-bin/protoc --nanopb_out=. myprotocol.proto
|
||||||
|
|
||||||
|
However, if you are using a git checkout or a plain source distribution, you
|
||||||
|
need to provide your own version of protoc and the Google's protobuf library.
|
||||||
|
On Linux, the necessary packages are protobuf-compiler and python-protobuf.
|
||||||
|
On Windows, you can either build Google's protobuf library from source or use
|
||||||
|
one of the binary distributions of it. In either case, if you use a separate
|
||||||
|
protoc, you need to manually give the path to nanopb generator:
|
||||||
|
|
||||||
|
protoc --plugin=protoc-gen-nanopb=nanopb/generator/protoc-gen-nanopb ...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Running the tests
|
||||||
|
=================
|
||||||
|
If you want to perform further development of the nanopb core, or to verify
|
||||||
|
its functionality using your compiler and platform, you'll want to run the
|
||||||
|
test suite. The build rules for the test suite are implemented using Scons,
|
||||||
|
so you need to have that installed. To run the tests:
|
||||||
|
|
||||||
|
cd tests
|
||||||
|
scons
|
||||||
|
|
||||||
|
This will show the progress of various test cases. If the output does not
|
||||||
|
end in an error, the test cases were successful.
|
||||||
|
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
all: index.html concepts.html reference.html \
|
all: index.html concepts.html reference.html security.html \
|
||||||
generator_flow.png
|
generator_flow.png
|
||||||
|
|
||||||
%.png: %.svg
|
%.png: %.svg
|
||||||
|
|||||||
@@ -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
|
||||||
=======
|
=======
|
||||||
@@ -263,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.
|
||||||
|
|
||||||
@@ -90,20 +90,38 @@ After that, buffer will contain the encoded message.
|
|||||||
The number of bytes in the message is stored in *stream.bytes_written*.
|
The number of bytes in the message is stored in *stream.bytes_written*.
|
||||||
You can feed the message to *protoc --decode=Example message.proto* to verify its validity.
|
You can feed the message to *protoc --decode=Example message.proto* to verify its validity.
|
||||||
|
|
||||||
For complete examples of the simple cases, see *tests/test_decode1.c* and *tests/test_encode1.c*. For an example with network interface, see the *example* subdirectory.
|
For a complete example of the simple case, see *example/simple.c*.
|
||||||
|
For a more complex example with network interface, see the *example/network_server* subdirectory.
|
||||||
|
|
||||||
Compiler requirements
|
Compiler requirements
|
||||||
=====================
|
=====================
|
||||||
Nanopb should compile with most ansi-C compatible compilers. It however requires a few header files to be available:
|
Nanopb should compile with most ansi-C compatible compilers. It however
|
||||||
|
requires a few header files to be available:
|
||||||
|
|
||||||
#) *string.h*, with these functions: *strlen*, *memcpy*, *memset*
|
#) *string.h*, with these functions: *strlen*, *memcpy*, *memset*
|
||||||
#) *stdint.h*, for definitions of *int32_t* etc.
|
#) *stdint.h*, for definitions of *int32_t* etc.
|
||||||
#) *stddef.h*, for definition of *size_t*
|
#) *stddef.h*, for definition of *size_t*
|
||||||
#) *stdbool.h*, for definition of *bool*
|
#) *stdbool.h*, for definition of *bool*
|
||||||
|
|
||||||
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 can use the
|
||||||
|
file *extra/pb_syshdr.h* instead. It contains an example of how to provide
|
||||||
|
the dependencies. You may have to edit it a bit to suit your custom platform.
|
||||||
|
|
||||||
Debugging and testing
|
To use the pb_syshdr.h, define *PB_SYSTEM_HEADER* as *"pb_syshdr.h"* (including the quotes).
|
||||||
=====================
|
Similarly, you can provide a custom include file, which should provide all the dependencies
|
||||||
Extensive unittests are included under the *tests* folder. Just type *make* there to run the tests.
|
listed above.
|
||||||
|
|
||||||
|
Running the test cases
|
||||||
|
======================
|
||||||
|
Extensive unittests and test cases are included under the *tests* folder.
|
||||||
|
|
||||||
|
To build the tests, you will need the `scons`__ build system. The tests should
|
||||||
|
be runnable on most platforms. Windows and Linux builds are regularly tested.
|
||||||
|
|
||||||
|
__ http://www.scons.org/
|
||||||
|
|
||||||
|
In addition to the build system, you will also need a working Google Protocol
|
||||||
|
Buffers *protoc* compiler, and the Python bindings for Protocol Buffers. On
|
||||||
|
Debian-based systems, install the following packages: *protobuf-compiler*,
|
||||||
|
*python-protobuf* and *libprotobuf-dev*.
|
||||||
|
|
||||||
|
|||||||
@@ -3,8 +3,9 @@
|
|||||||
1) `Overview`_
|
1) `Overview`_
|
||||||
2) `Concepts`_
|
2) `Concepts`_
|
||||||
3) `API reference`_
|
3) `API reference`_
|
||||||
|
4) `Security model`_
|
||||||
|
|
||||||
.. _`Overview`: index.html
|
.. _`Overview`: index.html
|
||||||
.. _`Concepts`: concepts.html
|
.. _`Concepts`: concepts.html
|
||||||
.. _`API reference`: reference.html
|
.. _`API reference`: reference.html
|
||||||
|
.. _`Security model`: security.html
|
||||||
|
|||||||
@@ -6,31 +6,189 @@ 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.
|
||||||
__BIG_ENDIAN__ Set this if your platform stores integers and floats in big-endian format.
|
2. By #defining them at the top of pb.h.
|
||||||
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.
|
You must have the same settings for the nanopb library and all code that
|
||||||
PB_MAX_REQUIRED_FIELDS Maximum number of required fields to check for presence. Default value is 64. Increases stack
|
includes pb.h.
|
||||||
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.
|
__BIG_ENDIAN__ Set this if your platform stores integers and
|
||||||
PB_FIELD_32BIT Add support for tag numbers > 65535 and fields larger than 65535 bytes or 65535 array entries.
|
floats in big-endian format. Mixed-endian
|
||||||
Increases code size 9 bytes per each field. Compiler error will tell if you need this.
|
systems (different layout for ints and floats)
|
||||||
PB_NO_ERRMSG Disables the support for error messages; only error information is the true/false return value.
|
are currently not supported.
|
||||||
Decreases the code size by a few hundred bytes.
|
NANOPB_INTERNALS Set this to expose the field encoder functions
|
||||||
PB_BUFFER_ONLY Disables the support for custom streams. Only supports encoding to memory buffers.
|
that are hidden since nanopb-0.1.3. Starting
|
||||||
Speeds up execution and decreases code size slightly.
|
with nanopb-0.2.4, this flag does nothing. Use
|
||||||
PB_OLD_CALLBACK_STYLE Use the old function signature (void\* instead of void\*\*) for callback fields. This was the
|
the newer functions that have better interface.
|
||||||
|
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.
|
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
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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
|
||||||
====
|
====
|
||||||
@@ -148,6 +306,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
|
||||||
===========
|
===========
|
||||||
|
|
||||||
@@ -297,6 +525,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
|
||||||
===========
|
===========
|
||||||
|
|
||||||
|
|||||||
79
docs/security.rst
Normal file
79
docs/security.rst
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
======================
|
||||||
|
Nanopb: Security model
|
||||||
|
======================
|
||||||
|
|
||||||
|
.. include :: menu.rst
|
||||||
|
|
||||||
|
.. contents ::
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Importance of security in a Protocol Buffers library
|
||||||
|
====================================================
|
||||||
|
In the context of protocol buffers, security comes into play when decoding
|
||||||
|
untrusted data. Naturally, if the attacker can modify the contents of a
|
||||||
|
protocol buffers message, he can feed the application any values possible.
|
||||||
|
Therefore the application itself must be prepared to receive untrusted values.
|
||||||
|
|
||||||
|
Where nanopb plays a part is preventing the attacker from running arbitrary
|
||||||
|
code on the target system. Mostly this means that there must not be any
|
||||||
|
possibility to cause buffer overruns, memory corruption or invalid pointers
|
||||||
|
by the means of crafting a malicious message.
|
||||||
|
|
||||||
|
Division of trusted and untrusted data
|
||||||
|
======================================
|
||||||
|
The following data is regarded as **trusted**. It must be under the control of
|
||||||
|
the application writer. Malicious data in these structures could cause
|
||||||
|
security issues, such as execution of arbitrary code:
|
||||||
|
|
||||||
|
1. Callback and extension fields in message structures given to pb_encode()
|
||||||
|
and pb_decode(). These fields are memory pointers, and are generated
|
||||||
|
depending on the .proto file.
|
||||||
|
2. The automatically generated field definitions, i.e. *pb_field_t* lists.
|
||||||
|
3. Contents of the *pb_istream_t* and *pb_ostream_t* structures (this does not
|
||||||
|
mean the contents of the stream itself, just the stream definition).
|
||||||
|
|
||||||
|
The following data is regarded as **untrusted**. Invalid/malicious data in
|
||||||
|
these will cause "garbage in, garbage out" behaviour. It will not cause
|
||||||
|
buffer overflows, information disclosure or other security problems:
|
||||||
|
|
||||||
|
1. All data read from *pb_istream_t*.
|
||||||
|
2. All fields in message structures, except callbacks and extensions.
|
||||||
|
(Beginning with nanopb-0.2.4, in earlier versions the field sizes are partially unchecked.)
|
||||||
|
|
||||||
|
Invariants
|
||||||
|
==========
|
||||||
|
The following invariants are maintained during operation, even if the
|
||||||
|
untrusted data has been maliciously crafted:
|
||||||
|
|
||||||
|
1. Nanopb will never read more than *bytes_left* bytes from *pb_istream_t*.
|
||||||
|
2. Nanopb will never write more than *max_size* bytes to *pb_ostream_t*.
|
||||||
|
3. Nanopb will never access memory out of bounds of the message structure.
|
||||||
|
4. After pb_decode() returns successfully, the message structure will be
|
||||||
|
internally consistent:
|
||||||
|
|
||||||
|
- The *count* fields of arrays will not exceed the array size.
|
||||||
|
- The *size* field of bytes will not exceed the allocated size.
|
||||||
|
- All string fields will have null terminator.
|
||||||
|
|
||||||
|
5. After pb_encode() returns successfully, the resulting message is a valid
|
||||||
|
protocol buffers message. (Except if user-defined callbacks write incorrect
|
||||||
|
data.)
|
||||||
|
|
||||||
|
Further considerations
|
||||||
|
======================
|
||||||
|
Even if the nanopb library is free of any security issues, there are still
|
||||||
|
several possible attack vectors that the application author must consider.
|
||||||
|
The following list is not comprehensive:
|
||||||
|
|
||||||
|
1. Stack usage may depend on the contents of the message. The message
|
||||||
|
definition places an upper bound on how much stack will be used. Tests
|
||||||
|
should be run with all fields present, to record the maximum possible
|
||||||
|
stack usage.
|
||||||
|
2. Callbacks can do anything. The code for the callbacks must be carefully
|
||||||
|
checked if they are used with untrusted data.
|
||||||
|
3. If using stream input, a maximum size should be set in *pb_istream_t* to
|
||||||
|
stop a denial of service attack from using an infinite message.
|
||||||
|
4. If using network sockets as streams, a timeout should be set to stop
|
||||||
|
denial of service attacks.
|
||||||
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
CFLAGS=-ansi -Wall -Werror -I .. -g -O0
|
|
||||||
DEPS=../pb_decode.c ../pb_decode.h ../pb_encode.c ../pb_encode.h ../pb.h
|
|
||||||
|
|
||||||
all: server client
|
|
||||||
|
|
||||||
clean:
|
|
||||||
rm -f server client fileproto.pb.c fileproto.pb.h
|
|
||||||
|
|
||||||
%: %.c $(DEPS) fileproto.pb.h fileproto.pb.c
|
|
||||||
$(CC) $(CFLAGS) -o $@ $< ../pb_decode.c ../pb_encode.c fileproto.pb.c common.c
|
|
||||||
|
|
||||||
fileproto.pb.c fileproto.pb.h: fileproto.proto ../generator/nanopb_generator.py
|
|
||||||
protoc -I. -I../generator -I/usr/include -ofileproto.pb $<
|
|
||||||
python ../generator/nanopb_generator.py fileproto.pb
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
import "nanopb.proto";
|
|
||||||
|
|
||||||
// This defines protocol for a simple server that lists files.
|
|
||||||
//
|
|
||||||
// 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.
|
|
||||||
|
|
||||||
message ListFilesRequest {
|
|
||||||
optional string path = 1 [default = "/", (nanopb).max_size = 128];
|
|
||||||
}
|
|
||||||
|
|
||||||
message FileInfo {
|
|
||||||
required uint64 inode = 1;
|
|
||||||
required string name = 2 [(nanopb).max_size = 128];
|
|
||||||
}
|
|
||||||
|
|
||||||
message ListFilesResponse {
|
|
||||||
optional bool path_error = 1 [default = false];
|
|
||||||
repeated FileInfo file = 2;
|
|
||||||
}
|
|
||||||
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
CFLAGS=-Wall -Werror -I .. -g -O0
|
|
||||||
DEPS=double_conversion.c ../pb_decode.c ../pb_decode.h ../pb_encode.c ../pb_encode.h ../pb.h
|
|
||||||
|
|
||||||
all: run_tests
|
|
||||||
|
|
||||||
clean:
|
|
||||||
rm -f test_conversions encode_double decode_double doubleproto.pb.c doubleproto.pb.h
|
|
||||||
|
|
||||||
test_conversions: test_conversions.c double_conversion.c
|
|
||||||
$(CC) $(CFLAGS) -o $@ $^
|
|
||||||
|
|
||||||
%: %.c $(DEPS) doubleproto.pb.h doubleproto.pb.c
|
|
||||||
$(CC) $(CFLAGS) -o $@ $< double_conversion.c ../pb_decode.c ../pb_encode.c doubleproto.pb.c
|
|
||||||
|
|
||||||
doubleproto.pb.c doubleproto.pb.h: doubleproto.proto ../generator/nanopb_generator.py
|
|
||||||
protoc -I. -I../generator -I/usr/include -odoubleproto.pb $<
|
|
||||||
python ../generator/nanopb_generator.py doubleproto.pb
|
|
||||||
|
|
||||||
run_tests: test_conversions encode_double decode_double
|
|
||||||
./test_conversions
|
|
||||||
./encode_double | ./decode_double
|
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
CFLAGS=-ansi -Wall -Werror -I .. -g -O0
|
|
||||||
DEPS=../pb_decode.c ../pb_decode.h ../pb_encode.c ../pb_encode.h ../pb.h
|
|
||||||
|
|
||||||
all: encode decode
|
|
||||||
./encode 1 | ./decode
|
|
||||||
./encode 2 | ./decode
|
|
||||||
./encode 3 | ./decode
|
|
||||||
|
|
||||||
clean:
|
|
||||||
rm -f encode unionproto.pb.h unionproto.pb.c
|
|
||||||
|
|
||||||
%: %.c $(DEPS) unionproto.pb.h unionproto.pb.c
|
|
||||||
$(CC) $(CFLAGS) -o $@ $< ../pb_decode.c ../pb_encode.c unionproto.pb.c
|
|
||||||
|
|
||||||
unionproto.pb.h unionproto.pb.c: unionproto.proto ../generator/nanopb_generator.py
|
|
||||||
protoc -I. -I../generator -I/usr/include -ounionproto.pb $<
|
|
||||||
python ../generator/nanopb_generator.py unionproto.pb
|
|
||||||
17
examples/network_server/Makefile
Normal file
17
examples/network_server/Makefile
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# Include the nanopb provided Makefile rules
|
||||||
|
include ../../extra/nanopb.mk
|
||||||
|
|
||||||
|
# Compiler flags to enable all warnings & debug info
|
||||||
|
CFLAGS = -ansi -Wall -Werror -g -O0
|
||||||
|
CFLAGS += -I$(NANOPB_DIR)
|
||||||
|
|
||||||
|
all: server client
|
||||||
|
|
||||||
|
.SUFFIXES:
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -f server client fileproto.pb.c fileproto.pb.h
|
||||||
|
|
||||||
|
%: %.c common.c fileproto.pb.c
|
||||||
|
$(CC) $(CFLAGS) -o $@ $^ $(NANOPB_CORE)
|
||||||
|
|
||||||
60
examples/network_server/README.txt
Normal file
60
examples/network_server/README.txt
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
Nanopb example "network_server"
|
||||||
|
===============================
|
||||||
|
|
||||||
|
This example demonstrates the use of nanopb to communicate over network
|
||||||
|
connections. It consists of a server that sends file listings, and of
|
||||||
|
a client that requests the file list from the server.
|
||||||
|
|
||||||
|
Example usage
|
||||||
|
-------------
|
||||||
|
|
||||||
|
user@host:~/nanopb/examples/network_server$ make # Build the example
|
||||||
|
protoc -ofileproto.pb fileproto.proto
|
||||||
|
python ../../generator/nanopb_generator.py fileproto.pb
|
||||||
|
Writing to fileproto.pb.h and fileproto.pb.c
|
||||||
|
cc -ansi -Wall -Werror -I .. -g -O0 -I../.. -o server server.c
|
||||||
|
../../pb_decode.c ../../pb_encode.c fileproto.pb.c common.c
|
||||||
|
cc -ansi -Wall -Werror -I .. -g -O0 -I../.. -o client client.c
|
||||||
|
../../pb_decode.c ../../pb_encode.c fileproto.pb.c common.c
|
||||||
|
|
||||||
|
user@host:~/nanopb/examples/network_server$ ./server & # Start the server on background
|
||||||
|
[1] 24462
|
||||||
|
|
||||||
|
petteri@oddish:~/nanopb/examples/network_server$ ./client /bin # Request the server to list /bin
|
||||||
|
Got connection.
|
||||||
|
Listing directory: /bin
|
||||||
|
1327119 bzdiff
|
||||||
|
1327126 bzless
|
||||||
|
1327147 ps
|
||||||
|
1327178 ntfsmove
|
||||||
|
1327271 mv
|
||||||
|
1327187 mount
|
||||||
|
1327259 false
|
||||||
|
1327266 tempfile
|
||||||
|
1327285 zfgrep
|
||||||
|
1327165 gzexe
|
||||||
|
1327204 nc.openbsd
|
||||||
|
1327260 uname
|
||||||
|
|
||||||
|
|
||||||
|
Details of implementation
|
||||||
|
-------------------------
|
||||||
|
fileproto.proto contains the portable Google Protocol Buffers protocol definition.
|
||||||
|
It could be used as-is to implement a server or a client in any other language, for
|
||||||
|
example Python or Java.
|
||||||
|
|
||||||
|
fileproto.options contains the nanopb-specific options for the protocol file. This
|
||||||
|
sets the amount of space allocated for file names when decoding messages.
|
||||||
|
|
||||||
|
common.c/h contains functions that allow nanopb to read and write directly from
|
||||||
|
network socket. This way there is no need to allocate a separate buffer to store
|
||||||
|
the message.
|
||||||
|
|
||||||
|
server.c contains the code to open a listening socket, to respond to clients and
|
||||||
|
to list directory contents.
|
||||||
|
|
||||||
|
client.c contains the code to connect to a server, to send a request and to print
|
||||||
|
the response message.
|
||||||
|
|
||||||
|
The code is implemented using the POSIX socket api, but it should be easy enough
|
||||||
|
to port into any other socket api, such as lwip.
|
||||||
13
examples/network_server/fileproto.options
Normal file
13
examples/network_server/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
|
||||||
18
examples/network_server/fileproto.proto
Normal file
18
examples/network_server/fileproto.proto
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
// This defines protocol for a simple server that lists files.
|
||||||
|
//
|
||||||
|
// See also the nanopb-specific options in fileproto.options.
|
||||||
|
|
||||||
|
message ListFilesRequest {
|
||||||
|
optional string path = 1 [default = "/"];
|
||||||
|
}
|
||||||
|
|
||||||
|
message FileInfo {
|
||||||
|
required uint64 inode = 1;
|
||||||
|
required string name = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
message ListFilesResponse {
|
||||||
|
optional bool path_error = 1 [default = false];
|
||||||
|
repeated FileInfo file = 2;
|
||||||
|
}
|
||||||
|
|
||||||
21
examples/simple/Makefile
Normal file
21
examples/simple/Makefile
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# Include the nanopb provided Makefile rules
|
||||||
|
include ../../extra/nanopb.mk
|
||||||
|
|
||||||
|
# Compiler flags to enable all warnings & debug info
|
||||||
|
CFLAGS = -Wall -Werror -g -O0
|
||||||
|
CFLAGS += -I$(NANOPB_DIR)
|
||||||
|
|
||||||
|
# C source code files that are required
|
||||||
|
CSRC = simple.c # The main program
|
||||||
|
CSRC += simple.pb.c # The compiled protocol definition
|
||||||
|
CSRC += $(NANOPB_DIR)/pb_encode.c # The nanopb encoder
|
||||||
|
CSRC += $(NANOPB_DIR)/pb_decode.c # The nanopb decoder
|
||||||
|
|
||||||
|
# Build rule for the main program
|
||||||
|
simple: $(CSRC)
|
||||||
|
$(CC) $(CFLAGS) -osimple $(CSRC)
|
||||||
|
|
||||||
|
# Build rule for the protocol
|
||||||
|
simple.pb.c: simple.proto
|
||||||
|
$(PROTOC) $(PROTOC_OPTS) --nanopb_out=. simple.proto
|
||||||
|
|
||||||
29
examples/simple/README.txt
Normal file
29
examples/simple/README.txt
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
Nanopb example "simple"
|
||||||
|
=======================
|
||||||
|
|
||||||
|
This example demonstrates the very basic use of nanopb. It encodes and
|
||||||
|
decodes a simple message.
|
||||||
|
|
||||||
|
The code uses four different API functions:
|
||||||
|
|
||||||
|
* pb_ostream_from_buffer() to declare the output buffer that is to be used
|
||||||
|
* pb_encode() to encode a message
|
||||||
|
* pb_istream_from_buffer() to declare the input buffer that is to be used
|
||||||
|
* pb_decode() to decode a message
|
||||||
|
|
||||||
|
Example usage
|
||||||
|
-------------
|
||||||
|
|
||||||
|
On Linux, simply type "make" to build the example. After that, you can
|
||||||
|
run it with the command: ./simple
|
||||||
|
|
||||||
|
On other platforms, you first have to compile the protocol definition using
|
||||||
|
the following command::
|
||||||
|
|
||||||
|
../../generator-bin/protoc --nanopb_out=. simple.proto
|
||||||
|
|
||||||
|
After that, add the following four files to your project and compile:
|
||||||
|
|
||||||
|
simple.c simple.pb.c pb_encode.c pb_decode.c
|
||||||
|
|
||||||
|
|
||||||
68
examples/simple/simple.c
Normal file
68
examples/simple/simple.c
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
#include <stdio.h>
|
||||||
|
#include <pb_encode.h>
|
||||||
|
#include <pb_decode.h>
|
||||||
|
#include "simple.pb.h"
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
/* This is the buffer where we will store our message. */
|
||||||
|
uint8_t buffer[128];
|
||||||
|
size_t message_length;
|
||||||
|
bool status;
|
||||||
|
|
||||||
|
/* Encode our message */
|
||||||
|
{
|
||||||
|
/* Allocate space on the stack to store the message data.
|
||||||
|
*
|
||||||
|
* Nanopb generates simple struct definitions for all the messages.
|
||||||
|
* - check out the contents of simple.pb.h! */
|
||||||
|
SimpleMessage message;
|
||||||
|
|
||||||
|
/* Create a stream that will write to our buffer. */
|
||||||
|
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
||||||
|
|
||||||
|
/* Fill in the lucky number */
|
||||||
|
message.lucky_number = 13;
|
||||||
|
|
||||||
|
/* Now we are ready to encode the message! */
|
||||||
|
status = pb_encode(&stream, SimpleMessage_fields, &message);
|
||||||
|
message_length = stream.bytes_written;
|
||||||
|
|
||||||
|
/* Then just check for any errors.. */
|
||||||
|
if (!status)
|
||||||
|
{
|
||||||
|
printf("Encoding failed: %s\n", PB_GET_ERROR(&stream));
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Now we could transmit the message over network, store it in a file or
|
||||||
|
* wrap it to a pigeon's leg.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* But because we are lazy, we will just decode it immediately. */
|
||||||
|
|
||||||
|
{
|
||||||
|
/* Allocate space for the decoded message. */
|
||||||
|
SimpleMessage message;
|
||||||
|
|
||||||
|
/* Create a stream that reads from the buffer. */
|
||||||
|
pb_istream_t stream = pb_istream_from_buffer(buffer, message_length);
|
||||||
|
|
||||||
|
/* Now we are ready to decode the message. */
|
||||||
|
status = pb_decode(&stream, SimpleMessage_fields, &message);
|
||||||
|
|
||||||
|
/* Check for errors... */
|
||||||
|
if (!status)
|
||||||
|
{
|
||||||
|
printf("Decoding failed: %s\n", PB_GET_ERROR(&stream));
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Print the data contained in the message. */
|
||||||
|
printf("Your lucky number was %d!\n", message.lucky_number);
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
7
examples/simple/simple.proto
Normal file
7
examples/simple/simple.proto
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
// A very simple protocol definition, consisting of only
|
||||||
|
// one message.
|
||||||
|
|
||||||
|
message SimpleMessage {
|
||||||
|
required int32 lucky_number = 1;
|
||||||
|
}
|
||||||
|
|
||||||
24
examples/using_double_on_avr/Makefile
Normal file
24
examples/using_double_on_avr/Makefile
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Include the nanopb provided Makefile rules
|
||||||
|
include ../../extra/nanopb.mk
|
||||||
|
|
||||||
|
# Compiler flags to enable all warnings & debug info
|
||||||
|
CFLAGS = -Wall -Werror -g -O0
|
||||||
|
CFLAGS += -I$(NANOPB_DIR)
|
||||||
|
|
||||||
|
all: run_tests
|
||||||
|
|
||||||
|
.SUFFIXES:
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -f test_conversions encode_double decode_double doubleproto.pb.c doubleproto.pb.h
|
||||||
|
|
||||||
|
test_conversions: test_conversions.c double_conversion.c
|
||||||
|
$(CC) $(CFLAGS) -o $@ $^
|
||||||
|
|
||||||
|
%: %.c double_conversion.c doubleproto.pb.c
|
||||||
|
$(CC) $(CFLAGS) -o $@ $^ $(NANOPB_CORE)
|
||||||
|
|
||||||
|
run_tests: test_conversions encode_double decode_double
|
||||||
|
./test_conversions
|
||||||
|
./encode_double | ./decode_double
|
||||||
|
|
||||||
@@ -1,3 +1,6 @@
|
|||||||
|
Nanopb example "using_double_on_avr"
|
||||||
|
====================================
|
||||||
|
|
||||||
Some processors/compilers, such as AVR-GCC, do not support the double
|
Some processors/compilers, such as AVR-GCC, do not support the double
|
||||||
datatype. Instead, they have sizeof(double) == 4. Because protocol
|
datatype. Instead, they have sizeof(double) == 4. Because protocol
|
||||||
binary format uses the double encoding directly, this causes trouble
|
binary format uses the double encoding directly, this causes trouble
|
||||||
@@ -9,7 +12,7 @@ platforms. The file double_conversion.c provides functions that
|
|||||||
convert these values to/from floats, without relying on compiler
|
convert these values to/from floats, without relying on compiler
|
||||||
support.
|
support.
|
||||||
|
|
||||||
To use this method, you need to make two modifications to your code:
|
To use this method, you need to make some modifications to your code:
|
||||||
|
|
||||||
1) Change all 'double' fields into 'fixed64' in the .proto.
|
1) Change all 'double' fields into 'fixed64' in the .proto.
|
||||||
|
|
||||||
@@ -17,6 +20,6 @@ To use this method, you need to make two modifications to your code:
|
|||||||
|
|
||||||
3) Whenever reading a 'double' field, use double_to_float().
|
3) Whenever reading a 'double' field, use double_to_float().
|
||||||
|
|
||||||
The conversion routines should be as accurate as the float datatype can
|
The conversion routines are as accurate as the float datatype can
|
||||||
be. Furthermore, they should handle all special values (NaN, inf, denormalized
|
be. Furthermore, they should handle all special values (NaN, inf, denormalized
|
||||||
numbers) correctly. There are testcases in test_conversions.c.
|
numbers) correctly. There are testcases in test_conversions.c.
|
||||||
20
examples/using_union_messages/Makefile
Normal file
20
examples/using_union_messages/Makefile
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Include the nanopb provided Makefile rules
|
||||||
|
include ../../extra/nanopb.mk
|
||||||
|
|
||||||
|
# Compiler flags to enable all warnings & debug info
|
||||||
|
CFLAGS = -ansi -Wall -Werror -g -O0
|
||||||
|
CFLAGS += -I$(NANOPB_DIR)
|
||||||
|
|
||||||
|
all: encode decode
|
||||||
|
./encode 1 | ./decode
|
||||||
|
./encode 2 | ./decode
|
||||||
|
./encode 3 | ./decode
|
||||||
|
|
||||||
|
.SUFFIXES:
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -f encode unionproto.pb.h unionproto.pb.c
|
||||||
|
|
||||||
|
%: %.c unionproto.pb.c
|
||||||
|
$(CC) $(CFLAGS) -o $@ $^ $(NANOPB_CORE)
|
||||||
|
|
||||||
52
examples/using_union_messages/README.txt
Normal file
52
examples/using_union_messages/README.txt
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
Nanopb example "using_union_messages"
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
Union messages is a common technique in Google Protocol Buffers used to
|
||||||
|
represent a group of messages, only one of which is passed at a time.
|
||||||
|
It is described in Google's documentation:
|
||||||
|
https://developers.google.com/protocol-buffers/docs/techniques#union
|
||||||
|
|
||||||
|
This directory contains an example on how to encode and decode union messages
|
||||||
|
with minimal memory usage. Usually, nanopb would allocate space to store
|
||||||
|
all of the possible messages at the same time, even though at most one of
|
||||||
|
them will be used at a time.
|
||||||
|
|
||||||
|
By using some of the lower level nanopb APIs, we can manually generate the
|
||||||
|
top level message, so that we only need to allocate the one submessage that
|
||||||
|
we actually want. Similarly when decoding, we can manually read the tag of
|
||||||
|
the top level message, and only then allocate the memory for the submessage
|
||||||
|
after we already know its type.
|
||||||
|
|
||||||
|
|
||||||
|
Example usage
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Type `make` to run the example. It will build it and run commands like
|
||||||
|
following:
|
||||||
|
|
||||||
|
./encode 1 | ./decode
|
||||||
|
Got MsgType1: 42
|
||||||
|
./encode 2 | ./decode
|
||||||
|
Got MsgType2: true
|
||||||
|
./encode 3 | ./decode
|
||||||
|
Got MsgType3: 3 1415
|
||||||
|
|
||||||
|
This simply demonstrates that the "decode" program has correctly identified
|
||||||
|
the type of the received message, and managed to decode it.
|
||||||
|
|
||||||
|
|
||||||
|
Details of implementation
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
unionproto.proto contains the protocol used in the example. It consists of
|
||||||
|
three messages: MsgType1, MsgType2 and MsgType3, which are collected together
|
||||||
|
into UnionMessage.
|
||||||
|
|
||||||
|
encode.c takes one command line argument, which should be a number 1-3. It
|
||||||
|
then fills in and encodes the corresponding message, and writes it to stdout.
|
||||||
|
|
||||||
|
decode.c reads a UnionMessage from stdin. Then it calls the function
|
||||||
|
decode_unionmessage_type() to determine the type of the message. After that,
|
||||||
|
the corresponding message is decoded and the contents of it printed to the
|
||||||
|
screen.
|
||||||
|
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
# Locate and configure the nanopb library.
|
# This is an example script for use with CMake projects for locating and configuring
|
||||||
|
# the nanopb library.
|
||||||
#
|
#
|
||||||
# The following varialbes have to be set:
|
# The following varialbes have to be set:
|
||||||
#
|
#
|
||||||
@@ -148,7 +149,7 @@ function(NANOPB_GENERATE_CPP SRCS HDRS)
|
|||||||
"${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.h"
|
"${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.h"
|
||||||
COMMAND python
|
COMMAND python
|
||||||
ARGS ${NANOPB_GENERATOR_EXECUTABLE} ${FIL_WE}.pb
|
ARGS ${NANOPB_GENERATOR_EXECUTABLE} ${FIL_WE}.pb
|
||||||
DEPENDS ${FIL_WE}.pb
|
DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb"
|
||||||
COMMENT "Running nanopb generator on ${FIL_WE}.pb"
|
COMMENT "Running nanopb generator on ${FIL_WE}.pb"
|
||||||
VERBATIM )
|
VERBATIM )
|
||||||
endforeach()
|
endforeach()
|
||||||
37
extra/nanopb.mk
Normal file
37
extra/nanopb.mk
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
# This is an include file for Makefiles. It provides rules for building
|
||||||
|
# .pb.c and .pb.h files out of .proto, as well the path to nanopb core.
|
||||||
|
|
||||||
|
# Path to the nanopb root directory
|
||||||
|
NANOPB_DIR := $(abspath $(dir $(lastword $(MAKEFILE_LIST)))../)
|
||||||
|
|
||||||
|
# Files for the nanopb core
|
||||||
|
NANOPB_CORE = $(NANOPB_DIR)/pb_encode.c $(NANOPB_DIR)/pb_decode.c
|
||||||
|
|
||||||
|
# Check if we are running on Windows
|
||||||
|
ifdef windir
|
||||||
|
WINDOWS = 1
|
||||||
|
endif
|
||||||
|
ifdef WINDIR
|
||||||
|
WINDOWS = 1
|
||||||
|
endif
|
||||||
|
|
||||||
|
# Check whether to use binary version of nanopb_generator or the
|
||||||
|
# system-supplied python interpreter.
|
||||||
|
ifneq "$(wildcard $(NANOPB_DIR)/generator-bin)" ""
|
||||||
|
# Binary package
|
||||||
|
PROTOC = $(NANOPB_DIR)/generator-bin/protoc
|
||||||
|
PROTOC_OPTS =
|
||||||
|
else
|
||||||
|
# Source only or git checkout
|
||||||
|
PROTOC = protoc
|
||||||
|
ifdef WINDOWS
|
||||||
|
PROTOC_OPTS = --plugin=protoc-gen-nanopb=$(NANOPB_DIR)/generator/protoc-gen-nanopb.bat
|
||||||
|
else
|
||||||
|
PROTOC_OPTS = --plugin=protoc-gen-nanopb=$(NANOPB_DIR)/generator/protoc-gen-nanopb
|
||||||
|
endif
|
||||||
|
endif
|
||||||
|
|
||||||
|
# Rule for building .pb.c and .pb.h
|
||||||
|
%.pb.c %.pb.h: %.proto $(wildcard %.options)
|
||||||
|
$(PROTOC) $(PROTOC_OPTS) --nanopb_out=. $<
|
||||||
|
|
||||||
94
extra/pb_syshdr.h
Normal file
94
extra/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
|
||||||
|
* extra 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
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
nanopb_pb2.py: nanopb.proto
|
|
||||||
protoc --python_out=. -I /usr/include -I . nanopb.proto
|
|
||||||
596
generator/nanopb_generator.py
Normal file → Executable file
596
generator/nanopb_generator.py
Normal file → Executable file
@@ -1,34 +1,42 @@
|
|||||||
|
#!/usr/bin/python
|
||||||
|
|
||||||
'''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
|
'''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
|
||||||
nanopb_version = "nanopb-0.2.1-dev"
|
nanopb_version = "nanopb-0.2.5"
|
||||||
|
|
||||||
|
import sys
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Add some dummy imports to keep packaging tools happy.
|
||||||
|
import google, distutils.util # bbfreeze seems to need these
|
||||||
|
import pkg_resources # pyinstaller / protobuf 2.5 seem to need these
|
||||||
|
except:
|
||||||
|
# Don't care, we will error out later if it is actually important.
|
||||||
|
pass
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import google.protobuf.descriptor_pb2 as descriptor
|
|
||||||
import google.protobuf.text_format as text_format
|
import google.protobuf.text_format as text_format
|
||||||
except:
|
except:
|
||||||
print
|
sys.stderr.write('''
|
||||||
print "*************************************************************"
|
*************************************************************
|
||||||
print "*** Could not import the Google protobuf Python libraries ***"
|
*** Could not import the Google protobuf Python libraries ***
|
||||||
print "*** Try installing package 'python-protobuf' or similar. ***"
|
*** Try installing package 'python-protobuf' or similar. ***
|
||||||
print "*************************************************************"
|
*************************************************************
|
||||||
print
|
''' + '\n')
|
||||||
raise
|
raise
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import nanopb_pb2
|
import proto.nanopb_pb2 as nanopb_pb2
|
||||||
|
import proto.descriptor_pb2 as descriptor
|
||||||
except:
|
except:
|
||||||
print
|
sys.stderr.write('''
|
||||||
print "***************************************************************"
|
********************************************************************
|
||||||
print "*** Could not import the precompiled nanopb_pb2.py. ***"
|
*** Failed to import the protocol definitions for generator. ***
|
||||||
print "*** Run 'make' in the 'generator' folder to update the file.***"
|
*** You have to run 'make' in the nanopb/generator/proto folder. ***
|
||||||
print "***************************************************************"
|
********************************************************************
|
||||||
print
|
''' + '\n')
|
||||||
raise
|
raise
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# Generation of single fields
|
# Generation of single fields
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -36,22 +44,22 @@ except:
|
|||||||
import time
|
import time
|
||||||
import os.path
|
import os.path
|
||||||
|
|
||||||
# Values are tuple (c type, pb type)
|
# Values are tuple (c type, pb type, encoded size)
|
||||||
FieldD = descriptor.FieldDescriptorProto
|
FieldD = descriptor.FieldDescriptorProto
|
||||||
datatypes = {
|
datatypes = {
|
||||||
FieldD.TYPE_BOOL: ('bool', 'BOOL'),
|
FieldD.TYPE_BOOL: ('bool', 'BOOL', 1),
|
||||||
FieldD.TYPE_DOUBLE: ('double', 'DOUBLE'),
|
FieldD.TYPE_DOUBLE: ('double', 'DOUBLE', 8),
|
||||||
FieldD.TYPE_FIXED32: ('uint32_t', 'FIXED32'),
|
FieldD.TYPE_FIXED32: ('uint32_t', 'FIXED32', 4),
|
||||||
FieldD.TYPE_FIXED64: ('uint64_t', 'FIXED64'),
|
FieldD.TYPE_FIXED64: ('uint64_t', 'FIXED64', 8),
|
||||||
FieldD.TYPE_FLOAT: ('float', 'FLOAT'),
|
FieldD.TYPE_FLOAT: ('float', 'FLOAT', 4),
|
||||||
FieldD.TYPE_INT32: ('int32_t', 'INT32'),
|
FieldD.TYPE_INT32: ('int32_t', 'INT32', 10),
|
||||||
FieldD.TYPE_INT64: ('int64_t', 'INT64'),
|
FieldD.TYPE_INT64: ('int64_t', 'INT64', 10),
|
||||||
FieldD.TYPE_SFIXED32: ('int32_t', 'SFIXED32'),
|
FieldD.TYPE_SFIXED32: ('int32_t', 'SFIXED32', 4),
|
||||||
FieldD.TYPE_SFIXED64: ('int64_t', 'SFIXED64'),
|
FieldD.TYPE_SFIXED64: ('int64_t', 'SFIXED64', 8),
|
||||||
FieldD.TYPE_SINT32: ('int32_t', 'SINT32'),
|
FieldD.TYPE_SINT32: ('int32_t', 'SINT32', 5),
|
||||||
FieldD.TYPE_SINT64: ('int64_t', 'SINT64'),
|
FieldD.TYPE_SINT64: ('int64_t', 'SINT64', 10),
|
||||||
FieldD.TYPE_UINT32: ('uint32_t', 'UINT32'),
|
FieldD.TYPE_UINT32: ('uint32_t', 'UINT32', 5),
|
||||||
FieldD.TYPE_UINT64: ('uint64_t', 'UINT64')
|
FieldD.TYPE_UINT64: ('uint64_t', 'UINT64', 10)
|
||||||
}
|
}
|
||||||
|
|
||||||
class Names:
|
class Names:
|
||||||
@@ -81,6 +89,55 @@ def names_from_type_name(type_name):
|
|||||||
raise NotImplementedError("Lookup of non-absolute type names is not supported")
|
raise NotImplementedError("Lookup of non-absolute type names is not supported")
|
||||||
return Names(type_name[1:].split('.'))
|
return Names(type_name[1:].split('.'))
|
||||||
|
|
||||||
|
def varint_max_size(max_value):
|
||||||
|
'''Returns the maximum number of bytes a varint can take when encoded.'''
|
||||||
|
for i in range(1, 11):
|
||||||
|
if (max_value >> (i * 7)) == 0:
|
||||||
|
return i
|
||||||
|
raise ValueError("Value too large for varint: " + str(max_value))
|
||||||
|
|
||||||
|
assert varint_max_size(0) == 1
|
||||||
|
assert varint_max_size(127) == 1
|
||||||
|
assert varint_max_size(128) == 2
|
||||||
|
|
||||||
|
class EncodedSize:
|
||||||
|
'''Class used to represent the encoded size of a field or a message.
|
||||||
|
Consists of a combination of symbolic sizes and integer sizes.'''
|
||||||
|
def __init__(self, value = 0, symbols = []):
|
||||||
|
if isinstance(value, (str, Names)):
|
||||||
|
symbols = [str(value)]
|
||||||
|
value = 0
|
||||||
|
self.value = value
|
||||||
|
self.symbols = symbols
|
||||||
|
|
||||||
|
def __add__(self, other):
|
||||||
|
if isinstance(other, (int, long)):
|
||||||
|
return EncodedSize(self.value + other, self.symbols)
|
||||||
|
elif isinstance(other, (str, Names)):
|
||||||
|
return EncodedSize(self.value, self.symbols + [str(other)])
|
||||||
|
elif isinstance(other, EncodedSize):
|
||||||
|
return EncodedSize(self.value + other.value, self.symbols + other.symbols)
|
||||||
|
else:
|
||||||
|
raise ValueError("Cannot add size: " + repr(other))
|
||||||
|
|
||||||
|
def __mul__(self, other):
|
||||||
|
if isinstance(other, (int, long)):
|
||||||
|
return EncodedSize(self.value * other, [str(other) + '*' + s for s in self.symbols])
|
||||||
|
else:
|
||||||
|
raise ValueError("Cannot multiply size: " + repr(other))
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
if not self.symbols:
|
||||||
|
return str(self.value)
|
||||||
|
else:
|
||||||
|
return '(' + str(self.value) + ' + ' + ' + '.join(self.symbols) + ')'
|
||||||
|
|
||||||
|
def upperlimit(self):
|
||||||
|
if not self.symbols:
|
||||||
|
return self.value
|
||||||
|
else:
|
||||||
|
return 2**32 - 1
|
||||||
|
|
||||||
class Enum:
|
class Enum:
|
||||||
def __init__(self, names, desc, enum_options):
|
def __init__(self, names, desc, enum_options):
|
||||||
'''desc is EnumDescriptorProto'''
|
'''desc is EnumDescriptorProto'''
|
||||||
@@ -111,6 +168,7 @@ class Field:
|
|||||||
self.max_size = None
|
self.max_size = None
|
||||||
self.max_count = None
|
self.max_count = None
|
||||||
self.array_decl = ""
|
self.array_decl = ""
|
||||||
|
self.enc_size = None
|
||||||
|
|
||||||
# Parse field options
|
# Parse field options
|
||||||
if field_options.HasField("max_size"):
|
if field_options.HasField("max_size"):
|
||||||
@@ -137,33 +195,15 @@ class Field:
|
|||||||
else:
|
else:
|
||||||
raise NotImplementedError(desc.label)
|
raise NotImplementedError(desc.label)
|
||||||
|
|
||||||
# Decide the C data type to use in the struct.
|
# Check if the field can be implemented with static allocation
|
||||||
if datatypes.has_key(desc.type):
|
# i.e. whether the data size is known.
|
||||||
self.ctype, self.pbtype = datatypes[desc.type]
|
if desc.type == FieldD.TYPE_STRING and self.max_size is None:
|
||||||
elif desc.type == FieldD.TYPE_ENUM:
|
can_be_static = False
|
||||||
self.pbtype = 'ENUM'
|
|
||||||
self.ctype = names_from_type_name(desc.type_name)
|
|
||||||
if self.default is not None:
|
|
||||||
self.default = self.ctype + self.default
|
|
||||||
elif desc.type == FieldD.TYPE_STRING:
|
|
||||||
self.pbtype = 'STRING'
|
|
||||||
if self.max_size is None:
|
|
||||||
can_be_static = False
|
|
||||||
else:
|
|
||||||
self.ctype = 'char'
|
|
||||||
self.array_decl += '[%d]' % self.max_size
|
|
||||||
elif desc.type == FieldD.TYPE_BYTES:
|
|
||||||
self.pbtype = 'BYTES'
|
|
||||||
if self.max_size is None:
|
|
||||||
can_be_static = False
|
|
||||||
else:
|
|
||||||
self.ctype = self.struct_name + self.name + 't'
|
|
||||||
elif desc.type == FieldD.TYPE_MESSAGE:
|
|
||||||
self.pbtype = 'MESSAGE'
|
|
||||||
self.ctype = self.submsgname = names_from_type_name(desc.type_name)
|
|
||||||
else:
|
|
||||||
raise NotImplementedError(desc.type)
|
|
||||||
|
|
||||||
|
if desc.type == FieldD.TYPE_BYTES and self.max_size is None:
|
||||||
|
can_be_static = False
|
||||||
|
|
||||||
|
# Decide how the field data will be allocated
|
||||||
if field_options.type == nanopb_pb2.FT_DEFAULT:
|
if field_options.type == nanopb_pb2.FT_DEFAULT:
|
||||||
if can_be_static:
|
if can_be_static:
|
||||||
field_options.type = nanopb_pb2.FT_STATIC
|
field_options.type = nanopb_pb2.FT_STATIC
|
||||||
@@ -171,28 +211,73 @@ class Field:
|
|||||||
field_options.type = nanopb_pb2.FT_CALLBACK
|
field_options.type = nanopb_pb2.FT_CALLBACK
|
||||||
|
|
||||||
if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static:
|
if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static:
|
||||||
raise Exception("Field %s is defined as static, but max_size or max_count is not given." % self.name)
|
raise Exception("Field %s is defined as static, but max_size or "
|
||||||
|
"max_count is not given." % self.name)
|
||||||
|
|
||||||
if field_options.type == nanopb_pb2.FT_STATIC:
|
if field_options.type == nanopb_pb2.FT_STATIC:
|
||||||
self.allocation = 'STATIC'
|
self.allocation = 'STATIC'
|
||||||
|
elif field_options.type == nanopb_pb2.FT_POINTER:
|
||||||
|
self.allocation = 'POINTER'
|
||||||
elif field_options.type == nanopb_pb2.FT_CALLBACK:
|
elif field_options.type == nanopb_pb2.FT_CALLBACK:
|
||||||
self.allocation = 'CALLBACK'
|
self.allocation = 'CALLBACK'
|
||||||
self.ctype = 'pb_callback_t'
|
|
||||||
self.array_decl = ''
|
|
||||||
else:
|
else:
|
||||||
raise NotImplementedError(field_options.type)
|
raise NotImplementedError(field_options.type)
|
||||||
|
|
||||||
|
# Decide the C data type to use in the struct.
|
||||||
|
if datatypes.has_key(desc.type):
|
||||||
|
self.ctype, self.pbtype, self.enc_size = datatypes[desc.type]
|
||||||
|
elif desc.type == FieldD.TYPE_ENUM:
|
||||||
|
self.pbtype = 'ENUM'
|
||||||
|
self.ctype = names_from_type_name(desc.type_name)
|
||||||
|
if self.default is not None:
|
||||||
|
self.default = self.ctype + self.default
|
||||||
|
self.enc_size = 5 # protoc rejects enum values > 32 bits
|
||||||
|
elif desc.type == FieldD.TYPE_STRING:
|
||||||
|
self.pbtype = 'STRING'
|
||||||
|
self.ctype = 'char'
|
||||||
|
if self.allocation == 'STATIC':
|
||||||
|
self.ctype = 'char'
|
||||||
|
self.array_decl += '[%d]' % self.max_size
|
||||||
|
self.enc_size = varint_max_size(self.max_size) + self.max_size
|
||||||
|
elif desc.type == FieldD.TYPE_BYTES:
|
||||||
|
self.pbtype = 'BYTES'
|
||||||
|
if self.allocation == 'STATIC':
|
||||||
|
self.ctype = self.struct_name + self.name + 't'
|
||||||
|
self.enc_size = varint_max_size(self.max_size) + self.max_size
|
||||||
|
elif self.allocation == 'POINTER':
|
||||||
|
self.ctype = 'pb_bytes_ptr_t'
|
||||||
|
elif desc.type == FieldD.TYPE_MESSAGE:
|
||||||
|
self.pbtype = 'MESSAGE'
|
||||||
|
self.ctype = self.submsgname = names_from_type_name(desc.type_name)
|
||||||
|
self.enc_size = None # Needs to be filled in after the message type is available
|
||||||
|
else:
|
||||||
|
raise NotImplementedError(desc.type)
|
||||||
|
|
||||||
def __cmp__(self, other):
|
def __cmp__(self, other):
|
||||||
return cmp(self.tag, other.tag)
|
return cmp(self.tag, other.tag)
|
||||||
|
|
||||||
def __str__(self):
|
def __str__(self):
|
||||||
if self.rules == 'OPTIONAL' and self.allocation == 'STATIC':
|
result = ''
|
||||||
result = ' bool has_' + self.name + ';\n'
|
if self.allocation == 'POINTER':
|
||||||
elif self.rules == 'REPEATED' and self.allocation == 'STATIC':
|
if self.rules == 'REPEATED':
|
||||||
result = ' size_t ' + self.name + '_count;\n'
|
result += ' size_t ' + self.name + '_count;\n'
|
||||||
|
|
||||||
|
if self.pbtype == 'MESSAGE':
|
||||||
|
# Use struct definition, so recursive submessages are possible
|
||||||
|
result += ' struct _%s *%s;' % (self.ctype, self.name)
|
||||||
|
elif self.rules == 'REPEATED' and self.pbtype == 'STRING':
|
||||||
|
# String arrays need to be defined as pointers to pointers
|
||||||
|
result += ' %s **%s;' % (self.ctype, self.name)
|
||||||
|
else:
|
||||||
|
result += ' %s *%s;' % (self.ctype, self.name)
|
||||||
|
elif self.allocation == 'CALLBACK':
|
||||||
|
result += ' pb_callback_t %s;' % self.name
|
||||||
else:
|
else:
|
||||||
result = ''
|
if self.rules == 'OPTIONAL' and self.allocation == 'STATIC':
|
||||||
result += ' %s %s%s;' % (self.ctype, self.name, self.array_decl)
|
result += ' bool has_' + self.name + ';\n'
|
||||||
|
elif self.rules == 'REPEATED' and self.allocation == 'STATIC':
|
||||||
|
result += ' size_t ' + self.name + '_count;\n'
|
||||||
|
result += ' %s %s%s;' % (self.ctype, self.name, self.array_decl)
|
||||||
return result
|
return result
|
||||||
|
|
||||||
def types(self):
|
def types(self):
|
||||||
@@ -235,14 +320,20 @@ 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.
|
||||||
'''
|
'''
|
||||||
result = ' PB_FIELD(%3d, ' % self.tag
|
result = ' PB_FIELD2(%3d, ' % self.tag
|
||||||
result += '%-8s, ' % self.pbtype
|
result += '%-8s, ' % self.pbtype
|
||||||
result += '%s, ' % self.rules
|
result += '%s, ' % self.rules
|
||||||
result += '%s, ' % self.allocation
|
result += '%-8s, ' % self.allocation
|
||||||
|
result += '%s, ' % ("FIRST" if not prev_field_name else "OTHER")
|
||||||
result += '%s, ' % self.struct_name
|
result += '%s, ' % self.struct_name
|
||||||
result += '%s, ' % self.name
|
result += '%s, ' % self.name
|
||||||
result += '%s, ' % (prev_field_name or self.name)
|
result += '%s, ' % (prev_field_name or self.name)
|
||||||
@@ -269,9 +360,129 @@ class Field:
|
|||||||
|
|
||||||
return max(self.tag, self.max_size, self.max_count)
|
return max(self.tag, self.max_size, self.max_count)
|
||||||
|
|
||||||
|
def encoded_size(self, allmsgs):
|
||||||
|
'''Return the maximum size that this field can take when encoded,
|
||||||
|
including the field tag. If the size cannot be determined, returns
|
||||||
|
None.'''
|
||||||
|
|
||||||
|
if self.allocation != 'STATIC':
|
||||||
|
return None
|
||||||
|
|
||||||
|
if self.pbtype == 'MESSAGE':
|
||||||
|
for msg in allmsgs:
|
||||||
|
if msg.name == self.submsgname:
|
||||||
|
encsize = msg.encoded_size(allmsgs)
|
||||||
|
if encsize is None:
|
||||||
|
return None # Submessage size is indeterminate
|
||||||
|
|
||||||
|
# Include submessage length prefix
|
||||||
|
encsize += varint_max_size(encsize.upperlimit())
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
# Submessage cannot be found, this currently occurs when
|
||||||
|
# the submessage type is defined in a different file.
|
||||||
|
# Instead of direct numeric value, reference the size that
|
||||||
|
# has been #defined in the other file.
|
||||||
|
encsize = EncodedSize(self.submsgname + 'size')
|
||||||
|
|
||||||
|
# We will have to make a conservative assumption on the length
|
||||||
|
# prefix size, though.
|
||||||
|
encsize += 5
|
||||||
|
|
||||||
|
elif self.enc_size is None:
|
||||||
|
raise RuntimeError("Could not determine encoded size for %s.%s"
|
||||||
|
% (self.struct_name, self.name))
|
||||||
|
else:
|
||||||
|
encsize = EncodedSize(self.enc_size)
|
||||||
|
|
||||||
|
encsize += varint_max_size(self.tag << 3) # Tag + wire type
|
||||||
|
|
||||||
|
if self.rules == 'REPEATED':
|
||||||
|
# Decoders must be always able to handle unpacked arrays.
|
||||||
|
# Therefore we have to reserve space for it, even though
|
||||||
|
# we emit packed arrays ourselves.
|
||||||
|
encsize *= self.max_count
|
||||||
|
|
||||||
|
return encsize
|
||||||
|
|
||||||
|
|
||||||
|
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 ''
|
||||||
|
|
||||||
|
def encoded_size(self, allmsgs):
|
||||||
|
# We exclude extensions from the count, because they cannot be known
|
||||||
|
# until runtime. Other option would be to return None here, but this
|
||||||
|
# way the value remains useful if extensions are not used.
|
||||||
|
return EncodedSize(0)
|
||||||
|
|
||||||
|
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 tags(self):
|
||||||
|
'''Return the #define for the tag number of this field.'''
|
||||||
|
identifier = '%s_tag' % self.fullname
|
||||||
|
return '#define %-40s %d\n' % (identifier, self.tag)
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -289,6 +500,12 @@ class Message:
|
|||||||
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()
|
||||||
@@ -351,9 +568,18 @@ class Message:
|
|||||||
result += ' PB_LAST_FIELD\n};'
|
result += ' PB_LAST_FIELD\n};'
|
||||||
return result
|
return result
|
||||||
|
|
||||||
|
def encoded_size(self, allmsgs):
|
||||||
|
'''Return the maximum size that this message can take when encoded.
|
||||||
|
If the size cannot be determined, returns None.
|
||||||
|
'''
|
||||||
|
size = EncodedSize(0)
|
||||||
|
for field in self.fields:
|
||||||
|
fsize = field.encoded_size(allmsgs)
|
||||||
|
if fsize is None:
|
||||||
|
return None
|
||||||
|
size += fsize
|
||||||
|
|
||||||
|
return size
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -375,11 +601,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('.'))
|
||||||
@@ -397,6 +635,11 @@ def parse_file(fdesc, file_options):
|
|||||||
enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
|
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:
|
||||||
@@ -406,7 +649,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.
|
||||||
@@ -449,7 +692,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.
|
||||||
'''
|
'''
|
||||||
@@ -484,24 +727,47 @@ def generate_header(dependencies, headername, enums, messages, options):
|
|||||||
for msg in sort_dependencies(messages):
|
for msg in sort_dependencies(messages):
|
||||||
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()
|
||||||
|
for extension in extensions:
|
||||||
|
yield extension.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'
|
||||||
|
yield '\n'
|
||||||
|
|
||||||
yield '\n#ifdef __cplusplus\n'
|
yield '/* Maximum encoded size of messages (where known) */\n'
|
||||||
|
for msg in messages:
|
||||||
|
msize = msg.encoded_size(messages)
|
||||||
|
if msize is not None:
|
||||||
|
identifier = '%s_size' % msg.name
|
||||||
|
yield '#define %-40s %s\n' % (identifier, msize)
|
||||||
|
yield '\n'
|
||||||
|
|
||||||
|
yield '#ifdef __cplusplus\n'
|
||||||
yield '} /* extern "C" */\n'
|
yield '} /* extern "C" */\n'
|
||||||
yield '#endif\n'
|
yield '#endif\n'
|
||||||
|
|
||||||
# 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, options):
|
||||||
'''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'
|
||||||
@@ -516,7 +782,11 @@ 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)
|
||||||
@@ -528,7 +798,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 = []
|
||||||
@@ -676,72 +945,133 @@ optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", def
|
|||||||
optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
|
optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
|
||||||
help="Set generator option (max_size, max_count etc.).")
|
help="Set generator option (max_size, max_count etc.).")
|
||||||
|
|
||||||
def process(filenames, options):
|
def process_file(filename, fdesc, options):
|
||||||
'''Process the files given on the command line.'''
|
'''Process a single file.
|
||||||
|
filename: The full path to the .proto or .pb source file, as string.
|
||||||
|
fdesc: The loaded FileDescriptorSet, or None to read from the input file.
|
||||||
|
options: Command line options as they come from OptionsParser.
|
||||||
|
|
||||||
|
Returns a dict:
|
||||||
|
{'headername': Name of header file,
|
||||||
|
'headerdata': Data for the .h header file,
|
||||||
|
'sourcename': Name of the source code file,
|
||||||
|
'sourcedata': Data for the .c source code file
|
||||||
|
}
|
||||||
|
'''
|
||||||
|
toplevel_options = nanopb_pb2.NanoPBOptions()
|
||||||
|
for s in options.settings:
|
||||||
|
text_format.Merge(s, toplevel_options)
|
||||||
|
|
||||||
|
if not fdesc:
|
||||||
|
data = open(filename, 'rb').read()
|
||||||
|
fdesc = descriptor.FileDescriptorSet.FromString(data).file[0]
|
||||||
|
|
||||||
|
# Check if there is a separate .options file
|
||||||
|
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:
|
||||||
|
print 'Reading options from ' + optfilename
|
||||||
|
|
||||||
|
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, toplevel_options, Names([filename]))
|
||||||
|
enums, messages, extensions = parse_file(fdesc, file_options)
|
||||||
|
|
||||||
|
# Decide the file names
|
||||||
|
noext = os.path.splitext(filename)[0]
|
||||||
|
headername = noext + '.' + options.extension + '.h'
|
||||||
|
sourcename = noext + '.' + options.extension + '.c'
|
||||||
|
headerbasename = os.path.basename(headername)
|
||||||
|
|
||||||
|
# List of .proto files that should not be included in the C header file
|
||||||
|
# even if they are mentioned in the source .proto.
|
||||||
|
excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
|
||||||
|
dependencies = [d for d in fdesc.dependency if d not in excludes]
|
||||||
|
|
||||||
|
headerdata = ''.join(generate_header(dependencies, headerbasename, enums,
|
||||||
|
messages, extensions, options))
|
||||||
|
|
||||||
|
sourcedata = ''.join(generate_source(headerbasename, enums,
|
||||||
|
messages, extensions, options))
|
||||||
|
|
||||||
|
return {'headername': headername, 'headerdata': headerdata,
|
||||||
|
'sourcename': sourcename, 'sourcedata': sourcedata}
|
||||||
|
|
||||||
|
def main_cli():
|
||||||
|
'''Main function when invoked directly from the command line.'''
|
||||||
|
|
||||||
|
options, filenames = optparser.parse_args()
|
||||||
|
|
||||||
if not filenames:
|
if not filenames:
|
||||||
optparser.print_help()
|
optparser.print_help()
|
||||||
return False
|
sys.exit(1)
|
||||||
|
|
||||||
if options.quiet:
|
if options.quiet:
|
||||||
options.verbose = False
|
options.verbose = False
|
||||||
|
|
||||||
Globals.verbose_options = options.verbose
|
Globals.verbose_options = options.verbose
|
||||||
|
|
||||||
toplevel_options = nanopb_pb2.NanoPBOptions()
|
|
||||||
for s in options.settings:
|
|
||||||
text_format.Merge(s, toplevel_options)
|
|
||||||
|
|
||||||
for filename in filenames:
|
for filename in filenames:
|
||||||
data = open(filename, 'rb').read()
|
results = process_file(filename, None, options)
|
||||||
fdesc = descriptor.FileDescriptorSet.FromString(data)
|
|
||||||
|
|
||||||
# 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:
|
|
||||||
print 'Reading options from ' + optfilename
|
|
||||||
|
|
||||||
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 = parse_file(fdesc.file[0], file_options)
|
|
||||||
|
|
||||||
noext = os.path.splitext(filename)[0]
|
|
||||||
headername = noext + '.' + options.extension + '.h'
|
|
||||||
sourcename = noext + '.' + options.extension + '.c'
|
|
||||||
headerbasename = os.path.basename(headername)
|
|
||||||
|
|
||||||
if not options.quiet:
|
if not options.quiet:
|
||||||
print "Writing to " + headername + " and " + sourcename
|
print "Writing to " + results['headername'] + " and " + results['sourcename']
|
||||||
|
|
||||||
# List of .proto files that should not be included in the C header file
|
open(results['headername'], 'w').write(results['headerdata'])
|
||||||
# even if they are mentioned in the source .proto.
|
open(results['sourcename'], 'w').write(results['sourcedata'])
|
||||||
excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
|
|
||||||
dependencies = [d for d in fdesc.file[0].dependency if d not in excludes]
|
|
||||||
|
|
||||||
header = open(headername, 'w')
|
|
||||||
for part in generate_header(dependencies, headerbasename, enums, messages, options):
|
|
||||||
header.write(part)
|
|
||||||
|
|
||||||
source = open(sourcename, 'w')
|
def main_plugin():
|
||||||
for part in generate_source(headerbasename, enums, messages):
|
'''Main function when invoked as a protoc plugin.'''
|
||||||
source.write(part)
|
|
||||||
|
|
||||||
return True
|
import sys
|
||||||
|
if sys.platform == "win32":
|
||||||
|
import os, msvcrt
|
||||||
|
# Set stdin and stdout to binary mode
|
||||||
|
msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
|
||||||
|
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
|
||||||
|
|
||||||
|
import proto.plugin_pb2 as plugin_pb2
|
||||||
|
data = sys.stdin.read()
|
||||||
|
request = plugin_pb2.CodeGeneratorRequest.FromString(data)
|
||||||
|
|
||||||
|
import shlex
|
||||||
|
args = shlex.split(request.parameter)
|
||||||
|
options, dummy = optparser.parse_args(args)
|
||||||
|
|
||||||
|
# We can't go printing stuff to stdout
|
||||||
|
Globals.verbose_options = False
|
||||||
|
options.verbose = False
|
||||||
|
options.quiet = True
|
||||||
|
|
||||||
|
response = plugin_pb2.CodeGeneratorResponse()
|
||||||
|
|
||||||
|
for filename in request.file_to_generate:
|
||||||
|
for fdesc in request.proto_file:
|
||||||
|
if fdesc.name == filename:
|
||||||
|
results = process_file(filename, fdesc, options)
|
||||||
|
|
||||||
|
f = response.file.add()
|
||||||
|
f.name = results['headername']
|
||||||
|
f.content = results['headerdata']
|
||||||
|
|
||||||
|
f = response.file.add()
|
||||||
|
f.name = results['sourcename']
|
||||||
|
f.content = results['sourcedata']
|
||||||
|
|
||||||
|
sys.stdout.write(response.SerializeToString())
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
options, filenames = optparser.parse_args()
|
# Check if we are running as a plugin under protoc
|
||||||
status = process(filenames, options)
|
if 'protoc-gen-' in sys.argv[0] or '--protoc-plugin' in sys.argv:
|
||||||
|
main_plugin()
|
||||||
if not status:
|
else:
|
||||||
sys.exit(1)
|
main_cli()
|
||||||
|
|
||||||
|
|||||||
@@ -1,158 +0,0 @@
|
|||||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
||||||
|
|
||||||
from google.protobuf import descriptor
|
|
||||||
from google.protobuf import message
|
|
||||||
from google.protobuf import reflection
|
|
||||||
from google.protobuf import descriptor_pb2
|
|
||||||
# @@protoc_insertion_point(imports)
|
|
||||||
|
|
||||||
|
|
||||||
import google.protobuf.descriptor_pb2
|
|
||||||
|
|
||||||
DESCRIPTOR = descriptor.FileDescriptor(
|
|
||||||
name='nanopb.proto',
|
|
||||||
package='',
|
|
||||||
serialized_pb='\n\x0cnanopb.proto\x1a google/protobuf/descriptor.proto\"\x92\x01\n\rNanoPBOptions\x12\x10\n\x08max_size\x18\x01 \x01(\x05\x12\x11\n\tmax_count\x18\x02 \x01(\x05\x12$\n\x04type\x18\x03 \x01(\x0e\x32\n.FieldType:\nFT_DEFAULT\x12\x18\n\nlong_names\x18\x04 \x01(\x08:\x04true\x12\x1c\n\rpacked_struct\x18\x05 \x01(\x08:\x05\x66\x61lse*J\n\tFieldType\x12\x0e\n\nFT_DEFAULT\x10\x00\x12\x0f\n\x0b\x46T_CALLBACK\x10\x01\x12\r\n\tFT_STATIC\x10\x02\x12\r\n\tFT_IGNORE\x10\x03:E\n\x0enanopb_fileopt\x12\x1c.google.protobuf.FileOptions\x18\xf2\x07 \x01(\x0b\x32\x0e.NanoPBOptions:G\n\rnanopb_msgopt\x12\x1f.google.protobuf.MessageOptions\x18\xf2\x07 \x01(\x0b\x32\x0e.NanoPBOptions:E\n\x0enanopb_enumopt\x12\x1c.google.protobuf.EnumOptions\x18\xf2\x07 \x01(\x0b\x32\x0e.NanoPBOptions:>\n\x06nanopb\x12\x1d.google.protobuf.FieldOptions\x18\xf2\x07 \x01(\x0b\x32\x0e.NanoPBOptions')
|
|
||||||
|
|
||||||
_FIELDTYPE = descriptor.EnumDescriptor(
|
|
||||||
name='FieldType',
|
|
||||||
full_name='FieldType',
|
|
||||||
filename=None,
|
|
||||||
file=DESCRIPTOR,
|
|
||||||
values=[
|
|
||||||
descriptor.EnumValueDescriptor(
|
|
||||||
name='FT_DEFAULT', index=0, number=0,
|
|
||||||
options=None,
|
|
||||||
type=None),
|
|
||||||
descriptor.EnumValueDescriptor(
|
|
||||||
name='FT_CALLBACK', index=1, number=1,
|
|
||||||
options=None,
|
|
||||||
type=None),
|
|
||||||
descriptor.EnumValueDescriptor(
|
|
||||||
name='FT_STATIC', index=2, number=2,
|
|
||||||
options=None,
|
|
||||||
type=None),
|
|
||||||
descriptor.EnumValueDescriptor(
|
|
||||||
name='FT_IGNORE', index=3, number=3,
|
|
||||||
options=None,
|
|
||||||
type=None),
|
|
||||||
],
|
|
||||||
containing_type=None,
|
|
||||||
options=None,
|
|
||||||
serialized_start=199,
|
|
||||||
serialized_end=273,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
FT_DEFAULT = 0
|
|
||||||
FT_CALLBACK = 1
|
|
||||||
FT_STATIC = 2
|
|
||||||
FT_IGNORE = 3
|
|
||||||
|
|
||||||
NANOPB_FILEOPT_FIELD_NUMBER = 1010
|
|
||||||
nanopb_fileopt = descriptor.FieldDescriptor(
|
|
||||||
name='nanopb_fileopt', full_name='nanopb_fileopt', index=0,
|
|
||||||
number=1010, type=11, cpp_type=10, label=1,
|
|
||||||
has_default_value=False, default_value=None,
|
|
||||||
message_type=None, enum_type=None, containing_type=None,
|
|
||||||
is_extension=True, extension_scope=None,
|
|
||||||
options=None)
|
|
||||||
NANOPB_MSGOPT_FIELD_NUMBER = 1010
|
|
||||||
nanopb_msgopt = descriptor.FieldDescriptor(
|
|
||||||
name='nanopb_msgopt', full_name='nanopb_msgopt', index=1,
|
|
||||||
number=1010, type=11, cpp_type=10, label=1,
|
|
||||||
has_default_value=False, default_value=None,
|
|
||||||
message_type=None, enum_type=None, containing_type=None,
|
|
||||||
is_extension=True, extension_scope=None,
|
|
||||||
options=None)
|
|
||||||
NANOPB_ENUMOPT_FIELD_NUMBER = 1010
|
|
||||||
nanopb_enumopt = descriptor.FieldDescriptor(
|
|
||||||
name='nanopb_enumopt', full_name='nanopb_enumopt', index=2,
|
|
||||||
number=1010, type=11, cpp_type=10, label=1,
|
|
||||||
has_default_value=False, default_value=None,
|
|
||||||
message_type=None, enum_type=None, containing_type=None,
|
|
||||||
is_extension=True, extension_scope=None,
|
|
||||||
options=None)
|
|
||||||
NANOPB_FIELD_NUMBER = 1010
|
|
||||||
nanopb = descriptor.FieldDescriptor(
|
|
||||||
name='nanopb', full_name='nanopb', index=3,
|
|
||||||
number=1010, type=11, cpp_type=10, label=1,
|
|
||||||
has_default_value=False, default_value=None,
|
|
||||||
message_type=None, enum_type=None, containing_type=None,
|
|
||||||
is_extension=True, extension_scope=None,
|
|
||||||
options=None)
|
|
||||||
|
|
||||||
|
|
||||||
_NANOPBOPTIONS = descriptor.Descriptor(
|
|
||||||
name='NanoPBOptions',
|
|
||||||
full_name='NanoPBOptions',
|
|
||||||
filename=None,
|
|
||||||
file=DESCRIPTOR,
|
|
||||||
containing_type=None,
|
|
||||||
fields=[
|
|
||||||
descriptor.FieldDescriptor(
|
|
||||||
name='max_size', full_name='NanoPBOptions.max_size', index=0,
|
|
||||||
number=1, type=5, cpp_type=1, label=1,
|
|
||||||
has_default_value=False, default_value=0,
|
|
||||||
message_type=None, enum_type=None, containing_type=None,
|
|
||||||
is_extension=False, extension_scope=None,
|
|
||||||
options=None),
|
|
||||||
descriptor.FieldDescriptor(
|
|
||||||
name='max_count', full_name='NanoPBOptions.max_count', index=1,
|
|
||||||
number=2, type=5, cpp_type=1, label=1,
|
|
||||||
has_default_value=False, default_value=0,
|
|
||||||
message_type=None, enum_type=None, containing_type=None,
|
|
||||||
is_extension=False, extension_scope=None,
|
|
||||||
options=None),
|
|
||||||
descriptor.FieldDescriptor(
|
|
||||||
name='type', full_name='NanoPBOptions.type', index=2,
|
|
||||||
number=3, type=14, cpp_type=8, label=1,
|
|
||||||
has_default_value=True, default_value=0,
|
|
||||||
message_type=None, enum_type=None, containing_type=None,
|
|
||||||
is_extension=False, extension_scope=None,
|
|
||||||
options=None),
|
|
||||||
descriptor.FieldDescriptor(
|
|
||||||
name='long_names', full_name='NanoPBOptions.long_names', index=3,
|
|
||||||
number=4, type=8, cpp_type=7, label=1,
|
|
||||||
has_default_value=True, default_value=True,
|
|
||||||
message_type=None, enum_type=None, containing_type=None,
|
|
||||||
is_extension=False, extension_scope=None,
|
|
||||||
options=None),
|
|
||||||
descriptor.FieldDescriptor(
|
|
||||||
name='packed_struct', full_name='NanoPBOptions.packed_struct', index=4,
|
|
||||||
number=5, type=8, cpp_type=7, label=1,
|
|
||||||
has_default_value=True, default_value=False,
|
|
||||||
message_type=None, enum_type=None, containing_type=None,
|
|
||||||
is_extension=False, extension_scope=None,
|
|
||||||
options=None),
|
|
||||||
],
|
|
||||||
extensions=[
|
|
||||||
],
|
|
||||||
nested_types=[],
|
|
||||||
enum_types=[
|
|
||||||
],
|
|
||||||
options=None,
|
|
||||||
is_extendable=False,
|
|
||||||
extension_ranges=[],
|
|
||||||
serialized_start=51,
|
|
||||||
serialized_end=197,
|
|
||||||
)
|
|
||||||
|
|
||||||
_NANOPBOPTIONS.fields_by_name['type'].enum_type = _FIELDTYPE
|
|
||||||
DESCRIPTOR.message_types_by_name['NanoPBOptions'] = _NANOPBOPTIONS
|
|
||||||
|
|
||||||
class NanoPBOptions(message.Message):
|
|
||||||
__metaclass__ = reflection.GeneratedProtocolMessageType
|
|
||||||
DESCRIPTOR = _NANOPBOPTIONS
|
|
||||||
|
|
||||||
# @@protoc_insertion_point(class_scope:NanoPBOptions)
|
|
||||||
|
|
||||||
nanopb_fileopt.message_type = _NANOPBOPTIONS
|
|
||||||
google.protobuf.descriptor_pb2.FileOptions.RegisterExtension(nanopb_fileopt)
|
|
||||||
nanopb_msgopt.message_type = _NANOPBOPTIONS
|
|
||||||
google.protobuf.descriptor_pb2.MessageOptions.RegisterExtension(nanopb_msgopt)
|
|
||||||
nanopb_enumopt.message_type = _NANOPBOPTIONS
|
|
||||||
google.protobuf.descriptor_pb2.EnumOptions.RegisterExtension(nanopb_enumopt)
|
|
||||||
nanopb.message_type = _NANOPBOPTIONS
|
|
||||||
google.protobuf.descriptor_pb2.FieldOptions.RegisterExtension(nanopb)
|
|
||||||
# @@protoc_insertion_point(module_scope)
|
|
||||||
4
generator/proto/Makefile
Normal file
4
generator/proto/Makefile
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
all: nanopb_pb2.py plugin_pb2.py descriptor_pb2.py
|
||||||
|
|
||||||
|
%_pb2.py: %.proto
|
||||||
|
protoc --python_out=. $<
|
||||||
620
generator/proto/descriptor.proto
Normal file
620
generator/proto/descriptor.proto
Normal file
@@ -0,0 +1,620 @@
|
|||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// http://code.google.com/p/protobuf/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// Author: kenton@google.com (Kenton Varda)
|
||||||
|
// Based on original Protocol Buffers design by
|
||||||
|
// Sanjay Ghemawat, Jeff Dean, and others.
|
||||||
|
//
|
||||||
|
// The messages in this file describe the definitions found in .proto files.
|
||||||
|
// A valid .proto file can be translated directly to a FileDescriptorProto
|
||||||
|
// without any other information (e.g. without reading its imports).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "DescriptorProtos";
|
||||||
|
|
||||||
|
// descriptor.proto must be optimized for speed because reflection-based
|
||||||
|
// algorithms don't work during bootstrapping.
|
||||||
|
option optimize_for = SPEED;
|
||||||
|
|
||||||
|
// The protocol compiler can output a FileDescriptorSet containing the .proto
|
||||||
|
// files it parses.
|
||||||
|
message FileDescriptorSet {
|
||||||
|
repeated FileDescriptorProto file = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a complete .proto file.
|
||||||
|
message FileDescriptorProto {
|
||||||
|
optional string name = 1; // file name, relative to root of source tree
|
||||||
|
optional string package = 2; // e.g. "foo", "foo.bar", etc.
|
||||||
|
|
||||||
|
// Names of files imported by this file.
|
||||||
|
repeated string dependency = 3;
|
||||||
|
// Indexes of the public imported files in the dependency list above.
|
||||||
|
repeated int32 public_dependency = 10;
|
||||||
|
// Indexes of the weak imported files in the dependency list.
|
||||||
|
// For Google-internal migration only. Do not use.
|
||||||
|
repeated int32 weak_dependency = 11;
|
||||||
|
|
||||||
|
// All top-level definitions in this file.
|
||||||
|
repeated DescriptorProto message_type = 4;
|
||||||
|
repeated EnumDescriptorProto enum_type = 5;
|
||||||
|
repeated ServiceDescriptorProto service = 6;
|
||||||
|
repeated FieldDescriptorProto extension = 7;
|
||||||
|
|
||||||
|
optional FileOptions options = 8;
|
||||||
|
|
||||||
|
// This field contains optional information about the original source code.
|
||||||
|
// You may safely remove this entire field whithout harming runtime
|
||||||
|
// functionality of the descriptors -- the information is needed only by
|
||||||
|
// development tools.
|
||||||
|
optional SourceCodeInfo source_code_info = 9;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a message type.
|
||||||
|
message DescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
|
||||||
|
repeated FieldDescriptorProto field = 2;
|
||||||
|
repeated FieldDescriptorProto extension = 6;
|
||||||
|
|
||||||
|
repeated DescriptorProto nested_type = 3;
|
||||||
|
repeated EnumDescriptorProto enum_type = 4;
|
||||||
|
|
||||||
|
message ExtensionRange {
|
||||||
|
optional int32 start = 1;
|
||||||
|
optional int32 end = 2;
|
||||||
|
}
|
||||||
|
repeated ExtensionRange extension_range = 5;
|
||||||
|
|
||||||
|
optional MessageOptions options = 7;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a field within a message.
|
||||||
|
message FieldDescriptorProto {
|
||||||
|
enum Type {
|
||||||
|
// 0 is reserved for errors.
|
||||||
|
// Order is weird for historical reasons.
|
||||||
|
TYPE_DOUBLE = 1;
|
||||||
|
TYPE_FLOAT = 2;
|
||||||
|
// Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if
|
||||||
|
// negative values are likely.
|
||||||
|
TYPE_INT64 = 3;
|
||||||
|
TYPE_UINT64 = 4;
|
||||||
|
// Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if
|
||||||
|
// negative values are likely.
|
||||||
|
TYPE_INT32 = 5;
|
||||||
|
TYPE_FIXED64 = 6;
|
||||||
|
TYPE_FIXED32 = 7;
|
||||||
|
TYPE_BOOL = 8;
|
||||||
|
TYPE_STRING = 9;
|
||||||
|
TYPE_GROUP = 10; // Tag-delimited aggregate.
|
||||||
|
TYPE_MESSAGE = 11; // Length-delimited aggregate.
|
||||||
|
|
||||||
|
// New in version 2.
|
||||||
|
TYPE_BYTES = 12;
|
||||||
|
TYPE_UINT32 = 13;
|
||||||
|
TYPE_ENUM = 14;
|
||||||
|
TYPE_SFIXED32 = 15;
|
||||||
|
TYPE_SFIXED64 = 16;
|
||||||
|
TYPE_SINT32 = 17; // Uses ZigZag encoding.
|
||||||
|
TYPE_SINT64 = 18; // Uses ZigZag encoding.
|
||||||
|
};
|
||||||
|
|
||||||
|
enum Label {
|
||||||
|
// 0 is reserved for errors
|
||||||
|
LABEL_OPTIONAL = 1;
|
||||||
|
LABEL_REQUIRED = 2;
|
||||||
|
LABEL_REPEATED = 3;
|
||||||
|
// TODO(sanjay): Should we add LABEL_MAP?
|
||||||
|
};
|
||||||
|
|
||||||
|
optional string name = 1;
|
||||||
|
optional int32 number = 3;
|
||||||
|
optional Label label = 4;
|
||||||
|
|
||||||
|
// If type_name is set, this need not be set. If both this and type_name
|
||||||
|
// are set, this must be either TYPE_ENUM or TYPE_MESSAGE.
|
||||||
|
optional Type type = 5;
|
||||||
|
|
||||||
|
// For message and enum types, this is the name of the type. If the name
|
||||||
|
// starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
|
||||||
|
// rules are used to find the type (i.e. first the nested types within this
|
||||||
|
// message are searched, then within the parent, on up to the root
|
||||||
|
// namespace).
|
||||||
|
optional string type_name = 6;
|
||||||
|
|
||||||
|
// For extensions, this is the name of the type being extended. It is
|
||||||
|
// resolved in the same manner as type_name.
|
||||||
|
optional string extendee = 2;
|
||||||
|
|
||||||
|
// For numeric types, contains the original text representation of the value.
|
||||||
|
// For booleans, "true" or "false".
|
||||||
|
// For strings, contains the default text contents (not escaped in any way).
|
||||||
|
// For bytes, contains the C escaped value. All bytes >= 128 are escaped.
|
||||||
|
// TODO(kenton): Base-64 encode?
|
||||||
|
optional string default_value = 7;
|
||||||
|
|
||||||
|
optional FieldOptions options = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes an enum type.
|
||||||
|
message EnumDescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
|
||||||
|
repeated EnumValueDescriptorProto value = 2;
|
||||||
|
|
||||||
|
optional EnumOptions options = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a value within an enum.
|
||||||
|
message EnumValueDescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
optional int32 number = 2;
|
||||||
|
|
||||||
|
optional EnumValueOptions options = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a service.
|
||||||
|
message ServiceDescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
repeated MethodDescriptorProto method = 2;
|
||||||
|
|
||||||
|
optional ServiceOptions options = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a method of a service.
|
||||||
|
message MethodDescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
|
||||||
|
// Input and output type names. These are resolved in the same way as
|
||||||
|
// FieldDescriptorProto.type_name, but must refer to a message type.
|
||||||
|
optional string input_type = 2;
|
||||||
|
optional string output_type = 3;
|
||||||
|
|
||||||
|
optional MethodOptions options = 4;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// ===================================================================
|
||||||
|
// Options
|
||||||
|
|
||||||
|
// Each of the definitions above may have "options" attached. These are
|
||||||
|
// just annotations which may cause code to be generated slightly differently
|
||||||
|
// or may contain hints for code that manipulates protocol messages.
|
||||||
|
//
|
||||||
|
// Clients may define custom options as extensions of the *Options messages.
|
||||||
|
// These extensions may not yet be known at parsing time, so the parser cannot
|
||||||
|
// store the values in them. Instead it stores them in a field in the *Options
|
||||||
|
// message called uninterpreted_option. This field must have the same name
|
||||||
|
// across all *Options messages. We then use this field to populate the
|
||||||
|
// extensions when we build a descriptor, at which point all protos have been
|
||||||
|
// parsed and so all extensions are known.
|
||||||
|
//
|
||||||
|
// Extension numbers for custom options may be chosen as follows:
|
||||||
|
// * For options which will only be used within a single application or
|
||||||
|
// organization, or for experimental options, use field numbers 50000
|
||||||
|
// through 99999. It is up to you to ensure that you do not use the
|
||||||
|
// same number for multiple options.
|
||||||
|
// * For options which will be published and used publicly by multiple
|
||||||
|
// independent entities, e-mail protobuf-global-extension-registry@google.com
|
||||||
|
// to reserve extension numbers. Simply provide your project name (e.g.
|
||||||
|
// Object-C plugin) and your porject website (if available) -- there's no need
|
||||||
|
// to explain how you intend to use them. Usually you only need one extension
|
||||||
|
// number. You can declare multiple options with only one extension number by
|
||||||
|
// putting them in a sub-message. See the Custom Options section of the docs
|
||||||
|
// for examples:
|
||||||
|
// http://code.google.com/apis/protocolbuffers/docs/proto.html#options
|
||||||
|
// If this turns out to be popular, a web service will be set up
|
||||||
|
// to automatically assign option numbers.
|
||||||
|
|
||||||
|
|
||||||
|
message FileOptions {
|
||||||
|
|
||||||
|
// Sets the Java package where classes generated from this .proto will be
|
||||||
|
// placed. By default, the proto package is used, but this is often
|
||||||
|
// inappropriate because proto packages do not normally start with backwards
|
||||||
|
// domain names.
|
||||||
|
optional string java_package = 1;
|
||||||
|
|
||||||
|
|
||||||
|
// If set, all the classes from the .proto file are wrapped in a single
|
||||||
|
// outer class with the given name. This applies to both Proto1
|
||||||
|
// (equivalent to the old "--one_java_file" option) and Proto2 (where
|
||||||
|
// a .proto always translates to a single class, but you may want to
|
||||||
|
// explicitly choose the class name).
|
||||||
|
optional string java_outer_classname = 8;
|
||||||
|
|
||||||
|
// If set true, then the Java code generator will generate a separate .java
|
||||||
|
// file for each top-level message, enum, and service defined in the .proto
|
||||||
|
// file. Thus, these types will *not* be nested inside the outer class
|
||||||
|
// named by java_outer_classname. However, the outer class will still be
|
||||||
|
// generated to contain the file's getDescriptor() method as well as any
|
||||||
|
// top-level extensions defined in the file.
|
||||||
|
optional bool java_multiple_files = 10 [default=false];
|
||||||
|
|
||||||
|
// If set true, then the Java code generator will generate equals() and
|
||||||
|
// hashCode() methods for all messages defined in the .proto file. This is
|
||||||
|
// purely a speed optimization, as the AbstractMessage base class includes
|
||||||
|
// reflection-based implementations of these methods.
|
||||||
|
optional bool java_generate_equals_and_hash = 20 [default=false];
|
||||||
|
|
||||||
|
// Generated classes can be optimized for speed or code size.
|
||||||
|
enum OptimizeMode {
|
||||||
|
SPEED = 1; // Generate complete code for parsing, serialization,
|
||||||
|
// etc.
|
||||||
|
CODE_SIZE = 2; // Use ReflectionOps to implement these methods.
|
||||||
|
LITE_RUNTIME = 3; // Generate code using MessageLite and the lite runtime.
|
||||||
|
}
|
||||||
|
optional OptimizeMode optimize_for = 9 [default=SPEED];
|
||||||
|
|
||||||
|
// Sets the Go package where structs generated from this .proto will be
|
||||||
|
// placed. There is no default.
|
||||||
|
optional string go_package = 11;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// Should generic services be generated in each language? "Generic" services
|
||||||
|
// are not specific to any particular RPC system. They are generated by the
|
||||||
|
// main code generators in each language (without additional plugins).
|
||||||
|
// Generic services were the only kind of service generation supported by
|
||||||
|
// early versions of proto2.
|
||||||
|
//
|
||||||
|
// Generic services are now considered deprecated in favor of using plugins
|
||||||
|
// that generate code specific to your particular RPC system. Therefore,
|
||||||
|
// these default to false. Old code which depends on generic services should
|
||||||
|
// explicitly set them to true.
|
||||||
|
optional bool cc_generic_services = 16 [default=false];
|
||||||
|
optional bool java_generic_services = 17 [default=false];
|
||||||
|
optional bool py_generic_services = 18 [default=false];
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message MessageOptions {
|
||||||
|
// Set true to use the old proto1 MessageSet wire format for extensions.
|
||||||
|
// This is provided for backwards-compatibility with the MessageSet wire
|
||||||
|
// format. You should not use this for any other reason: It's less
|
||||||
|
// efficient, has fewer features, and is more complicated.
|
||||||
|
//
|
||||||
|
// The message must be defined exactly as follows:
|
||||||
|
// message Foo {
|
||||||
|
// option message_set_wire_format = true;
|
||||||
|
// extensions 4 to max;
|
||||||
|
// }
|
||||||
|
// Note that the message cannot have any defined fields; MessageSets only
|
||||||
|
// have extensions.
|
||||||
|
//
|
||||||
|
// All extensions of your type must be singular messages; e.g. they cannot
|
||||||
|
// be int32s, enums, or repeated messages.
|
||||||
|
//
|
||||||
|
// Because this is an option, the above two restrictions are not enforced by
|
||||||
|
// the protocol compiler.
|
||||||
|
optional bool message_set_wire_format = 1 [default=false];
|
||||||
|
|
||||||
|
// Disables the generation of the standard "descriptor()" accessor, which can
|
||||||
|
// conflict with a field of the same name. This is meant to make migration
|
||||||
|
// from proto1 easier; new code should avoid fields named "descriptor".
|
||||||
|
optional bool no_standard_descriptor_accessor = 2 [default=false];
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message FieldOptions {
|
||||||
|
// The ctype option instructs the C++ code generator to use a different
|
||||||
|
// representation of the field than it normally would. See the specific
|
||||||
|
// options below. This option is not yet implemented in the open source
|
||||||
|
// release -- sorry, we'll try to include it in a future version!
|
||||||
|
optional CType ctype = 1 [default = STRING];
|
||||||
|
enum CType {
|
||||||
|
// Default mode.
|
||||||
|
STRING = 0;
|
||||||
|
|
||||||
|
CORD = 1;
|
||||||
|
|
||||||
|
STRING_PIECE = 2;
|
||||||
|
}
|
||||||
|
// The packed option can be enabled for repeated primitive fields to enable
|
||||||
|
// a more efficient representation on the wire. Rather than repeatedly
|
||||||
|
// writing the tag and type for each element, the entire array is encoded as
|
||||||
|
// a single length-delimited blob.
|
||||||
|
optional bool packed = 2;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// Should this field be parsed lazily? Lazy applies only to message-type
|
||||||
|
// fields. It means that when the outer message is initially parsed, the
|
||||||
|
// inner message's contents will not be parsed but instead stored in encoded
|
||||||
|
// form. The inner message will actually be parsed when it is first accessed.
|
||||||
|
//
|
||||||
|
// This is only a hint. Implementations are free to choose whether to use
|
||||||
|
// eager or lazy parsing regardless of the value of this option. However,
|
||||||
|
// setting this option true suggests that the protocol author believes that
|
||||||
|
// using lazy parsing on this field is worth the additional bookkeeping
|
||||||
|
// overhead typically needed to implement it.
|
||||||
|
//
|
||||||
|
// This option does not affect the public interface of any generated code;
|
||||||
|
// all method signatures remain the same. Furthermore, thread-safety of the
|
||||||
|
// interface is not affected by this option; const methods remain safe to
|
||||||
|
// call from multiple threads concurrently, while non-const methods continue
|
||||||
|
// to require exclusive access.
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// Note that implementations may choose not to check required fields within
|
||||||
|
// a lazy sub-message. That is, calling IsInitialized() on the outher message
|
||||||
|
// may return true even if the inner message has missing required fields.
|
||||||
|
// This is necessary because otherwise the inner message would have to be
|
||||||
|
// parsed in order to perform the check, defeating the purpose of lazy
|
||||||
|
// parsing. An implementation which chooses not to check required fields
|
||||||
|
// must be consistent about it. That is, for any particular sub-message, the
|
||||||
|
// implementation must either *always* check its required fields, or *never*
|
||||||
|
// check its required fields, regardless of whether or not the message has
|
||||||
|
// been parsed.
|
||||||
|
optional bool lazy = 5 [default=false];
|
||||||
|
|
||||||
|
// Is this field deprecated?
|
||||||
|
// Depending on the target platform, this can emit Deprecated annotations
|
||||||
|
// for accessors, or it will be completely ignored; in the very least, this
|
||||||
|
// is a formalization for deprecating fields.
|
||||||
|
optional bool deprecated = 3 [default=false];
|
||||||
|
|
||||||
|
// EXPERIMENTAL. DO NOT USE.
|
||||||
|
// For "map" fields, the name of the field in the enclosed type that
|
||||||
|
// is the key for this map. For example, suppose we have:
|
||||||
|
// message Item {
|
||||||
|
// required string name = 1;
|
||||||
|
// required string value = 2;
|
||||||
|
// }
|
||||||
|
// message Config {
|
||||||
|
// repeated Item items = 1 [experimental_map_key="name"];
|
||||||
|
// }
|
||||||
|
// In this situation, the map key for Item will be set to "name".
|
||||||
|
// TODO: Fully-implement this, then remove the "experimental_" prefix.
|
||||||
|
optional string experimental_map_key = 9;
|
||||||
|
|
||||||
|
// For Google-internal migration only. Do not use.
|
||||||
|
optional bool weak = 10 [default=false];
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message EnumOptions {
|
||||||
|
|
||||||
|
// Set this option to false to disallow mapping different tag names to a same
|
||||||
|
// value.
|
||||||
|
optional bool allow_alias = 2 [default=true];
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message EnumValueOptions {
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message ServiceOptions {
|
||||||
|
|
||||||
|
// Note: Field numbers 1 through 32 are reserved for Google's internal RPC
|
||||||
|
// framework. We apologize for hoarding these numbers to ourselves, but
|
||||||
|
// we were already using them long before we decided to release Protocol
|
||||||
|
// Buffers.
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message MethodOptions {
|
||||||
|
|
||||||
|
// Note: Field numbers 1 through 32 are reserved for Google's internal RPC
|
||||||
|
// framework. We apologize for hoarding these numbers to ourselves, but
|
||||||
|
// we were already using them long before we decided to release Protocol
|
||||||
|
// Buffers.
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// A message representing a option the parser does not recognize. This only
|
||||||
|
// appears in options protos created by the compiler::Parser class.
|
||||||
|
// DescriptorPool resolves these when building Descriptor objects. Therefore,
|
||||||
|
// options protos in descriptor objects (e.g. returned by Descriptor::options(),
|
||||||
|
// or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
|
||||||
|
// in them.
|
||||||
|
message UninterpretedOption {
|
||||||
|
// The name of the uninterpreted option. Each string represents a segment in
|
||||||
|
// a dot-separated name. is_extension is true iff a segment represents an
|
||||||
|
// extension (denoted with parentheses in options specs in .proto files).
|
||||||
|
// E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents
|
||||||
|
// "foo.(bar.baz).qux".
|
||||||
|
message NamePart {
|
||||||
|
required string name_part = 1;
|
||||||
|
required bool is_extension = 2;
|
||||||
|
}
|
||||||
|
repeated NamePart name = 2;
|
||||||
|
|
||||||
|
// The value of the uninterpreted option, in whatever type the tokenizer
|
||||||
|
// identified it as during parsing. Exactly one of these should be set.
|
||||||
|
optional string identifier_value = 3;
|
||||||
|
optional uint64 positive_int_value = 4;
|
||||||
|
optional int64 negative_int_value = 5;
|
||||||
|
optional double double_value = 6;
|
||||||
|
optional bytes string_value = 7;
|
||||||
|
optional string aggregate_value = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ===================================================================
|
||||||
|
// Optional source code info
|
||||||
|
|
||||||
|
// Encapsulates information about the original source file from which a
|
||||||
|
// FileDescriptorProto was generated.
|
||||||
|
message SourceCodeInfo {
|
||||||
|
// A Location identifies a piece of source code in a .proto file which
|
||||||
|
// corresponds to a particular definition. This information is intended
|
||||||
|
// to be useful to IDEs, code indexers, documentation generators, and similar
|
||||||
|
// tools.
|
||||||
|
//
|
||||||
|
// For example, say we have a file like:
|
||||||
|
// message Foo {
|
||||||
|
// optional string foo = 1;
|
||||||
|
// }
|
||||||
|
// Let's look at just the field definition:
|
||||||
|
// optional string foo = 1;
|
||||||
|
// ^ ^^ ^^ ^ ^^^
|
||||||
|
// a bc de f ghi
|
||||||
|
// We have the following locations:
|
||||||
|
// span path represents
|
||||||
|
// [a,i) [ 4, 0, 2, 0 ] The whole field definition.
|
||||||
|
// [a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
|
||||||
|
// [c,d) [ 4, 0, 2, 0, 5 ] The type (string).
|
||||||
|
// [e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
|
||||||
|
// [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
|
||||||
|
//
|
||||||
|
// Notes:
|
||||||
|
// - A location may refer to a repeated field itself (i.e. not to any
|
||||||
|
// particular index within it). This is used whenever a set of elements are
|
||||||
|
// logically enclosed in a single code segment. For example, an entire
|
||||||
|
// extend block (possibly containing multiple extension definitions) will
|
||||||
|
// have an outer location whose path refers to the "extensions" repeated
|
||||||
|
// field without an index.
|
||||||
|
// - Multiple locations may have the same path. This happens when a single
|
||||||
|
// logical declaration is spread out across multiple places. The most
|
||||||
|
// obvious example is the "extend" block again -- there may be multiple
|
||||||
|
// extend blocks in the same scope, each of which will have the same path.
|
||||||
|
// - A location's span is not always a subset of its parent's span. For
|
||||||
|
// example, the "extendee" of an extension declaration appears at the
|
||||||
|
// beginning of the "extend" block and is shared by all extensions within
|
||||||
|
// the block.
|
||||||
|
// - Just because a location's span is a subset of some other location's span
|
||||||
|
// does not mean that it is a descendent. For example, a "group" defines
|
||||||
|
// both a type and a field in a single declaration. Thus, the locations
|
||||||
|
// corresponding to the type and field and their components will overlap.
|
||||||
|
// - Code which tries to interpret locations should probably be designed to
|
||||||
|
// ignore those that it doesn't understand, as more types of locations could
|
||||||
|
// be recorded in the future.
|
||||||
|
repeated Location location = 1;
|
||||||
|
message Location {
|
||||||
|
// Identifies which part of the FileDescriptorProto was defined at this
|
||||||
|
// location.
|
||||||
|
//
|
||||||
|
// Each element is a field number or an index. They form a path from
|
||||||
|
// the root FileDescriptorProto to the place where the definition. For
|
||||||
|
// example, this path:
|
||||||
|
// [ 4, 3, 2, 7, 1 ]
|
||||||
|
// refers to:
|
||||||
|
// file.message_type(3) // 4, 3
|
||||||
|
// .field(7) // 2, 7
|
||||||
|
// .name() // 1
|
||||||
|
// This is because FileDescriptorProto.message_type has field number 4:
|
||||||
|
// repeated DescriptorProto message_type = 4;
|
||||||
|
// and DescriptorProto.field has field number 2:
|
||||||
|
// repeated FieldDescriptorProto field = 2;
|
||||||
|
// and FieldDescriptorProto.name has field number 1:
|
||||||
|
// optional string name = 1;
|
||||||
|
//
|
||||||
|
// Thus, the above path gives the location of a field name. If we removed
|
||||||
|
// the last element:
|
||||||
|
// [ 4, 3, 2, 7 ]
|
||||||
|
// this path refers to the whole field declaration (from the beginning
|
||||||
|
// of the label to the terminating semicolon).
|
||||||
|
repeated int32 path = 1 [packed=true];
|
||||||
|
|
||||||
|
// Always has exactly three or four elements: start line, start column,
|
||||||
|
// end line (optional, otherwise assumed same as start line), end column.
|
||||||
|
// These are packed into a single field for efficiency. Note that line
|
||||||
|
// and column numbers are zero-based -- typically you will want to add
|
||||||
|
// 1 to each before displaying to a user.
|
||||||
|
repeated int32 span = 2 [packed=true];
|
||||||
|
|
||||||
|
// If this SourceCodeInfo represents a complete declaration, these are any
|
||||||
|
// comments appearing before and after the declaration which appear to be
|
||||||
|
// attached to the declaration.
|
||||||
|
//
|
||||||
|
// A series of line comments appearing on consecutive lines, with no other
|
||||||
|
// tokens appearing on those lines, will be treated as a single comment.
|
||||||
|
//
|
||||||
|
// Only the comment content is provided; comment markers (e.g. //) are
|
||||||
|
// stripped out. For block comments, leading whitespace and an asterisk
|
||||||
|
// will be stripped from the beginning of each line other than the first.
|
||||||
|
// Newlines are included in the output.
|
||||||
|
//
|
||||||
|
// Examples:
|
||||||
|
//
|
||||||
|
// optional int32 foo = 1; // Comment attached to foo.
|
||||||
|
// // Comment attached to bar.
|
||||||
|
// optional int32 bar = 2;
|
||||||
|
//
|
||||||
|
// optional string baz = 3;
|
||||||
|
// // Comment attached to baz.
|
||||||
|
// // Another line attached to baz.
|
||||||
|
//
|
||||||
|
// // Comment attached to qux.
|
||||||
|
// //
|
||||||
|
// // Another line attached to qux.
|
||||||
|
// optional double qux = 4;
|
||||||
|
//
|
||||||
|
// optional string corge = 5;
|
||||||
|
// /* Block comment attached
|
||||||
|
// * to corge. Leading asterisks
|
||||||
|
// * will be removed. */
|
||||||
|
// /* Block comment attached to
|
||||||
|
// * grault. */
|
||||||
|
// optional int32 grault = 6;
|
||||||
|
optional string leading_comments = 3;
|
||||||
|
optional string trailing_comments = 4;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,13 +5,14 @@
|
|||||||
// These are used by nanopb to generate statically allocable structures
|
// These are used by nanopb to generate statically allocable structures
|
||||||
// for memory-limited environments.
|
// for memory-limited environments.
|
||||||
|
|
||||||
import "google/protobuf/descriptor.proto";
|
import "descriptor.proto";
|
||||||
|
|
||||||
option java_package = "fi.kapsi.koti.jpa.nanopb";
|
option java_package = "fi.kapsi.koti.jpa.nanopb";
|
||||||
|
|
||||||
enum FieldType {
|
enum FieldType {
|
||||||
FT_DEFAULT = 0; // Automatically decide field type, generate static field if possible.
|
FT_DEFAULT = 0; // Automatically decide field type, generate static field if possible.
|
||||||
FT_CALLBACK = 1; // Always generate a callback field.
|
FT_CALLBACK = 1; // Always generate a callback field.
|
||||||
|
FT_POINTER = 4; // Always generate a dynamically allocated field.
|
||||||
FT_STATIC = 2; // Generate a static field or raise an exception if not possible.
|
FT_STATIC = 2; // Generate a static field or raise an exception if not possible.
|
||||||
FT_IGNORE = 3; // Ignore the field completely.
|
FT_IGNORE = 3; // Ignore the field completely.
|
||||||
}
|
}
|
||||||
@@ -33,6 +34,8 @@ 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];
|
||||||
}
|
}
|
||||||
|
|
||||||
145
generator/proto/plugin.proto
Normal file
145
generator/proto/plugin.proto
Normal file
@@ -0,0 +1,145 @@
|
|||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// http://code.google.com/p/protobuf/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// Author: kenton@google.com (Kenton Varda)
|
||||||
|
//
|
||||||
|
// WARNING: The plugin interface is currently EXPERIMENTAL and is subject to
|
||||||
|
// change.
|
||||||
|
//
|
||||||
|
// protoc (aka the Protocol Compiler) can be extended via plugins. A plugin is
|
||||||
|
// just a program that reads a CodeGeneratorRequest from stdin and writes a
|
||||||
|
// CodeGeneratorResponse to stdout.
|
||||||
|
//
|
||||||
|
// Plugins written using C++ can use google/protobuf/compiler/plugin.h instead
|
||||||
|
// of dealing with the raw protocol defined here.
|
||||||
|
//
|
||||||
|
// A plugin executable needs only to be placed somewhere in the path. The
|
||||||
|
// plugin should be named "protoc-gen-$NAME", and will then be used when the
|
||||||
|
// flag "--${NAME}_out" is passed to protoc.
|
||||||
|
|
||||||
|
package google.protobuf.compiler;
|
||||||
|
|
||||||
|
import "descriptor.proto";
|
||||||
|
|
||||||
|
// An encoded CodeGeneratorRequest is written to the plugin's stdin.
|
||||||
|
message CodeGeneratorRequest {
|
||||||
|
// The .proto files that were explicitly listed on the command-line. The
|
||||||
|
// code generator should generate code only for these files. Each file's
|
||||||
|
// descriptor will be included in proto_file, below.
|
||||||
|
repeated string file_to_generate = 1;
|
||||||
|
|
||||||
|
// The generator parameter passed on the command-line.
|
||||||
|
optional string parameter = 2;
|
||||||
|
|
||||||
|
// FileDescriptorProtos for all files in files_to_generate and everything
|
||||||
|
// they import. The files will appear in topological order, so each file
|
||||||
|
// appears before any file that imports it.
|
||||||
|
//
|
||||||
|
// protoc guarantees that all proto_files will be written after
|
||||||
|
// the fields above, even though this is not technically guaranteed by the
|
||||||
|
// protobuf wire format. This theoretically could allow a plugin to stream
|
||||||
|
// in the FileDescriptorProtos and handle them one by one rather than read
|
||||||
|
// the entire set into memory at once. However, as of this writing, this
|
||||||
|
// is not similarly optimized on protoc's end -- it will store all fields in
|
||||||
|
// memory at once before sending them to the plugin.
|
||||||
|
repeated FileDescriptorProto proto_file = 15;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The plugin writes an encoded CodeGeneratorResponse to stdout.
|
||||||
|
message CodeGeneratorResponse {
|
||||||
|
// Error message. If non-empty, code generation failed. The plugin process
|
||||||
|
// should exit with status code zero even if it reports an error in this way.
|
||||||
|
//
|
||||||
|
// This should be used to indicate errors in .proto files which prevent the
|
||||||
|
// code generator from generating correct code. Errors which indicate a
|
||||||
|
// problem in protoc itself -- such as the input CodeGeneratorRequest being
|
||||||
|
// unparseable -- should be reported by writing a message to stderr and
|
||||||
|
// exiting with a non-zero status code.
|
||||||
|
optional string error = 1;
|
||||||
|
|
||||||
|
// Represents a single generated file.
|
||||||
|
message File {
|
||||||
|
// The file name, relative to the output directory. The name must not
|
||||||
|
// contain "." or ".." components and must be relative, not be absolute (so,
|
||||||
|
// the file cannot lie outside the output directory). "/" must be used as
|
||||||
|
// the path separator, not "\".
|
||||||
|
//
|
||||||
|
// If the name is omitted, the content will be appended to the previous
|
||||||
|
// file. This allows the generator to break large files into small chunks,
|
||||||
|
// and allows the generated text to be streamed back to protoc so that large
|
||||||
|
// files need not reside completely in memory at one time. Note that as of
|
||||||
|
// this writing protoc does not optimize for this -- it will read the entire
|
||||||
|
// CodeGeneratorResponse before writing files to disk.
|
||||||
|
optional string name = 1;
|
||||||
|
|
||||||
|
// If non-empty, indicates that the named file should already exist, and the
|
||||||
|
// content here is to be inserted into that file at a defined insertion
|
||||||
|
// point. This feature allows a code generator to extend the output
|
||||||
|
// produced by another code generator. The original generator may provide
|
||||||
|
// insertion points by placing special annotations in the file that look
|
||||||
|
// like:
|
||||||
|
// @@protoc_insertion_point(NAME)
|
||||||
|
// The annotation can have arbitrary text before and after it on the line,
|
||||||
|
// which allows it to be placed in a comment. NAME should be replaced with
|
||||||
|
// an identifier naming the point -- this is what other generators will use
|
||||||
|
// as the insertion_point. Code inserted at this point will be placed
|
||||||
|
// immediately above the line containing the insertion point (thus multiple
|
||||||
|
// insertions to the same point will come out in the order they were added).
|
||||||
|
// The double-@ is intended to make it unlikely that the generated code
|
||||||
|
// could contain things that look like insertion points by accident.
|
||||||
|
//
|
||||||
|
// For example, the C++ code generator places the following line in the
|
||||||
|
// .pb.h files that it generates:
|
||||||
|
// // @@protoc_insertion_point(namespace_scope)
|
||||||
|
// This line appears within the scope of the file's package namespace, but
|
||||||
|
// outside of any particular class. Another plugin can then specify the
|
||||||
|
// insertion_point "namespace_scope" to generate additional classes or
|
||||||
|
// other declarations that should be placed in this scope.
|
||||||
|
//
|
||||||
|
// Note that if the line containing the insertion point begins with
|
||||||
|
// whitespace, the same whitespace will be added to every line of the
|
||||||
|
// inserted text. This is useful for languages like Python, where
|
||||||
|
// indentation matters. In these languages, the insertion point comment
|
||||||
|
// should be indented the same amount as any inserted code will need to be
|
||||||
|
// in order to work correctly in that context.
|
||||||
|
//
|
||||||
|
// The code generator that generates the initial file and the one which
|
||||||
|
// inserts into it must both run as part of a single invocation of protoc.
|
||||||
|
// Code generators are executed in the order in which they appear on the
|
||||||
|
// command line.
|
||||||
|
//
|
||||||
|
// If |insertion_point| is present, |name| must also be present.
|
||||||
|
optional string insertion_point = 2;
|
||||||
|
|
||||||
|
// The file contents.
|
||||||
|
optional string content = 15;
|
||||||
|
}
|
||||||
|
repeated File file = 15;
|
||||||
|
}
|
||||||
13
generator/protoc-gen-nanopb
Executable file
13
generator/protoc-gen-nanopb
Executable file
@@ -0,0 +1,13 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
# This file is used to invoke nanopb_generator.py as a plugin
|
||||||
|
# to protoc on Linux and other *nix-style systems.
|
||||||
|
# Use it like this:
|
||||||
|
# protoc --plugin=nanopb=..../protoc-gen-nanopb --nanopb_out=dir foo.proto
|
||||||
|
#
|
||||||
|
# Note that if you use the binary package of nanopb, the protoc
|
||||||
|
# path is already set up properly and there is no need to give
|
||||||
|
# --plugin= on the command line.
|
||||||
|
|
||||||
|
MYPATH=$(dirname "$0")
|
||||||
|
exec python "$MYPATH/nanopb_generator.py" --protoc-plugin
|
||||||
12
generator/protoc-gen-nanopb.bat
Normal file
12
generator/protoc-gen-nanopb.bat
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
@echo off
|
||||||
|
:: This file is used to invoke nanopb_generator.py as a plugin
|
||||||
|
:: to protoc on Windows.
|
||||||
|
:: Use it like this:
|
||||||
|
:: protoc --plugin=nanopb=..../protoc-gen-nanopb.bat --nanopb_out=dir foo.proto
|
||||||
|
::
|
||||||
|
:: Note that if you use the binary package of nanopb, the protoc
|
||||||
|
:: path is already set up properly and there is no need to give
|
||||||
|
:: --plugin= on the command line.
|
||||||
|
|
||||||
|
set mydir=%~dp0
|
||||||
|
python "%mydir%\nanopb_generator.py" --protoc-plugin
|
||||||
312
pb.h
312
pb.h
@@ -1,13 +1,61 @@
|
|||||||
|
/* 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.5
|
||||||
|
|
||||||
|
/* 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.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#define NANOPB_VERSION nanopb-0.2.1-dev
|
|
||||||
|
|
||||||
#ifdef PB_SYSTEM_HEADER
|
#ifdef PB_SYSTEM_HEADER
|
||||||
#include PB_SYSTEM_HEADER
|
#include PB_SYSTEM_HEADER
|
||||||
#else
|
#else
|
||||||
@@ -30,7 +78,7 @@
|
|||||||
# define PB_PACKED_STRUCT_START _Pragma("pack(push, 1)")
|
# define PB_PACKED_STRUCT_START _Pragma("pack(push, 1)")
|
||||||
# define PB_PACKED_STRUCT_END _Pragma("pack(pop)")
|
# define PB_PACKED_STRUCT_END _Pragma("pack(pop)")
|
||||||
# define pb_packed
|
# define pb_packed
|
||||||
#elif defined(_MSC_VER)
|
#elif defined(_MSC_VER) && (_MSC_VER >= 1500)
|
||||||
/* For Microsoft Visual C++ */
|
/* For Microsoft Visual C++ */
|
||||||
# define PB_PACKED_STRUCT_START __pragma(pack(push, 1))
|
# define PB_PACKED_STRUCT_START __pragma(pack(push, 1))
|
||||||
# define PB_PACKED_STRUCT_END __pragma(pack(pop))
|
# define PB_PACKED_STRUCT_END __pragma(pack(pop))
|
||||||
@@ -42,7 +90,7 @@
|
|||||||
# define pb_packed
|
# define pb_packed
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* Handly macro for suppressing unreferenced-parameter compiler warnings. */
|
/* Handly macro for suppressing unreferenced-parameter compiler warnings. */
|
||||||
#ifndef UNUSED
|
#ifndef UNUSED
|
||||||
#define UNUSED(x) (void)(x)
|
#define UNUSED(x) (void)(x)
|
||||||
#endif
|
#endif
|
||||||
@@ -56,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
|
||||||
@@ -69,58 +116,53 @@
|
|||||||
/* List of possible field types. These are used in the autogenerated code.
|
/* List of possible field types. These are used in the autogenerated code.
|
||||||
* Least-significant 4 bits tell the scalar type
|
* Least-significant 4 bits tell the scalar type
|
||||||
* Most-significant 4 bits specify repeated/required/packed etc.
|
* Most-significant 4 bits specify repeated/required/packed etc.
|
||||||
*
|
|
||||||
* INT32 and UINT32 are treated the same, as are (U)INT64 and (S)FIXED*
|
|
||||||
* These types are simply casted to correct field type when they are
|
|
||||||
* assigned to the memory pointer.
|
|
||||||
* SINT* is different, though, because it is zig-zag coded.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
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, int64, enum, bool */
|
||||||
#define PB_LTYPE_SVARINT 0x01 /* sint32, sint64 */
|
#define PB_LTYPE_UVARINT 0x01 /* uint32, uint64 */
|
||||||
#define PB_LTYPE_FIXED32 0x02 /* fixed32, sfixed32, float */
|
#define PB_LTYPE_SVARINT 0x02 /* sint32, sint64 */
|
||||||
#define PB_LTYPE_FIXED64 0x03 /* fixed64, sfixed64, double */
|
#define PB_LTYPE_FIXED32 0x03 /* fixed32, sfixed32, float */
|
||||||
|
#define PB_LTYPE_FIXED64 0x04 /* fixed64, sfixed64, double */
|
||||||
|
|
||||||
/* Marker for last packable field type. */
|
/* Marker for last packable field type. */
|
||||||
#define PB_LTYPE_LAST_PACKABLE 0x03
|
#define PB_LTYPE_LAST_PACKABLE 0x04
|
||||||
|
|
||||||
/* Byte array with pre-allocated buffer.
|
/* Byte array with pre-allocated buffer.
|
||||||
* data_size is the length of the allocated PB_BYTES_ARRAY structure. */
|
* data_size is the length of the allocated PB_BYTES_ARRAY structure. */
|
||||||
#define PB_LTYPE_BYTES 0x04
|
#define PB_LTYPE_BYTES 0x05
|
||||||
|
|
||||||
/* String with pre-allocated buffer.
|
/* String with pre-allocated buffer.
|
||||||
* data_size is the maximum length. */
|
* data_size is the maximum length. */
|
||||||
#define PB_LTYPE_STRING 0x05
|
#define PB_LTYPE_STRING 0x06
|
||||||
|
|
||||||
/* Submessage
|
/* Submessage
|
||||||
* submsg_fields is pointer to field descriptions */
|
* submsg_fields is pointer to field descriptions */
|
||||||
#define PB_LTYPE_SUBMESSAGE 0x06
|
#define PB_LTYPE_SUBMESSAGE 0x07
|
||||||
|
|
||||||
|
/* Extension pseudo-field
|
||||||
|
* The field contains a pointer to pb_extension_t */
|
||||||
|
#define PB_LTYPE_EXTENSION 0x08
|
||||||
|
|
||||||
/* Number of declared LTYPES */
|
/* Number of declared LTYPES */
|
||||||
#define PB_LTYPES_COUNT 7
|
#define PB_LTYPES_COUNT 9
|
||||||
#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_POINTER 0x80
|
||||||
#define PB_ATYPE_CALLBACK 0x40
|
#define PB_ATYPE_CALLBACK 0x40
|
||||||
#define PB_ATYPE_MASK 0xC0
|
#define PB_ATYPE_MASK 0xC0
|
||||||
|
|
||||||
@@ -128,6 +170,20 @@ typedef uint8_t pb_type_t;
|
|||||||
#define PB_HTYPE(x) ((x) & PB_HTYPE_MASK)
|
#define PB_HTYPE(x) ((x) & PB_HTYPE_MASK)
|
||||||
#define PB_LTYPE(x) ((x) & PB_LTYPE_MASK)
|
#define PB_LTYPE(x) ((x) & PB_LTYPE_MASK)
|
||||||
|
|
||||||
|
/* Data type used for storing sizes of struct fields
|
||||||
|
* and array counts.
|
||||||
|
*/
|
||||||
|
#if defined(PB_FIELD_32BIT)
|
||||||
|
typedef uint32_t pb_size_t;
|
||||||
|
typedef int32_t pb_ssize_t;
|
||||||
|
#elif defined(PB_FIELD_16BIT)
|
||||||
|
typedef uint16_t pb_size_t;
|
||||||
|
typedef int16_t pb_ssize_t;
|
||||||
|
#else
|
||||||
|
typedef uint8_t pb_size_t;
|
||||||
|
typedef int8_t pb_ssize_t;
|
||||||
|
#endif
|
||||||
|
|
||||||
/* This structure is used in auto-generated constants
|
/* This structure is used in auto-generated constants
|
||||||
* to specify struct fields.
|
* to specify struct fields.
|
||||||
* You can change field sizes if you need structures
|
* You can change field sizes if you need structures
|
||||||
@@ -139,29 +195,12 @@ typedef uint8_t pb_type_t;
|
|||||||
PB_PACKED_STRUCT_START
|
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 {
|
||||||
|
pb_size_t tag;
|
||||||
#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)
|
|
||||||
uint8_t tag;
|
|
||||||
pb_type_t type;
|
pb_type_t type;
|
||||||
uint8_t data_offset; /* Offset of field data, relative to previous field. */
|
pb_size_t data_offset; /* Offset of field data, relative to previous field. */
|
||||||
int8_t size_offset; /* Offset of array size or has-boolean, relative to data */
|
pb_ssize_t size_offset; /* Offset of array size or has-boolean, relative to data */
|
||||||
uint8_t data_size; /* Data size in bytes for a single item */
|
pb_size_t data_size; /* Data size in bytes for a single item */
|
||||||
uint8_t array_size; /* Maximum number of entries in array */
|
pb_size_t array_size; /* Maximum number of entries in array */
|
||||||
#elif defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)
|
|
||||||
uint16_t tag;
|
|
||||||
pb_type_t type;
|
|
||||||
uint8_t data_offset;
|
|
||||||
int8_t size_offset;
|
|
||||||
uint16_t data_size;
|
|
||||||
uint16_t array_size;
|
|
||||||
#else
|
|
||||||
uint32_t tag;
|
|
||||||
pb_type_t type;
|
|
||||||
uint8_t data_offset;
|
|
||||||
int8_t size_offset;
|
|
||||||
uint32_t data_size;
|
|
||||||
uint32_t array_size;
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Field definitions for submessage
|
/* Field definitions for submessage
|
||||||
* OR default value for all other non-array, non-callback types
|
* OR default value for all other non-array, non-callback types
|
||||||
@@ -170,6 +209,17 @@ struct _pb_field_t {
|
|||||||
} pb_packed;
|
} pb_packed;
|
||||||
PB_PACKED_STRUCT_END
|
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.
|
||||||
* Note that actual structs used will have a different length of bytes array.
|
* Note that actual structs used will have a different length of bytes array.
|
||||||
@@ -178,9 +228,17 @@ struct _pb_bytes_array_t {
|
|||||||
size_t size;
|
size_t size;
|
||||||
uint8_t bytes[1];
|
uint8_t bytes[1];
|
||||||
};
|
};
|
||||||
|
|
||||||
typedef struct _pb_bytes_array_t pb_bytes_array_t;
|
typedef struct _pb_bytes_array_t pb_bytes_array_t;
|
||||||
|
|
||||||
|
/* Same, except for pointer-type fields. There is no need to variable struct
|
||||||
|
* length in this case.
|
||||||
|
*/
|
||||||
|
struct _pb_bytes_ptr_t {
|
||||||
|
size_t size;
|
||||||
|
uint8_t *bytes;
|
||||||
|
};
|
||||||
|
typedef struct _pb_bytes_ptr_t pb_bytes_ptr_t;
|
||||||
|
|
||||||
/* This structure is used for giving the callback function.
|
/* This structure is used for giving the callback function.
|
||||||
* It is stored in the message structure and filled in by the method that
|
* It is stored in the message structure and filled in by the method that
|
||||||
* calls pb_decode.
|
* calls pb_decode.
|
||||||
@@ -229,50 +287,133 @@ 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. */
|
||||||
|
/* Size of a structure member, in bytes. */
|
||||||
#define pb_membersize(st, m) (sizeof ((st*)0)->m)
|
#define pb_membersize(st, m) (sizeof ((st*)0)->m)
|
||||||
|
/* Number of entries in an array. */
|
||||||
#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]))
|
||||||
|
/* Delta from start of one member to the start of another member. */
|
||||||
#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) (int)(offsetof(st, m1) == offsetof(st, m2) \
|
/* Marks the end of the field list */
|
||||||
? offsetof(st, m1) \
|
|
||||||
: 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}
|
||||||
|
|
||||||
|
/* Macros for filling in the data_offset field */
|
||||||
|
/* data_offset for first field in a message */
|
||||||
|
#define PB_DATAOFFSET_FIRST(st, m1, m2) (offsetof(st, m1))
|
||||||
|
/* data_offset for subsequent fields */
|
||||||
|
#define PB_DATAOFFSET_OTHER(st, m1, m2) (offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
|
||||||
|
/* Choose first/other based on m1 == m2 (deprecated, remains for backwards compatibility) */
|
||||||
|
#define PB_DATAOFFSET_CHOOSE(st, m1, m2) (int)(offsetof(st, m1) == offsetof(st, m2) \
|
||||||
|
? PB_DATAOFFSET_FIRST(st, m1, m2) \
|
||||||
|
: PB_DATAOFFSET_OTHER(st, m1, m2))
|
||||||
|
|
||||||
/* Required fields are the simplest. They just have delta (padding) from
|
/* Required fields are the simplest. They just have delta (padding) from
|
||||||
* previous field end, and the size of the field. Pointer is used for
|
* previous field end, and the size of the field. Pointer is used for
|
||||||
* submessages and default values.
|
* submessages and default values.
|
||||||
*/
|
*/
|
||||||
#define PB_REQUIRED_STATIC(tag, st, m, pm, ltype, ptr) \
|
#define PB_REQUIRED_STATIC(tag, st, m, fd, ltype, ptr) \
|
||||||
{tag, PB_ATYPE_STATIC | PB_HTYPE_REQUIRED | ltype, \
|
{tag, PB_ATYPE_STATIC | PB_HTYPE_REQUIRED | ltype, \
|
||||||
pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
|
fd, 0, pb_membersize(st, m), 0, ptr}
|
||||||
|
|
||||||
/* Optional fields add the delta to the has_ variable. */
|
/* Optional fields add the delta to the has_ variable. */
|
||||||
#define PB_OPTIONAL_STATIC(tag, st, m, pm, ltype, ptr) \
|
#define PB_OPTIONAL_STATIC(tag, st, m, fd, ltype, ptr) \
|
||||||
{tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
|
{tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
|
||||||
pb_delta_end(st, m, pm), \
|
fd, \
|
||||||
pb_delta(st, has_ ## m, m), \
|
pb_delta(st, has_ ## m, m), \
|
||||||
pb_membersize(st, m), 0, ptr}
|
pb_membersize(st, m), 0, ptr}
|
||||||
|
|
||||||
/* Repeated fields have a _count field and also the maximum number of entries. */
|
/* Repeated fields have a _count field and also the maximum number of entries. */
|
||||||
#define PB_REPEATED_STATIC(tag, st, m, pm, ltype, ptr) \
|
#define PB_REPEATED_STATIC(tag, st, m, fd, ltype, ptr) \
|
||||||
{tag, PB_ATYPE_STATIC | PB_HTYPE_REPEATED | ltype, \
|
{tag, PB_ATYPE_STATIC | PB_HTYPE_REPEATED | ltype, \
|
||||||
pb_delta_end(st, m, pm), \
|
fd, \
|
||||||
pb_delta(st, m ## _count, m), \
|
pb_delta(st, m ## _count, m), \
|
||||||
pb_membersize(st, m[0]), \
|
pb_membersize(st, m[0]), \
|
||||||
pb_arraysize(st, m), ptr}
|
pb_arraysize(st, m), ptr}
|
||||||
|
|
||||||
/* Callbacks are much like required fields except with special datatype. */
|
/* Allocated fields carry the size of the actual data, not the pointer */
|
||||||
#define PB_REQUIRED_CALLBACK(tag, st, m, pm, ltype, ptr) \
|
#define PB_REQUIRED_POINTER(tag, st, m, fd, ltype, ptr) \
|
||||||
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_REQUIRED | ltype, \
|
{tag, PB_ATYPE_POINTER | PB_HTYPE_REQUIRED | ltype, \
|
||||||
pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
|
fd, 0, pb_membersize(st, m[0]), 0, ptr}
|
||||||
|
|
||||||
#define PB_OPTIONAL_CALLBACK(tag, st, m, pm, ltype, ptr) \
|
/* Optional fields don't need a has_ variable, as information would be redundant */
|
||||||
|
#define PB_OPTIONAL_POINTER(tag, st, m, fd, ltype, ptr) \
|
||||||
|
{tag, PB_ATYPE_POINTER | PB_HTYPE_OPTIONAL | ltype, \
|
||||||
|
fd, 0, pb_membersize(st, m[0]), 0, ptr}
|
||||||
|
|
||||||
|
/* Repeated fields have a _count field and a pointer to array of pointers */
|
||||||
|
#define PB_REPEATED_POINTER(tag, st, m, fd, ltype, ptr) \
|
||||||
|
{tag, PB_ATYPE_POINTER | PB_HTYPE_REPEATED | ltype, \
|
||||||
|
fd, pb_delta(st, m ## _count, m), \
|
||||||
|
pb_membersize(st, m[0]), 0, ptr}
|
||||||
|
|
||||||
|
/* Callbacks are much like required fields except with special datatype. */
|
||||||
|
#define PB_REQUIRED_CALLBACK(tag, st, m, fd, ltype, ptr) \
|
||||||
|
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_REQUIRED | ltype, \
|
||||||
|
fd, 0, pb_membersize(st, m), 0, ptr}
|
||||||
|
|
||||||
|
#define PB_OPTIONAL_CALLBACK(tag, st, m, fd, ltype, ptr) \
|
||||||
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
|
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
|
||||||
pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
|
fd, 0, pb_membersize(st, m), 0, ptr}
|
||||||
|
|
||||||
#define PB_REPEATED_CALLBACK(tag, st, m, pm, ltype, ptr) \
|
#define PB_REPEATED_CALLBACK(tag, st, m, fd, ltype, ptr) \
|
||||||
{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}
|
fd, 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, fd, 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, fd, 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
|
||||||
@@ -290,15 +431,16 @@ typedef enum {
|
|||||||
#define PB_LTYPE_MAP_SINT32 PB_LTYPE_SVARINT
|
#define PB_LTYPE_MAP_SINT32 PB_LTYPE_SVARINT
|
||||||
#define PB_LTYPE_MAP_SINT64 PB_LTYPE_SVARINT
|
#define PB_LTYPE_MAP_SINT64 PB_LTYPE_SVARINT
|
||||||
#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_UVARINT
|
||||||
#define PB_LTYPE_MAP_UINT64 PB_LTYPE_VARINT
|
#define PB_LTYPE_MAP_UINT64 PB_LTYPE_UVARINT
|
||||||
|
#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
|
||||||
@@ -308,8 +450,22 @@ typedef enum {
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
#define PB_FIELD(tag, type, rules, allocation, message, field, prevfield, ptr) \
|
#define PB_FIELD(tag, type, rules, allocation, message, field, prevfield, ptr) \
|
||||||
PB_ ## rules ## _ ## allocation(tag, message, field, prevfield, \
|
PB_ ## rules ## _ ## allocation(tag, message, field, \
|
||||||
PB_LTYPE_MAP_ ## type, ptr)
|
PB_DATAOFFSET_CHOOSE(message, field, prevfield), \
|
||||||
|
PB_LTYPE_MAP_ ## type, ptr)
|
||||||
|
|
||||||
|
/* This is a new version of the macro used by nanopb generator from
|
||||||
|
* version 0.2.3 onwards. It avoids the use of a ternary expression in
|
||||||
|
* the initialization, which confused some compilers.
|
||||||
|
*
|
||||||
|
* - Placement: FIRST or OTHER, depending on if this is the first field in structure.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
#define PB_FIELD2(tag, type, rules, allocation, placement, message, field, prevfield, ptr) \
|
||||||
|
PB_ ## rules ## _ ## allocation(tag, message, field, \
|
||||||
|
PB_DATAOFFSET_ ## placement(message, field, prevfield), \
|
||||||
|
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
|
||||||
|
|||||||
238
pb_decode.c
238
pb_decode.c
@@ -3,11 +3,13 @@
|
|||||||
* 2011 Petteri Aimonen <jpa@kapsi.fi>
|
* 2011 Petteri Aimonen <jpa@kapsi.fi>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* The warn_unused_result attribute appeared first in gcc-3.4.0 */
|
/* Use the GCC warn_unused_result attribute to check that all return values
|
||||||
|
* are propagated correctly. On other compilers and gcc before 3.4.0 just
|
||||||
|
* ignore the annotation.
|
||||||
|
*/
|
||||||
#if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
|
#if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
|
||||||
#define checkreturn
|
#define checkreturn
|
||||||
#else
|
#else
|
||||||
/* Verify that we remember to check all return values for proper error propagation */
|
|
||||||
#define checkreturn __attribute__((warn_unused_result))
|
#define checkreturn __attribute__((warn_unused_result))
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
@@ -15,25 +17,66 @@
|
|||||||
#include "pb.h"
|
#include "pb.h"
|
||||||
#include "pb_decode.h"
|
#include "pb_decode.h"
|
||||||
|
|
||||||
|
/**************************************
|
||||||
|
* Declarations internal to this file *
|
||||||
|
**************************************/
|
||||||
|
|
||||||
|
/* Iterator for pb_field_t list */
|
||||||
|
typedef struct {
|
||||||
|
const pb_field_t *start; /* Start of the pb_field_t array */
|
||||||
|
const pb_field_t *pos; /* Current position of the iterator */
|
||||||
|
unsigned field_index; /* Zero-based index of the field. */
|
||||||
|
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 *pData; /* Pointer where to store current field value */
|
||||||
|
void *pSize; /* Pointer where to store the size of current array field */
|
||||||
|
} pb_field_iterator_t;
|
||||||
|
|
||||||
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;
|
||||||
|
|
||||||
|
static bool checkreturn buf_read(pb_istream_t *stream, uint8_t *buf, size_t count);
|
||||||
|
static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest);
|
||||||
|
static bool checkreturn read_raw_value(pb_istream_t *stream, pb_wire_type_t wire_type, uint8_t *buf, size_t *size);
|
||||||
|
static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct);
|
||||||
|
static bool pb_field_next(pb_field_iterator_t *iter);
|
||||||
|
static bool checkreturn pb_field_find(pb_field_iterator_t *iter, uint32_t tag);
|
||||||
|
static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter);
|
||||||
|
static bool checkreturn decode_callback_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);
|
||||||
|
static bool checkreturn default_extension_decoder(pb_istream_t *stream, pb_extension_t *extension, uint32_t tag, pb_wire_type_t wire_type);
|
||||||
|
static bool checkreturn decode_extension(pb_istream_t *stream, uint32_t tag, pb_wire_type_t wire_type, pb_field_iterator_t *iter);
|
||||||
|
static bool checkreturn find_extension_field(pb_field_iterator_t *iter);
|
||||||
|
static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct);
|
||||||
|
static bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
||||||
|
static bool checkreturn pb_dec_uvarint(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
||||||
|
static bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
||||||
|
static bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
||||||
|
static bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
||||||
|
static bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
||||||
|
static bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
||||||
|
static bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
||||||
|
static bool checkreturn pb_skip_varint(pb_istream_t *stream);
|
||||||
|
static bool checkreturn pb_skip_string(pb_istream_t *stream);
|
||||||
|
|
||||||
/* --- Function pointers to field decoders ---
|
/* --- Function pointers to field decoders ---
|
||||||
* Order in the array must match pb_action_t LTYPE numbering.
|
* Order in the array must match pb_action_t LTYPE numbering.
|
||||||
*/
|
*/
|
||||||
static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
|
static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
|
||||||
&pb_dec_varint,
|
&pb_dec_varint,
|
||||||
|
&pb_dec_uvarint,
|
||||||
&pb_dec_svarint,
|
&pb_dec_svarint,
|
||||||
&pb_dec_fixed32,
|
&pb_dec_fixed32,
|
||||||
&pb_dec_fixed64,
|
&pb_dec_fixed64,
|
||||||
|
|
||||||
&pb_dec_bytes,
|
&pb_dec_bytes,
|
||||||
&pb_dec_string,
|
&pb_dec_string,
|
||||||
&pb_dec_submessage
|
&pb_dec_submessage,
|
||||||
|
NULL /* extensions */
|
||||||
};
|
};
|
||||||
|
|
||||||
/**************
|
/*******************************
|
||||||
* pb_istream *
|
* pb_istream_t implementation *
|
||||||
**************/
|
*******************************/
|
||||||
|
|
||||||
static bool checkreturn buf_read(pb_istream_t *stream, uint8_t *buf, size_t count)
|
static bool checkreturn buf_read(pb_istream_t *stream, uint8_t *buf, size_t count)
|
||||||
{
|
{
|
||||||
@@ -83,6 +126,26 @@ bool checkreturn pb_read(pb_istream_t *stream, uint8_t *buf, size_t count)
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Read a single byte from input stream. buf may not be NULL.
|
||||||
|
* This is an optimization for the varint decoding. */
|
||||||
|
static bool checkreturn pb_readbyte(pb_istream_t *stream, uint8_t *buf)
|
||||||
|
{
|
||||||
|
if (!stream->bytes_left)
|
||||||
|
PB_RETURN_ERROR(stream, "end-of-stream");
|
||||||
|
|
||||||
|
#ifndef PB_BUFFER_ONLY
|
||||||
|
if (!stream->callback(stream, buf, 1))
|
||||||
|
PB_RETURN_ERROR(stream, "io error");
|
||||||
|
#else
|
||||||
|
*buf = *(uint8_t*)stream->state;
|
||||||
|
stream->state = (uint8_t*)stream->state + 1;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
stream->bytes_left--;
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize)
|
pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize)
|
||||||
{
|
{
|
||||||
pb_istream_t stream;
|
pb_istream_t stream;
|
||||||
@@ -108,7 +171,7 @@ static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest)
|
|||||||
uint8_t byte;
|
uint8_t byte;
|
||||||
uint32_t result;
|
uint32_t result;
|
||||||
|
|
||||||
if (!pb_read(stream, &byte, 1))
|
if (!pb_readbyte(stream, &byte))
|
||||||
return false;
|
return false;
|
||||||
|
|
||||||
if (!(byte & 0x80))
|
if (!(byte & 0x80))
|
||||||
@@ -127,7 +190,7 @@ static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest)
|
|||||||
if (bitpos >= 32)
|
if (bitpos >= 32)
|
||||||
PB_RETURN_ERROR(stream, "varint overflow");
|
PB_RETURN_ERROR(stream, "varint overflow");
|
||||||
|
|
||||||
if (!pb_read(stream, &byte, 1))
|
if (!pb_readbyte(stream, &byte))
|
||||||
return false;
|
return false;
|
||||||
|
|
||||||
result |= (uint32_t)(byte & 0x7F) << bitpos;
|
result |= (uint32_t)(byte & 0x7F) << bitpos;
|
||||||
@@ -150,7 +213,7 @@ bool checkreturn pb_decode_varint(pb_istream_t *stream, uint64_t *dest)
|
|||||||
if (bitpos >= 64)
|
if (bitpos >= 64)
|
||||||
PB_RETURN_ERROR(stream, "varint overflow");
|
PB_RETURN_ERROR(stream, "varint overflow");
|
||||||
|
|
||||||
if (!pb_read(stream, &byte, 1))
|
if (!pb_readbyte(stream, &byte))
|
||||||
return false;
|
return false;
|
||||||
|
|
||||||
result |= (uint64_t)(byte & 0x7F) << bitpos;
|
result |= (uint64_t)(byte & 0x7F) << bitpos;
|
||||||
@@ -276,17 +339,6 @@ void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream)
|
|||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Iterator for pb_field_t list */
|
|
||||||
typedef struct {
|
|
||||||
const pb_field_t *start; /* Start of the pb_field_t array */
|
|
||||||
const pb_field_t *pos; /* Current position of the iterator */
|
|
||||||
unsigned field_index; /* Zero-based index of the field. */
|
|
||||||
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 *pData; /* Pointer where to store current field value */
|
|
||||||
void *pSize; /* Pointer where to store the size of current array field */
|
|
||||||
} pb_field_iterator_t;
|
|
||||||
|
|
||||||
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->pos = fields;
|
iter->start = iter->pos = fields;
|
||||||
@@ -308,12 +360,12 @@ static bool pb_field_next(pb_field_iterator_t *iter)
|
|||||||
prev_size *= iter->pos->array_size;
|
prev_size *= iter->pos->array_size;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (PB_HTYPE(iter->pos->type) == PB_HTYPE_REQUIRED)
|
|
||||||
iter->required_field_index++;
|
|
||||||
|
|
||||||
if (iter->pos->tag == 0)
|
if (iter->pos->tag == 0)
|
||||||
return false; /* Only happens with empty message types */
|
return false; /* Only happens with empty message types */
|
||||||
|
|
||||||
|
if (PB_HTYPE(iter->pos->type) == PB_HTYPE_REQUIRED)
|
||||||
|
iter->required_field_index++;
|
||||||
|
|
||||||
iter->pos++;
|
iter->pos++;
|
||||||
iter->field_index++;
|
iter->field_index++;
|
||||||
if (iter->pos->tag == 0)
|
if (iter->pos->tag == 0)
|
||||||
@@ -336,8 +388,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->pos->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);
|
||||||
|
|
||||||
@@ -430,11 +485,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->pos, 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;
|
||||||
@@ -472,6 +527,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_decoder(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_decoder(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)
|
||||||
{
|
{
|
||||||
@@ -528,6 +647,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);
|
||||||
@@ -548,6 +668,29 @@ 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;
|
||||||
@@ -603,6 +746,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)
|
||||||
@@ -664,24 +820,42 @@ 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)
|
||||||
|
{
|
||||||
|
case 1: *(int8_t*)dest = (int8_t)value; break;
|
||||||
|
case 2: *(int16_t*)dest = (int16_t)value; break;
|
||||||
|
case 4: *(int32_t*)dest = (int32_t)value; break;
|
||||||
|
case 8: *(int64_t*)dest = (int64_t)value; break;
|
||||||
|
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool checkreturn pb_dec_uvarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
|
||||||
|
{
|
||||||
|
uint64_t value;
|
||||||
|
if (!pb_decode_varint(stream, &value))
|
||||||
|
return false;
|
||||||
|
|
||||||
switch (field->data_size)
|
switch (field->data_size)
|
||||||
{
|
{
|
||||||
case 1: *(uint8_t*)dest = (uint8_t)value; break;
|
|
||||||
case 2: *(uint16_t*)dest = (uint16_t)value; break;
|
|
||||||
case 4: *(uint32_t*)dest = (uint32_t)value; break;
|
case 4: *(uint32_t*)dest = (uint32_t)value; break;
|
||||||
case 8: *(uint64_t*)dest = value; break;
|
case 8: *(uint64_t*)dest = value; break;
|
||||||
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)
|
||||||
{
|
{
|
||||||
@@ -690,7 +864,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)
|
||||||
|
|||||||
102
pb_decode.h
102
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.
|
||||||
*
|
*
|
||||||
* Rules for callback:
|
* The callback must conform to these rules:
|
||||||
|
*
|
||||||
* 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,25 +131,6 @@ 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.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifdef NANOPB_INTERNALS
|
|
||||||
bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
|
||||||
bool pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
|
||||||
bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
|
||||||
bool pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
|
||||||
|
|
||||||
bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
|
||||||
bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
|
||||||
bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
|
||||||
|
|
||||||
bool pb_skip_varint(pb_istream_t *stream);
|
|
||||||
bool pb_skip_string(pb_istream_t *stream);
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
} /* extern "C" */
|
} /* extern "C" */
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
250
pb_encode.c
250
pb_encode.c
@@ -7,31 +7,54 @@
|
|||||||
#include "pb.h"
|
#include "pb.h"
|
||||||
#include "pb_encode.h"
|
#include "pb_encode.h"
|
||||||
|
|
||||||
/* The warn_unused_result attribute appeared first in gcc-3.4.0 */
|
/* Use the GCC warn_unused_result attribute to check that all return values
|
||||||
|
* are propagated correctly. On other compilers and gcc before 3.4.0 just
|
||||||
|
* ignore the annotation.
|
||||||
|
*/
|
||||||
#if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
|
#if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
|
||||||
#define checkreturn
|
#define checkreturn
|
||||||
#else
|
#else
|
||||||
/* Verify that we remember to check all return values for proper error propagation */
|
|
||||||
#define checkreturn __attribute__((warn_unused_result))
|
#define checkreturn __attribute__((warn_unused_result))
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/**************************************
|
||||||
|
* Declarations internal to this file *
|
||||||
|
**************************************/
|
||||||
typedef bool (*pb_encoder_t)(pb_ostream_t *stream, const pb_field_t *field, const void *src) checkreturn;
|
typedef bool (*pb_encoder_t)(pb_ostream_t *stream, const pb_field_t *field, const void *src) checkreturn;
|
||||||
|
|
||||||
|
static bool checkreturn buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
|
||||||
|
static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field, const void *pData, size_t count, pb_encoder_t func);
|
||||||
|
static bool checkreturn encode_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData);
|
||||||
|
static bool checkreturn default_extension_encoder(pb_ostream_t *stream, const pb_extension_t *extension);
|
||||||
|
static bool checkreturn encode_extension_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData);
|
||||||
|
static bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
||||||
|
static bool checkreturn pb_enc_uvarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
||||||
|
static bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
||||||
|
static bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
||||||
|
static bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
||||||
|
static bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
||||||
|
static bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
||||||
|
static bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
||||||
|
|
||||||
/* --- Function pointers to field encoders ---
|
/* --- Function pointers to field encoders ---
|
||||||
* Order in the array must match pb_action_t LTYPE numbering.
|
* Order in the array must match pb_action_t LTYPE numbering.
|
||||||
*/
|
*/
|
||||||
static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
|
static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
|
||||||
&pb_enc_varint,
|
&pb_enc_varint,
|
||||||
|
&pb_enc_uvarint,
|
||||||
&pb_enc_svarint,
|
&pb_enc_svarint,
|
||||||
&pb_enc_fixed32,
|
&pb_enc_fixed32,
|
||||||
&pb_enc_fixed64,
|
&pb_enc_fixed64,
|
||||||
|
|
||||||
&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 *
|
||||||
|
*******************************/
|
||||||
|
|
||||||
static bool checkreturn buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
|
static bool checkreturn buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
|
||||||
{
|
{
|
||||||
@@ -48,7 +71,7 @@ pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize)
|
|||||||
{
|
{
|
||||||
pb_ostream_t stream;
|
pb_ostream_t stream;
|
||||||
#ifdef PB_BUFFER_ONLY
|
#ifdef PB_BUFFER_ONLY
|
||||||
stream.callback = (void*)1; /* Just some marker value */
|
stream.callback = (void*)1; /* Just a marker value */
|
||||||
#else
|
#else
|
||||||
stream.callback = &buf_write;
|
stream.callback = &buf_write;
|
||||||
#endif
|
#endif
|
||||||
@@ -81,12 +104,11 @@ bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Main encoding stuff */
|
/*************************
|
||||||
|
* Encode a single field *
|
||||||
|
*************************/
|
||||||
|
|
||||||
/* 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)
|
||||||
{
|
{
|
||||||
@@ -96,7 +118,11 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
|
|||||||
|
|
||||||
if (count == 0)
|
if (count == 0)
|
||||||
return true;
|
return true;
|
||||||
|
|
||||||
|
if (PB_ATYPE(field->type) != PB_ATYPE_POINTER && count > field->array_size)
|
||||||
|
PB_RETURN_ERROR(stream, "array max size exceeded");
|
||||||
|
|
||||||
|
/* 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))
|
||||||
@@ -112,7 +138,7 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
|
|||||||
size = 8 * count;
|
size = 8 * count;
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
pb_ostream_t sizestream = PB_OSTREAM_SIZING;
|
pb_ostream_t sizestream = PB_OSTREAM_SIZING;
|
||||||
p = pData;
|
p = pData;
|
||||||
for (i = 0; i < count; i++)
|
for (i = 0; i < count; i++)
|
||||||
@@ -146,8 +172,22 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
|
|||||||
{
|
{
|
||||||
if (!pb_encode_tag_for_field(stream, field))
|
if (!pb_encode_tag_for_field(stream, field))
|
||||||
return false;
|
return false;
|
||||||
if (!func(stream, field, p))
|
|
||||||
return false;
|
/* Normally the data is stored directly in the array entries, but
|
||||||
|
* for pointer-type string fields, the array entries are actually
|
||||||
|
* string pointers. So we have to dereference once more to get to
|
||||||
|
* the character data. */
|
||||||
|
if (PB_ATYPE(field->type) == PB_ATYPE_POINTER &&
|
||||||
|
PB_LTYPE(field->type) == PB_LTYPE_STRING)
|
||||||
|
{
|
||||||
|
if (!func(stream, field, *(const void* const*)p))
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
if (!func(stream, field, p))
|
||||||
|
return false;
|
||||||
|
}
|
||||||
p = (const char*)p + field->data_size;
|
p = (const char*)p + field->data_size;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -155,17 +195,38 @@ 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 or pointer allocation, i.e. one whose data
|
||||||
|
* is available to the encoder directly. */
|
||||||
|
static bool checkreturn encode_basic_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 implicit_has = 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 = &implicit_has;
|
||||||
|
|
||||||
|
if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
|
||||||
|
{
|
||||||
|
/* pData is a pointer to the field, which contains pointer to
|
||||||
|
* the data. If the 2nd pointer is NULL, it is interpreted as if
|
||||||
|
* the has_field was false.
|
||||||
|
*/
|
||||||
|
|
||||||
|
pData = *(const void* const*)pData;
|
||||||
|
implicit_has = (pData != NULL);
|
||||||
|
}
|
||||||
|
|
||||||
switch (PB_HTYPE(field->type))
|
switch (PB_HTYPE(field->type))
|
||||||
{
|
{
|
||||||
case PB_HTYPE_REQUIRED:
|
case PB_HTYPE_REQUIRED:
|
||||||
|
if (!pData)
|
||||||
|
PB_RETURN_ERROR(stream, "missing required field");
|
||||||
if (!pb_encode_tag_for_field(stream, field))
|
if (!pb_encode_tag_for_field(stream, field))
|
||||||
return false;
|
return false;
|
||||||
if (!func(stream, field, pData))
|
if (!func(stream, field, pData))
|
||||||
@@ -195,7 +256,10 @@ bool checkreturn encode_static_field(pb_ostream_t *stream, const pb_field_t *fie
|
|||||||
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;
|
||||||
|
|
||||||
@@ -213,6 +277,62 @@ bool checkreturn encode_callback_field(pb_ostream_t *stream, const pb_field_t *f
|
|||||||
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:
|
||||||
|
case PB_ATYPE_POINTER:
|
||||||
|
return encode_basic_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_encoder(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_encoder(stream, extension);
|
||||||
|
|
||||||
|
if (!status)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
extension = extension->next;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*********************
|
||||||
|
* Encode all fields *
|
||||||
|
*********************/
|
||||||
|
|
||||||
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,7 +342,10 @@ bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], cons
|
|||||||
while (field->tag != 0)
|
while (field->tag != 0)
|
||||||
{
|
{
|
||||||
pData = (const char*)pData + prev_size + field->data_offset;
|
pData = (const char*)pData + prev_size + field->data_offset;
|
||||||
prev_size = field->data_size;
|
if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
|
||||||
|
prev_size = sizeof(const void*);
|
||||||
|
else
|
||||||
|
prev_size = field->data_size;
|
||||||
|
|
||||||
/* Special case for static arrays */
|
/* Special case for static arrays */
|
||||||
if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
|
if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
|
||||||
@@ -230,21 +353,18 @@ 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;
|
return false;
|
||||||
|
|
||||||
default:
|
|
||||||
PB_RETURN_ERROR(stream, "invalid field type");
|
|
||||||
}
|
}
|
||||||
|
|
||||||
field++;
|
field++;
|
||||||
@@ -253,7 +373,14 @@ bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], cons
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Helper functions */
|
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 *
|
||||||
|
********************/
|
||||||
bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
|
bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
|
||||||
{
|
{
|
||||||
uint8_t buffer[10];
|
uint8_t buffer[10];
|
||||||
@@ -330,6 +457,7 @@ bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t
|
|||||||
switch (PB_LTYPE(field->type))
|
switch (PB_LTYPE(field->type))
|
||||||
{
|
{
|
||||||
case PB_LTYPE_VARINT:
|
case PB_LTYPE_VARINT:
|
||||||
|
case PB_LTYPE_UVARINT:
|
||||||
case PB_LTYPE_SVARINT:
|
case PB_LTYPE_SVARINT:
|
||||||
wiretype = PB_WT_VARINT;
|
wiretype = PB_WT_VARINT;
|
||||||
break;
|
break;
|
||||||
@@ -371,7 +499,12 @@ bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fie
|
|||||||
bool status;
|
bool status;
|
||||||
|
|
||||||
if (!pb_encode(&substream, fields, src_struct))
|
if (!pb_encode(&substream, fields, src_struct))
|
||||||
|
{
|
||||||
|
#ifndef PB_NO_ERRMSG
|
||||||
|
stream->errmsg = substream.errmsg;
|
||||||
|
#endif
|
||||||
return false;
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
size = substream.bytes_written;
|
size = substream.bytes_written;
|
||||||
|
|
||||||
@@ -411,13 +544,29 @@ bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fie
|
|||||||
/* Field encoders */
|
/* Field encoders */
|
||||||
|
|
||||||
bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
|
bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
|
||||||
|
{
|
||||||
|
int64_t value = 0;
|
||||||
|
|
||||||
|
/* Cases 1 and 2 are for compilers that have smaller types for bool
|
||||||
|
* or enums. */
|
||||||
|
switch (field->data_size)
|
||||||
|
{
|
||||||
|
case 1: value = *(const int8_t*)src; break;
|
||||||
|
case 2: value = *(const int16_t*)src; break;
|
||||||
|
case 4: value = *(const int32_t*)src; break;
|
||||||
|
case 8: value = *(const int64_t*)src; break;
|
||||||
|
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
||||||
|
}
|
||||||
|
|
||||||
|
return pb_encode_varint(stream, (uint64_t)value);
|
||||||
|
}
|
||||||
|
|
||||||
|
bool checkreturn pb_enc_uvarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
|
||||||
{
|
{
|
||||||
uint64_t value = 0;
|
uint64_t value = 0;
|
||||||
|
|
||||||
switch (field->data_size)
|
switch (field->data_size)
|
||||||
{
|
{
|
||||||
case 1: value = *(const uint8_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: PB_RETURN_ERROR(stream, "invalid data_size");
|
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
||||||
@@ -454,15 +603,38 @@ bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, c
|
|||||||
|
|
||||||
bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
|
bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
|
||||||
{
|
{
|
||||||
const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)src;
|
if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
|
||||||
UNUSED(field);
|
{
|
||||||
return pb_encode_string(stream, bytes->bytes, bytes->size);
|
const pb_bytes_ptr_t *bytes = (const pb_bytes_ptr_t*)src;
|
||||||
|
return pb_encode_string(stream, bytes->bytes, bytes->size);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)src;
|
||||||
|
if (bytes->size + offsetof(pb_bytes_array_t, bytes) > field->data_size)
|
||||||
|
PB_RETURN_ERROR(stream, "bytes size exceeded");
|
||||||
|
|
||||||
|
return pb_encode_string(stream, bytes->bytes, bytes->size);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
|
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 loop */
|
||||||
return pb_encode_string(stream, (const uint8_t*)src, strlen((const char*)src));
|
size_t size = 0;
|
||||||
|
size_t max_size = field->data_size;
|
||||||
|
const char *p = (const char*)src;
|
||||||
|
|
||||||
|
if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
|
||||||
|
max_size = (size_t)-1;
|
||||||
|
|
||||||
|
while (size < max_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)
|
||||||
|
|||||||
131
pb_encode.h
131
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
|
*
|
||||||
* count the number of bytes that would have been written. In this case
|
* The callback must conform to these rules:
|
||||||
* 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,42 +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
|
#ifndef PB_NO_ERRMSG
|
||||||
const char *errmsg;
|
const char *errmsg;
|
||||||
#endif
|
#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 *
|
||||||
|
***************************/
|
||||||
|
|
||||||
/* Stream type for use in computing message sizes */
|
/* Encode a single protocol buffers message from C structure into a stream.
|
||||||
|
* Returns true on success, false on any failure.
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* 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);
|
||||||
|
|
||||||
|
/* Same as pb_encode, but prepends the length of the message as a varint.
|
||||||
|
* 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);
|
||||||
|
|
||||||
|
/**************************************
|
||||||
|
* 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
|
#ifndef PB_NO_ERRMSG
|
||||||
#define PB_OSTREAM_SIZING {0,0,0,0,0}
|
#define PB_OSTREAM_SIZING {0,0,0,0,0}
|
||||||
#else
|
#else
|
||||||
#define PB_OSTREAM_SIZING {0,0,0,0}
|
#define PB_OSTREAM_SIZING {0,0,0,0}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* Encode struct to given output stream.
|
/* Function to write into a pb_ostream_t stream. You can use this if you need
|
||||||
* Returns true on success, false on any failure.
|
* to append or prepend some custom headers to the message.
|
||||||
* 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.
|
|
||||||
*/
|
*/
|
||||||
bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
|
bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
|
||||||
|
|
||||||
/* --- Helper functions ---
|
|
||||||
* You may want to use these from your caller or callbacks.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/* Encode field header based on LTYPE and field number defined in the field structure.
|
/************************************************
|
||||||
* Call this from the callback before writing out field contents. */
|
* 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.
|
||||||
@@ -101,29 +137,12 @@ 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.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifdef NANOPB_INTERNALS
|
|
||||||
bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
|
||||||
bool pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
|
||||||
bool pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
|
||||||
bool pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
|
||||||
bool pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
|
||||||
bool pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* This function is not recommended for new programs. Use pb_encode_submessage()
|
|
||||||
* instead, it has the same functionality with a less confusing interface. */
|
|
||||||
bool pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src);
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
} /* extern "C" */
|
} /* extern "C" */
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
139
tests/Makefile
139
tests/Makefile
@@ -1,139 +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 -fstack-protector-all
|
|
||||||
LDFLAGS+=--coverage
|
|
||||||
endif
|
|
||||||
ifneq (,$(findstring clang,$(CC_VERSION)))
|
|
||||||
CFLAGS_CORE=-pedantic -Wextra -Wcast-qual -Wconversion
|
|
||||||
endif
|
|
||||||
|
|
||||||
# Also use mudflap if it is available
|
|
||||||
# To enable, run with make -B USE_MUDFLAP=y
|
|
||||||
USE_MUDFLAP ?= n
|
|
||||||
ifeq ($(USE_MUDFLAP),y)
|
|
||||||
CFLAGS += -fmudflap
|
|
||||||
LDFLAGS += -lmudflap -fmudflap
|
|
||||||
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_decode3
|
|
||||||
bash -c 'ulimit -c unlimited; I=1; while true; do cat /dev/urandom | ./test_decode3 > /dev/null; I=$$(($$I+1)); echo -en "\r$$I"; done'
|
|
||||||
|
|||||||
133
tests/SConstruct
Normal file
133
tests/SConstruct
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
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, tools = ['default', 'nanopb'])
|
||||||
|
|
||||||
|
# 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'):
|
||||||
|
def check_ccflags(context, flags):
|
||||||
|
'''Check if given CCFLAGS are supported'''
|
||||||
|
context.Message('Checking support for CCFLAGS="%s"... ' % flags)
|
||||||
|
oldflags = context.env['CCFLAGS']
|
||||||
|
context.env.Append(CCFLAGS = flags)
|
||||||
|
result = context.TryCompile("int main() {return 0;}", '.c')
|
||||||
|
context.env.Replace(CCFLAGS = oldflags)
|
||||||
|
context.Result(result)
|
||||||
|
return result
|
||||||
|
|
||||||
|
conf = Configure(env, custom_tests = {'CheckCCFLAGS': check_ccflags})
|
||||||
|
|
||||||
|
# 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 = "#../extra")
|
||||||
|
|
||||||
|
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')
|
||||||
|
|
||||||
|
# Check if we can use extra strict warning flags (only with GCC)
|
||||||
|
extra = '-Wcast-qual -Wlogical-op -Wconversion'
|
||||||
|
extra += ' -Wmissing-prototypes -Wmissing-declarations -Wredundant-decls'
|
||||||
|
extra += ' -Wstack-protector '
|
||||||
|
if 'gcc' in env['CC']:
|
||||||
|
if conf.CheckCCFLAGS(extra):
|
||||||
|
conf.env.Append(CORECFLAGS = extra)
|
||||||
|
|
||||||
|
# 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(CORECFLAGS = '-Wextra')
|
||||||
|
env.Append(LINKFLAGS = '--coverage')
|
||||||
|
|
||||||
|
# We currently need uint64_t anyway, even though ANSI C90 otherwise..
|
||||||
|
env.Append(CFLAGS = '-Wno-long-long')
|
||||||
|
elif 'clang' in env['CC']:
|
||||||
|
# CLang
|
||||||
|
env.Append(CFLAGS = '-ansi -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
|
||||||
|
import os.path
|
||||||
|
env['VARIANT_DIR'] = 'build'
|
||||||
|
env['BUILD'] = '#' + env['VARIANT_DIR']
|
||||||
|
env['COMMON'] = '#' + env['VARIANT_DIR'] + '/common'
|
||||||
|
for subdir in Glob('*/SConscript'):
|
||||||
|
SConscript(subdir, exports = 'env', variant_dir = env['VARIANT_DIR'] + '/' + os.path.dirname(str(subdir)))
|
||||||
|
|
||||||
35
tests/alltypes/SConscript
Normal file
35
tests/alltypes/SConscript
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
# 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", "alltypes.options"])
|
||||||
|
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"])
|
||||||
|
|
||||||
|
# Test the round-trip from nanopb encoder to nanopb decoder
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest([dec, "encode_alltypes.output"])
|
||||||
|
|
||||||
|
# Re-encode the data using protoc, and check that the results from nanopb
|
||||||
|
# match byte-per-byte to the protoc output.
|
||||||
|
env.Decode("encode_alltypes.output.decoded",
|
||||||
|
["encode_alltypes.output", "alltypes.proto"],
|
||||||
|
MESSAGE='AllTypes')
|
||||||
|
env.Encode("encode_alltypes.output.recoded",
|
||||||
|
["encode_alltypes.output.decoded", "alltypes.proto"],
|
||||||
|
MESSAGE='AllTypes')
|
||||||
|
env.Compare(["encode_alltypes.output", "encode_alltypes.output.recoded"])
|
||||||
|
|
||||||
|
# Do the same checks with the optional fields present.
|
||||||
|
env.RunTest("optionals.output", enc, ARGS = ['1'])
|
||||||
|
env.RunTest("optionals.decout", [dec, "optionals.output"], ARGS = ['1'])
|
||||||
|
env.Decode("optionals.output.decoded",
|
||||||
|
["optionals.output", "alltypes.proto"],
|
||||||
|
MESSAGE='AllTypes')
|
||||||
|
env.Encode("optionals.output.recoded",
|
||||||
|
["optionals.output.decoded", "alltypes.proto"],
|
||||||
|
MESSAGE='AllTypes')
|
||||||
|
env.Compare(["optionals.output", "optionals.output.recoded"])
|
||||||
|
|
||||||
|
|
||||||
@@ -8,6 +8,24 @@ message EmptyMessage {
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
enum HugeEnum {
|
||||||
|
Negative = -2147483647; /* protoc doesn't accept -2147483648 here */
|
||||||
|
Positive = 2147483647;
|
||||||
|
}
|
||||||
|
|
||||||
|
message Limits {
|
||||||
|
required int32 int32_min = 1;
|
||||||
|
required int32 int32_max = 2;
|
||||||
|
required uint32 uint32_min = 3;
|
||||||
|
required uint32 uint32_max = 4;
|
||||||
|
required int64 int64_min = 5;
|
||||||
|
required int64 int64_max = 6;
|
||||||
|
required uint64 uint64_min = 7;
|
||||||
|
required uint64 uint64_max = 8;
|
||||||
|
required HugeEnum enum_min = 9;
|
||||||
|
required HugeEnum enum_max = 10;
|
||||||
|
}
|
||||||
|
|
||||||
enum MyEnum {
|
enum MyEnum {
|
||||||
Zero = 0;
|
Zero = 0;
|
||||||
First = 1;
|
First = 1;
|
||||||
@@ -39,26 +57,26 @@ message AllTypes {
|
|||||||
required EmptyMessage req_emptymsg = 18;
|
required EmptyMessage req_emptymsg = 18;
|
||||||
|
|
||||||
|
|
||||||
repeated int32 rep_int32 = 21;
|
repeated int32 rep_int32 = 21 [packed = true];
|
||||||
repeated int64 rep_int64 = 22;
|
repeated int64 rep_int64 = 22 [packed = true];
|
||||||
repeated uint32 rep_uint32 = 23;
|
repeated uint32 rep_uint32 = 23 [packed = true];
|
||||||
repeated uint64 rep_uint64 = 24;
|
repeated uint64 rep_uint64 = 24 [packed = true];
|
||||||
repeated sint32 rep_sint32 = 25;
|
repeated sint32 rep_sint32 = 25 [packed = true];
|
||||||
repeated sint64 rep_sint64 = 26;
|
repeated sint64 rep_sint64 = 26 [packed = true];
|
||||||
repeated bool rep_bool = 27;
|
repeated bool rep_bool = 27 [packed = true];
|
||||||
|
|
||||||
repeated fixed32 rep_fixed32 = 28;
|
repeated fixed32 rep_fixed32 = 28 [packed = true];
|
||||||
repeated sfixed32 rep_sfixed32= 29;
|
repeated sfixed32 rep_sfixed32= 29 [packed = true];
|
||||||
repeated float rep_float = 30;
|
repeated float rep_float = 30 [packed = true];
|
||||||
|
|
||||||
repeated fixed64 rep_fixed64 = 31;
|
repeated fixed64 rep_fixed64 = 31 [packed = true];
|
||||||
repeated sfixed64 rep_sfixed64= 32;
|
repeated sfixed64 rep_sfixed64= 32 [packed = true];
|
||||||
repeated double rep_double = 33;
|
repeated double rep_double = 33 [packed = true];
|
||||||
|
|
||||||
repeated string rep_string = 34;
|
repeated string rep_string = 34;
|
||||||
repeated bytes rep_bytes = 35;
|
repeated bytes rep_bytes = 35;
|
||||||
repeated SubMessage rep_submsg = 36;
|
repeated SubMessage rep_submsg = 36;
|
||||||
repeated MyEnum rep_enum = 37;
|
repeated MyEnum rep_enum = 37 [packed = true];
|
||||||
repeated EmptyMessage rep_emptymsg = 38;
|
repeated EmptyMessage rep_emptymsg = 38;
|
||||||
|
|
||||||
optional int32 opt_int32 = 41 [default = 4041];
|
optional int32 opt_int32 = 41 [default = 4041];
|
||||||
@@ -83,8 +101,14 @@ message AllTypes {
|
|||||||
optional MyEnum opt_enum = 57 [default = Second];
|
optional MyEnum opt_enum = 57 [default = Second];
|
||||||
optional EmptyMessage opt_emptymsg = 58;
|
optional EmptyMessage opt_emptymsg = 58;
|
||||||
|
|
||||||
|
// Check that extreme integer values are handled correctly
|
||||||
|
required Limits req_limits = 98;
|
||||||
|
|
||||||
// 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"); \
|
||||||
@@ -169,6 +170,17 @@ bool check_alltypes(pb_istream_t *stream, int mode)
|
|||||||
TEST(alltypes.has_opt_emptymsg == true);
|
TEST(alltypes.has_opt_emptymsg == true);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
TEST(alltypes.req_limits.int32_min == INT32_MIN);
|
||||||
|
TEST(alltypes.req_limits.int32_max == INT32_MAX);
|
||||||
|
TEST(alltypes.req_limits.uint32_min == 0);
|
||||||
|
TEST(alltypes.req_limits.uint32_max == UINT32_MAX);
|
||||||
|
TEST(alltypes.req_limits.int64_min == INT64_MIN);
|
||||||
|
TEST(alltypes.req_limits.int64_max == INT64_MAX);
|
||||||
|
TEST(alltypes.req_limits.uint64_min == 0);
|
||||||
|
TEST(alltypes.req_limits.uint64_max == UINT64_MAX);
|
||||||
|
TEST(alltypes.req_limits.enum_min == HugeEnum_Negative);
|
||||||
|
TEST(alltypes.req_limits.enum_max == HugeEnum_Positive);
|
||||||
|
|
||||||
TEST(alltypes.end == 1099);
|
TEST(alltypes.end == 1099);
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
@@ -176,15 +188,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)
|
||||||
{
|
{
|
||||||
@@ -66,6 +67,17 @@ int main(int argc, char **argv)
|
|||||||
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;
|
alltypes.rep_emptymsg_count = 5;
|
||||||
|
|
||||||
|
alltypes.req_limits.int32_min = INT32_MIN;
|
||||||
|
alltypes.req_limits.int32_max = INT32_MAX;
|
||||||
|
alltypes.req_limits.uint32_min = 0;
|
||||||
|
alltypes.req_limits.uint32_max = UINT32_MAX;
|
||||||
|
alltypes.req_limits.int64_min = INT64_MIN;
|
||||||
|
alltypes.req_limits.int64_max = INT64_MAX;
|
||||||
|
alltypes.req_limits.uint64_min = 0;
|
||||||
|
alltypes.req_limits.uint64_max = UINT64_MAX;
|
||||||
|
alltypes.req_limits.enum_min = HugeEnum_Negative;
|
||||||
|
alltypes.req_limits.enum_max = HugeEnum_Positive;
|
||||||
|
|
||||||
if (mode != 0)
|
if (mode != 0)
|
||||||
{
|
{
|
||||||
/* Fill in values for optional fields */
|
/* Fill in values for optional fields */
|
||||||
@@ -113,18 +125,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));
|
|
||||||
|
|
||||||
/* Now encode it and check if we succeeded. */
|
|
||||||
if (pb_encode(&stream, AllTypes_fields, &alltypes))
|
|
||||||
{
|
{
|
||||||
fwrite(buffer, 1, stream.bytes_written, stdout);
|
uint8_t buffer[AllTypes_size];
|
||||||
return 0; /* Success */
|
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
||||||
}
|
|
||||||
else
|
/* Now encode it and check if we succeeded. */
|
||||||
{
|
if (pb_encode(&stream, AllTypes_fields, &alltypes))
|
||||||
fprintf(stderr, "Encoding failed: %s\n", PB_GET_ERROR(&stream));
|
{
|
||||||
return 1; /* Failure */
|
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 */
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
23
tests/alltypes_pointer/SConscript
Normal file
23
tests/alltypes_pointer/SConscript
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# Encode the AllTypes message using pointers for all fields, and verify the
|
||||||
|
# output against the normal AllTypes test case.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
c = Copy("$TARGET", "$SOURCE")
|
||||||
|
env.Command("alltypes.proto", "#alltypes/alltypes.proto", c)
|
||||||
|
|
||||||
|
env.NanopbProto(["alltypes", "alltypes.options"])
|
||||||
|
enc = env.Program(["encode_alltypes_pointer.c", "alltypes.pb.c", "$COMMON/pb_encode.o"])
|
||||||
|
|
||||||
|
refdec = "$BUILD/alltypes/decode_alltypes$PROGSUFFIX"
|
||||||
|
|
||||||
|
# Encode and compare results
|
||||||
|
env.RunTest(enc)
|
||||||
|
env.RunTest("decode_alltypes.output", [refdec, "encode_alltypes_pointer.output"])
|
||||||
|
env.Compare(["encode_alltypes_pointer.output", "$BUILD/alltypes/encode_alltypes.output"])
|
||||||
|
|
||||||
|
# Do the same thing with the optional fields present
|
||||||
|
env.RunTest("optionals.output", enc, ARGS = ['1'])
|
||||||
|
env.RunTest("optionals.decout", [refdec, "optionals.output"], ARGS = ['1'])
|
||||||
|
env.Compare(["optionals.output", "$BUILD/alltypes/optionals.output"])
|
||||||
|
|
||||||
3
tests/alltypes_pointer/alltypes.options
Normal file
3
tests/alltypes_pointer/alltypes.options
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Generate all fields as pointers.
|
||||||
|
* type:FT_POINTER
|
||||||
|
|
||||||
187
tests/alltypes_pointer/encode_alltypes_pointer.c
Normal file
187
tests/alltypes_pointer/encode_alltypes_pointer.c
Normal file
@@ -0,0 +1,187 @@
|
|||||||
|
/* Attempts to test all the datatypes supported by ProtoBuf.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <pb_encode.h>
|
||||||
|
#include "alltypes.pb.h"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
|
int main(int argc, char **argv)
|
||||||
|
{
|
||||||
|
int mode = (argc > 1) ? atoi(argv[1]) : 0;
|
||||||
|
|
||||||
|
/* Values for required fields */
|
||||||
|
int32_t req_int32 = -1001;
|
||||||
|
int64_t req_int64 = -1002;
|
||||||
|
uint32_t req_uint32 = 1003;
|
||||||
|
uint64_t req_uint64 = 1004;
|
||||||
|
int32_t req_sint32 = -1005;
|
||||||
|
int64_t req_sint64 = -1006;
|
||||||
|
bool req_bool = true;
|
||||||
|
uint32_t req_fixed32 = 1008;
|
||||||
|
int32_t req_sfixed32 = -1009;
|
||||||
|
float req_float = 1010.0f;
|
||||||
|
uint64_t req_fixed64 = 1011;
|
||||||
|
int64_t req_sfixed64 = -1012;
|
||||||
|
double req_double = 1013.0;
|
||||||
|
char* req_string = "1014";
|
||||||
|
pb_bytes_ptr_t req_bytes = {4, (uint8_t*)"1015"};
|
||||||
|
static int32_t req_substuff = 1016;
|
||||||
|
SubMessage req_submsg = {"1016", &req_substuff};
|
||||||
|
MyEnum req_enum = MyEnum_Truth;
|
||||||
|
EmptyMessage req_emptymsg = {0};
|
||||||
|
|
||||||
|
int32_t end = 1099;
|
||||||
|
|
||||||
|
/* Values for repeated fields */
|
||||||
|
int32_t rep_int32[5] = {0, 0, 0, 0, -2001};
|
||||||
|
int64_t rep_int64[5] = {0, 0, 0, 0, -2002};
|
||||||
|
uint32_t rep_uint32[5] = {0, 0, 0, 0, 2003};
|
||||||
|
uint64_t rep_uint64[5] = {0, 0, 0, 0, 2004};
|
||||||
|
int32_t rep_sint32[5] = {0, 0, 0, 0, -2005};
|
||||||
|
int64_t rep_sint64[5] = {0, 0, 0, 0, -2006};
|
||||||
|
bool rep_bool[5] = {false, false, false, false, true};
|
||||||
|
uint32_t rep_fixed32[5] = {0, 0, 0, 0, 2008};
|
||||||
|
int32_t rep_sfixed32[5] = {0, 0, 0, 0, -2009};
|
||||||
|
float rep_float[5] = {0, 0, 0, 0, 2010.0f};
|
||||||
|
uint64_t rep_fixed64[5] = {0, 0, 0, 0, 2011};
|
||||||
|
int64_t rep_sfixed64[5] = {0, 0, 0, 0, -2012};
|
||||||
|
double rep_double[5] = {0, 0, 0, 0, 2013.0f};
|
||||||
|
char* rep_string[5] = {"", "", "", "", "2014"};
|
||||||
|
pb_bytes_ptr_t rep_bytes[5] = {{0,0}, {0,0}, {0,0}, {0,0}, {4, (uint8_t*)"2015"}};
|
||||||
|
static int32_t rep_sub2zero = 0;
|
||||||
|
static int32_t rep_substuff2 = 2016;
|
||||||
|
static uint32_t rep_substuff3 = 2016;
|
||||||
|
SubMessage rep_submsg[5] = {{"", &rep_sub2zero},
|
||||||
|
{"", &rep_sub2zero},
|
||||||
|
{"", &rep_sub2zero},
|
||||||
|
{"", &rep_sub2zero},
|
||||||
|
{"2016", &rep_substuff2, &rep_substuff3}};
|
||||||
|
MyEnum rep_enum[5] = {0, 0, 0, 0, MyEnum_Truth};
|
||||||
|
EmptyMessage rep_emptymsg[5] = {{0}, {0}, {0}, {0}, {0}};
|
||||||
|
|
||||||
|
/* Values for optional fields */
|
||||||
|
int32_t opt_int32 = 3041;
|
||||||
|
int64_t opt_int64 = 3042;
|
||||||
|
uint32_t opt_uint32 = 3043;
|
||||||
|
uint64_t opt_uint64 = 3044;
|
||||||
|
int32_t opt_sint32 = 3045;
|
||||||
|
int64_t opt_sint64 = 3046;
|
||||||
|
bool opt_bool = true;
|
||||||
|
uint32_t opt_fixed32 = 3048;
|
||||||
|
int32_t opt_sfixed32 = 3049;
|
||||||
|
float opt_float = 3050.0f;
|
||||||
|
uint64_t opt_fixed64 = 3051;
|
||||||
|
int64_t opt_sfixed64 = 3052;
|
||||||
|
double opt_double = 3053.0;
|
||||||
|
char* opt_string = "3054";
|
||||||
|
pb_bytes_ptr_t opt_bytes = {4, (uint8_t*)"3055"};
|
||||||
|
static int32_t opt_substuff = 3056;
|
||||||
|
SubMessage opt_submsg = {"3056", &opt_substuff};
|
||||||
|
MyEnum opt_enum = MyEnum_Truth;
|
||||||
|
EmptyMessage opt_emptymsg = {0};
|
||||||
|
|
||||||
|
/* Values for the Limits message. */
|
||||||
|
static int32_t int32_min = INT32_MIN;
|
||||||
|
static int32_t int32_max = INT32_MAX;
|
||||||
|
static uint32_t uint32_min = 0;
|
||||||
|
static uint32_t uint32_max = UINT32_MAX;
|
||||||
|
static int64_t int64_min = INT64_MIN;
|
||||||
|
static int64_t int64_max = INT64_MAX;
|
||||||
|
static uint64_t uint64_min = 0;
|
||||||
|
static uint64_t uint64_max = UINT64_MAX;
|
||||||
|
static HugeEnum enum_min = HugeEnum_Negative;
|
||||||
|
static HugeEnum enum_max = HugeEnum_Positive;
|
||||||
|
Limits req_limits = {&int32_min, &int32_max,
|
||||||
|
&uint32_min, &uint32_max,
|
||||||
|
&int64_min, &int64_max,
|
||||||
|
&uint64_min, &uint64_max,
|
||||||
|
&enum_min, &enum_max};
|
||||||
|
|
||||||
|
/* Initialize the message struct with pointers to the fields. */
|
||||||
|
AllTypes alltypes = {0};
|
||||||
|
|
||||||
|
alltypes.req_int32 = &req_int32;
|
||||||
|
alltypes.req_int64 = &req_int64;
|
||||||
|
alltypes.req_uint32 = &req_uint32;
|
||||||
|
alltypes.req_uint64 = &req_uint64;
|
||||||
|
alltypes.req_sint32 = &req_sint32;
|
||||||
|
alltypes.req_sint64 = &req_sint64;
|
||||||
|
alltypes.req_bool = &req_bool;
|
||||||
|
alltypes.req_fixed32 = &req_fixed32;
|
||||||
|
alltypes.req_sfixed32 = &req_sfixed32;
|
||||||
|
alltypes.req_float = &req_float;
|
||||||
|
alltypes.req_fixed64 = &req_fixed64;
|
||||||
|
alltypes.req_sfixed64 = &req_sfixed64;
|
||||||
|
alltypes.req_double = &req_double;
|
||||||
|
alltypes.req_string = req_string;
|
||||||
|
alltypes.req_bytes = &req_bytes;
|
||||||
|
alltypes.req_submsg = &req_submsg;
|
||||||
|
alltypes.req_enum = &req_enum;
|
||||||
|
alltypes.req_emptymsg = &req_emptymsg;
|
||||||
|
alltypes.req_limits = &req_limits;
|
||||||
|
|
||||||
|
alltypes.rep_int32_count = 5; alltypes.rep_int32 = rep_int32;
|
||||||
|
alltypes.rep_int64_count = 5; alltypes.rep_int64 = rep_int64;
|
||||||
|
alltypes.rep_uint32_count = 5; alltypes.rep_uint32 = rep_uint32;
|
||||||
|
alltypes.rep_uint64_count = 5; alltypes.rep_uint64 = rep_uint64;
|
||||||
|
alltypes.rep_sint32_count = 5; alltypes.rep_sint32 = rep_sint32;
|
||||||
|
alltypes.rep_sint64_count = 5; alltypes.rep_sint64 = rep_sint64;
|
||||||
|
alltypes.rep_bool_count = 5; alltypes.rep_bool = rep_bool;
|
||||||
|
alltypes.rep_fixed32_count = 5; alltypes.rep_fixed32 = rep_fixed32;
|
||||||
|
alltypes.rep_sfixed32_count = 5; alltypes.rep_sfixed32 = rep_sfixed32;
|
||||||
|
alltypes.rep_float_count = 5; alltypes.rep_float = rep_float;
|
||||||
|
alltypes.rep_fixed64_count = 5; alltypes.rep_fixed64 = rep_fixed64;
|
||||||
|
alltypes.rep_sfixed64_count = 5; alltypes.rep_sfixed64 = rep_sfixed64;
|
||||||
|
alltypes.rep_double_count = 5; alltypes.rep_double = rep_double;
|
||||||
|
alltypes.rep_string_count = 5; alltypes.rep_string = rep_string;
|
||||||
|
alltypes.rep_bytes_count = 5; alltypes.rep_bytes = rep_bytes;
|
||||||
|
alltypes.rep_submsg_count = 5; alltypes.rep_submsg = rep_submsg;
|
||||||
|
alltypes.rep_enum_count = 5; alltypes.rep_enum = rep_enum;
|
||||||
|
alltypes.rep_emptymsg_count = 5; alltypes.rep_emptymsg = rep_emptymsg;
|
||||||
|
|
||||||
|
if (mode != 0)
|
||||||
|
{
|
||||||
|
/* Fill in values for optional fields */
|
||||||
|
alltypes.opt_int32 = &opt_int32;
|
||||||
|
alltypes.opt_int64 = &opt_int64;
|
||||||
|
alltypes.opt_uint32 = &opt_uint32;
|
||||||
|
alltypes.opt_uint64 = &opt_uint64;
|
||||||
|
alltypes.opt_sint32 = &opt_sint32;
|
||||||
|
alltypes.opt_sint64 = &opt_sint64;
|
||||||
|
alltypes.opt_bool = &opt_bool;
|
||||||
|
alltypes.opt_fixed32 = &opt_fixed32;
|
||||||
|
alltypes.opt_sfixed32 = &opt_sfixed32;
|
||||||
|
alltypes.opt_float = &opt_float;
|
||||||
|
alltypes.opt_fixed64 = &opt_fixed64;
|
||||||
|
alltypes.opt_sfixed64 = &opt_sfixed64;
|
||||||
|
alltypes.opt_double = &opt_double;
|
||||||
|
alltypes.opt_string = opt_string;
|
||||||
|
alltypes.opt_bytes = &opt_bytes;
|
||||||
|
alltypes.opt_submsg = &opt_submsg;
|
||||||
|
alltypes.opt_enum = &opt_enum;
|
||||||
|
alltypes.opt_emptymsg = &opt_emptymsg;
|
||||||
|
}
|
||||||
|
|
||||||
|
alltypes.end = &end;
|
||||||
|
|
||||||
|
{
|
||||||
|
uint8_t buffer[4096];
|
||||||
|
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
||||||
|
|
||||||
|
/* Now encode it and check if we succeeded. */
|
||||||
|
if (pb_encode(&stream, AllTypes_fields, &alltypes))
|
||||||
|
{
|
||||||
|
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 */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
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 "bc_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,17 @@
|
|||||||
/* 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"
|
||||||
|
#include "test_helpers.h"
|
||||||
|
|
||||||
#define TEST(x) if (!(x)) { \
|
#define TEST(x) if (!(x)) { \
|
||||||
printf("Test " #x " failed.\n"); \
|
printf("Test " #x " failed.\n"); \
|
||||||
@@ -176,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))
|
||||||
@@ -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)
|
||||||
{
|
{
|
||||||
@@ -113,19 +114,22 @@ 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. */
|
|
||||||
if (pb_encode(&stream, AllTypes_fields, &alltypes))
|
/* Now encode it and check if we succeeded. */
|
||||||
{
|
if (pb_encode(&stream, AllTypes_fields, &alltypes))
|
||||||
fwrite(buffer, 1, stream.bytes_written, stdout);
|
{
|
||||||
return 0; /* Success */
|
SET_BINARY_MODE(stdout);
|
||||||
}
|
fwrite(buffer, 1, stream.bytes_written, stdout);
|
||||||
else
|
return 0; /* Success */
|
||||||
{
|
}
|
||||||
fprintf(stderr, "Encoding failed!\n");
|
else
|
||||||
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()
|
||||||
{
|
{
|
||||||
|
uint8_t buffer[Person_size];
|
||||||
|
pb_istream_t stream;
|
||||||
|
size_t count;
|
||||||
|
|
||||||
/* Read the data into buffer */
|
/* Read the data into buffer */
|
||||||
uint8_t buffer[512];
|
SET_BINARY_MODE(stdin);
|
||||||
size_t count = fread(buffer, 1, sizeof(buffer), 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[Person_size];
|
||||||
|
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,12 +20,13 @@ 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 */
|
||||||
}
|
}
|
||||||
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,7 +23,9 @@ 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))
|
||||||
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", "$BUILD/alltypes/alltypes.pb.h", c)
|
||||||
|
env.Command("alltypes.pb.c", "$BUILD/alltypes/alltypes.pb.c", c)
|
||||||
|
env.Command("encode_alltypes.c", "$BUILD/alltypes/encode_alltypes.c", c)
|
||||||
|
env.Command("decode_alltypes.c", "$BUILD/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,6 +5,7 @@
|
|||||||
#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)
|
||||||
{
|
{
|
||||||
@@ -50,21 +51,24 @@ bool print_fixed64(pb_istream_t *stream, const pb_field_t *field, void **arg)
|
|||||||
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,6 +4,7 @@
|
|||||||
#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, void * const *arg)
|
bool encode_string(pb_ostream_t *stream, const pb_field_t *field, void * const *arg)
|
||||||
{
|
{
|
||||||
@@ -25,27 +26,47 @@ bool encode_int32(pb_ostream_t *stream, const pb_field_t *field, void * const *a
|
|||||||
|
|
||||||
bool encode_fixed32(pb_ostream_t *stream, const pb_field_t *field, void * const *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, void * const *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;
|
||||||
@@ -57,10 +78,13 @@ int main()
|
|||||||
testmessage.submsg.int32value.funcs.encode = &encode_int32;
|
testmessage.submsg.int32value.funcs.encode = &encode_int32;
|
||||||
testmessage.submsg.fixed32value.funcs.encode = &encode_fixed32;
|
testmessage.submsg.fixed32value.funcs.encode = &encode_fixed32;
|
||||||
testmessage.submsg.fixed64value.funcs.encode = &encode_fixed64;
|
testmessage.submsg.fixed64value.funcs.encode = &encode_fixed64;
|
||||||
|
|
||||||
|
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", "$NANOPB/pb_decode.c")
|
||||||
|
strict.Object("pb_encode.o", "$NANOPB/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,14 @@ 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 BytesMessage {
|
||||||
|
required bytes data = 1 [(nanopb).max_size = 16];
|
||||||
|
}
|
||||||
|
|
||||||
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
|
||||||
24
tests/cxx_main_program/SConscript
Normal file
24
tests/cxx_main_program/SConscript
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Run the alltypes test case, but compile it as C++ instead.
|
||||||
|
# In fact, compile the entire nanopb using C++ compiler.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
# This is needed to get INT32_MIN etc. macros defined
|
||||||
|
env = env.Clone()
|
||||||
|
env.Append(CPPDEFINES = ['__STDC_LIMIT_MACROS'])
|
||||||
|
|
||||||
|
# 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", "$BUILD/alltypes/alltypes.pb.h", c)
|
||||||
|
env.Command("alltypes.pb.cxx", "$BUILD/alltypes/alltypes.pb.c", c)
|
||||||
|
env.Command("encode_alltypes.cxx", "$BUILD/alltypes/encode_alltypes.c", c)
|
||||||
|
env.Command("decode_alltypes.cxx", "$BUILD/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"])
|
||||||
|
env.RunTest(p)
|
||||||
|
|
||||||
@@ -1,8 +1,8 @@
|
|||||||
#define NANOPB_INTERNALS
|
/* This includes the whole .c file to get access to static functions. */
|
||||||
|
#include "pb_decode.c"
|
||||||
|
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
#include "pb_decode.h"
|
|
||||||
#include "unittests.h"
|
#include "unittests.h"
|
||||||
#include "unittestproto.pb.h"
|
#include "unittestproto.pb.h"
|
||||||
|
|
||||||
@@ -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"])
|
||||||
|
env.RunTest(p)
|
||||||
@@ -1,8 +1,8 @@
|
|||||||
#define NANOPB_INTERNALS
|
/* This includes the whole .c file to get access to static functions. */
|
||||||
|
#include "pb_encode.c"
|
||||||
|
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
#include "pb_encode.h"
|
|
||||||
#include "unittests.h"
|
#include "unittests.h"
|
||||||
#include "unittestproto.pb.h"
|
#include "unittestproto.pb.h"
|
||||||
|
|
||||||
@@ -172,20 +172,22 @@ int main()
|
|||||||
struct { size_t size; uint8_t bytes[5]; } value = {5, {'x', 'y', 'z', 'z', 'y'}};
|
struct { size_t size; uint8_t bytes[5]; } value = {5, {'x', 'y', 'z', 'z', 'y'}};
|
||||||
|
|
||||||
COMMENT("Test pb_enc_bytes")
|
COMMENT("Test pb_enc_bytes")
|
||||||
TEST(WRITES(pb_enc_bytes(&s, NULL, &value), "\x05xyzzy"))
|
TEST(WRITES(pb_enc_bytes(&s, &BytesMessage_fields[0], &value), "\x05xyzzy"))
|
||||||
value.size = 0;
|
value.size = 0;
|
||||||
TEST(WRITES(pb_enc_bytes(&s, NULL, &value), "\x00"))
|
TEST(WRITES(pb_enc_bytes(&s, &BytesMessage_fields[0], &value), "\x00"))
|
||||||
}
|
}
|
||||||
|
|
||||||
{
|
{
|
||||||
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"))
|
||||||
}
|
}
|
||||||
|
|
||||||
{
|
{
|
||||||
@@ -221,6 +223,20 @@ int main()
|
|||||||
TEST(!pb_encode(&s, FloatArray_fields, &msg))
|
TEST(!pb_encode(&s, FloatArray_fields, &msg))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
uint8_t buffer[50];
|
||||||
|
pb_ostream_t s;
|
||||||
|
FloatArray msg = {1, {99.0f}};
|
||||||
|
|
||||||
|
COMMENT("Test array size limit in pb_encode")
|
||||||
|
|
||||||
|
s = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
||||||
|
TEST((msg.data_count = 10) && pb_encode(&s, FloatArray_fields, &msg))
|
||||||
|
|
||||||
|
s = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
||||||
|
TEST((msg.data_count = 11) && !pb_encode(&s, FloatArray_fields, &msg))
|
||||||
|
}
|
||||||
|
|
||||||
{
|
{
|
||||||
uint8_t buffer[10];
|
uint8_t buffer[10];
|
||||||
pb_ostream_t s;
|
pb_ostream_t s;
|
||||||
@@ -242,6 +258,30 @@ int main()
|
|||||||
"\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"))
|
"\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
uint8_t buffer[32];
|
||||||
|
pb_ostream_t s;
|
||||||
|
BytesMessage msg = {{3, "xyz"}};
|
||||||
|
|
||||||
|
COMMENT("Test pb_encode with bytes message.")
|
||||||
|
TEST(WRITES(pb_encode(&s, BytesMessage_fields, &msg),
|
||||||
|
"\x0A\x03xyz"))
|
||||||
|
|
||||||
|
msg.data.size = 17; /* More than maximum */
|
||||||
|
TEST(!pb_encode(&s, BytesMessage_fields, &msg))
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
{
|
||||||
|
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;
|
||||||
@@ -268,6 +308,19 @@ int main()
|
|||||||
TEST(!pb_encode(&s, CallbackContainerContainer_fields, &msg2))
|
TEST(!pb_encode(&s, CallbackContainerContainer_fields, &msg2))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
uint8_t buffer[StringMessage_size];
|
||||||
|
pb_ostream_t s;
|
||||||
|
StringMessage msg = {"0123456789"};
|
||||||
|
|
||||||
|
s = pb_ostream_from_buffer(buffer, sizeof(buffer));
|
||||||
|
|
||||||
|
COMMENT("Test that StringMessage_size is correct")
|
||||||
|
|
||||||
|
TEST(pb_encode(&s, StringMessage_fields, &msg));
|
||||||
|
TEST(s.bytes_written == StringMessage_size);
|
||||||
|
}
|
||||||
|
|
||||||
if (status != 0)
|
if (status != 0)
|
||||||
fprintf(stdout, "\n\nSome tests FAILED!\n");
|
fprintf(stdout, "\n\nSome tests FAILED!\n");
|
||||||
|
|
||||||
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 = '$BUILD/alltypes')
|
||||||
|
incpath.Append(CPPPATH = '$BUILD/alltypes')
|
||||||
|
|
||||||
|
incpath.NanopbProto(["extensions", "extensions.options"])
|
||||||
|
enc = incpath.Program(["encode_extensions.c", "extensions.pb.c", "$BUILD/alltypes/alltypes.pb$OBJSUFFIX", "$COMMON/pb_encode.o"])
|
||||||
|
dec = incpath.Program(["decode_extensions.c", "extensions.pb.c", "$BUILD/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;
|
||||||
|
}
|
||||||
|
|
||||||
54
tests/extensions/encode_extensions.c
Normal file
54
tests/extensions/encode_extensions.c
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
/* 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 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Check that the field tags are properly generated */
|
||||||
|
(void)AllTypes_extensionfield1_tag;
|
||||||
|
(void)ExtensionMessage_AllTypes_extensionfield2_tag;
|
||||||
|
}
|
||||||
|
|
||||||
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;
|
||||||
|
}
|
||||||
|
|
||||||
16
tests/extra_fields/SConscript
Normal file
16
tests/extra_fields/SConscript
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# Test that the decoder properly handles unknown fields in the input.
|
||||||
|
|
||||||
|
Import("env")
|
||||||
|
|
||||||
|
dec = env.GetBuildPath('$BUILD/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"])
|
||||||
|
|
||||||
|
dec = env.GetBuildPath('$BUILD/basic_stream/${PROGPREFIX}decode_stream${PROGSUFFIX}')
|
||||||
|
env.RunTest('person_with_extra_field_stream.output', [dec, "person_with_extra_field.pb"])
|
||||||
|
env.Compare(["person_with_extra_field_stream.output", "person_with_extra_field.expected"])
|
||||||
|
|
||||||
|
# This uses the backwards compatibility alltypes test, so that
|
||||||
|
# alltypes_with_extra_fields.pb doesn't have to be remade so often.
|
||||||
|
dec2 = env.GetBuildPath('$BUILD/backwards_compatibility/${PROGPREFIX}decode_legacy${PROGSUFFIX}')
|
||||||
|
env.RunTest('alltypes_with_extra_fields.output', [dec2, 'alltypes_with_extra_fields.pb'])
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user