├── .github └── workflows │ ├── presubmit.yml │ └── release.yml ├── .gitignore ├── .gitmodules ├── CMakeLists.txt ├── CODE_OF_CONDUCT.md ├── LICENSE.txt ├── OpenCL-CLHPP.pc.in ├── README.md ├── cmake ├── DebSourcePkg.cmake ├── JoinPaths.cmake ├── Package.cmake └── PackageSetup.cmake ├── docs ├── CMakeLists.txt └── Doxyfile.in ├── examples ├── CMakeLists.txt └── src │ ├── CMakeLists.txt │ ├── headerexample.cpp │ ├── trivial.cpp │ └── trivialSizeTCompat.cpp ├── include └── CL │ ├── cl2.hpp │ └── opencl.hpp └── tests ├── CMakeLists.txt ├── ToAdd.txt ├── cmock.yml ├── pkgconfig ├── bare │ └── CMakeLists.txt ├── pkgconfig.cpp └── sdk │ └── CMakeLists.txt ├── strip_defines.cmake ├── test_openclhpp.cpp └── test_versions.cpp /.github/workflows/presubmit.yml: -------------------------------------------------------------------------------- 1 | name: Presubmit 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | linux: 7 | runs-on: ubuntu-latest 8 | defaults: 9 | run: 10 | shell: bash 11 | strategy: 12 | matrix: 13 | CMAKE: [3.26.4] 14 | COMPILER: 15 | - C_NAME: gcc 16 | CXX_NAME: g++ 17 | VER: 11 18 | - C_NAME: gcc 19 | CXX_NAME: g++ 20 | VER: 13 21 | - C_NAME: clang 22 | CXX_NAME: clang++ 23 | VER: 14 24 | - C_NAME: clang 25 | CXX_NAME: clang++ 26 | VER: 16 27 | BIN: [64] 28 | CXXSTD: [11, 17] 29 | CONF: 30 | - GEN: Unix Makefiles 31 | CONFIG: Debug 32 | - GEN: Unix Makefiles 33 | CONFIG: Release 34 | - GEN: Ninja Multi-Config 35 | CONFIG: Release 36 | IMAGE: 37 | - khronosgroup/docker-images:opencl-sdk-base-ubuntu-22.04.20230717 38 | include: 39 | - CMAKE: system 40 | COMPILER: 41 | C_NAME: gcc 42 | CXX_NAME: g++ 43 | VER: 9 44 | BIN: 64 45 | CXXSTD: 11 46 | CONF: 47 | GEN: Unix Makefiles 48 | CONFIG: Debug 49 | IMAGE: khronosgroup/docker-images:opencl-sdk-base-ubuntu-20.04.20230717 50 | - CMAKE: system 51 | COMPILER: 52 | C_NAME: gcc 53 | CXX_NAME: g++ 54 | VER: 9 55 | BIN: 64 56 | CXXSTD: 11 57 | CONF: 58 | GEN: Unix Makefiles 59 | CONFIG: Release 60 | IMAGE: khronosgroup/docker-images:opencl-sdk-base-ubuntu-20.04.20230717 61 | - CMAKE: system 62 | COMPILER: 63 | C_NAME: gcc 64 | CXX_NAME: g++ 65 | VER: 9 66 | BIN: 32 67 | CXXSTD: 11 68 | CONF: 69 | GEN: Unix Makefiles 70 | CONFIG: Debug 71 | IMAGE: khronosgroup/docker-images:opencl-sdk-base-ubuntu-20.04.20230717 72 | - CMAKE: system 73 | COMPILER: 74 | C_NAME: gcc 75 | CXX_NAME: g++ 76 | VER: 9 77 | BIN: 32 78 | CXXSTD: 11 79 | CONF: 80 | GEN: Unix Makefiles 81 | CONFIG: Release 82 | IMAGE: khronosgroup/docker-images:opencl-sdk-base-ubuntu-20.04.20230717 83 | container: ${{matrix.IMAGE}} 84 | env: 85 | CMAKE_EXE: /opt/Kitware/CMake/${{ matrix.CMAKE }}/bin/cmake 86 | CPACK_EXE: /opt/Kitware/CMake/${{ matrix.CMAKE }}/bin/cpack 87 | CTEST_EXE: /opt/Kitware/CMake/${{ matrix.CMAKE }}/bin/ctest 88 | DEB_INSTALLATION_PATH: /usr 89 | CC: ${{matrix.COMPILER.C_NAME}}-${{matrix.COMPILER.VER}} 90 | CXX: ${{matrix.COMPILER.CXX_NAME}}-${{matrix.COMPILER.VER}} 91 | CFLAGS: -Wall -Wextra -pedantic -Werror -m${{matrix.BIN}} 92 | CXXFLAGS: -Wall -Wextra -pedantic -Werror -m${{matrix.BIN}} 93 | 94 | steps: 95 | - name: Install system CMake 96 | if: ${{matrix.CMAKE}} == 'system' 97 | run: apt-get update -qq && apt-get install -y cmake && 98 | echo "CMAKE_EXE=cmake" >> "$GITHUB_ENV" && 99 | echo "CPACK_EXE=cpack" >> "$GITHUB_ENV" && 100 | echo "CTEST_EXE=ctest" >> "$GITHUB_ENV" 101 | 102 | - name: Checkout OpenCL-CLHPP 103 | uses: actions/checkout@v4 104 | with: 105 | submodules: recursive 106 | 107 | - name: Checkout OpenCL-Headers 108 | uses: actions/checkout@v4 109 | with: 110 | path: external/OpenCL-Headers 111 | repository: KhronosGroup/OpenCL-Headers 112 | 113 | - name: Checkout OpenCL-ICD-Loader 114 | uses: actions/checkout@v4 115 | with: 116 | path: external/OpenCL-ICD-Loader 117 | repository: KhronosGroup/OpenCL-ICD-Loader 118 | 119 | - name: Configure, install & package OpenCL-Headers 120 | run: $CMAKE_EXE 121 | -G "${{matrix.CONF.GEN}}" 122 | `if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; then echo "-D CMAKE_BUILD_TYPE=${{matrix.CONF.CONFIG}}"; fi` 123 | -D CMAKE_C_EXTENSIONS=OFF 124 | -D CMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/external/OpenCL-Headers/install 125 | -D CPACK_PACKAGING_INSTALL_PREFIX=$DEB_INSTALLATION_PATH 126 | -D BUILD_TESTING=OFF 127 | -S $GITHUB_WORKSPACE/external/OpenCL-Headers 128 | -B $GITHUB_WORKSPACE/external/OpenCL-Headers/build && 129 | $CMAKE_EXE 130 | --build $GITHUB_WORKSPACE/external/OpenCL-Headers/build 131 | --target install 132 | --parallel `nproc` && 133 | $CPACK_EXE 134 | --config "$GITHUB_WORKSPACE/external/OpenCL-Headers/build/CPackConfig.cmake" 135 | -G DEB 136 | -C ${{matrix.CONF.CONFIG}} 137 | -B "$GITHUB_WORKSPACE/external/OpenCL-Headers/package-deb" 138 | 139 | - name: Configure & install OpenCL-ICD-Loader 140 | run: $CMAKE_EXE 141 | -G "${{matrix.CONF.GEN}}" 142 | `if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; then echo "-D CMAKE_BUILD_TYPE=${{matrix.CONF.CONFIG}}"; fi` 143 | -D CMAKE_C_EXTENSIONS=OFF 144 | -D CMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install 145 | -D CMAKE_PREFIX_PATH=$GITHUB_WORKSPACE/external/OpenCL-Headers/install 146 | -D BUILD_TESTING=OFF 147 | -S $GITHUB_WORKSPACE/external/OpenCL-ICD-Loader 148 | -B $GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/build && 149 | $CMAKE_EXE 150 | --build $GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/build 151 | --target install 152 | --parallel `nproc` 153 | 154 | - name: Configure 155 | run: $CMAKE_EXE 156 | -G "${{matrix.CONF.GEN}}" 157 | -D BUILD_TESTING=ON 158 | -D BUILD_EXAMPLES=ON 159 | `if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; then echo "-D CMAKE_BUILD_TYPE=${{matrix.CONF.CONFIG}}"; fi` 160 | -D CMAKE_CXX_STANDARD=${{matrix.CXXSTD}} 161 | -D CMAKE_CXX_EXTENSIONS=OFF 162 | -D CMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/install 163 | -D CPACK_PACKAGING_INSTALL_PREFIX=$DEB_INSTALLATION_PATH 164 | -D CMAKE_PREFIX_PATH="$GITHUB_WORKSPACE/external/OpenCL-Headers/install;$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install" 165 | -S $GITHUB_WORKSPACE 166 | -B $GITHUB_WORKSPACE/build 167 | 168 | - name: Build 169 | run: if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; 170 | then 171 | $CMAKE_EXE --build $GITHUB_WORKSPACE/build --config ${{matrix.CONF.CONFIG}} --parallel `nproc`; 172 | else 173 | $CMAKE_EXE --build $GITHUB_WORKSPACE/build --config Debug; 174 | $CMAKE_EXE --build $GITHUB_WORKSPACE/build --config Release; 175 | fi 176 | 177 | - name: Test 178 | working-directory: ${{runner.workspace}}/OpenCL-CLHPP/build 179 | run: if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; 180 | then 181 | $CTEST_EXE --output-on-failure --no-tests=error --parallel `nproc`; 182 | else 183 | $CTEST_EXE --output-on-failure --no-tests=error -C Debug --parallel `nproc`; 184 | $CTEST_EXE --output-on-failure --no-tests=error -C Release --parallel `nproc`; 185 | fi 186 | 187 | - name: Package DEB 188 | run: $CPACK_EXE 189 | --config "$GITHUB_WORKSPACE/build/CPackConfig.cmake" 190 | -G DEB 191 | -C ${{matrix.CONF.CONFIG}} 192 | -B "$GITHUB_WORKSPACE/package-deb" 193 | 194 | - name: Consume (DEB) 195 | run: dpkg -i $GITHUB_WORKSPACE/external/OpenCL-Headers/package-deb/*.deb && 196 | dpkg -i $GITHUB_WORKSPACE/package-deb/*.deb && 197 | $CMAKE_EXE 198 | -G "${{matrix.CONF.GEN}}" 199 | `if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; then echo "-D CMAKE_BUILD_TYPE=${{matrix.CONF.CONFIG}}"; fi` 200 | -D CMAKE_CXX_STANDARD=${{matrix.CXXSTD}} 201 | -D CMAKE_CXX_EXTENSIONS=OFF 202 | -D CMAKE_PREFIX_PATH=$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install 203 | -S $GITHUB_WORKSPACE/tests/pkgconfig/bare 204 | -B $GITHUB_WORKSPACE/build_package && 205 | if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; 206 | then 207 | $CMAKE_EXE --build $GITHUB_WORKSPACE/build_package --config ${{matrix.CONF.CONFIG}} --parallel `nproc`; 208 | else 209 | $CMAKE_EXE --build $GITHUB_WORKSPACE/build_package --config Debug; 210 | $CMAKE_EXE --build $GITHUB_WORKSPACE/build_package --config Release; 211 | fi 212 | 213 | - name: Run consume test (DEB) 214 | if: matrix.BIN != 32 215 | working-directory: ${{runner.workspace}}/OpenCL-CLHPP/build_package 216 | run: if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; 217 | then 218 | $CTEST_EXE -C ${{matrix.CONF.CONFIG}} --output-on-failure --no-tests=error --parallel `nproc`; 219 | else 220 | $CTEST_EXE -C Debug --output-on-failure --no-tests=error --parallel `nproc`; 221 | $CTEST_EXE -C Release --output-on-failure --no-tests=error --parallel `nproc`; 222 | fi 223 | 224 | - name: Test pkg-config (DEB) 225 | # /usr/include is already on the include search path, 226 | # we don't expect any output 227 | run: | 228 | # First check if OpenCL-Headers is locatable 229 | pkg-config OpenCL-CLHPP --cflags 230 | # Then check if the output is empty 231 | if [[ "$(pkg-config OpenCL-CLHPP --cflags)" ]]; 232 | then 233 | exit 1; 234 | fi; 235 | 236 | - name: Uninstall (DEB) 237 | run: apt-get remove -y opencl-c-headers opencl-clhpp-headers 238 | 239 | - name: Test install 240 | run: $CMAKE_EXE --build $GITHUB_WORKSPACE/build --target install --config ${{matrix.CONF.CONFIG}} --parallel `nproc` 241 | 242 | - name: Consume (install) 243 | run: $CMAKE_EXE 244 | -G "${{matrix.CONF.GEN}}" 245 | `if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; then echo "-D CMAKE_BUILD_TYPE=${{matrix.CONF.CONFIG}}"; fi` 246 | -D CMAKE_PREFIX_PATH="$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install;$GITHUB_WORKSPACE/external/OpenCL-Headers/install;$GITHUB_WORKSPACE/install" 247 | -S $GITHUB_WORKSPACE/tests/pkgconfig/bare 248 | -B $GITHUB_WORKSPACE/build_install && 249 | if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; 250 | then 251 | $CMAKE_EXE --build $GITHUB_WORKSPACE/build_install --parallel `nproc`; 252 | else 253 | $CMAKE_EXE --build $GITHUB_WORKSPACE/build_install --config Debug; 254 | $CMAKE_EXE --build $GITHUB_WORKSPACE/build_install --config Release; 255 | fi 256 | 257 | - name: Run consume test (install) 258 | if: matrix.BIN != 32 259 | working-directory: ${{runner.workspace}}/OpenCL-CLHPP/build_install 260 | run: if [[ "${{matrix.CONF.GEN}}" == "Unix Makefiles" ]]; 261 | then 262 | $CTEST_EXE -C ${{matrix.CONF.CONFIG}} --output-on-failure --no-tests=error --parallel `nproc`; 263 | else 264 | $CTEST_EXE -C Debug --output-on-failure --no-tests=error --parallel `nproc`; 265 | $CTEST_EXE -C Release --output-on-failure --no-tests=error --parallel `nproc`; 266 | fi 267 | 268 | - name: Test pkg-config (install) 269 | run: PKG_CONFIG_PATH=$GITHUB_WORKSPACE/install/share/pkgconfig:$GITHUB_WORKSPACE/external/OpenCL-Headers/install/share/pkgconfig 270 | pkg-config OpenCL-CLHPP --cflags | grep -q "\-I$GITHUB_WORKSPACE/install/include" 271 | 272 | windows: 273 | runs-on: windows-latest 274 | defaults: 275 | run: 276 | shell: pwsh 277 | strategy: 278 | matrix: 279 | VER: [v142, v143, clangcl] 280 | GEN: [Visual Studio 17 2022, Ninja Multi-Config] 281 | BIN: [x64] 282 | CXXSTD: [11, 17] 283 | exclude: 284 | - VER: clangcl 285 | GEN: Ninja Multi-Config 286 | include: 287 | - VER: v142 288 | GEN: Visual Studio 17 2022 289 | BIN: x86 290 | CXXSTD: 11 291 | env: 292 | NINJA_URL: https://github.com/ninja-build/ninja/releases/download/v1.10.2/ninja-win.zip 293 | NINJA_ROOT: C:\Tools\Ninja 294 | VS_ROOT: 'C:\Program Files\Microsoft Visual Studio\2022\Enterprise' 295 | UseMultiToolTask: true # Better parallel MSBuild execution 296 | EnforceProcessCountAcrossBuilds: 'true' # -=- 297 | MultiProcMaxCount: '3' # -=- 298 | # C4152: nonstandard extension, function/data pointer conversion in expression 299 | # C4201: nonstandard extension used: nameless struct/union 300 | # C4310: cast truncates constant value 301 | CFLAGS: /W4 /WX /wd4152 /wd4201 /wd4310 302 | CXXFLAGS: /W4 /WX 303 | 304 | steps: 305 | - name: Cache Ninja install 306 | if: matrix.GEN == 'Ninja Multi-Config' 307 | id: ninja-install 308 | uses: actions/cache@v4 309 | with: 310 | path: | 311 | C:\Tools\Ninja 312 | key: ${{runner.os}}-ninja-${{env.NINJA_URL}} 313 | 314 | - name: Install Ninja 315 | if: matrix.GEN == 'Ninja Multi-Config' && steps.ninja-install.outputs.cache-hit != 'true' 316 | run: | 317 | Invoke-WebRequest ${env:NINJA_URL} -OutFile ~\Downloads\ninja-win.zip 318 | Expand-Archive ~\Downloads\ninja-win.zip -DestinationPath ${env:NINJA_ROOT}\ 319 | Remove-Item ~\Downloads\* 320 | 321 | - name: Checkout OpenCL-CLHPP 322 | uses: actions/checkout@v4 323 | with: 324 | submodules: recursive 325 | 326 | - name: Checkout OpenCL-Headers 327 | uses: actions/checkout@v4 328 | with: 329 | repository: KhronosGroup/OpenCL-Headers 330 | path: external/OpenCL-Headers 331 | 332 | - name: Checkout OpenCL-ICD-Loader 333 | uses: actions/checkout@v4 334 | with: 335 | repository: KhronosGroup/OpenCL-ICD-Loader 336 | path: external/OpenCL-ICD-Loader 337 | 338 | - name: Build & install OpenCL-Headers (MSBuild) 339 | if: matrix.GEN == 'Visual Studio 17 2022' 340 | run: | 341 | $BIN = if('${{matrix.BIN}}' -eq 'x86') {'Win32'} else {'x64'} 342 | & cmake ` 343 | -G '${{matrix.GEN}}' ` 344 | -A $BIN ` 345 | -T ${{matrix.VER}} ` 346 | -D BUILD_TESTING=OFF ` 347 | -D CMAKE_INSTALL_PREFIX=${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\install ` 348 | -S ${env:GITHUB_WORKSPACE}\external\OpenCL-Headers ` 349 | -B ${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\build 350 | if ($LASTEXITCODE -ne 0) { throw "Configuring OpenCL-Headers failed." } 351 | & cmake ` 352 | --build "${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\build" ` 353 | --target install ` 354 | --config Release ` 355 | -- ` 356 | /verbosity:minimal ` 357 | /maxCpuCount ` 358 | /noLogo 359 | if ($LASTEXITCODE -ne 0) { throw "Building OpenCL-Headers failed." } 360 | 361 | - name: Build & install OpenCL-Headers (Ninja Multi-Config) 362 | if: matrix.GEN == 'Ninja Multi-Config' 363 | run: | 364 | $VER = switch ('${{matrix.VER}}') { ` 365 | 'v142' {'14.2'} ` 366 | 'v143' {'14.4'} } 367 | Import-Module "${env:VS_ROOT}\Common7\Tools\Microsoft.VisualStudio.DevShell.dll" 368 | Enter-VsDevShell -VsInstallPath ${env:VS_ROOT} -SkipAutomaticLocation -DevCmdArguments "-host_arch=x64 -arch=${{matrix.BIN}} -vcvars_ver=$VER" 369 | & cmake ` 370 | -G '${{matrix.GEN}}' ` 371 | -D CMAKE_MAKE_PROGRAM="${env:NINJA_ROOT}\ninja.exe" ` 372 | -D BUILD_TESTING=OFF ` 373 | -D CMAKE_INSTALL_PREFIX=${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\install ` 374 | -S ${env:GITHUB_WORKSPACE}\external\OpenCL-Headers ` 375 | -B ${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\build 376 | if ($LASTEXITCODE -ne 0) { throw "Configuring OpenCL-Headers failed." } 377 | & cmake ` 378 | --build "${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\build" ` 379 | --target install ` 380 | --config Release 381 | if ($LASTEXITCODE -ne 0) { throw "Building OpenCL-Headers failed." } 382 | 383 | - name: Build & install OpenCL-ICD-Loader (MSBuild) 384 | if: matrix.GEN == 'Visual Studio 17 2022' 385 | run: | 386 | $BIN = if('${{matrix.BIN}}' -eq 'x86') {'Win32'} else {'x64'} 387 | & cmake ` 388 | -G '${{matrix.GEN}}' ` 389 | -A $BIN ` 390 | -T ${{matrix.VER}} ` 391 | -D BUILD_TESTING=OFF ` 392 | -D CMAKE_INSTALL_PREFIX=${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\install ` 393 | -D CMAKE_PREFIX_PATH=${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\install ` 394 | -S ${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader ` 395 | -B ${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\build 396 | if ($LASTEXITCODE -ne 0) { throw "Configuring OpenCL-ICD-Loader failed." } 397 | & cmake ` 398 | --build "${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\build" ` 399 | --target install ` 400 | --config Release ` 401 | -- ` 402 | /verbosity:minimal ` 403 | /maxCpuCount ` 404 | /noLogo 405 | if ($LASTEXITCODE -ne 0) { throw "Building OpenCL-ICD-Loader failed." } 406 | 407 | - name: Build & install OpenCL-ICD-Loader (Ninja Multi-Config) 408 | if: matrix.GEN == 'Ninja Multi-Config' 409 | run: | 410 | $VER = switch ('${{matrix.VER}}') { ` 411 | 'v142' {'14.2'} ` 412 | 'v143' {'14.4'} } 413 | Import-Module "${env:VS_ROOT}\Common7\Tools\Microsoft.VisualStudio.DevShell.dll" 414 | Enter-VsDevShell -VsInstallPath ${env:VS_ROOT} -SkipAutomaticLocation -DevCmdArguments "-host_arch=x64 -arch=${{matrix.BIN}} -vcvars_ver=$VER" 415 | & cmake ` 416 | -G '${{matrix.GEN}}' ` 417 | -D CMAKE_MAKE_PROGRAM="${env:NINJA_ROOT}\ninja.exe" ` 418 | -D BUILD_TESTING=OFF ` 419 | -D CMAKE_INSTALL_PREFIX=${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\install ` 420 | -D CMAKE_PREFIX_PATH=${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\install ` 421 | -S ${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader ` 422 | -B ${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\build 423 | if ($LASTEXITCODE -ne 0) { throw "Configuring OpenCL-ICD-Loader failed." } 424 | & cmake ` 425 | --build "${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\build" ` 426 | --target install ` 427 | --config Release 428 | if ($LASTEXITCODE -ne 0) { throw "Building OpenCL-ICD-Loader failed." } 429 | 430 | - name: Configure (MSBuild) 431 | if: matrix.GEN == 'Visual Studio 17 2022' 432 | run: | 433 | $BIN = if('${{matrix.BIN}}' -eq 'x86') {'Win32'} else {'x64'} 434 | & cmake ` 435 | -G '${{matrix.GEN}}' ` 436 | -A $BIN ` 437 | -T ${{matrix.VER}} ` 438 | -D BUILD_TESTING=ON ` 439 | -D CMAKE_CXX_STANDARD=${{matrix.CXXSTD}} ` 440 | -D CMAKE_CXX_EXTENSIONS=OFF ` 441 | -D CMAKE_INSTALL_PREFIX=${env:GITHUB_WORKSPACE}\install ` 442 | -D CMAKE_PREFIX_PATH="${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\install;${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\install" ` 443 | -S ${env:GITHUB_WORKSPACE} ` 444 | -B ${env:GITHUB_WORKSPACE}\build 445 | if ($LASTEXITCODE -ne 0) { throw "Configuring OpenCL-CLHPP failed." } 446 | 447 | - name: Configure (Ninja Multi-Config) 448 | if: matrix.GEN == 'Ninja Multi-Config' 449 | run: | 450 | $VER = switch ('${{matrix.VER}}') { ` 451 | 'v142' {'14.2'} ` 452 | 'v143' {'14.4'} } 453 | Import-Module "${env:VS_ROOT}\Common7\Tools\Microsoft.VisualStudio.DevShell.dll" 454 | Enter-VsDevShell -VsInstallPath ${env:VS_ROOT} -SkipAutomaticLocation -DevCmdArguments "-host_arch=x64 -arch=${{matrix.BIN}} -vcvars_ver=$VER" 455 | & cmake ` 456 | -G '${{matrix.GEN}}' ` 457 | -D CMAKE_MAKE_PROGRAM="${env:NINJA_ROOT}\ninja.exe" ` 458 | -D BUILD_TESTING=ON ` 459 | -D CMAKE_CXX_STANDARD=${{matrix.CXXSTD}} ` 460 | -D CMAKE_CXX_EXTENSIONS=OFF ` 461 | -D CMAKE_EXE_LINKER_FLAGS=/INCREMENTAL ` 462 | -D CMAKE_INSTALL_PREFIX=${env:GITHUB_WORKSPACE}\install ` 463 | -D CMAKE_PREFIX_PATH="${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\install;${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\install" ` 464 | -S ${env:GITHUB_WORKSPACE} ` 465 | -B ${env:GITHUB_WORKSPACE}\build 466 | if ($LASTEXITCODE -ne 0) { throw "Configuring OpenCL-CLHPP failed." } 467 | 468 | - name: Build (MSBuild) 469 | if: matrix.GEN == 'Visual Studio 17 2022' 470 | run: | 471 | foreach ($Config in 'Release','Debug') { 472 | & cmake ` 473 | --build "${env:GITHUB_WORKSPACE}\build" ` 474 | --config ${Config} ` 475 | -- ` 476 | /verbosity:minimal ` 477 | /maxCpuCount ` 478 | /noLogo 479 | if ($LASTEXITCODE -ne 0) { throw "Building OpenCL-CLHPP in $Config failed." } 480 | } 481 | 482 | - name: Build (Ninja) 483 | if: matrix.GEN == 'Ninja Multi-Config' 484 | run: | 485 | $VER = switch ('${{matrix.VER}}') { ` 486 | 'v142' {'14.2'} ` 487 | 'v143' {'14.4'} } 488 | Import-Module "${env:VS_ROOT}\Common7\Tools\Microsoft.VisualStudio.DevShell.dll" 489 | Enter-VsDevShell -VsInstallPath ${env:VS_ROOT} -SkipAutomaticLocation -DevCmdArguments "-host_arch=x64 -arch=${{matrix.BIN}} -vcvars_ver=$VER" 490 | foreach ($Config in 'Release','Debug') { 491 | & cmake ` 492 | --build "${env:GITHUB_WORKSPACE}\build" ` 493 | --config ${Config} 494 | if ($LASTEXITCODE -ne 0) { throw "Building OpenCL-CLHPP in $Config failed." } 495 | } 496 | 497 | - name: Test 498 | run: | 499 | foreach ($Config in 'Release','Debug') { 500 | & ctest ` 501 | --test-dir "${env:GITHUB_WORKSPACE}\build" ` 502 | --build-config ${Config} ` 503 | --output-on-failure ` 504 | --no-tests=error ` 505 | --parallel ${env:NUMBER_OF_PROCESSORS} 506 | if ($LASTEXITCODE -ne 0) { throw "Testing OpenCL-CLHPP in $Config failed." } 507 | } 508 | 509 | - name: Install 510 | run: | 511 | & cmake ` 512 | --install "${env:GITHUB_WORKSPACE}\build" ` 513 | --prefix "${env:GITHUB_WORKSPACE}\install" ` 514 | --config Release 515 | if ($LASTEXITCODE -ne 0) { throw "Installing OpenCL-CLHPP failed." } 516 | 517 | - name: "Consume (MSBuild standalone): Configure/Build/Test" 518 | if: matrix.GEN == 'Visual Studio 17 2022' 519 | run: | 520 | $BIN = if('${{matrix.BIN}}' -eq 'x86') {'Win32'} else {'x64'} 521 | & cmake ` 522 | -G '${{matrix.GEN}}' ` 523 | -A ${BIN} ` 524 | -T ${{matrix.VER}} ` 525 | -D CMAKE_CXX_STANDARD=${{matrix.CXXSTD}} ` 526 | -D CMAKE_CXX_EXTENSIONS=OFF ` 527 | -D CMAKE_EXE_LINKER_FLAGS=/INCREMENTAL ` 528 | -D CMAKE_PREFIX_PATH="${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\install;${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\install;${env:GITHUB_WORKSPACE}\install" ` 529 | -S "${env:GITHUB_WORKSPACE}\tests\pkgconfig\bare" ` 530 | -B "${env:GITHUB_WORKSPACE}\downstream\pkgconfig\bare" 531 | if ($LASTEXITCODE -ne 0) { throw "Configuring OpenCL-CLHPP standalone consume test failed." } 532 | foreach ($Config in 'Release','Debug') { 533 | & cmake ` 534 | --build "${env:GITHUB_WORKSPACE}\downstream\pkgconfig\bare" ` 535 | --config ${Config} 536 | if ($LASTEXITCODE -ne 0) { throw "Building OpenCL-CLHPP standalone consume test in $Config failed." } 537 | & cd ${env:GITHUB_WORKSPACE}\downstream\pkgconfig\bare 538 | & ctest --output-on-failure --no-tests=error -C ${Config} 539 | if ($LASTEXITCODE -ne 0) { throw "Running OpenCL-CLHPP standalone consume test in $Config failed." } 540 | } 541 | 542 | - name: "Consume (Ninja-Multi-Config standalone): Configure/Build/Test" 543 | if: matrix.GEN == 'Ninja Multi-Config' 544 | run: | 545 | $VER = switch ('${{matrix.VER}}') { ` 546 | 'v142' {'14.2'} ` 547 | 'v143' {'14.4'} } 548 | Import-Module "${env:VS_ROOT}\Common7\Tools\Microsoft.VisualStudio.DevShell.dll" 549 | Enter-VsDevShell -VsInstallPath ${env:VS_ROOT} -SkipAutomaticLocation -DevCmdArguments "-host_arch=x64 -arch=${{matrix.BIN}} -vcvars_ver=$VER" 550 | & cmake ` 551 | -G '${{matrix.GEN}}' ` 552 | -D CMAKE_MAKE_PROGRAM="${env:NINJA_ROOT}\ninja.exe" ` 553 | -D CMAKE_CXX_STANDARD=${{matrix.CXXSTD}} ` 554 | -D CMAKE_CXX_EXTENSIONS=OFF ` 555 | -D CMAKE_EXE_LINKER_FLAGS=/INCREMENTAL ` 556 | -D CMAKE_PREFIX_PATH="${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\install;${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\install;${env:GITHUB_WORKSPACE}\install" ` 557 | -S "${env:GITHUB_WORKSPACE}\tests\pkgconfig\bare" ` 558 | -B "${env:GITHUB_WORKSPACE}\downstream\pkgconfig\bare" 559 | if ($LASTEXITCODE -ne 0) { throw "Configuring OpenCL-CLHPP standalone consume test failed." } 560 | foreach ($Config in 'Release','Debug') { 561 | & cmake ` 562 | --build "${env:GITHUB_WORKSPACE}\downstream\pkgconfig\bare" ` 563 | --config ${Config} 564 | if ($LASTEXITCODE -ne 0) { throw "Building OpenCL-CLHPP standalone consume test in $Config failed." } 565 | & cd ${env:GITHUB_WORKSPACE}\downstream\pkgconfig\bare 566 | & ctest --output-on-failure --no-tests=error -C ${Config} 567 | if ($LASTEXITCODE -ne 0) { throw "Running OpenCL-CLHPP standalone consume test in $Config failed." } 568 | } 569 | 570 | - name: Consume (Emulate SDK presence) 571 | run: | 572 | New-Item -Type Directory -Path ${env:GITHUB_WORKSPACE}\install\share\cmake\OpenCL 573 | $workspace = ${env:GITHUB_WORKSPACE}.replace("\", "/") 574 | New-Item -Type File -Path ${env:GITHUB_WORKSPACE}\install\share\cmake\OpenCL\OpenCLConfig.cmake -Value "include(`"$workspace/external/OpenCL-Headers/install/share/cmake/OpenCLHeaders/OpenCLHeadersTargets.cmake`")`r`ninclude(`"$workspace/external/OpenCL-ICD-Loader/install/share/cmake/OpenCLICDLoader/OpenCLICDLoaderTargets.cmake`")`r`ninclude(`"`${CMAKE_CURRENT_LIST_DIR}/../OpenCLHeadersCpp/OpenCLHeadersCppTargets.cmake`")" 575 | 576 | - name: "Consume (MSBuild SDK): Configure/Build/Test" 577 | if: matrix.GEN == 'Visual Studio 17 2022' 578 | run: | 579 | $BIN = if('${{matrix.BIN}}' -eq 'x86') {'Win32'} else {'x64'} 580 | & cmake ` 581 | -G '${{matrix.GEN}}' ` 582 | -A ${BIN} ` 583 | -T ${{matrix.VER}} ` 584 | -D CMAKE_CXX_STANDARD=${{matrix.CXXSTD}} ` 585 | -D CMAKE_CXX_EXTENSIONS=OFF ` 586 | -D CMAKE_EXE_LINKER_FLAGS=/INCREMENTAL ` 587 | -D CMAKE_PREFIX_PATH="${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\install;${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\install;${env:GITHUB_WORKSPACE}\install" ` 588 | -S "${env:GITHUB_WORKSPACE}\tests\pkgconfig\sdk" ` 589 | -B "${env:GITHUB_WORKSPACE}\downstream\pkgconfig\sdk" 590 | if ($LASTEXITCODE -ne 0) { throw "Configuring OpenCL-CLHPP in-SDK consume test failed." } 591 | foreach ($Config in 'Release','Debug') { 592 | & cmake ` 593 | --build "${env:GITHUB_WORKSPACE}\downstream\pkgconfig\sdk" ` 594 | --config ${Config} 595 | if ($LASTEXITCODE -ne 0) { throw "Building OpenCL-CLHPP in-SDK consume test in $Config failed." } 596 | & cd ${env:GITHUB_WORKSPACE}\downstream\pkgconfig\sdk 597 | & ctest --output-on-failure --no-tests=error -C ${Config} 598 | if ($LASTEXITCODE -ne 0) { throw "Running OpenCL-CLHPP in-SDK consume test in $Config failed." } 599 | } 600 | 601 | - name: "Consume (Ninja-Multi-Config SDK): Configure/Build/Test" 602 | if: matrix.GEN == 'Ninja Multi-Config' 603 | run: | 604 | $VER = switch ('${{matrix.VER}}') { ` 605 | 'v142' {'14.2'} ` 606 | 'v143' {'14.4'} } 607 | Import-Module "${env:VS_ROOT}\Common7\Tools\Microsoft.VisualStudio.DevShell.dll" 608 | Enter-VsDevShell -VsInstallPath ${env:VS_ROOT} -SkipAutomaticLocation -DevCmdArguments "-host_arch=x64 -arch=${{matrix.BIN}} -vcvars_ver=${VER}" 609 | & cmake ` 610 | -G '${{matrix.GEN}}' ` 611 | -D CMAKE_MAKE_PROGRAM="${env:NINJA_ROOT}\ninja.exe" ` 612 | -D CMAKE_CXX_STANDARD=${{matrix.CXXSTD}} ` 613 | -D CMAKE_CXX_EXTENSIONS=OFF ` 614 | -D CMAKE_EXE_LINKER_FLAGS=/INCREMENTAL ` 615 | -D CMAKE_PREFIX_PATH="${env:GITHUB_WORKSPACE}\external\OpenCL-Headers\install;${env:GITHUB_WORKSPACE}\external\OpenCL-ICD-Loader\install;${env:GITHUB_WORKSPACE}\install" ` 616 | -S "${env:GITHUB_WORKSPACE}\tests\pkgconfig\sdk" ` 617 | -B "${env:GITHUB_WORKSPACE}\downstream\pkgconfig\sdk" 618 | if ($LASTEXITCODE -ne 0) { throw "Configuring OpenCL-CLHPP in-SDK consume test failed." } 619 | foreach ($Config in 'Release','Debug') { ` 620 | & cmake ` 621 | --build "${env:GITHUB_WORKSPACE}\downstream\pkgconfig\sdk" ` 622 | --config ${Config} 623 | if ($LASTEXITCODE -ne 0) { throw "Building OpenCL-CLHPP in-SDK consume test in $Config failed." } 624 | & cd ${env:GITHUB_WORKSPACE}\downstream\pkgconfig\sdk 625 | & ctest --output-on-failure --no-tests=error -C ${Config} 626 | if ($LASTEXITCODE -ne 0) { throw "Running OpenCL-CLHPP in-SDK consume test in $Config failed." } 627 | } 628 | 629 | macos: 630 | runs-on: macos-latest 631 | defaults: 632 | run: 633 | shell: bash 634 | strategy: 635 | matrix: 636 | COMPILER: 637 | - C_NAME: /usr/bin/clang 638 | CXX_NAME: /usr/bin/clang++ 639 | # Disabled due to problems with __has_cpp_attribute 640 | # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=114007 641 | #- C_NAME: gcc-11 642 | # CXX_NAME: g++-11 643 | # Disabled due to problems with the __API_AVAILABLE macro 644 | # - C_NAME: gcc-13 645 | # CXX_NAME: g++-13 646 | # # A workaround for a bug in the toolset 647 | # # See https://forums.developer.apple.com/forums/thread/737707 648 | # EXTRA_FLAGS: -Wl,-ld_classic 649 | GEN: 650 | - Xcode 651 | - Ninja Multi-Config 652 | CXXSTD: [11, 17] 653 | exclude: 654 | # These entries are excluded, since XCode selects its own compiler 655 | - COMPILER: 656 | C_NAME: gcc-11 657 | CXX_NAME: g++-11 658 | GEN: Xcode 659 | - COMPILER: 660 | C_NAME: gcc-13 661 | CXX_NAME: g++-13 662 | GEN: Xcode 663 | env: 664 | CC: ${{matrix.COMPILER.C_NAME}} 665 | CXX: ${{matrix.COMPILER.CXX_NAME}} 666 | CFLAGS: -Wall -Wextra -pedantic -Wno-format -Werror ${{matrix.COMPILER.EXTRA_FLAGS}} 667 | CXXFLAGS: -Wall -Wextra -pedantic -Wno-format -Werror ${{matrix.COMPILER.EXTRA_FLAGS}} 668 | 669 | steps: 670 | - name: Checkout OpenCL-CLHPP 671 | uses: actions/checkout@v4 672 | with: 673 | submodules: recursive 674 | 675 | - name: Checkout OpenCL-Headers 676 | uses: actions/checkout@v4 677 | with: 678 | repository: KhronosGroup/OpenCL-Headers 679 | path: external/OpenCL-Headers 680 | 681 | - name: Checkout OpenCL-ICD-Loader 682 | uses: actions/checkout@v4 683 | with: 684 | repository: KhronosGroup/OpenCL-ICD-Loader 685 | path: external/OpenCL-ICD-Loader 686 | 687 | - name: Create Build Environment 688 | run: | 689 | # Install Ninja only if it's the selected generator and it's not available. 690 | if [[ "${{matrix.GEN}}" == "Ninja Multi-Config" && ! `which ninja` ]]; then brew install ninja; fi && 691 | if [[ ! `which pkg-config` ]]; then brew install pkg-config; fi; 692 | cmake --version 693 | 694 | - name: Build & install OpenCL-Headers 695 | run: cmake 696 | -G "${{matrix.GEN}}" 697 | -D BUILD_TESTING=OFF 698 | -D CMAKE_C_EXTENSIONS=OFF 699 | -D CMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/external/OpenCL-Headers/install 700 | -S $GITHUB_WORKSPACE/external/OpenCL-Headers 701 | -B $GITHUB_WORKSPACE/external/OpenCL-Headers/build && 702 | cmake 703 | --build $GITHUB_WORKSPACE/external/OpenCL-Headers/build 704 | --target install 705 | --config Release 706 | --parallel `sysctl -n hw.logicalcpu` 707 | 708 | - name: Build & install OpenCL-ICD-Loader 709 | run: cmake 710 | -G "${{matrix.GEN}}" 711 | -D BUILD_TESTING=OFF 712 | -D CMAKE_C_EXTENSIONS=OFF 713 | -D CMAKE_PREFIX_PATH=$GITHUB_WORKSPACE/external/OpenCL-Headers/install 714 | -D CMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install 715 | -S $GITHUB_WORKSPACE/external/OpenCL-ICD-Loader 716 | -B $GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/build && 717 | cmake 718 | --build $GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/build 719 | --target install 720 | --config Release 721 | --parallel `sysctl -n hw.logicalcpu` 722 | 723 | - name: Configure 724 | run: cmake 725 | -G "${{matrix.GEN}}" 726 | -D BUILD_TESTING=ON 727 | -D CMAKE_CXX_STANDARD=${{matrix.CXXSTD}} 728 | -D CMAKE_CXX_EXTENSIONS=OFF 729 | -D CMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/install 730 | -D CMAKE_PREFIX_PATH="$GITHUB_WORKSPACE/external/OpenCL-Headers/install;$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install" 731 | -S $GITHUB_WORKSPACE 732 | -B $GITHUB_WORKSPACE/build 733 | 734 | - name: Build 735 | run: | 736 | cmake --build $GITHUB_WORKSPACE/build --config Release --parallel `sysctl -n hw.logicalcpu` 737 | cmake --build $GITHUB_WORKSPACE/build --config Debug --parallel `sysctl -n hw.logicalcpu` 738 | 739 | - name: Test 740 | working-directory: ${{runner.workspace}}/OpenCL-CLHPP/build 741 | run: | 742 | ctest -C Release --output-on-failure --no-tests=error --parallel `sysctl -n hw.logicalcpu` 743 | ctest -C Debug --output-on-failure --no-tests=error --parallel `sysctl -n hw.logicalcpu` 744 | 745 | - name: Test install 746 | run: | 747 | cmake --build $GITHUB_WORKSPACE/build --config Release --target install 748 | 749 | - name: Consume (install) 750 | run: cmake 751 | -G "${{matrix.GEN}}" 752 | -D CMAKE_CXX_STANDARD=${{matrix.CXXSTD}} 753 | -D CMAKE_CXX_EXTENSIONS=OFF 754 | -D CMAKE_CXX_STANDARD_REQUIRED=ON 755 | -D CMAKE_PREFIX_PATH="$GITHUB_WORKSPACE/external/OpenCL-Headers/install;$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install;$GITHUB_WORKSPACE/install" 756 | -S $GITHUB_WORKSPACE/tests/pkgconfig/bare 757 | -B $GITHUB_WORKSPACE/build_install && 758 | cmake --build $GITHUB_WORKSPACE/build_install --config Release --parallel `sysctl -n hw.logicalcpu` && 759 | cmake --build $GITHUB_WORKSPACE/build_install --config Debug --parallel `sysctl -n hw.logicalcpu` && 760 | cd $GITHUB_WORKSPACE/build_install && 761 | ctest -C Release --output-on-failure --no-tests=error --parallel `sysctl -n hw.logicalcpu` && 762 | ctest -C Debug --output-on-failure --no-tests=error --parallel `sysctl -n hw.logicalcpu` 763 | 764 | - name: Test pkg-config 765 | run: | 766 | export PKG_CONFIG_PATH=$GITHUB_WORKSPACE/install/share/pkgconfig:$GITHUB_WORKSPACE/external/OpenCL-Headers/install/share/pkgconfig:$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install/lib/pkgconfig 767 | pkg-config OpenCL-CLHPP --cflags | grep -q "\-I$GITHUB_WORKSPACE/install/include" 768 | 769 | - name: Test pkg-config dependency 770 | run: | 771 | export PKG_CONFIG_PATH=$GITHUB_WORKSPACE/install/share/pkgconfig:$GITHUB_WORKSPACE/external/OpenCL-Headers/install/share/pkgconfig:$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install/lib/pkgconfig 772 | pkg-config OpenCL-CLHPP --cflags | grep -q "\-I$GITHUB_WORKSPACE/external/OpenCL-Headers/install/include" 773 | 774 | android: 775 | runs-on: ubuntu-latest 776 | defaults: 777 | run: 778 | shell: bash 779 | strategy: 780 | matrix: 781 | ABI: 782 | - arm64-v8a 783 | - x86_64 784 | API_LEVEL: 785 | - android-19 786 | - android-33 787 | CONFIG: 788 | - Debug 789 | - Release 790 | env: 791 | CFLAGS: -Wall -Wextra -pedantic -Werror 792 | CXXFLAGS: -Wall -Wextra -pedantic -Werror 793 | steps: 794 | - name: Checkout OpenCL-CLHPP 795 | uses: actions/checkout@v4 796 | with: 797 | submodules: recursive 798 | 799 | - name: Checkout OpenCL-Headers 800 | uses: actions/checkout@v4 801 | with: 802 | repository: KhronosGroup/OpenCL-Headers 803 | path: external/OpenCL-Headers 804 | 805 | - name: Checkout OpenCL-ICD-Loader 806 | uses: actions/checkout@v4 807 | with: 808 | repository: KhronosGroup/OpenCL-ICD-Loader 809 | path: external/OpenCL-ICD-Loader 810 | 811 | - name: Configure & install OpenCL-Headers 812 | run: cmake 813 | -G "Unix Makefiles" 814 | -D CMAKE_BUILD_TYPE=${{matrix.CONFIG}} 815 | -D CMAKE_C_EXTENSIONS=OFF 816 | -D CMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/external/OpenCL-Headers/install 817 | -D BUILD_TESTING=OFF 818 | -S $GITHUB_WORKSPACE/external/OpenCL-Headers 819 | -B $GITHUB_WORKSPACE/external/OpenCL-Headers/build && 820 | cmake 821 | --build $GITHUB_WORKSPACE/external/OpenCL-Headers/build 822 | --target install 823 | -- 824 | -j`nproc` 825 | 826 | - name: Configure & install OpenCL-ICD-Loader 827 | run: cmake 828 | -G "Unix Makefiles" 829 | -D CMAKE_BUILD_TYPE=${{matrix.CONFIG}} 830 | -D CMAKE_INSTALL_PREFIX=$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install 831 | -D BUILD_TESTING=ON 832 | -D CMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake 833 | -D ANDROID_ABI=${{matrix.ABI}} 834 | -D ANDROID_PLATFORM=${{matrix.API_LEVEL}} 835 | -D CMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ONLY 836 | -D CMAKE_FIND_ROOT_PATH=$GITHUB_WORKSPACE/external/OpenCL-Headers/install 837 | -S $GITHUB_WORKSPACE/external/OpenCL-ICD-Loader 838 | -B $GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/build && 839 | sudo cmake 840 | --build $GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/build 841 | --target install 842 | -- 843 | -j`nproc` 844 | 845 | - name: Configure 846 | run: cmake 847 | -G "Unix Makefiles" 848 | -D BUILD_TESTING=ON 849 | -D BUILD_EXAMPLES=ON 850 | -D CMAKE_BUILD_TYPE=${{matrix.CONFIG}} 851 | -D CMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake 852 | -D ANDROID_ABI=${{matrix.ABI}} 853 | -D ANDROID_PLATFORM=${{matrix.API_LEVEL}} 854 | -D CMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ONLY 855 | -D CMAKE_FIND_ROOT_PATH="$GITHUB_WORKSPACE/external/OpenCL-Headers/install;$GITHUB_WORKSPACE/external/OpenCL-ICD-Loader/install" 856 | -S $GITHUB_WORKSPACE 857 | -B $GITHUB_WORKSPACE/build 858 | 859 | - name: Build 860 | run: cmake --build $GITHUB_WORKSPACE/build -j `nproc` 861 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | on: 4 | push: 5 | tags: 6 | - "v*" 7 | env: 8 | distroseries: jammy 9 | 10 | jobs: 11 | release: 12 | if: false 13 | runs-on: ubuntu-latest 14 | defaults: 15 | run: 16 | shell: bash 17 | steps: 18 | - name: Add PPA 19 | run: sudo add-apt-repository -y ppa:${{ vars.PPA }} 20 | 21 | - name: Install prerequisites 22 | run: sudo apt-get update -qq && sudo apt-get install -y cmake devscripts debhelper-compat=13 opencl-c-headers doxygen 23 | 24 | - name: Import GPG signing key 25 | run: echo "${{ secrets.DEB_SIGNING_KEY }}" | gpg --import 26 | 27 | - name: Download and extract source code 28 | run: | 29 | wget -O $GITHUB_WORKSPACE/source.orig.tar.gz https://github.com/$GITHUB_REPOSITORY/archive/refs/tags/$GITHUB_REF_NAME.tar.gz 30 | tar -xvf $GITHUB_WORKSPACE/source.orig.tar.gz 31 | 32 | - name: Configure project out-of-tree 33 | run: cmake 34 | -S $GITHUB_WORKSPACE/OpenCL-CLHPP* 35 | -B $GITHUB_WORKSPACE/../build 36 | -D CMAKE_BUILD_TYPE=Release 37 | -D CMAKE_INSTALL_PREFIX=/usr 38 | -D BUILD_TESTING=OFF 39 | -D BUILD_EXAMPLES=OFF 40 | -D BUILD_DOCS=OFF 41 | -D LATEST_RELEASE_VERSION=$GITHUB_REF_NAME 42 | -D CPACK_DEBIAN_PACKAGE_MAINTAINER="${{ vars.DEB_MAINTAINER }}" 43 | -D DEBIAN_VERSION_SUFFIX=${{ vars.DEB_VERSION_SUFFIX }} 44 | 45 | - name: Generate packaging scripts 46 | run: cmake 47 | -D CMAKE_CACHE_PATH=$GITHUB_WORKSPACE/../build/CMakeCache.txt 48 | -D ORIG_ARCHIVE=$GITHUB_WORKSPACE/source.orig.tar.gz 49 | -D LATEST_RELEASE_VERSION=$GITHUB_REF_NAME 50 | -D DEBIAN_DISTROSERIES=${{ env.distroseries }} 51 | -D DEBIAN_PACKAGE_MAINTAINER="${{ vars.DEB_MAINTAINER }}" 52 | -D DEBIAN_VERSION_SUFFIX=${{ vars.DEB_VERSION_SUFFIX }} 53 | -P $GITHUB_WORKSPACE/OpenCL-CLHPP*/cmake/DebSourcePkg.cmake 54 | 55 | - name: Build source package 56 | run: | 57 | cd $GITHUB_WORKSPACE/OpenCL-CLHPP*/ 58 | debuild -S -sa 59 | 60 | - name: Build binary package 61 | run: cpack 62 | -G DEB 63 | -C Release 64 | -B $GITHUB_WORKSPACE/../build 65 | --config $GITHUB_WORKSPACE/../build/CPackConfig.cmake 66 | 67 | # The following step does not depend on the previous step "Build binary package", 68 | # but if the binary package build is unsuccessful, it is better not to push the 69 | # source packages to the PPA 70 | - name: Push source package to the PPA 71 | run: dput ppa:${{ vars.PPA }} $GITHUB_WORKSPACE/*source.changes 72 | 73 | - name: Create GitHub release 74 | uses: softprops/action-gh-release@v1 75 | with: 76 | files: ${{ github.workspace }}/../build/*.deb 77 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Build dir 2 | [Bb]uild/ 3 | 4 | # Install dir 5 | [Ii]nstall/ 6 | 7 | # Package dir 8 | [Pp]ackage[-_\s\d]*/ 9 | 10 | # External dir 11 | [Ee]xternal/ 12 | 13 | # Visual Studio Code 14 | .vscode 15 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "external/CMock"] 2 | path = external/CMock 3 | url = https://github.com/ThrowTheSwitch/CMock 4 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16) 2 | 3 | project(OpenCLHeadersCpp 4 | VERSION 3.0 5 | LANGUAGES CXX # Ideally should be NONE, but GNUInstallDirs detects platform arch using try_compile 6 | # https://stackoverflow.com/questions/43379311/why-does-project-affect-cmakes-opinion-on-cmake-sizeof-void-p 7 | ) 8 | enable_testing() 9 | 10 | set(CMAKE_CXX_STANDARD 11) 11 | set(CMAKE_CXX_STANDARD_REQUIRED ON) 12 | 13 | option(BUILD_DOCS "Build Documentation" ON) 14 | option(BUILD_EXAMPLES "Build Examples" ON) 15 | option(OPENCL_CLHPP_BUILD_TESTING "Enable support for OpenCL C++ headers testing." OFF) 16 | set(THREADS_PREFER_PTHREAD_FLAG ON CACHE BOOL 17 | "find_package(Threads) preference. Recommendation is to keep default value." 18 | ) 19 | # Legacy helper variables, see later at finding headers and ICD Loader 20 | set(OPENCL_DIST_DIR "" CACHE PATH "OpenCL source dir (legacy helper var)") 21 | set(OPENCL_LIB_DIR "${OPENCL_DIST_DIR}/lib" CACHE PATH "OpenCL library dir (legacy helper var)" ) 22 | set(OPENCL_INCLUDE_DIR "${OPENCL_DIST_DIR}/include" CACHE PATH "OpenCL source dir (legacy helper var)") 23 | # Helper vars with names consistent with OpenCL-ICD-Loader's OPENCL_ICD_LOADER_HEADERS_DIR 24 | # Default values taken from legacy defaults 25 | set(OPENCL_CLHPP_HEADERS_DIR "${OPENCL_INCLUDE_DIR}" CACHE PATH "OpenCL headers dir") 26 | set(OPENCL_CLHPP_LOADER_DIR "${OPENCL_LIB_DIR}" CACHE PATH "OpenCL library dir") 27 | 28 | add_library(HeadersCpp INTERFACE) 29 | add_library(OpenCL::HeadersCpp ALIAS HeadersCpp) 30 | 31 | if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME OR OPENCL_CLHPP_BUILD_TESTING) 32 | include(CTest) 33 | endif() 34 | if((CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME OR OPENCL_CLHPP_BUILD_TESTING) AND BUILD_TESTING) 35 | set(CLHPP_BUILD_TESTS ON) 36 | endif() 37 | 38 | # In the spirit of backward compatibility, to not break existing build automation 39 | # we first check if the helper vars refer to existing files. If yes, use them. 40 | # Otherwise search using 3.0 installed CMake Package Configs. 41 | if(EXISTS "${OPENCL_CLHPP_HEADERS_DIR}/CL/cl.h") 42 | if(NOT TARGET OpenCL::Headers) 43 | message(STATUS "Defining OpenCL::Headers through OPENCL_INCLUDE_DIR") 44 | add_library(OpenCLHeaders INTERFACE) 45 | add_library(OpenCL::Headers ALIAS OpenCLHeaders) 46 | target_include_directories(OpenCLHeaders INTERFACE ${OPENCL_INCLUDE_DIR}) 47 | endif() 48 | else() 49 | if(NOT TARGET OpenCL::Headers) 50 | find_package(OpenCLHeaders REQUIRED) 51 | endif() 52 | endif() 53 | if(BUILD_EXAMPLES OR CLHPP_BUILD_TESTS) 54 | enable_language(C) 55 | find_package(Threads REQUIRED) 56 | endif() 57 | if(CLHPP_BUILD_TESTS) 58 | find_program(RUBY_EXECUTABLE ruby REQUIRED) 59 | endif() 60 | 61 | target_include_directories(HeadersCpp 62 | INTERFACE 63 | $ 64 | $ 65 | ) 66 | target_link_libraries(HeadersCpp 67 | INTERFACE 68 | OpenCL::Headers 69 | ) 70 | 71 | install( 72 | TARGETS HeadersCpp 73 | EXPORT OpenCLHeadersCppTargets 74 | ) 75 | 76 | include(GNUInstallDirs) 77 | 78 | set (CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake") 79 | include(JoinPaths) 80 | include(Package) 81 | 82 | install( 83 | DIRECTORY include/CL 84 | DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} 85 | ) 86 | export( 87 | EXPORT OpenCLHeadersCppTargets 88 | FILE ${PROJECT_BINARY_DIR}/OpenCLHeadersCpp/OpenCLHeadersCppTargets.cmake 89 | NAMESPACE OpenCL:: 90 | ) 91 | file( 92 | WRITE ${PROJECT_BINARY_DIR}/OpenCLHeadersCpp/OpenCLHeadersCppConfig.cmake 93 | "include(\"\${CMAKE_CURRENT_LIST_DIR}/OpenCLHeadersCppTargets.cmake\")" 94 | ) 95 | 96 | set(config_package_location ${CMAKE_INSTALL_DATADIR}/cmake/OpenCLHeadersCpp) 97 | install( 98 | EXPORT OpenCLHeadersCppTargets 99 | FILE OpenCLHeadersCppTargets.cmake 100 | NAMESPACE OpenCL:: 101 | DESTINATION ${config_package_location} 102 | ) 103 | install( 104 | FILES ${CMAKE_CURRENT_BINARY_DIR}/OpenCLHeadersCpp/OpenCLHeadersCppConfig.cmake 105 | DESTINATION ${config_package_location} 106 | ) 107 | 108 | unset(CMAKE_SIZEOF_VOID_P) 109 | include(CMakePackageConfigHelpers) 110 | write_basic_package_version_file( 111 | ${CMAKE_CURRENT_BINARY_DIR}/OpenCLHeadersCpp/OpenCLHeadersCppConfigVersion.cmake 112 | VERSION ${PROJECT_VERSION} 113 | COMPATIBILITY AnyNewerVersion 114 | ) 115 | install( 116 | FILES ${CMAKE_CURRENT_BINARY_DIR}/OpenCLHeadersCpp/OpenCLHeadersCppConfigVersion.cmake 117 | DESTINATION ${config_package_location} 118 | ) 119 | 120 | set(UNITY_DIR ${PROJECT_SOURCE_DIR}/external/CMock/vendor/unity CACHE PATH "Unity dir") 121 | set(CMOCK_DIR ${PROJECT_SOURCE_DIR}/external/CMock CACHE PATH "CMock dir") 122 | 123 | if(BUILD_DOCS) 124 | add_subdirectory(docs) 125 | endif(BUILD_DOCS) 126 | 127 | if(BUILD_EXAMPLES) 128 | add_subdirectory(examples) 129 | endif(BUILD_EXAMPLES) 130 | 131 | if(CLHPP_BUILD_TESTS) 132 | add_subdirectory(tests) 133 | endif(CLHPP_BUILD_TESTS) 134 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | A reminder that this issue tracker is managed by the Khronos Group. Interactions here should follow the Khronos Code of Conduct (https://www.khronos.org/developers/code-of-conduct), which prohibits aggressive or derogatory language. Please keep the discussion friendly and civil. 2 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /OpenCL-CLHPP.pc.in: -------------------------------------------------------------------------------- 1 | prefix=@PKGCONFIG_PREFIX@ 2 | includedir=@OPENCLHPP_INCLUDEDIR_PC@ 3 | 4 | Name: OpenCL-CLHPP 5 | Description: OpenCL API C++ bindings 6 | Requires: OpenCL-Headers 7 | Version: 3.0 8 | Cflags: -I${includedir} 9 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OpenCLTM API C++ bindings 2 | 3 | Doxgen documentation for the bindings is available here: 4 | 5 | http://khronosgroup.github.io/OpenCL-CLHPP/ 6 | 7 | Components: 8 | 9 | * `include/CL/opencl.hpp`: 10 | The latest, maintained, version of the C++ bindings. It should work with all 11 | versions of OpenCL (including 1.x). This is what most users will want. 12 | 13 | * `include/CL/cl2.hpp`: 14 | Includes `opencl.hpp` and emits a warning, for backwards compability. 15 | 16 | * `docs`: 17 | Doxygen file used to generate HTML documentation for `opencl.hpp`. 18 | 19 | * `examples`: 20 | A simple example application using the very basic features of the bindings. 21 | 22 | * `tests`: 23 | A (very small, incomplete) set of regression tests. Building the tests 24 | requires Python, Ruby, and CMock. For the last one we use 25 | [CMock top-of-tree from Github](https://github.com/ThrowTheSwitch/CMock), 26 | as the latest (at the time this was written) released CMock version, 27 | v2.5.3, has some issues. 28 | 29 | * `CMakeLists.txt`: 30 | Build system for the examples and tests and logic for the bindings 31 | installation. 32 | 33 | ## Build Instructions 34 | 35 | > While the C++ Headers can be built and installed in isolation, it is part of the [OpenCL SDK](https://github.com/KhronosGroup/OpenCL-SDK). If looking for streamlined build experience and a complete development package, refer to the SDK build instructions instead of the following guide. 36 | 37 | ### Dependencies 38 | 39 | The C++ Headers require: 40 | 41 | - the [OpenCL Headers](https://github.com/KhronosGroup/OpenCL-Headers/). 42 | - It is recommended to install the headers via CMake, however a convenience shorthand is provided. Providing `OPENCL_CLHPP_HEADERS_DIR` to CMake, one may specify the location of OpenCL Headers. By default, the C++ Headers will look for OpenCL Headers under `${OPENCL_DIST_DIR}/include`. 43 | - the [OpenCL-ICD-Loader](https://github.com/KhronosGroup/OpenCL-ICD-Loader/) when building the examples 44 | - It is recommended to install the ICD loader via CMake, however a convenience shorthand is provided. Providing `OPENCL_CLHPP_LOADER_DIR` to CMake, one may specify the location of the OpenCL ICD loader. By default, the C++ headers will look for OpenCL ICD loader under `${OPENCL_DIST_DIR}/lib`. 45 | - The C++ Headers uses CMake for its build system. 46 | If CMake is not provided by your build system or OS package manager, please consult the [CMake website](https://cmake.org). 47 | - The unit tests require [CMock](https://github.com/ThrowTheSwitch/CMock). To get this external dependency, use `--recursive` when cloning 48 | the repository, or run `git submodule update --init --recursive`. 49 | - Generating the mock input requires [Ruby](https://www.ruby-lang.org/en/). 50 | - Generating the docs requires Doxygen. When it is available, you can generate HTML documentation by building the `docs` target. 51 | 52 | ### Example Build 53 | 54 | 1. Clone this repo, the OpenCL ICD Loader and the OpenCL Headers: 55 | 56 | git clone --recursive https://github.com/KhronosGroup/OpenCL-CLHPP 57 | git clone https://github.com/KhronosGroup/OpenCL-ICD-Loader 58 | git clone https://github.com/KhronosGroup/OpenCL-Headers 59 | 60 | 1. Install OpenCL Headers CMake package 61 | 62 | cmake -D CMAKE_INSTALL_PREFIX=./OpenCL-Headers/install -S ./OpenCL-Headers -B ./OpenCL-Headers/build 63 | cmake --build ./OpenCL-Headers/build --target install 64 | 65 | 1. Build and install OpenCL ICD Loader CMake package. _(Note that `CMAKE_PREFIX_PATH` need to be an absolute path. Update as needed.)_ 66 | 67 | cmake -D CMAKE_PREFIX_PATH=/absolute/path/to/OpenCL-Headers/install -D CMAKE_INSTALL_PREFIX=./OpenCL-ICD-Loader/install -S ./OpenCL-ICD-Loader -B ./OpenCL-ICD-Loader/build 68 | cmake --build ./OpenCL-ICD-Loader/build --target install 69 | 70 | 1. Build and install OpenCL C++ Headers CMake package. 71 | 72 | cmake -D CMAKE_PREFIX_PATH="/absolute/path/to/OpenCL-Headers/install;/absolute/path/to/OpenCL-ICD-Loader/install" -D CMAKE_INSTALL_PREFIX=./OpenCL-CLHPP/install -S ./OpenCL-CLHPP -B ./OpenCL-CLHPP/build 73 | cmake --build ./OpenCL-CLHPP/build --target install 74 | 75 | ### Example Use 76 | 77 | Example CMake invocation 78 | 79 | ```bash 80 | cmake -D CMAKE_PREFIX_PATH="/chosen/install/prefix/of/headers;/chosen/install/prefix/of/loader;/chosen/install/prefix/of/cppheaders" /path/to/opencl/app 81 | ``` 82 | 83 | and sample `CMakeLists.txt` 84 | 85 | ```cmake 86 | cmake_minimum_required(VERSION 3.0) 87 | cmake_policy(VERSION 3.0...3.18.4) 88 | project(proj) 89 | add_executable(app main.cpp) 90 | find_package(OpenCLHeaders REQUIRED) 91 | find_package(OpenCLICDLoader REQUIRED) 92 | find_package(OpenCLHeadersCpp REQUIRED) 93 | target_link_libraries(app PRIVATE OpenCL::Headers OpenCL::OpenCL OpenCL::HeadersCpp) 94 | ``` 95 | -------------------------------------------------------------------------------- /cmake/DebSourcePkg.cmake: -------------------------------------------------------------------------------- 1 | # This script produces the changelog, control and rules file in the debian 2 | # directory. These files are needed to build a Debian source package from the repository. 3 | # Run this in CMake script mode, e.g. 4 | # $ cd OpenCL-CLHPP 5 | # $ cmake -S . -B ../build -D BUILD_TESTING=OFF -D BUILD_EXAMPLES=OFF -D BUILD_DOCS=OFF 6 | # $ cmake 7 | # -DCMAKE_CACHE_PATH=../build/CMakeCache.txt 8 | # -DCPACK_DEBIAN_PACKAGE_MAINTAINER="Example Name " 9 | # -DDEBIAN_DISTROSERIES=jammy 10 | # -DORIG_ARCHIVE=../OpenCL-Headers.tar.gz 11 | # -DLATEST_RELEASE_VERSION=v2023.08.29 12 | # -P cmake/DebSourcePkg.cmake 13 | # $ debuild -S -sa 14 | 15 | cmake_minimum_required(VERSION 3.21) # file(COPY_FILE) is added in CMake 3.21 16 | 17 | set(DEB_SOURCE_PKG_NAME "khronos-opencl-clhpp") 18 | set(DEB_C_HEADERS_PKG_NAME "opencl-c-headers") 19 | set(DEB_META_PKG_NAME "opencl-headers") 20 | set(DEB_DOC_PKG_NAME "opencl-clhpp-headers-doc") 21 | set(DEB_DOC_PKG_DESCRIPTION "documentation for C++ OpenCL headers 22 | OpenCL (Open Computing Language) is a multi-vendor open standard for 23 | general-purpose parallel programming of heterogeneous systems that include 24 | CPUs, GPUs and other processors. 25 | . 26 | This package provides the documentation of the C++ development header files 27 | for the OpenCL API as published by The Khronos Group Inc. 28 | ") 29 | 30 | if(NOT EXISTS "${CMAKE_CACHE_PATH}") 31 | message(FATAL_ERROR "CMAKE_CACHE_PATH is not set or does not exist") 32 | endif() 33 | if(NOT DEFINED DEBIAN_PACKAGE_MAINTAINER) 34 | message(FATAL_ERROR "DEBIAN_PACKAGE_MAINTAINER is not set") 35 | endif() 36 | if(NOT DEFINED DEBIAN_DISTROSERIES) 37 | message(FATAL_ERROR "DEBIAN_DISTROSERIES is not set") 38 | endif() 39 | if(NOT DEFINED ORIG_ARCHIVE) 40 | message(WARNING "ORIG_ARCHIVE is not set") 41 | elseif(NOT EXISTS "${ORIG_ARCHIVE}") 42 | message(FATAL_ERROR "ORIG_ARCHIVE is defined, but the file does not exist at \"${ORIG_ARCHIVE}\"") 43 | endif() 44 | if(NOT DEFINED LATEST_RELEASE_VERSION) 45 | message(WARNING "LATEST_RELEASE_VERSION is not set") 46 | endif() 47 | if(NOT DEFINED DEBIAN_VERSION_SUFFIX) 48 | message(WARNING "DEBIAN_VERSION_SUFFIX is not set") 49 | endif() 50 | 51 | # Extracting the project version from the main CMakeLists.txt via regex 52 | file(READ "${CMAKE_CACHE_PATH}" CMAKE_CACHE) 53 | string(REGEX MATCH "CMAKE_PROJECT_VERSION[^=]*=([^\n]*)" REGEX_MATCH "${CMAKE_CACHE}") 54 | if(NOT REGEX_MATCH) 55 | message(FATAL_ERROR "Could not extract project version from CMakeLists.txt") 56 | endif() 57 | set(PROJECT_VERSION "${CMAKE_MATCH_1}") 58 | 59 | list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}") 60 | # PackageSetup.cmake contains details for packaging 61 | include(PackageSetup) 62 | 63 | # Append a space after every newline in the description. This format is required 64 | # in the control file. 65 | string(REPLACE "\n" "\n " CPACK_PACKAGE_DESCRIPTION "${CPACK_PACKAGE_DESCRIPTION}") 66 | 67 | set(DEB_SOURCE_PKG_DIR "${CMAKE_CURRENT_LIST_DIR}/../debian") 68 | # Write debian/control 69 | file(WRITE "${DEB_SOURCE_PKG_DIR}/control" 70 | "Source: ${DEB_SOURCE_PKG_NAME} 71 | Section: ${CPACK_DEBIAN_PACKAGE_SECTION} 72 | Priority: optional 73 | Maintainer: ${DEBIAN_PACKAGE_MAINTAINER} 74 | Build-Depends: cmake, debhelper-compat (=13), doxygen, ${CPACK_DEBIAN_PACKAGE_DEPENDS} 75 | Rules-Requires-Root: no 76 | Homepage: ${CPACK_DEBIAN_PACKAGE_HOMEPAGE} 77 | Standards-Version: 4.6.2 78 | 79 | Package: ${DEBIAN_PACKAGE_NAME} 80 | Architecture: ${CPACK_DEBIAN_PACKAGE_ARCHITECTURE} 81 | Multi-Arch: foreign 82 | Depends: ${CPACK_DEBIAN_PACKAGE_DEPENDS} 83 | Breaks: ${CPACK_DEBIAN_PACKAGE_BREAKS} 84 | Replaces: ${CPACK_DEBIAN_PACKAGE_REPLACES} 85 | Description: ${CPACK_PACKAGE_DESCRIPTION} 86 | 87 | Package: ${DEB_DOC_PKG_NAME} 88 | Section: doc 89 | Architecture: all 90 | Multi-Arch: foreign 91 | Description: ${DEB_DOC_PKG_DESCRIPTION} 92 | " 93 | ) 94 | # Write debian/changelog 95 | string(TIMESTAMP CURRENT_TIMESTAMP "%a, %d %b %Y %H:%M:%S +0000" UTC) 96 | file(WRITE "${DEB_SOURCE_PKG_DIR}/changelog" 97 | "${DEB_SOURCE_PKG_NAME} (${PACKAGE_VERSION_REVISION}) ${DEBIAN_DISTROSERIES}; urgency=medium 98 | 99 | * Released version ${PACKAGE_VERSION_REVISION} 100 | 101 | -- ${DEBIAN_PACKAGE_MAINTAINER} ${CURRENT_TIMESTAMP} 102 | ") 103 | # Write debian/rules 104 | file(WRITE "${DEB_SOURCE_PKG_DIR}/rules" 105 | "#!/usr/bin/make -f 106 | %: 107 | \tdh $@ 108 | 109 | override_dh_auto_configure: 110 | \tdh_auto_configure -- -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=OFF -DBUILD_EXAMPLES=OFF 111 | 112 | override_dh_auto_build: 113 | \tdh_auto_build -- all docs 114 | ") 115 | # Write installed file list for headers package 116 | file(WRITE "${DEB_SOURCE_PKG_DIR}/${DEBIAN_PACKAGE_NAME}.install" 117 | "usr/include 118 | usr/share 119 | " 120 | ) 121 | # Write installed file list for docs package 122 | file(WRITE "${DEB_SOURCE_PKG_DIR}/${DEB_DOC_PKG_NAME}.install" 123 | "obj-*/docs/html usr/share/doc/opencl-clhpp-headers/ 124 | " 125 | ) 126 | # Write doc base file 127 | file(WRITE "${DEB_SOURCE_PKG_DIR}/${DEB_DOC_PKG_NAME}.doc-base" 128 | "Document: ${DEBIAN_PACKAGE_NAME} 129 | Title: OpenCL C++ Bindings Documentation 130 | Author: The Khronos Group Inc. 131 | Abstract: This manual describes the OpenCL C++ Bindings 132 | as provided by The Khronos Group Inc. 133 | Section: Programming/C++ 134 | 135 | Format: HTML 136 | Index: /usr/share/doc/${DEBIAN_PACKAGE_NAME}/html/index.html 137 | Files: /usr/share/doc/${DEBIAN_PACKAGE_NAME}/html/*.html 138 | ") 139 | 140 | if(DEFINED ORIG_ARCHIVE) 141 | # Copy the passed orig.tar.gz file. The target filename is deduced from the version number, as expected by debuild 142 | cmake_path(IS_ABSOLUTE ORIG_ARCHIVE IS_ORIG_ARCHIVE_ABSOLUTE) 143 | if (NOT IS_ORIG_ARCHIVE_ABSOLUTE) 144 | message(FATAL_ERROR "ORIG_ARCHIVE must be an absolute path (passed: \"${ORIG_ARCHIVE}\")") 145 | endif() 146 | cmake_path(GET ORIG_ARCHIVE EXTENSION ORIG_ARCHIVE_EXT) 147 | cmake_path(GET ORIG_ARCHIVE PARENT_PATH ORIG_ARCHIVE_PARENT) 148 | set(TARGET_PATH "${ORIG_ARCHIVE_PARENT}/${DEB_SOURCE_PKG_NAME}_${CPACK_DEBIAN_PACKAGE_VERSION}${ORIG_ARCHIVE_EXT}") 149 | message(STATUS "Copying \"${ORIG_ARCHIVE}\" to \"${TARGET_PATH}\"") 150 | file(COPY_FILE "${ORIG_ARCHIVE}" "${TARGET_PATH}") 151 | endif() 152 | -------------------------------------------------------------------------------- /cmake/JoinPaths.cmake: -------------------------------------------------------------------------------- 1 | # This module provides function for joining paths 2 | # known from from most languages 3 | # 4 | # Original license: 5 | # SPDX-License-Identifier: (MIT OR CC0-1.0) 6 | # Explicit permission given to distribute this module under 7 | # the terms of the project as described in /LICENSE.rst. 8 | # Copyright 2020 Jan Tojnar 9 | # https://github.com/jtojnar/cmake-snips 10 | # 11 | # Modelled after Python’s os.path.join 12 | # https://docs.python.org/3.7/library/os.path.html#os.path.join 13 | # Windows not supported 14 | function(join_paths joined_path first_path_segment) 15 | set(temp_path "${first_path_segment}") 16 | foreach(current_segment IN LISTS ARGN) 17 | if(NOT ("${current_segment}" STREQUAL "")) 18 | if(IS_ABSOLUTE "${current_segment}") 19 | set(temp_path "${current_segment}") 20 | else() 21 | set(temp_path "${temp_path}/${current_segment}") 22 | endif() 23 | endif() 24 | endforeach() 25 | set(${joined_path} "${temp_path}" PARENT_SCOPE) 26 | endfunction() 27 | -------------------------------------------------------------------------------- /cmake/Package.cmake: -------------------------------------------------------------------------------- 1 | include("${CMAKE_CURRENT_LIST_DIR}/PackageSetup.cmake") 2 | 3 | # Configuring pkgconfig 4 | 5 | # We need two different instances of OpenCL.pc 6 | # One for installing (cmake --install), which contains CMAKE_INSTALL_PREFIX as prefix 7 | # And another for the Debian development package, which contains CPACK_PACKAGING_INSTALL_PREFIX as prefix 8 | 9 | join_paths(OPENCLHPP_INCLUDEDIR_PC "\${prefix}" "${CMAKE_INSTALL_INCLUDEDIR}") 10 | 11 | set(pkg_config_location ${CMAKE_INSTALL_DATADIR}/pkgconfig) 12 | set(PKGCONFIG_PREFIX "${CMAKE_INSTALL_PREFIX}") 13 | configure_file( 14 | OpenCL-CLHPP.pc.in 15 | ${CMAKE_CURRENT_BINARY_DIR}/pkgconfig_install/OpenCL-CLHPP.pc 16 | @ONLY) 17 | install( 18 | FILES ${CMAKE_CURRENT_BINARY_DIR}/pkgconfig_install/OpenCL-CLHPP.pc 19 | DESTINATION ${pkg_config_location} 20 | COMPONENT pkgconfig_install) 21 | 22 | set(PKGCONFIG_PREFIX "${CPACK_PACKAGING_INSTALL_PREFIX}") 23 | configure_file( 24 | OpenCL-CLHPP.pc.in 25 | ${CMAKE_CURRENT_BINARY_DIR}/pkgconfig_package/OpenCL-CLHPP.pc 26 | @ONLY) 27 | # This install component is only needed in the Debian package 28 | install( 29 | FILES ${CMAKE_CURRENT_BINARY_DIR}/pkgconfig_package/OpenCL-CLHPP.pc 30 | DESTINATION ${pkg_config_location} 31 | COMPONENT pkgconfig_package 32 | EXCLUDE_FROM_ALL) 33 | 34 | # By using component based packaging, component pkgconfig_install 35 | # can be excluded from the package, and component pkgconfig_package 36 | # can be included. 37 | set(CPACK_DEB_COMPONENT_INSTALL ON) 38 | set(CPACK_COMPONENTS_GROUPING "ALL_COMPONENTS_IN_ONE") 39 | 40 | include(CPackComponent) 41 | cpack_add_component(pkgconfig_install) 42 | cpack_add_component(pkgconfig_package) 43 | set(CPACK_COMPONENTS_ALL "Unspecified;pkgconfig_package") 44 | 45 | set(CPACK_DEBIAN_PACKAGE_DEBUG ON) 46 | 47 | include(CPack) 48 | -------------------------------------------------------------------------------- /cmake/PackageSetup.cmake: -------------------------------------------------------------------------------- 1 | set(CPACK_PACKAGE_VENDOR "khronos") 2 | 3 | set(CPACK_PACKAGE_DESCRIPTION "C++ headers for OpenCL development 4 | C++ headers for OpenCL development 5 | OpenCL (Open Computing Language) is a multi-vendor open standard for 6 | general-purpose parallel programming of heterogeneous systems that include 7 | CPUs, GPUs and other processors. 8 | . 9 | This package provides the C++ development header files for the OpenCL API 10 | as published by The Khronos Group Inc. The corresponding specification and 11 | documentation can be found on the Khronos website.") 12 | 13 | set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.txt") 14 | 15 | set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md") 16 | 17 | if(NOT CPACK_PACKAGING_INSTALL_PREFIX) 18 | set(CPACK_PACKAGING_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}") 19 | endif() 20 | 21 | # DEB packaging configuration 22 | set(CPACK_DEBIAN_PACKAGE_MAINTAINER ${CPACK_PACKAGE_VENDOR}) 23 | 24 | set(CPACK_DEBIAN_PACKAGE_HOMEPAGE 25 | "https://github.com/KhronosGroup/OpenCL-CLHPP") 26 | 27 | set(CPACK_DEBIAN_PACKAGE_VERSION "${PROJECT_VERSION}") 28 | if(DEFINED LATEST_RELEASE_VERSION) 29 | # Remove leading "v", if exists 30 | string(LENGTH "${LATEST_RELEASE_VERSION}" LATEST_RELEASE_VERSION_LENGTH) 31 | string(SUBSTRING "${LATEST_RELEASE_VERSION}" 0 1 LATEST_RELEASE_VERSION_FRONT) 32 | if(LATEST_RELEASE_VERSION_FRONT STREQUAL "v") 33 | string(SUBSTRING "${LATEST_RELEASE_VERSION}" 1 ${LATEST_RELEASE_VERSION_LENGTH} LATEST_RELEASE_VERSION) 34 | endif() 35 | 36 | string(APPEND CPACK_DEBIAN_PACKAGE_VERSION "~${LATEST_RELEASE_VERSION}") 37 | endif() 38 | set(CPACK_DEBIAN_PACKAGE_RELEASE "1") # debian_revision (because this is a non-native pkg) 39 | set(PACKAGE_VERSION_REVISION "${CPACK_DEBIAN_PACKAGE_VERSION}-${CPACK_DEBIAN_PACKAGE_RELEASE}${DEBIAN_VERSION_SUFFIX}") 40 | 41 | set(DEBIAN_PACKAGE_NAME "opencl-clhpp-headers") 42 | set(CPACK_DEBIAN_PACKAGE_NAME 43 | "${DEBIAN_PACKAGE_NAME}" 44 | CACHE STRING "Package name" FORCE) 45 | 46 | set(CPACK_DEBIAN_PACKAGE_SECTION "libdevel") 47 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "all") 48 | 49 | # Dependencies 50 | set(CPACK_DEBIAN_PACKAGE_DEPENDS "opencl-c-headers (>= ${CPACK_DEBIAN_PACKAGE_VERSION})") 51 | set(CPACK_DEBIAN_PACKAGE_BREAKS "opencl-headers (<< ${CPACK_DEBIAN_PACKAGE_VERSION})") 52 | set(CPACK_DEBIAN_PACKAGE_REPLACES "opencl-headers (<< ${CPACK_DEBIAN_PACKAGE_VERSION})") 53 | 54 | # Package file name in deb format: 55 | # _-_.deb 56 | set(CPACK_DEBIAN_FILE_NAME "${DEBIAN_PACKAGE_NAME}_${PACKAGE_VERSION_REVISION}_${CPACK_DEBIAN_PACKAGE_ARCHITECTURE}.deb") 57 | -------------------------------------------------------------------------------- /docs/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | find_package(Doxygen) 2 | 3 | if (DOXYGEN_FOUND) 4 | 5 | configure_file(Doxyfile.in Doxyfile) 6 | add_custom_target( 7 | docs 8 | COMMAND 9 | ${DOXYGEN_EXECUTABLE} 10 | WORKING_DIRECTORY 11 | ${CMAKE_CURRENT_BINARY_DIR} 12 | VERBATIM) 13 | 14 | endif (DOXYGEN_FOUND) 15 | -------------------------------------------------------------------------------- /docs/Doxyfile.in: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.9.1 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "OpenCL C++ Bindings" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = 122 | 123 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124 | # doxygen will generate a detailed section even if there is only a brief 125 | # description. 126 | # The default value is: NO. 127 | 128 | ALWAYS_DETAILED_SEC = NO 129 | 130 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131 | # inherited members of a class in the documentation of that class as if those 132 | # members were ordinary class members. Constructors, destructors and assignment 133 | # operators of the base classes will not be shown. 134 | # The default value is: NO. 135 | 136 | INLINE_INHERITED_MEMB = NO 137 | 138 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 139 | # before files name in the file list and in the header files. If set to NO the 140 | # shortest path that makes the file name unique will be used 141 | # The default value is: YES. 142 | 143 | FULL_PATH_NAMES = NO 144 | 145 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146 | # Stripping is only done if one of the specified strings matches the left-hand 147 | # part of the path. The tag can be used to show relative paths in the file list. 148 | # If left blank the directory from which doxygen is run is used as the path to 149 | # strip. 150 | # 151 | # Note that you can specify absolute paths here, but also relative paths, which 152 | # will be relative from the directory where doxygen is started. 153 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 154 | 155 | STRIP_FROM_PATH = 156 | 157 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 158 | # path mentioned in the documentation of a class, which tells the reader which 159 | # header file to include in order to use a class. If left blank only the name of 160 | # the header file containing the class definition is used. Otherwise one should 161 | # specify the list of include paths that are normally passed to the compiler 162 | # using the -I flag. 163 | 164 | STRIP_FROM_INC_PATH = 165 | 166 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167 | # less readable) file names. This can be useful is your file systems doesn't 168 | # support long names like on DOS, Mac, or CD-ROM. 169 | # The default value is: NO. 170 | 171 | SHORT_NAMES = NO 172 | 173 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174 | # first line (until the first dot) of a Javadoc-style comment as the brief 175 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 176 | # style comments (thus requiring an explicit @brief command for a brief 177 | # description.) 178 | # The default value is: NO. 179 | 180 | JAVADOC_AUTOBRIEF = NO 181 | 182 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 | # line (until the first dot) of a Qt-style comment as the brief description. If 184 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185 | # requiring an explicit \brief command for a brief description.) 186 | # The default value is: NO. 187 | 188 | QT_AUTOBRIEF = NO 189 | 190 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 192 | # a brief description. This used to be the default behavior. The new default is 193 | # to treat a multi-line C++ comment block as a detailed description. Set this 194 | # tag to YES if you prefer the old behavior instead. 195 | # 196 | # Note that setting this tag to YES also means that rational rose comments are 197 | # not recognized any more. 198 | # The default value is: NO. 199 | 200 | MULTILINE_CPP_IS_BRIEF = NO 201 | 202 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 | # documentation from any documented member that it re-implements. 204 | # The default value is: YES. 205 | 206 | INHERIT_DOCS = YES 207 | 208 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 209 | # page for each member. If set to NO, the documentation of a member will be part 210 | # of the file/class/namespace that contains it. 211 | # The default value is: NO. 212 | 213 | SEPARATE_MEMBER_PAGES = NO 214 | 215 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216 | # uses this value to replace tabs by spaces in code fragments. 217 | # Minimum value: 1, maximum value: 16, default value: 4. 218 | 219 | TAB_SIZE = 4 220 | 221 | # This tag can be used to specify a number of aliases that act as commands in 222 | # the documentation. An alias has the form: 223 | # name=value 224 | # For example adding 225 | # "sideeffect=@par Side Effects:\n" 226 | # will allow you to put the command \sideeffect (or @sideeffect) in the 227 | # documentation, which will result in a user-defined paragraph with heading 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert 229 | # newlines. 230 | 231 | ALIASES = 232 | 233 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 234 | # A mapping has the form "name=value". For example adding "class=itcl::class" 235 | # will allow you to use the command class in the itcl::class meaning. 236 | 237 | TCL_SUBST = 238 | 239 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 240 | # only. Doxygen will then generate output that is more tailored for C. For 241 | # instance, some of the names that are used will be different. The list of all 242 | # members will be omitted, etc. 243 | # The default value is: NO. 244 | 245 | OPTIMIZE_OUTPUT_FOR_C = NO 246 | 247 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 248 | # Python sources only. Doxygen will then generate output that is more tailored 249 | # for that language. For instance, namespaces will be presented as packages, 250 | # qualified scopes will look different, etc. 251 | # The default value is: NO. 252 | 253 | OPTIMIZE_OUTPUT_JAVA = NO 254 | 255 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 256 | # sources. Doxygen will then generate output that is tailored for Fortran. 257 | # The default value is: NO. 258 | 259 | OPTIMIZE_FOR_FORTRAN = NO 260 | 261 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 262 | # sources. Doxygen will then generate output that is tailored for VHDL. 263 | # The default value is: NO. 264 | 265 | OPTIMIZE_OUTPUT_VHDL = NO 266 | 267 | # Doxygen selects the parser to use depending on the extension of the files it 268 | # parses. With this tag you can assign which parser to use for a given 269 | # extension. Doxygen has a built-in mapping, but you can override or extend it 270 | # using this tag. The format is ext=language, where ext is a file extension, and 271 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 272 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 273 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 274 | # Fortran. In the later case the parser tries to guess whether the code is fixed 275 | # or free formatted code, this is the default for Fortran type files), VHDL. For 276 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 277 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 278 | # 279 | # Note: For files without extension you can use no_extension as a placeholder. 280 | # 281 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 282 | # the files are not read by doxygen. 283 | 284 | EXTENSION_MAPPING = 285 | 286 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 287 | # according to the Markdown format, which allows for more readable 288 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 289 | # The output of markdown processing is further processed by doxygen, so you can 290 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 291 | # case of backward compatibilities issues. 292 | # The default value is: YES. 293 | 294 | MARKDOWN_SUPPORT = YES 295 | 296 | # When enabled doxygen tries to link words that correspond to documented 297 | # classes, or namespaces to their corresponding documentation. Such a link can 298 | # be prevented in individual cases by putting a % sign in front of the word or 299 | # globally by setting AUTOLINK_SUPPORT to NO. 300 | # The default value is: YES. 301 | 302 | AUTOLINK_SUPPORT = YES 303 | 304 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 305 | # to include (a tag file for) the STL sources as input, then you should set this 306 | # tag to YES in order to let doxygen match functions declarations and 307 | # definitions whose arguments contain STL classes (e.g. func(std::string); 308 | # versus func(std::string) {}). This also make the inheritance and collaboration 309 | # diagrams that involve STL classes more complete and accurate. 310 | # The default value is: NO. 311 | 312 | BUILTIN_STL_SUPPORT = NO 313 | 314 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 315 | # enable parsing support. 316 | # The default value is: NO. 317 | 318 | CPP_CLI_SUPPORT = NO 319 | 320 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 321 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 322 | # will parse them like normal C++ but will assume all classes use public instead 323 | # of private inheritance when no explicit protection keyword is present. 324 | # The default value is: NO. 325 | 326 | SIP_SUPPORT = NO 327 | 328 | # For Microsoft's IDL there are propget and propput attributes to indicate 329 | # getter and setter methods for a property. Setting this option to YES will make 330 | # doxygen to replace the get and set methods by a property in the documentation. 331 | # This will only work if the methods are indeed getting or setting a simple 332 | # type. If this is not the case, or you want to show the methods anyway, you 333 | # should set this option to NO. 334 | # The default value is: YES. 335 | 336 | IDL_PROPERTY_SUPPORT = YES 337 | 338 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 339 | # tag is set to YES then doxygen will reuse the documentation of the first 340 | # member in the group (if any) for the other members of the group. By default 341 | # all members of a group must be documented explicitly. 342 | # The default value is: NO. 343 | 344 | DISTRIBUTE_GROUP_DOC = NO 345 | 346 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 347 | # (for instance a group of public functions) to be put as a subgroup of that 348 | # type (e.g. under the Public Functions section). Set it to NO to prevent 349 | # subgrouping. Alternatively, this can be done per class using the 350 | # \nosubgrouping command. 351 | # The default value is: YES. 352 | 353 | SUBGROUPING = YES 354 | 355 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 356 | # are shown inside the group in which they are included (e.g. using \ingroup) 357 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 358 | # and RTF). 359 | # 360 | # Note that this feature does not work in combination with 361 | # SEPARATE_MEMBER_PAGES. 362 | # The default value is: NO. 363 | 364 | INLINE_GROUPED_CLASSES = NO 365 | 366 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 367 | # with only public data fields or simple typedef fields will be shown inline in 368 | # the documentation of the scope in which they are defined (i.e. file, 369 | # namespace, or group documentation), provided this scope is documented. If set 370 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 371 | # Man pages) or section (for LaTeX and RTF). 372 | # The default value is: NO. 373 | 374 | INLINE_SIMPLE_STRUCTS = NO 375 | 376 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 377 | # enum is documented as struct, union, or enum with the name of the typedef. So 378 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 379 | # with name TypeT. When disabled the typedef will appear as a member of a file, 380 | # namespace, or class. And the struct will be named TypeS. This can typically be 381 | # useful for C code in case the coding convention dictates that all compound 382 | # types are typedef'ed and only the typedef is referenced, never the tag name. 383 | # The default value is: NO. 384 | 385 | TYPEDEF_HIDES_STRUCT = NO 386 | 387 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 388 | # cache is used to resolve symbols given their name and scope. Since this can be 389 | # an expensive process and often the same symbol appears multiple times in the 390 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 391 | # doxygen will become slower. If the cache is too large, memory is wasted. The 392 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 393 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 394 | # symbols. At the end of a run doxygen will report the cache usage and suggest 395 | # the optimal cache size from a speed point of view. 396 | # Minimum value: 0, maximum value: 9, default value: 0. 397 | 398 | LOOKUP_CACHE_SIZE = 0 399 | 400 | #--------------------------------------------------------------------------- 401 | # Build related configuration options 402 | #--------------------------------------------------------------------------- 403 | 404 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 405 | # documentation are documented, even if no documentation was available. Private 406 | # class members and static file members will be hidden unless the 407 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 408 | # Note: This will also disable the warnings about undocumented members that are 409 | # normally produced when WARNINGS is set to YES. 410 | # The default value is: NO. 411 | 412 | EXTRACT_ALL = NO 413 | 414 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 415 | # be included in the documentation. 416 | # The default value is: NO. 417 | 418 | EXTRACT_PRIVATE = NO 419 | 420 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 421 | # scope will be included in the documentation. 422 | # The default value is: NO. 423 | 424 | EXTRACT_PACKAGE = NO 425 | 426 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 427 | # included in the documentation. 428 | # The default value is: NO. 429 | 430 | EXTRACT_STATIC = NO 431 | 432 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 433 | # locally in source files will be included in the documentation. If set to NO, 434 | # only classes defined in header files are included. Does not have any effect 435 | # for Java sources. 436 | # The default value is: YES. 437 | 438 | EXTRACT_LOCAL_CLASSES = YES 439 | 440 | # This flag is only useful for Objective-C code. If set to YES, local methods, 441 | # which are defined in the implementation section but not in the interface are 442 | # included in the documentation. If set to NO, only methods in the interface are 443 | # included. 444 | # The default value is: NO. 445 | 446 | EXTRACT_LOCAL_METHODS = NO 447 | 448 | # If this flag is set to YES, the members of anonymous namespaces will be 449 | # extracted and appear in the documentation as a namespace called 450 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 451 | # the file that contains the anonymous namespace. By default anonymous namespace 452 | # are hidden. 453 | # The default value is: NO. 454 | 455 | EXTRACT_ANON_NSPACES = NO 456 | 457 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 458 | # undocumented members inside documented classes or files. If set to NO these 459 | # members will be included in the various overviews, but no documentation 460 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 461 | # The default value is: NO. 462 | 463 | HIDE_UNDOC_MEMBERS = NO 464 | 465 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 466 | # undocumented classes that are normally visible in the class hierarchy. If set 467 | # to NO, these classes will be included in the various overviews. This option 468 | # has no effect if EXTRACT_ALL is enabled. 469 | # The default value is: NO. 470 | 471 | HIDE_UNDOC_CLASSES = NO 472 | 473 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 474 | # (class|struct|union) declarations. If set to NO, these declarations will be 475 | # included in the documentation. 476 | # The default value is: NO. 477 | 478 | HIDE_FRIEND_COMPOUNDS = NO 479 | 480 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 481 | # documentation blocks found inside the body of a function. If set to NO, these 482 | # blocks will be appended to the function's detailed documentation block. 483 | # The default value is: NO. 484 | 485 | HIDE_IN_BODY_DOCS = NO 486 | 487 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 488 | # \internal command is included. If the tag is set to NO then the documentation 489 | # will be excluded. Set it to YES to include the internal documentation. 490 | # The default value is: NO. 491 | 492 | INTERNAL_DOCS = NO 493 | 494 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 495 | # names in lower-case letters. If set to YES, upper-case letters are also 496 | # allowed. This is useful if you have classes or files whose names only differ 497 | # in case and if your file system supports case sensitive file names. Windows 498 | # and Mac users are advised to set this option to NO. 499 | # The default value is: system dependent. 500 | 501 | CASE_SENSE_NAMES = NO 502 | 503 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 504 | # their full class and namespace scopes in the documentation. If set to YES, the 505 | # scope will be hidden. 506 | # The default value is: NO. 507 | 508 | HIDE_SCOPE_NAMES = NO 509 | 510 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 511 | # append additional text to a page's title, such as Class Reference. If set to 512 | # YES the compound reference will be hidden. 513 | # The default value is: NO. 514 | 515 | HIDE_COMPOUND_REFERENCE= NO 516 | 517 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 518 | # the files that are included by a file in the documentation of that file. 519 | # The default value is: YES. 520 | 521 | SHOW_INCLUDE_FILES = NO 522 | 523 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 524 | # grouped member an include statement to the documentation, telling the reader 525 | # which file to include in order to use the member. 526 | # The default value is: NO. 527 | 528 | SHOW_GROUPED_MEMB_INC = NO 529 | 530 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 531 | # files with double quotes in the documentation rather than with sharp brackets. 532 | # The default value is: NO. 533 | 534 | FORCE_LOCAL_INCLUDES = NO 535 | 536 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 537 | # documentation for inline members. 538 | # The default value is: YES. 539 | 540 | INLINE_INFO = YES 541 | 542 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 543 | # (detailed) documentation of file and class members alphabetically by member 544 | # name. If set to NO, the members will appear in declaration order. 545 | # The default value is: YES. 546 | 547 | SORT_MEMBER_DOCS = YES 548 | 549 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 550 | # descriptions of file, namespace and class members alphabetically by member 551 | # name. If set to NO, the members will appear in declaration order. Note that 552 | # this will also influence the order of the classes in the class list. 553 | # The default value is: NO. 554 | 555 | SORT_BRIEF_DOCS = NO 556 | 557 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 558 | # (brief and detailed) documentation of class members so that constructors and 559 | # destructors are listed first. If set to NO the constructors will appear in the 560 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 561 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 562 | # member documentation. 563 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 564 | # detailed member documentation. 565 | # The default value is: NO. 566 | 567 | SORT_MEMBERS_CTORS_1ST = NO 568 | 569 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 570 | # of group names into alphabetical order. If set to NO the group names will 571 | # appear in their defined order. 572 | # The default value is: NO. 573 | 574 | SORT_GROUP_NAMES = NO 575 | 576 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 577 | # fully-qualified names, including namespaces. If set to NO, the class list will 578 | # be sorted only by class name, not including the namespace part. 579 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 580 | # Note: This option applies only to the class list, not to the alphabetical 581 | # list. 582 | # The default value is: NO. 583 | 584 | SORT_BY_SCOPE_NAME = NO 585 | 586 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 587 | # type resolution of all parameters of a function it will reject a match between 588 | # the prototype and the implementation of a member function even if there is 589 | # only one candidate or it is obvious which candidate to choose by doing a 590 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 591 | # accept a match between prototype and implementation in such cases. 592 | # The default value is: NO. 593 | 594 | STRICT_PROTO_MATCHING = NO 595 | 596 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 597 | # list. This list is created by putting \todo commands in the documentation. 598 | # The default value is: YES. 599 | 600 | GENERATE_TODOLIST = YES 601 | 602 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 603 | # list. This list is created by putting \test commands in the documentation. 604 | # The default value is: YES. 605 | 606 | GENERATE_TESTLIST = YES 607 | 608 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 609 | # list. This list is created by putting \bug commands in the documentation. 610 | # The default value is: YES. 611 | 612 | GENERATE_BUGLIST = YES 613 | 614 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 615 | # the deprecated list. This list is created by putting \deprecated commands in 616 | # the documentation. 617 | # The default value is: YES. 618 | 619 | GENERATE_DEPRECATEDLIST= YES 620 | 621 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 622 | # sections, marked by \if ... \endif and \cond 623 | # ... \endcond blocks. 624 | 625 | ENABLED_SECTIONS = 626 | 627 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 628 | # initial value of a variable or macro / define can have for it to appear in the 629 | # documentation. If the initializer consists of more lines than specified here 630 | # it will be hidden. Use a value of 0 to hide initializers completely. The 631 | # appearance of the value of individual variables and macros / defines can be 632 | # controlled using \showinitializer or \hideinitializer command in the 633 | # documentation regardless of this setting. 634 | # Minimum value: 0, maximum value: 10000, default value: 30. 635 | 636 | MAX_INITIALIZER_LINES = 30 637 | 638 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 639 | # the bottom of the documentation of classes and structs. If set to YES, the 640 | # list will mention the files that were used to generate the documentation. 641 | # The default value is: YES. 642 | 643 | SHOW_USED_FILES = YES 644 | 645 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 646 | # will remove the Files entry from the Quick Index and from the Folder Tree View 647 | # (if specified). 648 | # The default value is: YES. 649 | 650 | SHOW_FILES = YES 651 | 652 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 653 | # page. This will remove the Namespaces entry from the Quick Index and from the 654 | # Folder Tree View (if specified). 655 | # The default value is: YES. 656 | 657 | SHOW_NAMESPACES = YES 658 | 659 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 660 | # doxygen should invoke to get the current version for each file (typically from 661 | # the version control system). Doxygen will invoke the program by executing (via 662 | # popen()) the command command input-file, where command is the value of the 663 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 664 | # by doxygen. Whatever the program writes to standard output is used as the file 665 | # version. For an example see the documentation. 666 | 667 | FILE_VERSION_FILTER = 668 | 669 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 670 | # by doxygen. The layout file controls the global structure of the generated 671 | # output files in an output format independent way. To create the layout file 672 | # that represents doxygen's defaults, run doxygen with the -l option. You can 673 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 674 | # will be used as the name of the layout file. 675 | # 676 | # Note that if you run doxygen from a directory containing a file called 677 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 678 | # tag is left empty. 679 | 680 | LAYOUT_FILE = 681 | 682 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 683 | # the reference definitions. This must be a list of .bib files. The .bib 684 | # extension is automatically appended if omitted. This requires the bibtex tool 685 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 686 | # For LaTeX the style of the bibliography can be controlled using 687 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 688 | # search path. See also \cite for info how to create references. 689 | 690 | CITE_BIB_FILES = 691 | 692 | #--------------------------------------------------------------------------- 693 | # Configuration options related to warning and progress messages 694 | #--------------------------------------------------------------------------- 695 | 696 | # The QUIET tag can be used to turn on/off the messages that are generated to 697 | # standard output by doxygen. If QUIET is set to YES this implies that the 698 | # messages are off. 699 | # The default value is: NO. 700 | 701 | QUIET = NO 702 | 703 | # The WARNINGS tag can be used to turn on/off the warning messages that are 704 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 705 | # this implies that the warnings are on. 706 | # 707 | # Tip: Turn warnings on while writing the documentation. 708 | # The default value is: YES. 709 | 710 | WARNINGS = YES 711 | 712 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 713 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 714 | # will automatically be disabled. 715 | # The default value is: YES. 716 | 717 | WARN_IF_UNDOCUMENTED = YES 718 | 719 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 720 | # potential errors in the documentation, such as not documenting some parameters 721 | # in a documented function, or documenting parameters that don't exist or using 722 | # markup commands wrongly. 723 | # The default value is: YES. 724 | 725 | WARN_IF_DOC_ERROR = YES 726 | 727 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 728 | # are documented, but have no documentation for their parameters or return 729 | # value. If set to NO, doxygen will only warn about wrong or incomplete 730 | # parameter documentation, but not about the absence of documentation. 731 | # The default value is: NO. 732 | 733 | WARN_NO_PARAMDOC = NO 734 | 735 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 736 | # can produce. The string should contain the $file, $line, and $text tags, which 737 | # will be replaced by the file and line number from which the warning originated 738 | # and the warning text. Optionally the format may contain $version, which will 739 | # be replaced by the version of the file (if it could be obtained via 740 | # FILE_VERSION_FILTER) 741 | # The default value is: $file:$line: $text. 742 | 743 | WARN_FORMAT = "$file:$line: $text" 744 | 745 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 746 | # messages should be written. If left blank the output is written to standard 747 | # error (stderr). 748 | 749 | WARN_LOGFILE = 750 | 751 | #--------------------------------------------------------------------------- 752 | # Configuration options related to the input files 753 | #--------------------------------------------------------------------------- 754 | 755 | # The INPUT tag is used to specify the files and/or directories that contain 756 | # documented source files. You may enter file names like myfile.cpp or 757 | # directories like /usr/src/myproject. Separate the files or directories with 758 | # spaces. 759 | # Note: If this tag is empty the current directory is searched. 760 | 761 | INPUT = @PROJECT_SOURCE_DIR@/include/CL/opencl.hpp 762 | 763 | # This tag can be used to specify the character encoding of the source files 764 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 765 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 766 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 767 | # possible encodings. 768 | # The default value is: UTF-8. 769 | 770 | INPUT_ENCODING = UTF-8 771 | 772 | # If the value of the INPUT tag contains directories, you can use the 773 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 774 | # *.h) to filter out the source-files in the directories. If left blank the 775 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 776 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 777 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 778 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 779 | # *.qsf, *.as and *.js. 780 | 781 | FILE_PATTERNS = 782 | 783 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 784 | # be searched for input files as well. 785 | # The default value is: NO. 786 | 787 | RECURSIVE = NO 788 | 789 | # The EXCLUDE tag can be used to specify files and/or directories that should be 790 | # excluded from the INPUT source files. This way you can easily exclude a 791 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 792 | # 793 | # Note that relative paths are relative to the directory from which doxygen is 794 | # run. 795 | 796 | EXCLUDE = 797 | 798 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 799 | # directories that are symbolic links (a Unix file system feature) are excluded 800 | # from the input. 801 | # The default value is: NO. 802 | 803 | EXCLUDE_SYMLINKS = NO 804 | 805 | # If the value of the INPUT tag contains directories, you can use the 806 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 807 | # certain files from those directories. 808 | # 809 | # Note that the wildcards are matched against the file with absolute path, so to 810 | # exclude all test directories for example use the pattern */test/* 811 | 812 | EXCLUDE_PATTERNS = 813 | 814 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 815 | # (namespaces, classes, functions, etc.) that should be excluded from the 816 | # output. The symbol name can be a fully qualified name, a word, or if the 817 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 818 | # AClass::ANamespace, ANamespace::*Test 819 | # 820 | # Note that the wildcards are matched against the file with absolute path, so to 821 | # exclude all test directories use the pattern */test/* 822 | 823 | EXCLUDE_SYMBOLS = 824 | 825 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 826 | # that contain example code fragments that are included (see the \include 827 | # command). 828 | 829 | EXAMPLE_PATH = 830 | 831 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 832 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 833 | # *.h) to filter out the source-files in the directories. If left blank all 834 | # files are included. 835 | 836 | EXAMPLE_PATTERNS = 837 | 838 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 839 | # searched for input files to be used with the \include or \dontinclude commands 840 | # irrespective of the value of the RECURSIVE tag. 841 | # The default value is: NO. 842 | 843 | EXAMPLE_RECURSIVE = NO 844 | 845 | # The IMAGE_PATH tag can be used to specify one or more files or directories 846 | # that contain images that are to be included in the documentation (see the 847 | # \image command). 848 | 849 | IMAGE_PATH = 850 | 851 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 852 | # invoke to filter for each input file. Doxygen will invoke the filter program 853 | # by executing (via popen()) the command: 854 | # 855 | # 856 | # 857 | # where is the value of the INPUT_FILTER tag, and is the 858 | # name of an input file. Doxygen will then use the output that the filter 859 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 860 | # will be ignored. 861 | # 862 | # Note that the filter must not add or remove lines; it is applied before the 863 | # code is scanned, but not when the output code is generated. If lines are added 864 | # or removed, the anchors will not be placed correctly. 865 | 866 | INPUT_FILTER = 867 | 868 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 869 | # basis. Doxygen will compare the file name with each pattern and apply the 870 | # filter if there is a match. The filters are a list of the form: pattern=filter 871 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 872 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 873 | # patterns match the file name, INPUT_FILTER is applied. 874 | 875 | FILTER_PATTERNS = 876 | 877 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 878 | # INPUT_FILTER) will also be used to filter the input files that are used for 879 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 880 | # The default value is: NO. 881 | 882 | FILTER_SOURCE_FILES = NO 883 | 884 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 885 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 886 | # it is also possible to disable source filtering for a specific pattern using 887 | # *.ext= (so without naming a filter). 888 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 889 | 890 | FILTER_SOURCE_PATTERNS = 891 | 892 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 893 | # is part of the input, its contents will be placed on the main page 894 | # (index.html). This can be useful if you have a project on for instance GitHub 895 | # and want to reuse the introduction page also for the doxygen output. 896 | 897 | USE_MDFILE_AS_MAINPAGE = 898 | 899 | #--------------------------------------------------------------------------- 900 | # Configuration options related to source browsing 901 | #--------------------------------------------------------------------------- 902 | 903 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 904 | # generated. Documented entities will be cross-referenced with these sources. 905 | # 906 | # Note: To get rid of all source code in the generated output, make sure that 907 | # also VERBATIM_HEADERS is set to NO. 908 | # The default value is: NO. 909 | 910 | SOURCE_BROWSER = YES 911 | 912 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 913 | # classes and enums directly into the documentation. 914 | # The default value is: NO. 915 | 916 | INLINE_SOURCES = NO 917 | 918 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 919 | # special comment blocks from generated source code fragments. Normal C, C++ and 920 | # Fortran comments will always remain visible. 921 | # The default value is: YES. 922 | 923 | STRIP_CODE_COMMENTS = YES 924 | 925 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 926 | # function all documented functions referencing it will be listed. 927 | # The default value is: NO. 928 | 929 | REFERENCED_BY_RELATION = NO 930 | 931 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 932 | # all documented entities called/used by that function will be listed. 933 | # The default value is: NO. 934 | 935 | REFERENCES_RELATION = NO 936 | 937 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 938 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 939 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 940 | # link to the documentation. 941 | # The default value is: YES. 942 | 943 | REFERENCES_LINK_SOURCE = YES 944 | 945 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 946 | # source code will show a tooltip with additional information such as prototype, 947 | # brief description and links to the definition and documentation. Since this 948 | # will make the HTML file larger and loading of large files a bit slower, you 949 | # can opt to disable this feature. 950 | # The default value is: YES. 951 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 952 | 953 | SOURCE_TOOLTIPS = YES 954 | 955 | # If the USE_HTAGS tag is set to YES then the references to source code will 956 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 957 | # source browser. The htags tool is part of GNU's global source tagging system 958 | # (see http://www.gnu.org/software/global/global.html). You will need version 959 | # 4.8.6 or higher. 960 | # 961 | # To use it do the following: 962 | # - Install the latest version of global 963 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 964 | # - Make sure the INPUT points to the root of the source tree 965 | # - Run doxygen as normal 966 | # 967 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 968 | # tools must be available from the command line (i.e. in the search path). 969 | # 970 | # The result: instead of the source browser generated by doxygen, the links to 971 | # source code will now point to the output of htags. 972 | # The default value is: NO. 973 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 974 | 975 | USE_HTAGS = NO 976 | 977 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 978 | # verbatim copy of the header file for each class for which an include is 979 | # specified. Set to NO to disable this. 980 | # See also: Section \class. 981 | # The default value is: YES. 982 | 983 | VERBATIM_HEADERS = YES 984 | 985 | #--------------------------------------------------------------------------- 986 | # Configuration options related to the alphabetical class index 987 | #--------------------------------------------------------------------------- 988 | 989 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 990 | # compounds will be generated. Enable this if the project contains a lot of 991 | # classes, structs, unions or interfaces. 992 | # The default value is: YES. 993 | 994 | ALPHABETICAL_INDEX = YES 995 | 996 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 997 | # which the alphabetical index list will be split. 998 | # Minimum value: 1, maximum value: 20, default value: 5. 999 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1000 | 1001 | COLS_IN_ALPHA_INDEX = 5 1002 | 1003 | # In case all classes in a project start with a common prefix, all classes will 1004 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1005 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1006 | # while generating the index headers. 1007 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1008 | 1009 | IGNORE_PREFIX = 1010 | 1011 | #--------------------------------------------------------------------------- 1012 | # Configuration options related to the HTML output 1013 | #--------------------------------------------------------------------------- 1014 | 1015 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1016 | # The default value is: YES. 1017 | 1018 | GENERATE_HTML = YES 1019 | 1020 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1021 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1022 | # it. 1023 | # The default directory is: html. 1024 | # This tag requires that the tag GENERATE_HTML is set to YES. 1025 | 1026 | HTML_OUTPUT = html 1027 | 1028 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1029 | # generated HTML page (for example: .htm, .php, .asp). 1030 | # The default value is: .html. 1031 | # This tag requires that the tag GENERATE_HTML is set to YES. 1032 | 1033 | HTML_FILE_EXTENSION = .html 1034 | 1035 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1036 | # each generated HTML page. If the tag is left blank doxygen will generate a 1037 | # standard header. 1038 | # 1039 | # To get valid HTML the header file that includes any scripts and style sheets 1040 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1041 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1042 | # default header using 1043 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1044 | # YourConfigFile 1045 | # and then modify the file new_header.html. See also section "Doxygen usage" 1046 | # for information on how to generate the default header that doxygen normally 1047 | # uses. 1048 | # Note: The header is subject to change so you typically have to regenerate the 1049 | # default header when upgrading to a newer version of doxygen. For a description 1050 | # of the possible markers and block names see the documentation. 1051 | # This tag requires that the tag GENERATE_HTML is set to YES. 1052 | 1053 | HTML_HEADER = 1054 | 1055 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1056 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1057 | # footer. See HTML_HEADER for more information on how to generate a default 1058 | # footer and what special commands can be used inside the footer. See also 1059 | # section "Doxygen usage" for information on how to generate the default footer 1060 | # that doxygen normally uses. 1061 | # This tag requires that the tag GENERATE_HTML is set to YES. 1062 | 1063 | HTML_FOOTER = 1064 | 1065 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1066 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1067 | # the HTML output. If left blank doxygen will generate a default style sheet. 1068 | # See also section "Doxygen usage" for information on how to generate the style 1069 | # sheet that doxygen normally uses. 1070 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1071 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1072 | # obsolete. 1073 | # This tag requires that the tag GENERATE_HTML is set to YES. 1074 | 1075 | HTML_STYLESHEET = 1076 | 1077 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1078 | # cascading style sheets that are included after the standard style sheets 1079 | # created by doxygen. Using this option one can overrule certain style aspects. 1080 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1081 | # standard style sheet and is therefore more robust against future updates. 1082 | # Doxygen will copy the style sheet files to the output directory. 1083 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1084 | # style sheet in the list overrules the setting of the previous ones in the 1085 | # list). For an example see the documentation. 1086 | # This tag requires that the tag GENERATE_HTML is set to YES. 1087 | 1088 | HTML_EXTRA_STYLESHEET = 1089 | 1090 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1091 | # other source files which should be copied to the HTML output directory. Note 1092 | # that these files will be copied to the base HTML output directory. Use the 1093 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1094 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1095 | # files will be copied as-is; there are no commands or markers available. 1096 | # This tag requires that the tag GENERATE_HTML is set to YES. 1097 | 1098 | HTML_EXTRA_FILES = 1099 | 1100 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1101 | # will adjust the colors in the style sheet and background images according to 1102 | # this color. Hue is specified as an angle on a colorwheel, see 1103 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1104 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1105 | # purple, and 360 is red again. 1106 | # Minimum value: 0, maximum value: 359, default value: 220. 1107 | # This tag requires that the tag GENERATE_HTML is set to YES. 1108 | 1109 | HTML_COLORSTYLE_HUE = 220 1110 | 1111 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1112 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1113 | # value of 255 will produce the most vivid colors. 1114 | # Minimum value: 0, maximum value: 255, default value: 100. 1115 | # This tag requires that the tag GENERATE_HTML is set to YES. 1116 | 1117 | HTML_COLORSTYLE_SAT = 100 1118 | 1119 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1120 | # luminance component of the colors in the HTML output. Values below 100 1121 | # gradually make the output lighter, whereas values above 100 make the output 1122 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1123 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1124 | # change the gamma. 1125 | # Minimum value: 40, maximum value: 240, default value: 80. 1126 | # This tag requires that the tag GENERATE_HTML is set to YES. 1127 | 1128 | HTML_COLORSTYLE_GAMMA = 80 1129 | 1130 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1131 | # page will contain the date and time when the page was generated. Setting this 1132 | # to NO can help when comparing the output of multiple runs. 1133 | # The default value is: YES. 1134 | # This tag requires that the tag GENERATE_HTML is set to YES. 1135 | 1136 | HTML_TIMESTAMP = YES 1137 | 1138 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1139 | # documentation will contain sections that can be hidden and shown after the 1140 | # page has loaded. 1141 | # The default value is: NO. 1142 | # This tag requires that the tag GENERATE_HTML is set to YES. 1143 | 1144 | HTML_DYNAMIC_SECTIONS = NO 1145 | 1146 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1147 | # shown in the various tree structured indices initially; the user can expand 1148 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1149 | # such a level that at most the specified number of entries are visible (unless 1150 | # a fully collapsed tree already exceeds this amount). So setting the number of 1151 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1152 | # representing an infinite number of entries and will result in a full expanded 1153 | # tree by default. 1154 | # Minimum value: 0, maximum value: 9999, default value: 100. 1155 | # This tag requires that the tag GENERATE_HTML is set to YES. 1156 | 1157 | HTML_INDEX_NUM_ENTRIES = 100 1158 | 1159 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1160 | # generated that can be used as input for Apple's Xcode 3 integrated development 1161 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1162 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1163 | # Makefile in the HTML output directory. Running make will produce the docset in 1164 | # that directory and running make install will install the docset in 1165 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1166 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1167 | # for more information. 1168 | # The default value is: NO. 1169 | # This tag requires that the tag GENERATE_HTML is set to YES. 1170 | 1171 | GENERATE_DOCSET = NO 1172 | 1173 | # This tag determines the name of the docset feed. A documentation feed provides 1174 | # an umbrella under which multiple documentation sets from a single provider 1175 | # (such as a company or product suite) can be grouped. 1176 | # The default value is: Doxygen generated docs. 1177 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1178 | 1179 | DOCSET_FEEDNAME = "Doxygen generated docs" 1180 | 1181 | # This tag specifies a string that should uniquely identify the documentation 1182 | # set bundle. This should be a reverse domain-name style string, e.g. 1183 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1184 | # The default value is: org.doxygen.Project. 1185 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1186 | 1187 | DOCSET_BUNDLE_ID = org.doxygen.Project 1188 | 1189 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1190 | # the documentation publisher. This should be a reverse domain-name style 1191 | # string, e.g. com.mycompany.MyDocSet.documentation. 1192 | # The default value is: org.doxygen.Publisher. 1193 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1194 | 1195 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1196 | 1197 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1198 | # The default value is: Publisher. 1199 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1200 | 1201 | DOCSET_PUBLISHER_NAME = Publisher 1202 | 1203 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1204 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1205 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1206 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1207 | # Windows. 1208 | # 1209 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1210 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1211 | # files are now used as the Windows 98 help format, and will replace the old 1212 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1213 | # HTML files also contain an index, a table of contents, and you can search for 1214 | # words in the documentation. The HTML workshop also contains a viewer for 1215 | # compressed HTML files. 1216 | # The default value is: NO. 1217 | # This tag requires that the tag GENERATE_HTML is set to YES. 1218 | 1219 | GENERATE_HTMLHELP = NO 1220 | 1221 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1222 | # file. You can add a path in front of the file if the result should not be 1223 | # written to the html output directory. 1224 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1225 | 1226 | CHM_FILE = 1227 | 1228 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1229 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1230 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1231 | # The file has to be specified with full path. 1232 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1233 | 1234 | HHC_LOCATION = 1235 | 1236 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1237 | # (YES) or that it should be included in the master .chm file (NO). 1238 | # The default value is: NO. 1239 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1240 | 1241 | GENERATE_CHI = NO 1242 | 1243 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1244 | # and project file content. 1245 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1246 | 1247 | CHM_INDEX_ENCODING = 1248 | 1249 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1250 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1251 | # enables the Previous and Next buttons. 1252 | # The default value is: NO. 1253 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1254 | 1255 | BINARY_TOC = NO 1256 | 1257 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1258 | # the table of contents of the HTML help documentation and to the tree view. 1259 | # The default value is: NO. 1260 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1261 | 1262 | TOC_EXPAND = NO 1263 | 1264 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1265 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1266 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1267 | # (.qch) of the generated HTML documentation. 1268 | # The default value is: NO. 1269 | # This tag requires that the tag GENERATE_HTML is set to YES. 1270 | 1271 | GENERATE_QHP = NO 1272 | 1273 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1274 | # the file name of the resulting .qch file. The path specified is relative to 1275 | # the HTML output folder. 1276 | # This tag requires that the tag GENERATE_QHP is set to YES. 1277 | 1278 | QCH_FILE = 1279 | 1280 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1281 | # Project output. For more information please see Qt Help Project / Namespace 1282 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1283 | # The default value is: org.doxygen.Project. 1284 | # This tag requires that the tag GENERATE_QHP is set to YES. 1285 | 1286 | QHP_NAMESPACE = org.doxygen.Project 1287 | 1288 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1289 | # Help Project output. For more information please see Qt Help Project / Virtual 1290 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1291 | # folders). 1292 | # The default value is: doc. 1293 | # This tag requires that the tag GENERATE_QHP is set to YES. 1294 | 1295 | QHP_VIRTUAL_FOLDER = doc 1296 | 1297 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1298 | # filter to add. For more information please see Qt Help Project / Custom 1299 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1300 | # filters). 1301 | # This tag requires that the tag GENERATE_QHP is set to YES. 1302 | 1303 | QHP_CUST_FILTER_NAME = 1304 | 1305 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1306 | # custom filter to add. For more information please see Qt Help Project / Custom 1307 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1308 | # filters). 1309 | # This tag requires that the tag GENERATE_QHP is set to YES. 1310 | 1311 | QHP_CUST_FILTER_ATTRS = 1312 | 1313 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1314 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1315 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1316 | # This tag requires that the tag GENERATE_QHP is set to YES. 1317 | 1318 | QHP_SECT_FILTER_ATTRS = 1319 | 1320 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1321 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1322 | # generated .qhp file. 1323 | # This tag requires that the tag GENERATE_QHP is set to YES. 1324 | 1325 | QHG_LOCATION = 1326 | 1327 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1328 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1329 | # install this plugin and make it available under the help contents menu in 1330 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1331 | # to be copied into the plugins directory of eclipse. The name of the directory 1332 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1333 | # After copying Eclipse needs to be restarted before the help appears. 1334 | # The default value is: NO. 1335 | # This tag requires that the tag GENERATE_HTML is set to YES. 1336 | 1337 | GENERATE_ECLIPSEHELP = NO 1338 | 1339 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1340 | # the directory name containing the HTML and XML files should also have this 1341 | # name. Each documentation set should have its own identifier. 1342 | # The default value is: org.doxygen.Project. 1343 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1344 | 1345 | ECLIPSE_DOC_ID = org.doxygen.Project 1346 | 1347 | # If you want full control over the layout of the generated HTML pages it might 1348 | # be necessary to disable the index and replace it with your own. The 1349 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1350 | # of each HTML page. A value of NO enables the index and the value YES disables 1351 | # it. Since the tabs in the index contain the same information as the navigation 1352 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1353 | # The default value is: NO. 1354 | # This tag requires that the tag GENERATE_HTML is set to YES. 1355 | 1356 | DISABLE_INDEX = NO 1357 | 1358 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1359 | # structure should be generated to display hierarchical information. If the tag 1360 | # value is set to YES, a side panel will be generated containing a tree-like 1361 | # index structure (just like the one that is generated for HTML Help). For this 1362 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1363 | # (i.e. any modern browser). Windows users are probably better off using the 1364 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1365 | # further fine-tune the look of the index. As an example, the default style 1366 | # sheet generated by doxygen has an example that shows how to put an image at 1367 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1368 | # the same information as the tab index, you could consider setting 1369 | # DISABLE_INDEX to YES when enabling this option. 1370 | # The default value is: NO. 1371 | # This tag requires that the tag GENERATE_HTML is set to YES. 1372 | 1373 | GENERATE_TREEVIEW = YES 1374 | 1375 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1376 | # doxygen will group on one line in the generated HTML documentation. 1377 | # 1378 | # Note that a value of 0 will completely suppress the enum values from appearing 1379 | # in the overview section. 1380 | # Minimum value: 0, maximum value: 20, default value: 4. 1381 | # This tag requires that the tag GENERATE_HTML is set to YES. 1382 | 1383 | ENUM_VALUES_PER_LINE = 4 1384 | 1385 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1386 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1387 | # Minimum value: 0, maximum value: 1500, default value: 250. 1388 | # This tag requires that the tag GENERATE_HTML is set to YES. 1389 | 1390 | TREEVIEW_WIDTH = 250 1391 | 1392 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1393 | # external symbols imported via tag files in a separate window. 1394 | # The default value is: NO. 1395 | # This tag requires that the tag GENERATE_HTML is set to YES. 1396 | 1397 | EXT_LINKS_IN_WINDOW = NO 1398 | 1399 | # Use this tag to change the font size of LaTeX formulas included as images in 1400 | # the HTML documentation. When you change the font size after a successful 1401 | # doxygen run you need to manually remove any form_*.png images from the HTML 1402 | # output directory to force them to be regenerated. 1403 | # Minimum value: 8, maximum value: 50, default value: 10. 1404 | # This tag requires that the tag GENERATE_HTML is set to YES. 1405 | 1406 | FORMULA_FONTSIZE = 10 1407 | 1408 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1409 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1410 | # supported properly for IE 6.0, but are supported on all modern browsers. 1411 | # 1412 | # Note that when changing this option you need to delete any form_*.png files in 1413 | # the HTML output directory before the changes have effect. 1414 | # The default value is: YES. 1415 | # This tag requires that the tag GENERATE_HTML is set to YES. 1416 | 1417 | FORMULA_TRANSPARENT = YES 1418 | 1419 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1420 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1421 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1422 | # installed or if you want to formulas look prettier in the HTML output. When 1423 | # enabled you may also need to install MathJax separately and configure the path 1424 | # to it using the MATHJAX_RELPATH option. 1425 | # The default value is: NO. 1426 | # This tag requires that the tag GENERATE_HTML is set to YES. 1427 | 1428 | USE_MATHJAX = NO 1429 | 1430 | # When MathJax is enabled you can set the default output format to be used for 1431 | # the MathJax output. See the MathJax site (see: 1432 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1433 | # Possible values are: HTML-CSS (which is slower, but has the best 1434 | # compatibility), NativeMML (i.e. MathML) and SVG. 1435 | # The default value is: HTML-CSS. 1436 | # This tag requires that the tag USE_MATHJAX is set to YES. 1437 | 1438 | MATHJAX_FORMAT = HTML-CSS 1439 | 1440 | # When MathJax is enabled you need to specify the location relative to the HTML 1441 | # output directory using the MATHJAX_RELPATH option. The destination directory 1442 | # should contain the MathJax.js script. For instance, if the mathjax directory 1443 | # is located at the same level as the HTML output directory, then 1444 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1445 | # Content Delivery Network so you can quickly see the result without installing 1446 | # MathJax. However, it is strongly recommended to install a local copy of 1447 | # MathJax from http://www.mathjax.org before deployment. 1448 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1449 | # This tag requires that the tag USE_MATHJAX is set to YES. 1450 | 1451 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1452 | 1453 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1454 | # extension names that should be enabled during MathJax rendering. For example 1455 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1456 | # This tag requires that the tag USE_MATHJAX is set to YES. 1457 | 1458 | MATHJAX_EXTENSIONS = 1459 | 1460 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1461 | # of code that will be used on startup of the MathJax code. See the MathJax site 1462 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1463 | # example see the documentation. 1464 | # This tag requires that the tag USE_MATHJAX is set to YES. 1465 | 1466 | MATHJAX_CODEFILE = 1467 | 1468 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1469 | # the HTML output. The underlying search engine uses javascript and DHTML and 1470 | # should work on any modern browser. Note that when using HTML help 1471 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1472 | # there is already a search function so this one should typically be disabled. 1473 | # For large projects the javascript based search engine can be slow, then 1474 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1475 | # search using the keyboard; to jump to the search box use + S 1476 | # (what the is depends on the OS and browser, but it is typically 1477 | # , /