commit 68019a1fb20928beaa7b0cb2d8310af29ffe789e Author: Michael Krasnyk Date: Thu Apr 19 22:03:49 2018 +0300 Squashed 'third_party/protozero/' content from commit d5d8debf1 git-subtree-dir: third_party/protozero git-subtree-split: d5d8debf1b17c6bb652395957b76cde7787e5377 diff --git a/.clang-tidy b/.clang-tidy new file mode 100644 index 000000000..1ba914c7c --- /dev/null +++ b/.clang-tidy @@ -0,0 +1,34 @@ +--- +Checks: '*,-cert-dcl21-cpp,-cert-err60-cpp,-cppcoreguidelines-pro-bounds-pointer-arithmetic,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-cppcoreguidelines-pro-type-reinterpret-cast,-fuchsia-*,-google-runtime-references,-hicpp-no-array-decay' +# +# Disabled checks: +# +# cert-dcl21-cpp +# It is unclear whether this is still a good recommendation in modern C++. +# +# cert-err60-cpp +# Reports std::runtime_error as broken which we can't do anything about. +# +# cppcoreguidelines-pro-bounds-array-to-pointer-decay +# Limited use and many false positives including for all asserts. +# +# cppcoreguidelines-pro-bounds-pointer-arithmetic +# This is a low-level library, it needs to do pointer arithmetic. +# +# cppcoreguidelines-pro-type-reinterpret-cast +# This is a low-level library, it needs to do reinterpret-casts. +# +# fuchsia-* +# Much too strict. +# +# google-runtime-references +# This is just a matter of preference, and we can't change the interfaces +# now anyways. +# +# hicpp-no-array-decay +# Limited use and many false positives including for all asserts. +# +WarningsAsErrors: '*' +HeaderFilterRegex: '\/include\/' +AnalyzeTemporaryDtors: false +... diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..3503e2c40 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.pbf -text diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..891e59bba --- /dev/null +++ b/.travis.yml @@ -0,0 +1,178 @@ +#----------------------------------------------------------------------------- +# +# Configuration for continuous integration service at travis-ci.org +# +#----------------------------------------------------------------------------- + +language: generic + +sudo: false + +dist: trusty + +#----------------------------------------------------------------------------- + +# Save common build configurations as shortcuts, so we can reference them later. +addons_shortcuts: + addons_clang35: &clang35 + apt: + sources: [ 'ubuntu-toolchain-r-test', 'llvm-toolchain-trusty-3.5' ] + packages: [ 'libprotobuf-dev','protobuf-compiler', 'clang-3.5' ] + addons_clang38: &clang38 + apt: + sources: [ 'ubuntu-toolchain-r-test', 'llvm-toolchain-trusty-3.8' ] + packages: [ 'libprotobuf-dev','protobuf-compiler', 'clang-3.8' ] + addons_clang39: &clang39 + apt: + sources: [ 'ubuntu-toolchain-r-test', 'llvm-toolchain-trusty-3.9' ] + packages: [ 'libprotobuf-dev','protobuf-compiler', 'clang-3.9' ] + addons_clang40: &clang40 + apt: + sources: [ 'ubuntu-toolchain-r-test', 'llvm-toolchain-trusty-4.0' ] + packages: [ 'libprotobuf-dev','protobuf-compiler', 'clang-4.0' ] + addons_clang50: &clang50 + apt: + sources: [ 'ubuntu-toolchain-r-test', 'llvm-toolchain-trusty-5.0' ] + packages: [ 'libprotobuf-dev','protobuf-compiler', 'clang-5.0', 'clang-tidy-5.0' ] + addons_gcc47: &gcc47 + apt: + sources: [ 'ubuntu-toolchain-r-test' ] + packages: [ 'libprotobuf-dev','protobuf-compiler', 'g++-4.7', 'gcc-4.7' ] + addons_gcc48: &gcc48 + apt: + sources: [ 'ubuntu-toolchain-r-test' ] + packages: [ 'libprotobuf-dev','protobuf-compiler', 'g++-4.8', 'gcc-4.8' ] + addons_gcc49: &gcc49 + apt: + sources: [ 'ubuntu-toolchain-r-test' ] + packages: [ 'libprotobuf-dev','protobuf-compiler', 'g++-4.9', 'gcc-4.9' ] + addons_gcc5: &gcc5 + apt: + sources: [ 'ubuntu-toolchain-r-test' ] + packages: [ 'libprotobuf-dev','protobuf-compiler', 'g++-5', 'gcc-5' ] + addons_gcc6: &gcc6 + apt: + sources: [ 'ubuntu-toolchain-r-test' ] + packages: [ 'libprotobuf-dev','protobuf-compiler', 'g++-6', 'gcc-6' ] + +#----------------------------------------------------------------------------- + +matrix: + include: + - os: linux + compiler: "clang-3.5" + env: BUILD='Debug' CC=clang-3.5 CXX=clang++-3.5 + addons: *clang35 + - os: linux + compiler: "clang-3.8" + env: BUILD='Debug' CC=clang-3.8 CXX=clang++-3.8 + addons: *clang38 + - os: linux + compiler: "clang-3.9" + env: BUILD='Debug' CC=clang-3.9 CXX=clang++-3.9 + addons: *clang39 + - os: linux + compiler: "clang-4.0" + env: BUILD='Debug' CC=clang-4.0 CXX=clang++-4.0 + addons: *clang40 + - os: linux + compiler: "clang-5.0" + env: BUILD='Debug' CC=clang-5.0 CXX=clang++-5.0 + CLANG_TIDY=clang-tidy-5.0 + addons: *clang50 + - os: linux + compiler: "clang-5.0" + env: BUILD='Release' CC=clang-5.0 CXX=clang++-5.0 + addons: *clang50 + - os: linux + compiler: "clang-5.0" + env: BUILD='Debug' CC=clang-5.0 CXX=clang++-5.0 + CXXFLAGS="-fsanitize=address,undefined,integer -fno-sanitize-recover=all -fno-omit-frame-pointer" + LDFLAGS="-fsanitize=address,undefined,integer" + # LSAN doesn't work on container-based system + sudo: required + addons: *clang50 + - os: linux + compiler: "gcc-4.7" + env: BUILD='Debug' CC=gcc-4.7 CXX=g++-4.7 + addons: *gcc47 + - os: linux + compiler: "gcc-4.8" + env: BUILD='Debug' CC=gcc-4.8 CXX=g++-4.8 + addons: *gcc48 + - os: linux + compiler: "gcc-4.9" + env: BUILD='Debug' CC=gcc-4.9 CXX=g++-4.9 + COVERAGE=gcov-4.9 + CXXFLAGS="--coverage" LDFLAGS="--coverage" + addons: *gcc49 + - os: linux + compiler: "gcc-5" + env: BUILD='Debug' CC=gcc-5 CXX=g++-5 + CXXFLAGS="-D_GLIBCXX_USE_CXX11_ABI=0" + addons: *gcc5 + - os: linux + compiler: "gcc-5" + env: BUILD='Debug' CC=gcc-5 CXX=g++-5 + CXXFLAGS="-D_GLIBCXX_USE_CXX11_ABI=1" + addons: *gcc5 + - os: linux + compiler: "gcc-6" + env: BUILD='Debug' CC=gcc-6 CXX=g++-6 + addons: *gcc6 + - os: linux + compiler: "gcc-6" + env: BUILD='Debug' CC=gcc-6 CXX=g++-6 + PROTOZERO_DATA_VIEW=std::experimental::string_view + addons: *gcc6 + - os: linux + compiler: "gcc-6" + env: BUILD='Release' CC=gcc-6 CXX=g++-6 + addons: *gcc6 + - os: osx + osx_image: xcode6.4 + compiler: clang + env: BUILD='Debug' + - os: osx + osx_image: xcode7.3 + compiler: clang + env: BUILD='Debug' + - os: osx + osx_image: xcode8.3 + compiler: clang + env: BUILD='Debug' + - os: osx + osx_image: xcode9.1 + compiler: clang + env: BUILD='Debug' + - os: osx + osx_image: xcode9.1 + compiler: clang + env: BUILD='Release' + +#----------------------------------------------------------------------------- + +install: + - if [[ $(uname -s) == 'Darwin' ]]; then + brew update; + brew install protobuf; + fi + +script: + - mkdir build + - cd build + - cmake .. -LA -DCMAKE_BUILD_TYPE=${BUILD} -DPROTOZERO_DATA_VIEW=$PROTOZERO_DATA_VIEW -DCLANG_TIDY=$(which ${CLANG_TIDY}) + - make VERBOSE=1 + - ctest --output-on-failure + - if [ -n "${CLANG_TIDY}" ]; then make clang-tidy; fi + - | + if [ -n "${COVERAGE}" ]; then + which ${COVERAGE} + curl -S -f https://codecov.io/bash -o codecov + chmod +x codecov + ${COVERAGE} -p $(find test/ tools/ -name '*.o') + ./codecov -Z -f '*protozero*' -f '*tools*' -f '!*catch*' -X search + fi + + +#----------------------------------------------------------------------------- diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..d43f422b6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,324 @@ + +# Changelog + +All notable changes to this project will be documented in this file. +The format is based on [Keep a Changelog](http://keepachangelog.com/) +This project adheres to [Semantic Versioning](http://semver.org/). + + +## [unreleased] - + +### Added + +### Changed + +### Fixed + + +## [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 using + `std::distance`) +- Overloads `std::distance` for the varint and svarint iterators. This is + better than the workaround with the `rage_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 in `std::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 from `types.hpp` into its own header file + `data_view.hpp`. +- Implementation of the `const_fixed_iterator` to use only a single pointer + instead of two. +- Made `operator==` and `operator!=` on `data_view` constexpr. +- The `pbf_reader` constructor taking a `std::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 the `std::difference()` call you had to do before, because the + varints don't have to be fully decoded. See [Advanced + Topics](doc/advanced.md) 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` and `packed_repeated_fields`. + This fixes move construction and move assignement in `pbf_writer` and + disables the copy construction and copy assignement which don't have + clear semantics. It introduces an invalid or empty state in the + `pbf_writer`, `pbf_builder`, and `packed_repeated_fields` classes used for + default-constructed, moved from, or committed objects. There is a new + `commit()` function for `pbf_writer` and the `packed_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 a `bool` instead of + a `size_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()`, and `add_message()` + to `pbf_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 to `pbf_writer` and `pbf_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()` and `pbf_reader::tag_and_type()` can be used + together with the free function `tag_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 with `pbf_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 of `std::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 to `pbf_writer` for "manual" rollback. + +### Changed + +- Various test and documentation cleanups. +- Rename `pbf_types.hpp` to `types.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` and `pbf_builder` template classes wrapping `pbf_reader` + and `pbf_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. + + +[unreleased]: https://github.com/osmcode/libosmium/compare/v1.6.2...HEAD +[1.6.2]: https://github.com/osmcode/libosmium/compare/v1.6.1...v1.6.2 +[1.6.1]: https://github.com/osmcode/libosmium/compare/v1.6.0...v1.6.1 +[1.6.0]: https://github.com/osmcode/libosmium/compare/v1.5.3...v1.6.0 +[1.5.3]: https://github.com/osmcode/libosmium/compare/v1.5.2...v1.5.3 +[1.5.2]: https://github.com/osmcode/libosmium/compare/v1.5.1...v1.5.2 +[1.5.1]: https://github.com/osmcode/libosmium/compare/v1.5.0...v1.5.1 +[1.5.0]: https://github.com/osmcode/libosmium/compare/v1.4.5...v1.5.0 +[1.4.5]: https://github.com/osmcode/libosmium/compare/v1.4.4...v1.4.5 +[1.4.4]: https://github.com/osmcode/libosmium/compare/v1.4.3...v1.4.4 +[1.4.3]: https://github.com/osmcode/libosmium/compare/v1.4.2...v1.4.3 +[1.4.2]: https://github.com/osmcode/libosmium/compare/v1.4.1...v1.4.2 +[1.4.1]: https://github.com/osmcode/libosmium/compare/v1.4.0...v1.4.1 +[1.4.0]: https://github.com/osmcode/libosmium/compare/v1.3.0...v1.4.0 +[1.3.0]: https://github.com/osmcode/libosmium/compare/v1.2.3...v1.3.0 +[1.2.3]: https://github.com/osmcode/libosmium/compare/v1.2.2...v1.2.3 +[1.2.2]: https://github.com/osmcode/libosmium/compare/v1.2.1...v1.2.2 +[1.2.1]: https://github.com/osmcode/libosmium/compare/v1.2.0...v1.2.1 +[1.2.0]: https://github.com/osmcode/libosmium/compare/v1.1.0...v1.2.0 +[1.1.0]: https://github.com/osmcode/libosmium/compare/v1.0.0...v1.1.0 + diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 000000000..24e293d73 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,145 @@ +#----------------------------------------------------------------------------- +# +# CMake config +# +# protozero +# +#----------------------------------------------------------------------------- + +cmake_minimum_required(VERSION 2.8 FATAL_ERROR) + +#----------------------------------------------------------------------------- + +project(protozero) + +set(PROTOZERO_VERSION_MAJOR 1) +set(PROTOZERO_VERSION_MINOR 6) +set(PROTOZERO_VERSION_PATCH 2) + +set(PROTOZERO_VERSION + "${PROTOZERO_VERSION_MAJOR}.${PROTOZERO_VERSION_MINOR}.${PROTOZERO_VERSION_PATCH}") + +set(CMAKE_EXPORT_COMPILE_COMMANDS ON) + +#----------------------------------------------------------------------------- + +option(WERROR "Add -Werror flag to build (turns warnings into errors)" ON) + +if(MSVC) + add_definitions(-std=c++11 /W3) + add_definitions(-D_CRT_SECURE_NO_WARNINGS -D_SCL_SECURE_NO_WARNINGS) +else() + add_definitions(-std=c++11 -Wall -Wextra -pedantic -Wsign-compare -Wunused-parameter -Wno-float-equal -Wno-covered-switch-default) + if(WERROR) + add_definitions(-Werror) + endif() +endif() + +include_directories("${CMAKE_SOURCE_DIR}/include") + +set(PROTOZERO_DATA_VIEW "" CACHE STRING "Type used for protozero::data_view") +if(NOT PROTOZERO_DATA_VIEW STREQUAL "") + add_definitions(-DPROTOZERO_DATA_VIEW=${PROTOZERO_DATA_VIEW}) +endif() + + +#----------------------------------------------------------------------------- +# +# Find dependencies +# +#----------------------------------------------------------------------------- + +find_package(Protobuf) + + +#----------------------------------------------------------------------------- +# +# Optional "clang-tidy" target +# +#----------------------------------------------------------------------------- +message(STATUS "Looking for clang-tidy") +find_program(CLANG_TIDY NAMES clang-tidy clang-tidy-6.0 clang-tidy-5.0) + +if(CLANG_TIDY) + message(STATUS "Looking for clang-tidy - found ${CLANG_TIDY}") + add_custom_target(clang-tidy + ${CLANG_TIDY} + -p ${CMAKE_BINARY_DIR} + ${CMAKE_SOURCE_DIR}/test/*.cpp + ${CMAKE_SOURCE_DIR}/test/t/*/*.cpp + ${CMAKE_SOURCE_DIR}/test/unit/*.cpp + ${CMAKE_SOURCE_DIR}/tools/*.cpp + ) + add_dependencies(clang-tidy writer_tests) +else() + message(STATUS "Looking for clang-tidy - not found") + message(STATUS " Build target 'clang-tidy' will not be available.") +endif() + + +#----------------------------------------------------------------------------- +# +# Optional "cppcheck" target +# +#----------------------------------------------------------------------------- +message(STATUS "Looking for cppcheck") +find_program(CPPCHECK NAMES cppcheck) + +if(CPPCHECK) + message(STATUS "Looking for cppcheck - found") + add_custom_target(cppcheck + ${CPPCHECK} + -Uassert --std=c++11 --enable=all + ${CMAKE_SOURCE_DIR}/include/protozero/*.hpp + ${CMAKE_SOURCE_DIR}/test/*.cpp + ${CMAKE_SOURCE_DIR}/test/include/*.hpp + ${CMAKE_SOURCE_DIR}/test/t/*/*.cpp + ${CMAKE_SOURCE_DIR}/test/unit/*.cpp + ${CMAKE_SOURCE_DIR}/tools/*.cpp + ) +else() + message(STATUS "Looking for cppcheck - not found") + message(STATUS " Build target 'cppcheck' will not be available.") +endif() + + +#----------------------------------------------------------------------------- +# +# Include what you use +# +#----------------------------------------------------------------------------- +message(STATUS "Looking for iwyu") +find_program(IWYU_TOOL NAMES iwyu_tool) + +if(IWYU_TOOL) + message(STATUS "Looking for iwyu - found") + add_custom_target(iwyu + ${IWYU_TOOL} -p ${CMAKE_BINARY_DIR} + ) +else() + message(STATUS "Looking for iwyu - not found") + message(STATUS " Build target 'iwyu' will not be available.") +endif() + + +#----------------------------------------------------------------------------- +# +# Installation +# +#----------------------------------------------------------------------------- + +install(DIRECTORY include/protozero DESTINATION include) + + +#----------------------------------------------------------------------------- + +enable_testing() + +add_subdirectory(doc) + +add_subdirectory(tools) + +add_subdirectory(test) + + +#----------------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..c116f600b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing to protozero + +## Releasing + +To release a new protozero version: + + - Make sure all tests are passing locally, on travis and on appveyor + - Make sure "make doc" builds + - Update version number in + - include/protozero/version.hpp (two places) + - CMakeLists.txt (one place) + - Update CHANGELOG.md + (don't forget links at the bottom of the file) + - Update UPGRADING.md if necessary + - `git commit -m "Release X.Y.Z" include/protozero/version.hpp CMakeLists.txt CHANGELOG.md UPGRADING.md` + - `git tag vX.Y.Z` + - `git push` + - `git push --tags` + - Go to https://github.com/mapbox/protozero/releases + and edit the new release. Put "Version x.y.z" in title and + cut-and-paste entry from CHANGELOG.md. diff --git a/FUZZING.md b/FUZZING.md new file mode 100644 index 000000000..44ae0ef16 --- /dev/null +++ b/FUZZING.md @@ -0,0 +1,22 @@ + +To do fuzz testing using [AFL](http://lcamtuf.coredump.cx/afl/) compile with +the AFL compiler wrappers: + + mkdir build + cd build + CC=afl-clang CXX=afl-clang++ cmake .. + mkdir testcase_dir + +You need some data to start the fuzzing. In this case I am using all the test +messages from the unit tests: + + find ../test/t/ -name data-\*.pbf -a -not -empty -exec cp {} testcase_dir/ \; + +Then do the actual fuzzing: + + afl-fuzz -i testcase_dir -o findings_dir -- tools/pbf-decoder - + +See the AFL documentation for more information. + +This only checkes the reading side of Protozero! + diff --git a/LICENSE.from_folly b/LICENSE.from_folly new file mode 100644 index 000000000..f433b1a53 --- /dev/null +++ b/LICENSE.from_folly @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 000000000..d0b30117c --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,24 @@ +protozero copyright (c) Mapbox. + +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. + +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. diff --git a/README.md b/README.md new file mode 100644 index 000000000..63972e0a6 --- /dev/null +++ b/README.md @@ -0,0 +1,156 @@ +# protozero + +Minimalistic protocol buffer decoder and encoder in C++. + +Designed for high performance. Suitable for writing zero copy parsers and +encoders with minimal need for run-time allocation of memory. + +Low-level: this is designed to be a building block for writing a very +customized decoder for a stable protobuf schema. If your protobuf schema is +changing frequently or lazy decoding is not critical for your application then +this approach offers no value: just use the C++ API that can be generated with +the Google Protobufs `protoc` program. + +[![Travis Build Status](https://travis-ci.org/mapbox/protozero.svg?branch=master)](https://travis-ci.org/mapbox/protozero) +[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/mapbox/protozero?svg=true)](https://ci.appveyor.com/project/Mapbox/protozero) +[![Coverage Status](https://codecov.io/gh/mapbox/protozero/branch/master/graph/badge.svg)](https://codecov.io/gh/mapbox/protozero) +[![Packaging status](https://repology.org/badge/tiny-repos/protozero.svg)](https://repology.org/metapackage/protozero) + +## Depends + +* C++11 compiler +* CMake +* Some tests depend on the Google Protobuf library, but use of Protozero + doesn't need it + + +## How it works + +The protozero code does **not** read `.proto` files used by the usual Protobuf +implementations. The developer using protozero has to manually "translate" the +`.proto` description into code. This means there is no way to access any of the +information from the `.proto` description. This results in a few restrictions: + +* The names of the fields are not available. +* Enum names are not available, you'll have to use the values they are defined + with. +* Default values are not available. +* Field types have to be hardcoded. The library does not know which types to + expect, so the user of the library has to supply the right types. Some checks + are made using `assert()`, but mostly the user has to take care of that. + +The library will make sure not to overrun the buffer it was given, but +basically all other checks have to be made in user code! + + +## Documentation + +You have to have a working knowledge of how +[protocol buffer encoding works](https://developers.google.com/protocol-buffers/docs/encoding). + +* Read the [tutorial](doc/tutorial.md) for an introduction on how to use + Protozero. +* Some advanced topics are described in an [extra document](doc/advanced.md). +* There is a table of all types and functions in the + [cheat sheet](doc/cheatsheet.md). +* Read the [upgrading instructions](UPGRADING.md) if you are upgrading from + an older version of Protozero. + +The build process will also build the Doxygen-based reference documentation +if you have [Doxygen](http://www.stack.nl/~dimitri/doxygen/) installed. Then +open `doc/html/index.html` in your browser to read it. + + +## Endianness + +Protozero uses a very simplistic test to check the byte order of the system it +compiles on. If this check is wrong, you'll get test failures. If this is the +case, please [open an issue](https://github.com/mapbox/protozero/issues) and +tell us about your system. + + +## Building tests + +Extensive tests are included. Build them using CMake: + + mkdir build + cd build + cmake .. + make + +Call `ctest` to run the tests. + +The unit and reader tests are always build, the writer tests are only build if +the Google Protobuf library is found when running CMake. + +See `test/README.md` for more details about the test. + + +## Coverage report + +To get a coverage report set `CXXFLAGS` and `LDFLAGS` before calling CMake: + + CXXFLAGS="--coverage" LDFLAGS="--coverage" cmake .. + +Then call `make` as usual and run the tests using `ctest`. + +If you are using `g++` use `gcov` to generate a report (results are in `*.gcov` +files): + + gcov -lp $(find test/ -name '*.o') + +If you are using `clang++` use `llvm-cov` instead: + + llvm-cov gcov -lp $(find test/ -name '*.o') + +If you are using `g++` you can use `gcovr` to generate nice HTML output: + + mkdir -p coverage + gcovr . -r SRCDIR --html --html-details -o coverage/index.html + +Open `coverage/index.html` in your browser to see the report. + + +## Clang-tidy + +After the CMake step, run + + make clang-tidy + +to check the code with [clang-tidy](https://clang.llvm.org/extra/clang-tidy/). +You might have to set `CLANG_TIDY` in CMake config. + + +## Cppcheck + +For extra checks with [Cppcheck](http://cppcheck.sourceforge.net/) you can, +after the CMake step, call + + make cppcheck + + +## Installation + +After the CMake step, call `make install` to install the include files in +`/usr/local/include/protozero`. + +If you are using CMake to build your own software, you can copy the file +`cmake/FindProtozero.cmake` and use it in your build. See the file for +details. + + +## Who is using Protozero? + +* [Carmen](https://github.com/mapbox/carmen-cache) +* [Libosmium](https://github.com/osmcode/libosmium) +* [Mapbox GL Native](https://github.com/mapbox/mapbox-gl-native) +* [Mapbox Vector Tile library](https://github.com/mapbox/vector-tile) +* [Mapnik](https://github.com/mapbox/mapnik-vector-tile) +* [OSRM](https://github.com/Project-OSRM/osrm-backend) +* [Tippecanoe](https://github.com/mapbox/tippecanoe) +* [Vtzero](https://github.com/mapbox/vtzero) + +Are you using Protozero? Tell us! Send a pull request with changes to this +README. + + diff --git a/UPGRADING.md b/UPGRADING.md new file mode 100644 index 000000000..9a5db8ee9 --- /dev/null +++ b/UPGRADING.md @@ -0,0 +1,96 @@ + +# Upgrading + +This file contains instructions for users of Protozero who are upgrading from +one version to another. + +You do not need to change anything if only the minor version changes, but it +is better to keep up with changes if you can. The switch to the next major +version will be easier then. And you might get some more convenient usage. + +To help you with upgrading to new versions, you can define the C++ preprocessor +macro `PROTOZERO_STRICT_API` in which case Protozero will compile without the +code used for backwards compatibilty. You will then get compile errors for +older API usages. + +## Upgrading from *v1.5* to *v1.6.0* + +* The `data_view` class moved from `types.hpp` into its own header file + `data_view.hpp`. Most people should not include those headers directly, + but if you do, you might have to change your includes. +* There are two new exceptions `invalid_tag_exception` and + `invalid_length_exception` which cover cases that were only checked by + `assert` before this version. If you catch specific exceptions in your code + you might have to amend it. But just catching `protozero::exception` is + usually fine for most code (if you catch exceptions at all). +* The `pbf_reader` constructor taking a `std::pair` is now deprecated. If you + are compiling with `PROTOZERO_STRICT_API` it is not available any more. Use + one of the other constructors instead. + +## Upgrading from *v1.4.5* to *v1.5.0* + +* New functions for checking tag and type at the same time to make your + program more robust. Read the section "Repeated fields in messages" in + the new [Advanced Topics documentation](doc/advanced.md). + +## Upgrading from *v1.4.4* to *v1.4.5* + +* The macro `PROTOZERO_DO_NOT_USE_BARE_POINTER` is not used any more. If you + have been setting this, remove it. + +## Upgrading from *v1.4.0* to *v1.4.1* + +* You can now do `require('protozero')` in nodejs to print the path + to the include paths for the protozero headers. + +## Upgrading from *v1.3.0* to *v1.4.0* + +* Functions in `pbf_reader` (and the derived `pbf_message`) called + `get_packed_*()` now return an `iterator_range` instead of a `std::pair`. + The new class is derived from `std::pair`, so changes are usually not + strictly necessary. For future compatibility, you should change all + attribute accesses on the returned objects from `first` and `second` to + `begin()` and `end()`, respectively. So change something like this: + + auto x = message.get_packed_int32(); + for (auto it = x.first; it != x.second; ++it) { + .... + } + + to: + + auto x = message.get_packed_int32(); + for (auto it = x.begin(); it != x.end(); ++it) { + .... + } + + or even better use the range-based for loop: + + auto x = message.get_packed_int32(); + for (auto val : x) { + .... + } + + Ranges can also be used in this way. This will change the range in-place: + + auto range = message.get_packed_int32(); + while (!range.empty()) { + auto value = range.front(); + range.drop_front(); + .... + } + +* The class `pbf_reader` has a new method `get_view()` returning an object + of the new `protozero::data_view` class. The `data_view` only has minimal + functionality, but what it has is compatible to the `std::string_view` class + which will be coming in C++17. The view autoconverts to a `std::string` if + needed. Use `get_view()` instead of `get_data()` giving you a more intuitive + interface (call `data()` and `size()` on the view instead of using `first` + and `second` on the `std::pair` returned by `get_data()`). + + You can set the macro `PROTOZERO_USE_VIEW` (before including `types.hpp`) to + the name of any class that behaves like `protozero::data_view` and + `data_view` will be an alias to that class instead of the implementation + from protozero. This way you can use the C++17 `string_view` or a similar + class if it is already available on your system. + diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 000000000..3c3dc7bce --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,57 @@ +#----------------------------------------------------------------------------- +# +# Configuration for continuous integration service at appveyor.com +# +#----------------------------------------------------------------------------- + +platform: x64 + +image: Visual Studio 2017 + +clone_depth: 1 + +#----------------------------------------------------------------------------- + +environment: + matrix: + - config: MSYS2 + autocrlf: true + - config: Debug + autocrlf: true + - config: RelWithDebInfo + autocrlf: true + - config: Debug + autocrlf: false + - config: RelWithDebInfo + autocrlf: false + +#----------------------------------------------------------------------------- + +init: + - git config --global core.autocrlf %autocrlf% + - git config --get core.autocrlf + +# The option --ask=20 is a workaround for a problem with the MSYS2 update +# process. Without it the following error is printed and the appveyor script +# halts: "msys2-runtime and catgets are in conflict. Remove catgets?" +# See also: https://github.com/Alexpux/MSYS2-packages/issues/1141 +install: + - if [%config%]==[MSYS2] ( + C:\msys64\usr\bin\pacman --noconfirm --sync --refresh --refresh --sysupgrade --sysupgrade --ask=20 + && C:\msys64\usr\bin\pacman -Rc --noconfirm mingw-w64-x86_64-gcc-libs + ) + +build_script: + - if [%config%]==[MSYS2] ( + build-msys2.bat + ) else ( + build-appveyor.bat + ) + +# remove garbage VS messages +# http://help.appveyor.com/discussions/problems/4569-the-target-_convertpdbfiles-listed-in-a-beforetargets-attribute-at-c-does-not-exist-in-the-project-and-will-be-ignored +before_build: + - del "C:\Program Files (x86)\MSBuild\14.0\Microsoft.Common.targets\ImportAfter\Xamarin.Common.targets" + + +#----------------------------------------------------------------------------- diff --git a/bench/data/README.md b/bench/data/README.md new file mode 100644 index 000000000..202f94db1 --- /dev/null +++ b/bench/data/README.md @@ -0,0 +1,13 @@ + + +mapbox-streets-v6/14/8714/8017.vector.pbf + + - http://c.tile.openstreetmap.org/14/8714/8017.png + - https://a.tiles.mapbox.com/v4/mapbox.mapbox-streets-v6/14/8714/8017.vector.pbf + - https://www.mapbox.com/developers/vector-tiles/mapbox-streets/ + +enf-14-4824-6157.vector.pbf + + - enf.8k273nmi + - https://b.tiles.mapbox.com/v4/enf.c3a2de35/14/4824/6157@2x.png + - https://www.mapbox.com/blog/twitter-map-every-tweet/ \ No newline at end of file diff --git a/bench/data/enf-14-4824-6157.vector.pbf b/bench/data/enf-14-4824-6157.vector.pbf new file mode 100644 index 000000000..dcd8717b4 Binary files /dev/null and b/bench/data/enf-14-4824-6157.vector.pbf differ diff --git a/bench/data/mapbox-streets-v6-14-8714-8017.vector.pbf b/bench/data/mapbox-streets-v6-14-8714-8017.vector.pbf new file mode 100644 index 000000000..9553b22da Binary files /dev/null and b/bench/data/mapbox-streets-v6-14-8714-8017.vector.pbf differ diff --git a/build-appveyor.bat b/build-appveyor.bat new file mode 100644 index 000000000..76e848c29 --- /dev/null +++ b/build-appveyor.bat @@ -0,0 +1,65 @@ +@ECHO OFF +SETLOCAL +SET EL=0 + +ECHO ~~~~~~ %~f0 ~~~~~~ + +::show all available env vars +SET +ECHO cmake on AppVeyor +cmake -version + +ECHO activating VS cmd prompt && CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64 +IF %ERRORLEVEL% NEQ 0 GOTO ERROR + +SET protobuf_sdk=protozero-dep-protobuf-2.6.1.7z +IF EXIST %protobuf_sdk% (ECHO protobuf already downloaded) ELSE (ECHO downloading protobuf ... && powershell Invoke-WebRequest https://mapbox.s3.amazonaws.com/windows-builds/windows-build-deps/$env:protobuf_sdk -OutFile $pwd\$env:protobuf_sdk) +IF %ERRORLEVEL% NEQ 0 GOTO ERROR +IF EXIST deps\protobuf (ECHO protobuf already extracted) ELSE (CALL 7z x -y %protobuf_sdk% | %windir%\system32\FIND "ing archive") +IF %ERRORLEVEL% NEQ 0 GOTO ERROR +SET PATH=%~dp0deps\protobuf;%PATH% + +IF EXIST build ECHO deleting build dir... && RD /Q /S build +IF %ERRORLEVEL% NEQ 0 GOTO ERROR + +MKDIR build +IF %ERRORLEVEL% NEQ 0 GOTO ERROR + +CD build +ECHO config^: %config% + +::This will produce lots of LNK4099 warnings which can be ignored. +::Unfortunately they can't be disabled, see +::http://stackoverflow.com/questions/661606/visual-c-how-to-disable-specific-linker-warnings +SET CMAKE_CMD=cmake .. ^ +-LA -G "Visual Studio 14 Win64" + +ECHO calling^: %CMAKE_CMD% +%CMAKE_CMD% +IF %ERRORLEVEL% NEQ 0 GOTO ERROR + +SET avlogger= +IF /I "%APPVEYOR%"=="True" SET avlogger=/logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" + +msbuild protozero.sln ^ +/p:Configuration=%config% ^ +/toolsversion:14.0 ^ +/p:Platform=x64 ^ +/p:PlatformToolset=v140 %avlogger% +IF %ERRORLEVEL% NEQ 0 GOTO ERROR + +ctest --output-on-failure ^ +-C %config% ^ +IF %ERRORLEVEL% NEQ 0 GOTO ERROR + +GOTO DONE + +:ERROR +ECHO ~~~~~~ ERROR %~f0 ~~~~~~ +SET EL=%ERRORLEVEL% + +:DONE +IF %EL% NEQ 0 ECHO. && ECHO !!! ERRORLEVEL^: %EL% !!! && ECHO. +ECHO ~~~~~~ DONE %~f0 ~~~~~~ + +EXIT /b %EL% diff --git a/build-local.bat b/build-local.bat new file mode 100644 index 000000000..62db254ac --- /dev/null +++ b/build-local.bat @@ -0,0 +1,29 @@ +@ECHO OFF +SETLOCAL +SET EL=0 + +ECHO =========== %~f0 =========== + +SET VERBOSITY_MSBUILD=diagnostic +IF NOT "%1"=="" SET VERBOSITY_MSBUILD=%1 +SET platform=x64 +SET configuration=Release +CALL build-appveyor.bat %VERBOSITY_MSBUILD% +IF %ERRORLEVEL% NEQ 0 GOTO ERROR + +SET platform=x86 +SET configuration=Debug +CALL build-appveyor.bat %VERBOSITY_MSBUILD% +IF %ERRORLEVEL% NEQ 0 GOTO ERROR + +GOTO DONE + +:ERROR +ECHO =========== ERROR %~f0 =========== +ECHO ERRORLEVEL^: %ERRORLEVEL% +SET EL=%ERRORLEVEL% + +:DONE +ECHO =========== DONE %~f0 =========== + +EXIT /b %EL% diff --git a/build-msys2.bat b/build-msys2.bat new file mode 100644 index 000000000..1a02156b5 --- /dev/null +++ b/build-msys2.bat @@ -0,0 +1,18 @@ +echo "Adding MSYS2 to path..." +SET "PATH=C:\msys64\mingw64\bin;C:\msys64\usr\bin;%PATH%" +echo %PATH% + +echo "Installing MSYS2 packages..." +bash -lc "pacman -S --needed --noconfirm mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake mingw-w64-x86_64-doxygen mingw-w64-x86_64-protobuf" + +echo "Generating makefiles" +mkdir build +cd build +cmake .. -LA -G "MSYS Makefiles" + +echo "Building" +make VERBOSE=1 + +echo "Testing" +ctest --output-on-failure + diff --git a/cmake/FindProtozero.cmake b/cmake/FindProtozero.cmake new file mode 100644 index 000000000..ad16cabeb --- /dev/null +++ b/cmake/FindProtozero.cmake @@ -0,0 +1,63 @@ +#---------------------------------------------------------------------- +# +# FindProtozero.cmake +# +# Find the protozero headers. +# +#---------------------------------------------------------------------- +# +# Usage: +# +# Copy this file somewhere into your project directory, where cmake can +# find it. Usually this will be a directory called "cmake" which you can +# add to the CMake module search path with the following line in your +# CMakeLists.txt: +# +# list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake") +# +# Then add the following in your CMakeLists.txt: +# +# find_package(Protozero [version] [REQUIRED]) +# include_directories(SYSTEM ${PROTOZERO_INCLUDE_DIR}) +# +# The version number is optional. If it is not set, any version of +# protozero will do. +# +# if(NOT PROTOZERO_FOUND) +# message(WARNING "Protozero not found!\n") +# endif() +# +#---------------------------------------------------------------------- +# +# Variables: +# +# PROTOZERO_FOUND - True if Protozero was found. +# PROTOZERO_INCLUDE_DIR - Where to find include files. +# +#---------------------------------------------------------------------- + +# find include path +find_path(PROTOZERO_INCLUDE_DIR protozero/version.hpp + PATH_SUFFIXES include + PATHS ${CMAKE_SOURCE_DIR}/../protozero +) + +# Check version number +if(Protozero_FIND_VERSION) + file(STRINGS "${PROTOZERO_INCLUDE_DIR}/protozero/version.hpp" _version_define REGEX "#define PROTOZERO_VERSION_STRING") + if("${_version_define}" MATCHES "#define PROTOZERO_VERSION_STRING \"([0-9.]+)\"") + set(_version "${CMAKE_MATCH_1}") + else() + set(_version "unknown") + endif() +endif() + +#set(PROTOZERO_INCLUDE_DIRS "${PROTOZERO_INCLUDE_DIR}") + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(Protozero + REQUIRED_VARS PROTOZERO_INCLUDE_DIR + VERSION_VAR _version) + + +#---------------------------------------------------------------------- diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 000000000..77c5420a6 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,37 @@ +#----------------------------------------------------------------------------- +# +# CMake Config +# +# protozero documentation +# +#----------------------------------------------------------------------------- + +message(STATUS "Configuring documentation") + +message(STATUS "Looking for doxygen") +find_package(Doxygen) + +if(DOXYGEN_FOUND) + message(STATUS "Looking for doxygen - found") + configure_file(Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) + + file(GLOB HEADER_FILES "${CMAKE_SOURCE_DIR}/include/protozero/*.hpp") + add_custom_command(OUTPUT html/index.html + COMMAND ${DOXYGEN_EXECUTABLE} + ARGS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + DEPENDS Doxyfile.in advanced.md cheatsheet.md tutorial.md + ${HEADER_FILES} + WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} + COMMENT "Generating API documentation with Doxygen" VERBATIM) + add_custom_target(doc ALL + DEPENDS html/index.html) +else() + message(STATUS "Looking for doxygen - not found") + message(STATUS " Disabled making of documentation.") +endif() + +#----------------------------------------------------------------------------- +message(STATUS "Configuring documentation - done") + + +#----------------------------------------------------------------------------- diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in new file mode 100644 index 000000000..148190551 --- /dev/null +++ b/doc/Doxyfile.in @@ -0,0 +1,2355 @@ +# Doxyfile 1.8.8 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "protozero" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = @PROTOZERO_VERSION@ + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Minimalistic protocol buffer decoder and encoder in C++." + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = "@PROJECT_BINARY_DIR@/doc" + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = @PROJECT_SOURCE_DIR@/README.md \ + @PROJECT_SOURCE_DIR@/UPGRADING.md \ + @PROJECT_SOURCE_DIR@/doc \ + @PROJECT_SOURCE_DIR@/include/protozero + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = protozero::detail protozero_assert PROTOZERO_*_ENDIAN PROTOZERO_BYTE_ORDER + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = @PROJECT_SOURCE_DIR@/README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra stylesheet files is of importance (e.g. the last +# stylesheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /