Compare commits
52 Commits
nanopb-0.2
...
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 |
21
.gitignore
vendored
21
.gitignore
vendored
@@ -5,17 +5,24 @@
|
||||
*.pb.c
|
||||
*.pb.h
|
||||
*.pb
|
||||
*.pyc
|
||||
*_pb2.py
|
||||
*~
|
||||
*.tar.gz
|
||||
.sconsign.dblite
|
||||
config.log
|
||||
.sconf_temp
|
||||
tests/build
|
||||
julkaisu.txt
|
||||
dist
|
||||
docs/*.html
|
||||
docs/generator_flow.png
|
||||
example/client
|
||||
example/server
|
||||
example_avr_double/decode_double
|
||||
example_avr_double/encode_double
|
||||
example_avr_double/test_conversions
|
||||
example_unions/decode
|
||||
example_unions/encode
|
||||
examples/simple/simple
|
||||
examples/network_server/client
|
||||
examples/network_server/server
|
||||
examples/using_double_on_avr/decode_double
|
||||
examples/using_double_on_avr/encode_double
|
||||
examples/using_double_on_avr/test_conversions
|
||||
examples/using_union_messages/decode
|
||||
examples/using_union_messages/encode
|
||||
generator/nanopb_pb2.pyc
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
@@ -104,11 +104,12 @@ requires a few header files to be available:
|
||||
#) *stdbool.h*, for definition of *bool*
|
||||
|
||||
If these header files do not come with your compiler, you can use the
|
||||
file *compat/pb_syshdr.h* instead. It contains an example of how to provide
|
||||
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.
|
||||
|
||||
To use the pb_syshdr.h, define *PB_SYSTEM_HEADER* to be the name of your custom
|
||||
header file. It should provide all the dependencies listed above.
|
||||
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
|
||||
listed above.
|
||||
|
||||
Running the test cases
|
||||
======================
|
||||
|
||||
@@ -1,19 +1,17 @@
|
||||
CFLAGS = -ansi -Wall -Werror -g -O0
|
||||
# Include the nanopb provided Makefile rules
|
||||
include ../../extra/nanopb.mk
|
||||
|
||||
# Path to the nanopb root folder
|
||||
NANOPB_DIR = ../..
|
||||
DEPS = $(NANOPB_DIR)/pb_decode.c $(NANOPB_DIR)/pb_decode.h \
|
||||
$(NANOPB_DIR)/pb_encode.c $(NANOPB_DIR)/pb_encode.h $(NANOPB_DIR)/pb.h
|
||||
# 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 $(DEPS) fileproto.pb.h fileproto.pb.c
|
||||
$(CC) $(CFLAGS) -o $@ $< $(NANOPB_DIR)/pb_decode.c $(NANOPB_DIR)/pb_encode.c fileproto.pb.c common.c
|
||||
%: %.c common.c fileproto.pb.c
|
||||
$(CC) $(CFLAGS) -o $@ $^ $(NANOPB_CORE)
|
||||
|
||||
fileproto.pb.c fileproto.pb.h: fileproto.proto $(NANOPB_DIR)/generator/nanopb_generator.py
|
||||
protoc -ofileproto.pb $<
|
||||
python $(NANOPB_DIR)/generator/nanopb_generator.py fileproto.pb
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# Include the nanopb provided Makefile rules
|
||||
include ../../extra/nanopb.mk
|
||||
|
||||
# Compiler flags to enable all warnings & debug info
|
||||
CFLAGS = -Wall -Werror -g -O0
|
||||
|
||||
# Path to the nanopb root folder
|
||||
NANOPB_DIR = ../..
|
||||
CFLAGS += -I$(NANOPB_DIR)
|
||||
|
||||
# C source code files that are required
|
||||
@@ -17,6 +17,5 @@ simple: $(CSRC)
|
||||
|
||||
# Build rule for the protocol
|
||||
simple.pb.c: simple.proto
|
||||
protoc -osimple.pb simple.proto
|
||||
python $(NANOPB_DIR)/generator/nanopb_generator.py simple.pb
|
||||
$(PROTOC) $(PROTOC_OPTS) --nanopb_out=. simple.proto
|
||||
|
||||
|
||||
@@ -18,10 +18,9 @@ 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 two commands::
|
||||
the following command::
|
||||
|
||||
protoc -osimple.pb simple.proto
|
||||
python nanopb_generator.py simple.pb
|
||||
../../generator-bin/protoc --nanopb_out=. simple.proto
|
||||
|
||||
After that, add the following four files to your project and compile:
|
||||
|
||||
@@ -1,27 +1,22 @@
|
||||
CFLAGS = -Wall -Werror -g -O0
|
||||
# Include the nanopb provided Makefile rules
|
||||
include ../../extra/nanopb.mk
|
||||
|
||||
# Path to the nanopb root directory
|
||||
NANOPB_DIR = ../..
|
||||
DEPS = double_conversion.c $(NANOPB_DIR)/pb.h \
|
||||
$(NANOPB_DIR)/pb_decode.c $(NANOPB_DIR)/pb_decode.h \
|
||||
$(NANOPB_DIR)/pb_encode.c $(NANOPB_DIR)/pb_encode.h
|
||||
# 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 $(DEPS) doubleproto.pb.h doubleproto.pb.c
|
||||
$(CC) $(CFLAGS) -o $@ $< double_conversion.c \
|
||||
$(NANOPB_DIR)/pb_decode.c $(NANOPB_DIR)/pb_encode.c doubleproto.pb.c
|
||||
|
||||
doubleproto.pb.c doubleproto.pb.h: doubleproto.proto $(NANOPB_DIR)/generator/nanopb_generator.py
|
||||
protoc -odoubleproto.pb $<
|
||||
python $(NANOPB_DIR)/generator/nanopb_generator.py doubleproto.pb
|
||||
%: %.c double_conversion.c doubleproto.pb.c
|
||||
$(CC) $(CFLAGS) -o $@ $^ $(NANOPB_CORE)
|
||||
|
||||
run_tests: test_conversions encode_double decode_double
|
||||
./test_conversions
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
CFLAGS = -ansi -Wall -Werror -g -O0
|
||||
# Include the nanopb provided Makefile rules
|
||||
include ../../extra/nanopb.mk
|
||||
|
||||
# Path to the nanopb root folder
|
||||
NANOPB_DIR = ../..
|
||||
DEPS = $(NANOPB_DIR)/pb_decode.c $(NANOPB_DIR)/pb_decode.h \
|
||||
$(NANOPB_DIR)/pb_encode.c $(NANOPB_DIR)/pb_encode.h $(NANOPB_DIR)/pb.h
|
||||
# Compiler flags to enable all warnings & debug info
|
||||
CFLAGS = -ansi -Wall -Werror -g -O0
|
||||
CFLAGS += -I$(NANOPB_DIR)
|
||||
|
||||
all: encode decode
|
||||
@@ -11,12 +10,11 @@ all: encode decode
|
||||
./encode 2 | ./decode
|
||||
./encode 3 | ./decode
|
||||
|
||||
.SUFFIXES:
|
||||
|
||||
clean:
|
||||
rm -f encode unionproto.pb.h unionproto.pb.c
|
||||
|
||||
%: %.c $(DEPS) unionproto.pb.h unionproto.pb.c
|
||||
$(CC) $(CFLAGS) -o $@ $< $(NANOPB_DIR)/pb_decode.c $(NANOPB_DIR)/pb_encode.c unionproto.pb.c
|
||||
%: %.c unionproto.pb.c
|
||||
$(CC) $(CFLAGS) -o $@ $^ $(NANOPB_CORE)
|
||||
|
||||
unionproto.pb.h unionproto.pb.c: unionproto.proto $(NANOPB_DIR)/generator/nanopb_generator.py
|
||||
protoc -ounionproto.pb $<
|
||||
python $(NANOPB_DIR)/generator/nanopb_generator.py unionproto.pb
|
||||
|
||||
@@ -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:
|
||||
#
|
||||
@@ -148,7 +149,7 @@ function(NANOPB_GENERATE_CPP SRCS HDRS)
|
||||
"${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.h"
|
||||
COMMAND python
|
||||
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"
|
||||
VERBATIM )
|
||||
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=. $<
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/* This is an example of a header file for platforms/compilers that do
|
||||
* not come with stdint.h/stddef.h/stdbool.h/string.h. To use it, define
|
||||
* PB_SYSTEM_HEADER as "pb_syshdr.h", including the quotes, and add the
|
||||
* compat folder to your include path.
|
||||
* 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
|
||||
@@ -1,5 +0,0 @@
|
||||
nanopb_pb2.py: nanopb.proto
|
||||
protoc --python_out=. -I /usr/include -I . nanopb.proto
|
||||
|
||||
plugin_pb2.py: plugin.proto
|
||||
protoc --python_out=. -I /usr/include -I . plugin.proto
|
||||
@@ -1,36 +1,42 @@
|
||||
#!/usr/bin/python
|
||||
|
||||
'''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
|
||||
nanopb_version = "nanopb-0.2.4"
|
||||
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:
|
||||
import google.protobuf.descriptor_pb2 as descriptor
|
||||
import google.protobuf.text_format as text_format
|
||||
except:
|
||||
print
|
||||
print "*************************************************************"
|
||||
print "*** Could not import the Google protobuf Python libraries ***"
|
||||
print "*** Try installing package 'python-protobuf' or similar. ***"
|
||||
print "*************************************************************"
|
||||
print
|
||||
sys.stderr.write('''
|
||||
*************************************************************
|
||||
*** Could not import the Google protobuf Python libraries ***
|
||||
*** Try installing package 'python-protobuf' or similar. ***
|
||||
*************************************************************
|
||||
''' + '\n')
|
||||
raise
|
||||
|
||||
try:
|
||||
import nanopb_pb2
|
||||
import proto.nanopb_pb2 as nanopb_pb2
|
||||
import proto.descriptor_pb2 as descriptor
|
||||
except:
|
||||
print
|
||||
print "***************************************************************"
|
||||
print "*** Could not import the precompiled nanopb_pb2.py. ***"
|
||||
print "*** Run 'make' in the 'generator' folder to update the file.***"
|
||||
print "***************************************************************"
|
||||
print
|
||||
sys.stderr.write('''
|
||||
********************************************************************
|
||||
*** Failed to import the protocol definitions for generator. ***
|
||||
*** You have to run 'make' in the nanopb/generator/proto folder. ***
|
||||
********************************************************************
|
||||
''' + '\n')
|
||||
raise
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Generation of single fields
|
||||
# ---------------------------------------------------------------------------
|
||||
@@ -46,7 +52,7 @@ datatypes = {
|
||||
FieldD.TYPE_FIXED32: ('uint32_t', 'FIXED32', 4),
|
||||
FieldD.TYPE_FIXED64: ('uint64_t', 'FIXED64', 8),
|
||||
FieldD.TYPE_FLOAT: ('float', 'FLOAT', 4),
|
||||
FieldD.TYPE_INT32: ('int32_t', 'INT32', 5),
|
||||
FieldD.TYPE_INT32: ('int32_t', 'INT32', 10),
|
||||
FieldD.TYPE_INT64: ('int64_t', 'INT64', 10),
|
||||
FieldD.TYPE_SFIXED32: ('int32_t', 'SFIXED32', 4),
|
||||
FieldD.TYPE_SFIXED64: ('int64_t', 'SFIXED64', 8),
|
||||
@@ -189,6 +195,34 @@ class Field:
|
||||
else:
|
||||
raise NotImplementedError(desc.label)
|
||||
|
||||
# Check if the field can be implemented with static allocation
|
||||
# i.e. whether the data size is known.
|
||||
if desc.type == FieldD.TYPE_STRING and self.max_size is None:
|
||||
can_be_static = False
|
||||
|
||||
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 can_be_static:
|
||||
field_options.type = nanopb_pb2.FT_STATIC
|
||||
else:
|
||||
field_options.type = nanopb_pb2.FT_CALLBACK
|
||||
|
||||
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)
|
||||
|
||||
if field_options.type == nanopb_pb2.FT_STATIC:
|
||||
self.allocation = 'STATIC'
|
||||
elif field_options.type == nanopb_pb2.FT_POINTER:
|
||||
self.allocation = 'POINTER'
|
||||
elif field_options.type == nanopb_pb2.FT_CALLBACK:
|
||||
self.allocation = 'CALLBACK'
|
||||
else:
|
||||
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]
|
||||
@@ -200,19 +234,18 @@ class Field:
|
||||
self.enc_size = 5 # protoc rejects enum values > 32 bits
|
||||
elif desc.type == FieldD.TYPE_STRING:
|
||||
self.pbtype = 'STRING'
|
||||
if self.max_size is None:
|
||||
can_be_static = False
|
||||
else:
|
||||
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.max_size is None:
|
||||
can_be_static = False
|
||||
else:
|
||||
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)
|
||||
@@ -220,35 +253,31 @@ class Field:
|
||||
else:
|
||||
raise NotImplementedError(desc.type)
|
||||
|
||||
if field_options.type == nanopb_pb2.FT_DEFAULT:
|
||||
if can_be_static:
|
||||
field_options.type = nanopb_pb2.FT_STATIC
|
||||
else:
|
||||
field_options.type = nanopb_pb2.FT_CALLBACK
|
||||
|
||||
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)
|
||||
|
||||
if field_options.type == nanopb_pb2.FT_STATIC:
|
||||
self.allocation = 'STATIC'
|
||||
elif field_options.type == nanopb_pb2.FT_CALLBACK:
|
||||
self.allocation = 'CALLBACK'
|
||||
self.ctype = 'pb_callback_t'
|
||||
self.array_decl = ''
|
||||
else:
|
||||
raise NotImplementedError(field_options.type)
|
||||
|
||||
def __cmp__(self, other):
|
||||
return cmp(self.tag, other.tag)
|
||||
|
||||
def __str__(self):
|
||||
if self.rules == 'OPTIONAL' and self.allocation == 'STATIC':
|
||||
result = ' bool has_' + self.name + ';\n'
|
||||
elif self.rules == 'REPEATED' and self.allocation == 'STATIC':
|
||||
result = ' size_t ' + self.name + '_count;\n'
|
||||
result = ''
|
||||
if self.allocation == 'POINTER':
|
||||
if self.rules == 'REPEATED':
|
||||
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:
|
||||
result = ''
|
||||
result += ' %s %s%s;' % (self.ctype, self.name, self.array_decl)
|
||||
if self.rules == 'OPTIONAL' and self.allocation == 'STATIC':
|
||||
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
|
||||
|
||||
def types(self):
|
||||
@@ -303,7 +332,7 @@ class Field:
|
||||
result = ' PB_FIELD2(%3d, ' % self.tag
|
||||
result += '%-8s, ' % self.pbtype
|
||||
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.name
|
||||
@@ -1002,7 +1031,14 @@ def main_cli():
|
||||
def main_plugin():
|
||||
'''Main function when invoked as a protoc plugin.'''
|
||||
|
||||
import plugin_pb2
|
||||
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)
|
||||
|
||||
@@ -1034,7 +1070,7 @@ def main_plugin():
|
||||
|
||||
if __name__ == '__main__':
|
||||
# Check if we are running as a plugin under protoc
|
||||
if 'protoc-gen-' in sys.argv[0]:
|
||||
if 'protoc-gen-' in sys.argv[0] or '--protoc-plugin' in sys.argv:
|
||||
main_plugin()
|
||||
else:
|
||||
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)
|
||||
@@ -1,161 +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='plugin.proto',
|
||||
package='google.protobuf.compiler',
|
||||
serialized_pb='\n\x0cplugin.proto\x12\x18google.protobuf.compiler\x1a google/protobuf/descriptor.proto\"}\n\x14\x43odeGeneratorRequest\x12\x18\n\x10\x66ile_to_generate\x18\x01 \x03(\t\x12\x11\n\tparameter\x18\x02 \x01(\t\x12\x38\n\nproto_file\x18\x0f \x03(\x0b\x32$.google.protobuf.FileDescriptorProto\"\xaa\x01\n\x15\x43odeGeneratorResponse\x12\r\n\x05\x65rror\x18\x01 \x01(\t\x12\x42\n\x04\x66ile\x18\x0f \x03(\x0b\x32\x34.google.protobuf.compiler.CodeGeneratorResponse.File\x1a>\n\x04\x46ile\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x17\n\x0finsertion_point\x18\x02 \x01(\t\x12\x0f\n\x07\x63ontent\x18\x0f \x01(\t')
|
||||
|
||||
|
||||
|
||||
|
||||
_CODEGENERATORREQUEST = descriptor.Descriptor(
|
||||
name='CodeGeneratorRequest',
|
||||
full_name='google.protobuf.compiler.CodeGeneratorRequest',
|
||||
filename=None,
|
||||
file=DESCRIPTOR,
|
||||
containing_type=None,
|
||||
fields=[
|
||||
descriptor.FieldDescriptor(
|
||||
name='file_to_generate', full_name='google.protobuf.compiler.CodeGeneratorRequest.file_to_generate', index=0,
|
||||
number=1, type=9, cpp_type=9, label=3,
|
||||
has_default_value=False, default_value=[],
|
||||
message_type=None, enum_type=None, containing_type=None,
|
||||
is_extension=False, extension_scope=None,
|
||||
options=None),
|
||||
descriptor.FieldDescriptor(
|
||||
name='parameter', full_name='google.protobuf.compiler.CodeGeneratorRequest.parameter', index=1,
|
||||
number=2, type=9, cpp_type=9, label=1,
|
||||
has_default_value=False, default_value=unicode("", "utf-8"),
|
||||
message_type=None, enum_type=None, containing_type=None,
|
||||
is_extension=False, extension_scope=None,
|
||||
options=None),
|
||||
descriptor.FieldDescriptor(
|
||||
name='proto_file', full_name='google.protobuf.compiler.CodeGeneratorRequest.proto_file', index=2,
|
||||
number=15, type=11, cpp_type=10, label=3,
|
||||
has_default_value=False, default_value=[],
|
||||
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=76,
|
||||
serialized_end=201,
|
||||
)
|
||||
|
||||
|
||||
_CODEGENERATORRESPONSE_FILE = descriptor.Descriptor(
|
||||
name='File',
|
||||
full_name='google.protobuf.compiler.CodeGeneratorResponse.File',
|
||||
filename=None,
|
||||
file=DESCRIPTOR,
|
||||
containing_type=None,
|
||||
fields=[
|
||||
descriptor.FieldDescriptor(
|
||||
name='name', full_name='google.protobuf.compiler.CodeGeneratorResponse.File.name', index=0,
|
||||
number=1, type=9, cpp_type=9, label=1,
|
||||
has_default_value=False, default_value=unicode("", "utf-8"),
|
||||
message_type=None, enum_type=None, containing_type=None,
|
||||
is_extension=False, extension_scope=None,
|
||||
options=None),
|
||||
descriptor.FieldDescriptor(
|
||||
name='insertion_point', full_name='google.protobuf.compiler.CodeGeneratorResponse.File.insertion_point', index=1,
|
||||
number=2, type=9, cpp_type=9, label=1,
|
||||
has_default_value=False, default_value=unicode("", "utf-8"),
|
||||
message_type=None, enum_type=None, containing_type=None,
|
||||
is_extension=False, extension_scope=None,
|
||||
options=None),
|
||||
descriptor.FieldDescriptor(
|
||||
name='content', full_name='google.protobuf.compiler.CodeGeneratorResponse.File.content', index=2,
|
||||
number=15, type=9, cpp_type=9, label=1,
|
||||
has_default_value=False, default_value=unicode("", "utf-8"),
|
||||
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=312,
|
||||
serialized_end=374,
|
||||
)
|
||||
|
||||
_CODEGENERATORRESPONSE = descriptor.Descriptor(
|
||||
name='CodeGeneratorResponse',
|
||||
full_name='google.protobuf.compiler.CodeGeneratorResponse',
|
||||
filename=None,
|
||||
file=DESCRIPTOR,
|
||||
containing_type=None,
|
||||
fields=[
|
||||
descriptor.FieldDescriptor(
|
||||
name='error', full_name='google.protobuf.compiler.CodeGeneratorResponse.error', index=0,
|
||||
number=1, type=9, cpp_type=9, label=1,
|
||||
has_default_value=False, default_value=unicode("", "utf-8"),
|
||||
message_type=None, enum_type=None, containing_type=None,
|
||||
is_extension=False, extension_scope=None,
|
||||
options=None),
|
||||
descriptor.FieldDescriptor(
|
||||
name='file', full_name='google.protobuf.compiler.CodeGeneratorResponse.file', index=1,
|
||||
number=15, type=11, cpp_type=10, label=3,
|
||||
has_default_value=False, default_value=[],
|
||||
message_type=None, enum_type=None, containing_type=None,
|
||||
is_extension=False, extension_scope=None,
|
||||
options=None),
|
||||
],
|
||||
extensions=[
|
||||
],
|
||||
nested_types=[_CODEGENERATORRESPONSE_FILE, ],
|
||||
enum_types=[
|
||||
],
|
||||
options=None,
|
||||
is_extendable=False,
|
||||
extension_ranges=[],
|
||||
serialized_start=204,
|
||||
serialized_end=374,
|
||||
)
|
||||
|
||||
_CODEGENERATORREQUEST.fields_by_name['proto_file'].message_type = google.protobuf.descriptor_pb2._FILEDESCRIPTORPROTO
|
||||
_CODEGENERATORRESPONSE_FILE.containing_type = _CODEGENERATORRESPONSE;
|
||||
_CODEGENERATORRESPONSE.fields_by_name['file'].message_type = _CODEGENERATORRESPONSE_FILE
|
||||
DESCRIPTOR.message_types_by_name['CodeGeneratorRequest'] = _CODEGENERATORREQUEST
|
||||
DESCRIPTOR.message_types_by_name['CodeGeneratorResponse'] = _CODEGENERATORRESPONSE
|
||||
|
||||
class CodeGeneratorRequest(message.Message):
|
||||
__metaclass__ = reflection.GeneratedProtocolMessageType
|
||||
DESCRIPTOR = _CODEGENERATORREQUEST
|
||||
|
||||
# @@protoc_insertion_point(class_scope:google.protobuf.compiler.CodeGeneratorRequest)
|
||||
|
||||
class CodeGeneratorResponse(message.Message):
|
||||
__metaclass__ = reflection.GeneratedProtocolMessageType
|
||||
|
||||
class File(message.Message):
|
||||
__metaclass__ = reflection.GeneratedProtocolMessageType
|
||||
DESCRIPTOR = _CODEGENERATORRESPONSE_FILE
|
||||
|
||||
# @@protoc_insertion_point(class_scope:google.protobuf.compiler.CodeGeneratorResponse.File)
|
||||
DESCRIPTOR = _CODEGENERATORRESPONSE
|
||||
|
||||
# @@protoc_insertion_point(class_scope:google.protobuf.compiler.CodeGeneratorResponse)
|
||||
|
||||
# @@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=. $<
|
||||
0
generator/proto/__init__.py
Normal file
0
generator/proto/__init__.py
Normal file
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
|
||||
// for memory-limited environments.
|
||||
|
||||
import "google/protobuf/descriptor.proto";
|
||||
import "descriptor.proto";
|
||||
|
||||
option java_package = "fi.kapsi.koti.jpa.nanopb";
|
||||
|
||||
enum FieldType {
|
||||
FT_DEFAULT = 0; // Automatically decide field type, generate static field if possible.
|
||||
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_IGNORE = 3; // Ignore the field completely.
|
||||
}
|
||||
@@ -46,7 +46,7 @@
|
||||
|
||||
package google.protobuf.compiler;
|
||||
|
||||
import "google/protobuf/descriptor.proto";
|
||||
import "descriptor.proto";
|
||||
|
||||
// An encoded CodeGeneratorRequest is written to the plugin's stdin.
|
||||
message CodeGeneratorRequest {
|
||||
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
|
||||
59
pb.h
59
pb.h
@@ -43,7 +43,7 @@
|
||||
|
||||
/* Version of the nanopb library. Just in case you want to check it in
|
||||
* your own program. */
|
||||
#define NANOPB_VERSION nanopb-0.2.4
|
||||
#define NANOPB_VERSION nanopb-0.2.5
|
||||
|
||||
/* Include all the system headers needed by nanopb. You will need the
|
||||
* definitions of the following:
|
||||
@@ -116,11 +116,6 @@
|
||||
/* List of possible field types. These are used in the autogenerated code.
|
||||
* Least-significant 4 bits tell the scalar type
|
||||
* 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;
|
||||
@@ -128,32 +123,33 @@ typedef uint8_t pb_type_t;
|
||||
/**** Field data types ****/
|
||||
|
||||
/* Numeric types */
|
||||
#define PB_LTYPE_VARINT 0x00 /* int32, uint32, int64, uint64, bool, enum */
|
||||
#define PB_LTYPE_SVARINT 0x01 /* sint32, sint64 */
|
||||
#define PB_LTYPE_FIXED32 0x02 /* fixed32, sfixed32, float */
|
||||
#define PB_LTYPE_FIXED64 0x03 /* fixed64, sfixed64, double */
|
||||
#define PB_LTYPE_VARINT 0x00 /* int32, int64, enum, bool */
|
||||
#define PB_LTYPE_UVARINT 0x01 /* uint32, uint64 */
|
||||
#define PB_LTYPE_SVARINT 0x02 /* sint32, sint64 */
|
||||
#define PB_LTYPE_FIXED32 0x03 /* fixed32, sfixed32, float */
|
||||
#define PB_LTYPE_FIXED64 0x04 /* fixed64, sfixed64, double */
|
||||
|
||||
/* Marker for last packable field type. */
|
||||
#define PB_LTYPE_LAST_PACKABLE 0x03
|
||||
#define PB_LTYPE_LAST_PACKABLE 0x04
|
||||
|
||||
/* Byte array with pre-allocated buffer.
|
||||
* 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.
|
||||
* data_size is the maximum length. */
|
||||
#define PB_LTYPE_STRING 0x05
|
||||
#define PB_LTYPE_STRING 0x06
|
||||
|
||||
/* Submessage
|
||||
* 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 0x07
|
||||
#define PB_LTYPE_EXTENSION 0x08
|
||||
|
||||
/* Number of declared LTYPES */
|
||||
#define PB_LTYPES_COUNT 8
|
||||
#define PB_LTYPES_COUNT 9
|
||||
#define PB_LTYPE_MASK 0x0F
|
||||
|
||||
/**** Field repetition rules ****/
|
||||
@@ -166,6 +162,7 @@ typedef uint8_t pb_type_t;
|
||||
/**** Field allocation types ****/
|
||||
|
||||
#define PB_ATYPE_STATIC 0x00
|
||||
#define PB_ATYPE_POINTER 0x80
|
||||
#define PB_ATYPE_CALLBACK 0x40
|
||||
#define PB_ATYPE_MASK 0xC0
|
||||
|
||||
@@ -231,9 +228,17 @@ struct _pb_bytes_array_t {
|
||||
size_t size;
|
||||
uint8_t bytes[1];
|
||||
};
|
||||
|
||||
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.
|
||||
* It is stored in the message structure and filled in by the method that
|
||||
* calls pb_decode.
|
||||
@@ -370,6 +375,22 @@ struct _pb_extension_t {
|
||||
pb_membersize(st, m[0]), \
|
||||
pb_arraysize(st, m), ptr}
|
||||
|
||||
/* Allocated fields carry the size of the actual data, not the pointer */
|
||||
#define PB_REQUIRED_POINTER(tag, st, m, fd, ltype, ptr) \
|
||||
{tag, PB_ATYPE_POINTER | PB_HTYPE_REQUIRED | ltype, \
|
||||
fd, 0, pb_membersize(st, m[0]), 0, 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, \
|
||||
@@ -410,8 +431,8 @@ struct _pb_extension_t {
|
||||
#define PB_LTYPE_MAP_SINT32 PB_LTYPE_SVARINT
|
||||
#define PB_LTYPE_MAP_SINT64 PB_LTYPE_SVARINT
|
||||
#define PB_LTYPE_MAP_STRING PB_LTYPE_STRING
|
||||
#define PB_LTYPE_MAP_UINT32 PB_LTYPE_VARINT
|
||||
#define PB_LTYPE_MAP_UINT64 PB_LTYPE_VARINT
|
||||
#define PB_LTYPE_MAP_UINT32 PB_LTYPE_UVARINT
|
||||
#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.
|
||||
|
||||
50
pb_decode.c
50
pb_decode.c
@@ -47,7 +47,8 @@ static bool checkreturn default_extension_decoder(pb_istream_t *stream, pb_exten
|
||||
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 pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest);
|
||||
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);
|
||||
@@ -62,6 +63,7 @@ static bool checkreturn pb_skip_string(pb_istream_t *stream);
|
||||
*/
|
||||
static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
|
||||
&pb_dec_varint,
|
||||
&pb_dec_uvarint,
|
||||
&pb_dec_svarint,
|
||||
&pb_dec_fixed32,
|
||||
&pb_dec_fixed64,
|
||||
@@ -124,6 +126,26 @@ bool checkreturn pb_read(pb_istream_t *stream, uint8_t *buf, size_t count)
|
||||
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 stream;
|
||||
@@ -149,7 +171,7 @@ static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest)
|
||||
uint8_t byte;
|
||||
uint32_t result;
|
||||
|
||||
if (!pb_read(stream, &byte, 1))
|
||||
if (!pb_readbyte(stream, &byte))
|
||||
return false;
|
||||
|
||||
if (!(byte & 0x80))
|
||||
@@ -168,7 +190,7 @@ static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest)
|
||||
if (bitpos >= 32)
|
||||
PB_RETURN_ERROR(stream, "varint overflow");
|
||||
|
||||
if (!pb_read(stream, &byte, 1))
|
||||
if (!pb_readbyte(stream, &byte))
|
||||
return false;
|
||||
|
||||
result |= (uint32_t)(byte & 0x7F) << bitpos;
|
||||
@@ -191,7 +213,7 @@ bool checkreturn pb_decode_varint(pb_istream_t *stream, uint64_t *dest)
|
||||
if (bitpos >= 64)
|
||||
PB_RETURN_ERROR(stream, "varint overflow");
|
||||
|
||||
if (!pb_read(stream, &byte, 1))
|
||||
if (!pb_readbyte(stream, &byte))
|
||||
return false;
|
||||
|
||||
result |= (uint64_t)(byte & 0x7F) << bitpos;
|
||||
@@ -803,8 +825,24 @@ bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, vo
|
||||
|
||||
switch (field->data_size)
|
||||
{
|
||||
case 1: *(uint8_t*)dest = (uint8_t)value; break;
|
||||
case 2: *(uint16_t*)dest = (uint16_t)value; break;
|
||||
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)
|
||||
{
|
||||
case 4: *(uint32_t*)dest = (uint32_t)value; break;
|
||||
case 8: *(uint64_t*)dest = value; break;
|
||||
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
||||
|
||||
109
pb_encode.c
109
pb_encode.c
@@ -28,6 +28,7 @@ static bool checkreturn encode_field(pb_ostream_t *stream, const pb_field_t *fie
|
||||
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);
|
||||
@@ -40,6 +41,7 @@ static bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t
|
||||
*/
|
||||
static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
|
||||
&pb_enc_varint,
|
||||
&pb_enc_uvarint,
|
||||
&pb_enc_svarint,
|
||||
&pb_enc_fixed32,
|
||||
&pb_enc_fixed64,
|
||||
@@ -116,8 +118,8 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
|
||||
|
||||
if (count == 0)
|
||||
return true;
|
||||
|
||||
if (count > field->array_size)
|
||||
|
||||
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. */
|
||||
@@ -170,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))
|
||||
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;
|
||||
}
|
||||
}
|
||||
@@ -179,25 +195,38 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
|
||||
return true;
|
||||
}
|
||||
|
||||
/* Encode a field with static allocation, i.e. one whose data is stored
|
||||
* in the structure itself. */
|
||||
static bool checkreturn encode_static_field(pb_ostream_t *stream,
|
||||
/* 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;
|
||||
const void *pSize;
|
||||
bool dummy = true;
|
||||
bool implicit_has = true;
|
||||
|
||||
func = PB_ENCODERS[PB_LTYPE(field->type)];
|
||||
|
||||
if (field->size_offset)
|
||||
pSize = (const char*)pData + field->size_offset;
|
||||
else
|
||||
pSize = &dummy;
|
||||
|
||||
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))
|
||||
{
|
||||
case PB_HTYPE_REQUIRED:
|
||||
if (!pData)
|
||||
PB_RETURN_ERROR(stream, "missing required field");
|
||||
if (!pb_encode_tag_for_field(stream, field))
|
||||
return false;
|
||||
if (!func(stream, field, pData))
|
||||
@@ -255,7 +284,8 @@ static bool checkreturn encode_field(pb_ostream_t *stream,
|
||||
switch (PB_ATYPE(field->type))
|
||||
{
|
||||
case PB_ATYPE_STATIC:
|
||||
return encode_static_field(stream, field, pData);
|
||||
case PB_ATYPE_POINTER:
|
||||
return encode_basic_field(stream, field, pData);
|
||||
|
||||
case PB_ATYPE_CALLBACK:
|
||||
return encode_callback_field(stream, field, pData);
|
||||
@@ -312,7 +342,10 @@ bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], cons
|
||||
while (field->tag != 0)
|
||||
{
|
||||
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 */
|
||||
if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
|
||||
@@ -424,6 +457,7 @@ bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t
|
||||
switch (PB_LTYPE(field->type))
|
||||
{
|
||||
case PB_LTYPE_VARINT:
|
||||
case PB_LTYPE_UVARINT:
|
||||
case PB_LTYPE_SVARINT:
|
||||
wiretype = PB_WT_VARINT;
|
||||
break;
|
||||
@@ -465,7 +499,12 @@ bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fie
|
||||
bool status;
|
||||
|
||||
if (!pb_encode(&substream, fields, src_struct))
|
||||
{
|
||||
#ifndef PB_NO_ERRMSG
|
||||
stream->errmsg = substream.errmsg;
|
||||
#endif
|
||||
return false;
|
||||
}
|
||||
|
||||
size = substream.bytes_written;
|
||||
|
||||
@@ -505,13 +544,29 @@ bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fie
|
||||
/* Field encoders */
|
||||
|
||||
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;
|
||||
|
||||
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 8: value = *(const uint64_t*)src; break;
|
||||
default: PB_RETURN_ERROR(stream, "invalid data_size");
|
||||
@@ -548,20 +603,32 @@ 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)
|
||||
{
|
||||
const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)src;
|
||||
if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
|
||||
{
|
||||
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");
|
||||
|
||||
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);
|
||||
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)
|
||||
{
|
||||
/* strnlen() is not always available, so just use a for-loop */
|
||||
/* strnlen() is not always available, so just use a loop */
|
||||
size_t size = 0;
|
||||
size_t max_size = field->data_size;
|
||||
const char *p = (const char*)src;
|
||||
while (size < field->data_size && *p != '\0')
|
||||
|
||||
if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
|
||||
max_size = (size_t)-1;
|
||||
|
||||
while (size < max_size && *p != '\0')
|
||||
{
|
||||
size++;
|
||||
p++;
|
||||
|
||||
@@ -14,7 +14,7 @@ scons CC=clang CXX=clang++
|
||||
''')
|
||||
|
||||
import os
|
||||
env = Environment(ENV = os.environ)
|
||||
env = Environment(ENV = os.environ, tools = ['default', 'nanopb'])
|
||||
|
||||
# Allow overriding the compiler with scons CC=???
|
||||
if 'CC' in ARGUMENTS: env.Replace(CC = ARGUMENTS['CC'])
|
||||
@@ -26,14 +26,24 @@ if 'CXXFLAGS' in ARGUMENTS: env.Append(CCFLAGS = ARGUMENTS['CXXFLAGS'])
|
||||
add_nanopb_builders(env)
|
||||
|
||||
# Path to the files shared by tests, and to the nanopb core.
|
||||
env.Append(CPPPATH = ["#../", "#common"])
|
||||
env.Append(CPPPATH = ["#../", "$COMMON"])
|
||||
|
||||
# Path for finding nanopb.proto
|
||||
env.Append(PROTOCPATH = '#../generator')
|
||||
|
||||
# Check the compilation environment, unless we are just cleaning up.
|
||||
if not env.GetOption('clean'):
|
||||
conf = Configure(env)
|
||||
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')
|
||||
@@ -42,7 +52,7 @@ if not env.GetOption('clean'):
|
||||
string = conf.CheckCHeader('string.h')
|
||||
if not stdbool or not stdint or not stddef or not string:
|
||||
conf.env.Append(CPPDEFINES = {'PB_SYSTEM_HEADER': '\\"pb_syshdr.h\\"'})
|
||||
conf.env.Append(CPPPATH = "#../compat")
|
||||
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})
|
||||
@@ -62,6 +72,14 @@ if not env.GetOption('clean'):
|
||||
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()
|
||||
|
||||
@@ -71,15 +89,11 @@ if 'gcc' in env['CC']:
|
||||
|
||||
# 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')
|
||||
|
||||
# More strict checks on the nanopb core
|
||||
env.Append(CORECFLAGS = '-Wextra -Wcast-qual -Wlogical-op -Wconversion')
|
||||
env.Append(CORECFLAGS = ' -Wmissing-prototypes -Wmissing-declarations -Wredundant-decls')
|
||||
env.Append(CORECFLAGS = ' -Wstack-protector')
|
||||
elif 'clang' in env['CC']:
|
||||
# CLang
|
||||
env.Append(CFLAGS = '-ansi -g -O0 -Wall -Werror')
|
||||
@@ -110,5 +124,10 @@ elif 'cl' in env['CXX']:
|
||||
env.Append(CXXFLAGS = '/Zi /W2 /WX')
|
||||
|
||||
# Now include the SConscript files from all subdirectories
|
||||
SConscript(Glob('*/SConscript'), exports = 'env')
|
||||
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)))
|
||||
|
||||
|
||||
@@ -3,10 +3,33 @@
|
||||
|
||||
Import("env")
|
||||
|
||||
env.NanopbProto("alltypes")
|
||||
enc = env.Program(["encode_alltypes.c", "alltypes.pb.c", "#common/pb_encode.o"])
|
||||
dec = env.Program(["decode_alltypes.c", "alltypes.pb.c", "#common/pb_decode.o"])
|
||||
env.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 {
|
||||
Zero = 0;
|
||||
First = 1;
|
||||
@@ -39,26 +57,26 @@ message AllTypes {
|
||||
required EmptyMessage req_emptymsg = 18;
|
||||
|
||||
|
||||
repeated int32 rep_int32 = 21;
|
||||
repeated int64 rep_int64 = 22;
|
||||
repeated uint32 rep_uint32 = 23;
|
||||
repeated uint64 rep_uint64 = 24;
|
||||
repeated sint32 rep_sint32 = 25;
|
||||
repeated sint64 rep_sint64 = 26;
|
||||
repeated bool rep_bool = 27;
|
||||
repeated int32 rep_int32 = 21 [packed = true];
|
||||
repeated int64 rep_int64 = 22 [packed = true];
|
||||
repeated uint32 rep_uint32 = 23 [packed = true];
|
||||
repeated uint64 rep_uint64 = 24 [packed = true];
|
||||
repeated sint32 rep_sint32 = 25 [packed = true];
|
||||
repeated sint64 rep_sint64 = 26 [packed = true];
|
||||
repeated bool rep_bool = 27 [packed = true];
|
||||
|
||||
repeated fixed32 rep_fixed32 = 28;
|
||||
repeated sfixed32 rep_sfixed32= 29;
|
||||
repeated float rep_float = 30;
|
||||
repeated fixed32 rep_fixed32 = 28 [packed = true];
|
||||
repeated sfixed32 rep_sfixed32= 29 [packed = true];
|
||||
repeated float rep_float = 30 [packed = true];
|
||||
|
||||
repeated fixed64 rep_fixed64 = 31;
|
||||
repeated sfixed64 rep_sfixed64= 32;
|
||||
repeated double rep_double = 33;
|
||||
repeated fixed64 rep_fixed64 = 31 [packed = true];
|
||||
repeated sfixed64 rep_sfixed64= 32 [packed = true];
|
||||
repeated double rep_double = 33 [packed = true];
|
||||
|
||||
repeated string rep_string = 34;
|
||||
repeated bytes rep_bytes = 35;
|
||||
repeated SubMessage rep_submsg = 36;
|
||||
repeated MyEnum rep_enum = 37;
|
||||
repeated MyEnum rep_enum = 37 [packed = true];
|
||||
repeated EmptyMessage rep_emptymsg = 38;
|
||||
|
||||
optional int32 opt_int32 = 41 [default = 4041];
|
||||
@@ -83,6 +101,9 @@ message AllTypes {
|
||||
optional MyEnum opt_enum = 57 [default = Second];
|
||||
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
|
||||
// properly, i.e. otherwise a bug in last field might not be detected.
|
||||
required int32 end = 99;
|
||||
|
||||
@@ -170,6 +170,17 @@ bool check_alltypes(pb_istream_t *stream, int mode)
|
||||
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);
|
||||
|
||||
return true;
|
||||
|
||||
@@ -67,6 +67,17 @@ int main(int argc, char **argv)
|
||||
alltypes.rep_enum_count = 5; alltypes.rep_enum[4] = MyEnum_Truth;
|
||||
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)
|
||||
{
|
||||
/* Fill in values for optional fields */
|
||||
|
||||
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 */
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
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"])
|
||||
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"])
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
#include <stdlib.h>
|
||||
#include <pb_decode.h>
|
||||
#include "alltypes_legacy.h"
|
||||
#include "test_helpers.h"
|
||||
|
||||
#define TEST(x) if (!(x)) { \
|
||||
printf("Test " #x " failed.\n"); \
|
||||
@@ -176,15 +177,19 @@ bool check_alltypes(pb_istream_t *stream, int mode)
|
||||
|
||||
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. */
|
||||
int mode = (argc > 1) ? atoi(argv[1]) : 0;
|
||||
|
||||
/* Read the data into buffer */
|
||||
uint8_t buffer[1024];
|
||||
size_t count = fread(buffer, 1, sizeof(buffer), stdin);
|
||||
SET_BINARY_MODE(stdin);
|
||||
count = fread(buffer, 1, sizeof(buffer), stdin);
|
||||
|
||||
/* Construct a pb_istream_t for reading from the buffer */
|
||||
pb_istream_t stream = pb_istream_from_buffer(buffer, count);
|
||||
stream = pb_istream_from_buffer(buffer, count);
|
||||
|
||||
/* Decode and print out the stuff */
|
||||
if (!check_alltypes(&stream, mode))
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
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"])
|
||||
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.Decode(["encode_buffer.output", "$COMMON/person.proto"], MESSAGE = "Person")
|
||||
env.Compare(["decode_buffer.output", "encode_buffer.decoded"])
|
||||
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
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"])
|
||||
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.Decode(["encode_stream.output", "$COMMON/person.proto"], MESSAGE = "Person")
|
||||
env.Compare(["decode_stream.output", "encode_stream.decoded"])
|
||||
|
||||
|
||||
@@ -6,10 +6,10 @@ Import("env")
|
||||
c = Copy("$TARGET", "$SOURCE")
|
||||
env.Command("pb_encode.c", "#../pb_encode.c", c)
|
||||
env.Command("pb_decode.c", "#../pb_decode.c", c)
|
||||
env.Command("alltypes.pb.h", "#alltypes/alltypes.pb.h", c)
|
||||
env.Command("alltypes.pb.c", "#alltypes/alltypes.pb.c", c)
|
||||
env.Command("encode_alltypes.c", "#alltypes/encode_alltypes.c", c)
|
||||
env.Command("decode_alltypes.c", "#alltypes/decode_alltypes.c", c)
|
||||
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()
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
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"])
|
||||
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"])
|
||||
|
||||
@@ -12,6 +12,6 @@ env.NanopbProto("person")
|
||||
# These are built using more strict warning flags.
|
||||
strict = env.Clone()
|
||||
strict.Append(CFLAGS = strict['CORECFLAGS'])
|
||||
strict.Object("pb_decode.o", "#../pb_decode.c")
|
||||
strict.Object("pb_encode.o", "#../pb_encode.c")
|
||||
strict.Object("pb_decode.o", "$NANOPB/pb_decode.c")
|
||||
strict.Object("pb_encode.o", "$NANOPB/pb_encode.c")
|
||||
|
||||
|
||||
@@ -3,14 +3,18 @@
|
||||
|
||||
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", "#alltypes/alltypes.pb.h", c)
|
||||
env.Command("alltypes.pb.cxx", "#alltypes/alltypes.pb.c", c)
|
||||
env.Command("encode_alltypes.cxx", "#alltypes/encode_alltypes.c", c)
|
||||
env.Command("decode_alltypes.cxx", "#alltypes/decode_alltypes.c", c)
|
||||
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"])
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Import('env')
|
||||
p = env.Program(["decode_unittests.c", "#common/unittestproto.pb.c"])
|
||||
p = env.Program(["decode_unittests.c", "$COMMON/unittestproto.pb.c"])
|
||||
env.RunTest(p)
|
||||
|
||||
|
||||
@@ -1,5 +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"])
|
||||
p = env.Program(["encode_unittests.c", "$COMMON/unittestproto.pb.c"])
|
||||
env.RunTest(p)
|
||||
|
||||
@@ -4,12 +4,12 @@ Import("env")
|
||||
|
||||
# We use the files from the alltypes test case
|
||||
incpath = env.Clone()
|
||||
incpath.Append(PROTOCPATH = '#alltypes')
|
||||
incpath.Append(CPPPATH = '#alltypes')
|
||||
incpath.Append(PROTOCPATH = '$BUILD/alltypes')
|
||||
incpath.Append(CPPPATH = '$BUILD/alltypes')
|
||||
|
||||
incpath.NanopbProto("extensions")
|
||||
enc = incpath.Program(["encode_extensions.c", "extensions.pb.c", "#alltypes/alltypes.pb$OBJSUFFIX", "#common/pb_encode.o"])
|
||||
dec = incpath.Program(["decode_extensions.c", "extensions.pb.c", "#alltypes/alltypes.pb$OBJSUFFIX", "#common/pb_decode.o"])
|
||||
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"])
|
||||
|
||||
@@ -2,13 +2,15 @@
|
||||
|
||||
Import("env")
|
||||
|
||||
dec = env.GetBuildPath('#basic_buffer/${PROGPREFIX}decode_buffer${PROGSUFFIX}')
|
||||
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('#basic_stream/${PROGPREFIX}decode_stream${PROGSUFFIX}')
|
||||
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"])
|
||||
|
||||
dec2 = env.GetBuildPath('#alltypes/${PROGPREFIX}decode_alltypes${PROGSUFFIX}')
|
||||
# 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'])
|
||||
|
||||
@@ -7,10 +7,10 @@ Import("env")
|
||||
c = Copy("$TARGET", "$SOURCE")
|
||||
env.Command("pb_encode.c", "#../pb_encode.c", c)
|
||||
env.Command("pb_decode.c", "#../pb_decode.c", c)
|
||||
env.Command("encode_alltypes.c", "#alltypes/encode_alltypes.c", c)
|
||||
env.Command("decode_alltypes.c", "#alltypes/decode_alltypes.c", c)
|
||||
env.Command("encode_alltypes.c", "$BUILD/alltypes/encode_alltypes.c", c)
|
||||
env.Command("decode_alltypes.c", "$BUILD/alltypes/decode_alltypes.c", c)
|
||||
|
||||
env.NanopbProto("alltypes")
|
||||
env.NanopbProto(["alltypes", "alltypes.options"])
|
||||
|
||||
# Define the compilation options
|
||||
opts = env.Clone()
|
||||
|
||||
@@ -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 {
|
||||
Zero = 0;
|
||||
First = 1;
|
||||
@@ -83,6 +101,9 @@ message AllTypes {
|
||||
optional MyEnum opt_enum = 10057 [default = Second];
|
||||
optional EmptyMessage opt_emptymsg = 10058;
|
||||
|
||||
// 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
|
||||
// properly, i.e. otherwise a bug in last field might not be detected.
|
||||
required int32 end = 10099;
|
||||
|
||||
@@ -7,10 +7,10 @@ Import("env")
|
||||
c = Copy("$TARGET", "$SOURCE")
|
||||
env.Command("pb_encode.c", "#../pb_encode.c", c)
|
||||
env.Command("pb_decode.c", "#../pb_decode.c", c)
|
||||
env.Command("encode_alltypes.c", "#alltypes/encode_alltypes.c", c)
|
||||
env.Command("decode_alltypes.c", "#alltypes/decode_alltypes.c", c)
|
||||
env.Command("encode_alltypes.c", "$BUILD/alltypes/encode_alltypes.c", c)
|
||||
env.Command("decode_alltypes.c", "$BUILD/alltypes/decode_alltypes.c", c)
|
||||
|
||||
env.NanopbProto("alltypes")
|
||||
env.NanopbProto(["alltypes", "alltypes.options"])
|
||||
|
||||
# Define the compilation options
|
||||
opts = env.Clone()
|
||||
|
||||
@@ -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 {
|
||||
Zero = 0;
|
||||
First = 1;
|
||||
@@ -83,6 +101,9 @@ message AllTypes {
|
||||
optional MyEnum opt_enum = 10057 [default = Second];
|
||||
optional EmptyMessage opt_emptymsg = 10058;
|
||||
|
||||
// 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
|
||||
// properly, i.e. otherwise a bug in last field might not be detected.
|
||||
required int32 end = 13432099;
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
Import("env")
|
||||
|
||||
env.NanopbProto("missing_fields")
|
||||
test = env.Program(["missing_fields.c", "missing_fields.pb.c", "#common/pb_encode.o", "#common/pb_decode.o"])
|
||||
test = env.Program(["missing_fields.c", "missing_fields.pb.c", "$COMMON/pb_encode.o", "$COMMON/pb_decode.o"])
|
||||
env.RunTest(test)
|
||||
|
||||
|
||||
@@ -6,10 +6,10 @@ Import("env")
|
||||
c = Copy("$TARGET", "$SOURCE")
|
||||
env.Command("pb_encode.c", "#../pb_encode.c", c)
|
||||
env.Command("pb_decode.c", "#../pb_decode.c", c)
|
||||
env.Command("alltypes.pb.h", "#alltypes/alltypes.pb.h", c)
|
||||
env.Command("alltypes.pb.c", "#alltypes/alltypes.pb.c", c)
|
||||
env.Command("encode_alltypes.c", "#alltypes/encode_alltypes.c", c)
|
||||
env.Command("decode_alltypes.c", "#alltypes/decode_alltypes.c", c)
|
||||
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()
|
||||
|
||||
@@ -11,42 +11,6 @@ except ImportError:
|
||||
|
||||
def add_nanopb_builders(env):
|
||||
'''Add the necessary builder commands for nanopb tests.'''
|
||||
|
||||
# Build command for building .pb from .proto using protoc
|
||||
def proto_actions(source, target, env, for_signature):
|
||||
esc = env['ESCAPE']
|
||||
dirs = ' '.join(['-I' + esc(env.GetBuildPath(d)) for d in env['PROTOCPATH']])
|
||||
return '$PROTOC $PROTOCFLAGS %s -o%s %s' % (dirs, esc(str(target[0])), esc(str(source[0])))
|
||||
|
||||
proto_file_builder = Builder(generator = proto_actions,
|
||||
suffix = '.pb',
|
||||
src_suffix = '.proto')
|
||||
env.Append(BUILDERS = {'Proto': proto_file_builder})
|
||||
env.SetDefault(PROTOC = 'protoc')
|
||||
env.SetDefault(PROTOCPATH = ['.'])
|
||||
|
||||
# Build command for running nanopb generator
|
||||
import os.path
|
||||
def nanopb_targets(target, source, env):
|
||||
basename = os.path.splitext(str(source[0]))[0]
|
||||
target.append(basename + '.pb.h')
|
||||
return target, source
|
||||
|
||||
nanopb_file_builder = Builder(action = '$NANOPB_GENERATOR $NANOPB_FLAGS $SOURCE',
|
||||
suffix = '.pb.c',
|
||||
src_suffix = '.pb',
|
||||
emitter = nanopb_targets)
|
||||
env.Append(BUILDERS = {'Nanopb': nanopb_file_builder})
|
||||
gen_path = env['ESCAPE'](env.GetBuildPath("#../generator/nanopb_generator.py"))
|
||||
env.SetDefault(NANOPB_GENERATOR = 'python ' + gen_path)
|
||||
env.SetDefault(NANOPB_FLAGS = '-q')
|
||||
|
||||
# Combined method to run both protoc and nanopb generator
|
||||
def run_protoc_and_nanopb(env, source):
|
||||
b1 = env.Proto(source)
|
||||
b2 = env.Nanopb(source)
|
||||
return b1 + b2
|
||||
env.AddMethod(run_protoc_and_nanopb, "NanopbProto")
|
||||
|
||||
# Build command that runs a test program and saves the output
|
||||
def run_test(target, source, env):
|
||||
@@ -55,7 +19,11 @@ def add_nanopb_builders(env):
|
||||
else:
|
||||
infile = None
|
||||
|
||||
pipe = subprocess.Popen(str(source[0]),
|
||||
args = [str(source[0])]
|
||||
if env.has_key('ARGS'):
|
||||
args.extend(env['ARGS'])
|
||||
|
||||
pipe = subprocess.Popen(args,
|
||||
stdin = infile,
|
||||
stdout = open(str(target[0]), 'w'),
|
||||
stderr = sys.stderr)
|
||||
@@ -81,6 +49,17 @@ def add_nanopb_builders(env):
|
||||
suffix = '.decoded')
|
||||
env.Append(BUILDERS = {'Decode': decode_builder})
|
||||
|
||||
# Build command that encodes a message using protoc
|
||||
def encode_actions(source, target, env, for_signature):
|
||||
esc = env['ESCAPE']
|
||||
dirs = ' '.join(['-I' + esc(env.GetBuildPath(d)) for d in env['PROTOCPATH']])
|
||||
return '$PROTOC $PROTOCFLAGS %s --encode=%s %s <%s >%s' % (
|
||||
dirs, env['MESSAGE'], esc(str(source[1])), esc(str(source[0])), esc(str(target[0])))
|
||||
|
||||
encode_builder = Builder(generator = encode_actions,
|
||||
suffix = '.encoded')
|
||||
env.Append(BUILDERS = {'Encode': encode_builder})
|
||||
|
||||
# Build command that asserts that two files be equal
|
||||
def compare_files(target, source, env):
|
||||
data1 = open(str(source[0]), 'rb').read()
|
||||
|
||||
126
tests/site_scons/site_tools/nanopb.py
Normal file
126
tests/site_scons/site_tools/nanopb.py
Normal file
@@ -0,0 +1,126 @@
|
||||
'''
|
||||
Scons Builder for nanopb .proto definitions.
|
||||
|
||||
This tool will locate the nanopb generator and use it to generate .pb.c and
|
||||
.pb.h files from the .proto files.
|
||||
|
||||
Basic example
|
||||
-------------
|
||||
# Build myproto.pb.c and myproto.pb.h from myproto.proto
|
||||
myproto = env.NanopbProto("myproto")
|
||||
|
||||
# Link nanopb core to the program
|
||||
env.Append(CPPPATH = "$NANOB")
|
||||
myprog = env.Program(["myprog.c", myproto, "$NANOPB/pb_encode.c", "$NANOPB/pb_decode.c"])
|
||||
|
||||
Configuration options
|
||||
---------------------
|
||||
Normally, this script is used in the test environment of nanopb and it locates
|
||||
the nanopb generator by a relative path. If this script is used in another
|
||||
application, the path to nanopb root directory has to be defined:
|
||||
|
||||
env.SetDefault(NANOPB = "path/to/nanopb")
|
||||
|
||||
Additionally, the path to protoc and the options to give to protoc can be
|
||||
defined manually:
|
||||
|
||||
env.SetDefault(PROTOC = "path/to/protoc")
|
||||
env.SetDefault(PROTOCFLAGS = "--plugin=protoc-gen-nanopb=path/to/protoc-gen-nanopb")
|
||||
'''
|
||||
|
||||
import SCons.Action
|
||||
import SCons.Builder
|
||||
import SCons.Util
|
||||
import os.path
|
||||
|
||||
class NanopbWarning(SCons.Warnings.Warning):
|
||||
pass
|
||||
SCons.Warnings.enableWarningClass(NanopbWarning)
|
||||
|
||||
def _detect_nanopb(env):
|
||||
'''Find the path to nanopb root directory.'''
|
||||
if env.has_key('NANOPB'):
|
||||
# Use nanopb dir given by user
|
||||
return env['NANOPB']
|
||||
|
||||
p = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', '..'))
|
||||
if os.path.isdir(p) and os.path.isfile(os.path.join(p, 'pb.h')):
|
||||
# Assume we are running under tests/site_scons/site_tools
|
||||
return p
|
||||
|
||||
raise SCons.Errors.StopError(NanopbWarning,
|
||||
"Could not find the nanopb root directory")
|
||||
|
||||
def _detect_protoc(env):
|
||||
'''Find the path to the protoc compiler.'''
|
||||
if env.has_key('PROTOC'):
|
||||
# Use protoc defined by user
|
||||
return env['PROTOC']
|
||||
|
||||
n = _detect_nanopb(env)
|
||||
p1 = os.path.join(n, 'generator-bin', 'protoc' + env['PROGSUFFIX'])
|
||||
if os.path.exists(p1):
|
||||
# Use protoc bundled with binary package
|
||||
return env['ESCAPE'](p1)
|
||||
|
||||
p = env.WhereIs('protoc')
|
||||
if p:
|
||||
# Use protoc from path
|
||||
return env['ESCAPE'](p)
|
||||
|
||||
raise SCons.Errors.StopError(NanopbWarning,
|
||||
"Could not find the protoc compiler")
|
||||
|
||||
def _detect_protocflags(env):
|
||||
'''Find the options to use for protoc.'''
|
||||
if env.has_key('PROTOCFLAGS'):
|
||||
return env['PROTOCFLAGS']
|
||||
|
||||
p = _detect_protoc(env)
|
||||
n = _detect_nanopb(env)
|
||||
p1 = os.path.join(n, 'generator-bin', 'protoc' + env['PROGSUFFIX'])
|
||||
if p == env['ESCAPE'](p1):
|
||||
# Using the bundled protoc, no options needed
|
||||
return ''
|
||||
|
||||
e = env['ESCAPE']
|
||||
if env['PLATFORM'] == 'win32':
|
||||
return e('--plugin=protoc-gen-nanopb=' + os.path.join(n, 'generator', 'protoc-gen-nanopb.bat'))
|
||||
else:
|
||||
return e('--plugin=protoc-gen-nanopb=' + os.path.join(n, 'generator', 'protoc-gen-nanopb'))
|
||||
|
||||
def _nanopb_proto_actions(source, target, env, for_signature):
|
||||
esc = env['ESCAPE']
|
||||
dirs = ' '.join(['-I' + esc(env.GetBuildPath(d)) for d in env['PROTOCPATH']])
|
||||
return '$PROTOC $PROTOCFLAGS %s --nanopb_out=. %s' % (dirs, esc(str(source[0])))
|
||||
|
||||
def _nanopb_proto_emitter(target, source, env):
|
||||
basename = os.path.splitext(str(source[0]))[0]
|
||||
target.append(basename + '.pb.h')
|
||||
|
||||
if os.path.exists(basename + '.options'):
|
||||
source.append(basename + '.options')
|
||||
|
||||
return target, source
|
||||
|
||||
_nanopb_proto_builder = SCons.Builder.Builder(
|
||||
generator = _nanopb_proto_actions,
|
||||
suffix = '.pb.c',
|
||||
src_suffix = '.proto',
|
||||
emitter = _nanopb_proto_emitter)
|
||||
|
||||
def generate(env):
|
||||
'''Add Builder for nanopb protos.'''
|
||||
|
||||
env['NANOPB'] = _detect_nanopb(env)
|
||||
env['PROTOC'] = _detect_protoc(env)
|
||||
env['PROTOCFLAGS'] = _detect_protocflags(env)
|
||||
|
||||
env.SetDefault(PROTOCPATH = ['.', os.path.join(env['NANOPB'], 'generator', 'proto')])
|
||||
|
||||
env.SetDefault(NANOPB_PROTO_CMD = '$PROTOC $PROTOC_OPTS --nanopb_out=. $SOURCE')
|
||||
env['BUILDERS']['NanopbProto'] = _nanopb_proto_builder
|
||||
|
||||
def exists(env):
|
||||
return _detect_protoc(env) and _detect_protoc_opts(env)
|
||||
|
||||
@@ -2,6 +2,5 @@
|
||||
|
||||
Import('env')
|
||||
|
||||
env.Proto("funny-proto+name has.characters.proto")
|
||||
env.Nanopb("funny-proto+name has.characters.pb.c", "funny-proto+name has.characters.pb")
|
||||
env.NanopbProto("funny-proto+name has.characters.proto")
|
||||
env.Object("funny-proto+name has.characters.pb.c")
|
||||
|
||||
46
tools/make_linux_package.sh
Executable file
46
tools/make_linux_package.sh
Executable file
@@ -0,0 +1,46 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Run this script in the top nanopb directory to create a binary package
|
||||
# for Linux users.
|
||||
|
||||
set -e
|
||||
set -x
|
||||
|
||||
VERSION=`git describe --always`-linux-x86
|
||||
DEST=dist/$VERSION
|
||||
|
||||
rm -rf $DEST
|
||||
mkdir -p $DEST
|
||||
|
||||
# Export the files from newest commit
|
||||
git archive HEAD | tar x -C $DEST
|
||||
|
||||
# Rebuild the Python .proto files
|
||||
make -BC $DEST/generator/proto
|
||||
|
||||
# Make the nanopb generator available as a protoc plugin
|
||||
cp $DEST/generator/nanopb_generator.py $DEST/generator/protoc-gen-nanopb.py
|
||||
|
||||
# Package the Python libraries
|
||||
( cd $DEST/generator; bbfreeze nanopb_generator.py protoc-gen-nanopb.py )
|
||||
mv $DEST/generator/dist $DEST/generator-bin
|
||||
|
||||
# Remove temp file
|
||||
rm $DEST/generator/protoc-gen-nanopb.py
|
||||
|
||||
# Package the protoc compiler
|
||||
cp `which protoc` $DEST/generator-bin/protoc.bin
|
||||
LIBPROTOC=$(ldd `which protoc` | grep -o '/.*libprotoc[^ ]*')
|
||||
cp $LIBPROTOC $DEST/generator-bin/
|
||||
cat > $DEST/generator-bin/protoc << EOF
|
||||
#!/bin/bash
|
||||
SCRIPTDIR=\$(dirname "\$0")
|
||||
export LD_LIBRARY_PATH=\$SCRIPTDIR
|
||||
export PATH=\$SCRIPTDIR:\$PATH
|
||||
exec "\$SCRIPTDIR/protoc.bin" "\$@"
|
||||
EOF
|
||||
chmod +x $DEST/generator-bin/protoc
|
||||
|
||||
# Tar it all up
|
||||
( cd dist; tar -czf $VERSION.tar.gz $VERSION )
|
||||
|
||||
49
tools/make_mac_package.sh
Executable file
49
tools/make_mac_package.sh
Executable file
@@ -0,0 +1,49 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Run this script in the top nanopb directory to create a binary package
|
||||
# for Mac OS X users.
|
||||
|
||||
# Requires: protobuf, python-protobuf, pyinstaller
|
||||
|
||||
set -e
|
||||
set -x
|
||||
|
||||
VERSION=`git describe --always`-macosx-x86
|
||||
DEST=dist/$VERSION
|
||||
|
||||
rm -rf $DEST
|
||||
mkdir -p $DEST
|
||||
|
||||
# Export the files from newest commit
|
||||
git archive HEAD | tar x -C $DEST
|
||||
|
||||
# Rebuild the Python .proto files
|
||||
make -BC $DEST/generator/proto
|
||||
|
||||
# Package the Python libraries
|
||||
( cd $DEST/generator; pyinstaller nanopb_generator.py )
|
||||
mv $DEST/generator/dist/nanopb_generator $DEST/generator-bin
|
||||
|
||||
# Remove temp files
|
||||
rm -rf $DEST/generator/dist $DEST/generator/build $DEST/generator/nanopb_generator.spec
|
||||
|
||||
# Make the nanopb generator available as a protoc plugin
|
||||
cp $DEST/generator-bin/nanopb_generator $DEST/generator-bin/protoc-gen-nanopb
|
||||
|
||||
# Package the protoc compiler
|
||||
cp `which protoc` $DEST/generator-bin/protoc.bin
|
||||
LIBPROTOC=$(otool -L `which protoc` | grep -o '/.*libprotoc[^ ]*')
|
||||
LIBPROTOBUF=$(otool -L `which protoc` | grep -o '/.*libprotobuf[^ ]*')
|
||||
cp $LIBPROTOC $LIBPROTOBUF $DEST/generator-bin/
|
||||
cat > $DEST/generator-bin/protoc << EOF
|
||||
#!/bin/bash
|
||||
SCRIPTDIR=\$(dirname "\$0")
|
||||
export DYLD_LIBRARY_PATH=\$SCRIPTDIR
|
||||
export PATH=\$SCRIPTDIR:\$PATH
|
||||
exec "\$SCRIPTDIR/protoc.bin" "\$@"
|
||||
EOF
|
||||
chmod +x $DEST/generator-bin/protoc
|
||||
|
||||
# Tar it all up
|
||||
( cd dist; zip -r $VERSION.zip $VERSION )
|
||||
|
||||
55
tools/make_windows_package.sh
Executable file
55
tools/make_windows_package.sh
Executable file
@@ -0,0 +1,55 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Run this script in the top nanopb directory to create a binary package
|
||||
# for Windows users. This script is designed to run under MingW/MSYS bash
|
||||
# and requires the following tools: git, make, zip, unix2dos
|
||||
|
||||
set -e
|
||||
set -x
|
||||
|
||||
VERSION=`git describe --always`-windows-x86
|
||||
DEST=dist/$VERSION
|
||||
|
||||
rm -rf $DEST
|
||||
mkdir -p $DEST
|
||||
|
||||
# Export the files from newest commit
|
||||
git archive HEAD | tar x -C $DEST
|
||||
|
||||
# Rebuild the Python .proto files
|
||||
make -BC $DEST/generator/proto
|
||||
|
||||
# Make the nanopb generator available as a protoc plugin
|
||||
cp $DEST/generator/nanopb_generator.py $DEST/generator/protoc-gen-nanopb.py
|
||||
|
||||
# Package the Python libraries
|
||||
( cd $DEST/generator; bbfreeze nanopb_generator.py protoc-gen-nanopb.py )
|
||||
mv $DEST/generator/dist $DEST/generator-bin
|
||||
|
||||
# Remove temp file
|
||||
rm $DEST/generator/protoc-gen-nanopb.py
|
||||
|
||||
# The python interpreter requires MSVCR90.dll.
|
||||
# FIXME: Find a way around hardcoding this path
|
||||
cp /c/windows/winsxs/x86_microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.4974_none_50940634bcb759cb/MSVCR90.DLL $DEST/generator-bin/
|
||||
cat > $DEST/generator-bin/Microsoft.VC90.CRT.manifest <<EOF
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
||||
<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
|
||||
<noInheritable></noInheritable>
|
||||
<assemblyIdentity type="win32" name="Microsoft.VC90.CRT" version="9.0.21022.8" processorArchitecture="x86" publicKeyToken="1fc8b3b9a1e18e3b"></assemblyIdentity>
|
||||
<file name="msvcr90.dll" hashalg="SHA1" hash="e0dcdcbfcb452747da530fae6b000d47c8674671"><asmv2:hash xmlns:asmv2="urn:schemas-microsoft-com:asm.v2" xmlns:dsig="http://www.w3.org/2000/09/xmldsig#"><dsig:Transforms><dsig:Transform Algorithm="urn:schemas-microsoft-com:HashTransforms.Identity"></dsig:Transform></dsig:Transforms><dsig:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"></dsig:DigestMethod><dsig:DigestValue>KSaO8M0iCtPF6YEr79P1dZsnomY=</dsig:DigestValue></asmv2:hash></file> <file name="msvcp90.dll" hashalg="SHA1" hash="81efe890e4ef2615c0bb4dda7b94bea177c86ebd"><asmv2:hash xmlns:asmv2="urn:schemas-microsoft-com:asm.v2" xmlns:dsig="http://www.w3.org/2000/09/xmldsig#"><dsig:Transforms><dsig:Transform Algorithm="urn:schemas-microsoft-com:HashTransforms.Identity"></dsig:Transform></dsig:Transforms><dsig:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"></dsig:DigestMethod><dsig:DigestValue>ojDmTgpYMFRKJYkPcM6ckpYkWUU=</dsig:DigestValue></asmv2:hash></file> <file name="msvcm90.dll" hashalg="SHA1" hash="5470081b336abd7b82c6387567a661a729483b04"><asmv2:hash xmlns:asmv2="urn:schemas-microsoft-com:asm.v2" xmlns:dsig="http://www.w3.org/2000/09/xmldsig#"><dsig:Transforms><dsig:Transform Algorithm="urn:schemas-microsoft-com:HashTransforms.Identity"></dsig:Transform></dsig:Transforms><dsig:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"></dsig:DigestMethod><dsig:DigestValue>tVogb8kezDre2mXShlIqpp8ErIg=</dsig:DigestValue></asmv2:hash></file>
|
||||
</assembly>
|
||||
EOF
|
||||
|
||||
# Package the protoc compiler
|
||||
cp `which protoc.exe` $DEST/generator-bin/
|
||||
cp `which MSVCR100.DLL` $DEST/generator-bin/
|
||||
cp `which MSVCP100.DLL` $DEST/generator-bin/
|
||||
|
||||
# Convert line breaks for convenience
|
||||
find $DEST -name '*.c' -o -name '*.h' -o -name '*.txt' \
|
||||
-o -name '*.proto' -o -name '*.py' -o -name '*.options' \
|
||||
-exec unix2dos '{}' \;
|
||||
|
||||
# Zip it all up
|
||||
( cd dist; zip -r $VERSION.zip $VERSION )
|
||||
Reference in New Issue
Block a user