f379578a3 Release 1.7.1 040947ba2 CMake: Add language C to project() c60e87879 Update include catch.hpp to 2.13.8 6599d4828 Update change log ebd2e4f40 Allow setting C++ version to compile with in CMake config bbb2a95d0 Github actions: Only install x64 version of vcpkgs in windows build 546edf929 Avoid narrowing conversion by being explicit 91adaecd6 Fix various issues reported by clang-tidy and disable some checks 68f30a1f7 Add Github actions CI build for Linux/macOS/Windows c13886b78 Update some links bd429c52f Include tools subdirectory *after* testing is enabled 3133dc52f Use std::memcpy instead of just memcpy 7ee29422a Merge pull request #106 from daniel-j-h/fix-byteswap-ub aba0800aa CMake config: clang-tidy target needs writer_tests which need protobuf 74516e8df Modernize CMake config a little bit b4486ca7a Disable some clang-tidy warnings 19f4b75f6 Fix appveyor build 58b1a19a4 Modernize Doxygen config file 046c07d0e Update included catch2 framework to current version v2.13.7 49acea746 fix some doxygen warnings by removing obsolete config entries 0c5426df3 fix cmake dep warning: 'Compatibility with CMake < 2.8.12 will be removed from a future version of CMake' dadf7bd51 Fixes float and double byteswap undefined behavior 85db94025 Merge pull request #105 from ffontaine/master d3a35791d Merge pull request #104 from joto/master 03daae49c CMakeLists.txt: respect BUILD_TESTING 67133e362 Add missing includes 9f85f3a5e Update README.md 010ffcf69 Release 1.7.0 6ad492994 Fixed docs adde4dedf Travis: Add non-Intel architectures 37c3d0e1d Add typedefs and functions to make buffer adaptor work as container 83563acdb Remove delegating constructor because clang-tidy doesn't like it b4afc06db Use #include "" for library-internal includes d1929788e Add missing includes fae5247f0 Update change log 2abb1b5cd Travis: Test with std::string_view, not std::experimental::string_view 697bd812d Use forwarding constructor in fixed_size_buffer_adaptor c8fd2e819 Move fixed_size_buffer_adaptor into buffer_fixed.hpp abb856ecc Remove semicolon where it doesn't belong 6243855bc Change the way the customization for special buffer classes work d6a8ed098 Remove useless post-increment 184046cb0 Remove need for push_back() on custom buffer types 0a974e067 Remove templated buffer adaptor wrappers ed6ba5097 Add buffer implementation based on std::vector<char> cec309c3c Use more descriptive names for buffer test types a7b99da6f Use TEMPLATE_TEST_CASE to test different buffer implementations a0abc493c Use explicit for constructor 72850abc9 Remove broken doxygen link 1e347c620 Add more convenient fixed_size_buffer_adaptor constructor fb575e0ea Make members private 50e953b71 Make older compilers happy c850ef150 Extend tests of static buffer use f6d8394c0 Rename fixed_size_buffer to fixed_size_buffer_adaptor 3b18162e3 Make the buffer backend used by the pbf writer configurable. 6fd19c58d "Modernize" travis config 981aba084 Use explicit cast to avoid undefined behaviour 550974d5d Travis: Do not test GCC 4.7 any more 866e024fc Revert "Workaround in catch code so it compiles with older compilers" 65dfad056 Disable a clang-tidy test triggered by Catch. 02bf73df5 Workaround in catch code so it compiles with older compilers f98792a15 Travis: Do not update homebrew for faster builds 2d87da7ec Switch tests to Catch2 5dc45ac3b Avoid signed/unsigned comparison 3a93f19ba Add missing includes b49c077ac Disable clang-tidy for files where we don't have a compile command 34396fc7d Travis: Fix gcc8 build c3060101c Handle clang-tidy warnings 64ef96ff0 Revert "Initialize test messages" a0828d538 Travis: Also build with GCC 8 171c5c446 Update travis xcode versions f5a223aa7 Use "auto*" instead of just "auto" for pointer types e4fa23616 Initialize test messages e3a59454a Simpler code and avoid shadowing of external function 830f049b4 Use STL algorithms insted of raw loops faa7e6e8a Disable config settings not used in newer Doxygen versions 3b2e11438 Remove unnecessary enum name 7487f8109 Release 1.6.8 6dcaf8fde Travis config: Use "official" way to pull homebrew package. c61eb29c3 Revert "Disable warnings from clang-tidy about a missing file." 28d05a0a8 Disable warnings from clang-tidy about a missing file. 329920a3c Pesky aliases of clang-tidy warnings strike again. 79fd87922 User plain assert() instead of our own so compare() can be noexcept. 473e6ec13 Update change log. 393e279b7 Make pbf_writer destructor noexcept. 48a38b3f2 Disable clang-tidy misc-non-private-member-variables-in-classes. e9c148c8a Use no-argument version of main(). 29ba04123 Disable clang tidy checks for C arrays. 2fcfb56e2 More places to use std::array instead of a C style array. 7321761a3 Disable a clang-tidy warning. 4d9d8fff4 Make data_view::compare() noexcept. 3325364cf User uppercase integer literal suffix. df0a23c5e Use std::array instead of C arrays in some places. 8247ed76b Make clang-tidy include order check happy. f1b504e16 Update travis config to user newer compilers and operating systems. ccf692d47 Disable some clang-tidy warnings. 095abd259 CMake config: Also look for newer clang-tidy versions. 2c1f6f9c8 Use uppercase integer literal suffixes. fadd024d4 Release 1.6.7 8c6acbff7 Fix signed-unsigned comparison. b36774ccb Release 1.6.6 5a92b744f Remove useless asserts, simplify condition. 06bafb56c Fix several possible UBs. b7b290b1a Release 1.6.5 51753d514 Merge pull request #95 from tomhughes/subscript b90faaf03 Avoid out of bounds array subscript 7d418492e Merge pull request #94 from nigels-com/proto2 015f9cc5e Specify proto2 syntax to appease protoc 23d48fd2a Use universal initialization syntax in constructors. 0f610fad5 Update travis config: Use xenial for most builds. d71da0b04 Update appveyor config: Simpler builds, current MSVC, 32bit build 3ef46ba78 Release 1.6.4 3a1ef0138 Tighten some tests. 18eebb8c3 Remove unused code from tests. 29ef3e4e7 More casts to remove undefined behaviour. 6108e6480 No more bitwise operations on signed integers in zigzag encoder/decoder. 6e0d34985 Remove bitwise operations on signed integers in varint decoder. 4af65f262 Update change log. 2f82182fe Add some tips to test/create_pbf_test_data.sh. c55f4ed55 Fix some doxygen warnings. afa362a03 Add static_asserts to check movability of some classes. efeb45e0c Disable readability-implicit-bool-conversion clang-tidy warning. 78febda5b Explicit conversion and tests for new pbf_reader::data() function. 0d5492c9c Revert "Explicit conversion and tests for new pbf_reader::data() function." 43cf8fa5a Fix travis config. bd2ae4682 Explicit conversion and tests for new pbf_reader::data() function. 28cd406bd Update travis with newer compiler versions. 0555e6a1f Add function to get the not yet read data from a pbf_reader. bf4284bee Disable docker builds on travis. They are being phased out by travis. 5ffe45b71 New add_packed_fixed template function. e54cd858d Add helper function that computes the length a varint would have. 72d7e143a More consistent implementation of operators. 3a41880c2 Do not download protobuf library, it isn't found by cmake anyway. 3c662ce3c Remove comment that doesn't apply (any more). 45da6dd4d Update zigzag tests. 4ad573dbf Extra cast so we do the xor with unsigned ints. 509aec5ab Update appveyor build to current Visual Studio compiler. 67b24e1a3 Remove unnecessary workaround in Appveyor config. c559af682 Remove xcode6.4 build soon to be removed from travis. 0662dcecc Release 1.6.3 da5bfc019 Move byteswap_inplace functions from detail into protozero namespace. a44efc34e Travis: Ignore install problems on OSX. 5775b2b23 Travis update to newer OSX image. 032aa037c Special case the distance between default initialized iterators. 0ca02161e Make dereferencing operator of fixed_iterator noexcept. a0095f603 Test code must call functions that it wants to test. 6791b0bc3 Add unit tests. 191eb4004 Add some paranoia asserts. 99ca512f5 Use TEST_CASEs instead of SECTIOs in some tests. 040e2bc14 Add some asserts and tests. git-subtree-dir: third_party/protozero git-subtree-split: f379578a3f7c8162aac0ac31c2696de09a5b5f93
12 KiB
12 KiB
Changelog
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog This project adheres to Semantic Versioning.
unreleased -
Added
Changed
Fixed
1.7.1 - 2022-01-10
Changed
- Don't build tests if the standard CMake
BUILD_TESTING
variable is set to off. - Now needs CMake 3.5.0 or greater.
- Update included catch2 framework to current version v2.13.8.
- Only enable clang-tidy make target if protobuf was found.
- Allow setting C++ version to compile with in CMake config.
Fixed
- Fixes undefined behaviour in
float
anddouble
byteswap. - Add missing includes of "config.hpp".
- Avoid narrowing conversion by doing an explicit
static_cast
.
1.7.0 - 2020-06-08
Added
- Support for buffer types other that
std::string
.pbf_writer
is now just a typedef forbasic_pbf_writer<std::string>
. Other buffer types can be used withbasic_pbf_writer
. Seedoc/advanced.md
for details.
Changed
- Switched to catch2 for testing.
- Some minor tweaks.
Fixed
- Removed some undefined behaviour.
1.6.8 - 2019-08-15
Changed
- Various code cleanups due to clang-tidy warnings.
Fixed
- Made
data_view::compare
noexcept.
1.6.7 - 2018-02-21
Fixed
- Signed-unsigned comparison on 32 bit systems.
1.6.6 - 2018-02-20
Fixed
- Fixed several place with possible undefined behaviour.
1.6.5 - 2018-02-05
Fixed
- Avoid UB: Do not calculate pointer outside array bounds.
- Specify proto2 syntax in .proto files to appease protoc.
1.6.4 - 2018-11-08
Added
- Add function
data()
to get the not yet read data from apbf_reader
. - New
add_packed_fixed()
template function forpbf_writer
. - New
length_of_varint()
helper function calculates how long a varint would be for a specified value.
Changed
- More consistent implementation of operators as free friend functions.
Fixed
- Fixed some zigzag encoding tests on MSVC.
- Add extra cast so we do an xor with unsigned ints.
- No more bitwise operations on signed integers in varint decoder.
- No more bitwise operations on signed integers in zigzag encoder/decoder.
1.6.3 - 2018-07-17
Changed
- Moved
byteswap_inplace
functions from detail into protozero namespace. They can be useful outsize protozero. - More asserts and unit tests and small cleanups.
1.6.2 - 2018-03-09
Changed
- Update included catch.hpp to v1.12.0.
- Move basic unit tests into their own directory (
test/unit
). - Improved clang-tidy config and fixed some code producing warnings.
Fixed
- Buffer overflow in pbf-decoder tool.
1.6.1 - 2017-11-16
Added
- Document internal handling of varints.
- Add aliases for fixed iterators, too.
Changed
- The
const_fixed_iterator
is now a random access iterator making code using it potentially more performant (for instance when usingstd::distance
) - Overloads
std::distance
for the varint and svarint iterators. This is better than the workaround with therage_size
function used before.
Fixed
- Rename
.proto
files in some tests to be unique. This solves a problem when building with newer versions of the Google Protobuf library. - Floating point comparisons in tests are now always correctly done using
Approx()
.
1.6.0 - 2017-10-24
Added
- Comparison functions (<, <=, >, >=) for
data_view
. Allows use instd::map
for instance. - Tool
pbf-decoder
for decoding raw messages. This has limited use for normal users, but it can be used for fuzzing.
Changed
- Protozero now uses CMake to build the tests etc. This does not affect
simple users of the library, but if you are using CMake yourself you might
want to use the
cmake/FindProtozero.cmake
module provided. The README contains more information about build options. - Moved
data_view
class fromtypes.hpp
into its own header filedata_view.hpp
. - Implementation of the
const_fixed_iterator
to use only a single pointer instead of two. - Made
operator==
andoperator!=
ondata_view
constexpr. - The
pbf_reader
constructor taking astd::pair
is deprecated. Use one of the other constructors instead.
Fixed
- Varints where the last byte was larger than what would fit in 64bit were triggering undefined behaviour. This can only happen when the message being decoded was corrupt in some way.
- Do not assert when reading too long varints for bools any more. A valid encoder should never generate varints with more than one byte for bools, but if they are longer that's not really a problem, so just handle it.
- Throw exception if the length of a packed repeated field of a fixed-length type is invalid. The length must always be a multiple of the size of the underlying type. This can only happen if the data is corrupted in some way, a valid encoder would never generate data like this.
- Throw an exception when reading invalid tags. This can only happen if the data is corrupted in some way, a valid encoder would never generate invalid tags.
1.5.3 - 2017-09-22
Added
- More documentation.
- New
size()
method on iterator range used for packed repeated fields to find out how many elements there are in the range. This is much faster compared to thestd::difference()
call you had to do before, because the varints don't have to be fully decoded. See Advanced Topics for details.
Changed
- Updated clang-tidy settings in Makefiles and fixed a lot of minor issues reported by clang-tidy.
- Update included catch.hpp to version 1.10.0.
- Miscellaneous code cleanups.
- Support for invalid state in
pbf_writer
andpacked_repeated_fields
. This fixes move construction and move assignement inpbf_writer
and disables the copy construction and copy assignement which don't have clear semantics. It introduces an invalid or empty state in thepbf_writer
,pbf_builder
, andpacked_repeated_fields
classes used for default-constructed, moved from, or committed objects. There is a newcommit()
function forpbf_writer
and thepacked_repeated_fields
which basically does the same as the destructor but can be called explicitly.
Fixed
- The
empty()
method of the iterator range now returns abool
instead of asize_t
.
1.5.2 - 2017-06-30
Added
- Add missing two-parameter version of
pbf_message::next()
function. - Add
data_view::empty()
function. - Add missing versions of
add_bytes()
,add_string()
, andadd_message()
topbf_builder
.
Changed
- Clarify include file usage in tutorial.
- Updated included Catch unit test framework to version 1.9.6 and updated tests to work with the current version.
- Make some constructors explicit (best practice to avoid silent conversions).
Fixed
- Important bugfix in
data_view
equality operator. The equality operator is actually never used in the protozero code itself, but users of protozero might use it. This is a serious bug that could lead to buffer overrun type problems.
1.5.1 - 2017-01-14
Added
- Better documentation for
tag_and_type()
in doc/advanced.md.
Fixed
- Fixed broken "make doc" build.
1.5.0 - 2017-01-12
Added
- Add
add_bytes_vectored()
methods topbf_writer
andpbf_builder
. This allows single-copy scatter-gather type adding of data that has been prepared in pieces to a protobuf message. - New functions to check the tag and wire type at the same time: Two parameter
version of
pbf_reader::next()
andpbf_reader::tag_and_type()
can be used together with the free functiontag_and_type()
to easily and quickly check that not only the tag but also the wire type is correct for a field.
Changed
packed_field_*
classes now work withpbf_builder
.- Reorganized documentation. Advanced docs are now under doc/advanced.md.
Fixed
packed_field
class is now non-copyable because data can get corrupted if you copy it around.- Comparison operators of
data_view
now have const& parameters. - Make zigzag encoding/decoding functions constexpr.
1.4.5 - 2016-11-18
Fixed
- Undefined behaviour in packed fixed iterator. As a result, the macro
PROTOZERO_DO_NOT_USE_BARE_POINTER
is not used any more.
1.4.4 - 2016-11-15
Fixed
- Byteswap implementation.
1.4.3 - 2016-11-15
Fixed
- Undefined behaviour in byte swapping code.
- Rename some parameters to avoid "shadow" warning from some compilers.
1.4.2 - 2016-08-27
Fixed
- Compile fix: Variable shadowing.
1.4.1 - 2016-08-21
Fixed
- GCC 4.8 compile fixed
Added
- New ability to dynamically require the module as a node module to ease building against from other node C++ modules.
1.4.0 - 2016-07-22
Changed
- Use more efficient new
skip_varint()
function when iterating over packed varints. - Split
decode_varint()
function into two functions speeding up the common case where a varint is only one byte long. - Introduce new class
iterator_range
used instead ofstd::pair
of iterators. This way the objects can be used in range-based for loops. Read UPGRADING.md for details. - Introduce new class
data_view
and functions using and returning it. Read UPGRADING.md for details.
1.3.0 - 2016-02-18
Added
- Added
config.hpp
header which now includes all the macro magic to configure the library for different architectures etc. - New way to create repeated packed fields without using an iterator.
- Add
rollback()
function topbf_writer
for "manual" rollback.
Changed
- Various test and documentation cleanups.
- Rename
pbf_types.hpp
totypes.hpp
.
1.2.3 - 2015-11-30
Added
- Added
config.hpp
header which now includes all the macro magic to configure the library for different architectures etc.
Fixed
- Unaligned access to floats/doubles on some ARM architectures.
1.2.2 - 2015-10-13
Fixed
- Fix the recently broken writing of bools on big-endian architectures.
1.2.1 - 2015-10-12
Fixed
- Removed unneeded code (1-byte "swap") which lead to test failures.
1.2.0 - 2015-10-08
Added
pbf_message
andpbf_builder
template classes wrappingpbf_reader
andpbf_writer
, respectively. The new classes are the preferred interface now.
Changed
- Improved byte swapping operation.
- Detect some types of data corruption earlier and throw.
1.1.0 - 2015-08-22
Changed
- Make pbf reader and writer code endianess-aware.