diff -Nru jasper-2.0.33/build/build jasper-3.0.4/build/build --- jasper-2.0.33/build/build 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/build/build 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,585 @@ +#! /usr/bin/env bash + +panic() +{ + echo "ERROR: $@" + exit 1 +} + +program_dir=$(dirname "$0") || exit 1 +jas_realpath="$program_dir/jas_realpath" +abs_program_dir=$("$jas_realpath" "$program_dir") || panic + +usage() +{ + if [ "$#" -gt 0 ]; then + echo "bad usage: $@" + fi + cat <<- EOF + Options + ======= + + --help + Print help information and exit. + + --build-dir \$dir + Set the build directory to \$dir. + --install-dir \$dir + Set the install directory to \$dir. + + --configure-only + Perform configuration phase of CMake only. + --install + Perform installation. + --test + Perform testing. + + --multithread + Enable multithreading support. + --no-multithread + Disable multithreading support. + + --shared + Enable the generation of shared (instead of static) libraries. + --static + Enable the generation of static (instead of shared) libraries. + + --use-jas-init + --no-use-jas-init + + --release + Set the build type to release. + --debug + Set the build type to debug. + --relwithdebinfo + Set the build type to release with debug information. + + --documentation + Enable the building of the documentation. + --no-documentation + Disable the building of the documentation. + + --asan + Enable ASan. + --lsan + Enable LSan. + --tsan + Enable TSan. + --ubsan + Enable UBSan. + --msan + Enable MSan. + + Examples + ======== + + $0 --mode debug + EOF + exit 2 +} + +enable=1 +enable_install=0 +build_type=release +enable_test=0 +verbose=0 +enable_asan=0 +enable_lsan=0 +enable_ubsan=0 +enable_msan=0 +enable_tsan=0 +enable_shared=1 +sde_top_dir= +configure_only=0 +enable_doc=0 +use_pthread=0 +enable_multithread=1 +build_dir= +install_dir= +crostini=0 +clean_build_dir=0 +clean_install_dir=0 +debug_level=0 +os= +use_jas_init=0 +enable_strict=1 +cmake_generator= +enable_32bit=0 +enable_cxx=0 + +while [ $# -gt 0 ]; do + option="$1" + case "$option" in + --debug-level) + shift 1 + [ $# -gt 0 ] || usage + debug_level="$1" + shift 1 + ;; + --make) + shift 1 + cmake_generator="Unix Makefiles" + ;; + --ninja) + shift 1 + cmake_generator="Ninja" + ;; + --strict) + shift 1 + enable_strict=1 + ;; + --no-strict) + shift 1 + enable_strict=0 + ;; + --use-jas-init) + shift 1 + use_jas_init=1 + ;; + --no-use-jas-init) + shift 1 + use_jas_init=0 + ;; + --clean-build-dir) + shift 1 + clean_build_dir=1 + ;; + --clean-install-dir) + shift 1 + clean_install_dir=1 + ;; + --crostini) + shift 1 + crostini=1 + ;; + -q|--quiet) + shift 1 + if [ "$verbose" -gt 0 ]; then + verbose=$((verbose - 1)) + fi + ;; + -v|--verbose) + shift 1 + verbose=$((verbose + 1)) + ;; + --configure-only) + shift 1 + configure_only=1 + ;; + --install) + shift 1 + enable_install=1 + ;; + --test) + shift 1 + enable_test=1 + ;; + --no-test) + shift 1 + enable_test=0 + ;; + --documentation) + shift 1 + enable_doc=1 + ;; + --no-documentation) + shift 1 + enable_doc=0 + ;; + --shared) + shift 1 + enable_shared=1 + ;; + --asan) + shift 1 + enable_asan=1 + ;; + --no-asan) + shift 1 + enable_asan=0 + ;; + --lsan) + shift 1 + enable_lsan=1 + ;; + --no-lsan) + shift 1 + enable_lsan=0 + ;; + --msan) + shift 1 + enable_msan=1 + ;; + --no-msan) + shift 1 + enable_msan=0 + ;; + --ubsan) + shift 1 + enable_ubsan=1 + ;; + --no-ubsan) + shift 1 + enable_ubsan=0 + ;; + --tsan) + shift 1 + enable_tsan=1 + ;; + --no-tsan) + shift 1 + enable_tsan=0 + ;; + --release) + shift 1 + build_type=release + ;; + --relwithdebinfo) + shift 1 + build_type=relwithdebinfo + ;; + --debug) + shift 1 + build_type=debug + ;; + --prefer-pthread) + shift 1 + use_pthread=1 + ;; + --no-prefer-pthread) + shift 1 + use_pthread=0 + ;; + --print-only) + shift 1 + enable=0 + ;; + --shared) + shift 1 + enable_shared=1 + ;; + --static) + shift 1 + enable_shared=0 + ;; + --no-multithread) + shift 1 + enable_multithread=0 + ;; + --multithread) + shift 1 + enable_multithread=1 + ;; + --build-dir) + shift 1 + [ $# -gt 0 ] || usage + build_dir="$1" + shift 1 + ;; + --install-dir) + shift 1 + [ $# -gt 0 ] || usage + install_dir="$1" + shift 1 + ;; + --mode) + shift 1 + [ $# -gt 0 ] || usage + case "$1" in + debug) + enable_asan=1 + enable_ubsan=1 + enable_lsan=1 + enable_doc=0 + use_pthread=0 + enable_shared=0 + enable_multithreading=1 + build_type=debug + shift 1 + ;; + *) + shift 1;; + esac + ;; + --32bit) + shift 1 + enable_32bit=1 + ;; + --cxx) + shift 1 + enable_cxx=1 + ;; + --no-cxx) + shift 1 + enable_cxx=0 + ;; + --help) + usage + ;; + --) + shift 1 + break + ;; + --*|-*) + usage "invalid option $option" + ;; + *) + break + ;; + esac +done + +program_args=("$@") + +if [ "$debug_level" -ge 1 ]; then + set -xv +fi + +if [ -z "$os" ]; then + if [ -n "$RUNNER_OS" ]; then + case "$RUNNER_OS" in + MacOS|macOS) + os=macos;; + Linux|linux) + os=linux;; + Windows|windows) + os=windows;; + esac + else + os=unknown + fi +fi + +if [ "$crostini" -ne 0 ]; then + enable_tsan=0 +fi + +source_dir="$abs_program_dir/.." + +if [ -z "$build_dir" ]; then + build_dir="$source_dir/tmp_cmake/build" +fi +if [ -z "$install_dir" ]; then + install_dir="$source_dir/tmp_cmake/install" +fi + +echo "operating system: $os" +echo "source directory: $source_dir" +echo "build directory: $build_dir" +echo "install directory: $install_dir" +if [ -n "$CC" ]; then + echo "C compiler $CC" +fi + +if [ -n "$sde_top_dir" ]; then + #sde_gcc="$sde_top_dir/bin/gcc" + sde_setup="$sde_top_dir/bin/sde_make_setup" + eval $("$sde_setup") || panic "setup failed" +fi + +if [ "$clean_build_dir" -ne 0 -a -e "$build_dir" ]; then + echo "Removing $build_dir" + rm -rf "$build_dir" || panic "cannot remove directory $build_dir" +fi +if [ "$clean_install_dir" -ne 0 -a -e "$install_dir" ]; then + echo "Removing $install_dir" + rm -rf "$install_dir" || panic "cannot remove directory $install_dir" +fi + +if [ ! -d "$build_dir" ]; then + mkdir -p "$build_dir" || panic "cannot make directory $build_dir" +fi +if [ ! -d "$install_dir" ]; then + mkdir -p "$install_dir" || panic "cannot make directory $install_dir" +fi + +################################################################################ +# Configure +################################################################################ + +configure_opts=() + +configure_opts+=(-B"$build_dir") +configure_opts+=(-H"$source_dir") + +if [ -n "$cmake_generator" ]; then + configure_opts+=(-G "$cmake_generator") +fi + +#if [ "$os" = windows ]; then +# configure_opts+=(-G "Visual Studio 12 2013 Win64") +#fi + +configure_opts+=("-DCMAKE_INSTALL_PREFIX=$install_dir") + +if [ "$verbose" -ge 1 ]; then + configure_opts+=("-DCMAKE_VERBOSE_MAKEFILE=true") +fi + +case "$build_type" in +debug) + configure_opts+=("-DCMAKE_BUILD_TYPE=Debug");; +release) + configure_opts+=("-DCMAKE_BUILD_TYPE=Release");; +relwithdebinfo) + configure_opts+=("-DCMAKE_BUILD_TYPE=RelWithDebInfo");; +*) + panic "unknown build type $build_type";; +esac + +if [ "$enable_shared" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_SHARED=true") +else + configure_opts+=("-DJAS_ENABLE_SHARED=false") +fi + +if [ "$enable_asan" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_ASAN=true") +fi +if [ "$enable_tsan" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_TSAN=true") +fi +if [ "$enable_lsan" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_LSAN=true") +fi +if [ "$enable_ubsan" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_UBSAN=true") +fi +if [ "$enable_msan" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_MSAN=true") +fi +if [ "$enable_32bit" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_32BIT=true") +fi + +if [ "$enable_cxx" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_CXX=true") +else + configure_opts+=("-DJAS_ENABLE_CXX=false") +fi +configure_opts+=("-DJAS_ENABLE_DANGEROUS_INTERNAL_TESTING_MODE=true") + +if [ "$enable_doc" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_DOC=true") +else + configure_opts+=("-DJAS_ENABLE_DOC=false") +fi + +if [ "$use_jas_init" -ne 0 ]; then + configure_opts+=("-DJAS_USE_JAS_INIT=true") +else + configure_opts+=("-DJAS_USE_JAS_INIT=false") +fi + +if [ "$enable_strict" -ne 0 ]; then + configure_opts+=("-DJAS_STRICT=true") +else + configure_opts+=("-DJAS_STRICT=false") +fi + +if [ "$enable_multithread" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_MULTITHREADING_SUPPORT=true") +else + configure_opts+=("-DJAS_ENABLE_MULTITHREADING_SUPPORT=false") +fi +if [ "$use_pthread" -ne 0 ]; then + configure_opts+=("-DJAS_PREFER_PTHREAD=true") +fi + +configure_opts+=("${program_args[@]}") +command=(cmake "${configure_opts[@]}") +echo "============================================================" +echo "RUNNING: ${command[@]}" +echo "============================================================" +if [ "$enable" -ne 0 ]; then + "${command[@]}" || panic "cmake failed" +fi + +if [ "$configure_only" -ne 0 ]; then + exit +fi + +################################################################################ +# +################################################################################ + +build_opts=() + +if [ "$verbose" -ge 1 ]; then + build_opts+=(--verbose) +fi + +command=(cmake) +command+=(--build "$build_dir") +#command+=(--clean-first) +command+=("${build_opts[@]}") +echo "============================================================" +echo "RUNNING: ${command[@]}" +echo "============================================================" +if [ "$enable" -ne 0 ]; then + "${command[@]}" || \ + panic "cmake build failed" +fi + +################################################################################ +# +################################################################################ + +install_opts=() + +if [ "$verbose" -ge 1 ]; then + install_opts+=(--verbose) +fi + +if [ "$enable_install" -ne 0 ]; then + command=(cmake) + command+=(--build "$build_dir") + command+=(--target install) + command+=("${install_opts[@]}") + echo "============================================================" + echo "RUNNING: ${command[@]}" + echo "============================================================" + if [ "$enable" -ne 0 ]; then + "${command[@]}" || \ + panic "cmake install failed" + fi +fi + +################################################################################ +# +################################################################################ + +test_opts=() + +if [ "$verbose" -ge 2 ]; then + test_opts+=(--verbose) +fi + +test_opts+=(--output-on-failure) + +command=() +command+=(env) +if [ "$debug_level" -ge 2 ]; then + command+=(JAS_DEBUG_LEVEL="$debug_level") +fi +if [ "$os" = windows ]; then + # NOTE: + # Windows searches for DLLs in the directories specified by the PATH + # environment variable (and possibly a few system directories as well). + # So, the following line ensures that the directory containing the + # JasPer DLL will be found. + command+=(PATH="$PATH:$build_dir/src/libjasper") + echo "**********" + ls -al $build_dir/src/libjasper + echo "**********" +fi +command+=(ctest "${test_opts[@]}") +if [ "$enable_test" -ne 0 ]; then + echo "============================================================" + echo "Testing" + echo "RUNNING: ${command[@]}" + echo "============================================================" + if [ "$enable" -ne 0 ]; then + (cd "$build_dir" && "${command[@]}") || panic "ctest failed" + fi +fi diff -Nru jasper-2.0.33/build/build_all jasper-3.0.4/build/build_all --- jasper-2.0.33/build/build_all 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/build/build_all 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,467 @@ +#! /usr/bin/env bash + +panic() +{ + echo "ERROR: $@" + exit 1 +} + +program_dir=$(dirname "$0") || exit 1 +jas_realpath="$program_dir/jas_realpath" +abs_program_dir=$("$jas_realpath" "$program_dir") || panic +build_program="$program_dir/build" + +list_directory() +{ + local dir="$1" + (cd "$dir" && find . -type f -printf "%M %010s %P\n" | sort -k3) +} + +set_build_config() +{ + [ $# -eq 1 ] || return 1 + + build_name="" + base_dir="" + command=() + + local id="$1" + case "$id" in + + ############################################################ + # Debug Builds + ############################################################ + + static_debug_mt0|static_debug_mt1) + local multithread + multithread=0 + case "$id" in + *mt1) + multithread=1;; + esac + build_name="static debug ASan+LSan+UBSan mt=$multithread" + base_dir="$build_dir/test_static_debug-$multithread" + command=("$build_program") + command+=("${global_options[@]}") + command+=(--build-dir "$base_dir/build") + command+=(--install-dir "$base_dir/install") + command+=(--static) + command+=(--debug) + command+=(--ubsan) + command+=("${asan_option[@]}") + command+=("${lsan_option[@]}") + command+=("${test_option[@]}") + command+=(--install) + command+=(--no-documentation) + command+=(--no-use-jas-init) + if [ "$multithread" -ne 0 ]; then + command+=(--multithread) + else + command+=(--no-multithread) + fi + ;; + + static_debug_ji_mt0|static_debug_ji_mt1) + local multithread + multithread=0 + case "$id" in + *mt1) + multithread=1;; + esac + build_name="static debug jas_init ASan+LSan+UBSan mt=$multithread" + base_dir="$build_dir/test_static_debug-ji-$multithread" + command=("$build_program") + command+=("${global_options[@]}") + command+=(--build-dir "$base_dir/build") + command+=(--install-dir "$base_dir/install") + command+=(--static) + command+=(--debug) + command+=(--ubsan) + command+=("${asan_option[@]}") + command+=("${lsan_option[@]}") + command+=("${test_option[@]}") + command+=(--install) + command+=(--no-documentation) + command+=(--use-jas-init) + if [ "$multithread" -ne 0 ]; then + command+=(--multithread) + else + command+=(--no-multithread) + fi + ;; + + tsan) + build_name="multithread static debug TSan+UBSan" + base_dir="$build_dir/test_static_debug_tsan" + command=("$build_program") + command+=("${global_options[@]}") + command+=(--build-dir "$base_dir/build") + command+=(--install-dir "$base_dir/install") + command+=(--prefer-pthread) + command+=(--static) + command+=(--debug) + command+=(--ubsan) + command+=(--tsan) + command+=("${test_option[@]}") + command+=(--install) + command+=(--no-documentation) + command+=(--multithread) + command+=(--no-use-jas-init) + ;; + + ############################################################ + # Release Builds + ############################################################ + + # release without run-time tests + static_release|shared_release) + local shared + if [ "$id" = shared_release ]; then + shared=1 + else + shared=0 + fi + build_name="release shared=$shared" + base_dir="$build_dir/release-$shared" + command=("$build_program") + command+=("${global_options[@]}") + command+=(--build-dir "$base_dir/build") + command+=(--install-dir "$base_dir/install") + command+=(--shared) + command+=(--release) + command+=(--multithread) + command+=(--documentation) + command+=(--no-test) + command+=(--no-cxx) + command+=(--install) + ;; + + static_release_mt0|static_release_mt1) + local multithread + multithread=0 + case "$id" in + *mt1) + multithread=1;; + esac + build_name="static release mt=$multithread" + base_dir="$build_dir/static_release-$multithread" + command=("$build_program") + command+=("${global_options[@]}") + command+=(--build-dir "$base_dir/build") + command+=(--install-dir "$base_dir/install") + command+=(--static) + command+=(--release) + command+=(--documentation) + command+=("${test_option[@]}") + command+=(--install) + if [ "$multithread" -ne 0 ]; then + command+=(--multithread) + else + command+=(--no-multithread) + fi + ;; + + shared_release_mt0|shared_release_mt1) + local multithread + multithread=0 + case "$id" in + *mt1) + multithread=1;; + esac + build_name="shared release mt=$multithread" + base_dir="$build_dir/shared_release-$multithread" + command=("$build_program") + command+=("${global_options[@]}") + command+=(--build-dir "$base_dir/build") + command+=(--install-dir "$base_dir/install") + command+=(--shared) + command+=(--release) + command+=(--documentation) + command+=("${test_option[@]}") + command+=(--install) + command+=(--no-use-jas-init) + if [ "$multithread" -ne 0 ]; then + command+=(--multithread) + else + command+=(--no-multithread) + fi + ;; + + ############################################################ + ############################################################ + + *) + return 1;; + + esac +} + +usage() +{ + echo "bad usage: $@" + cat <<- EOF + Options + ======= + + -X + Disable tests. + -s + Enable strict mode. + -w + Disable strict mode. + -v + Enable verbose mode. + -b \$dir + Set the build directory to \$dir. + EOF + exit 2 +} + +verbose=1 +build_dir= +crostini=0 +enable=1 +debug_level=0 +strict=1 +command_file= +enable_test=1 +requested_tests=() +hard_fail=0 + +while getopts hvb:cnd:swC:Xqt:F option; do + case "$option" in + n) + enable=0;; + F) + hard_fail=1;; + c) + crostini=1;; + C) + command_file="$OPTARG";; + t) + requested_tests+=("$OPTARG");; + b) + build_dir="$OPTARG";; + d) + debug_level="$OPTARG";; + v) + verbose=$((verbose + 1));; + q) + if [ "$verbose" -gt 0 ]; then + verbose=$((verbose - 1)) + fi + ;; + w) + strict=0;; + s) + strict=1;; + X) + enable_test=0;; + h) + usage;; + *) + usage "invalid option $option";; + esac +done +shift $((OPTIND - 1)) + +if [ $# -ne 0 ]; then + usage "unexpected command-line arguments" +fi + +if [ "$debug_level" -ge 1 -a "$verbose" -eq 0 ]; then + verbose=1 +fi + +if [ -z "$build_dir" ]; then + build_dir="$abs_program_dir/../tmp_cmake" +fi + +if [ -n "$command_file" ]; then + source "$command_file" || panic "source failed" +fi + +os=unknown +if [ -n "$RUNNER_OS" ]; then + case "$RUNNER_OS" in + MacOS|macOS) + os=macos;; + Linux|linux) + os=linux;; + Windows|windows) + os=windows;; + esac +fi + +# TODO: Fix this later. +ubuntu_clang_hack=0 +# If invoked by GitHub Actions CI... +if [ -n "$RUNNER_OS" ]; then + if [ "$os" = linux ]; then + # Assume that the OS being Linux means Ubuntu. + case "$CC" in + clang*) + ubuntu_clang_hack=1 + ;; + esac + fi +fi + +################################################################################ + +cat <<- EOF +================================================================================ +Operating System: $os +================================================================================ +EOF + +global_options=() + +for ((i=0; i < "$verbose"; ++i)); do + global_options+=(--verbose) +done + +if [ "$strict" -ge 1 ]; then + global_options+=(--strict) +else + global_options+=(--no-strict) +fi + +if [ "$crostini" -ne 0 ]; then + global_options+=(--crostini) +fi + +global_options+=(--cxx) + +global_options+=(--debug-level "$debug_level") + +lsan_option=(--lsan) +asan_option=(--asan) +case "$os" in +macos) + lsan_option=() + ;; +windows) + asan_option=() + ;; +esac + +if [ "$enable_test" -ne 0 ]; then + test_option=(--test) +else + test_option=(--no-test) +fi + +################################################################################ + +cat <<- EOF +================================================================================ +File System Mount Information +================================================================================ +EOF +mount || panic "mount failed" + +################################################################################ + +if [ "${#requested_tests[@]}" -gt 0 ]; then + tests=("${requested_tests[@]}") +fi + +if [ "${#tests[@]}" -eq 0 ]; then + + tests=() + + # debug builds + if [ "$ubuntu_clang_hack" -eq 0 ]; then + tests+=(static_debug_mt0) + tests+=(static_debug_mt1) + tests+=(static_debug_ji_mt0) + tests+=(static_debug_ji_mt1) + tests+=(tsan) + fi + + # release builds + tests+=(shared_release_mt0) + tests+=(shared_release_mt1) + if [ "$ubuntu_clang_hack" -eq 0 ]; then + tests+=(static_release_mt0) + tests+=(static_release_mt1) + fi + tests+=(static_release) + tests+=(shared_release) + +fi + +failed_tests=() +passed_tests=() +attempted_tests=() + +for id in "${tests[@]}"; do + + attempted_tests+=("$id") + + set_build_config "$id" + if [ $? -ne 0 ]; then + failed_tests+=("$id") + if [ "$hard_fail" -ne 0 ]; then + break + fi + continue + fi + + cat <<- EOF + ================================================================================ + BUILD (${#attempted_tests[@]}/${#tests[@]}): ${build_name} + ================================================================================ + EOF + + echo "RUNNING: ${command[@]}" + if [ "$enable" -ne 0 ]; then + "${command[@]}" + if [ $? -ne 0 ]; then + failed_tests+=("$id") + if [ "$hard_fail" -ne 0 ]; then + break + fi + continue + fi + echo "build directory:" + list_directory "$base_dir/build" || panic + echo "install directory:" + list_directory "$base_dir/install" || panic + passed_tests+=("$id") + fi + +done + +cat <<- EOF +================================================================================ +SUMMARY +================================================================================ +EOF + +echo "Total number of tests: ${#tests[@]}" + +echo "Number of attempted tests: ${#attempted_tests[@]}" + +echo "Number of passed tests: ${#passed_tests[@]}" +if [ "${#passed_tests[@]}" -gt 0 ]; then + echo "The following tests passed:" + for test in "${passed_tests[@]}"; do + echo " $test" + done +fi + +echo "Number of failed tests: ${#failed_tests[@]}" +if [ "${#failed_tests[@]}" -gt 0 ]; then + echo "ERROR: One or more tests failed." + echo "The following tests failed:" + for test in "${failed_tests[@]}"; do + echo " $test" + done + exit 1 +fi + +exit 0 + +################################################################################ diff -Nru jasper-2.0.33/build/cmake/modules/EnableAssertions.cmake jasper-3.0.4/build/cmake/modules/EnableAssertions.cmake --- jasper-2.0.33/build/cmake/modules/EnableAssertions.cmake 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/build/cmake/modules/EnableAssertions.cmake 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,14 @@ +if(CMAKE_C_COMPILER_ID STREQUAL "Clang" OR + CMAKE_C_COMPILER_ID STREQUAL "GNU" OR + CMAKE_C_COMPILER_ID STREQUAL "MSVC") + foreach(flags_var_to_scrub + CMAKE_CXX_FLAGS_RELEASE + CMAKE_CXX_FLAGS_RELWITHDEBINFO + CMAKE_CXX_FLAGS_MINSIZEREL + CMAKE_C_FLAGS_RELEASE + CMAKE_C_FLAGS_RELWITHDEBINFO + CMAKE_C_FLAGS_MINSIZEREL) + string (REGEX REPLACE "(^| )[/-]D *NDEBUG($| )" " " + "${flags_var_to_scrub}" "${${flags_var_to_scrub}}") + endforeach() +endif() diff -Nru jasper-2.0.33/build/cmake/modules/InSourceBuild.cmake jasper-3.0.4/build/cmake/modules/InSourceBuild.cmake --- jasper-2.0.33/build/cmake/modules/InSourceBuild.cmake 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/build/cmake/modules/InSourceBuild.cmake 2022-06-03 04:10:20.000000000 +0000 @@ -1,9 +1,9 @@ -option(ALLOW_IN_SOURCE_BUILD "Allow an in-source build" false) +option(ALLOW_IN_SOURCE_BUILD "Allow an in-source build" OFF) function(prevent_in_source_build) get_filename_component(source_dir "${CMAKE_SOURCE_DIR}" REALPATH) get_filename_component(binary_dir "${CMAKE_BINARY_DIR}" REALPATH) - if("${source_dir}" STREQUAL "${binary_dir}") + if(source_dir STREQUAL binary_dir) message(FATAL_ERROR "The use of an in-source build is not recommended. " "For this reason, the use of in-source build is disabled by default. " @@ -12,6 +12,6 @@ endif() endfunction() -if (NOT ALLOW_IN_SOURCE_BUILD) +if(NOT ALLOW_IN_SOURCE_BUILD) prevent_in_source_build() endif() diff -Nru jasper-2.0.33/build/cmake/modules/JasCheckType.cmake jasper-3.0.4/build/cmake/modules/JasCheckType.cmake --- jasper-2.0.33/build/cmake/modules/JasCheckType.cmake 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/build/cmake/modules/JasCheckType.cmake 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,42 @@ +function(jas_check_type name valid_out) + + set(verbose FALSE) + #set(verbose TRUE) + + set(single_arg_options "SIZE") + cmake_parse_arguments(PARSE_ARGV 2 parsed "" "${single_arg_options}" "") + + if(verbose) + message("name: ${name}") + message("size: ${result}") + message("parsed_SIZE: ${parsed_SIZE}") + endif() + + # Note: + # The check_type_size function/macro places its results in cache variables. + # So, we need to use a name that is unlikely to collide with another name. + # Also, we need to clear the cache so that we do not obtain a cached + # result from a previous invocation. + unset(jas_check_type_name_result CACHE) + unset(HAVE_jas_check_type_name_result CACHE) + check_type_size("${name}" jas_check_type_name_result) + + if(verbose) + message("valid: ${HAVE_jas_check_type_name_result}") + message("size: ${jas_check_type_name_result}") + endif() + + if(HAVE_jas_check_type_name_result) + set(${valid} TRUE) + else() + set(${valid} FALSE) + endif() + + set(${valid_out} ${valid} CACHE INTERNAL "is_valid ${name}") + + if (DEFINED parsed_SIZE) + set(${parsed_SIZE} ${jas_check_type_name_result} CACHE INTERNAL + "sizeof ${name}") + endif() + +endfunction() diff -Nru jasper-2.0.33/build/cmake/modules/JasGetIncludes.cmake jasper-3.0.4/build/cmake/modules/JasGetIncludes.cmake --- jasper-2.0.33/build/cmake/modules/JasGetIncludes.cmake 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/build/cmake/modules/JasGetIncludes.cmake 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,17 @@ +function(jas_get_includes_from_targets) + set(var_name ${ARGV0}) + set(target_list ${ARGV}) + list(REMOVE_AT target_list 0) + set(include_dirs) + foreach(t ${target_list}) + if (TARGET ${t}) + message("target: ${t}") + get_target_property(dirs ${t} INTERFACE_INCLUDE_DIRECTORIES) + if (dirs) + message("${t}: adding include directory ${dirs}") + set(include_dirs ${include_dirs} ${dirs}) + endif() + endif() + endforeach() + set(${var_name} ${include_dirs} PARENT_SCOPE) +endfunction() diff -Nru jasper-2.0.33/build/cmake/modules/JasGetStdcVersion.cmake jasper-3.0.4/build/cmake/modules/JasGetStdcVersion.cmake --- jasper-2.0.33/build/cmake/modules/JasGetStdcVersion.cmake 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/build/cmake/modules/JasGetStdcVersion.cmake 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,42 @@ +function(jas_get_stdc_version status_out stdc_version_out) + + #set(verbose TRUE) + set(verbose FALSE) + + set(source_dir ${CMAKE_SOURCE_DIR}/build/cmake/src) + set(bin_dir ${CMAKE_BINARY_DIR}/build/cmake/src) + + try_run(print_stdc_run_status print_stdc_compile_status + ${bin_dir} + ${source_dir}/print_stdc.c + COMPILE_OUTPUT_VARIABLE print_stdc_compile_output + RUN_OUTPUT_VARIABLE stdc_version + ) + + # For testing. + #set(stdc_version "199901L") # C99 + #set(stdc_version "201112L") # C11 + #set(stdc_version "201710L") # C17 + + if(verbose) + message("print_stdc_run_status ${print_stdc_run_status}") + message("print_stdc_compile_status ${print_stdc_compile_status}") + message("stdc_version ${stdc_version}") + endif() + + if(print_stdc_compile_status AND NOT print_stdc_run_status) + set(status TRUE) + else() + set(status FALSE) + set(stdc_version "") + endif() + + if(verbose) + message("status ${status}") + message("stdc_version ${stdc_version}") + endif() + + set(${status_out} "${status}" PARENT_SCOPE) + set(${stdc_version_out} "${stdc_version}" PARENT_SCOPE) + +endfunction() diff -Nru jasper-2.0.33/build/cmake/modules/JasOpenGL.cmake jasper-3.0.4/build/cmake/modules/JasOpenGL.cmake --- jasper-2.0.33/build/cmake/modules/JasOpenGL.cmake 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/build/cmake/modules/JasOpenGL.cmake 1970-01-01 00:00:00.000000000 +0000 @@ -1,54 +0,0 @@ -################################################################################ -# Check for the OpenGL and GLUT libraries. -################################################################################ - -if (JAS_ENABLE_OPENGL) - set(OpenGL_GL_PREFERENCE GLVND) - find_package(OpenGL ${JAS_REQUIRED}) - message("OpenGL library found: ${OPENGL_FOUND}") -else() - set(OPENGL_FOUND false) -endif() -if (JAS_ENABLE_OPENGL AND OPENGL_FOUND) - set(JAS_HAVE_OPENGL 0) - message("OpenGL include directory: ${OPENGL_INCLUDE_DIR}") - message("OpenGL libraries: ${OPENGL_LIBRARIES}") - find_package(GLUT ${JAS_REQUIRED}) - message("GLUT library found: ${GLUT_FOUND}") - if (GLUT_FOUND) - message("GLUT include directory: ${GLUT_INCLUDE_DIR}") - message("GLUT libraries: ${GLUT_LIBRARIES}") - set(CMAKE_REQUIRED_INCLUDES ${GLUT_INCLUDE_DIR}) - check_include_files(GL/glut.h JAS_HAVE_GL_GLUT_H) - check_include_files(glut.h JAS_HAVE_GLUT_H) - if (JAS_HAVE_GL_GLUT_H OR JAS_HAVE_GLUT_H) - set(JAS_HAVE_OPENGL 1) - include_directories(${GLUT_INCLUDE_DIR} ${OPENGL_INCLUDE_DIR}) - else() - message(WARNING "The header files GL/glut.h and glut.h both appear to be missing.") - message(WARNING "Disabling OpenGL.") - endif() - endif() - # On some systems (e.g., Fedora 21), there is a bug in the cmake code - # that detects GLUT libraries. The following ugliness is a workaround for - # this problem. - if (NOT GLUT_Xmu_LIBRARY OR NOT GLUT_Xmi_LIBRARY) - if (NOT GLUT_Xmu_LIBRARY) - set(GLUT_Xmu_LIBRARY "") - message(WARNING "Clearing bogus value for GLUT_Xmu_LIBRARY.") - message(WARNING "Your version of CMake may be buggy.") - endif() - if (NOT GLUT_Xmi_LIBRARY) - set(GLUT_Xmi_LIBRARY "") - message(WARNING "Clearing bogus value for GLUT_Xmi_LIBRARY.") - message(WARNING "Your version of CMake may be buggy.") - endif() - set(GLUT_LIBRARIES "${GLUT_glut_LIBRARY}") - endif() -else() - set(JAS_HAVE_OPENGL 0) - set(OPENGL_INCLUDE_DIR "") - set(OPENGL_LIBRARIES "") - set(GLUT_INCLUDE_DIR "") - set(GLUT_LIBRARIES "") -endif() diff -Nru jasper-2.0.33/build/cmake/modules/Sanitizers.cmake jasper-3.0.4/build/cmake/modules/Sanitizers.cmake --- jasper-2.0.33/build/cmake/modules/Sanitizers.cmake 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/build/cmake/modules/Sanitizers.cmake 2022-06-03 04:10:20.000000000 +0000 @@ -1,41 +1,90 @@ -option(JAS_ENABLE_ASAN "Enable Address Sanitizer" false) -option(JAS_ENABLE_USAN "Enable Undefined-Behavior Sanitizer" false) -option(JAS_ENABLE_LSAN "Enable Leak Sanitizer" false) -option(JAS_ENABLE_MSAN "Enable Memory Sanitizer" false) -option(JAS_ENABLE_FUZZER "Enable libFuzzer" false) - -macro(jas_enable_sanitizer name) - if ("${name}" MATCHES "asan") - set(SANITIZER_COMPILE_FLAGS "-fsanitize=address") - set(SANITIZER_LINKER_FLAGS "-fsanitize=address") - elseif ("${name}" MATCHES "usan") - set(SANITIZER_COMPILE_FLAGS "-fsanitize=undefined") - set(SANITIZER_LINKER_FLAGS "-fsanitize=undefined") - elseif ("${name}" MATCHES "leak") - set(SANITIZER_COMPILE_FLAGS "-fsanitize=leak") - set(SANITIZER_LINKER_FLAGS "-fsanitize=leak") - elseif ("${name}" MATCHES "memory") - set(SANITIZER_COMPILE_FLAGS "-fsanitize=memory") - set(SANITIZER_LINKER_FLAGS "-fsanitize=memory") +option(JAS_ENABLE_ASAN "Enable Address Sanitizer" OFF) +option(JAS_ENABLE_UBSAN "Enable Undefined-Behavior Sanitizer" OFF) +option(JAS_ENABLE_LSAN "Enable Leak Sanitizer" OFF) +option(JAS_ENABLE_MSAN "Enable Memory Sanitizer" OFF) +option(JAS_ENABLE_TSAN "Enable Thread Sanitizer" OFF) + +# FIXME - This does not work. +#check_c_compiler_flag("-fsanitize=address" JAS_HAVE_FSANITIZE_ADDRESS) +set(JAS_HAVE_FSANITIZE_ADDRESS 1) + +check_c_compiler_flag("-fsanitize=leak" JAS_HAVE_FSANITIZE_LEAK) + +# FIXME - This does not work. +#check_c_compiler_flag("-fsanitize=memory" JAS_HAVE_FSANITIZE_MEMORY) +set(JAS_HAVE_FSANITIZE_MEMORY 1) + +# FIXME - This does not work. +#check_c_compiler_flag("-fsanitize=thread" JAS_HAVE_FSANITIZE_THREAD) +set(JAS_HAVE_FSANITIZE_THREAD 1) + +check_c_compiler_flag("-fsanitize=undefined" JAS_HAVE_FSANITIZE_UNDEFINED) + +check_c_compiler_flag("/fsanitize=address" JAS_HAVE_MSVC_FSANITIZE_ADDRESS) + +if(JAS_ENABLE_MSAN) + if(CMAKE_C_COMPILER_ID STREQUAL "Clang" OR + CMAKE_C_COMPILER_ID STREQUAL GNU) + if(JAS_HAVE_FSANITIZE_MEMORY) + message("Enabling Memory Sanitizer") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=memory") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=memory") + set(CMAKE_LD_FLAGS "${CMAKE_LD_FLAGS} -fsanitize=memory") + endif() endif() - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${SANITIZER_COMPILE_FLAGS}") - set(CMAKE_LD_FLAGS "${CMAKE_LD_FLAGS} ${SANITIZER_LINKER_FLAGS}") -endmacro() - -if (JAS_ENABLE_ASAN) - message("Enabling Address Sanitizer") - jas_enable_sanitizer("asan") endif() -if (JAS_ENABLE_USAN) - message("Enabling Undefined-Behavior Sanitizer") - jas_enable_sanitizer("usan") + +if(JAS_ENABLE_ASAN) + if(CMAKE_C_COMPILER_ID STREQUAL "Clang" OR + CMAKE_C_COMPILER_ID STREQUAL GNU) + if(JAS_HAVE_FSANITIZE_ADDRESS) + message("Enabling Address Sanitizer") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address") + set(CMAKE_LD_FLAGS "${CMAKE_LD_FLAGS} -fsanitize=address") + endif() + elseif(CMAKE_C_COMPILER_ID STREQUAL "MSVC") + if(JAS_HAVE_MSVC_FSANITIZE_ADDRESS) + message("Enabling Address Sanitizer") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /fsanitize=address") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /fsanitize=address") + set(CMAKE_LD_FLAGS "${CMAKE_LD_FLAGS} /fsanitize=address") + endif() + endif() endif() -if (JAS_ENABLE_LSAN) - message("Enabling Leak Sanitizer") - jas_enable_sanitizer("lsan") + +if(JAS_ENABLE_LSAN) + if(CMAKE_C_COMPILER_ID STREQUAL "Clang" OR + CMAKE_C_COMPILER_ID STREQUAL GNU) + if(JAS_HAVE_FSANITIZE_LEAK) + message("Enabling Leak Sanitizer") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=leak") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=leak") + set(CMAKE_LD_FLAGS "${CMAKE_LD_FLAGS} -fsanitize=leak") + endif() + endif() endif() -if (JAS_ENABLE_MSAN) - message("Enabling Memory Sanitizer") - jas_enable_sanitizer("msan") + +if(JAS_ENABLE_UBSAN) + if(CMAKE_C_COMPILER_ID STREQUAL "Clang" OR + CMAKE_C_COMPILER_ID STREQUAL GNU) + if(JAS_HAVE_FSANITIZE_UNDEFINED) + message("Enabling Undefined-Behavior Sanitizer") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=undefined") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=undefined") + set(CMAKE_LD_FLAGS "${CMAKE_LD_FLAGS} -fsanitize=undefined") + endif() + endif() endif() +if(JAS_ENABLE_TSAN) + if(CMAKE_C_COMPILER_ID STREQUAL "Clang" OR + CMAKE_C_COMPILER_ID STREQUAL GNU) + if(JAS_HAVE_FSANITIZE_THREAD) + message("Enabling Thread Sanitizer") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=thread") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=thread") + set(CMAKE_LD_FLAGS "${CMAKE_LD_FLAGS} -fsanitize=thread") + endif() + endif() +endif() diff -Nru jasper-2.0.33/build/cmake/src/print_stdc.c jasper-3.0.4/build/cmake/src/print_stdc.c --- jasper-2.0.33/build/cmake/src/print_stdc.c 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/build/cmake/src/print_stdc.c 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,20 @@ +#include +int main(void) +{ + long stdc_version; + +#if defined(__STDC__) && defined(__STDC_VERSION__) + stdc_version = __STDC_VERSION__; +#else + /* + stdc_version = 198900L; + */ + stdc_version = 0L; +#endif + + printf("%ldL", stdc_version); + if (fflush(stdout)) { + return 1; + } + return 0; +} diff -Nru jasper-2.0.33/build/github/deploy_gh_pages jasper-3.0.4/build/github/deploy_gh_pages --- jasper-2.0.33/build/github/deploy_gh_pages 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/build/github/deploy_gh_pages 2022-06-03 04:10:20.000000000 +0000 @@ -21,6 +21,17 @@ echo "$*" } +is_preview_release() +{ + local version="$1" + local pattern='^version-[0-9]+\.[0-9]+\.[0-9]+$' + if [[ "$version" =~ $pattern ]]; then + output="0" + else + output="1" + fi + echo "$output" +} # Print usage information and exit. usage() @@ -70,6 +81,10 @@ # Parse command line. ################################################################################ +program_dir="$(dirname "$0")" || panic +make_main_gh_page="$program_dir/make_main_gh_page" + +latest= branch="gh-pages" in_dir= repo_name= @@ -80,8 +95,12 @@ verbose=1 deploy_mode= -while getopts b:i:r:t:z:fnvqm: opt; do +while getopts b:i:r:t:z:fnvqm:lL opt; do case $opt in + L) + latest=0;; + l) + latest=1;; m) deploy_mode="$OPTARG";; v) @@ -163,10 +182,20 @@ echo "version $version" fi +preview_release="$(is_preview_release "$version")" || \ + panic "cannot determine if release is preview release" + +if [ -z "$latest" ]; then + latest=1 + if [ "$preview_release" -ne 0 ]; then + latest=0 + fi +fi + tmp_dir="$tmp_dir/deploy" git_dir="$tmp_dir/git" -version_dir="$git_dir/$version" +version_dir="$git_dir/releases/$version" github_host="github.com" github_user="git" @@ -273,7 +302,10 @@ git -C "$git_dir" config --local user.email "mdadams@ece.uvic.ca" || \ panic "cannot set Git user email" +################################################################################ # Add the content for the new release. +################################################################################ + if [ -e "$version_dir" ]; then panic "directory already exist for $version" fi @@ -282,37 +314,32 @@ (cd "$in_dir" && tar -cf - .) | (cd "$version_dir" && tar -xf -) || \ panic "tar failed" -# Update the symlink for the latest release. -target="$git_dir/latest" -if [ -h "$target" -o -e "$target" ]; then - rm -f "$target" || panic "rm failed" -fi -ln -s "$version/html" "$target" || \ - panic "ln failed" - -index_html_data=' - - - - -

If you are not redirected in five seconds, click here.

- -' +if [ "$latest" -ne 0 ]; then + # Update the symlink for the latest release. + target="$git_dir/latest" + if [ -h "$target" -o -e "$target" ]; then + rm -f "$target" || panic "rm failed" + fi + ln -s "releases/$version/html" "$target" || \ + panic "ln failed" +fi -# Add a top-level index.html file to redirect to the latest release. +# Add a top-level index.html file. target="$git_dir/index.html" if [ -e "$target" ]; then rm -f "$target" || panic "cannot remove $target" fi -cat > "$target" <<< "$index_html_data" || \ +"$make_main_gh_page" -d "$git_dir" > "$target" || \ panic "cannot create index.html" -#cp "$top_dir/sources/index.html" "$target" || panic "cannot copy $target" if [ "$verbose" -ge 2 ]; then ls -al "$git_dir"/* fi +################################################################################ # Commit and push all of the changes. +################################################################################ + git -C "$git_dir" add . || \ panic "git add failed" git -C "$git_dir" commit -m "Deploying release $version" || \ diff -Nru jasper-2.0.33/build/github/make_main_gh_page jasper-3.0.4/build/github/make_main_gh_page --- jasper-2.0.33/build/github/make_main_gh_page 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/build/github/make_main_gh_page 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,198 @@ +#! /usr/bin/env bash + +# Copyright (c) 2021 Michael David Adams. +# All rights reserved. + +################################################################################ +# Some helper functions. +################################################################################ + +# Terminate with error. +panic() +{ + echo "ERROR: $@" 1>&2 + exit 1 +} + +eecho() +{ + echo "$@" 1>&2 +} + +dir_to_version() +{ + local dir="$1" + case "$dir" in + version-*) + sed -e 's/^version-//' <<< "$dir" + ;; + manual-version-*) + sed -e 's/^manual-version-//' <<< "$dir" + ;; + *) + echo "$dir" + ;; + esac +} + +get_realpath() +{ + if [ $# -ne 1 ]; then + return 1 + fi + local path="$1" + python -c 'import os,sys;print(os.path.realpath(sys.argv[1]))' "$path" +} + +################################################################################ +# Usage information. +################################################################################ + +# Print usage information and exit. +usage() +{ + echo "bad usage: $@" + cat <<- EOF + Options + ======= + + -v + Enable verbose mode. + + -d \$in_dir + Set input directory to \$in_dir. + + Examples + ======== + + $0 -d manual_working_tree_root + EOF + exit 2 +} + +################################################################################ +# Parse command line. +################################################################################ + +verbose=0 +in_dir= + +while getopts d:o:hv option; do + case $option in + d) + in_dir="$OPTARG";; + h|*) + usage;; + esac +done +shift $((OPTIND - 1)) + +if [ ! -d "$in_dir" ]; then + usage "no input directory specified" +fi + +releases_dir="$in_dir/releases" + +official_list=() +other_list=() +for path in $releases_dir/*; do + + if [ -d "$path" ]; then + base=$(basename "$path") || panic + case "$base" in + version-*.*.*-*) + #other_list+=("$base") + other_list=("$base" "${other_list[@]}") + ;; + version-*) + #official_list+=("$base") + official_list=("$base" "${official_list[@]}") + ;; + *) + #other_list+=("$base") + other_list=("$base" "${other_list[@]}") + ;; + esac + fi + +done +dir_list=("${official_list[@]}" "${other_list[@]}") + +title="JasPer Reference Manual" + +#index_html_data=' +# +# +# +# +#

If you are not redirected in five seconds, click here.

+# +#' + +dquote='"' +cat <<- EOF + + + +$title + + +

$title

+EOF +[ $? -eq 0 ] || panic "cat failed" + +cat <<- EOF +

Official Releases

+EOF +[ $? -eq 0 ] || panic "cat failed" + +printf "The following official versions of the manual are available:\n\n" || \ + panic "printf failed" +printf "\n" || panic "printf failed" + +cat <<- EOF +

Draft Versions

+EOF +[ $? -eq 0 ] || panic "cat failed" + +if [ "${#other_list[@]}" -gt 0 ]; then + printf "The following other versions of the manual are available:\n\n" + printf "\n" +else + echo "No draft versions are available." +fi + +cat <<- EOF + + +EOF +[ $? -eq 0 ] || panic "cat failed" diff -Nru jasper-2.0.33/build/github/prebuild-v2 jasper-3.0.4/build/github/prebuild-v2 --- jasper-2.0.33/build/github/prebuild-v2 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/build/github/prebuild-v2 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,82 @@ +#! /usr/bin/env bash + +panic() +{ + echo "ERROR: $@" + exit 1 +} + +usage() +{ + echo "bad usage: $@" + exit 2 +} + +verbose=0 +out_file= +os= + +while getopts vc:s: opt; do + case $opt in + s) + os="$OPTARG";; + c) + out_file="$OPTARG";; + v) + verbose=$((verbose + 1));; + \?) + usage + break;; + esac +done +shift $((OPTIND - 1)) + +if [ -z "$out_file" ]; then + panic "no output file specified" +fi + +if [ -z "$os" ]; then + if [ -n "$RUNNER_OS" ]; then + case "$RUNNER_OS" in + MacOS|macOS) + os=macos;; + Linux|linux) + os=linux;; + Windows|windows) + os=windows;; + *) + os=unknown;; + esac + fi +fi + +echo "OS: $os" + +if [ -f "$out_file" ]; then + rm -f "$out_file" || panic "cannot remove file $out_file" +fi + +touch "$out_file" || panic "cannot create file $out_file" + +case "$os" in +linux) + ;; +macos) + brew install findutils || panic "cannot install findutils" + cat >> "$out_file" <<- EOF + export PATH=\$(brew --prefix)/opt/findutils/libexec/gnubin:\$PATH + EOF + [ $? -eq 0 ] || panic "cat failed" + ;; +windows) + ;; +*) + panic "invalid OS" + ;; +esac + +echo "========== start of commands ==========" || panic "echo failed" +cat "$out_file" || panic "cat failed" +echo "========== end of commands ==========" || panic "echo failed" + +exit 0 diff -Nru jasper-2.0.33/build/jas_realpath jasper-3.0.4/build/jas_realpath --- jasper-2.0.33/build/jas_realpath 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/build/jas_realpath 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,9 @@ +#! /usr/bin/env bash + +if [ $# -ne 1 ]; then + echo "bad usage: no path specified" + exit 1 +fi + +path="$1" +python -c 'import os,sys;print(os.path.realpath(sys.argv[1]))' "$path" diff -Nru jasper-2.0.33/build/make_release jasper-3.0.4/build/make_release --- jasper-2.0.33/build/make_release 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/build/make_release 2022-06-03 04:10:20.000000000 +0000 @@ -80,7 +80,7 @@ source_dir="$tmp_dir/$name" build_dir="$tmp_dir/build" install_dir="$tmp_dir/install" -news_file="$workspace_dir/NEWS" +news_file="$workspace_dir/NEWS.txt" changelog_file="$source_dir/ChangeLog" release_notes_file="$out_dir/release_notes.txt" archive_file="$out_dir/${name}.tar.gz" @@ -132,16 +132,23 @@ # panic "cannot move manual.pdf" remove_list=() + remove_list+=(appveyor.yml) +remove_list+=(.gitattributes) remove_list+=(.github) -remove_list+=(.travis.yml) remove_list+=(.gitignore) -remove_list+=(.gitattributes) -remove_list+=(build/my_build) +remove_list+=(.travis.yml) + remove_list+=(build/appveyor) -remove_list+=(build/travis) +remove_list+=(build/extract_release_notes) +remove_list+=(build/github) remove_list+=(build/make_dist) +remove_list+=(build/make_release) +remove_list+=(build/my_build) +remove_list+=(build/travis) + remove_list+=(data/test/bad/1_crash.jpg) + for file in "${remove_list[@]}"; do if [ ! -e "$source_dir/$file" ]; then warn "missing file/directory $file" diff -Nru jasper-2.0.33/build/my_build jasper-3.0.4/build/my_build --- jasper-2.0.33/build/my_build 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/build/my_build 2022-06-03 04:10:20.000000000 +0000 @@ -9,23 +9,84 @@ cmd_dir=$(dirname "$0") || exit 1 abs_cmd_dir=$(readlink -f "$cmd_dir") || panic -do_install=0 +usage() +{ + echo "bad usage: $@" + exit 2 +} + +enable=1 +enable_install=0 enable_debug=0 do_make_test=0 verbose=0 enable_asan=0 -enable_usan=0 -sde_top_dir="$HOME/public/sde" -#sde_top_dir="" +enable_lsan=0 +enable_ubsan=0 +enable_tsan=0 +enable_shared=1 +sde_top_dir= +configure_only=0 +enable_doc=0 +use_pthread=0 -while getopts E:AUditv opt; do +while getopts m:PE:AULTditvCDnS: opt; do case $opt in + S) + enable_shared="$OPTARG";; + P) + use_pthread=1;; + n) + enable=0;; + m) + case "$OPTARG" in + tsan) + enable_tsan=1 + enable_asan=0 + enable_lsan=0 + enable_ubsan=1 + enable_doc=0 + enable_debug=1 + enable_install=1 + use_pthread=1 + ;; + debug) + enable_tsan=0 + enable_asan=1 + enable_lsan=1 + enable_ubsan=1 + enable_doc=0 + enable_debug=1 + enable_install=1 + ;; + release) + enable_tsan=0 + enable_asan=1 + enable_lsan=1 + enable_ubsan=1 + enable_doc=0 + enable_debug=0 + enable_install=1 + ;; + *) + usage + ;; + esac + ;; A) enable_asan=1;; + L) + enable_lsan=1;; U) - enable_usan=1;; + enable_ubsan=1;; + T) + enable_tsan=1;; + C) + configure_only=1;; + D) + enable_doc=1;; i) - do_install=1;; + enable_install=1;; d) enable_debug=1;; t) @@ -41,10 +102,11 @@ done shift $((OPTIND - 1)) -if [ "$enable_debug" -ne 0 ]; then - enable_asan=1 - enable_usan=1 -fi +#if [ "$enable_debug" -ne 0 ]; then +# enable_asan=1 +# enable_lsan=1 +# enable_ubsan=1 +#fi source_dir="$abs_cmd_dir/.." tmp_dir="$source_dir/tmp_cmake" @@ -58,9 +120,11 @@ echo "C compiler $CC" fi -#sde_gcc="$sde_top_dir/bin/gcc" -sde_setup="$sde_top_dir/bin/sde_make_setup" -eval $("$sde_setup") || panic "setup failed" +if [ -n "$sde_top_dir" ]; then + #sde_gcc="$sde_top_dir/bin/gcc" + sde_setup="$sde_top_dir/bin/sde_make_setup" + eval $("$sde_setup") || panic "setup failed" +fi if [ -e "$tmp_dir" ]; then echo "Removing $tmp_dir" @@ -74,23 +138,50 @@ # configure_opts+=("-DCMAKE_C_COMPILER=$sde_gcc") #fi configure_opts+=("-DCMAKE_INSTALL_PREFIX=$install_dir") -configure_opts+=("-DJAS_ENABLE_STRICT=true") if [ "$enable_debug" -ne 0 ]; then configure_opts+=("-DCMAKE_BUILD_TYPE=Debug") - configure_opts+=("-DJAS_ENABLE_SHARED=false") else configure_opts+=("-DCMAKE_BUILD_TYPE=Release") fi +if [ "$enable_shared" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_SHARED=true") +else + configure_opts+=("-DJAS_ENABLE_SHARED=false") +fi if [ "$enable_asan" -ne 0 ]; then configure_opts+=("-DJAS_ENABLE_ASAN=true") fi -if [ "$enable_usan" -ne 0 ]; then - configure_opts+=("-DJAS_ENABLE_USAN=true") +if [ "$enable_tsan" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_TSAN=true") +fi +if [ "$enable_lsan" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_LSAN=true") +fi +if [ "$enable_ubsan" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_UBSAN=true") fi configure_opts+=("-DJAS_ENABLE_DANGEROUS_INTERNAL_TESTING_MODE=true") +if [ "$enable_doc" -ne 0 ]; then + configure_opts+=("-DJAS_ENABLE_DOC=true") +else + configure_opts+=("-DJAS_ENABLE_DOC=false") +fi +configure_opts+=("-DCMAKE_VERBOSE_MAKEFILE=true") +if [ "$use_pthread" -ne 0 ]; then + configure_opts+=("-DJAS_PREFER_PTHREAD=true") +fi configure_opts+=("$@") -echo "Running cmake ${configure_opts[@]}" -cmake "${configure_opts[@]}" || panic "cmake failed" +command=(cmake "${configure_opts[@]}") +echo "============================================================" +echo "RUNNING: ${command[@]}" +echo "============================================================" +if [ "$enable" -ne 0 ]; then + "${command[@]}" || panic "cmake failed" +fi + +if [ "$configure_only" -ne 0 ]; then + exit +fi build_opts=() install_opts=() @@ -98,16 +189,41 @@ build_opts+=(--verbose) install_opts+=(--verbose) fi -cmake --build "$build_dir" --clean-first \ - "${build_opts[@]}" || \ - panic "cmake build failed" - -cmake --build "$build_dir" --target install \ - "${install_opts[@]}" || \ - panic "cmake install failed" +command=(cmake) +command+=(--build "$build_dir") +command+=(--clean-first) +command+=("${build_opts[@]}") +echo "============================================================" +echo "RUNNING: ${command[@]}" +echo "============================================================" +if [ "$enable" -ne 0 ]; then + "${command[@]}" || \ + panic "cmake build failed" +fi + +if [ "$enable_install" -ne 0 ]; then + command=(cmake) + command+=(--build "$build_dir") + command+=(--target install) + command+=("${install_opts[@]}") + echo "============================================================" + echo "RUNNING: ${command[@]}" + echo "============================================================" + if [ "$enable" -ne 0 ]; then + "${command[@]}" || \ + panic "cmake install failed" + fi +fi test_opts=() test_opts+=(--output-on-failure) +command=(ctest "${test_opts[@]}") if [ "$do_make_test" -ne 0 ]; then - (cd "$build_dir" && ctest "${test_opts[@]}") || panic "ctest failed" + echo "============================================================" + echo "Testing" + echo "RUNNING: ${command[@]}" + echo "============================================================" + if [ "$enable" -ne 0 ]; then + (cd "$build_dir" && "${command[@]}") || panic "ctest failed" + fi fi diff -Nru jasper-2.0.33/build/travis/build jasper-3.0.4/build/travis/build --- jasper-2.0.33/build/travis/build 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/build/travis/build 2022-06-03 04:10:20.000000000 +0000 @@ -146,7 +146,7 @@ echo "Running cmake ${cmake_opts[@]}" (cmake "${cmake_opts[@]}") || panic "build of $target failed" if [ "$verbose" -ge 1 ]; then - for dir in src/appl src/libjasper test/bin; do + for dir in src/app src/libjasper test/bin; do echo "Listing directory $build_dir/$dir" (cd "$build_dir" && ls -alR "$dir") done @@ -169,7 +169,7 @@ echo "########################################" mkdir -p "$test_dir" || panic "cannot make directory $test_dir" - for file in build/travis/CMakeLists.txt src/appl/jasper.c; do + for file in build/travis/CMakeLists.txt src/app/jasper.c; do cp "$source_dir/$file" "$test_dir" || \ panic "cannot copy $file" done diff -Nru jasper-2.0.33/CMakeLists.txt jasper-3.0.4/CMakeLists.txt --- jasper-2.0.33/CMakeLists.txt 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/CMakeLists.txt 2022-06-03 04:10:20.000000000 +0000 @@ -1,154 +1,267 @@ -cmake_minimum_required (VERSION 2.8.11) - -project(JasPer C) - -set(CMAKE_MODULE_PATH - ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/build/cmake/modules/") - -# This include should be placed as early as possible. -include(InSourceBuild) - -include(CheckCCompilerFlag) +cmake_minimum_required(VERSION 3.12) +# Version 3.12 needed for FindJPEG imported targets. +# Version 3.10 needed for FindOpenGL imported targets. +# Version 3.1 needed for FindGLUT imported targets. ################################################################################ -# Version information. +# Specify software and shared library version information. ################################################################################ # The major, minor, and micro version numbers of the project. -set(JAS_VERSION_MAJOR 2) +set(JAS_VERSION_MAJOR 3) set(JAS_VERSION_MINOR 0) -set(JAS_VERSION_PATCH 33) +set(JAS_VERSION_PATCH 4) -# The project version. -set(JAS_VERSION - "${JAS_VERSION_MAJOR}.${JAS_VERSION_MINOR}.${JAS_VERSION_PATCH}") - -message("Software version: ${JAS_VERSION}") +# The shared library versioning information. +# Guidelines on how to change this information can be found below. +# The shared library version was set to 6.0.0 for JasPer version 3.0.0. +set(JAS_SO_VERSION 6) +set(JAS_SO_MINOR 0) +set(JAS_SO_RELEASE 0) -# The shared library versioning information, which is specified by the -# following variables: JAS_SO_VERSION, JAS_SO_MINOR, and JAS_SO_RELEASE. -# Each new software release should update the values of these variables. +# Guidelines for Updating the Shared Library Versioning Information +# ================================================================= # -# Guidelines for updating this information: -# If the code did not change (e.g., only documentation was updated), do -# nothing. +# If the code did not change (e.g., only documentation was updated): +# do not change the shared library versioning information. # If the code changed and the binary interface for the library did not change -# from the previous release (e.g., most bug fixes), increment JAS_SO_RELEASE. +# from the previous release (e.g., most bug fixes): +# increment JAS_SO_RELEASE. # If the binary interface changed, but remains compatible with the previous -# release (e.g., only new functions were added), increment JAS_SO_MINOR and -# set JAS_SO_RELEASE to 0. +# release (e.g., only new functions were added): +# - increment JAS_SO_MINOR; and +# - set JAS_SO_RELEASE to 0. # If the binary interface changed in a way that breaks compatibility with the -# previous release (e.g., a function was deleted), increment JAS_SO_VERSION and -# set both JAS_SO_MINOR and JAS_SO_RELEASE to 0. -# -# History of shared library versioning information: -# JasPer 2.0.0: 4.0.0 +# previous release (e.g., a function was deleted): +# - increment JAS_SO_VERSION; and +# - set both JAS_SO_MINOR and JAS_SO_RELEASE to 0. -if (APPLE AND CMAKE_SYSTEM_NAME MATCHES "Darwin") - set(MACOSX true) -else() - set(MACOSX false) -endif() +# Generate the project version. +set(JAS_VERSION + "${JAS_VERSION_MAJOR}.${JAS_VERSION_MINOR}.${JAS_VERSION_PATCH}") -# To fix a problem with OSX, increase JAS_SO_VERSION to 6 (instead of 5) -# when it is next increased. -set(JAS_SO_VERSION 4) -set(JAS_SO_MINOR 0) -set(JAS_SO_RELEASE 0) -# This is a temporary hack for OSX that should be removed when JAS_SO_VERSION -# is next incremented. -if (MACOSX) -set(JAS_SO_NAME "5.${JAS_SO_MINOR}.${JAS_SO_RELEASE}") -else() +# Generate the shared library build version. set(JAS_SO_NAME "${JAS_SO_VERSION}.${JAS_SO_MINOR}.${JAS_SO_RELEASE}") -endif() +message("Software version: ${JAS_VERSION}") message("Shared library ABI version: ${JAS_SO_VERSION}") message("Shared library build version: ${JAS_SO_NAME}") +message("CMAKE_VERSION: ${CMAKE_VERSION}") + +project(JasPer VERSION ${JAS_VERSION} LANGUAGES C) + +message("CMAKE_C_COMPILER_ID: ${CMAKE_C_COMPILER_ID}") +message("CMAKE_C_COMPILER_VERISON: ${CMAKE_C_COMPILER_VERSION}") + ################################################################################ # Include modules and set policies. ################################################################################ +list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/build/cmake/modules) + +# This include should be placed as early as possible. +include(InSourceBuild) + +include(CheckCCompilerFlag) +include(EnableAssertions) + # Adhere to GNU filesystem layout conventions. include(GNUInstallDirs) include(CheckIncludeFiles) include(CheckFunctionExists) +include(CheckSymbolExists) +include(CheckTypeSize) include(CheckCSourceCompiles) include(CTest) include(Sanitizers) +include(GenerateExportHeader) +include(JasGetIncludes) -cmake_policy(SET CMP0012 NEW) +# Note: JasGetStdcVersion uses try_run. +include(JasGetStdcVersion) +include(JasCheckType) + +# Save some typing below. +function(add_c_compile_options args) + foreach(arg IN LISTS ARGV) + add_compile_options($<$:${arg}>) + endforeach() +endfunction() ################################################################################ # Define options. ################################################################################ -option(JAS_ENABLE_SHARED "Enable building of shared library" true) -option(JAS_ENABLE_HIDDEN "Hide internal symbols" false) -option(JAS_ENABLE_32BIT "Use 32 bit integers on 64 bit CPUs" false) -option(JAS_ENABLE_LIBJPEG "Enable the use of the JPEG Library" true) -option(JAS_ENABLE_OPENGL "Enable the use of the OpenGL/GLUT Library" true) -option(JAS_ENABLE_AUTOMATIC_DEPENDENCIES "Enable automatic dependencies" true) -option(JAS_ENABLE_DOC "Enable building of the documentation" true) -option(JAS_ENABLE_PROGRAMS "Enable building of the programs" true) - -option(JAS_INCLUDE_PNM_CODEC "Include PNM codec support" true) -option(JAS_INCLUDE_BMP_CODEC "Include BMP codec support" true) -option(JAS_INCLUDE_RAS_CODEC "Include RAS codec support" true) -option(JAS_INCLUDE_JP2_CODEC "Include JP2 codec support" true) -option(JAS_INCLUDE_JPC_CODEC "Include JPC codec support" true) -option(JAS_INCLUDE_JPG_CODEC "Include JPG codec support" true) -option(JAS_INCLUDE_PGX_CODEC "Include PGX codec support" true) -option(JAS_INCLUDE_MIF_CODEC "Include MIF codec support" true) +# Note: The variable JAS_CROSSCOMPILING can be defined on the command line +# in order to override the value of CMAKE_CROSSCOMPILING (if necessary). + +if(DEFINED BUILD_SHARED_LIBS) + option(JAS_ENABLE_SHARED "Enable building of shared library" + ${BUILD_SHARED_LIBS}) +else() + option(JAS_ENABLE_SHARED "Enable building of shared library" ON) +endif() +option(JAS_ENABLE_HIDDEN "Hide internal symbols" ON) +option(JAS_ENABLE_32BIT "Use 32 bit integers on 64 bit CPUs" OFF) +option(JAS_ENABLE_LIBJPEG "Enable the use of the JPEG Library" ON) +option(JAS_ENABLE_LIBHEIF "Enable the use of the HEIF Library" ON) +option(JAS_ENABLE_OPENGL "Enable the use of the OpenGL/GLUT Library" ON) +option(JAS_ENABLE_DOC "Enable building of the documentation" ON) +option(JAS_ENABLE_LATEX "Allow the use of LaTeX if it is available " ON) +option(JAS_ENABLE_PROGRAMS "Enable building of the programs" ON) +option(JAS_ENABLE_MULTITHREADING_SUPPORT "Enable multithreading support" ON) +option(JAS_PREFER_PTHREAD + "Prefer POSIX Threads Library (over C11) for threading support" ON) +option(JAS_PREFER_PTHREAD_TSS + "Prefer POSIX Threads Library thread-specific storage (over _Thread_local)" + OFF) +option(JAS_STRICT "Treat compiler warnings as errors" OFF) + +# Options controlling which codec support is built into the JasPer library. +option(JAS_INCLUDE_BMP_CODEC "Include (native) BMP codec support" ON) +option(JAS_INCLUDE_JP2_CODEC "Include (native) JP2 codec support" ON) +option(JAS_INCLUDE_JPC_CODEC "Include (native) JPC codec support" ON) +option(JAS_INCLUDE_JPG_CODEC + "Include JPG codec support (via IJG JPEG Library)" ON) +option(JAS_INCLUDE_HEIC_CODEC + "Include experimental HEIC codec support (via Libheif Library)" ON) +option(JAS_INCLUDE_MIF_CODEC "Include (native) MIF codec support" ON) +option(JAS_INCLUDE_PGX_CODEC "Include (native) PGX codec support" ON) +option(JAS_INCLUDE_PNM_CODEC "Include (native) PNM codec support" ON) +option(JAS_INCLUDE_RAS_CODEC "Include (native) RAS codec support" ON) + +# Options controlling which codec support that is built into the JasPer +# library is enabled by default. +option(JAS_ENABLE_BMP_CODEC "Enable (native) BMP codec support" ON) +option(JAS_ENABLE_JP2_CODEC "Enable (native) JP2 codec support" ON) +option(JAS_ENABLE_JPC_CODEC "Enable (native) JPC codec support" ON) +option(JAS_ENABLE_JPG_CODEC + "Enable JPG codec support (via IJG JPEG Library)" ON) +option(JAS_ENABLE_HEIC_CODEC + "Enable experimental HEIC codec support (via Libheif Library)" OFF) +option(JAS_ENABLE_MIF_CODEC "Enable (native) MIF codec support" OFF) +option(JAS_ENABLE_PGX_CODEC "Enable (native) PGX codec support" ON) +option(JAS_ENABLE_PNM_CODEC "Enable (native) PNM codec support" ON) +option(JAS_ENABLE_RAS_CODEC "Enable (native) RAS codec support" ON) + +set(JAS_DEFAULT_MAX_MEM_USAGE "1073741824" CACHE STRING + "Set memory usage limit in bytes") + +# The following options are for testing/debugging and should normally only +# be changed by the developers of JasPer. +option(JAS_USE_JAS_INIT + "Use jas_init instead of jas_init_custom for initialization (should be false, except for testing)" + OFF) +option(JAS_ENABLE_NON_THREAD_SAFE_DEBUGGING + "Enable non-thread safe debug code" OFF) + +if(JAS_USE_JAS_INIT) + add_compile_definitions(JAS_USE_JAS_INIT) +endif() + +# To override the default setting of max_align_t, something like what +# appears in the body of the if-statement following this comment can be used. +# WARNING: Do not do this unless you know what you are doing. +if(FALSE) + add_compile_definitions("JAS_NO_SET_MAX_ALIGN_T") + add_compile_definitions("max_align_t=__INSERT_APPROPRIATE_TYPE_HERE__") +endif() + +# To override the default setting of ssize_t, something like what +# appears in the body of the if-statement following this comment can be used. +# WARNING: Do not do this unless you know what you are doing. +if(FALSE) + add_compile_definitions("JAS_NO_SET_SSIZE_T") + add_compile_definitions("ssize_t=__INSERT_APPROPRIATE_TYPE_HERE__") +endif() # WARNING: THE FOLLOWING OPTION SHOULD ONLY BE ENABLED BY THE JASPER SOFTWARE # DEVELOPMENT TEAM. IT IS NECESSARY FOR INTERNAL TESTING PURPOSES AND POSES # SIGNIFICANT SECURITY RISKS IF ENABLED. option(JAS_ENABLE_DANGEROUS_INTERNAL_TESTING_MODE "DO NOT ENABLE FOR SECURITY REASONS! (For internal use by JasPer development team only" - false) + OFF) + +option(JAS_ENABLE_CXX "Enable C++ code (for testing)." OFF) ################################################################################ # ################################################################################ +if(JAS_ENABLE_CXX) + message("Enabling C++") + enable_language(CXX) + message("CMAKE_CXX_COMPILER_ID: ${CMAKE_CXX_COMPILER_ID}") + message("CMAKE_CXX_COMPILER_VERISON: ${CMAKE_CXX_COMPILER_VERSION}") +endif() + +set(CMAKE_EXPORT_COMPILE_COMMANDS TRUE) + +# It is strongly recommended that the JasPer software be built using a +# compiler that supports the C11 (or later) version of the C standard, if +# such a compiler is available. The use of compilers supporting older +# versions of the language standard, such as C99, should only be used when +# no C11 support is available. +#set(CMAKE_C_STANDARD 99) # This should work but is not recommended. set(CMAKE_C_STANDARD 11) -if ((CMAKE_GENERATOR MATCHES Xcode) OR - (CMAKE_GENERATOR MATCHES "Visual Studio")) - set(JAS_MULTICONFIGURATION_GENERATOR 1) +# Enable extensions so that POSIX support is visible (e.g., ssize_t) without +# having to manually define _POSIX_C_SOURCE. +# Setting this to OFF will break things for at least some versions of MacOS +# (e.g, due to u_char, u_short, and u_int being undefined). +# In any case, it might be a bad idea to set this to OFF due to issues +# related to max_align_t and ssize_t. +set(CMAKE_C_EXTENSIONS ON) + +# Ensure that that the try_compile command (and the commands that use it) +# use the compiler option for the language standard being used. +# This policy was added in CMake 3.8. +cmake_policy(SET CMP0067 NEW) + +# Eliminate a CMake warning. +# Note: This policy was added in CMake 3.20. Do not add this for now, +# since it will cause older versions of CMake to barf. +#cmake_policy(SET CMP0115 NEW) + +if(APPLE AND CMAKE_SYSTEM_NAME MATCHES "Darwin") + set(MACOS TRUE) else() - set(JAS_MULTICONFIGURATION_GENERATOR 0) + set(MACOS FALSE) endif() -message("JAS_MULTICONFIGURATION_GENERATOR ${JAS_MULTICONFIGURATION_GENERATOR}") -if (JAS_ENABLE_AUTOMATIC_DEPENDENCIES) - message(WARNING - "If this software is being built as a package for a Linux distribution, " - "you should probably set JAS_ENABLE_AUTOMATIC_DEPENDENCIES to false.") - set(JAS_REQUIRED "") +if(CMAKE_SYSTEM_NAME MATCHES "Linux") + set(LINUX TRUE) else() - set(JAS_REQUIRED "REQUIRED") + set(LINUX FALSE) endif() -if (JAS_ENABLE_SHARED AND MACOSX) - set(CMAKE_MACOSX_RPATH true) +if((CMAKE_GENERATOR MATCHES "Xcode") OR + (CMAKE_GENERATOR MATCHES "Visual Studio") OR + (CMAKE_GENERATOR STREQUAL "Ninja Multi-Config")) + set(JAS_MULTICONFIGURATION_GENERATOR TRUE) + message("JAS_MULTICONFIGURATION_GENERATOR ${JAS_MULTICONFIGURATION_GENERATOR}") +else() + set(JAS_MULTICONFIGURATION_GENERATOR FALSE) endif() +message("JAS_MULTICONFIGURATION_GENERATOR ${JAS_MULTICONFIGURATION_GENERATOR}") -if (JAS_ENABLE_SHARED) - set(JAS_DLL 1) +if(JAS_ENABLE_SHARED AND MACOS) + set(CMAKE_MACOSX_RPATH TRUE) endif() # If a multiconfiguration generator is used, ensure that various output # files are not placed in subdirectories (such as Debug and Release) # as this will cause the CTest test suite to fail. -if (JAS_MULTICONFIGURATION_GENERATOR) +if(JAS_MULTICONFIGURATION_GENERATOR) + if(CMAKE_CONFIGURATION_TYPES) + set(CMAKE_DEBUG_POSTFIX d) + endif() set(CMAKE_RUNTIME_OUTPUT_DIRECTORY .) set(CMAKE_LIBRARY_OUTPUT_DIRECTORY .) set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY .) - foreach (config ${CMAKE_CONFIGURATION_TYPES}) + foreach(config ${CMAKE_CONFIGURATION_TYPES}) string(TOUPPER "${config}" config) set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_${config} .) set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_${config} .) @@ -161,8 +274,8 @@ set(CPACK_PACKAGE_VERSION "${JAS_VERSION}") set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "JasPer Image Processing Tool Kit") set(CPACK_PACKAGE_VENDOR "Michael Adams") -set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README") -set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE") +set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README.md") +set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.txt") set(CPACK_PACKAGE_VERSION_MAJOR "${JAS_VERSION_MAJOR}") set(CPACK_PACKAGE_VERSION_MINOR "${JAS_VERSION_MINOR}") set(CPACK_PACKAGE_VERSION_PATCH "${JAS_VERSION_PATCH}") @@ -173,37 +286,141 @@ set(CPACK_GENERATOR "TGZ") include(CPack) -if (NOT MSVC) - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall") +if(CMAKE_BUILD_TYPE) + message("CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}") +elseif(CMAKE_CONFIGURATION_TYPES) + message("CMAKE_CONFIGURATION_TYPES: ${CMAKE_CONFIGURATION_TYPES}") +endif() +message("CMAKE_C_COMPILER_ID: ${CMAKE_C_COMPILER_ID}") +message("CMAKE_C_COMPILER: ${CMAKE_C_COMPILER}") +message("CMAKE_LINKER: ${CMAKE_LINKER}") + +# Customize the compiler flags for warning messages. +if(CMAKE_C_COMPILER_ID STREQUAL "Clang" OR CMAKE_C_COMPILER_ID STREQUAL "GNU") + check_c_compiler_flag("-Wno-stringop-truncation" + JAS_GCC_WARN_NO_STRINGOP_TRUNCATION) + check_c_compiler_flag("-Wno-stringop-overflow" + JAS_GCC_WARN_NO_STRINGOP_OVERFLOW) + check_c_compiler_flag("-Wno-tautological-constant-out-of-range-compare" + JAS_CLANG_WARN_NO_OUT_OF_RANGE_COMPARE) + add_c_compile_options(-Wall) + + # Note: Use CMAKE_C_FLAGS (instead of add_compile_options) so that the + # flags are also used for compile checks. + #add_c_compile_options(-pedantic) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -pedantic") - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -W -Wformat -Wmissing-prototypes -Wstrict-prototypes") - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wmissing-declarations -Wredundant-decls") -endif() -if (JAS_ENABLE_HIDDEN AND NOT WIN32) - # don't export internal symbols - check_c_compiler_flag("-fvisibility=hidden" JAS_HAVE_VISIBILITY) - if (JAS_HAVE_VISIBILITY) - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fvisibility=hidden -DJAS_HAVE_VISIBILITY") + add_c_compile_options(-W) + add_c_compile_options(-Wno-sign-compare) + add_c_compile_options(-Wformat) + add_c_compile_options(-Wmissing-prototypes) + add_c_compile_options(-Wstrict-prototypes) + add_c_compile_options(-Wno-type-limits) + if (JAS_CLANG_WARN_NO_OUT_OF_RANGE_COMPARE) + add_c_compile_options(-Wno-tautological-constant-out-of-range-compare) endif() + if(JAS_GCC_WARN_NO_STRINGOP_TRUNCATION) + add_c_compile_options(-Wno-stringop-truncation) + endif() + if(JAS_GCC_WARN_NO_STRINGOP_OVERFLOW) + # Note: Sometimes spurious warnings that have nothing to do with + # string are generated. + add_c_compile_options(-Wno-stringop-overflow) + endif() + add_c_compile_options(-Wmissing-declarations) + if(CMAKE_C_COMPILER_ID STREQUAL "Clang") + add_c_compile_options(-Wno-unused-command-line-argument) + endif() + if(JAS_STRICT) + # Treat all compiler warnings as errors. + # Note: Use CMAKE_C_FLAGS (instead of add_compile_options) so that the + # flags are also used for compile checks. + #add_c_compile_options(-pedantic-errors) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -pedantic-errors") + #add_c_compile_options(-Werror) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror") + endif() +elseif(CMAKE_C_COMPILER_ID STREQUAL "MSVC") + # possibly lossy conversion + add_c_compile_options(/wd4244) + # different const qualifiers + add_c_compile_options(/wd4090) + # signed/unsigned mismatch + add_c_compile_options(/wd4018) + # function may be unsafe (e.g., sprintf, strncat) + add_c_compile_options(/wd4996) + # allow some kinds of narrowing conversions + add_c_compile_options(/wd4267) + if(JAS_STRICT) + # Treat all compiler warnings as errors. + add_c_compile_options(/WX) + endif() +endif() - if (NOT (CMAKE_BUILD_TYPE MATCHES "Debug")) - # remove unused internal symbols - check_c_compiler_flag("-ffunction-sections" HAVE_FUNCTION_SECTIONS) - check_c_compiler_flag("-fdata-sections" HAVE_DATA_SECTIONS) - check_c_compiler_flag("-Wl,--gc-sections" HAVE_GC_SECTIONS) - - if (HAVE_FUNCTION_SECTIONS AND HAVE_DATA_SECTIONS AND HAVE_GC_SECTIONS) - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -ffunction-sections -fdata-sections -Wl,--gc-sections") +if(JAS_ENABLE_HIDDEN) + set(CMAKE_C_VISIBILITY_PRESET hidden) + set(CMAKE_VISIBILITY_INLINES_HIDDEN 0) + if(NOT (CMAKE_BUILD_TYPE MATCHES "Debug")) + if(LINUX) + check_c_compiler_flag("-ffunction-sections" HAVE_FUNCTION_SECTIONS) + check_c_compiler_flag("-fdata-sections" HAVE_DATA_SECTIONS) + check_c_compiler_flag("-Wl,--gc-sections" HAVE_GC_SECTIONS) + if(HAVE_FUNCTION_SECTIONS AND HAVE_DATA_SECTIONS AND + HAVE_GC_SECTIONS) + add_c_compile_options(-ffunction-sections) + add_c_compile_options(-fdata-sections) + add_c_compile_options(-Wl,--gc-sections) + endif() endif() endif() endif() -################################################################################ -# Perform plaform checks. -################################################################################ - -include(JasOpenGL) +message("CMAKE_C_FLAGS: ${CMAKE_C_FLAGS}") +message("CMAKE_C_FLAGS_RELEASE: ${CMAKE_C_FLAGS_RELEASE}") +message("CMAKE_C_FLAGS_DEBUG: ${CMAKE_C_FLAGS_DEBUG}") + +################################################################################ +# Perform platform checks. +################################################################################ + +#unset(JAS_CMAKE_REQUIRED_FLAGS) +#unset(JAS_CMAKE_REQUIRED_DEFINITIONS) +#if(CMAKE_C_COMPILER_ID STREQUAL "Clang" OR CMAKE_C_COMPILER_ID STREQUAL "GNU") +# set(JAS_CMAKE_REQUIRED_FLAGS ${JAS_CMAKE_REQUIRED_FLAGS} +# -Wpedantic -pedantic-errors -Werror) +# #set(JAS_CMAKE_REQUIRED_DEFINITIONS ${JAS_CMAKE_REQUIRED_DEFINITIONS} +# # "_POSIX_C_SOURCE=200809L") +#endif() +#set(CMAKE_REQUIRED_FLAGS ${JAS_CMAKE_REQUIRED_FLAGS}) +#set(JAS_CMAKE_REQUIRED_DEFINITIONS ${JAS_CMAKE_REQUIRED_DEFINITIONS}) + +# Get the value of the __STDC_VERSION__ preprocessor define. +if((DEFINED JAS_CROSSCOMPILING AND JAS_CROSSCOMPILING) OR + (NOT DEFINED JAS_CROSSCOMPILING AND CMAKE_CROSSCOMPILING)) + message("A cross-compiling environment has been detected.") + # Note: The variable JAS_STDC_VERSION should be set to the value of the + # preprocessor symbol __STDC_VERSION__ on the target platform. + # Since CMake is unable to run a cross-compiled program, the value of + # __STDC_VERSION__ cannot be automatically determined when + # cross-compiling. If cross-compiling, the value of JAS_STDC_VERSION + # will need to be set manually from the command line + # (e.g., using -DJAS_STDC_VERSION=YYYYMML) or by changing the line below. + set(JAS_STDC_VERSION "0L" CACHE INTERNAL "The value of __STDC_VERSION__.") + if (JAS_STDC_VERSION STREQUAL "0L") + message(FATAL_ERROR + "The value of __STDC_VERSION__ cannot be automatically determined " + "when cross-compiling. Please set JAS_STDC_VERSION to the value " + "of __STDC_VERSION__ when invoking CMake (e.g., by using the " + "option -DJAS_STDC_VERSION=...) or modify the CMakeLists.txt " + "appropriately.") + endif() +else() + jas_get_stdc_version(status JAS_STDC_VERSION) + if(NOT status) + message(FATAL_ERROR "Cannot determine the value of __STDC_VERSION__.") + endif() +endif() +message("__STDC_VERSION__: ${JAS_STDC_VERSION}") find_program(BASH_PROGRAM bash) @@ -213,90 +430,315 @@ check_include_files(sys/time.h JAS_HAVE_SYS_TIME_H) check_include_files(sys/types.h JAS_HAVE_SYS_TYPES_H) +check_type_size(max_align_t MAX_ALIGN_T) +if(HAVE_MAX_ALIGN_T) + set(JAS_HAVE_MAX_ALIGN_T 1 CACHE INTERNAL "Test JAS_HAVE_MAX_ALIGN_T") +else() + set(JAS_HAVE_MAX_ALIGN_T 0 CACHE INTERNAL "Test JAS_HAVE_MAX_ALIGN_T") +endif() +message("JAS_HAVE_MAX_ALIGN_T: ${JAS_HAVE_MAX_ALIGN_T}") + +jas_check_type("char" JAS_HAVE_CHAR SIZE JAS_SIZEOF_CHAR) +message("JAS_SIZEOF_CHAR: ${JAS_SIZEOF_CHAR}") +jas_check_type("int" JAS_HAVE_INT SIZE JAS_SIZEOF_INT) +message("JAS_SIZEOF_INT: ${JAS_SIZEOF_INT}") +jas_check_type("long" JAS_HAVE_LONG SIZE JAS_SIZEOF_LONG) +message("JAS_SIZEOF_LONG: ${JAS_SIZEOF_LONG}") +jas_check_type("long long" JAS_HAVE_LLONG SIZE JAS_SIZEOF_LLONG) +message("JAS_SIZEOF_LLONG: ${JAS_SIZEOF_LLONG}") +jas_check_type("size_t" JAS_HAVE_SIZE_T SIZE JAS_SIZEOF_SIZE_T) +message("JAS_SIZEOF_SIZE_T: ${JAS_SIZEOF_SIZE_T}") +jas_check_type("ssize_t" JAS_HAVE_SSIZE_T SIZE JAS_SIZEOF_SSIZE_T) +message("JAS_HAVE_SSIZE_T: ${JAS_HAVE_SSIZE_T}") +if(JAS_HAVE_SSIZE_T) + message("JAS_SIZEOF_SSIZE_T: ${JAS_SIZEOF_SSIZE_T}") +endif() + +#check_type_size(ssize_t SSIZE_T) +#if(HAVE_SSIZE_T) +# set(JAS_HAVE_SSIZE_T 1 CACHE INTERNAL "Test JAS_HAVE_SSIZE_T") +#else() +# set(JAS_HAVE_SSIZE_T 0 CACHE INTERNAL "Test JAS_HAVE_SSIZE_T") +#endif() +#message("JAS_HAVE_SSIZE_T: ${JAS_HAVE_SSIZE_T}") + +#check_type_size(uintmax_t UINTMAX_T) +#if(HAVE_UINTMAX_T) +# set(JAS_HAVE_UINTMAX_T 1 CACHE INTERNAL "Test JAS_HAVE_UINTMAX_T") +#else() +# set(JAS_HAVE_UINTMAX_T 0 CACHE INTERNAL "Test JAS_HAVE_UINTMAX_T") +#endif() +#message("JAS_HAVE_UINTMAX_T: ${JAS_HAVE_UINTMAX_T}") + +#check_type_size(intmax_t INTMAX_T) +#if(HAVE_INTMAX_T) +# set(JAS_HAVE_INTMAX_T 1 CACHE INTERNAL "Test JAS_HAVE_INTMAX_T") +#else() +# set(JAS_HAVE_INTMAX_T 0 CACHE INTERNAL "Test JAS_HAVE_INTMAX_T") +#endif() +#message("JAS_HAVE_INTMAX_T: ${JAS_HAVE_INTMAX_T}") + +check_function_exists(nanosleep JAS_HAVE_NANOSLEEP) check_function_exists(gettimeofday JAS_HAVE_GETTIMEOFDAY) check_function_exists(getrusage JAS_HAVE_GETRUSAGE) check_function_exists(mkostemp JAS_HAVE_MKOSTEMP) +if(MSVC) + check_symbol_exists(snprintf stdio.h JAS_HAVE_SNPRINTF) +else() + check_function_exists(snprintf JAS_HAVE_SNPRINTF) +endif() ################################################################################ # Check for invalid codec combinations. ################################################################################ -if (JAS_INCLUDE_JP2_CODEC AND NOT JAS_INCLUDE_JPC_CODEC) - message(FATAL_ERROR "The JPC codec must be included in order to include the JP2 codec.") +if(NOT JAS_ENABLE_DANGEROUS_INTERNAL_TESTING_MODE AND JAS_ENABLE_MIF_CODEC) + message(FATAL_ERROR + "For reasons of security, it is not recommended that the MIF codec " + "be enabled by default." + ) + set(JAS_ENABLE_MIF_CODEC OFF) +endif() +message("JAS_ENABLE_MIF_CODEC: ${JAS_ENABLE_MIF_CODEC}") + +if (JAS_INCLUDE_BMP_CODEC AND + JAS_INCLUDE_JP2_CODEC AND + JAS_INCLUDE_JPC_CODEC AND + JAS_INCLUDE_PGX_CODEC AND + JAS_INCLUDE_PNM_CODEC AND + JAS_INCLUDE_MIF_CODEC AND + JAS_INCLUDE_RAS_CODEC) + message("Support for all native codecs has been included.") + set(JAS_HAVE_ALL_NATIVE_CODECS 1) +else() + message(WARNING + "Support for one or more native codecs has been excluded. " + "The inclusion of support for all native codecs is " + "STRONGLY RECOMMENDED.") + set(JAS_HAVE_ALL_NATIVE_CODECS 0) +endif() + +if(JAS_INCLUDE_JP2_CODEC AND NOT JAS_INCLUDE_JPC_CODEC) + message(FATAL_ERROR + "The JPC codec must be included in order to include the JP2 codec.") endif() ################################################################################ -# Check for the JPEG library. +# Configure threading support ################################################################################ -if (JAS_ENABLE_LIBJPEG) - find_package(JPEG ${JAS_LIBJPEG_REQUIRED}) - message("JPEG library found: ${JPEG_FOUND}") -else() - set(JPEG_FOUND false) -endif() -if (JAS_ENABLE_LIBJPEG AND JPEG_FOUND) - set(JAS_HAVE_LIBJPEG 0) - message("JPEG include directory: ${JPEG_INCLUDE_DIR}") - message("JPEG libraries: ${JPEG_LIBRARIES}") - # In some versions of the JPEG library, the header file jpeglib.h - # does not include some of the header files upon which it depends - # (e.g., stdio.h and stdint.h). So, we cannot reliably use - # check_include_file here. - set(CMAKE_REQUIRED_INCLUDES ${JPEG_INCLUDE_DIR}) +set(JAS_THREADS FALSE) +set(JAS_THREADS_C11 FALSE) +set(JAS_THREADS_PTHREAD FALSE) +set(JAS_THREADS_WIN32 FALSE) +set(JAS_HAVE_THREAD_LOCAL FALSE) +if(JAS_ENABLE_MULTITHREADING_SUPPORT) check_c_source_compiles(" - #include - #include - #include - int main() {} - " JAS_HAVE_JPEGLIB_H) - if(JAS_HAVE_JPEGLIB_H) - set(JAS_HAVE_LIBJPEG 1) - include_directories(${JPEG_INCLUDE_DIR}) + #include + int main() { + thrd_t thread; + mtx_t mutex; + tss_t tss; + } + " JAS_TRY_COMPILE_C11_THREADS) + check_c_source_compiles(" + typedef struct {int x;} foo_t; + /* Use a pointer to a struct to entice a warning from GCC + in C99 mode with -Wpedantic. */ + extern _Thread_local foo_t *foo; + int main() { + } + " JAS_TRY_COMPILE_THREAD_LOCAL) + check_include_files(pthread.h JAS_HAVE_PTHREAD_H) + + # Check for support for various threading libraries. + if(MACOS) + set(THREADS_PREFER_PTHREAD_FLAG TRUE) + set(CMAKE_HAVE_THREADS_LIBRARY 1) + set(CMAKE_THREAD_LIBS_INIT "-lpthread") + set(CMAKE_USE_WIN32_THREADS_INIT 0) + set(CMAKE_USE_PTHREADS_INIT 1) + set(Threads_FOUND TRUE) else() - message(WARNING "The header file jpeglib.h appears to be missing.") - message(WARNING "Disabling LIBJPEG.") - set(JPEG_FOUND false) - set(JPEG_LIBRARIES "") - set(JPEG_INCLUDE_DIR "") - set(JAS_ENABLE_LIBJPEG 0) + set(THREADS_PREFER_PTHREAD_FLAG TRUE) + find_package(Threads) + endif() + if(Threads_FOUND) + if(CMAKE_USE_PTHREADS_INIT AND JAS_HAVE_PTHREAD_H) + set(JAS_HAVE_PTHREAD_THREADS TRUE) + endif() + if(CMAKE_USE_WIN32_THREADS_INIT) + set(JAS_HAVE_WIN32_THREADS TRUE) + endif() + set(THREAD_LIBRARY "${CMAKE_THREAD_LIBS_INIT}") + if(JAS_TRY_COMPILE_C11_THREADS) + set(JAS_HAVE_C11_THREADS TRUE) + endif() + if(JAS_TRY_COMPILE_THREAD_LOCAL AND NOT JAS_PREFER_PTHREAD_TSS) + set(JAS_HAVE_THREAD_LOCAL TRUE) + endif() + endif() + + # TODO: Is this really needed? Is this due to a TSan issue? + if(MACOS) + set(JAS_PREFER_PTHREAD FALSE) endif() + + # Apply preferences to select one particular threading library. + if(JAS_HAVE_PTHREAD_THREADS AND JAS_PREFER_PTHREAD) + set(JAS_THREADS_PTHREAD TRUE) + elseif(JAS_HAVE_C11_THREADS) + set(JAS_THREADS_C11 TRUE) + elseif(JAS_HAVE_WIN32_THREADS) + set(JAS_THREADS_WIN32 TRUE) + elseif(JAS_HAVE_PTHREAD_THREADS) + set(JAS_THREADS_PTHREAD TRUE) + endif() + if(JAS_THREADS_C11 OR JAS_THREADS_PTHREAD OR JAS_THREADS_WIN32) + set(JAS_THREADS TRUE) + message("Threading support enabled.") + else() + message(WARNING "No threading support found.") + endif() + + message("Prefer POSIX threading support: ${JAS_PREFER_PTHREAD}") + message("Threading support found: ${JAS_THREADS}") + message("C11 threading support detected: ${JAS_HAVE_C11_THREADS}") + message("POSIX threading support detected: ${JAS_HAVE_PTHREAD_THREADS}") + message("WIN32 threading support detected: ${JAS_HAVE_WIN32_THREADS}") + message("C11 threading support selected: ${JAS_THREADS_C11}") + message("POSIX threading support selected: ${JAS_THREADS_PTHREAD}") + message("Win32 threading support selected: ${JAS_THREADS_WIN32}") + message("Threading library: ${THREAD_LIBRARY}") + message("_Thread_local: ${JAS_HAVE_THREAD_LOCAL}") else() - set(JAS_HAVE_LIBJPEG 0) - set(JPEG_INCLUDE_DIR "") - set(JPEG_LIBRARIES "") + message("Threading support has been disabled.") endif() -if (NOT JAS_HAVE_LIBJPEG) - set(JAS_INCLUDE_JPG_CODEC 0) + +if(JAS_ENABLE_MULTITHREADING_SUPPORT AND NOT JAS_THREADS) + message(FATAL_ERROR "Threading support is not available.") +endif() + +if(JAS_THREADS_C11 AND JAS_ENABLE_TSAN) + message(FATAL_ERROR + "TSAN does not have interceptors for C11 concurrency primitives. " + "Using C11 threads and TSan will likely not end well. " + "See https://github.com/google/sanitizers/issues/1195") endif() ################################################################################ -# Check for the Math library. +# Check for the OpenGL and GLUT libraries. +################################################################################ + +set(JAS_HAVE_OPENGL 0) +set(JAS_OPENGL_TARGETS) +if(JAS_ENABLE_OPENGL) + set(OpenGL_GL_PREFERENCE GLVND) + find_package(OpenGL) + find_package(GLUT) + if((TARGET OpenGL::GL) AND (TARGET GLUT::GLUT)) + jas_get_includes_from_targets(CMAKE_REQUIRE_INCLUDES + OpenGL::GL OpenGL::GLU GLUT::GLUT) + message("CMAKE_REQUIRE_INCLUDES ${CMAKE_REQUIRE_INCLUDES}") + check_include_files(GL/glut.h JAS_HAVE_GL_GLUT_H) + check_include_files(GLUT/glut.h JAS_HAVE_GLUT_GLUT_H) + check_include_files(glut.h JAS_HAVE_GLUT_H) + if(JAS_HAVE_GL_GLUT_H OR JAS_HAVE_GLUT_GLUT_H OR JAS_HAVE_GLUT_H) + set(JAS_OPENGL_TARGETS GLUT::GLUT OpenGL::GL) + if (TARGET OpenGL::GLU) + set(JAS_OPENGL_TARGETS ${JAS_OPENGL_TARGETS} OpenGL::GLU) + endif() + set(JAS_HAVE_OPENGL 1) + else() + message(WARNING "The glut.h header file is missing.") + message(WARNING "Disabling OpenGL.") + endif() + endif() +endif() + +if(JAS_HAVE_OPENGL AND MACOS) + add_compile_definitions(GL_SILENCE_DEPRECATION) +endif() + +################################################################################ +# Check for the JPEG library. ################################################################################ -find_library(MATH_LIBRARY m) -if (NOT MATH_LIBRARY) - set(MATH_LIBRARY "") +# The following is needed to prevent the incorrect version of the JPEG library +# from being found. +if(MACOS) + set(CMAKE_FIND_FRAMEWORK LAST) +endif() + +set(JAS_HAVE_LIBJPEG 0) +set(JAS_LIBJPEG_TARGET) +if(JAS_ENABLE_LIBJPEG) + find_package(JPEG) + if (TARGET JPEG::JPEG) + # In some versions of the JPEG library, the header file jpeglib.h + # does not include some of the header files upon which it depends + # (e.g., stdio.h and stdint.h). So, we cannot reliably use + # check_include_file here. + jas_get_includes_from_targets(CMAKE_REQUIRED_INCLUDES JPEG::JPEG) + check_c_source_compiles(" + #include + #include + #include + int main() {} + " JAS_HAVE_JPEGLIB_H) + if(JAS_HAVE_JPEGLIB_H) + set(JAS_HAVE_LIBJPEG 1) + set(JAS_LIBJPEG_TARGET JPEG::JPEG) + else() + message(WARNING "The header file jpeglib.h is missing.") + message(WARNING "Disabling LIBJPEG.") + endif() + endif() +endif() + +if(NOT JAS_HAVE_LIBJPEG) + set(JAS_INCLUDE_JPG_CODEC 0) endif() +message("JAS_INCLUDE_JPG_CODEC: ${JAS_INCLUDE_JPG_CODEC}") ################################################################################ -# +# Check for the HEIF library. ################################################################################ -add_definitions("-D_GNU_SOURCE") +set(JAS_HAVE_LIBHEIF 0) +if(JAS_ENABLE_LIBHEIF) + find_library(HEIF_LIBRARY heif) + check_include_files(libheif/heif.h JAS_HAVE_HEIF_H) + if(HEIF_LIBRARY AND JAS_HAVE_HEIF_H) + set(JAS_HAVE_LIBHEIF 1) + set(HEIF_LIBRARIES "${HEIF_LIBRARY}") + endif() +endif() +if(NOT JAS_HAVE_LIBHEIF) + set(JAS_INCLUDE_HEIC_CODEC 0) +endif() +message("JAS_INCLUDE_HEIC_CODEC: ${JAS_INCLUDE_HEIC_CODEC}") ################################################################################ -# +# Check for the Math library. ################################################################################ -if (JAS_ENABLE_SHARED) +find_library(MATH_LIBRARY m) +if(NOT MATH_LIBRARY) + set(MATH_LIBRARY "") +endif() + +################################################################################ +# Perform shared library setup. +################################################################################ +if(JAS_ENABLE_SHARED) # use, i.e. don't skip the full RPATH for the build tree set(CMAKE_SKIP_BUILD_RPATH FALSE) # when building, don't use the install RPATH already # (but later on when installing) - set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE) + set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE) set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib") @@ -308,24 +750,23 @@ # system directory list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/lib" isSystemDir) - if("${isSystemDir}" STREQUAL "-1") + if(isSystemDir EQUAL -1) set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}") - endif("${isSystemDir}" STREQUAL "-1") - + endif() endif() ################################################################################ -# +# Miscellany. ################################################################################ add_subdirectory(src/libjasper) -if (JAS_ENABLE_PROGRAMS) - add_subdirectory(src/appl) -endif () -if (JAS_ENABLE_DOC) +if(JAS_ENABLE_PROGRAMS) + add_subdirectory(src/app) +endif() +if(JAS_ENABLE_DOC) add_subdirectory(doc) -endif () +endif() # The package configuation (pc) file should be installed in # ${CMAKE_INSTALL_PREFIX}/lib/pkgconfig. @@ -334,26 +775,4 @@ install(FILES "${CMAKE_CURRENT_BINARY_DIR}/build/jasper.pc" DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig") -install(FILES "README" DESTINATION "${CMAKE_INSTALL_DOCDIR}") - -################################################################################ -# Test suite -################################################################################ - -configure_file("${CMAKE_CURRENT_SOURCE_DIR}/test/bin/wrapper.in" - "${CMAKE_CURRENT_BINARY_DIR}/test/bin/wrapper" @ONLY) - -if (BASH_PROGRAM) - add_test(run_test_1 - "${BASH_PROGRAM}" "${CMAKE_CURRENT_BINARY_DIR}/test/bin/wrapper" - "${CMAKE_CURRENT_SOURCE_DIR}/test/bin/run_test_1") - add_test(run_test_2 - "${BASH_PROGRAM}" "${CMAKE_CURRENT_BINARY_DIR}/test/bin/wrapper" - "${CMAKE_CURRENT_SOURCE_DIR}/test/bin/run_test_2") - add_test(run_test_3 - "${BASH_PROGRAM}" "${CMAKE_CURRENT_BINARY_DIR}/test/bin/wrapper" - "${CMAKE_CURRENT_SOURCE_DIR}/test/bin/run_test_3") - add_test(run_test_4 - "${BASH_PROGRAM}" "${CMAKE_CURRENT_BINARY_DIR}/test/bin/wrapper" - "${CMAKE_CURRENT_SOURCE_DIR}/test/bin/run_test_4") -endif() +install(FILES "README.md" DESTINATION "${CMAKE_INSTALL_DOCDIR}") diff -Nru jasper-2.0.33/COPYRIGHT jasper-3.0.4/COPYRIGHT --- jasper-2.0.33/COPYRIGHT 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/COPYRIGHT 1970-01-01 00:00:00.000000000 +0000 @@ -1,2 +0,0 @@ -The copyright information for the JasPer software accompanies the software -license, and can be found in the file named "LICENSE". diff -Nru jasper-2.0.33/COPYRIGHT.txt jasper-3.0.4/COPYRIGHT.txt --- jasper-2.0.33/COPYRIGHT.txt 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/COPYRIGHT.txt 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,2 @@ +The copyright information for the JasPer software accompanies the software +license, and can be found in the file named "LICENSE.txt". diff -Nru jasper-2.0.33/data/colorprofiles/README jasper-3.0.4/data/colorprofiles/README --- jasper-2.0.33/data/colorprofiles/README 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/data/colorprofiles/README 1970-01-01 00:00:00.000000000 +0000 @@ -1,18 +0,0 @@ -This directory contains a number of ICC color profiles. - -Some of the more important profiles include: - -sgray.icm - JPEG-2000 JP2 standard gray enumerated color space - This profile was provided by Scott Houchin of Kodak. - -srgb.icm - JPEG-2000 JP2 standard RGB (i.e., sRGB) enumerated color space - This profile was provided by Scott Houchin of Kodak. - -sycc.icm - JPEG-2000 JP2 standard YCC enumerated color space - This profile was provided by Jack Holm of Hewlett Packard. - -A number of other profiles in this directory were provided by Scott -Houchin of Kodak. diff -Nru jasper-2.0.33/data/colorprofiles/README.txt jasper-3.0.4/data/colorprofiles/README.txt --- jasper-2.0.33/data/colorprofiles/README.txt 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/data/colorprofiles/README.txt 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,18 @@ +This directory contains a number of ICC color profiles. + +Some of the more important profiles include: + +sgray.icm + JPEG-2000 JP2 standard gray enumerated color space + This profile was provided by Scott Houchin of Kodak. + +srgb.icm + JPEG-2000 JP2 standard RGB (i.e., sRGB) enumerated color space + This profile was provided by Scott Houchin of Kodak. + +sycc.icm + JPEG-2000 JP2 standard YCC enumerated color space + This profile was provided by Jack Holm of Hewlett Packard. + +A number of other profiles in this directory were provided by Scott +Houchin of Kodak. diff -Nru jasper-2.0.33/data/images/feed.pnm jasper-3.0.4/data/images/feed.pnm --- jasper-2.0.33/data/images/feed.pnm 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/data/images/feed.pnm 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,11 @@ +P1 +# feep.pbm +24 7 +0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 +0 1 1 1 1 0 0 1 1 1 1 0 0 1 1 1 1 0 0 1 1 1 0 0 +0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 1 0 +0 1 1 1 0 0 0 1 1 1 0 0 0 1 1 1 0 0 0 1 0 0 1 0 +0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 1 0 +0 1 0 0 0 0 0 1 1 1 1 0 0 1 1 1 1 0 0 1 1 1 0 0 +0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 + Binary files /tmp/tmp6x855cg9/_kRq9Ov68F/jasper-2.0.33/data/images/goldenears_gray.jp2 and /tmp/tmp6x855cg9/JmVMT9nr8O/jasper-3.0.4/data/images/goldenears_gray.jp2 differ Binary files /tmp/tmp6x855cg9/_kRq9Ov68F/jasper-2.0.33/data/images/goldenears.jp2 and /tmp/tmp6x855cg9/JmVMT9nr8O/jasper-3.0.4/data/images/goldenears.jp2 differ diff -Nru jasper-2.0.33/data/images/README jasper-3.0.4/data/images/README --- jasper-2.0.33/data/images/README 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/data/images/README 1970-01-01 00:00:00.000000000 +0000 @@ -1,11 +0,0 @@ -This directory contains numerous test images, stored in various formats. - -goldenears -goldenears_gray - A picture taken at Golden Ears Provincial Park, - located near Maple Ridge, BC, Canada. - -stawamuschief -stawamuschief_gray - A picture taken at Stawamus Chief Provincial Park, - located close to Squamish, BC, Canada. diff -Nru jasper-2.0.33/data/images/README.txt jasper-3.0.4/data/images/README.txt --- jasper-2.0.33/data/images/README.txt 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/data/images/README.txt 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,11 @@ +This directory contains numerous test images, stored in various formats. + +goldenears +goldenears_gray + A picture taken at Golden Ears Provincial Park, + located near Maple Ridge, BC, Canada. + +stawamuschief +stawamuschief_gray + A picture taken at Stawamus Chief Provincial Park, + located close to Squamish, BC, Canada. Binary files /tmp/tmp6x855cg9/_kRq9Ov68F/jasper-2.0.33/data/test/bad/307_empty_iccp.jp2 and /tmp/tmp6x855cg9/JmVMT9nr8O/jasper-3.0.4/data/test/bad/307_empty_iccp.jp2 differ Binary files /tmp/tmp6x855cg9/_kRq9Ov68F/jasper-2.0.33/data/test/bad/309.jpc and /tmp/tmp6x855cg9/JmVMT9nr8O/jasper-3.0.4/data/test/bad/309.jpc differ diff -Nru jasper-2.0.33/data/test/bad/README jasper-3.0.4/data/test/bad/README --- jasper-2.0.33/data/test/bad/README 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/data/test/bad/README 1970-01-01 00:00:00.000000000 +0000 @@ -1,3 +0,0 @@ -This directory contains numerous image files whose contents correspond -to invalid (i.e., corrupt) image data. These files are useful for -testing purposes. diff -Nru jasper-2.0.33/data/test/bad/README.txt jasper-3.0.4/data/test/bad/README.txt --- jasper-2.0.33/data/test/bad/README.txt 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/data/test/bad/README.txt 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,3 @@ +This directory contains numerous image files whose contents correspond +to invalid (i.e., corrupt) image data. These files are useful for +testing purposes. diff -Nru jasper-2.0.33/data/test/good/README jasper-3.0.4/data/test/good/README --- jasper-2.0.33/data/test/good/README 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/data/test/good/README 1970-01-01 00:00:00.000000000 +0000 @@ -1,3 +0,0 @@ -This directory contains numerous image files whose contents correspond -to valid image data, although in some cases the image data may be bizarre -(e.g., an image with zero components). diff -Nru jasper-2.0.33/data/test/good/README.txt jasper-3.0.4/data/test/good/README.txt --- jasper-2.0.33/data/test/good/README.txt 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/data/test/good/README.txt 2022-06-03 04:10:20.000000000 +0000 @@ -0,0 +1,3 @@ +This directory contains numerous image files whose contents correspond +to valid image data, although in some cases the image data may be bizarre +(e.g., an image with zero components). Binary files /tmp/tmp6x855cg9/_kRq9Ov68F/jasper-2.0.33/data/test/other/pr325-bad-icc-profile.jp2 and /tmp/tmp6x855cg9/JmVMT9nr8O/jasper-3.0.4/data/test/other/pr325-bad-icc-profile.jp2 differ diff -Nru jasper-2.0.33/debian/changelog jasper-3.0.4/debian/changelog --- jasper-2.0.33/debian/changelog 2021-09-19 19:11:46.000000000 +0000 +++ jasper-3.0.4/debian/changelog 2022-06-08 19:47:14.000000000 +0000 @@ -1,3 +1,15 @@ +jasper (3.0.4-0ubuntu1~20.04.sav0) focal; urgency=medium + + * New upstream release + * SONAME bump: libjasper4 -> libjasper6 + * d/control: Bump to cmake (>= 3.12) BD as per updated CMakeLists.txt + - Add libheif-dev BD for new experimental HEIF/HEIC support + * d/libjasper-doc.{doc-base,docs}: Drop jasper.pdf and README (upstream) + * d/rules: Drop removed JAS_ENABLE_AUTOMATIC_DEPENDENCIES config + - Update NEWS -> NEWS.txt for dh_installchangelogs (upstream) + + -- Rob Savoury Wed, 08 Jun 2022 12:47:14 -0700 + jasper (2.0.33-0ubuntu1~20.04.sav0) focal; urgency=medium * New upstream release (fix a JP2/JPC decoder bug) diff -Nru jasper-2.0.33/debian/control jasper-3.0.4/debian/control --- jasper-2.0.33/debian/control 2020-12-12 19:51:36.000000000 +0000 +++ jasper-3.0.4/debian/control 2022-06-08 16:08:20.000000000 +0000 @@ -6,16 +6,17 @@ XSBC-Original-Maintainer: Roland Stigge Build-Depends: debhelper-compat (= 10), - cmake (>= 2.8.11), + cmake (>= 3.12), doxygen, freeglut3-dev, + libheif-dev, libjpeg-dev, libxi-dev, libxmu-dev, libxt-dev Standards-Version: 3.9.5 -Package: libjasper4 +Package: libjasper6 Section: libs Architecture: any Multi-Arch: same @@ -36,7 +37,7 @@ Section: libdevel Architecture: any Depends: - libjasper4 (= ${binary:Version}), + libjasper6 (= ${binary:Version}), ${misc:Depends} Conflicts: libjasper-1.700-2-dev Replaces: libjasper-1.700-2-dev diff -Nru jasper-2.0.33/debian/libjasper4.install jasper-3.0.4/debian/libjasper4.install --- jasper-2.0.33/debian/libjasper4.install 2020-09-27 15:53:01.000000000 +0000 +++ jasper-3.0.4/debian/libjasper4.install 1970-01-01 00:00:00.000000000 +0000 @@ -1 +0,0 @@ -usr/lib/*/libjasper.so.* diff -Nru jasper-2.0.33/debian/libjasper6.install jasper-3.0.4/debian/libjasper6.install --- jasper-2.0.33/debian/libjasper6.install 1970-01-01 00:00:00.000000000 +0000 +++ jasper-3.0.4/debian/libjasper6.install 2020-09-27 15:53:01.000000000 +0000 @@ -0,0 +1 @@ +usr/lib/*/libjasper.so.* diff -Nru jasper-2.0.33/debian/libjasper-doc.doc-base jasper-3.0.4/debian/libjasper-doc.doc-base --- jasper-2.0.33/debian/libjasper-doc.doc-base 2020-09-27 15:52:57.000000000 +0000 +++ jasper-3.0.4/debian/libjasper-doc.doc-base 2022-06-08 15:50:48.000000000 +0000 @@ -4,7 +4,6 @@ Section: Graphics Format: PDF -Files: /usr/share/doc/libjasper-doc/jasper.pdf.gz Files: /usr/share/doc/libjasper-doc/jpeg2000.pdf.gz Format: HTML diff -Nru jasper-2.0.33/debian/libjasper-doc.docs jasper-3.0.4/debian/libjasper-doc.docs --- jasper-2.0.33/debian/libjasper-doc.docs 2020-09-27 15:52:54.000000000 +0000 +++ jasper-3.0.4/debian/libjasper-doc.docs 2022-06-08 15:50:51.000000000 +0000 @@ -1,4 +1,2 @@ -doc/jasper.pdf doc/jpeg2000.pdf -doc/README debian/tmp/usr/share/doc/JasPer/html diff -Nru jasper-2.0.33/debian/rules jasper-3.0.4/debian/rules --- jasper-2.0.33/debian/rules 2020-10-11 01:37:47.000000000 +0000 +++ jasper-3.0.4/debian/rules 2022-06-08 19:46:44.000000000 +0000 @@ -9,8 +9,7 @@ CMAKE_COMMON := -DCMAKE_INSTALL_PREFIX=/usr \ -DCMAKE_BUILD_TYPE=Release \ - -DCMAKE_SKIP_RPATH=ON \ - -DJAS_ENABLE_AUTOMATIC_DEPENDENCIES=OFF + -DCMAKE_SKIP_RPATH=ON CMAKE_shared = ON CMAKE_static = OFF @@ -41,4 +40,4 @@ dh_auto_install -O--buildsystem=cmake --builddirectory=build/$* --destdir=debian/tmp override_dh_installchangelogs: - dh_installchangelogs NEWS + dh_installchangelogs NEWS.txt diff -Nru jasper-2.0.33/doc/CMakeLists.txt jasper-3.0.4/doc/CMakeLists.txt --- jasper-2.0.33/doc/CMakeLists.txt 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/doc/CMakeLists.txt 2022-06-03 04:10:20.000000000 +0000 @@ -1,68 +1,70 @@ find_package(Doxygen) -find_package(LATEX COMPONENTS PDFLATEX) +if(JAS_ENABLE_LATEX) + find_package(LATEX COMPONENTS PDFLATEX) +else() + set(LATEX_FOUND 0) +endif() # On some (or maybe all?) systems, LATEX_FOUND is not set by FindLATEX. # So, instead, rely on LATEX_PDFLATEX_FOUND. message("PDFLATEX_COMPILER: ${PDFLATEX_COMPILER}") -if ((NOT LATEX_FOUND) AND PDFLATEX_COMPILER) - message(WARNING "Setting LATEX_FOUND to true.") +if((NOT LATEX_FOUND) AND PDFLATEX_COMPILER) + message(WARNING "Setting LATEX_FOUND to TRUE.") message(WARNING "Your version of CMake may be buggy.") - set(LATEX_FOUND true) + set(LATEX_FOUND TRUE) endif() message("LATEX_FOUND ${LATEX_FOUND}") -if (DOXYGEN_FOUND) - +if(DOXYGEN_FOUND) configure_file("${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in" "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile" @ONLY) - configure_file("${CMAKE_CURRENT_SOURCE_DIR}/src/mainpage.dox.in" - "${CMAKE_CURRENT_BINARY_DIR}/src/mainpage.dox" @ONLY) - configure_file("${CMAKE_CURRENT_SOURCE_DIR}/src/getting_started.dox.in" - "${CMAKE_CURRENT_BINARY_DIR}/src/getting_started.dox" @ONLY) + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/src/overview.dox.in" + "${CMAKE_CURRENT_BINARY_DIR}/src/overview.dox" @ONLY) + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/src/install.dox.in" + "${CMAKE_CURRENT_BINARY_DIR}/src/install.dox" @ONLY) + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/src/license.dox.in" + "${CMAKE_CURRENT_BINARY_DIR}/src/license.dox" @ONLY) file(GLOB_RECURSE DOXYGEN_DEPENDS "${CMAKE_SOURCE_DIR}/*.[ch]") add_custom_command(OUTPUT "html/index.html" "latex/index.tex" - COMMAND ${DOXYGEN_EXECUTABLE} "Doxyfile" - BYPRODUCTS "html" "latex" - WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}" - MAIN_DEPENDENCY "Doxyfile" - DEPENDS "${DOXYGEN_DEPENDS}" - COMMENT "Generating API documentation with Doxygen" VERBATIM + COMMAND ${DOXYGEN_EXECUTABLE} "Doxyfile" + BYPRODUCTS "html" "latex" + WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}" + MAIN_DEPENDENCY "Doxyfile" + DEPENDS "${DOXYGEN_DEPENDS}" + COMMENT "Generating API documentation with Doxygen" VERBATIM ) add_custom_target(doc ALL DEPENDS "html/index.html" ) - if (LATEX_FOUND) + if(LATEX_FOUND) add_custom_command(OUTPUT "latex/refman.pdf" COMMAND "${PDFLATEX_COMPILER}" refman.tex - COMMAND "${PDFLATEX_COMPILER}" refman.tex - COMMAND "${PDFLATEX_COMPILER}" refman.tex - COMMAND "${PDFLATEX_COMPILER}" refman.tex WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/latex" DEPENDS "latex/index.tex" ) add_custom_target(manual_pdf ALL - DEPENDS "latex/refman.pdf" + DEPENDS "latex/refman.pdf" ) endif() - set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_CLEAN_FILES "html" "latex") + set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_CLEAN_FILES + "html" "latex") # Install the HTML version of the manual. install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html" DESTINATION "${CMAKE_INSTALL_DOCDIR}") # Install the PDF version of the manual built from LaTeX. - if (LATEX_FOUND) + if(LATEX_FOUND) install(FILES "${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf" DESTINATION "${CMAKE_INSTALL_DOCDIR}" RENAME manual.pdf) endif() endif() -# Install papers and technical reports. -install(FILES "jasper.pdf" "jpeg2000.pdf" - DESTINATION "${CMAKE_INSTALL_DOCDIR}") +# Install JPEG-2000 tutorial paper. +install(FILES jpeg2000.pdf DESTINATION "${CMAKE_INSTALL_DOCDIR}") diff -Nru jasper-2.0.33/doc/Doxyfile.in jasper-3.0.4/doc/Doxyfile.in --- jasper-2.0.33/doc/Doxyfile.in 2021-08-01 20:50:31.000000000 +0000 +++ jasper-3.0.4/doc/Doxyfile.in 2022-06-03 04:10:20.000000000 +0000 @@ -1,110 +1,137 @@ -# Doxyfile 1.8.1.1 +# Doxyfile 1.9.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored. +# 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 (" "). +# 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 +# This tag specifies the encoding used for all characters in the configuration +# 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. +# https://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 sequence of words) that should -# identify the project. Note that if you do not use Doxywizard you need -# to put quotes around the project name if it contains spaces. - -PROJECT_NAME = "@CMAKE_PROJECT_NAME@" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. +# 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 = @CMAKE_PROJECT_NAME@ + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. PROJECT_NUMBER = @JAS_VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. +# 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 an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. +# 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) -# base path where the generated documentation will be put. -# 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. +# 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 cause performance problems for the file system. +# 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. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# 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 (the default) 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 OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# 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 (the default) 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 +# 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" "the" +# 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 = YES # 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 +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = YES @@ -112,569 +139,792 @@ # 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 = YES -# If the FULL_PATH_NAMES tag is set to YES then 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. +# 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 = NO -# If the FULL_PATH_NAMES tag is set to YES then 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. +# 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 = @CMAKE_SOURCE_DIR@/src -# 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 include paths that -# are normally passed to the compiler using the -I flag. +# 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 if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. +# 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 -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# 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 comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = 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 behaviour. -# 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 behaviour instead. +# 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 (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# 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. +# 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. +# 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 = 8 -# This tag can be used to specify a number of aliases that acts -# 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. +# 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 (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) 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. +# 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. + +## 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 = OPTIMIZE_OUTPUT_FOR_C = NO -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# 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 only. Doxygen will then generate output that is more tailored for -# 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. +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = 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, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. 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 that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. +# 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, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# 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). 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. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. EXTENSION_MAPPING = -# If MARKDOWN_SUPPORT is enabled (the default) 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. +# 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 https://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: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# 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); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration +# 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 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. +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/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 (the default) -# will make doxygen 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. +# 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 +# tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. +# The default value is: NO. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) 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. +# 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). +# 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 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 (the default), -# structs, classes, and unions are shown on a separate page (for HTML and Man -# pages) or section (for LaTeX and RTF). +# 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 is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So +# 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 +# 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 -# Similar to the SYMBOL_CACHE_SIZE 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 appear 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. +# 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 +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which efficively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + #--------------------------------------------------------------------------- # 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 and EXTRACT_STATIC tags are set to YES +# 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. +# 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. +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = 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. - -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. +# 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 = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. +# 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 namespaces are hidden. +# '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 of documented classes, files or namespaces. -# If set to NO (the default) 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. +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# 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 = YES -# 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 (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# 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 = YES -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# 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 (the default) these blocks will be appended to the -# function's detailed documentation block. +# 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 (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# 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. +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# 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 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. +# 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 (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# 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 (the default) 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. +# 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 documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# 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 default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to 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 default) -# the group names will appear in their defined order. +# 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 default), the class list will be sorted only by class name, -# not including the namespace part. +# 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. +# 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. +# 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 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 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 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 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 sectionname ... \endif. +# 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 -# the initial value of a variable or macro consists of 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 initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# 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 +# 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 is 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 is 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 , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. +# 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. +# 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 references data. This must be a list of .bib files. The -# .bib extension is automatically appended if omitted. Using this command -# 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. +# 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 https://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 = +CITE_BIB_FILES = @CMAKE_SOURCE_DIR@/doc/src/references.bib #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# 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 by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# 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 WARN_IF_UNDOCUMENTED 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. +# 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 WARN_IF_DOC_ERROR 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. +# 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 -# The 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 (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# 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. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. WARN_NO_PARAMDOC = NO -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# 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 stderr. +# 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 +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be 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. - -INPUT = \ - @CMAKE_BINARY_DIR@/doc/src/mainpage.dox \ - @CMAKE_BINARY_DIR@/doc/src/getting_started.dox \ - @CMAKE_SOURCE_DIR@/doc/src/faq.dox \ +# 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 = @CMAKE_BINARY_DIR@/doc/src/overview.dox \ + @CMAKE_BINARY_DIR@/doc/src/license.dox \ + @CMAKE_SOURCE_DIR@/doc/src/intro.dox \ + @CMAKE_BINARY_DIR@/doc/src/install.dox \ + @CMAKE_SOURCE_DIR@/doc/src/lib.dox \ + @CMAKE_SOURCE_DIR@/doc/src/lib_init.dox \ + @CMAKE_SOURCE_DIR@/doc/src/lib_images.dox \ + @CMAKE_SOURCE_DIR@/doc/src/lib_iostreams.dox \ + @CMAKE_SOURCE_DIR@/doc/src/lib_log.dox \ + @CMAKE_SOURCE_DIR@/doc/src/lib_threads.dox \ + @CMAKE_SOURCE_DIR@/doc/src/lib_math.dox \ + @CMAKE_SOURCE_DIR@/doc/src/lib_string.dox \ + @CMAKE_SOURCE_DIR@/doc/src/lib_timers.dox \ + @CMAKE_SOURCE_DIR@/doc/src/lib_misc.dox \ + @CMAKE_SOURCE_DIR@/doc/src/apps.dox \ + @CMAKE_SOURCE_DIR@/doc/src/apps_jasper.dox \ + @CMAKE_SOURCE_DIR@/doc/src/apps_imgcmp.dox \ + @CMAKE_SOURCE_DIR@/doc/src/apps_imginfo.dox \ + @CMAKE_SOURCE_DIR@/doc/src/apps_jiv.dox \ + @CMAKE_SOURCE_DIR@/doc/src/codecs.dox \ @CMAKE_SOURCE_DIR@/doc/src/bugs.dox \ @CMAKE_SOURCE_DIR@/doc/src/modules.dox \ @CMAKE_SOURCE_DIR@/src # This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. 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. +# 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: +# https://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 pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl +# 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. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# 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 (to be provided as doxygen C comment), +# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, +# *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.h \ *.c -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. +# 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 = YES # 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. @@ -683,14 +933,16 @@ # 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/* +# 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 = @@ -699,745 +951,1225 @@ # 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). +# 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 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. -# Possible values are YES and NO. If left blank NO is used. +# 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 image that are included in the documentation (see -# the \image command). +# 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 = +IMAGE_PATH = @CMAKE_SOURCE_DIR@/doc/src/figures_generated # 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. +# 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 -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. +# 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 be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# 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 option only has effect when -# FILTER_SOURCE_FILES is enabled. +# 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 +# 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 also -# VERBATIM_HEADERS is set to NO. +# 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 and classes directly in the documentation. +# 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 (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C, C++ and Fortran comments will always remain visible. +# 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. +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity 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. +# 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 (the default) -# 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. +# 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 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. +# 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 https://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 configuration 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 to YES (the default) 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. +# 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. +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to +# YES then doxygen will add the directory of each input to the include path. +# The default value is: YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# 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 = NO -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -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 one or more prefixes that -# should be ignored while generating the index headers. +# 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 +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate 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. If left blank `html' will be used as the default path. +# 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). If it is left blank -# doxygen will generate files with .html extension. +# 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 personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is advised to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# have to redo this when upgrading to a newer version of doxygen or when -# changing the value of configuration settings such as GENERATE_TREEVIEW! +# 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 personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. +# 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 the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# style sheet in the HTML output directory as well, or it will be erased! +# 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. +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the style sheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. +# 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 +# https://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. +# 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. +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. +# 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_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of -# entries shown in the various tree structured indices initially; the user -# can expand and collapse entries dynamically later on. Doxygen will expand -# the tree to such a level that at most the specified number of entries are -# visible (unless a fully collapsed tree already exceeds this amount). -# So setting the number of entries 1 will produce a full collapsed tree by -# default. 0 is a special value representing an infinite number of entries -# and will result in a full expanded tree by default. +# 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, 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. +# 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: +# https://developer.apple.com/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 https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# 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. +# 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" -# When GENERATE_DOCSET tag is set to YES, 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. +# 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 -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# 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 GENERATE_PUBLISHER_NAME tag identifies the documentation 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, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# 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: +# https://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 -# If the GENERATE_HTMLHELP tag is set to YES, 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 +# 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 = -# If the GENERATE_HTMLHELP tag is set to YES, 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 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 = -# If the GENERATE_HTMLHELP tag is set to YES, 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 GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# 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 = -# If the GENERATE_HTMLHELP tag is set to YES, 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. +# 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 contents of the HTML help documentation and to the tree view. +# 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. +# 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. +# 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 -# http://doc.trolltech.com/qthelpproject.html#namespace +# 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: +# https://doc.qt.io/archives/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 = -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# 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: +# https://doc.qt.io/archives/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 QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# 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: +# https://doc.qt.io/archives/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_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. +# 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: +# https://doc.qt.io/archives/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. +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, 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. +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) 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, which together with the HTML files, 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. +# 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. +# 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 -# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) -# at top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. Since the tabs have the same information as the -# navigation tree you can set this option to NO if you already set -# GENERATE_TREEVIEW to YES. +# 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 DISABLE_INDEX = YES # 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. -# Since the tree basically has the same information as the tab index you -# could consider to set DISABLE_INDEX to NO when enabling this option. +# 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 GENERATE_TREEVIEW = YES -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values -# (range [0,1..20]) 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. +# 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. +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. +# 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. The default is 10. Note that -# 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. +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# 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 before the changes have effect. +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you may also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://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 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. +# 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/v2.7-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 https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# 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 MathJax extension -# names that should be enabled during MathJax rendering. +# 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 = -# 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. +# 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/v2.7-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 +# , /