575 Commits

Author SHA1 Message Date
Robert Edmonds
3e126545b1 protobuf-c: add doxygen documentation derived from doc/c-code-generator.xml 2014-06-09 16:31:41 -04:00
Robert Edmonds
fc266579b8 add doxygen documentation for the protobuf-c implementation
based heavily on kevin lyda's work in PR #140.
2014-06-07 14:40:41 -04:00
Robert Edmonds
21382d1fca protobuf-c: consistently use TRUE and FALSE instead of 1 and 0
partially based on hunks split out of kevin lyda's PR #140.
2014-06-07 14:40:03 -04:00
Robert Edmonds
d14bb42d40 add doxygen documentation for the public header file
this also significantly reorganizes the header file.

based heavily on kevin lyda's work in PR #140.
2014-06-07 14:40:03 -04:00
Robert Edmonds
8655ca076d PROTOBUF_C_{NO_,}DEPRECATED -> PROTOBUF_C__{NO_,}DEPRECATED
these identifiers aren't intended for use by client code. add a double
underscore to indicate this.
2014-06-06 14:55:11 -04:00
Robert Edmonds
d05795c335 PROTOBUF_C_API -> PROTOBUF_C__API
this identifier isn't intended for use by client code. add a double
underscore to indicate this.
2014-06-06 14:52:29 -04:00
Robert Edmonds
af5120e678 PROTOBUF_C_{BEGIN,END}_DECLS -> PROTOBUF_C__{BEGIN,END}_DECLS
these identifiers aren't intended for use by client code. add a double
underscore to indicate this.
2014-06-06 14:50:14 -04:00
Andrei Nigmatulin
94e7cde263 cosmetics 2014-06-06 14:48:59 -04:00
Robert Edmonds
c96fee16c2 PROTOBUF_C_OFFSETOF -> offsetof
offsetof() conforms to the C89 standard, just call it directly.
2014-06-04 17:28:51 -04:00
Robert Edmonds
a1fa70c9b7 'struct _ProtobufC' -> 'struct ProtobufC'
identifiers in any scope that begin with an underscore and a capital
letter are reserved in C.
2014-06-04 17:25:45 -04:00
Robert Edmonds
97b6aa368b use double underscores in the MAGIC identifiers
these magic constants aren't intended for use by client code. add a
double underscore to indicate this.
2014-06-04 17:17:15 -04:00
Robert Edmonds
d0cadf1a4a PROTOBUF_C_ASSERT -> assert
assert() conforms to the C89 standard, just call it directly.
2014-06-04 17:14:44 -04:00
Robert Edmonds
298066893e remove PROTOBUF_C_ASSERT_NOT_REACHED from the public API
this macro isn't used anywhere except in the libprotobuf-c
implementation.
2014-06-04 17:11:49 -04:00
Robert Edmonds
6df737e0ca Doxyfile.in: enable MACRO_EXPANSION
this avoids littering function definitions in the documentation with
"PROTOBUF_C_API".
2014-06-03 17:57:27 -04:00
Robert Edmonds
ecc4febaba _PROTOBUF_C_FORCE_ENUM_TO_BE_INT_SIZE -> PROTOBUF_C__FORCE_ENUM_TO_BE_INT_SIZE
identifiers that begin with an underscore are reserved. instead, use a
double underscore in the *middle* of the identifier to indicate that
it's an "internal" identifier.
2014-06-03 17:43:21 -04:00
Robert Edmonds
de041d44ff protobuf-c: __PROTOBUF_C_RUNTIME_H_ -> PROTOBUF_C_H
identifiers that begin with a double underscore are reserved.
2014-06-03 17:39:49 -04:00
Robert Edmonds
0df53ea0c5 switch to a more automake-ish method of generating the html doxygen documentation 2014-06-03 17:30:13 -04:00
Robert Edmonds
e38b90f52b DoxygenLayout.xml: initial customizations 2014-06-03 17:29:22 -04:00
Robert Edmonds
aa5617bc1f Doxyfile.in: initial customizations 2014-06-03 17:29:22 -04:00
Robert Edmonds
693f98dea7 DoxygenLayout.xml: new
this is the unmodified output from "doxygen -l DoxygenLayout.xml".
2014-06-03 17:00:44 -04:00
Robert Edmonds
ef418275f2 Doxyfile.in: new
this is the completely unmodified output output from running
"doxygen -g Doxyfile.in".  (note that this is doxygen 1.8.7.)

customization will come in a subsequent commit so that we have a record
of exactly what was changed from the default values.
2014-06-03 16:37:44 -04:00
Robert Edmonds
d46d52dfaa configure.ac: use the 5-argument form of AC_INIT() and also define our own PACKAGE_DESCRIPTION 2014-06-03 16:34:38 -04:00
Robert Edmonds
9fa749d679 loosen the coupling between protoc-c and the protobuf-c headers
exact version coupling between the compiler and the public headers is
too strict because some existing projects (such as collectd,
riemann-c-client, and nmsg) directly embed .pb-c.h files generated by
protoc-c into their exported headers. this would cause unnecessary build
failures in downstream clients of these libraries if a newer version of
the protobuf-c headers is installed.

however, it's still desireable to be able to explicitly declare when
compatibility is broken between the headers and the compiler, so
introduce new variables that allow independently setting the minimum
header version required by the compiler and the minimum compiler version
required by the header.

this follows the protobuf C++ implementation a little bit more closely,
though we don't have an analogous facility for verifying that the header
and *library* are compatible. (this seems like overkill for a C project;
in practice the headers and the library will be from the same version,
especially in downstream distributors like debian where the -dev package
has an exact versioned dependency on the shared library package.)
2014-06-03 13:54:50 -04:00
Robert Edmonds
f406c9c537 protobuf-c/libprotobuf-c.pc.in: export the 'bindir' variable 2014-06-02 18:34:21 -04:00
Robert Edmonds
fd53cf5516 README.md: add coveralls.io badge 2014-06-02 18:17:02 -04:00
Robert Edmonds
1dc2c8dd78 ChangeLog: --enable-code-coverage 2014-06-02 18:05:22 -04:00
Robert Edmonds
54881f489b .travis.yml: enable code coverage checks and upload data to coveralls.io 2014-06-02 18:04:35 -04:00
Robert Edmonds
e72e7e7e81 add code coverage option to the build system
configure now has a "--enable-code-coverage" option, and if the
lcov/gcov tools are available a code coverage report can be built with
"make check-code-coverage".

this is mostly based on the AX_CODE_COVERAGE / GNOME_CODE_COVERAGE
macro:

    http://savannah.gnu.org/patch/?8451

but i also looked at knot-dns's code coverage implementation:

    https://github.com/CZNIC-Labs/knot/blob/master/m4/code-coverage.m4

and kevin lyda's pull request:

    https://github.com/protobuf-c/protobuf-c/pull/131/files
2014-06-02 17:56:41 -04:00
Robert Edmonds
44a71ee675 ChangeLog: fix formatting of author names 2014-05-30 17:25:34 -04:00
Robert Edmonds
c89aaed7c4 README.md: link to the protobuf project, not the Protocol Buffers documentation 2014-04-05 14:35:08 -04:00
Robert Edmonds
a4030b5689 README.md: update the overview 2014-04-05 14:34:09 -04:00
Robert Edmonds
1b7dfbbf6d README.md: update the synopsis 2014-04-05 14:28:09 -04:00
Robert Edmonds
66f608be48 README.md: add a "Mailing list" section near the top 2014-04-05 14:13:10 -04:00
Robert Edmonds
c11a598e3c protobuf-c: bump PROTOBUF_C_VERSION to 1.0.0-rc1 v1.0.0-rc1 2014-04-04 19:23:42 -04:00
Robert Edmonds
84be226396 configure.ac: bump version to 1.0.0-rc1 2014-04-04 19:21:31 -04:00
Robert Edmonds
9eb868d33d TODO: remove 'dispatch-within-dispatch'
it's related to the RPC code, and that's been split out into
protobuf-c-rpc now.
2014-04-04 19:20:51 -04:00
Robert Edmonds
5353ba7432 Makefile.am: ship LICENSE and README.md in the tarball 2014-04-03 19:08:21 -04:00
Robert Edmonds
cbb27d53c8 ProtobufCFieldFlagType -> ProtobufCFieldFlag
this was inadvertently reverted when i was editing e9627054.
2014-04-03 18:36:26 -04:00
Robert Edmonds
58c9e066e7 ChangeLog: protoc-c/protobuf-c.h version coupling 2014-04-03 18:26:19 -04:00
Robert Edmonds
c7c7850b51 tightly couple protoc-c output with the protobuf-c headers
this adds a version guard like the protobuf C++ implementation. it
ensures that protoc-c and <protobuf-c.h> are from the exact same version
of protobuf-c.
2014-04-03 18:19:00 -04:00
Robert Edmonds
516f72286a ChangeLog: versioning updates related to Issue #53 2014-04-03 17:58:04 -04:00
Robert Edmonds
626b138fa6 t/: add new test program 'version' 2014-04-03 17:09:39 -04:00
Robert Edmonds
c821ac3c83 rework header/library versioning
this replaces the changes in Issue #53 with a slightly different way of
representing / retrieving the version number.

protobuf_c_version() returns the version of the *library* as a string.

protobuf_c_version_number() returns the version of the *library* as an
integer.

PROTOBUF_C_VERSION is the version of the *headers* as a string constant.

PROTOBUF_C_VERSION_NUMBER is the version of the *headers* as an integer.
2014-04-03 16:36:39 -04:00
Robert Edmonds
4d525f2fff ChangeLog: credit Andrei Nigmatulin for #138 2014-04-03 12:14:03 -04:00
Robert Edmonds
3fccff9381 t/: add test case test_field_flags 2014-04-03 12:09:54 -04:00
Andrei Nigmatulin
e962705437 added deprecated flag into ProtobufCFieldDescriptor->flags
[edmonds@fsi.io: resolve merge conflicts, add documentation]
2014-04-03 11:41:13 -04:00
Robert Edmonds
8a71fdab60 minor adjustments to the field flags patch
rename PROTOBUF_C_FIELD_FLAGS_PACKED to PROTOBUF_C_FIELD_FLAG_PACKED.

rename ProtobufCFieldFlagType to ProtobufCFieldFlag.

wrap some particular long lines.

update documentation.

for clarity, use a "uint32_t" instead of "unsigned" for the 'flags'
field in _ProtobufCFieldDescriptor.
2014-04-03 10:17:14 -04:00
Andrei Nigmatulin
9c6f2fe4d3 turned ProtobufCFieldDescriptor->packed into ->flags 2014-04-03 09:56:03 -04:00
Robert Edmonds
db49f8e889 .travis.yml: test on both gcc and clang 2014-03-31 17:47:29 -04:00
Robert Edmonds
53dcda6c31 ChangeLog: credit Andrei Nigmatulin for #136, #137 2014-03-31 17:35:51 -04:00