pax_global_header00006660000000000000000000000064141566617040014524gustar00rootroot0000000000000052 comment=61f873cf79a016b0572c04f2df075a75a66389aa PTL-2.3.1/000077500000000000000000000000001415666170400121665ustar00rootroot00000000000000PTL-2.3.1/.clang-format000066400000000000000000000035431415666170400145460ustar00rootroot00000000000000# requires clang-tidy version 6.0+ --- AccessModifierOffset: -4 AlignAfterOpenBracket: Align AlignConsecutiveAssignments: true AlignConsecutiveDeclarations: true AlignEscapedNewlinesLeft: false AlignOperands: true AlignTrailingComments: true AllowShortCaseLabelsOnASingleLine: true AllowShortFunctionsOnASingleLine: All AllowShortIfStatementsOnASingleLine: false AllowShortLoopsOnASingleLine: false AlwaysBreakAfterDefinitionReturnType: TopLevel AlwaysBreakAfterReturnType: TopLevel AlwaysBreakBeforeMultilineStrings: false AlwaysBreakTemplateDeclarations: true BasedOnStyle: Mozilla BinPackArguments: true BinPackParameters: true BraceWrapping: AfterClass: true AfterControlStatement: true AfterEnum: true AfterFunction: true AfterNamespace: true AfterStruct: true AfterUnion: true AfterExternBlock: true BeforeCatch: false BeforeElse: true IndentBraces: false SplitEmptyFunction: false SplitEmptyRecord: false SplitEmptyNamespace: false BreakBeforeBraces: Custom BreakBeforeInheritanceComma: true ColumnLimit: 90 CompactNamespaces: true ConstructorInitializerAllOnOneLineOrOnePerLine: false ConstructorInitializerIndentWidth: 0 ContinuationIndentWidth: 4 FixNamespaceComments: true IndentCaseLabels: true IndentPPDirectives: AfterHash IndentWidth: 4 KeepEmptyLinesAtTheStartOfBlocks: false Language: Cpp PointerAlignment: Left SortIncludes: true SortUsingDeclarations: true SpaceAfterCStyleCast: true SpaceAfterTemplateKeyword: true SpaceBeforeAssignmentOperators: true SpaceBeforeParens: false SpaceInEmptyParentheses: false SpacesBeforeTrailingComments: 2 SpacesInAngles: false SpacesInContainerLiterals: true SpacesInParentheses: false SpacesInSquareBrackets: false Standard: Cpp11 TabWidth: 4 UseTab: Never ... PTL-2.3.1/.clang-tidy000066400000000000000000000031161415666170400142230ustar00rootroot00000000000000--- Checks: "-*,\ misc-*,\ -misc-incorrect-roundings,\ -misc-macro-parentheses,\ -misc-misplaced-widening-cast,\ -misc-static-assert,\ -misc-non-private-member-variables-in-classes,\ -misc-no-recursion,\ modernize-*,\ -modernize-deprecated-headers,\ -modernize-raw-string-literal,\ -modernize-return-braced-init-list,\ -modernize-use-transparent-functors,\ -modernize-use-trailing-return-type,\ -modernize-avoid-c-arrays,\ -modernize-redundant-void-arg,\ -modernize-use-using,\ -modernize-use-auto,\ -modernize-concat-nested-namespaces,\ -modernize-use-nodiscard,\ -modernize-make-unique,\ performance-*,\ readability-*,\ -readability-function-size,\ -readability-identifier-naming,\ -readability-implicit-bool-cast,\ -readability-inconsistent-declaration-parameter-name,\ -readability-named-parameter,\ -readability-magic-numbers,\ -readability-redundant-declaration,\ -readability-redundant-member-init,\ -readability-simplify-boolean-expr,\ -readability-uppercase-literal-suffix,\ -readability-braces-around-statements,\ -readability-avoid-const-params-in-decls,\ -readability-else-after-return,\ -readability-isolate-declaration,\ -readability-redundant-string-cstr,\ -readability-static-accessed-through-instance,\ -readability-const-return-type,\ -readability-function-cognitive-complexity,\ -readability-redundant-access-specifiers,\ " HeaderFilterRegex: 'source/[^/]*\.(hh|cc)$' CheckOptions: - key: readability-braces-around-statements.ShortStatementLines value: '2' - key: readability-implicit-bool-conversion.AllowPointerConditions value: '1' ... PTL-2.3.1/.cmake-format.yaml000066400000000000000000000033471415666170400155050ustar00rootroot00000000000000parse: additional_commands: ptl_build_library: flags: - RECURSIVE kwargs: TYPE: '*' TARGET_NAME: '*' OUTPUT_NAME: '*' SOURCES: '*' EXTRA_ARGS: '*' override_spec: {} vartags: [] proptags: [] format: disable: false line_width: 90 tab_size: 4 use_tabchars: false fractional_tab_policy: use-space max_subgroups_hwrap: 2 max_pargs_hwrap: 8 max_rows_cmdline: 2 separate_ctrl_name_with_space: false separate_fn_name_with_space: false dangle_parens: false dangle_align: child min_prefix_chars: 4 max_prefix_chars: 10 max_lines_hwrap: 2 line_ending: unix command_case: lower keyword_case: upper always_wrap: [] enable_sort: true autosort: false require_valid_layout: false layout_passes: {} markup: bullet_char: '*' enum_char: . first_comment_is_literal: false literal_comment_pattern: null fence_pattern: ^\s*([`~]{3}[`~]*)(.*)$ ruler_pattern: ^\s*[^\w\s]{3}.*[^\w\s]{3}$ explicit_trailing_pattern: '#<' hashruler_min_length: 10 canonicalize_hashrulers: true enable_markup: true lint: disabled_codes: [] function_pattern: '[0-9a-z_]+' macro_pattern: '[0-9A-Z_]+' global_var_pattern: '[A-Z][0-9A-Z_]+' internal_var_pattern: _[A-Z][0-9A-Z_]+ local_var_pattern: '[a-z][a-z0-9_]+' private_var_pattern: _[0-9a-z_]+ public_var_pattern: '[A-Z][0-9A-Z_]+' argument_var_pattern: '[a-z][a-z0-9_]+' keyword_pattern: '[A-Z][0-9A-Z_]+' max_conditionals_custom_parser: 2 min_statement_spacing: 1 max_statement_spacing: 2 max_returns: 6 max_branches: 12 max_arguments: 5 max_localvars: 15 max_statements: 50 encode: emit_byteorder_mark: false input_encoding: utf-8 output_encoding: utf-8 misc: per_command: {} PTL-2.3.1/.github/000077500000000000000000000000001415666170400135265ustar00rootroot00000000000000PTL-2.3.1/.github/ISSUE_TEMPLATE/000077500000000000000000000000001415666170400157115ustar00rootroot00000000000000PTL-2.3.1/.github/ISSUE_TEMPLATE/bug_report.md000066400000000000000000000014371415666170400204100ustar00rootroot00000000000000--- name: Bug report about: Create a report to help us improve --- **Describe the bug** A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error **Expected behavior** A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - OS: [e.g. iOS] - Browser [e.g. chrome, safari] - Version [e.g. 22] **Smartphone (please complete the following information):** - Device: [e.g. iPhone6] - OS: [e.g. iOS8.1] - Browser [e.g. stock browser, safari] - Version [e.g. 22] **Additional context** Add any other context about the problem here. PTL-2.3.1/.github/workflows/000077500000000000000000000000001415666170400155635ustar00rootroot00000000000000PTL-2.3.1/.github/workflows/cancelling.yml000066400000000000000000000011071415666170400204040ustar00rootroot00000000000000name: cancel-builds-on-update on: workflow_run: workflows: ['linux-ci'] types: ['requested'] jobs: cancel-duplicate-workflow-runs: name: "Cancel duplicate workflow runs" runs-on: ubuntu-latest steps: - uses: potiuk/cancel-workflow-runs@master name: "Cancel duplicate workflow runs" with: cancelMode: duplicates cancelFutureDuplicates: true token: ${{ secrets.GITHUB_TOKEN }} sourceRunId: ${{ github.event.workflow_run.id }} notifyPRCancel: true skipEventTypes: '["schedule"]' PTL-2.3.1/.github/workflows/formatting.yml000066400000000000000000000033501415666170400204610ustar00rootroot00000000000000# This handles formatting for C/C++ source code and cmake code name: formatting on: push: branches: [ master, develop ] pull_request: branches: [ master, develop ] jobs: cxx-formatting: runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v2 - name: Install dependencies run: | sudo apt-get update sudo apt-get install -y clang-format-9 cmake - name: clang-format run: | cmake -B build-PTL -DPTL_USE_TBB=OFF . cmake --build build-PTL --target format-source rm -rf build-PTL if [ $(git diff | wc -l) -gt 0 ]; then echo -e "\nError! Source code not formatted. Run clang-format-9...\n" echo -e "\nFiles:\n" git diff --name-only echo -e "\nFull diff:\n" git diff exit 1 fi cmake-formatting: runs-on: ubuntu-20.04 strategy: matrix: python-version: [3.8] steps: - uses: actions/checkout@v2 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v2 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | sudo apt-get update sudo apt-get install -y cmake python -m pip install --upgrade pip pip install cmake-format pyyaml - name: cmake format run: | cmake -B build-PTL -DPTL_USE_TBB=OFF . cmake --build build-PTL --target format-cmake rm -rf build-PTL if [ $(git diff | wc -l) -gt 0 ]; then echo -e "\nError! CMake code not formatted. Run cmake-format...\n" echo -e "\nFiles:\n" git diff --name-only echo -e "\nFull diff:\n" git diff exit 1 fi PTL-2.3.1/.github/workflows/linux-ci.yml000066400000000000000000000130671415666170400200450ustar00rootroot00000000000000name: linux-ci on: push: branches: [ master, main, develop ] pull_request: branches: [ master, main, develop ] env: BUILD_TYPE: Release ASAN_OPTIONS: "detect_leaks=0" jobs: ci: runs-on: ubuntu-18.04 strategy: matrix: include: - build_type: 'Debug' build_libs: 'shared' compiler: 'gcc' extra_args: '--coverage --tbb --num-tasks=64' extra_packages: 'clang-tidy' standard: '11' - build_type: 'RelWithDebInfo' build_libs: 'shared' compiler: 'clang-12' extra_args: '--num-tasks=256 --sanitizer --sanitizer-type=leak --static-analysis' extra_packages: 'clang-tidy-12' standard: '11' - build_type: 'RelWithDebInfo' build_libs: 'shared' compiler: 'clang-12' extra_args: '--num-tasks=256 --tbb --sanitizer --sanitizer-type=address --static-analysis' extra_packages: 'clang-tidy-12' standard: '14' - build_type: 'RelWithDebInfo' build_libs: 'shared' compiler: 'clang-12' extra_args: '--num-tasks=256 --tbb --sanitizer --sanitizer-type=thread --static-analysis' extra_cmake: '-DPTL_USE_LOCKS=ON' extra_packages: 'clang-tidy-12' standard: '17' build_type: ['Release'] build_libs: ['shared static'] compiler: ['gcc-6', 'gcc-7', 'gcc-8', 'gcc-9', 'gcc-10', 'clang-7', 'clang-8', 'clang-10', 'clang-11'] extra_args: ['--num-tasks=256 --tbb'] standard: ['11'] steps: - uses: actions/checkout@v2 - name: Install Conda run: wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh && bash miniconda.sh -b -p /opt/conda && export PATH="/opt/conda/bin:${PATH}" && conda config --set always_yes yes --set changeps1 yes && conda update -c defaults -n base conda && conda create -n pyctest -c defaults -c conda-forge python=3.7 pyctest && source activate && conda activate pyctest - name: Configure Repos run: DISTRIB_CODENAME=$(cat /etc/lsb-release | grep DISTRIB_CODENAME | awk -F '=' '{print $NF}') && sudo apt-get update && sudo apt-get install -y software-properties-common wget curl && sudo add-apt-repository -u -y ppa:ubuntu-toolchain-r/test && wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add - && echo "deb http://apt.llvm.org/${DISTRIB_CODENAME}/ llvm-toolchain-${DISTRIB_CODENAME}-8 main" >> llvm-toolchain.list && echo "deb-src http://apt.llvm.org/${DISTRIB_CODENAME}/ llvm-toolchain-${DISTRIB_CODENAME}-8 main" >> llvm-toolchain.list && echo "deb http://apt.llvm.org/${DISTRIB_CODENAME}/ llvm-toolchain-${DISTRIB_CODENAME}-9 main" >> llvm-toolchain.list && echo "deb-src http://apt.llvm.org/${DISTRIB_CODENAME}/ llvm-toolchain-${DISTRIB_CODENAME}-9 main" >> llvm-toolchain.list && echo "deb http://apt.llvm.org/${DISTRIB_CODENAME}/ llvm-toolchain-${DISTRIB_CODENAME}-10 main" >> llvm-toolchain.list && echo "deb-src http://apt.llvm.org/${DISTRIB_CODENAME}/ llvm-toolchain-${DISTRIB_CODENAME}-10 main" >> llvm-toolchain.list && echo "deb http://apt.llvm.org/${DISTRIB_CODENAME}/ llvm-toolchain-${DISTRIB_CODENAME}-11 main" >> llvm-toolchain.list && echo "deb-src http://apt.llvm.org/${DISTRIB_CODENAME}/ llvm-toolchain-${DISTRIB_CODENAME}-11 main" >> llvm-toolchain.list && echo "deb http://apt.llvm.org/${DISTRIB_CODENAME}/ llvm-toolchain-${DISTRIB_CODENAME}-12 main" >> llvm-toolchain.list && echo "deb-src http://apt.llvm.org/${DISTRIB_CODENAME}/ llvm-toolchain-${DISTRIB_CODENAME}-12 main" >> llvm-toolchain.list && cat llvm-toolchain.list && sudo mv llvm-toolchain.list /etc/apt/sources.list.d/ - name: Install Repos run: export CC=${{ matrix.compiler }} && export CXX=$(echo "${{ matrix.compiler }}" | sed 's/gcc/g++/1' | sed 's/clang/clang++/1') && echo "C compiler is ${CC}" && echo "C++ compiler is ${CXX}" && sudo apt-get update && sudo apt-get install -y lcov libtbb-dev ${{ matrix.extra_packages }} && sudo apt-get install -y build-essential ${CC} ${CXX} - name: Build and Test run: export PATH="/opt/conda/bin:${PATH}" && source activate && conda activate pyctest && export CMAKE_PREFIX_PATH="${CMAKE_PREFIX_PATH}:${CONDA_PREFIX}" && export CC=$(which ${{ matrix.compiler }}) && export CXX=$(which $(echo "${{ matrix.compiler }}" | sed 's/gcc/g++/1' | sed 's/clang/clang++/1')) && echo "C compiler is ${CC}" && echo "C++ compiler is ${CXX}" && python ./pyctest-runner.py -SF --pyctest-model=Continuous --pyctest-site=GitHub-Linux --pyctest-build-type=${{ matrix.build_type }} --build-libs ${{ matrix.build_libs }} ${{ matrix.extra_args }} -- -VV ${{ matrix.extra_ctest }} -- -DCMAKE_INSTALL_PREFIX=${HOME}/ptl-install -DCMAKE_CXX_STANDARD=${{ matrix.standard }} ${{ matrix.extra_cmake }} - name: Install run: export PATH="/opt/conda/bin:${PATH}" && source activate && conda activate pyctest && export CMAKE_PREFIX_PATH="${HOME}/ptl-install:${CMAKE_PREFIX_PATH}:${CONDA_PREFIX}" && cmake --build build-PTL --target install && cmake -B ${HOME}/ptl-examples-build ${PWD}/examples && cmake --build ${HOME}/ptl-examples-build --target all PTL-2.3.1/.gitignore000066400000000000000000000006461415666170400141640ustar00rootroot00000000000000# Prerequisites *.d # Compiled Object files *.slo *.lo *.o *.obj # Precompiled Headers *.gch *.pch # Compiled Dynamic libraries *.so *.dylib *.dll # Fortran module files *.mod *.smod # Compiled Static libraries *.lai *.la *.a *.lib # Executables *.exe *.out *.app # IDE project configs *CMakeLists.txt.user *.vscode # Build folders /build-* /install-* /build* /install* /*-build /*-install # Edit files *~ *.bak PTL-2.3.1/.license.c000066400000000000000000000021641415666170400140350ustar00rootroot00000000000000// MIT License // // Copyright (c) 2019 Jonathan R. Madsen // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. // // PTL-2.3.1/.scripts/000077500000000000000000000000001415666170400137335ustar00rootroot00000000000000PTL-2.3.1/.scripts/gperf_cpu_profile.sh000077500000000000000000000037751415666170400200000ustar00rootroot00000000000000#!/bin/bash set -o errexit : ${N:=0} : ${CPUPROFILE:=""} : ${CPUPROFBASE:=gperf.cpu.prof} : ${PPROF_ARGS:=""} : ${MALLOCSTATS:=1} : ${CPUPROFILE_FREQUENCY:=250} : ${INTERACTIVE:=0} while [ -z "${CPUPROFILE}" ] do TEST_FILE=${CPUPROFBASE}.${N} if [ ! -f "${TEST_FILE}" ]; then CPUPROFILE=${TEST_FILE} fi N=$((${N}+1)) done export CPUPROFILE export MALLOCSTATS export CPUPROFILE_FREQUENCY echo -e "\n\t--> Outputting profile to '${CPUPROFILE}'...\n" # remove profile file if unsucessful execution cleanup-failure() { set +v ; rm -f ${CPUPROFILE}; } trap cleanup-failure SIGHUP SIGINT SIGQUIT SIGILL SIGABRT SIGKILL # configure pre-loading of profiler library LIBS=$(find $PWD | grep libptl | egrep -v '\.a$|\.dSYM') LIBS=$(echo ${LIBS} | sed 's/ /:/g') if [ "$(uname)" = "Darwin" ]; then for i in $(otool -L ${1} | egrep 'profiler' | awk '{print $1}') do LIBS=${LIBS}:${i} done LIBS=$(echo ${LIBS} | sed 's/^://g') if [ -n "${LIBS}" ]; then export DYLD_FORCE_FLAT_NAMESPACE=1 export DYLD_INSERT_LIBRARIES=${LIBS} echo "DYLD_INSERT_LIBRARIES=${DYLD_INSERT_LIBRARIES}" fi else for i in $(ldd ${1} | egrep 'profiler' | awk '{print $(NF-1)}') do LIBS=${LIBS}:${i} done LIBS=$(echo ${LIBS} | sed 's/^://g') if [ -n "${LIB}" ]; then export LD_PRELOAD=${LIBS} echo "LD_PRELOAD=${LD_PRELOAD}" fi fi # run the application eval $@ | tee ${CPU_PROFILE}.log # generate the results EXT=so if [ "$(uname)" = "Darwin" ]; then EXT=dylib; fi if [ -f "${CPUPROFILE}" ]; then : ${PPROF:=$(which pprof)} if [ -n "${PPROF}" ]; then pprof --text --add_lib=libptl.${EXT} ${PPROF_ARGS} ${1} ${CPUPROFILE} | egrep -v ' 0x[0-9]' &> ${CPUPROFILE}.txt pprof --text --cum --add_lib=libptl.${EXT} ${PPROF_ARGS} ${1} ${CPUPROFILE} | egrep -v ' 0x[0-9]' &> ${CPUPROFILE}.cum.txt if [ "${INTERACTIVE}" -gt 0 ]; then pprof --add_lib=libptl.${EXT} ${PPROF_ARGS} ${1} ${CPUPROFILE} fi fi fi PTL-2.3.1/.scripts/gperf_heap_profile.sh000077500000000000000000000033771415666170400201240ustar00rootroot00000000000000#!/bin/bash set -o errexit : ${N:=0} : ${HEAPPROFILE:=""} : ${HEAPPROFBASE:=gperf.heap.prof} : ${PPROF_ARGS:=""} : ${MALLOCSTATS:=1} : ${INTERACTIVE:=0} while [ -z "${HEAPPROFILE}" ] do TEST_FILE=${HEAPPROFBASE}.${N} if [ ! -f "${TEST_FILE}" ]; then HEAPPROFILE=${TEST_FILE} fi N=$((${N}+1)) done export HEAPPROFILE export MALLOCSTATS echo -e "\n\t--> Outputting profile to '${HEAPPROFILE}'...\n" # remove profile file if unsucessful execution cleanup-failure() { set +v ; rm -f ${HEAPPROFILE}; } trap cleanup-failure SIGHUP SIGINT SIGQUIT SIGILL SIGABRT SIGKILL # configure pre-loading of profiler library LIBS=$(find $PWD | grep libptl | egrep -v '\.a$|\.dSYM') LIBS=$(echo ${LIBS} | sed 's/ /:/g') if [ "$(uname)" = "Darwin" ]; then for i in $(otool -L ${1} | egrep 'tcmalloc|profiler' | awk '{print $1}') do LIBS=${LIBS}:${i} done LIBS=$(echo ${LIBS} | sed 's/^://g') if [ -n "${LIBS}" ]; then export DYLD_FORCE_FLAT_NAMESPACE=1 export DYLD_INSERT_LIBRARIES=${LIBS} echo "DYLD_INSERT_LIBRARIES=${DYLD_INSERT_LIBRARIES}" fi unset LIBS else for i in $(ldd ${1} | egrep 'tcmalloc|profiler' | awk '{print $(NF-1)}') do LIBS=${LIBS}:${i} done LIBS=$(echo ${LIBS} | sed 's/^://g') if [ -n "${LIBS}" ]; then export LD_PRELOAD=${LIBS} echo "LD_PRELOAD=${LD_PRELOAD}" fi unset LIBS fi # run the application eval $@ | tee ${HEAPPROFILE}.log # generate the results if [ -f "${HEAPPROFILE}" ]; then : ${PPROF:=$(which pprof)} if [ -n "${PPROF}" ]; then pprof --text ${PPROF_ARGS} ${1} ${HEAPPROFILE} &> ${HEAPPROFILE}.txt if [ "${INTERACTIVE}" -gt 0 ]; then pprof ${PPROF_ARGS} ${1} ${HEAPPROFILE} fi fi fi PTL-2.3.1/CMakeLists.txt000066400000000000000000000077071415666170400147410ustar00rootroot00000000000000# -------------------------------------------------------------------------------------- # # cmake settings # cmake_minimum_required(VERSION 3.8...3.20) if(${CMAKE_VERSION} VERSION_LESS 3.12) cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}) endif() # Warn about an in-source build, but don't error out if("${CMAKE_SOURCE_DIR}" STREQUAL "${CMAKE_BINARY_DIR}") message(STATUS "Warning! Building from the source directory is not recommended") message(STATUS "If unintented, please remove 'CMakeCache.txt' and 'CMakeFiles'") message(STATUS "and build from a separate directory") message(WARNING "In-source build") endif() # Check if project is being used directly or via add_subdirectory set(PTL_MASTER_PROJECT ON) if(NOT CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) set(PTL_MASTER_PROJECT OFF) else() set(CMAKE_EXPORT_COMPILE_COMMANDS ON) endif() # Version file(READ "${CMAKE_CURRENT_LIST_DIR}/VERSION" VERSION_STRING LIMIT_COUNT 1) string(REGEX REPLACE "(\n|\r)" "" VERSION_STRING "${VERSION_STRING}") string(REGEX REPLACE "[A-Za-z].*" "" VERSION_STRING "${VERSION_STRING}") set(PTL_VERSION "${VERSION_STRING}") # -------------------------------------------------------------------------------------- # # -------------------------------------------------------------------------------------- # # project setup # project( PTL LANGUAGES C CXX VERSION ${PTL_VERSION}) # Postprocess version info to create variables for export to Version.hh set(PTL_VERSION_STRING "${PTL_VERSION_MAJOR}.${PTL_VERSION_MINOR}.${PTL_VERSION_PATCH}") math(EXPR PTL_VERSION_CODE "10000 * ${PTL_VERSION_MAJOR} + 100 * ${PTL_VERSION_MINOR} + ${PTL_VERSION_PATCH}") # Project-local CMake settings set(CMAKE_DIRECTORY_LABELS "PTL") set(CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE ON) set(CMAKE_INSTALL_DEFAULT_COMPONENT_NAME Development) set(CMAKE_INSTALL_MESSAGE LAZY) set(CMAKE_LINK_DEPENDS_NO_SHARED ON) list(INSERT CMAKE_MODULE_PATH 0 ${CMAKE_CURRENT_LIST_DIR}/cmake/Modules) include(PTLCMakeUtilities) # -------------------------------------------------------------------------------------- # # Build/Install settings and options include(PTLInstallDirs) include(PTLBuildSettings) # -------------------------------------------------------------------------------------- # # User options ptl_add_option(PTL_USE_TBB "Enable TBB" ON) ptl_add_option(PTL_USE_LOCKS "Enable mutex locking in task subqueues for extra safety" OFF) ptl_add_option(PTL_INSTALL_HEADERS "Install the headers" ON) ptl_add_option(PTL_INSTALL_CONFIG "Install the cmake configuration" ON) if(DEFINED PTL_DEVELOPER_INSTALL) set(PTL_INSTALL_HEADERS ${PTL_DEVELOPER_INSTALL} CACHE BOOL "Set via PTL_DEVELOPER_INSTALL" FORCE) set(PTL_INSTALL_CONFIG ${PTL_DEVELOPER_INSTALL} CACHE BOOL "Set via PTL_DEVELOPER_INSTALL" FORCE) endif() # -------------------------------------------------------------------------------------- # # Build Dependencies - Threads if(NOT WIN32) set(CMAKE_THREAD_PREFER_PTHREAD ON) set(THREADS_PREFER_PTHREAD_FLAG ON) endif() find_package(Threads REQUIRED) # * TBB if(PTL_USE_TBB) find_package(TBB 2017 REQUIRED) endif() # -------------------------------------------------------------------------------------- # # PTL Primary Build add_subdirectory(source) # -------------------------------------------------------------------------------------- # # CMake/PkgConfig Support files include(PTLPackageConfigHelpers) # -------------------------------------------------------------------------------------- # # Examples build/test if(EXISTS ${CMAKE_CURRENT_LIST_DIR}/examples) ptl_add_option(PTL_BUILD_EXAMPLES "Build examples" OFF) if(PTL_BUILD_EXAMPLES) set(PTL_DIR ${CMAKE_BINARY_DIR}) add_subdirectory(examples) endif() endif() # -------------------------------------------------------------------------------------- # # Reporting if master project if(PTL_MASTER_PROJECT) ptl_print_features() endif() PTL-2.3.1/LICENSE000066400000000000000000000020631415666170400131740ustar00rootroot00000000000000MIT License Copyright (c) 2020 Jonathan R. Madsen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. PTL-2.3.1/README.md000066400000000000000000000036401415666170400134500ustar00rootroot00000000000000# Parallel Tasking Library (PTL) Lightweight C++11 multithreading tasking system featuring thread-pool, task-groups, and lock-free task queue ## Basic Interface ```cpp #include "PTL/PTL.hh" #include inline long fibonacci(long n) { return (n < 2) ? n : (fibonacci(n - 1) + fibonacci(n - 2)); } int main() { bool use_tbb = false; auto num_threads = 4; auto run_manager = PTL::TaskRunManager(use_tbb); run_manager.Initialize(num_threads); auto* task_manager = run_manager.GetTaskManager(); // add a task via the task manager auto baz = task_manager->async(fibonacci, 40); // functor to combine results auto join = [](long& lhs, long rhs) { return lhs += rhs; }; // create a task group for 10 fibonacci calculations PTL::TaskGroup foo(join); for(uint64_t i = 0; i < 10; ++i) foo.exec(fibonacci, 40); // create a task group for 10 fibonacci calculations PTL::TaskGroup bar{}; long ret_bar = 0; auto run = [&ret_bar](long n) { ret_bar += fibonacci(n); }; for(uint64_t i = 0; i < 10; ++i) bar.exec(run, 40); auto ret_baz = baz->get(); auto ret_foo = foo.join(); bar.join(); assert(ret_baz * 10 == ret_foo); assert(ret_baz * 10 == ret_bar); assert(ret_foo == ret_bar); } ``` ## Explicit Thread-Pool Using `PTL::TaskRunManager` is not necessary with task-groups. You can create new thread-pools directly and pass them to task-groups: ```cpp long example() { // create a new thread-pool explicitly PTL::ThreadPool tp(4); // combines results auto join = [](long& lhs, long rhs) { return lhs += rhs; }; // specify thread-pool explicitly PTL::TaskGroup foo(join, &tp); for(int i = 0; i < 10; ++i) foo.exec(fibonacci, 40); // blocks until tasks in group are completed // thread-pool is destroyed after function returns return foo.get(); } ``` PTL-2.3.1/VERSION000066400000000000000000000000061415666170400132320ustar00rootroot000000000000002.3.1 PTL-2.3.1/cmake/000077500000000000000000000000001415666170400132465ustar00rootroot00000000000000PTL-2.3.1/cmake/Modules/000077500000000000000000000000001415666170400146565ustar00rootroot00000000000000PTL-2.3.1/cmake/Modules/Documentation.cmake000066400000000000000000000171621415666170400205000ustar00rootroot00000000000000# # Create a "make doc" target using Doxygen. # # Prototype: # # GENERATE_DOCUMENTATION(doxygen_config_file) # # Parameters: # # * doxygen_config_file: Doxygen configuration file (must in the root of the source # directory) include(MacroUtilities) # -------------------------------------------------------------------------------------- # # if BUILD_DOXYGEN_DOCS = ON, we want to build docs quietly else, don't build quietly add_option(${PROJECT_NAME}_DOCS_QUIET "Suppress standard output when making the docs" ON) mark_as_advanced(${PROJECT_NAME}_DOCS_QUIET) if(${PROJECT_NAME}_DOCS_QUIET) set(DOXYGEN_QUIET YES) else() set(DOXYGEN_QUIET NO) endif() # GraphViz dot program is used to build call graphs, caller graphs, class graphs find_program(GRAPHVIZ_DOT_PATH dot) mark_as_advanced(GRAPHVIZ_DOT_PATH) if("${GRAPHVIZ_DOT_PATH}" STREQUAL "GRAPHVIZ_DOT_PATH-NOTFOUND") set(DOXYGEN_DOT_FOUND NO) set(GRAPHVIZ_DOT_PATH "") else() set(DOXYGEN_DOT_FOUND YES) set(GRAPHVIZ_DOT_PATH ${GRAPHVIZ_DOT_PATH}) endif() # available Doxygen doc formats set(AVAILABLE_DOXYGEN_DOC_FORMATS HTML LATEX MAN XML RTF) # we want HTML, LATEX, and MAN to be default set(_default_on "MAN") foreach(_doc_format ${AVAILABLE_DOXYGEN_DOC_FORMATS}) # find if we want it on string(REGEX MATCH "${_doc_format}" SET_TO_ON "${_default_on}") # if doc format is MAN and it is not a UNIX machine --> turn off if("${_doc_format}" STREQUAL "MAN" AND NOT UNIX) set(SET_TO_ON "") endif() # set ON/OFF if("${SET_TO_ON}" STREQUAL "") set(_default "OFF") else() set(_default "ON") endif() # add option add_option(${PROJECT_NAME}_${_doc_format}_DOCS "Build documentation with ${_doc_format} format" ${_default}) mark_as_advanced(${PROJECT_NAME}_${_doc_format}_DOCS) endforeach() # loop over doc formats and set GENERATE_DOXYGEN_${_doc_format}_DOC to YES/NO # GENERATE_DOXYGEN_${_doc_format}_DOC is used in configure_file @ONLY foreach(_doc_format ${AVAILABLE_DOXYGEN_DOC_FORMATS}) if(${PROJECT_NAME}_${_doc_format}_DOCS) set(GENERATE_DOXYGEN_${_doc_format}_DOC YES) else() set(GENERATE_DOXYGEN_${_doc_format}_DOC NO) endif() endforeach() if(DOXYGEN_DOT_FOUND) set(DOXYGEN_DOT_GRAPH_TYPES CLASS CALL CALLER) # options to turn generation of class, call, and caller graphs foreach(_graph_type ${DOXYGEN_DOT_GRAPH_TYPES}) # create CMake doc string string(TOLOWER _graph_type_desc ${_graph_type}) # add option option(${PROJECT_NAME}_${_graph_type}_GRAPH "${_message}" ON) mark_as_advanced(${PROJECT_NAME}_${_graph_type}_GRAPH) # set GENERATE_DOXYGEN_${_graph_type}_GRAPH to YES/NO # GENERATE_DOXYGEN_${_graph_type}_GRAPH is used in configure_file @ONLY if(${PROJECT_NAME}_${_graph_type}_GRAPH) set(GENERATE_DOXYGEN_${_graph_type}_GRAPH YES) else() set(GENERATE_DOXYGEN_${_graph_type}_GRAPH NO) endif() endforeach() endif() # get the documentation include directories get_property(BUILDTREE_DIRS GLOBAL PROPERTY PTL_DOCUMENTATION_DIRS) if("${BUILDTREE_DIRS}" STREQUAL "") message(FATAL_ERROR "Property PTL_DOCUMENTATION_DIRS is empty") endif() list(REMOVE_DUPLICATES BUILDTREE_DIRS) set(SOURCE_FILES) set(EXTENSIONS h hh hpp c cc cpp icc tcc py) foreach(_DIR ${BUILDTREE_DIRS}) foreach(_EXT ${EXTENSIONS}) file(GLOB _FILES "${_DIR}/*.${_EXT}") if(_FILES) list(APPEND SOURCE_FILES ${_FILES}) endif() unset(_FILES CACHE) endforeach() endforeach() # Doxyfiles was spaces not semi-colon separated lists string(REPLACE ";" " " BUILDTREE_DIRS "${BUILDTREE_DIRS}") string(REPLACE ";" " " SOURCE_FILES "${SOURCE_FILES}") # ----------------------------------------------------------------------- if(XCODE) set(GENERATE_DOCSET_IF_XCODE YES) else() set(GENERATE_DOCSET_IF_XCODE NO) endif() # ----------------------------------------------------------------------- configure_file(${PROJECT_SOURCE_DIR}/cmake/Templates/Doxyfile.in ${PROJECT_BINARY_DIR}/doc/Doxyfile.${PROJECT_NAME} @ONLY) if(${PROJECT_NAME}_HTML_DOCS) file(WRITE ${PROJECT_BINARY_DIR}/doc/${PROJECT_NAME}_Documentation.html "") endif() # -------------------------------------------------------------------------------------- # # Macro to generate documentation from: # http://www.cmake.org/pipermail/cmake/2007-May/014174.html macro(GENERATE_DOCUMENTATION DOXYGEN_CONFIG_FILE) find_package(Doxygen) if(NOT Doxygen_FOUND) message( STATUS "Doxygen executable cannot be found. Disable ${PROJECT_NAME}_DOXYGEN_DOCS" ) return() endif() set(DOXYFILE_FOUND false) if(EXISTS ${PROJECT_BINARY_DIR}/doc/${DOXYGEN_CONFIG_FILE}) set(DOXYFILE_FOUND true) else() message( STATUS "Doxygen config file was not found at ${PROJECT_BINARY_DIR}/doc/${DOXYGEN_CONFIG_FILE}" ) endif() if(DOXYGEN_FOUND) if(DOXYFILE_FOUND) # Add target add_custom_target(docs ${DOXYGEN_EXECUTABLE} "${PROJECT_BINARY_DIR}/doc/${DOXYGEN_CONFIG_FILE}") install( DIRECTORY ${PROJECT_BINARY_DIR}/doc/man/ DESTINATION ${CMAKE_INSTALL_MANDIR} OPTIONAL COMPONENT documentation) install( DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION ${CMAKE_INSTALL_DOCDIR} OPTIONAL COMPONENT documentation) install( DIRECTORY ${PROJECT_BINARY_DIR}/doc/latex DESTINATION ${CMAKE_INSTALL_DOCDIR} OPTIONAL COMPONENT documentation) install( FILES ${PROJECT_BINARY_DIR}/doc/${PROJECT_NAME}_Documentation.html DESTINATION ${CMAKE_INSTALL_DOCDIR} OPTIONAL COMPONENT documentation) else() message( STATUS "Doxygen configuration file not found - Documentation will not be generated" ) endif() else() message(STATUS "Doxygen not found - Documentation will not be generated") endif() endmacro() # -------------------------------------------------------------------------------------- # # Macro to generate PDF manual from LaTeX using pdflatex assumes manual is in # ${CMAKE_SOURCE_DIR}/doc macro(GENERATE_MANUAL MANUAL_TEX MANUAL_BUILD_PATH EXTRA_FILES_TO_COPY) find_program(PDFLATEX pdflatex) if(PDFLATEX AND NOT "${PDFLATEX}" STREQUAL "PDFLATEX-NOTFOUND") # name with no path is given set(MANUAL_NAME ${MANUAL_TEX}) # set to full path set(MANUAL_BUILD_PATH ${CMAKE_BINARY_DIR}/${MANUAL_BUILD_PATH}) if(NOT EXISTS ${CMAKE_SOURCE_DIR}/doc/${MANUAL_TEX}) message( FATAL_ERROR "LaTeX of manual for ${PROJECT_NAME} is not in ${CMAKE_SOURCE_DIR}/doc" ) endif() configure_file(${CMAKE_SOURCE_DIR}/doc/${MANUAL_TEX} ${MANUAL_BUILD_PATH}/${MANUAL_NAME} COPYONLY) foreach(_file ${EXTRA_FILES_TO_COPY}) configure_file(${CMAKE_SOURCE_DIR}/doc/${_file} ${MANUAL_BUILD_PATH}/${_file} COPYONLY) endforeach() add_custom_target( man ${PDFLATEX} "${MANUAL_NAME}" WORKING_DIRECTORY ${MANUAL_BUILD_PATH}) endif() endmacro() PTL-2.3.1/cmake/Modules/FindTBB.cmake000066400000000000000000000404471415666170400171010ustar00rootroot00000000000000# - Find ThreadingBuildingBlocks include dirs and libraries # Use this module by invoking find_package with the form: # find_package(TBB # [REQUIRED] # Fail with error if TBB is not found # ) # # Once done, this will define # # TBB_FOUND - system has TBB # TBB_INCLUDE_DIRS - the TBB include directories # TBB_LIBRARIES - TBB libraries to be lined, doesn't include malloc or # malloc proxy # TBB::tbb - imported target for the TBB library # # TBB_VERSION_MAJOR - Major Product Version Number # TBB_VERSION_MINOR - Minor Product Version Number # TBB_INTERFACE_VERSION - Engineering Focused Version Number # TBB_COMPATIBLE_INTERFACE_VERSION - The oldest major interface version # still supported. This uses the engineering # focused interface version numbers. # # TBB_MALLOC_FOUND - system has TBB malloc library # TBB_MALLOC_INCLUDE_DIRS - the TBB malloc include directories # TBB_MALLOC_LIBRARIES - The TBB malloc libraries to be lined # TBB::malloc - imported target for the TBB malloc library # # TBB_MALLOC_PROXY_FOUND - system has TBB malloc proxy library # TBB_MALLOC_PROXY_INCLUDE_DIRS = the TBB malloc proxy include directories # TBB_MALLOC_PROXY_LIBRARIES - The TBB malloc proxy libraries to be lined # TBB::malloc_proxy - imported target for the TBB malloc proxy library # # # This module reads hints about search locations from variables: # ENV TBB_ARCH_PLATFORM - for eg. set it to "mic" for Xeon Phi builds # ENV TBB_ROOT or just TBB_ROOT - root directory of tbb installation # ENV TBB_BUILD_PREFIX - specifies the build prefix for user built tbb # libraries. Should be specified with ENV TBB_ROOT # and optionally... # ENV TBB_BUILD_DIR - if build directory is different than ${TBB_ROOT}/build # # # Modified by Robert Maynard from the original OGRE source # #------------------------------------------------------------------- # This file is part of the CMake build system for OGRE # (Object-oriented Graphics Rendering Engine) # For the latest info, see http://www.ogre3d.org/ # # The contents of this file are placed in the public domain. Feel # free to make use of it in any way you like. #------------------------------------------------------------------- # #============================================================================= # Copyright 2010-2012 Kitware, Inc. # Copyright 2012 Rolf Eike Beer # # 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. #============================================================================= # (To distribute this file outside of CMake, substitute the full # License text for the above reference.) #============================================================================= # FindTBB helper functions and macros # # Use TBBConfig.cmake if possible. set(_tbb_find_quiet) if (TBB_FIND_QUIETLY) set(_tbb_find_quiet QUIET) endif () set(_tbb_find_components) set(_tbb_find_optional_components) foreach (_tbb_find_component IN LISTS TBB_FIND_COMPONENTS) if (TBB_FIND_REQUIRED_${_tbb_find_component}) list(APPEND _tbb_find_components "${_tbb_find_component}") else () list(APPEND _tbb_find_optional_components "${_tbb_find_component}") endif () endforeach () unset(_tbb_find_component) find_package(TBB CONFIG ${_tbb_find_quiet} COMPONENTS ${_tbb_find_components} OPTIONAL_COMPONENTS ${_tbb_find_optional_components}) unset(_tbb_find_quiet) unset(_tbb_find_components) unset(_tbb_find_optional_components) if (TBB_FOUND) return () endif () #==================================================== # Fix the library path in case it is a linker script #==================================================== function(tbb_extract_real_library library real_library) if(NOT UNIX OR NOT EXISTS ${library}) set(${real_library} "${library}" PARENT_SCOPE) return() endif() #Read in the first 4 bytes and see if they are the ELF magic number set(_elf_magic "7f454c46") file(READ ${library} _hex_data OFFSET 0 LIMIT 4 HEX) if(_hex_data STREQUAL _elf_magic) #we have opened a elf binary so this is what #we should link to set(${real_library} "${library}" PARENT_SCOPE) return() endif() file(READ ${library} _data OFFSET 0 LIMIT 1024) if("${_data}" MATCHES "INPUT \\(([^(]+)\\)") #extract out the .so name from REGEX MATCH command set(_proper_so_name "${CMAKE_MATCH_1}") #construct path to the real .so which is presumed to be in the same directory #as the input file get_filename_component(_so_dir "${library}" DIRECTORY) set(${real_library} "${_so_dir}/${_proper_so_name}" PARENT_SCOPE) else() #unable to determine what this library is so just hope everything works #and pass it unmodified. set(${real_library} "${library}" PARENT_SCOPE) endif() endfunction() #=============================================== # Do the final processing for the package find. #=============================================== macro(findpkg_finish PREFIX TARGET_NAME) if (${PREFIX}_INCLUDE_DIR AND ${PREFIX}_LIBRARY) set(${PREFIX}_FOUND TRUE) set (${PREFIX}_INCLUDE_DIRS ${${PREFIX}_INCLUDE_DIR}) set (${PREFIX}_LIBRARIES ${${PREFIX}_LIBRARY}) else () if (${PREFIX}_FIND_REQUIRED AND NOT ${PREFIX}_FIND_QUIETLY) message(FATAL_ERROR "Required library ${PREFIX} not found.") endif () endif () if (NOT TARGET "TBB::${TARGET_NAME}") if (${PREFIX}_LIBRARY_RELEASE) tbb_extract_real_library(${${PREFIX}_LIBRARY_RELEASE} real_release) endif () if (${PREFIX}_LIBRARY_DEBUG) tbb_extract_real_library(${${PREFIX}_LIBRARY_DEBUG} real_debug) endif () add_library(TBB::${TARGET_NAME} UNKNOWN IMPORTED) set_target_properties(TBB::${TARGET_NAME} PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${${PREFIX}_INCLUDE_DIR}") if (${PREFIX}_LIBRARY_DEBUG AND ${PREFIX}_LIBRARY_RELEASE) set_target_properties(TBB::${TARGET_NAME} PROPERTIES IMPORTED_LOCATION "${real_release}" IMPORTED_LOCATION_DEBUG "${real_debug}" IMPORTED_LOCATION_RELEASE "${real_release}") elseif (${PREFIX}_LIBRARY_RELEASE) set_target_properties(TBB::${TARGET_NAME} PROPERTIES IMPORTED_LOCATION "${real_release}") elseif (${PREFIX}_LIBRARY_DEBUG) set_target_properties(TBB::${TARGET_NAME} PROPERTIES IMPORTED_LOCATION "${real_debug}") endif () endif () #mark the following variables as internal variables mark_as_advanced(${PREFIX}_INCLUDE_DIR ${PREFIX}_LIBRARY ${PREFIX}_LIBRARY_DEBUG ${PREFIX}_LIBRARY_RELEASE) endmacro() #=============================================== # Generate debug names from given release names #=============================================== macro(get_debug_names PREFIX) foreach(i ${${PREFIX}}) set(${PREFIX}_DEBUG ${${PREFIX}_DEBUG} ${i}d ${i}D ${i}_d ${i}_D ${i}_debug ${i}) endforeach() endmacro() #=============================================== # See if we have env vars to help us find tbb #=============================================== macro(getenv_path VAR) set(ENV_${VAR} $ENV{${VAR}}) # replace won't work if var is blank if (ENV_${VAR}) string( REGEX REPLACE "\\\\" "/" ENV_${VAR} ${ENV_${VAR}} ) endif () endmacro() #=============================================== # Couple a set of release AND debug libraries #=============================================== macro(make_library_set PREFIX) if (${PREFIX}_RELEASE AND ${PREFIX}_DEBUG) set(${PREFIX} optimized ${${PREFIX}_RELEASE} debug ${${PREFIX}_DEBUG}) elseif (${PREFIX}_RELEASE) set(${PREFIX} ${${PREFIX}_RELEASE}) elseif (${PREFIX}_DEBUG) set(${PREFIX} ${${PREFIX}_DEBUG}) endif () endmacro() #============================================================================= # Now to actually find TBB # # Get path, convert backslashes as ${ENV_${var}} getenv_path(TBB_ROOT) # initialize search paths set(TBB_PREFIX_PATH ${TBB_ROOT} ${ENV_TBB_ROOT}) set(TBB_INC_SEARCH_PATH "") set(TBB_LIB_SEARCH_PATH "") # If user built from sources set(TBB_BUILD_PREFIX $ENV{TBB_BUILD_PREFIX}) if (TBB_BUILD_PREFIX AND ENV_TBB_ROOT) getenv_path(TBB_BUILD_DIR) if (NOT ENV_TBB_BUILD_DIR) set(ENV_TBB_BUILD_DIR ${ENV_TBB_ROOT}/build) endif () # include directory under ${ENV_TBB_ROOT}/include list(APPEND TBB_LIB_SEARCH_PATH ${ENV_TBB_BUILD_DIR}/${TBB_BUILD_PREFIX}_release ${ENV_TBB_BUILD_DIR}/${TBB_BUILD_PREFIX}_debug) endif () # For Windows, let's assume that the user might be using the precompiled # TBB packages from the main website. These use a rather awkward directory # structure (at least for automatically finding the right files) depending # on platform and compiler, but we'll do our best to accommodate it. # Not adding the same effort for the precompiled linux builds, though. Those # have different versions for CC compiler versions and linux kernels which # will never adequately match the user's setup, so there is no feasible way # to detect the "best" version to use. The user will have to manually # select the right files. (Chances are the distributions are shipping their # custom version of tbb, anyway, so the problem is probably nonexistent.) if (WIN32 AND MSVC) set(COMPILER_PREFIX "vc7.1") if (MSVC_VERSION EQUAL 1400) set(COMPILER_PREFIX "vc8") elseif(MSVC_VERSION EQUAL 1500) set(COMPILER_PREFIX "vc9") elseif(MSVC_VERSION EQUAL 1600) set(COMPILER_PREFIX "vc10") elseif(MSVC_VERSION EQUAL 1700) set(COMPILER_PREFIX "vc11") elseif(MSVC_VERSION EQUAL 1800) set(COMPILER_PREFIX "vc12") elseif(MSVC_VERSION GREATER_EQUAL 1900) set(COMPILER_PREFIX "vc14") endif () # for each prefix path, add ia32/64\${COMPILER_PREFIX}\lib to the lib search path foreach (dir IN LISTS TBB_PREFIX_PATH) if (CMAKE_CL_64) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/ia64/${COMPILER_PREFIX}/lib) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/lib/ia64/${COMPILER_PREFIX}) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/intel64/${COMPILER_PREFIX}/lib) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/lib/intel64/${COMPILER_PREFIX}) else () list(APPEND TBB_LIB_SEARCH_PATH ${dir}/ia32/${COMPILER_PREFIX}/lib) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/lib/ia32/${COMPILER_PREFIX}) endif () endforeach () endif () # For OS X binary distribution, choose libc++ based libraries for Mavericks (10.9) # and above and AppleClang if (CMAKE_SYSTEM_NAME STREQUAL "Darwin" AND NOT CMAKE_SYSTEM_VERSION VERSION_LESS 13.0) set (USE_LIBCXX OFF) cmake_policy(GET CMP0025 POLICY_VAR) if (POLICY_VAR STREQUAL "NEW") if (CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang") set (USE_LIBCXX ON) endif () else () if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang") set (USE_LIBCXX ON) endif () endif () if (USE_LIBCXX) foreach (dir IN LISTS TBB_PREFIX_PATH) list (APPEND TBB_LIB_SEARCH_PATH ${dir}/lib/libc++ ${dir}/libc++/lib) endforeach () endif () endif () # check compiler ABI if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU") set(COMPILER_PREFIX) if (NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.8) list(APPEND COMPILER_PREFIX "gcc4.8") endif() if (NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.7) list(APPEND COMPILER_PREFIX "gcc4.7") endif() if (NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.4) list(APPEND COMPILER_PREFIX "gcc4.4") endif() list(APPEND COMPILER_PREFIX "gcc4.1") elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang") set(COMPILER_PREFIX) if (NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.0) # Complete guess list(APPEND COMPILER_PREFIX "gcc4.8") endif() if (NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS 3.6) list(APPEND COMPILER_PREFIX "gcc4.7") endif() list(APPEND COMPILER_PREFIX "gcc4.4") else() # Assume compatibility with 4.4 for other compilers list(APPEND COMPILER_PREFIX "gcc4.4") endif () # if platform architecture is explicitly specified set(TBB_ARCH_PLATFORM $ENV{TBB_ARCH_PLATFORM}) if (TBB_ARCH_PLATFORM) foreach (dir IN LISTS TBB_PREFIX_PATH) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/${TBB_ARCH_PLATFORM}/lib) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/lib/${TBB_ARCH_PLATFORM}) endforeach () endif () foreach (dir IN LISTS TBB_PREFIX_PATH) foreach (prefix IN LISTS COMPILER_PREFIX) if (CMAKE_SIZEOF_VOID_P EQUAL 8) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/lib/intel64) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/lib/intel64/${prefix}) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/intel64/lib) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/intel64/${prefix}/lib) else () list(APPEND TBB_LIB_SEARCH_PATH ${dir}/lib/ia32) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/lib/ia32/${prefix}) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/ia32/lib) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/ia32/${prefix}/lib) endif () endforeach() endforeach () # add general search paths foreach (dir IN LISTS TBB_PREFIX_PATH) list(APPEND TBB_LIB_SEARCH_PATH ${dir}/lib ${dir}/Lib ${dir}/lib/tbb ${dir}/Libs) list(APPEND TBB_INC_SEARCH_PATH ${dir}/include ${dir}/Include ${dir}/include/tbb) endforeach () set(TBB_LIBRARY_NAMES tbb) get_debug_names(TBB_LIBRARY_NAMES) find_path(TBB_INCLUDE_DIR NAMES tbb/tbb.h PATHS ${TBB_INC_SEARCH_PATH}) find_library(TBB_LIBRARY_RELEASE NAMES ${TBB_LIBRARY_NAMES} PATHS ${TBB_LIB_SEARCH_PATH}) find_library(TBB_LIBRARY_DEBUG NAMES ${TBB_LIBRARY_NAMES_DEBUG} PATHS ${TBB_LIB_SEARCH_PATH}) make_library_set(TBB_LIBRARY) findpkg_finish(TBB tbb) #if we haven't found TBB no point on going any further if (NOT TBB_FOUND) return() endif () #============================================================================= # Look for TBB's malloc package set(TBB_MALLOC_LIBRARY_NAMES tbbmalloc) get_debug_names(TBB_MALLOC_LIBRARY_NAMES) find_path(TBB_MALLOC_INCLUDE_DIR NAMES tbb/tbb.h PATHS ${TBB_INC_SEARCH_PATH}) find_library(TBB_MALLOC_LIBRARY_RELEASE NAMES ${TBB_MALLOC_LIBRARY_NAMES} PATHS ${TBB_LIB_SEARCH_PATH}) find_library(TBB_MALLOC_LIBRARY_DEBUG NAMES ${TBB_MALLOC_LIBRARY_NAMES_DEBUG} PATHS ${TBB_LIB_SEARCH_PATH}) make_library_set(TBB_MALLOC_LIBRARY) findpkg_finish(TBB_MALLOC tbbmalloc) #============================================================================= # Look for TBB's malloc proxy package set(TBB_MALLOC_PROXY_LIBRARY_NAMES tbbmalloc_proxy) get_debug_names(TBB_MALLOC_PROXY_LIBRARY_NAMES) find_path(TBB_MALLOC_PROXY_INCLUDE_DIR NAMES tbb/tbbmalloc_proxy.h PATHS ${TBB_INC_SEARCH_PATH}) find_library(TBB_MALLOC_PROXY_LIBRARY_RELEASE NAMES ${TBB_MALLOC_PROXY_LIBRARY_NAMES} PATHS ${TBB_LIB_SEARCH_PATH}) find_library(TBB_MALLOC_PROXY_LIBRARY_DEBUG NAMES ${TBB_MALLOC_PROXY_LIBRARY_NAMES_DEBUG} PATHS ${TBB_LIB_SEARCH_PATH}) make_library_set(TBB_MALLOC_PROXY_LIBRARY) findpkg_finish(TBB_MALLOC_PROXY tbbmalloc_proxy) #============================================================================= #parse all the version numbers from tbb if(NOT TBB_VERSION) if (EXISTS "${TBB_INCLUDE_DIR}/oneapi/tbb/version.h") file(STRINGS "${TBB_INCLUDE_DIR}/oneapi/tbb/version.h" TBB_VERSION_CONTENTS REGEX "VERSION") else() #only read the start of the file file(STRINGS "${TBB_INCLUDE_DIR}/tbb/tbb_stddef.h" TBB_VERSION_CONTENTS REGEX "VERSION") endif() string(REGEX REPLACE ".*#define TBB_VERSION_MAJOR ([0-9]+).*" "\\1" TBB_VERSION_MAJOR "${TBB_VERSION_CONTENTS}") string(REGEX REPLACE ".*#define TBB_VERSION_MINOR ([0-9]+).*" "\\1" TBB_VERSION_MINOR "${TBB_VERSION_CONTENTS}") string(REGEX REPLACE ".*#define TBB_INTERFACE_VERSION ([0-9]+).*" "\\1" TBB_INTERFACE_VERSION "${TBB_VERSION_CONTENTS}") string(REGEX REPLACE ".*#define TBB_COMPATIBLE_INTERFACE_VERSION ([0-9]+).*" "\\1" TBB_COMPATIBLE_INTERFACE_VERSION "${TBB_VERSION_CONTENTS}") set(TBB_VERSION "${TBB_VERSION_MAJOR}.${TBB_VERSION_MINOR}") endif() include(FindPackageHandleStandardArgs) find_package_handle_standard_args(TBB REQUIRED_VARS TBB_INCLUDE_DIR TBB_LIBRARY VERSION_VAR TBB_VERSION) PTL-2.3.1/cmake/Modules/PTLBuildSettings.cmake000066400000000000000000000105501415666170400210210ustar00rootroot00000000000000# PTL Build Settings and Options include(PTLCMakeUtilities) include(CheckCXXCompilerFlag) # -------------------------------------------------------------------------------------- # # # Build Type(s) # # -------------------------------------------------------------------------------------- # set(__ptl_default_build_type "Release") if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) message( STATUS "Forcing PTL CMAKE_BUILD_TYPE to '${__ptl_default_build_type}' as none was specified" ) set(CMAKE_BUILD_TYPE "${__ptl_default_build_type}" CACHE STRING "Choose the type of build." FORCE) # Set the possible values of build type for cmake-gui set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo") endif() # -------------------------------------------------------------------------------------- # # # Output Directories for build products # # -------------------------------------------------------------------------------------- # # If master project, set the output directory (critical on Windows and Xcode) Otherwise we # leave this at the discretion of the parent project # if(PTL_MASTER_PROJECT) set(_BIN_DIR ${PROJECT_BINARY_DIR}) if(WIN32) set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${_BIN_DIR}/outputs/runtime) set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${_BIN_DIR}/outputs/library) set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${_BIN_DIR}/outputs/archive) else() set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${_BIN_DIR}) set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${_BIN_DIR}) set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${_BIN_DIR}) endif() endif() # -------------------------------------------------------------------------------------- # # # Library types # # -------------------------------------------------------------------------------------- # ptl_add_option(BUILD_STATIC_LIBS "Build static library" ON) ptl_add_option(BUILD_SHARED_LIBS "Build shared library" ON) if((NOT BUILD_SHARED_LIBS) AND (NOT BUILD_STATIC_LIBS)) message( FATAL_ERROR "Neither BUILD_STATIC_LIBS nor BUILD_SHARED_LIBS are set. One must be ON") endif() # -------------------------------------------------------------------------------------- # # # C/C++ Standard and Flags # # -------------------------------------------------------------------------------------- # if(WIN32) set(CMAKE_CXX_STANDARD 14 CACHE STRING "C++ STL standard") else() set(CMAKE_CXX_STANDARD 11 CACHE STRING "C++ STL standard") endif() ptl_message_on_change(CMAKE_CXX_STANDARD "Building PTL with CMAKE_CXX_STANDARD") set(CMAKE_CXX_STANDARD_REQUIRED ON) set(CMAKE_CXX_EXTENSIONS OFF) # Add allocation export symbol for the PTL module Should this be a # target_compile_definition? add_compile_definitions(PTL_ALLOC_EXPORT) # -------------------------------------------------------------------------------------- # # # Testing/Profiling Options # # -------------------------------------------------------------------------------------- # # Coverage compile/link settings See also: # https://discourse.cmake.org/t/best-practice-for-multi-config-build-options/2049 ptl_add_option(PTL_USE_COVERAGE "Enable code coverage" OFF) if(PTL_USE_COVERAGE) if((NOT CMAKE_BUILD_TYPE STREQUAL "Debug") AND (NOT CMAKE_CONFIGURATION_TYPES)) message( WARNING "PTL_USE_COVERAGE is ON, but the build mode is not 'Debug': coverage testing will be disabled." ) set(PTL_USE_COVERAGE OFF CACHE BOOL "Enable code coverage (disabled)" FORCE) else() include(PTLCoverage) endif() endif() # Sanitizer compile/link flags See also: # https://discourse.cmake.org/t/best-practice-for-multi-config-build-options/2049 ptl_add_option(PTL_USE_SANITIZER "Enable -fsanitize=" OFF) if(PTL_USE_SANITIZER) set(PTL_SANITIZER_TYPE "thread" CACHE STRING "Sanitizer type (-fsanitize=)") set_property(CACHE PTL_SANITIZER_TYPE PROPERTY STRINGS "thread" "address" "undefined") ptl_message_on_change(PTL_SANITIZER_TYPE "Building PTL with sanitizer type") include(PTLSanitize) endif() # Clang Tooling include(PTLFormatting) ptl_add_option(PTL_USE_CLANG_TIDY "Enable running clang-tidy on sources" OFF) if(PTL_USE_CLANG_TIDY) include(PTLLinting) endif() PTL-2.3.1/cmake/Modules/PTLCMakeUtilities.cmake000066400000000000000000000102631415666170400211160ustar00rootroot00000000000000# PTLCMakeUtilities - useful macros and functions for generic tasks # # CMake Extensions # ---------------- # * Include guard include_guard(DIRECTORY) include(CMakeParseArguments) # -------------------------------------------------------------------------------------- # # function ptl_message_on_change( ) Watch and print and # 's value when the value changes # function(ptl_message_on_change _var _prefix) set(_ptl_watch_var_name PTL_WATCH_VALUE_${_var}) if(DEFINED ${_ptl_watch_var_name}) if("${${_var}}" STREQUAL "${${_ptl_watch_var_name}}") return() endif() endif() set(${_ptl_watch_var_name} "${${_var}}" CACHE INTERNAL "Last value of ${_var}" FORCE) message(STATUS "${_prefix} - ${${_var}}") endfunction() # -------------------------------------------------------------------------------------- # # function ptl_add_feature( ) Store activation of a feature and a # docstring describing it. should be a variable whose value indicates activation of # the feature # function(ptl_add_feature _var _description) if(${_var}) set_property(GLOBAL APPEND PROPERTY PTL_ENABLED_FEATURES ${_var}) endif() set_property(GLOBAL PROPERTY PTL_FEATURE_${_var}_DESCRIPTION "${_description}") endfunction() # ----------------------------------------------------------------------- # function ptl_print_features() Print enabled features plus their docstrings. # function(ptl_print_features) set(_currentFeatureText "The following PTL features are enabled:") get_property(_enabledFeatures GLOBAL PROPERTY PTL_ENABLED_FEATURES) foreach(_feature ${_enabledFeatures}) set(_currentFeatureText "${_currentFeatureText}\n - ${_feature}") get_property(_desc GLOBAL PROPERTY PTL_FEATURE_${_feature}_DESCRIPTION) if(_desc) set(_currentFeatureText "${_currentFeatureText}: ${_desc}") set(_desc NOTFOUND) endif() endforeach() message(STATUS "${_currentFeatureText}\n") endfunction() # -------------------------------------------------------------------------------------- # # function ptl_add_option( ) Add an option for # master project only, always reporting its value # function(ptl_add_option _NAME _MESSAGE _DEFAULT) if(PTL_MASTER_PROJECT) option(${_NAME} "${_MESSAGE}" ${_DEFAULT}) ptl_add_feature(${_NAME} "${_MESSAGE}") endif() # Always on configure time reporting ptl_message_on_change(${_NAME} "Building PTL with option ${_NAME}") endfunction() # ---------------------------------------------------------------------------- # function ptl_build_library Encapsulates common build/install for main PTL shared/static # libs # function(ptl_build_library) cmake_parse_arguments(LIB "" "TYPE;TARGET_NAME;OUTPUT_NAME" "SOURCES;EXTRA_ARGS" ${ARGN}) if(NOT LIB_OUTPUT_NAME) set(LIB_OUTPUT_NAME ${LIB_TARGET_NAME}) endif() add_library(${LIB_TARGET_NAME} ${LIB_TYPE} ${LIB_SOURCES}) add_library(${PROJECT_NAME}::${LIB_TARGET_NAME} ALIAS ${LIB_TARGET_NAME}) set_target_properties( ${LIB_TARGET_NAME} PROPERTIES OUTPUT_NAME ${LIB_OUTPUT_NAME} VERSION ${${PROJECT_NAME}_VERSION} SOVERSION ${${PROJECT_NAME}_VERSION_MAJOR} WINDOWS_EXPORT_ALL_SYMBOLS ON) target_compile_definitions(${LIB_TARGET_NAME} PRIVATE $<$:DEBUG>) target_compile_features(${LIB_TARGET_NAME} PUBLIC cxx_std_${CMAKE_CXX_STANDARD}) # Subproject overrides only if not a master project if(NOT PTL_MASTER_PROJECT) target_compile_options( ${LIB_TARGET_NAME} PRIVATE $<$:${${PROJECT_NAME}_C_FLAGS}> $<$:${${PROJECT_NAME}_CXX_FLAGS}>) endif() # Install the targets and export libraries install( TARGETS ${LIB_TARGET_NAME} EXPORT ${PROJECT_NAME}Targets COMPONENT Development ARCHIVE DESTINATION ${PTL_INSTALL_LIBDIR} LIBRARY DESTINATION ${PTL_INSTALL_LIBDIR} RUNTIME DESTINATION ${PTL_INSTALL_BINDIR}) endfunction() PTL-2.3.1/cmake/Modules/PTLCoverage.cmake000066400000000000000000000020351415666170400177730ustar00rootroot00000000000000if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|(Apple)?Clang") set(ptl_coverage_args "--coverage") check_cxx_compiler_flag("-fprofile-abs-path ${PTL_COVERAGE_FLAGS}" PTL_HAS_PROFILE_ABS_PATH) if(PTL_HAS_PROFILE_ABS_PATH) string(APPEND ptl_coverage_args " -fprofile-abs-path") endif() else() set(ptl_coverage_args) message( WARNING "PTL_USE_COVERAGE is ON, but is not supported for compiler '${CMAKE_CXX_COMPILER_ID}" ) endif() # We're setting the DEBUG CXX flags and C flags because we only use coverage in Debug # builds but want them to propagate down Once CMake 3.13 is the minimum, we can use # add_{compile,link}_options + genexs instead string(APPEND CMAKE_C_FLAGS_DEBUG " ${ptl_coverage_args}") string(APPEND CMAKE_CXX_FLAGS_DEBUG " ${ptl_coverage_args}") string(APPEND CMAKE_EXE_LINKER_FLAGS_DEBUG " ${ptl_coverage_args}") string(APPEND CMAKE_SHARED_LINKER_FLAGS_DEBUG " ${ptl_coverage_args}") string(APPEND CMAKE_MODULE_LINKER_FLAGS_DEBUG " ${ptl_coverage_args}") PTL-2.3.1/cmake/Modules/PTLFormatting.cmake000066400000000000000000000040371415666170400203560ustar00rootroot00000000000000# * Clang-format only for master project if(PTL_CLANG_FORMATTER MATCHES ".*-6") unset(PTL_CLANG_FORMATTER CACHE) endif() find_program(PTL_CLANG_FORMATTER NAMES clang-format-9 clang-format-mp-9.0 clang-format) mark_as_advanced(PTL_CLANG_FORMATTER) find_program(PTL_CMAKE_FORMATTER NAMES cmake-format) mark_as_advanced(PTL_CMAKE_FORMATTER) set(PTL_FORMAT_TARGET format) if(TARGET format) set(PTL_FORMAT_TARGET format-ptl) endif() if(PTL_CLANG_FORMATTER) set(_Source_DIR ${PROJECT_SOURCE_DIR}/source) set(_Example_DIR ${PROJECT_SOURCE_DIR}/examples) file(GLOB_RECURSE headers ${_Source_DIR}/*.hh ${_Source_DIR}/*.icc ${_Example_DIR}/*.hh ${_Example_DIR}/*.h) file(GLOB_RECURSE sources ${_Source_DIR}/*.cc ${_Source_DIR}/*.c ${_Example_DIR}/*.cc ${_Example_DIR}/*.cu) add_custom_target( ${PTL_FORMAT_TARGET}-source COMMAND ${PTL_CLANG_FORMATTER} -i ${headers} ${sources} WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} COMMENT "Running '${PTL_CLANG_FORMATTER}' on '${_Source_DIR}' and '${_Example_DIR}..." SOURCES ${headers} ${sources}) endif() if(PTL_CMAKE_FORMATTER) set(_Source_DIR ${PROJECT_SOURCE_DIR}/source) set(_Example_DIR ${PROJECT_SOURCE_DIR}/examples) file(GLOB_RECURSE cmake_files "${PROJECT_SOURCE_DIR}/**/CMakeLists.txt" "${PROJECT_SOURCE_DIR}/*.cmake" "${PROJECT_SOURCE_DIR}/*.cmake.in") list(REMOVE_ITEM cmake_files "${PROJECT_SOURCE_DIR}/cmake/Modules/FindTBB.cmake") add_custom_target( ${PTL_FORMAT_TARGET}-cmake COMMAND ${PTL_CMAKE_FORMATTER} -i ${cmake_files} WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} COMMENT "Running '${PTL_CMAKE_FORMATTER}'..." SOURCES ${cmake_files}) endif() foreach(_FORMAT_TARGET ${PTL_FORMAT_TARGET}-source) # avoid conflicting format targets if(NOT TARGET ${PTL_FORMAT_TARGET}) add_custom_target(${PTL_FORMAT_TARGET}) endif() if(TARGET ${_FORMAT_TARGET}) add_dependencies(${PTL_FORMAT_TARGET} ${_FORMAT_TARGET}) endif() endforeach() PTL-2.3.1/cmake/Modules/PTLInstallDirs.cmake000066400000000000000000000022031415666170400204650ustar00rootroot00000000000000# -------------------------------------------------------------------------------------- # # # installation directories # # -------------------------------------------------------------------------------------- # include(GNUInstallDirs) # cmake installation folder (not exposed to user) set(CMAKE_INSTALL_CMAKEDIR ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}) if(NOT IS_ABSOLUTE "${CMAKE_INSTALL_CMAKEDIR}") set(CMAKE_INSTALL_FULL_CMAKEDIR ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_CMAKEDIR}) else() set(CMAKE_INSTALL_FULL_CMAKEDIR ${CMAKE_INSTALL_CMAKEDIR}) endif() # Create PTL_ versions that are used internally and may be overriden by master projects # When we are the master project, these are *always* set to the value(s) of # CMAKE_INSTALL_ Otherwise, the value of CMAKE_INSTALL_ is used as the # default. foreach(_TYPE DATAROOT CMAKE INCLUDE LIB BIN MAN DOC) if(PTL_MASTER_PROJECT) set(PTL_INSTALL_${_TYPE}DIR "${CMAKE_INSTALL_${_TYPE}DIR}") else() if(NOT DEFINED PTL_INSTALL_${_TYPE}DIR) set(PTL_INSTALL_${_TYPE}DIR "${CMAKE_INSTALL_${_TYPE}DIR}") endif() endif() endforeach() PTL-2.3.1/cmake/Modules/PTLLinting.cmake000066400000000000000000000021361415666170400176460ustar00rootroot00000000000000# Only search for clang-tidy if user has not supplied it through CMAKE_CXX_CLANG_TIDY if(NOT DEFINED CMAKE_CXX_CLANG_TIDY) find_program( PTL_CLANG_TIDY_COMMAND NAMES clang-tidy clang-tidy-12 clang-tidy-11 clang-tidy-10 clang-tidy-9 clang-tidy-8 clang-tidy-7) mark_as_advanced(PTL_CLANG_TIDY_COMMAND) if(NOT PTL_CLANG_TIDY_COMMAND) message( FATAL_ERROR "PTL_USE_CLANG_TIDY is ON, but no clang-tidy program could be found") endif() set(CMAKE_CXX_CLANG_TIDY "${PTL_CLANG_TIDY_COMMAND}") endif() # Create a preprocessor definition that depends on .clang-tidy content so the compile # command will change when .clang-tidy changes. Nothing actually uses this definition, it # is simply added to trigger a rebuild when *only* .clang-tidy changes. file(SHA1 ${PROJECT_SOURCE_DIR}/.clang-tidy __ptl_clang_tidy_sha1) add_compile_definitions("PTL_CLANG_TIDY_SHA1=${__ptl_clang_tidy_sha1}") unset(__ptl_clang_tidy_sha1) configure_file(${PROJECT_SOURCE_DIR}/.clang-tidy ${PROJECT_SOURCE_DIR}/.clang-tidy COPYONLY) PTL-2.3.1/cmake/Modules/PTLPackageConfigHelpers.cmake000066400000000000000000000055661415666170400222600ustar00rootroot00000000000000# -------------------------------------------------------------------------------------- # # PTL CMake Package Config installation # include(CMakePackageConfigHelpers) # Generic write_basic_package_version_file( ${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake VERSION ${PROJECT_VERSION} COMPATIBILITY SameMajorVersion) # Install Tree set(INCLUDE_INSTALL_DIR "${PTL_INSTALL_INCLUDEDIR}") set(LIB_INSTALL_DIR "${PTL_INSTALL_LIBDIR}") set(CMAKE_MODULE_INSTALL_DIR "${PTL_INSTALL_CMAKEDIR}/Modules") configure_package_config_file( ${PROJECT_SOURCE_DIR}/cmake/Templates/${PROJECT_NAME}Config.cmake.in ${PROJECT_BINARY_DIR}/installation/${PROJECT_NAME}Config.cmake INSTALL_DESTINATION ${PTL_INSTALL_CMAKEDIR} INSTALL_PREFIX ${PTL_INSTALL_PREFIX} PATH_VARS INCLUDE_INSTALL_DIR LIB_INSTALL_DIR CMAKE_MODULE_INSTALL_DIR) install( FILES ${PROJECT_BINARY_DIR}/installation/${PROJECT_NAME}Config.cmake ${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake DESTINATION ${PTL_INSTALL_CMAKEDIR} COMPONENT Development) install( FILES ${PROJECT_SOURCE_DIR}/cmake/Modules/FindTBB.cmake DESTINATION ${PTL_INSTALL_CMAKEDIR}/Modules COMPONENT Development) # Build Tree set(INCLUDE_INSTALL_DIR "${PROJECT_SOURCE_DIR}/source") set(LIB_INSTALL_DIR "${PROJECT_BINARY_DIR}") set(CMAKE_MODULE_INSTALL_DIR "${PROJECT_SOURCE_DIR}/cmake/Modules") configure_package_config_file( ${PROJECT_SOURCE_DIR}/cmake/Templates/${PROJECT_NAME}Config.cmake.in ${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake INSTALL_DESTINATION ${PROJECT_BINARY_DIR} INSTALL_PREFIX ${PROJECT_BINARY_DIR} PATH_VARS INCLUDE_INSTALL_DIR LIB_INSTALL_DIR CMAKE_MODULE_INSTALL_DIR) configure_file(${PROJECT_SOURCE_DIR}/cmake/Templates/${PROJECT_NAME}BuildTargets.cmake ${PROJECT_BINARY_DIR}/${PROJECT_NAME}Targets.cmake COPYONLY) # -------------------------------------------------------------------------------------- # # PTL pkg-config file install NB: The `-std=c++` flag is currently exported to # Cflags. Not at all clear how this is supposed to be handled in pkg-config yet. This is # therefore a "simplest and dumbest" solution set(PTL_PC_INCLUDEDIR "\${prefix}/PTL_INSTALL_INCLUDEDIR}") if(IS_ABSOLUTE "${PTL_INSTALL_INCLUDEDIR}") set(PTL_PC_INCLUDEDIR "${PTL_INSTALL_INCLUDEDIR}") endif() set(PTL_PC_LIBDIR "\${prefix}/PTL_INSTALL_LIBDIR}") if(IS_ABSOLUTE "${PTL_INSTALL_LIBDIR}") set(PTL_PC_INCLUDEDIR "${PTL_INSTALL_LIBDIR}") endif() if(PTL_USE_TBB) # Left as exact until we know version/soversions for TBB better set(PTL_PC_TBB_REQUIREMENT "tbb = ${TBB_VERSION}") endif() configure_file(${PROJECT_SOURCE_DIR}/cmake/Templates/ptl.pc.in ${PROJECT_BINARY_DIR}/installation/ptl.pc @ONLY) install( FILES "${PROJECT_BINARY_DIR}/installation/ptl.pc" DESTINATION ${PTL_INSTALL_LIBDIR}/pkgconfig COMPONENT Development) PTL-2.3.1/cmake/Modules/PTLSanitize.cmake000066400000000000000000000017511415666170400200320ustar00rootroot00000000000000if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|(Apple)?Clang") set(ptl_sanitize_args "-fsanitize=${PTL_SANITIZER_TYPE}") if(NOT ("${PTL_SANITIZER_TYPE}" STREQUAL "thread")) string( APPEND ptl_sanitize_args " -fno-optimize-sibling-calls -fno-omit-frame-pointer -fno-inline-functions") endif() else() set(ptl_sanitize_args) message( WARNING "PTL_USE_SANITIZER is ON, but is not supported for compiler '${CMAKE_CXX_COMPILER_ID}" ) endif() # We're setting the CXX flags and C flags beacuse they're propagated down independent of # build type. Once CMake 3.13 is the minimum, we can use add_{compile,link}_options + # genexs instead string(APPEND CMAKE_CXX_FLAGS " ${ptl_sanitize_args}") string(APPEND CMAKE_C_FLAGS " ${ptl_sanitize_args}") string(APPEND CMAKE_EXE_LINKER_FLAGS " ${ptl_sanitize_args}") string(APPEND CMAKE_SHARED_LINKER_FLAGS " ${ptl_sanitize_args}") string(APPEND CMAKE_MODULE_LINKER_FLAGS " ${ptl_sanitize_args}") PTL-2.3.1/cmake/Templates/000077500000000000000000000000001415666170400152045ustar00rootroot00000000000000PTL-2.3.1/cmake/Templates/Config.hh.in000066400000000000000000000025561415666170400173470ustar00rootroot00000000000000// MIT License // // Copyright (c) 2021 Ben Morgan // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. // // #pragma once // // This file was auto-generated by CMake. DO NOT EDIT! // // Defined if PTL is using TBB as a tasking backend #cmakedefine PTL_USE_TBB // Defined if PTL's `UserTaskQueue` uses mutex locks for additional safety #cmakedefine PTL_USE_LOCKS PTL-2.3.1/cmake/Templates/Doxyfile.in000066400000000000000000003537061415666170400173350ustar00rootroot00000000000000# Doxyfile 1.8.13 #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = @PROJECT_NAME@ PROJECT_NUMBER = @PROJECT_VERSION@ PROJECT_BRIEF = "Parallel Tasking Library (PTL)" PROJECT_LOGO = OUTPUT_DIRECTORY = doc CREATE_SUBDIRS = NO ALLOW_UNICODE_NAMES = YES OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = YES INLINE_INHERITED_MEMB = YES FULL_PATH_NAMES = YES STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ \ @PROJECT_SOURCE_DIR@/source STRIP_FROM_INC_PATH = @PROJECT_SOURCE_DIR@/source SHORT_NAMES = YES JAVADOC_AUTOBRIEF = NO QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 4 ALIASES = TCL_SUBST = OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO EXTENSION_MAPPING = hpp=C++ \ cpp=C++ \ hh=C++ \ cc=C++ \ icc=C++ \ py=Python MARKDOWN_SUPPORT = YES TOC_INCLUDE_HEADINGS = 2 AUTOLINK_SUPPORT = YES BUILTIN_STL_SUPPORT = YES CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO IDL_PROPERTY_SUPPORT = YES DISTRIBUTE_GROUP_DOC = NO GROUP_NESTED_COMPOUNDS = NO SUBGROUPING = NO INLINE_GROUPED_CLASSES = NO INLINE_SIMPLE_STRUCTS = YES TYPEDEF_HIDES_STRUCT = NO LOOKUP_CACHE_SIZE = 5 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- EXTRACT_ALL = YES EXTRACT_PRIVATE = YES EXTRACT_PACKAGE = YES EXTRACT_STATIC = YES EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = YES HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = NO HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO CASE_SENSE_NAMES = NO HIDE_SCOPE_NAMES = NO HIDE_COMPOUND_REFERENCE= NO SHOW_INCLUDE_FILES = YES SHOW_GROUPED_MEMB_INC = NO FORCE_LOCAL_INCLUDES = YES INLINE_INFO = YES SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO SORT_MEMBERS_CTORS_1ST = YES SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO STRICT_PROTO_MATCHING = NO GENERATE_TODOLIST = NO GENERATE_TESTLIST = NO GENERATE_BUGLIST = NO GENERATE_DEPRECATEDLIST= NO ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES SHOW_FILES = YES SHOW_NAMESPACES = YES FILE_VERSION_FILTER = LAYOUT_FILE = CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- QUIET = @DOXYGEN_QUIET@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = YES WARN_AS_ERROR = NO WARN_FORMAT = "---> WARNING! $file:$line: $text" WARN_LOGFILE = doc/warnings.log #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- INPUT = @PROJECT_SOURCE_DIR@/README.md \ @BUILDTREE_DIRS@ \ @SOURCE_FILES@ INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.h \ *.hh \ *.hpp \ *.c \ *.cc \ *.cxx \ *.cpp \ *.c++ \ *.icc \ *.tcc \ *.py RECURSIVE = YES EXCLUDE = @EXCLUDE_LIST@ EXCLUDE_SYMLINKS = YES EXCLUDE_PATTERNS = */.git/* EXCLUDE_SYMBOLS = EXAMPLE_PATH = @PROJECT_SOURCE_DIR@/examples EXAMPLE_PATTERNS = *.hh \ *.hpp \ *.cc \ *.cpp \ *.py \ *.txt EXAMPLE_RECURSIVE = YES IMAGE_PATH = INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = @PROJECT_SOURCE_DIR@/README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- SOURCE_BROWSER = YES INLINE_SOURCES = NO STRIP_CODE_COMMENTS = NO REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES REFERENCES_LINK_SOURCE = YES SOURCE_TOOLTIPS = YES USE_HTAGS = NO VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML = @GENERATE_DOXYGEN_HTML_DOC@ HTML_OUTPUT = html HTML_FILE_EXTENSION = .html HTML_HEADER = HTML_FOOTER = HTML_STYLESHEET = HTML_EXTRA_STYLESHEET = HTML_EXTRA_FILES = HTML_COLORSTYLE_HUE = 220 HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 HTML_TIMESTAMP = YES HTML_DYNAMIC_SECTIONS = YES HTML_INDEX_NUM_ENTRIES = 1000 GENERATE_DOCSET = @GENERATE_DOCSET_IF_XCODE@ DOCSET_FEEDNAME = "Doxygen generated docs" DOCSET_BUNDLE_ID = org.doxygen.@PROJECT_NAME@ DOCSET_PUBLISHER_ID = org.doxygen.jrmadsen DOCSET_PUBLISHER_NAME = "Jonathan R. Madsen" GENERATE_HTMLHELP = NO CHM_FILE = HHC_LOCATION = GENERATE_CHI = NO CHM_INDEX_ENCODING = BINARY_TOC = NO TOC_EXPAND = YES GENERATE_QHP = NO QCH_FILE = QHP_NAMESPACE = QHP_VIRTUAL_FOLDER = doc QHP_CUST_FILTER_NAME = QHP_CUST_FILTER_ATTRS = QHP_SECT_FILTER_ATTRS = QHG_LOCATION = GENERATE_ECLIPSEHELP = NO ECLIPSE_DOC_ID = org.doxygen.@PROJECT_NAME@ DISABLE_INDEX = NO GENERATE_TREEVIEW = YES ENUM_VALUES_PER_LINE = 1 TREEVIEW_WIDTH = 300 EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 12 FORMULA_TRANSPARENT = YES USE_MATHJAX = NO MATHJAX_FORMAT = HTML-CSS MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest MATHJAX_EXTENSIONS = MATHJAX_CODEFILE = SEARCHENGINE = YES SERVER_BASED_SEARCH = NO EXTERNAL_SEARCH = NO SEARCHENGINE_URL = SEARCHDATA_FILE = searchdata.xml EXTERNAL_SEARCH_ID = EXTRA_SEARCH_MAPPINGS = #--------------------------------------------------------------------------- # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- GENERATE_LATEX = @GENERATE_DOXYGEN_LATEX_DOC@ LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex COMPACT_LATEX = NO PAPER_TYPE = a4wide EXTRA_PACKAGES = float LATEX_HEADER = LATEX_FOOTER = LATEX_EXTRA_STYLESHEET = LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES USE_PDFLATEX = YES LATEX_BATCHMODE = YES LATEX_HIDE_INDICES = NO LATEX_SOURCE_CODE = YES LATEX_BIB_STYLE = plain LATEX_TIMESTAMP = NO #--------------------------------------------------------------------------- # Configuration options related to the RTF output #--------------------------------------------------------------------------- GENERATE_RTF = @GENERATE_DOXYGEN_RTF_DOC@ RTF_OUTPUT = rtf COMPACT_RTF = NO RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = RTF_SOURCE_CODE = NO #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- GENERATE_MAN = @GENERATE_DOXYGEN_MAN_DOC@ MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_SUBDIR = MAN_LINKS = YES #--------------------------------------------------------------------------- # Configuration options related to the XML output #--------------------------------------------------------------------------- GENERATE_XML = @GENERATE_DOXYGEN_XML_DOC@ XML_OUTPUT = xml XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook DOCBOOK_PROGRAMLISTING = NO #--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # Configuration options related to the Perl module output #--------------------------------------------------------------------------- GENERATE_PERLMOD = NO PERLMOD_LATEX = NO PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- ENABLE_PREPROCESSING = YES MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = PREDEFINED = EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration options related to external references #--------------------------------------------------------------------------- TAGFILES = GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- CLASS_DIAGRAMS = YES MSCGEN_PATH = DIA_PATH = HIDE_UNDOC_RELATIONS = NO HAVE_DOT = @DOXYGEN_DOT_FOUND@ DOT_NUM_THREADS = 0 DOT_FONTNAME = Helvetica DOT_FONTSIZE = 12 DOT_FONTPATH = CLASS_GRAPH = @GENERATE_DOXYGEN_CLASS_GRAPH@ COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES UML_LOOK = YES UML_LIMIT_NUM_FIELDS = 10 TEMPLATE_RELATIONS = YES INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES CALL_GRAPH = @GENERATE_DOXYGEN_CALL_GRAPH@ CALLER_GRAPH = @GENERATE_DOXYGEN_CALLER_GRAPH@ GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES DOT_IMAGE_FORMAT = svg INTERACTIVE_SVG = YES DOT_PATH = @GRAPHVIZ_DOT_PATH@ DOTFILE_DIRS = MSCFILE_DIRS = DIAFILE_DIRS = PLANTUML_JAR_PATH = PLANTUML_CFG_FILE = PLANTUML_INCLUDE_PATH = DOT_GRAPH_MAX_NODES = 10 MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = YES GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- # VERBOSE output #--------------------------------------------------------------------------- # Doxyfile 1.8.13 # 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 = "My Project" # 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 = # 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 = # 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 = # 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 = # 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 = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. # TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. # OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. # OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. # OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. # OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. # EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. # MARKDOWN_SUPPORT = YES # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 0. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. # TOC_INCLUDE_HEADINGS = 0 # 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 = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. # TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. # LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. # EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. # EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. # EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. # EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. # EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. 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 = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. # SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. # SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. # SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. # STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. # GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. # GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. # GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. # GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. # ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. # MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. # SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. # SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. # SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. # FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. # LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. # CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. # QUIET = 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 = # 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, *.f95, *.f03, *.f08, # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. # 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 \ # *.pyw \ # *.f90 \ # *.f95 \ # *.f03 \ # *.f08 \ # *.f \ # *.for \ # *.tcl \ # *.vhd \ # *.vhdl \ # *.ucf \ # *.qsf # 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 = # 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 = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. # INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. # STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. # REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. # REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. # REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. # SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. # USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. # VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # 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 = # 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 = $relpath^/images/timing.png $relpath^/images/memory.png # 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 = NO # 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 = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. # ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. # TREEVIEW_WIDTH = 250 # 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 # , /