From afb0a8fea788ba3157defd798a7ccb06860f3799 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Tue, 18 Feb 2025 11:18:17 +0100 Subject: [PATCH] Adding upstream version 2.0.24. Signed-off-by: Daniel Baumann --- .github/workflows/ci.yml | 213 + .github/workflows/devel-push.yml | 145 + .gitignore | 1 + .lgtm.yml | 19 + CMakeLists.txt | 341 ++ CMakeModules/ABICheck.cmake | 66 + CMakeModules/FindCMocka.cmake | 49 + CMakeModules/FindLibSSH.cmake | 117 + CMakeModules/FindLibVAL.cmake | 102 + CMakeModules/FindLibYANG.cmake | 89 + CMakeModules/FindUncrustify.cmake | 21 + CMakeModules/GenCoverage.cmake | 118 + CMakeModules/GenDoc.cmake | 28 + CMakeModules/SourceFormat.cmake | 32 + CMakeModules/UseCompat.cmake | 57 + CMakeModules/uninstall.cmake | 27 + CODINGSTYLE.md | 184 + Doxyfile.in | 2457 +++++++++++ FAQ.md | 38 + FindLibNETCONF2.cmake | 85 + LICENSE | 27 + README.md | 285 ++ codecov.yml | 32 + compat/check_includes.sh | 44 + compat/compat.c | 250 ++ compat/compat.h.in | 158 + distro/config/apkg.toml | 10 + distro/pkg/deb/changelog | 5 + distro/pkg/deb/compat | 1 + distro/pkg/deb/control | 44 + distro/pkg/deb/copyright | 46 + distro/pkg/deb/gbp.conf | 4 + distro/pkg/deb/libnetconf2-2.install | 1 + distro/pkg/deb/libnetconf2-dev.install | 5 + distro/pkg/deb/rules | 12 + distro/pkg/deb/source/format | 1 + distro/pkg/deb/watch | 4 + distro/pkg/rpm/libnetconf2.spec | 61 + distro/scripts/make-archive.sh | 17 + distro/scripts/upstream-version.sh | 7 + doc/cesnet-style.css | 106 + libnetconf2.pc.in | 12 + modules/ietf-netconf-acm@2018-02-14.yang | 464 +++ .../ietf-netconf-monitoring@2010-10-04.yang | 558 +++ modules/ietf-netconf@2013-09-29.yang | 939 +++++ modules/ietf_netconf@2013-09-29_yang.h | 2251 ++++++++++ .../ietf_netconf_monitoring@2010-10-04_yang.h | 1454 +++++++ nc_client.h.in | 35 + nc_server.h.in | 35 + src/config.h.in | 69 + src/io.c | 1212 ++++++ src/libnetconf.h | 669 +++ src/log.c | 148 + src/log.h | 96 + src/log_p.h | 54 + src/messages_client.c | 1234 ++++++ src/messages_client.h | 555 +++ src/messages_p.h | 263 ++ src/messages_server.c | 901 ++++ src/messages_server.h | 340 ++ src/netconf.h | 134 + src/session.c | 1694 ++++++++ src/session.h | 244 ++ src/session_client.c | 2946 +++++++++++++ src/session_client.h | 631 +++ src/session_client_ch.h | 354 ++ src/session_client_ssh.c | 1911 +++++++++ src/session_client_tls.c | 848 ++++ src/session_p.h | 861 ++++ src/session_server.c | 3665 +++++++++++++++++ src/session_server.h | 930 +++++ src/session_server_ch.h | 436 ++ src/session_server_ssh.c | 1709 ++++++++ src/session_server_tls.c | 2005 +++++++++ tests/CMakeLists.txt | 78 + tests/client/test_client.c | 125 + tests/client/test_client_messages.c | 709 ++++ tests/client/test_client_ssh.c | 813 ++++ tests/client/test_client_tls.c | 200 + tests/config.h.in | 24 + tests/data/042686bb.0 | 1 + tests/data/5412ca73.0 | 1 + tests/data/62436b04.0 | 1 + tests/data/client.crt | 25 + tests/data/client.key | 51 + tests/data/key_dsa | 12 + tests/data/key_dsa.pub | 1 + tests/data/key_ecdsa | 5 + tests/data/key_ecdsa.pub | 1 + tests/data/key_rsa | 27 + tests/data/key_rsa.pub | 1 + tests/data/modules/ietf-netconf-acm.yin | 464 +++ .../data/modules/ietf-netconf-monitoring.yin | 600 +++ .../modules/ietf-netconf-notifications.yin | 353 ++ .../modules/ietf-netconf-with-defaults.yin | 149 + tests/data/modules/ietf-netconf.yin | 1032 +++++ tests/data/modules/module-a-dv.yang | 16 + tests/data/modules/module-a-dv2.yang | 21 + tests/data/modules/module-a.yang | 23 + tests/data/modules/nc-notifications.yin | 102 + tests/data/modules/notif1.yang | 10 + tests/data/modules/notifications.yin | 96 + tests/data/nc10/rpc-lock | 9 + tests/data/nc11/rpc-lock | 7 + tests/data/server.crt | 26 + tests/data/server.key | 51 + tests/data/serverca.key | 27 + tests/data/serverca.pem | 22 + tests/ld.supp | 10 + tests/test_client_thread.c | 77 + tests/test_fd_comm.c | 555 +++ tests/test_init_destroy_client.c | 69 + tests/test_init_destroy_server.c | 75 + tests/test_io.c | 186 + tests/test_server_thread.c | 765 ++++ tests/test_server_thread.supp | 15 + tests/test_thread_messages.c | 189 + uncrustify.cfg | 3094 ++++++++++++++ 118 files changed, 45084 insertions(+) create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/devel-push.yml create mode 100644 .gitignore create mode 100644 .lgtm.yml create mode 100644 CMakeLists.txt create mode 100644 CMakeModules/ABICheck.cmake create mode 100644 CMakeModules/FindCMocka.cmake create mode 100644 CMakeModules/FindLibSSH.cmake create mode 100644 CMakeModules/FindLibVAL.cmake create mode 100644 CMakeModules/FindLibYANG.cmake create mode 100644 CMakeModules/FindUncrustify.cmake create mode 100644 CMakeModules/GenCoverage.cmake create mode 100644 CMakeModules/GenDoc.cmake create mode 100644 CMakeModules/SourceFormat.cmake create mode 100644 CMakeModules/UseCompat.cmake create mode 100644 CMakeModules/uninstall.cmake create mode 100644 CODINGSTYLE.md create mode 100644 Doxyfile.in create mode 100644 FAQ.md create mode 100644 FindLibNETCONF2.cmake create mode 100644 LICENSE create mode 100644 README.md create mode 100644 codecov.yml create mode 100755 compat/check_includes.sh create mode 100644 compat/compat.c create mode 100644 compat/compat.h.in create mode 100644 distro/config/apkg.toml create mode 100644 distro/pkg/deb/changelog create mode 100644 distro/pkg/deb/compat create mode 100644 distro/pkg/deb/control create mode 100644 distro/pkg/deb/copyright create mode 100644 distro/pkg/deb/gbp.conf create mode 100644 distro/pkg/deb/libnetconf2-2.install create mode 100644 distro/pkg/deb/libnetconf2-dev.install create mode 100755 distro/pkg/deb/rules create mode 100644 distro/pkg/deb/source/format create mode 100644 distro/pkg/deb/watch create mode 100644 distro/pkg/rpm/libnetconf2.spec create mode 100755 distro/scripts/make-archive.sh create mode 100755 distro/scripts/upstream-version.sh create mode 100644 doc/cesnet-style.css create mode 100644 libnetconf2.pc.in create mode 100644 modules/ietf-netconf-acm@2018-02-14.yang create mode 100644 modules/ietf-netconf-monitoring@2010-10-04.yang create mode 100644 modules/ietf-netconf@2013-09-29.yang create mode 100644 modules/ietf_netconf@2013-09-29_yang.h create mode 100644 modules/ietf_netconf_monitoring@2010-10-04_yang.h create mode 100644 nc_client.h.in create mode 100644 nc_server.h.in create mode 100644 src/config.h.in create mode 100644 src/io.c create mode 100644 src/libnetconf.h create mode 100644 src/log.c create mode 100644 src/log.h create mode 100644 src/log_p.h create mode 100644 src/messages_client.c create mode 100644 src/messages_client.h create mode 100644 src/messages_p.h create mode 100644 src/messages_server.c create mode 100644 src/messages_server.h create mode 100644 src/netconf.h create mode 100644 src/session.c create mode 100644 src/session.h create mode 100644 src/session_client.c create mode 100644 src/session_client.h create mode 100644 src/session_client_ch.h create mode 100644 src/session_client_ssh.c create mode 100644 src/session_client_tls.c create mode 100644 src/session_p.h create mode 100644 src/session_server.c create mode 100644 src/session_server.h create mode 100644 src/session_server_ch.h create mode 100644 src/session_server_ssh.c create mode 100644 src/session_server_tls.c create mode 100644 tests/CMakeLists.txt create mode 100644 tests/client/test_client.c create mode 100644 tests/client/test_client_messages.c create mode 100644 tests/client/test_client_ssh.c create mode 100644 tests/client/test_client_tls.c create mode 100644 tests/config.h.in create mode 120000 tests/data/042686bb.0 create mode 120000 tests/data/5412ca73.0 create mode 120000 tests/data/62436b04.0 create mode 100644 tests/data/client.crt create mode 100644 tests/data/client.key create mode 100644 tests/data/key_dsa create mode 100644 tests/data/key_dsa.pub create mode 100644 tests/data/key_ecdsa create mode 100644 tests/data/key_ecdsa.pub create mode 100644 tests/data/key_rsa create mode 100644 tests/data/key_rsa.pub create mode 100644 tests/data/modules/ietf-netconf-acm.yin create mode 100644 tests/data/modules/ietf-netconf-monitoring.yin create mode 100644 tests/data/modules/ietf-netconf-notifications.yin create mode 100644 tests/data/modules/ietf-netconf-with-defaults.yin create mode 100644 tests/data/modules/ietf-netconf.yin create mode 100644 tests/data/modules/module-a-dv.yang create mode 100644 tests/data/modules/module-a-dv2.yang create mode 100644 tests/data/modules/module-a.yang create mode 100644 tests/data/modules/nc-notifications.yin create mode 100644 tests/data/modules/notif1.yang create mode 100644 tests/data/modules/notifications.yin create mode 100644 tests/data/nc10/rpc-lock create mode 100644 tests/data/nc11/rpc-lock create mode 100644 tests/data/server.crt create mode 100644 tests/data/server.key create mode 100644 tests/data/serverca.key create mode 100644 tests/data/serverca.pem create mode 100644 tests/ld.supp create mode 100644 tests/test_client_thread.c create mode 100644 tests/test_fd_comm.c create mode 100644 tests/test_init_destroy_client.c create mode 100644 tests/test_init_destroy_server.c create mode 100644 tests/test_io.c create mode 100644 tests/test_server_thread.c create mode 100644 tests/test_server_thread.supp create mode 100644 tests/test_thread_messages.c create mode 100644 uncrustify.cfg diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..b8bbc67 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,213 @@ +name: libnetconf2 CI +on: + push: + branches: + - master + - devel + pull_request: + branches: + - master + - devel + +env: + DEFAULT_PACKAGES: libcmocka-dev zlib1g-dev libssh-dev libssl-dev + +jobs: + git-branch: + name: Get git branch + runs-on: ubuntu-18.04 + outputs: + branch-name: ${{ steps.get-git-branch.outputs.branch-name }} + steps: + - id: get-git-branch + run: | + if ${{ github.event_name == 'push' }} + then export GIT_BRANCH=`echo ${{ github.ref }} | cut -d'/' -f 3` + else + export GIT_BRANCH=${{ github.base_ref }} + fi + echo "::set-output name=branch-name::$GIT_BRANCH" + + build: + name: ${{ matrix.config.name }} + runs-on: ${{ matrix.config.os }} + needs: git-branch + strategy: + fail-fast: false + matrix: + config: + - { + name: "Release, Ubuntu 18.04, gcc", + os: "ubuntu-18.04", + build-type: "Release", + dep-build-type: "Release", + cc: "gcc", + options: "-DENABLE_TESTS=ON -DENABLE_DNSSEC=ON", + packages: "", + snaps: "", + make-prepend: "", + make-target: "" + } + - { + name: "Release, Ubuntu 18.04, clang", + os: "ubuntu-18.04", + build-type: "Release", + dep-build-type: "Release", + cc: "clang", + options: "-DENABLE_TESTS=ON -DENABLE_DNSSEC=ON", + packages: "", + snaps: "", + make-prepend: "", + make-target: "" + } + - { + name: "Debug, Ubuntu 18.04, gcc", + os: "ubuntu-18.04", + build-type: "Debug", + dep-build-type: "Release", + cc: "gcc", + options: "-DENABLE_DNSSEC=ON", + packages: "valgrind", + snaps: "", + make-prepend: "", + make-target: "" + } + - { + name: "Debug, Ubuntu 18.04, clang", + os: "ubuntu-18.04", + build-type: "Debug", + dep-build-type: "Release", + cc: "clang", + options: "-DENABLE_DNSSEC=ON", + packages: "valgrind", + snaps: "", + make-prepend: "", + make-target: "" + } + - { + name: "SSH Only", + os: "ubuntu-18.04", + build-type: "Debug", + dep-build-type: "Release", + cc: "gcc", + options: "-DENABLE_TLS=OFF -DENABLE_SSH=ON", + packages: "valgrind", + snaps: "", + make-prepend: "", + make-target: "" + } + - { + name: "TLS Only", + os: "ubuntu-18.04", + build-type: "Debug", + dep-build-type: "Release", + cc: "gcc", + options: "-DENABLE_TLS=ON -DENABLE_SSH=OFF", + packages: "valgrind", + snaps: "", + make-prepend: "", + make-target: "" + } + - { + name: "No SSH nor TLS", + os: "ubuntu-18.04", + build-type: "Debug", + dep-build-type: "Release", + cc: "gcc", + options: "-DENABLE_TLS=OFF -DENABLE_SSH=OFF", + packages: "valgrind", + snaps: "", + make-prepend: "", + make-target: "" + } + - { + name: "ASAN and UBSAN", + os: "ubuntu-18.04", + build-type: "Debug", + dep-build-type: "Release", + cc: "clang", + options: "-DCMAKE_C_FLAGS=-fsanitize=address,undefined -DENABLE_VALGRIND_TESTS=OFF", + packages: "", + snaps: "", + make-prepend: "", + make-target: "" + } + - { + name: "ABI Check", + os: "ubuntu-latest", + build-type: "ABICheck", + dep-build-type: "Debug", + cc: "gcc", + options: "", + packages: "abi-dumper abi-compliance-checker snap", + snaps: "core universal-ctags", + make-prepend: "", + make-target: "abi-check" + } + + steps: + - uses: actions/checkout@v2 + + - name: Deps-packages + shell: bash + run: | + sudo add-apt-repository ppa:kedazo/libssh-0.7.x -y + sudo apt-get update + sudo apt-get install $DEFAULT_PACKAGES ${{ matrix.config.packages }} + if ${{ matrix.config.snaps != '' }} + then sudo snap refresh; sudo snap install ${{ matrix.config.snaps }} + fi + + - name: Deps-uncrustify + shell: bash + working-directory: ${{ github.workspace }} + run: | + git clone --branch uncrustify-0.71.0 https://github.com/uncrustify/uncrustify + cd uncrustify + mkdir build + cd build + CC=${{ matrix.config.cc }} cmake .. + make + sudo make install + if: ${{ matrix.config.name == 'Debug, Ubuntu 18.04, gcc' }} + + - name: Deps-libyang + shell: bash + run: | + git clone -b ${{needs.git-branch.outputs.branch-name}} https://github.com/CESNET/libyang.git + cd libyang + mkdir build + cd build + CC=${{ matrix.config.cc }} cmake -DCMAKE_BUILD_TYPE=${{ matrix.config.dep-build-type }} -DENABLE_BUILD_TESTS=OFF .. + make -j2 + sudo make install + + - name: Deps-libval + shell: bash + run: | + git clone https://github.com/DNSSEC-Tools/DNSSEC-Tools.git dnssec-tools + cd dnssec-tools/dnssec-tools/validator + ./configure + make -j2 + sudo make install + + - name: Configure + shell: bash + working-directory: ${{ github.workspace }} + run: | + mkdir build + cd build + CC=${{ matrix.config.cc }} cmake -DCMAKE_BUILD_TYPE=${{ matrix.config.build-type }} ${{ matrix.config.options }} .. + + - name: Build + shell: bash + working-directory: ${{ github.workspace }}/build + run: | + export LC_ALL=C.UTF-8 + export PATH=/snap/bin:${{ github.workspace }}/coverity-tools/bin:$PATH + ${{ matrix.config.make-prepend }} make ${{ matrix.config.make-target }} + + - name: Test + shell: bash + working-directory: ${{ github.workspace }}/build + run: ctest --output-on-failure diff --git a/.github/workflows/devel-push.yml b/.github/workflows/devel-push.yml new file mode 100644 index 0000000..49918a8 --- /dev/null +++ b/.github/workflows/devel-push.yml @@ -0,0 +1,145 @@ +name: libnetconf2 devel push +on: + push: + branches: + - devel + +env: + DEFAULT_PACKAGES: libcmocka-dev zlib1g-dev libssh-dev libssl-dev + COVERITY_PROJECT: CESNET%2Flibnetconf2 + +jobs: + git-branch: + name: Get git branch + runs-on: ubuntu-18.04 + outputs: + branch-name: ${{ steps.get-git-branch.outputs.branch-name }} + steps: + - id: get-git-branch + run: | + if ${{ github.event_name == 'push' }} + then export GIT_BRANCH=`echo ${{ github.ref }} | cut -d'/' -f 3` + else + export GIT_BRANCH=${{ github.base_ref }} + fi + echo "::set-output name=branch-name::$GIT_BRANCH" + + build: + name: ${{ matrix.config.name }} + runs-on: ${{ matrix.config.os }} + needs: git-branch + strategy: + fail-fast: false + matrix: + config: + - { + name: "Coverity", + os: "ubuntu-latest", + build-type: "Debug", + dep-build-type: "Debug", + cc: "clang", + options: "-DENABLE_DNSSEC=ON", + packages: "", + snaps: "", + make-prepend: "cov-build --dir cov-int", + make-target: "" + } + - { + name: "Codecov", + os: "ubuntu-latest", + build-type: "Debug", + dep-build-type: "Debug", + cc: "gcc", + options: "-DENABLE_COVERAGE=ON -DENABLE_DNSSEC=ON", + packages: "lcov", + snaps: "", + make-prepend: "", + make-target: "" + } + + steps: + - uses: actions/checkout@v2 + + - name: Deps-packages + shell: bash + run: | + sudo add-apt-repository ppa:kedazo/libssh-0.7.x -y + sudo apt-get update + sudo apt-get install $DEFAULT_PACKAGES ${{ matrix.config.packages }} + if ${{ matrix.config.snaps != '' }} + then sudo snap install ${{ matrix.config.snaps }} + fi + + - name: Deps-coverity + shell: bash + working-directory: ${{ github.workspace }} + run: | + wget -q https://scan.coverity.com/download/linux64 --post-data "token=$TOKEN&project=$COVERITY_PROJECT" -O coverity-tools.tar.gz + mkdir coverity-tools + tar xzf coverity-tools.tar.gz --strip 1 -C coverity-tools + env: + TOKEN: ${{ secrets.COVERITY_SCAN_TOKEN }} + if: ${{ matrix.config.name == 'Coverity' }} + + - name: Deps-libyang + shell: bash + run: | + git clone -b ${{needs.git-branch.outputs.branch-name}} https://github.com/CESNET/libyang.git + cd libyang + mkdir build + cd build + CC=${{ matrix.config.cc }} cmake -DCMAKE_BUILD_TYPE=${{ matrix.config.dep-build-type }} -DENABLE_BUILD_TESTS=OFF .. + make -j2 + sudo make install + + - name: Deps-libval + shell: bash + run: | + git clone https://github.com/DNSSEC-Tools/DNSSEC-Tools.git dnssec-tools + cd dnssec-tools/dnssec-tools/validator + ./configure + make -j2 + sudo make install + + - name: Configure + shell: bash + working-directory: ${{ github.workspace }} + run: | + mkdir build + cd build + CC=${{ matrix.config.cc }} cmake -DCMAKE_BUILD_TYPE=${{ matrix.config.build-type }} ${{ matrix.config.options }} .. + + - name: Build + shell: bash + working-directory: ${{ github.workspace }}/build + run: | + export LC_ALL=C.UTF-8 + export PATH=/snap/bin:${{ github.workspace }}/coverity-tools/bin:$PATH + ${{ matrix.config.make-prepend }} make ${{ matrix.config.make-target }} + + - name: Test + shell: bash + working-directory: ${{ github.workspace }}/build + run: ctest --output-on-failure + + - name: Upload to Coverity.com + shell: bash + working-directory: ${{ github.workspace }}/build + run: | + tar czvf libnetconf2.tgz cov-int + curl \ + --form token=$TOKEN \ + --form email=mvasko@cesnet.cz \ + --form file=@libnetconf2.tgz \ + --form version="`grep Version ./libnetconf2.pc | cut -d' ' -f 2`" \ + --form description="libnetconf2 NETCONF library" \ + https://scan.coverity.com/builds?project=$COVERITY_PROJECT + env: + TOKEN: ${{ secrets.COVERITY_SCAN_TOKEN }} + if: ${{ matrix.config.name == 'Coverity' }} + + - name: Upload to Codecov.io + shell: bash + working-directory: ${{ github.workspace }}/build + run: bash <(curl -s https://codecov.io/bash) + if: ${{ matrix.config.name == 'Codecov' }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fc5bd90 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/pkg diff --git a/.lgtm.yml b/.lgtm.yml new file mode 100644 index 0000000..2794096 --- /dev/null +++ b/.lgtm.yml @@ -0,0 +1,19 @@ +extraction: + cpp: + prepare: + packages: libpcre2-dev + after_prepare: + - cd $LGTM_WORKSPACE + - git clone -b devel https://github.com/CESNET/libyang.git + - cd libyang; mkdir build; cd build + - cmake -DCMAKE_INSTALL_PREFIX=$LGTM_WORKSPACE -DENABLE_BUILD_TESTS=OFF .. + - make -j2 + - make install + configure: + command: + - mkdir build; cd build + - cmake -DCMAKE_INCLUDE_PATH=$LGTM_WORKSPACE/include -DCMAKE_LIBRARY_PATH=$LGTM_WORKSPACE/lib .. + index: + build_command: + - cd build + - make -j2 diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..c659ab4 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,341 @@ +cmake_minimum_required(VERSION 2.8.12) + +project(libnetconf2 C) + +# include custom Modules +list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/CMakeModules/") + +include(GNUInstallDirs) +include(CheckFunctionExists) +include(CheckCSourceCompiles) +include(CheckIncludeFile) +include(UseCompat) +include(ABICheck) +include(SourceFormat) +include(GenDoc) +include(GenCoverage) + +if(POLICY CMP0075) + cmake_policy(SET CMP0075 NEW) +endif() + +set(LIBNETCONF2_DESCRIPTION "NETCONF server and client library in C.") + +# check the supported platform +if(NOT UNIX) + message(FATAL_ERROR "Only *nix like systems are supported.") +endif() + +# osx specific +set(CMAKE_MACOSX_RPATH TRUE) + +# set default build type if not specified by user +if(NOT CMAKE_BUILD_TYPE) + set(CMAKE_BUILD_TYPE Debug) +endif() +# see https://github.com/CESNET/libyang/pull/1692 for why CMAKE_C_FLAGS_ are not used directly +# normalize build type string +string(TOUPPER "${CMAKE_BUILD_TYPE}" BUILD_TYPE_UPPER) +if ("${BUILD_TYPE_UPPER}" STREQUAL "RELEASE") + set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Build Type" FORCE) + set(CMAKE_C_FLAGS "-DNDEBUG -O2 ${CMAKE_C_FLAGS}") +elseif("${BUILD_TYPE_UPPER}" STREQUAL "DEBUG") + set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build Type" FORCE) + set(CMAKE_C_FLAGS "-g -O0 ${CMAKE_C_FLAGS}") +elseif("${BUILD_TYPE_UPPER}" STREQUAL "RELWITHDEBINFO") + set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Build Type" FORCE) +elseif("${BUILD_TYPE_UPPER}" STREQUAL "RELWITHDEBUG") + set(CMAKE_BUILD_TYPE "RelWithDebug" CACHE STRING "Build Type" FORCE) +elseif("${BUILD_TYPE_UPPER}" STREQUAL "ABICHECK") + set(CMAKE_BUILD_TYPE "ABICheck" CACHE STRING "Build Type" FORCE) + set(CMAKE_C_FLAGS "-g -Og ${CMAKE_C_FLAGS}") +elseif("${BUILD_TYPE_UPPER}" STREQUAL "DOCONLY") + set(CMAKE_BUILD_TYPE "DocOnly" CACHE STRING "Build Type" FORCE) +endif() + +# Version of the project +# Generic version of not only the library. Major version is reserved for really big changes of the project, +# minor version changes with added functionality (new tool, functionality of the tool or library, ...) and +# micro version is changed with a set of small changes or bugfixes anywhere in the project. +set(LIBNETCONF2_MAJOR_VERSION 2) +set(LIBNETCONF2_MINOR_VERSION 0) +set(LIBNETCONF2_MICRO_VERSION 24) +set(LIBNETCONF2_VERSION ${LIBNETCONF2_MAJOR_VERSION}.${LIBNETCONF2_MINOR_VERSION}.${LIBNETCONF2_MICRO_VERSION}) + +# Version of the library +# Major version is changed with every backward non-compatible API/ABI change in libyang, minor version changes +# with backward compatible change and micro version is connected with any internal change of the library. +set(LIBNETCONF2_MAJOR_SOVERSION 2) +set(LIBNETCONF2_MINOR_SOVERSION 1) +set(LIBNETCONF2_MICRO_SOVERSION 20) +set(LIBNETCONF2_SOVERSION_FULL ${LIBNETCONF2_MAJOR_SOVERSION}.${LIBNETCONF2_MINOR_SOVERSION}.${LIBNETCONF2_MICRO_SOVERSION}) +set(LIBNETCONF2_SOVERSION ${LIBNETCONF2_MAJOR_SOVERSION}) + +# libyang SO version required +set(LIBYANG_DEP_SOVERSION_MAJOR 2) + +set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -fvisibility=hidden -std=gnu99") + +# +# options +# +if(("${BUILD_TYPE_UPPER}" STREQUAL "DEBUG") OR ("${BUILD_TYPE_UPPER}" STREQUAL "RELWITHDEBINFO")) + option(ENABLE_TESTS "Build tests" ON) + option(ENABLE_VALGRIND_TESTS "Build tests with valgrind" ON) +else() + option(ENABLE_TESTS "Build tests" OFF) + option(ENABLE_VALGRIND_TESTS "Build tests with valgrind" OFF) +endif() +option(ENABLE_COVERAGE "Build code coverage report from tests" OFF) +option(ENABLE_SSH "Enable NETCONF over SSH support (via libssh)" ON) +option(ENABLE_TLS "Enable NETCONF over TLS support (via OpenSSL)" ON) +option(ENABLE_DNSSEC "Enable support for SSHFP retrieval using DNSSEC for SSH (requires OpenSSL and libval)" OFF) +set(READ_INACTIVE_TIMEOUT 20 CACHE STRING "Maximum number of seconds waiting for new data once some data have arrived") +set(READ_ACTIVE_TIMEOUT 300 CACHE STRING "Maximum number of seconds for receiving a full message") +set(MAX_PSPOLL_THREAD_COUNT 6 CACHE STRING "Maximum number of threads that could simultaneously access a ps_poll structure") +set(TIMEOUT_STEP 100 CACHE STRING "Number of microseconds tasks are repeated until timeout elapses") +set(YANG_MODULE_DIR "${CMAKE_INSTALL_PREFIX}/share/yang/modules" CACHE STRING "Directory with common YANG modules") + +# +# sources +# +set(libsrc + src/io.c + src/log.c + src/messages_client.c + src/messages_server.c + src/session.c + src/session_client.c + src/session_server.c) + +if(ENABLE_SSH) + list(APPEND libsrc + src/session_client_ssh.c + src/session_server_ssh.c) + set(SSH_MACRO "#ifndef NC_ENABLED_SSH\n#define NC_ENABLED_SSH\n#endif") +endif() + +if(ENABLE_TLS) + list(APPEND libsrc + src/session_client_tls.c + src/session_server_tls.c) + set(TLS_MACRO "#ifndef NC_ENABLED_TLS\n#define NC_ENABLED_TLS\n#endif") +endif() + +set(headers + src/log.h + src/netconf.h + src/session.h + src/messages_client.h + src/messages_server.h + src/session_client.h + src/session_client_ch.h + src/session_server.h + src/session_server_ch.h) + +# files to generate doxygen from +set(doxy_files + src/libnetconf.h + src/log.h + src/netconf.h + src/session.h + src/messages_client.h + src/messages_server.h + src/session_client.h + src/session_client_ch.h + src/session_server.h + src/session_server_ch.h) + +# source files to be covered by the 'format' target +set(format_sources + compat/*.c + compat/*.h* + src/*.c + src/*.h + tests/*.c + tests/client/*.c) + +# +# checks +# +if(ENABLE_DNSSEC AND NOT ENABLE_SSH) + message(WARNING "DNSSEC SSHFP retrieval cannot be used without SSH support.") + set(ENABLE_DNSSEC OFF) +endif() + +if(ENABLE_VALGRIND_TESTS) + find_program(VALGRIND_FOUND valgrind) + if(NOT VALGRIND_FOUND) + message(WARNING "valgrind executable not found! Disabling memory leaks tests.") + set(ENABLE_VALGRIND_TESTS OFF) + else() + set(ENABLE_TESTS ON) + endif() +endif() + +if(ENABLE_TESTS) + find_package(CMocka 1.0.1) + if(NOT CMOCKA_FOUND) + message(STATUS "Disabling tests because of missing CMocka") + set(ENABLE_TESTS OFF) + endif() +endif() + +if(ENABLE_COVERAGE) + gen_coverage_enable(${ENABLE_TESTS}) +endif() + +if ("${BUILD_TYPE_UPPER}" STREQUAL "DEBUG") + source_format_enable() +endif() + +if("${BUILD_TYPE_UPPER}" STREQUAL "DOCONLY") + gen_doc("${doxy_files}" ${LIBNETCONF2_VERSION} ${LIBNETCONF2_DESCRIPTION} "") + return() +endif() + +# +# targets +# + +# use compat +use_compat() + +# netconf2 target +add_library(netconf2 SHARED ${libsrc} ${compatsrc}) +set_target_properties(netconf2 PROPERTIES VERSION ${LIBNETCONF2_SOVERSION_FULL} SOVERSION ${LIBNETCONF2_SOVERSION}) + +# include repository files with highest priority +include_directories(${PROJECT_BINARY_DIR}/src) + +# dependencies - pthread +set(CMAKE_THREAD_PREFER_PTHREAD TRUE) +find_package(Threads REQUIRED) +target_link_libraries(netconf2 ${CMAKE_THREAD_LIBS_INIT}) + +# check availability for some pthread functions +set(CMAKE_REQUIRED_LIBRARIES pthread) +check_function_exists(pthread_rwlockattr_setkind_np HAVE_PTHREAD_RWLOCKATTR_SETKIND_NP) + +# dependencies - openssl +if(ENABLE_TLS OR ENABLE_DNSSEC OR ENABLE_SSH) + find_package(OpenSSL REQUIRED) + if(ENABLE_TLS) + message(STATUS "OpenSSL found, required for TLS") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DNC_ENABLED_TLS") + endif() + if(OPENSSL_VERSION VERSION_LESS 1.1.1) + message(WARNING "OpenSSL version ${OPENSSL_VERSION} is no longer maintained, consider an update.") + endif() + + target_link_libraries(netconf2 ${OPENSSL_LIBRARIES}) + include_directories(${OPENSSL_INCLUDE_DIR}) +endif() + +# dependencies - libssh +if(ENABLE_SSH) + find_package(LibSSH 0.7.1 REQUIRED) + if(LIBSSH_VERSION VERSION_EQUAL 0.9.3 OR LIBSSH_VERSION VERSION_EQUAL 0.9.4) + message(FATAL_ERROR "LibSSH ${LIBSSH_VERSION} includes regression bugs and libnetconf2 will NOT work properly, try to use another version") + endif() + + target_link_libraries(netconf2 ${LIBSSH_LIBRARIES}) + list(APPEND CMAKE_REQUIRED_LIBRARIES ${LIBSSH_LIBRARIES}) + include_directories(${LIBSSH_INCLUDE_DIRS}) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DNC_ENABLED_SSH") + + # crypt + if(NOT ${CMAKE_SYSTEM_NAME} MATCHES "QNX") + target_link_libraries(netconf2 -lcrypt) + list(APPEND CMAKE_REQUIRED_LIBRARIES crypt) + else() + target_link_libraries(netconf2 -llogin) + list(APPEND CMAKE_REQUIRED_LIBRARIES login) + endif() +endif() + +# dependencies - libval +if(ENABLE_DNSSEC) + find_package(LibVAL REQUIRED) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DENABLE_DNSSEC") + target_link_libraries(netconf2 ${LIBVAL_LIBRARIES}) + include_directories(${LIBVAL_INCLUDE_DIRS}) +endif() + +# dependencies - libyang +find_package(LibYANG ${LIBYANG_DEP_SOVERSION_MAJOR} REQUIRED) +target_link_libraries(netconf2 ${LIBYANG_LIBRARIES}) +include_directories(${LIBYANG_INCLUDE_DIRS}) + +# header file compatibility - shadow.h and crypt.h +check_include_file("shadow.h" HAVE_SHADOW) +check_include_file("crypt.h" HAVE_CRYPT) + +# function compatibility - getpeereid on QNX +if(${CMAKE_SYSTEM_NAME} MATCHES "QNX") + target_link_libraries(netconf2 -lsocket) + list(APPEND CMAKE_REQUIRED_LIBRARIES socket) + list(REMOVE_ITEM CMAKE_REQUIRED_LIBRARIES pthread) + list(APPEND CMAKE_REQUIRED_DEFINITIONS -D_QNX_SOURCE) + check_symbol_exists(getpeereid "sys/types.h;unistd.h" HAVE_GETPEEREID) + list(REMOVE_ITEM CMAKE_REQUIRED_DEFINITIONS -D_QNX_SOURCE) +endif() + +# generate files +configure_file("${PROJECT_SOURCE_DIR}/src/config.h.in" "${PROJECT_BINARY_DIR}/src/config.h" ESCAPE_QUOTES @ONLY) +configure_file(nc_client.h.in nc_client.h) +configure_file(nc_server.h.in nc_server.h) + +# install library +install(TARGETS netconf2 DESTINATION ${CMAKE_INSTALL_LIBDIR}) + +# install headers +install(FILES ${CMAKE_CURRENT_BINARY_DIR}/nc_client.h DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) +install(FILES ${CMAKE_CURRENT_BINARY_DIR}/nc_server.h DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) +install(FILES ${headers} ${PROJECT_BINARY_DIR}/src/config.h DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/libnetconf2) + +# install pkg-config file +find_package(PkgConfig) +if(PKG_CONFIG_FOUND) + configure_file("libnetconf2.pc.in" "libnetconf2.pc" @ONLY) + install(FILES "${CMAKE_CURRENT_BINARY_DIR}/libnetconf2.pc" DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig") + # check that pkg-config includes the used path + execute_process(COMMAND ${PKG_CONFIG_EXECUTABLE} --variable pc_path pkg-config RESULT_VARIABLE RETURN OUTPUT_VARIABLE PC_PATH ERROR_QUIET) + if(RETURN EQUAL 0) + string(REGEX MATCH "${CMAKE_INSTALL_LIBDIR}/pkgconfig" SUBSTR "${PC_PATH}") + string(LENGTH "${SUBSTR}" SUBSTR_LEN) + if(SUBSTR_LEN EQUAL 0) + message(WARNING "pkg-config will not detect the new package after installation, adjust PKG_CONFIG_PATH using \"export PKG_CONFIG_PATH=\${PKG_CONFIG_PATH}:${CMAKE_INSTALL_LIBDIR}/pkgconfig\".") + endif() + endif() +endif() + +# tests +if(ENABLE_TESTS) + enable_testing() + add_subdirectory(tests) +endif() + +# create coverage target for generating coverage reports +gen_coverage("test_.*" "test_.*_valgrind") + +# generate doxygen documentation for libnetconf2 API +gen_doc("${doxy_files}" ${LIBNETCONF2_VERSION} ${LIBNETCONF2_DESCRIPTION} "") + +# generate API/ABI report +if ("${BUILD_TYPE_UPPER}" STREQUAL "ABICHECK") + lib_abi_check(netconf2 "${headers}" ${LIBNETCONF2_SOVERSION_FULL} e7402149e5b36de7acab2e38970a3a9d6a8165d5) +endif() + +# source files to be covered by the 'format' target and a test with 'format-check' target +source_format(${format_sources}) + +# clean cmake cache +add_custom_target(cleancache + COMMAND make clean + COMMAND find . -iname '*cmake*' -not -name CMakeLists.txt -exec rm -rf {} + + COMMAND rm -rf Makefile Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + +# uninstall +add_custom_target(uninstall "${CMAKE_COMMAND}" -P "${CMAKE_MODULE_PATH}/uninstall.cmake") diff --git a/CMakeModules/ABICheck.cmake b/CMakeModules/ABICheck.cmake new file mode 100644 index 0000000..814c5f9 --- /dev/null +++ b/CMakeModules/ABICheck.cmake @@ -0,0 +1,66 @@ +# generate API/ABI report +macro(LIB_ABI_CHECK LIB_TARGET LIB_HEADERS LIB_SOVERSION_FULL ABI_BASE_HASH) + # get short hash + string(SUBSTRING "${ABI_BASE_HASH}" 0 8 ABI_BASE_HASH_SHORT) + + # find abi-dumper + find_program(ABI_DUMPER abi-dumper) + find_package_handle_standard_args(abi-dumper DEFAULT_MSG ABI_DUMPER) + if(NOT ABI_DUMPER) + message(FATAL_ERROR "Program abi-dumper not found!") + endif() + + # find abi-checker + find_program(ABI_CHECKER abi-compliance-checker) + find_package_handle_standard_args(abi-compliance-checker DEFAULT_MSG ABI_CHECKER) + if(NOT ABI_CHECKER) + message(FATAL_ERROR "Program abi-compliance-checker not found!") + endif() + + # abi-dump target - generating an ABI dump + set(PUBLIC_HEADERS ${LIB_HEADERS}) + string(PREPEND PUBLIC_HEADERS "${CMAKE_SOURCE_DIR}/") + string(REPLACE ";" "\n${CMAKE_SOURCE_DIR}/" PUBLIC_HEADERS "${PUBLIC_HEADERS}") + file(GENERATE OUTPUT ${CMAKE_BINARY_DIR}/public_headers CONTENT "${PUBLIC_HEADERS}") + add_custom_target(abi-dump + COMMAND ${ABI_DUMPER} ./lib${LIB_TARGET}${CMAKE_SHARED_LIBRARY_SUFFIX} + -o lib${LIB_TARGET}.${LIB_SOVERSION_FULL}.dump + -lver ${LIB_SOVERSION_FULL} -public-headers ${CMAKE_BINARY_DIR}/public_headers + DEPENDS ${LIB_TARGET} + BYPRODUCTS ${CMAKE_BINARY_DIR}/lib${LIB_TARGET}.${LIB_SOVERSION_FULL}.dump + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMENT "Dumping ABI information of version ${LIB_SOVERSION_FULL} for abi-check") + + # get URL for fetching origin + execute_process(COMMAND git remote get-url origin OUTPUT_VARIABLE ORIGIN_URL OUTPUT_STRIP_TRAILING_WHITESPACE) + + # generate script for generating the base ABI dump + file(GENERATE OUTPUT ${CMAKE_BINARY_DIR}/abibase.sh CONTENT "#!/bin/sh +if [ ! -d abibase ]; then mkdir abibase; fi +cd abibase +if [ ! -f build/lib${LIB_TARGET}.*.dump ]; then + if [ -d .git ] && [ \"${ABI_BASE_HASH}\" != \"`git log --pretty=oneline | cut -d' ' -f1`\" ]; then rm -rf .* 2> /dev/null; fi + if [ ! -d .git ]; then + git init --initial-branch=master + git remote add origin ${ORIGIN_URL} + git fetch origin --depth 1 ${ABI_BASE_HASH} + git reset --hard FETCH_HEAD + fi + if [ ! -d build ]; then mkdir build; fi + cd build + cmake -DCMAKE_BUILD_TYPE=ABICheck .. + make abi-dump +fi +") + + # abi-check target - check ABI compatibility of current version and the base hash version + add_custom_target(abi-check + COMMAND bash ./abibase.sh + COMMAND ${ABI_CHECKER} -l lib${LIB_TARGET}${CMAKE_SHARED_LIBRARY_SUFFIX} + -old abibase/build/lib${LIB_TARGET}.*.dump + -new ./lib${LIB_TARGET}.${LIB_SOVERSION_FULL}.dump -s + DEPENDS ${LIB_TARGET} abi-dump + BYPRODUCTS ${CMAKE_BINARY_DIR}/compat_reports/lib${LIB_TARGET}${CMAKE_SHARED_LIBRARY_SUFFIX}/*_to_${LIB_SOVERSION_FULL}/compat_report.html + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMENT "Checking ABI compatibility of version ${LIB_SOVERSION_FULL} and revision ${ABI_BASE_HASH_SHORT}") +endmacro() diff --git a/CMakeModules/FindCMocka.cmake b/CMakeModules/FindCMocka.cmake new file mode 100644 index 0000000..f8c2a0d --- /dev/null +++ b/CMakeModules/FindCMocka.cmake @@ -0,0 +1,49 @@ +# - Try to find CMocka +# Once done this will define +# +# CMOCKA_ROOT_DIR - Set this variable to the root installation of CMocka +# +# Read-Only variables: +# CMOCKA_FOUND - system has CMocka +# CMOCKA_INCLUDE_DIR - the CMocka include directory +# CMOCKA_LIBRARIES - Link these to use CMocka +# CMOCKA_DEFINITIONS - Compiler switches required for using CMocka +# +#============================================================================= +# Copyright (c) 2011-2012 Andreas Schneider +# +# Distributed under the OSI-approved BSD License (the "License"); +# see accompanying file Copyright.txt for details. +# +# This software is distributed WITHOUT ANY WARRANTY; without even the +# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# See the License for more information. +#============================================================================= +# + +find_path(CMOCKA_INCLUDE_DIR + NAMES + cmocka.h + PATHS + ${CMOCKA_ROOT_DIR}/include +) + +find_library(CMOCKA_LIBRARY + NAMES + cmocka + PATHS + ${CMOCKA_ROOT_DIR}/include +) + +if(CMOCKA_LIBRARY) + set(CMOCKA_LIBRARIES + ${CMOCKA_LIBRARIES} + ${CMOCKA_LIBRARY} + ) +endif() + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(CMocka DEFAULT_MSG CMOCKA_LIBRARIES CMOCKA_INCLUDE_DIR) + +# show the CMOCKA_INCLUDE_DIR and CMOCKA_LIBRARIES variables only in the advanced view +mark_as_advanced(CMOCKA_INCLUDE_DIR CMOCKA_LIBRARIES) diff --git a/CMakeModules/FindLibSSH.cmake b/CMakeModules/FindLibSSH.cmake new file mode 100644 index 0000000..8ef0ac4 --- /dev/null +++ b/CMakeModules/FindLibSSH.cmake @@ -0,0 +1,117 @@ +# - Try to find LibSSH +# Once done this will define +# +# LIBSSH_FOUND - system has LibSSH +# LIBSSH_INCLUDE_DIRS - the LibSSH include directory +# LIBSSH_LIBRARIES - link these to use LibSSH +# LIBSSH_VERSION - +# +# Author Michal Vasko +# Copyright (c) 2020 CESNET, z.s.p.o. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# 1. Redistributions of source code must retain the copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# 3. The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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. +# +include(FindPackageHandleStandardArgs) + +if(LIBSSH_LIBRARIES AND LIBSSH_INCLUDE_DIRS) + # in cache already + set(LIBSSH_FOUND TRUE) +else() + find_path(LIBSSH_INCLUDE_DIR + NAMES + libssh/libssh.h + PATHS + /usr/include + /usr/local/include + /opt/local/include + /sw/include + ${CMAKE_INCLUDE_PATH} + ${CMAKE_INSTALL_PREFIX}/include + ) + + find_library(LIBSSH_LIBRARY + NAMES + ssh.so + libssh.so + libssh.dylib + PATHS + /usr/lib + /usr/local/lib + /opt/local/lib + /sw/lib + ${CMAKE_LIBRARY_PATH} + ${CMAKE_INSTALL_PREFIX}/lib + ) + + if(LIBSSH_INCLUDE_DIR AND LIBSSH_LIBRARY) + # learn libssh version + if(EXISTS ${LIBSSH_INCLUDE_DIR}/libssh/libssh_version.h) + set(LIBSSH_HEADER_PATH ${LIBSSH_INCLUDE_DIR}/libssh/libssh_version.h) + else() + set(LIBSSH_HEADER_PATH ${LIBSSH_INCLUDE_DIR}/libssh/libssh.h) + endif() + file(STRINGS ${LIBSSH_HEADER_PATH} LIBSSH_VERSION_MAJOR + REGEX "#define[ ]+LIBSSH_VERSION_MAJOR[ ]+[0-9]+") + if(NOT LIBSSH_VERSION_MAJOR) + message(STATUS "LIBSSH_VERSION_MAJOR not found, assuming libssh is too old and cannot be used!") + set(LIBSSH_INCLUDE_DIR "LIBSSH_INCLUDE_DIR-NOTFOUND") + set(LIBSSH_LIBRARY "LIBSSH_LIBRARY-NOTFOUND") + else() + string(REGEX MATCH "[0-9]+" LIBSSH_VERSION_MAJOR ${LIBSSH_VERSION_MAJOR}) + file(STRINGS ${LIBSSH_HEADER_PATH} LIBSSH_VERSION_MINOR + REGEX "#define[ ]+LIBSSH_VERSION_MINOR[ ]+[0-9]+") + string(REGEX MATCH "[0-9]+" LIBSSH_VERSION_MINOR ${LIBSSH_VERSION_MINOR}) + file(STRINGS ${LIBSSH_HEADER_PATH} LIBSSH_VERSION_PATCH + REGEX "#define[ ]+LIBSSH_VERSION_MICRO[ ]+[0-9]+") + string(REGEX MATCH "[0-9]+" LIBSSH_VERSION_PATCH ${LIBSSH_VERSION_PATCH}) + + set(LIBSSH_VERSION ${LIBSSH_VERSION_MAJOR}.${LIBSSH_VERSION_MINOR}.${LIBSSH_VERSION_PATCH}) + + if(LIBSSH_VERSION VERSION_LESS 0.8.0) + # libssh_threads also needs to be linked for these versions + string(REPLACE "libssh.so" "libssh_threads.so" + LIBSSH_THREADS_LIBRARY + ${LIBSSH_LIBRARY} + ) + string(REPLACE "libssh.dylib" "libssh_threads.dylib" + LIBSSH_THREADS_LIBRARY + ${LIBSSH_THREADS_LIBRARY} + ) + string(REPLACE "ssh.so" "ssh_threads.so" + LIBSSH_THREADS_LIBRARY + ${LIBSSH_THREADS_LIBRARY} + ) + endif() + endif() + endif() + + set(LIBSSH_INCLUDE_DIRS ${LIBSSH_INCLUDE_DIR}) + set(LIBSSH_LIBRARIES ${LIBSSH_LIBRARY} ${LIBSSH_THREADS_LIBRARY}) + mark_as_advanced(LIBSSH_INCLUDE_DIRS LIBSSH_LIBRARIES) + + find_package_handle_standard_args(LibSSH FOUND_VAR LIBSSH_FOUND + REQUIRED_VARS LIBSSH_INCLUDE_DIRS LIBSSH_LIBRARIES + VERSION_VAR LIBSSH_VERSION) +endif() + diff --git a/CMakeModules/FindLibVAL.cmake b/CMakeModules/FindLibVAL.cmake new file mode 100644 index 0000000..26d4ea2 --- /dev/null +++ b/CMakeModules/FindLibVAL.cmake @@ -0,0 +1,102 @@ +# - Try to find LibVAL +# Once done this will define +# +# LIBVAL_FOUND - system has LibVAL +# LIBVAL_INCLUDE_DIRS - the LibVAL include directory +# LIBVAL_LIBRARIES - link these to use LibVAL +# +# Author Michal Vasko +# Copyright (c) 2015 CESNET, z.s.p.o. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# 1. Redistributions of source code must retain the copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# 3. The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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. +# + +if(LIBVAL_LIBRARIES AND LIBVAL_INCLUDE_DIRS) + # in cache already + set(LIBVAL_FOUND TRUE) +else() + + find_path(LIBVAL_INCLUDE_DIR + NAMES + validator/validator.h + validator/resolver.h + validator/validator-compat.h + validator/val_dane.h + validator/val_errors.h + PATHS + /usr/include + /usr/local/include + /opt/local/include + /sw/include + ${CMAKE_INCLUDE_PATH} + ${CMAKE_INSTALL_PREFIX}/include + ) + + find_library(LIBVAL_LIBRARY + NAMES + libval-threads + val-threads + PATHS + /usr/lib + /usr/lib64 + /usr/local/lib + /usr/local/lib64 + /opt/local/lib + /sw/lib + ${CMAKE_LIBRARY_PATH} + ${CMAKE_INSTALL_PREFIX}/lib + ) + + find_library(LIBSRES_LIBRARY + NAMES + libsres + sres + PATHS + /usr/lib + /usr/lib64 + /usr/local/lib + /usr/local/lib64 + /opt/local/lib + /sw/lib + ${CMAKE_LIBRARY_PATH} + ${CMAKE_INSTALL_PREFIX}/lib + ) + + if(LIBVAL_INCLUDE_DIR AND LIBVAL_LIBRARY AND LIBSRES_LIBRARY) + set(LIBVAL_FOUND TRUE) + else() + set(LIBVAL_FOUND FALSE) + endif() + + set(LIBVAL_INCLUDE_DIRS ${LIBVAL_INCLUDE_DIR}) + set(LIBVAL_LIBRARIES ${LIBSRES_LIBRARY} ${LIBVAL_LIBRARY}) + + include(FindPackageHandleStandardArgs) + find_package_handle_standard_args(LibVAL DEFAULT_MSG LIBVAL_LIBRARIES LIBVAL_INCLUDE_DIRS) + + # show the LIBVAL_INCLUDE_DIRS and LIBVAL_LIBRARIES variables only in the advanced view + mark_as_advanced(LIBVAL_INCLUDE_DIRS LIBVAL_LIBRARIES) + +endif() + diff --git a/CMakeModules/FindLibYANG.cmake b/CMakeModules/FindLibYANG.cmake new file mode 100644 index 0000000..89cd93a --- /dev/null +++ b/CMakeModules/FindLibYANG.cmake @@ -0,0 +1,89 @@ +# - Try to find LibYANG +# Once done this will define +# +# LIBYANG_FOUND - system has LibYANG +# LIBYANG_INCLUDE_DIRS - the LibYANG include directory +# LIBYANG_LIBRARIES - Link these to use LibYANG +# LIBYANG_VERSION - SO version of the found libyang library +# +# Author Michal Vasko +# Copyright (c) 2021 CESNET, z.s.p.o. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# 1. Redistributions of source code must retain the copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# 3. The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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. +# +include(FindPackageHandleStandardArgs) + +if(LIBYANG_LIBRARIES AND LIBYANG_INCLUDE_DIRS) + # in cache already + set(LIBYANG_FOUND TRUE) +else() + find_path(LIBYANG_INCLUDE_DIR + NAMES + libyang/libyang.h + PATHS + /usr/include + /usr/local/include + /opt/local/include + /sw/include + ${CMAKE_INCLUDE_PATH} + ${CMAKE_INSTALL_PREFIX}/include + ) + + find_library(LIBYANG_LIBRARY + NAMES + yang + libyang + PATHS + /usr/lib + /usr/lib64 + /usr/local/lib + /usr/local/lib64 + /opt/local/lib + /sw/lib + ${CMAKE_LIBRARY_PATH} + ${CMAKE_INSTALL_PREFIX}/lib + ) + + if(LIBYANG_INCLUDE_DIR) + find_path(LY_VERSION_PATH "libyang/version.h" HINTS ${LIBYANG_INCLUDE_DIR}) + if(LY_VERSION_PATH) + file(READ "${LY_VERSION_PATH}/libyang/version.h" LY_VERSION_FILE) + else() + find_path(LY_HEADER_PATH "libyang/libyang.h" HINTS ${LIBYANG_INCLUDE_DIR}) + file(READ "${LY_HEADER_PATH}/libyang/libyang.h" LY_VERSION_FILE) + endif() + string(REGEX MATCH "#define LY_VERSION \"[0-9]+\\.[0-9]+\\.[0-9]+\"" LY_VERSION_MACRO "${LY_VERSION_FILE}") + string(REGEX MATCH "[0-9]+\\.[0-9]+\\.[0-9]+" LIBYANG_VERSION "${LY_VERSION_MACRO}") + endif() + + set(LIBYANG_INCLUDE_DIRS ${LIBYANG_INCLUDE_DIR}) + set(LIBYANG_LIBRARIES ${LIBYANG_LIBRARY}) + mark_as_advanced(LIBYANG_INCLUDE_DIRS LIBYANG_LIBRARIES) + + # handle the QUIETLY and REQUIRED arguments and set LIBYANG_FOUND to TRUE + # if all listed variables are TRUE + find_package_handle_standard_args(LibYANG FOUND_VAR LIBYANG_FOUND + REQUIRED_VARS LIBYANG_LIBRARY LIBYANG_INCLUDE_DIR + VERSION_VAR LIBYANG_VERSION) +endif() diff --git a/CMakeModules/FindUncrustify.cmake b/CMakeModules/FindUncrustify.cmake new file mode 100644 index 0000000..3b013e8 --- /dev/null +++ b/CMakeModules/FindUncrustify.cmake @@ -0,0 +1,21 @@ +# - Find uncrustify +# Find the uncrustify binary. +# +# UNCRUSTIFY - path ot the binary +# UNCRUSTIFY_VERSION - found version +# UNCRUSTIFY_FOUND - True if uncrustify found. +include(FindPackageHandleStandardArgs) + +find_program(UNCRUSTIFY uncrustify) +if(UNCRUSTIFY) + execute_process(COMMAND ${UNCRUSTIFY} --version OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE VERSION) + string(FIND ${VERSION} "-" START_IDX) + math(EXPR START_IDX "${START_IDX} + 1") + string(SUBSTRING "${VERSION}" ${START_IDX} -1 VERSION) + + string(FIND ${VERSION} "-" LEN) + string(SUBSTRING "${VERSION}" 0 ${LEN} UNCRUSTIFY_VERSION) +endif() + +# Handle the QUIETLY and REQUIRED arguments and set UNCRUSTIFY_FOUND to TRUE if all listed variables are TRUE. +find_package_handle_standard_args(Uncrustify REQUIRED_VARS UNCRUSTIFY VERSION_VAR UNCRUSTIFY_VERSION) diff --git a/CMakeModules/GenCoverage.cmake b/CMakeModules/GenCoverage.cmake new file mode 100644 index 0000000..55be637 --- /dev/null +++ b/CMakeModules/GenCoverage.cmake @@ -0,0 +1,118 @@ +# generate test code coverage report + +# check that coverage tools are available - always use before GEN_COVERAGE +macro(GEN_COVERAGE_ENABLE ENABLE_TESTS) + # make into normal variable + set(TESTS_ENABLED ${ENABLE_TESTS}) + + set(GEN_COVERAGE_ENABLED ON) + if(NOT TESTS_ENABLED) + message(WARNING "You cannot generate coverage when tests are disabled. Enable test by additing parameter -DENABLE_BUILD_TESTS=ON or run cmake with Debug build target.") + set(GEN_COVERAGE_ENABLED OFF) + endif() + + if(GEN_COVERAGE_ENABLED) + find_program(PATH_GCOV NAMES gcov) + if(NOT PATH_GCOV) + message(WARNING "gcov executable not found! Disabling building code coverage report.") + set(GEN_COVERAGE_ENABLED OFF) + endif() + endif() + + if(GEN_COVERAGE_ENABLED) + find_program(PATH_LCOV NAMES lcov) + if(NOT PATH_LCOV) + message(WARNING "lcov executable not found! Disabling building code coverage report.") + set(GEN_COVERAGE_ENABLED OFF) + endif() + endif() + + if(GEN_COVERAGE_ENABLED) + find_program(PATH_GENHTML NAMES genhtml) + if(NOT PATH_GENHTML) + message(WARNING "genhtml executable not found! Disabling building code coverage report.") + set(GEN_COVERAGE_ENABLED OFF) + endif() + endif() + + if(GEN_COVERAGE_ENABLED) + if(NOT CMAKE_COMPILER_IS_GNUCC) + message(WARNING "Compiler is not gcc! Coverage may break the tests!") + endif() + + execute_process( + COMMAND bash "-c" "${CMAKE_C_COMPILER} --version | head -n1 | sed \"s/.* (.*) \\([0-9]\\+.[0-9]\\+.[0-9]\\+ .*\\)/\\1/\"" + OUTPUT_VARIABLE GCC_VERSION_FULL + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + execute_process( + COMMAND bash "-c" "${PATH_GCOV} --version | head -n1 | sed \"s/.* (.*) \\([0-9]\\+.[0-9]\\+.[0-9]\\+ .*\\)/\\1/\"" + OUTPUT_VARIABLE GCOV_VERSION_FULL + OUTPUT_STRIP_TRAILING_WHITESPACE + ) + if(NOT GCC_VERSION_FULL STREQUAL GCOV_VERSION_FULL) + message(WARNING "gcc and gcov versions do not match! Generating coverage may fail with errors.") + endif() + + # add specific required compile flags + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --coverage -fprofile-arcs -ftest-coverage") + endif() +endmacro() + +# tests are always expected to be in ${CMAKE_SOURCE_DIR}/tests +function(GEN_COVERAGE MATCH_TEST_REGEX EXCLUDE_TEST_REGEX) + if(NOT GEN_COVERAGE_ENABLED) + return() + endif() + + # destination + set(COVERAGE_DIR "${CMAKE_BINARY_DIR}/code_coverage/") + set(COVERAGE_FILE_RAW "${CMAKE_BINARY_DIR}/coverage_raw.info") + set(COVERAGE_FILE_CLEAN "${CMAKE_BINARY_DIR}/coverage_clean.info") + + # test match/exclude + if(MATCH_TEST_REGEX) + set(MATCH_TEST_ARGS -R \"${MATCH_TEST_REGEX}\") + endif() + if(EXCLUDE_TEST_REGEX) + set(EXCLUDE_TEST_ARGS -E \"${EXCLUDE_TEST_REGEX}\") + endif() + + # coverage target + add_custom_target(coverage + COMMENT "Generating code coverage..." + WORKING_DIRECTORY "${CMAKE_BINARY_DIR}" + # Cleanup code counters + COMMAND "${PATH_LCOV}" --directory . --zerocounters --quiet + + # Run tests + COMMAND "${CMAKE_CTEST_COMMAND}" --quiet ${MATCH_TEST_ARGS} ${EXCLUDE_TEST_ARGS} + + # Capture the counters + COMMAND "${PATH_LCOV}" + --directory . + --rc lcov_branch_coverage=1 + --rc 'lcov_excl_line=assert' + --capture --quiet + --output-file "${COVERAGE_FILE_RAW}" + # Remove coverage of tests, system headers, etc. + COMMAND "${PATH_LCOV}" + --remove "${COVERAGE_FILE_RAW}" '${CMAKE_SOURCE_DIR}/tests/*' + --rc lcov_branch_coverage=1 + --quiet --output-file "${COVERAGE_FILE_CLEAN}" + # Generate HTML report + COMMAND "${PATH_GENHTML}" + --branch-coverage --function-coverage --quiet --title "${PROJECT_NAME}" + --legend --show-details --output-directory "${COVERAGE_DIR}" + "${COVERAGE_FILE_CLEAN}" + # Delete the counters + COMMAND "${CMAKE_COMMAND}" -E remove + ${COVERAGE_FILE_RAW} ${COVERAGE_FILE_CLEAN} + ) + + add_custom_command(TARGET coverage POST_BUILD + WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/tests" + COMMENT "To see the code coverage report, open ${COVERAGE_DIR}index.html" + COMMAND ; + ) +endfunction() diff --git a/CMakeModules/GenDoc.cmake b/CMakeModules/GenDoc.cmake new file mode 100644 index 0000000..ee879d0 --- /dev/null +++ b/CMakeModules/GenDoc.cmake @@ -0,0 +1,28 @@ +# Prepare building doxygen documentation +macro(GEN_DOC INPUT_FILES PROJECT_VERSION PROJECT_DESCRIPTION DOC_LOGO) + find_package(Doxygen) + if(DOXYGEN_FOUND) + find_program(DOT_PATH dot PATH_SUFFIXES graphviz2.38/bin graphviz/bin) + if(DOT_PATH) + set(HAVE_DOT "YES") + else() + set(HAVE_DOT "NO") + message(AUTHOR_WARNING "Doxygen: to generate UML diagrams please install graphviz") + endif() + + # target doc + add_custom_target(doc + COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + + # generate list with spaces as separators + string(REPLACE ";" " " DOXY_INPUT "${INPUT_FILES}") + + # make other arguments into variables + set(PROJECT_VERSION ${PROJECT_VERSION}) + set(PROJECT_DESCRIPTION ${PROJECT_DESCRIPTION}) + set(DOC_LOGO ${DOC_LOGO}) + + configure_file(Doxyfile.in Doxyfile) + endif() +endmacro() diff --git a/CMakeModules/SourceFormat.cmake b/CMakeModules/SourceFormat.cmake new file mode 100644 index 0000000..76132a4 --- /dev/null +++ b/CMakeModules/SourceFormat.cmake @@ -0,0 +1,32 @@ +# format source files with uncrustify + +# check that format checking is available - always use before SOURCE_FORMAT +macro(SOURCE_FORMAT_ENABLE) + find_package(Uncrustify 0.71) + if(UNCRUSTIFY_FOUND) + set(SOURCE_FORMAT_ENABLED TRUE) + else() + set(SOURCE_FORMAT_ENABLED FALSE) + endif() +endmacro() + +# files are expected to be a list and relative paths are resolved wtih respect to CMAKE_SOURCE DIR +macro(SOURCE_FORMAT) + if(NOT ${ARGC}) + message(FATAL_ERROR "source_format() needs a list of files to format!") + endif() + + if(SOURCE_FORMAT_ENABLED) + add_custom_target(format + COMMAND ${UNCRUSTIFY} -c ${CMAKE_SOURCE_DIR}/uncrustify.cfg --no-backup --replace ${ARGN} + WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} + COMMENT "Formating sources with ${UNCRUSTIFY} ...") + + add_custom_target(format-check + COMMAND ${UNCRUSTIFY} -c ${CMAKE_SOURCE_DIR}/uncrustify.cfg --check ${ARGN} + WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} + COMMENT "Checking format of the sources with ${UNCRUSTIFY} ...") + + set(SOURCE_FORMAT_ENABLED TRUE) + endif() +endmacro() diff --git a/CMakeModules/UseCompat.cmake b/CMakeModules/UseCompat.cmake new file mode 100644 index 0000000..7d7a338 --- /dev/null +++ b/CMakeModules/UseCompat.cmake @@ -0,0 +1,57 @@ +# - Use compat library providing various functions and macros that may be missing on some systems +# Once done this will define +# +# compatsrc - sources to add to compilation +# +# Additionally, "compat.h" include directory is added and can be included. +# +# Author Michal Vasko +# Copyright (c) 2021 CESNET, z.s.p.o. +# +# This source code is licensed under BSD 3-Clause License (the "License"). +# You may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://opensource.org/licenses/BSD-3-Clause +# +include(CheckSymbolExists) +include(CheckFunctionExists) +include(CheckIncludeFile) +include(TestBigEndian) +if(POLICY CMP0075) + cmake_policy(SET CMP0075 NEW) +endif() + +macro(USE_COMPAT) + # compatibility checks + set(CMAKE_REQUIRED_DEFINITIONS -D_POSIX_C_SOURCE=200809L) + list(APPEND CMAKE_REQUIRED_DEFINITIONS -D_GNU_SOURCE) + list(APPEND CMAKE_REQUIRED_DEFINITIONS -D__BSD_VISIBLE=1) + set(CMAKE_REQUIRED_LIBRARIES pthread) + + check_symbol_exists(vdprintf "stdio.h;stdarg.h" HAVE_VDPRINTF) + check_symbol_exists(asprintf "stdio.h" HAVE_ASPRINTF) + check_symbol_exists(vasprintf "stdio.h" HAVE_VASPRINTF) + check_symbol_exists(getline "stdio.h" HAVE_GETLINE) + + check_symbol_exists(strndup "string.h" HAVE_STRNDUP) + check_symbol_exists(strnstr "string.h" HAVE_STRNSTR) + check_symbol_exists(strdupa "string.h" HAVE_STRDUPA) + check_symbol_exists(strchrnul "string.h" HAVE_STRCHRNUL) + + check_symbol_exists(get_current_dir_name "unistd.h" HAVE_GET_CURRENT_DIR_NAME) + + check_function_exists(pthread_mutex_timedlock HAVE_PTHREAD_MUTEX_TIMEDLOCK) + + TEST_BIG_ENDIAN(IS_BIG_ENDIAN) + + check_include_file("stdatomic.h" HAVE_STDATOMIC) + + unset(CMAKE_REQUIRED_DEFINITIONS) + unset(CMAKE_REQUIRED_LIBRARIES) + + # header and source file (adding the source directly allows for hiding its symbols) + configure_file(${PROJECT_SOURCE_DIR}/compat/compat.h.in ${PROJECT_BINARY_DIR}/compat/compat.h @ONLY) + include_directories(${PROJECT_BINARY_DIR}/compat) + set(compatsrc ${PROJECT_SOURCE_DIR}/compat/compat.c) +endmacro() diff --git a/CMakeModules/uninstall.cmake b/CMakeModules/uninstall.cmake new file mode 100644 index 0000000..b9618a2 --- /dev/null +++ b/CMakeModules/uninstall.cmake @@ -0,0 +1,27 @@ +cmake_minimum_required(VERSION 3.0.2) + +set(MANIFEST "${CMAKE_CURRENT_BINARY_DIR}/install_manifest.txt") + +if(NOT EXISTS ${MANIFEST}) + message(FATAL_ERROR "Cannot find install manifest: ${MANIFEST}") +endif() + +file(STRINGS ${MANIFEST} files) +foreach(file ${files}) + if(EXISTS ${file} OR IS_SYMLINK ${file}) + message(STATUS "Removing: ${file}") + + execute_process(COMMAND rm -f ${file} + RESULT_VARIABLE result + OUTPUT_QUIET + ERROR_VARIABLE stderr + ERROR_STRIP_TRAILING_WHITESPACE + ) + + if(NOT ${result} EQUAL 0) + message(FATAL_ERROR "${stderr}") + endif() + else() + message(STATUS "Does-not-exist: ${file}") + endif() +endforeach(file) diff --git a/CODINGSTYLE.md b/CODINGSTYLE.md new file mode 100644 index 0000000..57eec3f --- /dev/null +++ b/CODINGSTYLE.md @@ -0,0 +1,184 @@ +# libnetconf2 Coding Style + +This file describes the coding style used in most C files in the libnetconf2 +library. + +## Basics + +- Use space instead of tabs for indentations. +- There is no strict limit for the line length, However, try to keep lines in a +reasonable length (120 characters). +- Avoid trailing spaces on lines. +- Put one blank line between function definitions. +- Don't mix declarations and code within a block. Similarly, don't use + declarations in iteration statements. + +## Naming + +Use underscores to separate words in an identifier: `multi_word_name`. + +Use lowercase for most names. Use uppercase for macros, macro parameters and +members of enumerations. + +Do not use names that begin with `_`. If you need a name for "internal use +only", use `__` as a suffix instead of a prefix. + +## Comments + +Avoid `//` comments. Use `/* ... */` comments, write block comments with the +leading asterisk on each line. You may put the `/*` and `*/` on the same line as +comment text if you prefer. + +```c +/* + * comment text + */ +``` + +## Functions + +Put the return type, function name, and the braces that surround the function's +code on separate lines, all starting in column 0. + +```c +static int +foo(int arg) +{ + ... +} +``` + +When you need to put the function parameters on multiple lines, start new line +at column after the opening parenthesis from the initial line. + +```c +static int +my_function(struct my_struct *p1, struct another_struct *p2, + int size) +{ + ... +} +``` + +In the absence of good reasons for another order, the following parameter order +is preferred. One notable exception is that data parameters and their +corresponding size parameters should be paired. + +1. The primary object being manipulated, if any (equivalent to the "this" + pointer in C++). +2. Input-only parameters. +3. Input/output parameters. +4. Output-only parameters. +5. Status parameter. + +Functions that destroy an instance of a dynamically-allocated type should accept +and ignore a null pointer argument. Code that calls such a function (including +the C standard library function `free()`) should omit a null-pointer check. We +find that this usually makes code easier to read. + +### Function Prototypes + +Put the return type and function name on the same line in a function prototype: + +```c +static const struct int foo(int arg); +``` + +## Statements + +- Indent each level of code with 4 spaces. +- Put single space between `if`, `while`, `for`, etc. statements and the + expression that follow them. On the other hand, function calls has no space + between the function name and opening parenthesis. +- Opening code block brace is kept at the same line with the `if`, `while`, + `for` or `switch` statements. + +```c +if (a) { + x = exp(a); +} else { + return 1; +} +``` + +- Start switch's cases at the same column as the switch. + +```c +switch (conn->state) { +case 0: + return "data found"; +case 1: + return "data not found"; +default: + return "unknown error"; +} +``` + +- Do not put gratuitous parentheses around the expression in a return statement, +that is, write `return 0;` and not `return(0);` + +## Types + +Use typedefs sparingly. Code is clearer if the actual type is visible at the +point of declaration. Do not, in general, declare a typedef for a struct, union, +or enum. Do not declare a typedef for a pointer type, because this can be very +confusing to the reader. + +Use the `int_t` and `uint_t` types from `` for exact-width +integer types. Use the `PRId`, `PRIu`, and `PRIx` macros from +`` for formatting them with `printf()` and related functions. + +Pointer declarators bind to the variable name, not the type name. Write +`int *x`, not `int* x` and definitely not `int * x`. + +## Expresions + +Put one space on each side of infix binary and ternary operators: + +```c +* / % + - << >> < <= > >= == != & ^ | && || ?: = += -= *= /= %= &= ^= |= <<= >>= +``` + +Do not put any white space around postfix, prefix, or grouping operators with +one exception - `sizeof`, see the note below. + +```c +() [] -> . ! ~ ++ -- + - * & +``` + +The "sizeof" operator is unique among C operators in that it accepts two very +different kinds of operands: an expression or a type. In general, prefer to +specify an expression +```c +int *x = calloc(1, sizeof *x); +``` +When the operand of sizeof is an expression, there is no need to parenthesize +that operand, and please don't. There is an exception to this rule when you need +to work with partially compatible structures: + +```c +struct a_s { + uint8_t type; +} + +struct b_s { + uint8_t type; + char *str; +} + +struct c_s { + uint8_t type; + uint8_t *u8; +} +... +struct a_s *a; + +switch (type) { +case 1: + a = (struct a_s *)calloc(1, sizeof(struct b_s)); + break; +case 2: + a = (struct a_s *)calloc(1, sizeof(struct c_s)); + break; + ... +``` diff --git a/Doxyfile.in b/Doxyfile.in new file mode 100644 index 0000000..324e670 --- /dev/null +++ b/Doxyfile.in @@ -0,0 +1,2457 @@ +# Doxyfile 1.8.11 + +# 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 = @PROJECT_NAME@ + +# 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 = @PROJECT_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 = "@PROJECT_DESCRIPTION@" + +# With the PROJECT_LOGO tag one can specify a logo or an 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 = @DOC_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 = ./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 = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# 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 = + +# 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 = asterisk=* + +# 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 = YES + +# 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 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 + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = 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 = YES + +# 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 = YES + +# 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. If 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 = NO + +# 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 HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= 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 = YES + +# 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 = YES + +# 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 = YES + +# 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 = NO + +# 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 + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = 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. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = @DOXY_INPUT@ + +# 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. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# 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, *.pyw, *.f90, *.f, *.for, *.tcl, +# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = *.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 \ + *.js + +# 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 = + +# 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 = "./doc" + +# 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. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +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. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +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 = + +#--------------------------------------------------------------------------- +# 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 = YES + +# 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 + +#--------------------------------------------------------------------------- +# 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 therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet 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 = ./doc/cesnet-style.css + +# 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 style sheet 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 YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# 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 style sheets (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 = YES + +# 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 + +# If 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 pre-rendered 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 +# , /