diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 77f30a49..2fe637c0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,6 +20,7 @@ concurrency: jobs: ## Build Jobs ## + ## Linux build-centos8: secrets: inherit @@ -83,53 +84,22 @@ jobs: artifact-out: build-rocky8-7 artifact-path: build - ## Dev Build Jobs ## - ## Linux - cache-ospray-rocky8-7: - secrets: inherit - uses: ./.github/workflows/cache-ospray.yml - with: - image: rockylinux:8.7 - ospray-version: devel - rkcommon-version: devel - - build-rocky8-7-dev: - needs: cache-ospray-rocky8-7 - uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/docker.yml@main - with: - image: rockylinux:8.7 - cmd: | - module load cmake/3.25.3 - module load intel/2022.1 - export CC=icx - export CXX=icpx - export CXXFLAGS="-fhonor-infinities -fhonor-nans" - export CFLAGS=$CXXFLAGS - export CACHE_DIR=${{ needs.cache-ospray-rocky8-7.outputs.cache-dir }} - export OSPRAY_VER=${{ needs.cache-ospray-rocky8-7.outputs.ospray-version }} - export CMAKE_PREFIX_PATH=$CACHE_DIR/ospray-$OSPRAY_VER/build/install - export TBB_ROOT=$CACHE_DIR/ospray-$OSPRAY_VER/build/tbb/src/tbb - cmake -L -S . -B build -DENABLE_OPENIMAGEIO=OFF -DENABLE_OPENVDB=OFF -DENABLE_EXR=OFF - cmake --build build -- -j`nproc` - artifact-path: build - artifact-out: build-rocky8-7-dev - ## MacOS - build-macos-clang-dev: + build-macos-clang: uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/macos.yml@main with: cmd: | - gitlab/macos-dev.sh + gitlab/macos.sh artifact-out: build-macos artifact-path: build-macos ## Windows - build-windows-msvc15-dev: + build-windows-msvc15: uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/windows.yml@main with: cmd: | $env:Python3_ROOT = "N:/packages/apps/python/3.9.7/windows" - gitlab\win-dev.ps1 + gitlab\win.ps1 artifact-out: build-windows artifact-path: build-win @@ -142,37 +112,31 @@ jobs: cmake --build build-win-msvc16 --parallel $env:NUMBER_OF_PROCESSORS --config Release --target install ## Dev Test Jobs - test-run-rocky8-7-dev: - needs: build-rocky8-7-dev + test-run-rocky8-7: + needs: build-rocky8-7 uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/docker.yml@main with: - # Run the rocky8-7-dev build on the ubuntu 18.04 image as a test, and because it has vncserver installed + # Run the rocky8-7 build on the ubuntu 18.04 image as a test, and because it has vncserver installed image: rockylinux:8.7-tgt-rebuild pre-cmd: yum -y install tigervnc-server mesa-libGLU cmd: | module load intel/2023.0 build/ospStudio --verify_install - export CACHE_DIR=/NAS/ci-cache - export OSPRAY_VER=devel gitlab/run-dev.sh gitlab/run-dev-img-cmp.sh - artifact-in: build-rocky8-7-dev + artifact-in: build-rocky8-7 artifact-path: build/model-results build/cert-tests/* - artifact-out: test-run-rocky8-7-dev + artifact-out: test-run-rocky8-7 artifact-on-failure: true ### Devel Coverity Job ### static-analysis: - needs: cache-ospray-rocky8-7 secrets: inherit - uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/static_analysis.yml@main + #uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/static_analysis.yml@main + uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/static_analysis.yml@tgt/coverity_env with: project: OSPRay Studio prebuild: > module load cmake/3.25.3 && - export CACHE_DIR=${{ needs.cache-ospray-rocky8-7.outputs.cache-dir }} && - export OSPRAY_VER=${{ needs.cache-ospray-rocky8-7.outputs.ospray-version }} && - export CMAKE_PREFIX_PATH=$CACHE_DIR/ospray-$OSPRAY_VER/build/install/lib64/cmake/ospray-3.0.0 && - export TBB_ROOT=$CACHE_DIR/ospray-$OSPRAY_VER/build/tbb/src/tbb && cmake -L -S . -B build -DENABLE_OPENIMAGEIO=OFF -DENABLE_OPENVDB=OFF -DENABLE_EXR=OFF build: cmake --build build diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 03e56616..7eb5b0bd 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -115,7 +115,7 @@ jobs: with: cmd: | msiexec.exe /a (Get-ChildItem $env:GITHUB_WORKSPACE\build-win\package\*.msi | Select-Object -Expand FullName) /qn TARGETDIR=$env:GITHUB_WORKSPACE | Out-Null - & $env:SIGN_FILE_WINDOWS -t $env:GITHUB_WORKSPACE\build-win\package\*.msi (Get-ChildItem "$env:GITHUB_WORKSPACE\Intel\OSPRay Studio v0\bin\*" | Select-Object -Expand FullName) + & $env:SIGN_FILE_WINDOWS -t $env:GITHUB_WORKSPACE\build-win\package\*.msi (Get-ChildItem "$env:GITHUB_WORKSPACE\Intel\OSPRay Studio*\bin\*" | Select-Object -Expand FullName) artifact-in: release-windows ## macOS ## @@ -131,22 +131,14 @@ jobs: ### Scan Jobs ### - cache-ospray: - secrets: inherit - uses: ./.github/workflows/cache-ospray.yml - with: - image: rockylinux:8.7 - ospray-version: devel - rkcommon-version: devel - composition-analysis: secrets: inherit uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/composition_analysis.yml@main static-analysis: - needs: cache-ospray secrets: inherit - uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/static_analysis.yml@main + #uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/static_analysis.yml@main + uses: intel-innersource/libraries.devops.renderkit.workflows/.github/workflows/static_analysis.yml@tgt/coverity_env with: coverity: true image: rockylinux:8.7 @@ -154,10 +146,6 @@ jobs: ignore-files: pysg.cpp prebuild: > module load cmake/3.25.3 && - export CACHE_DIR=${{ needs.cache-ospray.outputs.cache-dir }} && - export OSPRAY_VER=${{ needs.cache-ospray.outputs.ospray-version }} && - export CMAKE_PREFIX_PATH=$CACHE_DIR/ospray-$OSPRAY_VER/build/install && - export TBB_ROOT=$CACHE_DIR/ospray-$OSPRAY_VER/build/tbb/src/tbb && cmake -L -S . -B build -DENABLE_OPENIMAGEIO=OFF -DENABLE_OPENVDB=OFF -DENABLE_EXR=OFF && echo "Done: Configure OSPRay Studio" build: cmake --build build diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d9ca72d..c927765f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,59 @@ Version History --------------- +### Changes in OSPRay Studio v1.0.0 + +- Compatible with OSPRay release v3.1.0 + +- Features and Improvements + - Add support for new OSPRay functionality:
+ - Principled and Luminous materials support emissive textures + - Add native support for disc and oriented disc geometry + - Add support for mirror repeat and clamp to edge texture wrap modes + - `OSPTextureWrapMode` supported on all textures + - glTF texture wrapping now fully supported + - Support frame buffer denoise and tonemapper on non-float buffer format + + - Add more OSPRay material types to UI, supporting the rest of + the OSPRay material types and their default values. + - Support for both OpenEXR v2.x and v3.x APIs + - Detection of asynchronous file modifications for automatic + update HDRI and backplate textures. + - Enable plugins to access MainWindow class, re-enabling plugins to access + the ArcballCamera + - Enable MPI distributed rendering in Batch mode allowing ospStudio to utilize + OSPRay's MPI Distributed renderer in Batch mode +

+ +- Cleanup and bug fixes: + - For Windows builds, add dependent load for dll injection security + - Graceful exit if command line parsing fails + - Fix support for 2D measured light intensity distribution + - Correctly set OBJ texture parameters in SciVis/AO and show OBJ colors in widget + - Fixed a long-standing bug in OBJ material loader. kd and ks textures were + loaded as linear format and not sRGB gamma encoded. + - Fix value scaling when displaying depth buffer + - Add helper code to enable loading of pre-OSPRayStudio v0.13 sg files + - Fix incorrect texture flip on load in UDIM and reuse + +- Update 3rd party dependencies + - Implicitly included in this repo: + - CLI11 v2.4.0 (github.com/CLIUtils/CLI11) + - dear imgui v1.90.2 WIP (docking branch) (github.com/ocornut/imgui) + - dirent v1.24 (github.com/tronkko/dirent) + - ImGuiFileDialog v0.6.6.1 (github.com/aiekick/ImGuiFileDialog) + - imGuIZMO.quat v3.0 (github.com/BrutPitt/imGuIZMO.quat) + - JSON for Modern C++ 3.11.3 (github.com/nlohmann/json) + - stb_image v2.29 (github.com/nothings/stb) + - tinydng v0.1.0 (github.com/syoyo/tinydng) + - tinyexr v1.0.7 (github.com/syoyo/tinyexr) + - tinygltf v2.8.20 (github.com/syoyo/tinygltf) + - tinyobjloader v2.0.0rc13 (github.com/tinyobjloader/tinyobjloader) + - via FetchContent: + - glfw v3.3.9 (github.com/glfw/glfw) + - pybind11 v2.11.1 (github.com/pybind/pybind11) + - draco v1.5.7 (github.com/google/draco) + ### Changes in OSPRay Studio v0.13.0 - Compatible with OSPRay release v3.0.0 diff --git a/CMakeLists.txt b/CMakeLists.txt index 819a3490..cca5a1e4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.15) -project(ospray_studio VERSION 0.13.0 LANGUAGES CXX C) +project(ospray_studio VERSION 1.0.0 LANGUAGES CXX C) include(GNUInstallDirs) include(ProcessorCount) @@ -55,6 +55,20 @@ else() set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS ${CONFIGURATION_TYPES}) endif() +## Add dependent load for Windows dll injection load security +if (WIN32) + get_filename_component(COMPILER_NAME ${CMAKE_CXX_COMPILER} NAME_WE) + if (COMPILER_NAME STREQUAL "icx" OR COMPILER_NAME STREQUAL "icpx") + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} /Qoption,link,/DEPENDENTLOADFLAG:0x2000") + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} /Qoption,link,/DEPENDENTLOADFLAG:0x2000") + elseif (MSVC) + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} /DEPENDENTLOADFLAG:0x2000") + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} /DEPENDENTLOADFLAG:0x2000") + else() + message(WARNING "Urecognized compiler, DEPENDENTLOADFLAG can't be set") + endif() +endif() + ## global options and variables option(OSPRAY_INSTALL "Install OSPRay libraries in addition to OSPRay Studio libraries / binaries" ON) set(OSPRAY_STUDIO_RESOURCE_FILE "${PROJECT_SOURCE_DIR}/resources/ospray_studio.rc") diff --git a/README.md b/README.md index 5bc08c33..1a8b110b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # OSPRay Studio -This is release v0.13.0 of Intel® OSPRay Studio. It is released under the +This is release v1.0.0 of Intel® OSPRay Studio. It is released under the Apache 2.0 license. Visit [**OSPRay Studio**](http://www.ospray.org/ospray_studio) @@ -72,28 +72,28 @@ listed in OS-specific building process below. ### Required dependencies - [CMake](https://www.cmake.org) (v3.15+) and any C++14 compiler -- Intel [OSPRay](https://www.github.com/ospray/ospray) (v3.0.0) and its +- Intel [OSPRay](https://www.github.com/ospray/ospray) (v3.1.0) and its dependencies - OSPRay Studio builds on top of OSPRay. Instructions on building OSPRay are provided [here](http://www.ospray.org/downloads.html#building-and-finding-ospray). OSPRay and OSPRay Studio have the following common dependencies which Studio can hence leverage from an OSPRay build. - Intel oneAPI Rendering Toolkit common library - [rkcommon](https://www.github.com/ospray/rkcommon) (v1.12.0) + [rkcommon](https://www.github.com/ospray/rkcommon) (v1.13.0) - Intel [Threading Building Blocks](https://www.threadingbuildingblocks.org/) -- OpenGL and [GLFW](https://www.glfw.org) (v3.3.8) - for the windowing environment +- OpenGL and [GLFW](https://www.glfw.org) (v3.3.9) - for the windowing environment ### Optional Dependencies -- Intel [Open Image Denoise](https://openimagedenoise.github.io) - (v2.0.0 or +- Intel [Open Image Denoise](https://openimagedenoise.github.io) - (v2.2.0 or newer) for denoising frames. To use with OSPRay Studio, OSPRay must be built with `-DBUILD_OIDN=ON` in CMake. - [OpenVDB](https://www.openvdb.org/) to support loading VDB formatted volume files. - [OpenImageIO](http://openimageio.org/) and [OpenEXR](https://www.openexr.com/) - (pre-3.x versions) to support images in a variety of file formats. Set `OPENIMAGEIO_ROOT` + (either v2.x or v3.x) to support images in a variety of file formats. Set `OPENIMAGEIO_ROOT` and `OPENEXR_ROOT` to the respective install directories to use these libraries. - (tested with OpenImageIO v2.3.16 and OpenEXR v2.5.8) + (tested with OpenImageIO v2.3.16 and OpenEXR v2.5.8 and v3.3.0) - [Python] (3.9.7) (https://python.org) for python bindings ### Building on Linux and macOS diff --git a/app/Batch.cpp b/app/Batch.cpp index 3ff2605b..f6dbf417 100644 --- a/app/Batch.cpp +++ b/app/Batch.cpp @@ -63,6 +63,14 @@ void BatchContext::start() cameraIdx = whichCamera; if (parseCommandLine()) { + // If using MPI distributed, ensure mpiRaycast renderer is chosen. + if (sgUsingMpi()) { + if (optRendererTypeStr != "mpiRaycast") { + std::cerr << "Distributed rendering requires mpiRaycast renderer." << std::endl; + optRendererTypeStr = "mpiRaycast"; + } + } + std::cout << "...importing files!" << std::endl; loadCamJson(); @@ -235,14 +243,15 @@ bool BatchContext::parseCommandLine() try { app->parse(ac, av); } catch (const CLI::ParseError &e) { - exit(app->exit(e)); + app->exit(e); + return false; } if (filesToImport.size() == 0) { std::cout << "No files to import " << std::endl; - return 0; + return false; } else - return 1; + return true; } void BatchContext::refreshRenderer() diff --git a/app/GUIContext.cpp b/app/GUIContext.cpp index 5753b541..36b28676 100644 --- a/app/GUIContext.cpp +++ b/app/GUIContext.cpp @@ -63,6 +63,7 @@ void GUIContext::start() if (!mainWindow) { mainWindow = new MainWindow(defaultSize, currentUtil); mainWindow->initGLFW(); + StudioContext::setMainWindow((void *)mainWindow); } // load plugins // @@ -245,22 +246,7 @@ void GUIContext::refreshRenderer() r["maxContribution"] = maxContribution; // Re-add the backplate on renderer change - if (backPlateTexture != "") { - auto backplateTex = - createNodeAs("map_backplate", "texture_2d"); - if (backplateTex->load(backPlateTexture, false, false)) - r.add(backplateTex); - else { - backplateTex = nullptr; - backPlateTexture = ""; - } - } else { - // Node removal requires waiting on previous frame completion - frame->cancelFrame(); - frame->waitOnFrame(); - r.remove("map_backplate"); - r.handle().removeParam("map_backplate"); - } + r["backplate_filename"] = backPlateTexture.str(); } void GUIContext::saveRendererParams() @@ -345,7 +331,8 @@ bool GUIContext::parseCommandLine() try { app->parse(ac, av); } catch (const CLI::ParseError &e) { - exit(app->exit(e)); + app->exit(e); + return false; } // XXX: changing windowSize here messes causes some display scaling issues @@ -616,11 +603,12 @@ void GUIContext::saveNodesJson(const std::string nodeTypeStr) void GUIContext::selectBuffer(OSPFrameBufferChannel whichBuffer, bool invert) { + auto &framebuffer = frame->childAs("framebuffer"); + optDisplayBuffer = whichBuffer; - optDisplayBufferInvert = invert; + optDisplayBufferInvert = invert && framebuffer.isFloatFormat(); // Only enabled if they exist - auto &framebuffer = frame->childAs("framebuffer"); if (!framebuffer.hasDepthChannel()) optDisplayBuffer &= ~OSP_FB_DEPTH; if (!framebuffer.hasAccumChannel()) diff --git a/app/MainWindow.cpp b/app/MainWindow.cpp index a4f075bd..6956f66b 100644 --- a/app/MainWindow.cpp +++ b/app/MainWindow.cpp @@ -706,7 +706,9 @@ void MainWindow::display() std::transform(depthCopy.begin(), depthCopy.end(), depthCopy.begin(), - [&](float value) { return (value - minValue) * rcpRange; }); + [&](float value) { + return isinf(value) ? 1.f : (value - minValue) * rcpRange; + }); bufferCopy = std::move(depthCopy); } diff --git a/app/WindowsBuilder.h b/app/WindowsBuilder.h index 1ca95c30..7b8f063c 100644 --- a/app/WindowsBuilder.h +++ b/app/WindowsBuilder.h @@ -296,8 +296,8 @@ void WindowsBuilder::buildWindowFrameBufferEditor() whichBuffer == OSP_FB_DEPTH)) whichBuffer = OSP_FB_DEPTH; - ImGui::NewLine(); ImGui::SameLine(); + ImGui::NewLine(); if (fb.hasPrimitiveIDChannel() && ImGui::RadioButton( "PrimID##displayPrimID", whichBuffer == OSP_FB_ID_PRIMITIVE)) @@ -315,42 +315,42 @@ void WindowsBuilder::buildWindowFrameBufferEditor() "InstanceID##displayInstID", whichBuffer == OSP_FB_ID_INSTANCE)) whichBuffer = OSP_FB_ID_INSTANCE; + ImGui::SameLine(); ImGui::NewLine(); - ImGui::Checkbox("Invert values##displayInverted", &invertBuffer); - if (!fb.isFloatFormat()) ImGui::TextColored( ImVec4(.5f, .5f, .5f, 1.f), "Enable float format for more buffers"); } - ctx->selectBuffer(whichBuffer, invertBuffer); + // Only float buffers will be inverted + ImGui::SameLine(); + ImGui::NewLine(); + if (fb.isFloatFormat()) + ImGui::Checkbox("Invert values##displayInverted", &invertBuffer); + + ctx->selectBuffer(whichBuffer, invertBuffer); ImGui::Separator(); ImGui::Text("Post-processing"); - if (fb.isFloatFormat()) { - ImGui::Checkbox("Tonemap", &ctx->frame->toneMapFB); - ImGui::SameLine(); - ImGui::Checkbox("Tonemap nav", &ctx->frame->toneMapNavFB); - - if (ctx->studioCommon.denoiserAvailable) { - ImGui::Checkbox("Denoise", &ctx->frame->denoiseFB); - ImGui::SameLine(); - ImGui::Checkbox("Denoise nav", &ctx->frame->denoiseNavFB); - } - if (ctx->frame->denoiseFB || ctx->frame->denoiseNavFB) { - ImGui::Checkbox("Denoise only PathTracer", &ctx->frame->denoiseOnlyPathTracer); - ImGui::Checkbox("Denoise on final frame", &ctx->frame->denoiseFBFinalFrame); - ImGui::SameLine(); - // Add accum here for convenience with final-frame denoising - ImGui::SetNextItemWidth(5 * ImGui::GetFontSize()); - ImGui::DragInt( - "Limit accumulation", &ctx->frame->accumLimit, 1, 0, INT_MAX, "%d frames"); - } - } else { - ImGui::TextColored( - ImVec4(.5f, .5f, .5f, 1.f), "Enable float format for post-processing"); - } + ImGui::Checkbox("Tonemap", &ctx->frame->toneMapFB); + ImGui::SameLine(); + ImGui::Checkbox("Tonemap nav", &ctx->frame->toneMapNavFB); + + if (ctx->studioCommon.denoiserAvailable) { + ImGui::Checkbox("Denoise", &ctx->frame->denoiseFB); + ImGui::SameLine(); + ImGui::Checkbox("Denoise nav", &ctx->frame->denoiseNavFB); + } + if (ctx->frame->denoiseFB || ctx->frame->denoiseNavFB) { + ImGui::Checkbox("Denoise only PathTracer", &ctx->frame->denoiseOnlyPathTracer); + ImGui::Checkbox("Denoise on final frame", &ctx->frame->denoiseFBFinalFrame); + ImGui::SameLine(); + // Add accum here for convenience with final-frame denoising + ImGui::SetNextItemWidth(5 * ImGui::GetFontSize()); + ImGui::DragInt( + "Limit accumulation", &ctx->frame->accumLimit, 1, 0, INT_MAX, "%d frames"); + } ImGui::Separator(); @@ -486,7 +486,7 @@ void WindowsBuilder::buildWindowKeyframes() } } - if (ImGui::ListBoxHeader("##")) { + if (ImGui::BeginListBox("##")) { for (int i = 0; i < cameraStack->size(); i++) { if (ImGui::Selectable( (std::to_string(i) + ": " + to_string(cameraStack->at(i))).c_str(), @@ -496,7 +496,7 @@ void WindowsBuilder::buildWindowKeyframes() ctx->updateCamera(); } } - ImGui::ListBoxFooter(); + ImGui::EndListBox(); } ImGui::End(); @@ -805,7 +805,10 @@ void WindowsBuilder::buildWindowTransferFunctionEditor() range1f(0.f, 1.f), "TransferFunctionEditor"); - if (ImGui::ListBoxHeader("##transferFunction", transferFunctions.size())) { + if (ImGui::BeginListBox("##transferFunction", + ImVec2(-FLT_MIN, + ImGui::GetTextLineHeightWithSpacing() + * transferFunctions.size()))) { int i = 0; for (auto t : transferFunctions) { if (ImGui::Selectable(t.first.c_str(), (whichTFn == i))) { @@ -834,7 +837,7 @@ void WindowsBuilder::buildWindowTransferFunctionEditor() } i++; } - ImGui::ListBoxFooter(); + ImGui::EndListBox(); ImGui::Separator(); if (whichTFn != -1) { diff --git a/app/ospStudio.cpp b/app/ospStudio.cpp index bc5c385a..fb98e4ee 100644 --- a/app/ospStudio.cpp +++ b/app/ospStudio.cpp @@ -5,7 +5,6 @@ #include "Batch.h" #include "GUIContext.h" -#include "sg/Mpi.h" // CLI #include @@ -64,12 +63,12 @@ void StudioContext::addToCommandLine(std::shared_ptr app) "files", filesToImport, "The list of files to import" - ); + )->check(CLI::detail::ExistingFileValidator()); app->add_option( - "reload assets", + "--reload", optReloadAssets, "reload asset file contents, rather than creating an instance" - ); + )->check(CLI::IsMember({true, false})); app->add_option( "--renderer", optRendererTypeStr, @@ -95,7 +94,7 @@ void StudioContext::addToCommandLine(std::shared_ptr app) return true; }, "Set the renderer background color" - )->expected(4)->check(CLI::NonNegativeNumber); + )->expected(4)->check(CLI::NonNegativeNumber); app->add_option( "--pixelfilter", optPF, @@ -120,27 +119,27 @@ void StudioContext::addToCommandLine(std::shared_ptr app) "--saveAlbedo", optSaveAlbedo, "Save albedo values" - ); + )->check(CLI::IsMember({true, false})); app->add_flag( "--saveDepth", optSaveDepth, "Save depth values" - ); + )->check(CLI::IsMember({true, false})); app->add_flag( "--saveNormal", optSaveNormal, "Save normal values" - ); + )->check(CLI::IsMember({true, false})); app->add_flag( "--saveLayers", optSaveLayersSeparately, "Save layers in separate files" - ); + )->check(CLI::IsMember({true, false})); app->add_flag( "--verboseImporter", optVerboseImporter, "Additional console info messages when importing files" - ); + )->check(CLI::IsMember({true, false})); app->add_option( "--resolution", [&](const std::vector val) { @@ -240,12 +239,12 @@ void StudioContext::addToCommandLine(std::shared_ptr app) "--denoiser", optDenoiser, "Enable frame denoising" - ); + )->check(CLI::IsMember({true, false})); app->add_flag( "--denoiseFinalFrame", optDenoiseFinalFrame, "Denoise only when accum limit is reached" - ); + )->check(CLI::IsMember({true, false})); app->add_option( "--camera", optCameraRange, @@ -300,11 +299,28 @@ int main(int argc, const char *argv[]) { std::cout << "OSPRay Studio" << std::endl; - // Just look for either version or verify_install arguments, initializeOSPRay - // will remove OSPRay specific args, parse fully down further + // Parse first argument as StudioMode + // (GUI is the default if no mode is given) + // XXX Switch to using ospcommon/rkcommon ArgumentList + auto mode = StudioMode::GUI; + if (argc > 1) { + auto modeArg = std::string(argv[1]); + if (modeArg.front() != '-') { + auto s = StudioModeMap.find(modeArg); + if (s != StudioModeMap.end()) { + mode = s->second; + // Remove mode argument + removeArgs(argc, argv, 1, 1); + } + } + } + + // Look for either special arguments: version, verify_install, use_mpi and plugins, initializeOSPRay + // will remove OSPRay specific args. Other options will be parsed later bool version = false; bool verify_install = false; bool use_mpi = false; + std::vector pluginsToLoad; for (int i = 1; i < argc; i++) { const auto arg = std::string(argv[i]); if (arg == "--version") { @@ -316,6 +332,11 @@ int main(int argc, const char *argv[]) } else if (arg == "--mpi") { use_mpi = true; removeArgs(argc, argv, i, 1); + } else if (arg == "--plugin" || arg == "-p") { + // Parse argument list for any plugins. + pluginsToLoad.emplace_back(argv[i + 1]); + removeArgs(argc, argv, i, 2); + --i; } } @@ -327,22 +348,18 @@ int main(int argc, const char *argv[]) if (use_mpi) { #ifdef USE_MPI - use_mpi = ospLoadModule("mpi") == OSP_NO_ERROR; - if (!use_mpi) { + if (mode != StudioMode::BATCH) { std::cout - << "Fatal: ospStudio launched with --mpi, but could not load the OSPRay MPI module." - << std::endl; + << "Error: ospStudio distributed rendering currently only enabled for " + << "batch mode." + << std::endl; return 1; - } else { - sgInitializeMPI(argc, argv); - std::cout << "ospStudio --mpi, rank " << sgMpiRank() << "/" - << sgMpiWorldSize() << "\n"; } - -#else // USE_MPI +#else std::cout - << "Fatal: ospStudio launched with --mpi, but has not been compiled with MPI support." - << std::endl; + << "Error: ospStudio launched with --mpi, but has not been compiled " + << "with MPI support." + << std::endl; return 1; #endif } @@ -368,33 +385,6 @@ int main(int argc, const char *argv[]) std::cout << "OpenImageDenoise is " << (denoiser ? "" : "not ") << "available" << std::endl; - // Parse first argument as StudioMode - // (GUI is the default if no mode is given) - // XXX Switch to using ospcommon/rkcommon ArgumentList - auto mode = StudioMode::GUI; - std::vector pluginsToLoad; - if (argc > 1) { - auto modeArg = std::string(argv[1]); - if (modeArg.front() != '-') { - auto s = StudioModeMap.find(modeArg); - if (s != StudioModeMap.end()) { - mode = s->second; - // Remove mode argument - removeArgs(argc, argv, 1, 1); - } - } - - // Parse argument list for any plugins. - for (int i = 1; i < argc; i++) { - const auto arg = std::string(argv[i]); - if (arg == "--plugin" || arg == "-p") { - pluginsToLoad.emplace_back(argv[i + 1]); - removeArgs(argc, argv, i, 2); - --i; - } - } - } - // Set parameters common to all modes StudioCommon studioCommon(pluginsToLoad, denoiser, argc, argv); studioCommon.splitPluginArguments(); @@ -419,11 +409,13 @@ int main(int argc, const char *argv[]) case StudioMode::HEADLESS: std::cerr << "Headless mode\n"; break; -#ifdef USE_BENCHMARK case StudioMode::BENCHMARK: +#ifdef USE_BENCHMARK context = std::make_shared(studioCommon); - break; +#else + std::cerr << "Benchmark mode not enabled. Recompile with -DUSE_BENCHMARK=ON\n"; #endif + break; default: std::cerr << "unknown mode! How did I get here?!\n"; } diff --git a/app/ospStudio.h b/app/ospStudio.h index 0518dfc7..435e18bb 100644 --- a/app/ospStudio.h +++ b/app/ospStudio.h @@ -15,10 +15,12 @@ #include "sg/Scheduler.h" #include "sg/renderer/MaterialRegistry.h" #include "sg/scene/lights/LightsManager.h" +#include "sg/Mpi.h" // studio app #include "AnimationManager.h" // ospcommon #include "rkcommon/common.h" +#include "rkcommon/utility/getEnvVar.h" #include "version.h" @@ -29,7 +31,7 @@ class App; } using namespace ospray; -using namespace rkcommon::math; +using namespace rkcommon; class PluginManager; enum class StudioMode @@ -37,9 +39,7 @@ enum class StudioMode GUI, BATCH, HEADLESS, -#ifdef USE_BENCHMARK BENCHMARK, -#endif }; enum class OSPRayRendererType @@ -58,9 +58,7 @@ const static std::map StudioModeMap = { {"gui", StudioMode::GUI}, {"batch", StudioMode::BATCH}, {"server", StudioMode::HEADLESS}, -#ifdef USE_BENCHMARK {"benchmark", StudioMode::BENCHMARK}, -#endif }; const static std::map standardResolutionSizeMap = { @@ -103,7 +101,7 @@ class StudioCommon const char **plugin_argv{nullptr}; }; -using CameraMap = rkcommon::containers::FlatMap; +using CameraMap = containers::FlatMap; // abstract base class for all Studio modes // XXX: should be merged with StudioCommon above @@ -155,6 +153,13 @@ class StudioContext : public std::enable_shared_from_this std::string outputFilename{""}; StudioMode mode; + void *ctxMainWindow{nullptr}; // Will be populated if in GUI mode + void setMainWindow(void *mainWindow) { + ctxMainWindow = mainWindow; + }; + void *getMainWindow() { + return ctxMainWindow; + }; bool optReloadAssets{false}; bool optResetCameraOnLoad{true}; @@ -207,30 +212,9 @@ class StudioContext : public std::enable_shared_from_this inline OSPError initializeOSPRay(int &argc, const char **argv, bool use_mpi) { - OSPDevice device; - - if (use_mpi) { - // TODO: calling ospInit seems to be required, - // even though the OSPRay MPI warns us not to do this... - OSPError initError = ospInit(&argc, argv); - - if (initError != OSP_NO_ERROR) { - std::cerr << "OSPRay not initialized correctly!" << std::endl; - return initError; - } - - device = ospGetCurrentDevice(); - if (!device) { - std::cerr << "OSPRay device could not be fetched!" << std::endl; - return OSP_UNKNOWN_ERROR; - } - - // TODO: setErrorCallback and ospDeviceSetParam calls seem to break mpi. - // Why? - } else { + if (!use_mpi) { // initialize OSPRay; OSPRay parses (and removes) its commandline // parameters, e.g. "--osp:debug" - OSPError initError = ospInit(&argc, argv); if (initError != OSP_NO_ERROR) { @@ -238,13 +222,13 @@ inline OSPError initializeOSPRay(int &argc, const char **argv, bool use_mpi) return initError; } - device = ospGetCurrentDevice(); - + OSPDevice device(ospGetCurrentDevice()); if (!device) { std::cerr << "OSPRay device could not be fetched!" << std::endl; return OSP_UNKNOWN_ERROR; } + // TODO: setErrorCallback and ospDeviceSetParam calls seem to break mpi. // set an error callback to catch any OSPRay errors ospDeviceSetErrorCallback( device, @@ -261,10 +245,51 @@ inline OSPError initializeOSPRay(int &argc, const char **argv, bool use_mpi) ospDeviceSetParam(device, "warnAsError", OSP_BOOL, &warnAsErrors); ospDeviceSetParam(device, "logLevel", OSP_INT, &logLevel); - } - ospDeviceCommit(device); - ospDeviceRelease(device); + ospDeviceCommit(device); + ospDeviceRelease(device); + + } else { + // + // MPI Distributed + // + + // Initialize MPI and set rank and world size in sg + sg::sgInitializeMPI(argc, argv); + std::cout << "ospStudio --mpi, rank " << sg::sgMpiRank() << "/" + << sg::sgMpiWorldSize() << "\n"; + + // load the MPI module, and select the MPI distributed device. Here we + // do not call ospInit, as we want to explicitly pick the distributed + // device + auto OSPRAY_MPI_DISTRIBUTED_GPU = + utility::getEnvVar("OSPRAY_MPI_DISTRIBUTED_GPU").value_or(0); + + auto mpiModuleName = OSPRAY_MPI_DISTRIBUTED_GPU ? "mpi_distributed_gpu" + : "mpi_distributed_cpu"; + std::cout << "Loading OSPRay Module: " << mpiModuleName; + + use_mpi = ospLoadModule(mpiModuleName) == OSP_NO_ERROR; + if (!use_mpi) { + std::cout + << "Fatal: ospStudio launched with --mpi, but could not load the OSPRay MPI module." + << std::endl; + return OSP_UNKNOWN_ERROR; + } + + cpp::Device mpiDevice("mpiDistributed"); + mpiDevice.commit(); + mpiDevice.setCurrent(); + + // set an error callback to catch any OSPRay errors and exit the application + ospDeviceSetErrorCallback( + mpiDevice.handle(), + [](void *, OSPError error, const char *errorDetails) { + std::cerr << "OSPRay error: " << errorDetails << std::endl; + exit(error); + }, + nullptr); + } return OSP_NO_ERROR; } diff --git a/app/widgets/AdvancedMaterialEditor.cpp b/app/widgets/AdvancedMaterialEditor.cpp index ac84eb17..bdbff8f9 100644 --- a/app/widgets/AdvancedMaterialEditor.cpp +++ b/app/widgets/AdvancedMaterialEditor.cpp @@ -17,6 +17,7 @@ #include +using namespace ospray::sg; using namespace rkcommon::math; void AdvancedMaterialEditor::buildUI( @@ -45,10 +46,22 @@ void AdvancedMaterialEditor::buildUI( ImGui::Spacing(); ImGui::Text("Replace material"); static int currentMatType = 0; - const char *matTypes[] = {"principled", "carPaint", "obj", "luminous"}; - ImGui::Combo("Material types", ¤tMatType, matTypes, 4); + const char *matTypes[] = {"alloy", + "carPaint", + "glass", + "luminous", + "metal", + "metallicPaint", + // "mix", Mix needs pointers to two existing materials and a blend factor + "obj", + "plastic", + "principled", + "thinGlass", + "velvet"}; + constexpr int numMatTypes = sizeof(matTypes) >> 3; + ImGui::Combo("Material types", ¤tMatType, matTypes, numMatTypes); if (ImGui::Button("Replace##material")) { - auto newMat = ospray::sg::createNode(matName, matTypes[currentMatType]); + auto newMat = createNode(matName, matTypes[currentMatType]); materialRegistry->add(newMat); } @@ -80,11 +93,17 @@ void AdvancedMaterialEditor::buildUI( if (ImGui::Button("Add##materialtexture")) { std::string paramStr(matTexParamName); if (!paramStr.empty()) { - std::shared_ptr sgTex = - std::static_pointer_cast( - ospray::sg::createNode(paramStr, "texture_2d")); + // color textures are typically sRGB gamma encoded, others prefer linear + // texture format may override this preference + bool preferLinear = paramStr.find("Color") == paramStr.npos + && paramStr.find("kd") == paramStr.npos + && paramStr.find("ks") == paramStr.npos; + + auto sgTex = createNodeAs(paramStr, "texture_2d"); + // Set parameters affecting texture load and usage + sgTex->samplerParams.preferLinear = preferLinear; // If load fails, remove the texture node - if (!sgTex->load(matTexFileName, true, false)) + if (!sgTex->load(matTexFileName)) sgTex = nullptr; else { auto newMat = copyMaterial(selectedMat, "", paramStr); diff --git a/app/widgets/FileBrowserWidget.cpp b/app/widgets/FileBrowserWidget.cpp index 0487d9e5..9933beac 100644 --- a/app/widgets/FileBrowserWidget.cpp +++ b/app/widgets/FileBrowserWidget.cpp @@ -29,17 +29,15 @@ bool fileBrowser(FileList &fileList, ImVec2 maxSize = ImGui::GetIO().DisplaySize; ImVec2 minSize(maxSize.x * 0.5, maxSize.y * 0.5); - auto fd = ImGuiFileDialog::Instance(); + // Allow multiple selections if requested (pass 0 as the countSelectionMax) + IGFD::FileDialogConfig fdConfig{}; + fdConfig.path = defaultPath; + fdConfig.fileName = ""; + fdConfig.countSelectionMax = allowMultipleSelection ? 0 : 1; + fdConfig.flags = ImGuiFileDialogFlags_Modal; - // Allow multiple selections if requested (pass 0 as the vCountSelectionMax) - fd->OpenDialog(prompt.c_str(), - prompt.c_str(), - filters.c_str(), - defaultPath, - "", - allowMultipleSelection ? 0 : 1, - nullptr, - ImGuiFileDialogFlags_Modal); + auto fd = ImGuiFileDialog::Instance(); + fd->OpenDialog(prompt.c_str(), prompt.c_str(), filters.c_str(), fdConfig); if (fd->Display( prompt.c_str(), ImGuiWindowFlags_NoCollapse, minSize, maxSize)) { diff --git a/app/widgets/GenerateImGuiWidgets.h b/app/widgets/GenerateImGuiWidgets.h index d96ec3ba..8b74b6ad 100644 --- a/app/widgets/GenerateImGuiWidgets.h +++ b/app/widgets/GenerateImGuiWidgets.h @@ -138,9 +138,11 @@ inline bool generateWidget_float(const std::string &title, Node &node) return false; } +template inline bool generateWidget_vec2i(const std::string &title, Node &node) { - vec2i v = node.valueAs(); + using v2T = vec_t; + vec2i v = node.valueAs(); if (node.readOnly()) { ImGui::Text("%s", @@ -151,10 +153,10 @@ inline bool generateWidget_vec2i(const std::string &title, Node &node) } if (node.hasMinMax()) { - const int min = node.minAs(); - const int max = node.maxAs(); + const int min = node.minAs(); + const int max = node.maxAs(); if (ImGui::SliderInt2(title.c_str(), v, min, max)) { - node.setValue(v); + node.setValue(v2T(v)); return true; } } else { @@ -564,7 +566,8 @@ static std::map widgetGenerators = { {"uint32_t", generateWidget_int}, {"long", generateWidget_int}, {"float", generateWidget_float}, - {"vec2i", generateWidget_vec2i}, + {"vec2i", generateWidget_vec2i}, + {"vec2ui", generateWidget_vec2i}, {"vec2f", generateWidget_vec2f}, {"vec3i", generateWidget_vec3i}, {"vec3f", generateWidget_vec3f}, @@ -578,6 +581,7 @@ static std::map widgetGenerators = { {"quaternionf", generateWidget_quaternionf}, {"string", generateWidget_string}, {"filename", generateWidget_filename}, + {"fileWatcher", generateWidget_bool}, // OSPRay Enum types {"OSPAMRMethod", generateWidget_int}, @@ -592,10 +596,12 @@ static std::map widgetGenerators = { {"OSPLogLevel", generateWidget_int}, {"OSPPixelFilterType", generateWidget_int}, {"OSPShutterType", generateWidget_int}, + {"OSPSphereType", generateWidget_int}, {"OSPStereoMode", generateWidget_int}, {"OSPSubdivisionMode", generateWidget_int}, {"OSPSyncEvent", generateWidget_int}, {"OSPTextureFilter", generateWidget_int}, + {"OSPTextureWrapMode", generateWidget_int}, {"OSPTextureFormat", generateWidget_int}, {"OSPUnstructuredCellType", generateWidget_int}, {"OSPVolumeFilter", generateWidget_int}, diff --git a/cmake/draco.cmake b/cmake/draco.cmake index 1ade66aa..8d6bc67b 100644 --- a/cmake/draco.cmake +++ b/cmake/draco.cmake @@ -6,7 +6,7 @@ ## if(NOT DEFINED DRACO_VERSION) - set(DRACO_VERSION 1.5.6) + set(DRACO_VERSION 1.5.7) endif() ## @@ -27,7 +27,7 @@ if(NOT "${draco_FOUND}") # Hide advanced options from main CMake list mark_as_advanced(DRACO_FAST) - mark_as_advanced(DRACO_GLTF) + mark_as_advanced(DRACO_GLTF_BITSTREAM) mark_as_advanced(DRACO_ANIMATION_ENCODING) mark_as_advanced(DRACO_BACKWARDS_COMPATIBILITY) mark_as_advanced(DRACO_DECODER_ATTRIBUTE_DEDUPLICATION) @@ -45,10 +45,10 @@ if(NOT "${draco_FOUND}") mark_as_advanced(DRACO_DEBUG_GLTF_BITSTREAM) mark_as_advanced(DRACO_TRANSCODER_SUPPORTED) - # draco needs to be build position independent to link with ospray_sg + # draco needs to be built position independent to link with ospray_sg set(CMAKE_POSITION_INDEPENDENT_CODE ON) set(DRACO_FAST ON) - set(DRACO_GLTF ON) + set(DRACO_GLTF_BITSTREAM ON) set(DRACO_ANIMATION_ENCODING ON) set(DRACO_JS_GLUE OFF) diff --git a/cmake/glfw.cmake b/cmake/glfw.cmake index c6200f1d..0dbc76e1 100644 --- a/cmake/glfw.cmake +++ b/cmake/glfw.cmake @@ -6,7 +6,7 @@ if(glfw3_FOUND) endif() if(NOT DEFINED GLFW_VERSION) - set(GLFW_VERSION 3.3.8) + set(GLFW_VERSION 3.3.9) endif() ## Look for any available version diff --git a/cmake/glfw.patch b/cmake/glfw.patch index d2f58d7c..929fd816 100644 --- a/cmake/glfw.patch +++ b/cmake/glfw.patch @@ -1,15 +1,3 @@ -From 8dfd5804447a1f35c15e650737fee3694bc71f26 Mon Sep 17 00:00:00 2001 -From: Florian Reibold -Date: Mon, 6 Feb 2023 17:29:44 +0100 -Subject: [PATCH] fix LoadLibraryA - ---- - src/null_platform.h | 2 +- - src/wgl_context.c | 2 +- - src/win32_init.c | 12 ++++++------ - src/win32_platform.h | 2 +- - 4 files changed, 9 insertions(+), 9 deletions(-) - diff --git a/src/null_platform.h b/src/null_platform.h index 708975d1..d916b922 100644 --- a/src/null_platform.h @@ -24,10 +12,10 @@ index 708975d1..d916b922 100644 #define _glfw_dlsym(handle, name) GetProcAddress((HMODULE) handle, name) #else diff --git a/src/wgl_context.c b/src/wgl_context.c -index 72ad11de..5c42fa81 100644 +index eebf6cd5..8a72d676 100644 --- a/src/wgl_context.c +++ b/src/wgl_context.c -@@ -416,7 +416,7 @@ GLFWbool _glfwInitWGL(void) +@@ -405,7 +405,7 @@ GLFWbool _glfwInitWGL(void) if (_glfw.wgl.instance) return GLFW_TRUE; @@ -95,7 +83,7 @@ index 885f32fa..5e698cc2 100644 { _glfw.win32.ntdll.RtlVerifyVersionInfo_ = (PFN_RtlVerifyVersionInfo) diff --git a/src/win32_platform.h b/src/win32_platform.h -index bf703d7e..55b8425b 100644 +index e729709f..4a7d8068 100644 --- a/src/win32_platform.h +++ b/src/win32_platform.h @@ -289,7 +289,7 @@ typedef VkBool32 (APIENTRY *PFN_vkGetPhysicalDeviceWin32PresentationSupportKHR)( @@ -107,6 +95,3 @@ index bf703d7e..55b8425b 100644 #define _glfw_dlclose(handle) FreeLibrary((HMODULE) handle) #define _glfw_dlsym(handle, name) GetProcAddress((HMODULE) handle, name) --- -2.38.1.windows.1 - diff --git a/cmake/openexr.cmake b/cmake/openexr.cmake index 8525613a..230fbf20 100644 --- a/cmake/openexr.cmake +++ b/cmake/openexr.cmake @@ -1,8 +1,36 @@ ## Copyright 2020 Intel Corporation ## SPDX-License-Identifier: Apache-2.0 -if(OPENEXR_FOUND) +if(OpenEXR_FOUND) return() endif() -find_package(OpenEXR 2 REQUIRED) +# Find package installed OpenEXR (v2.x or v3.x) +# Imath indicates OpenEXR 3.x +message(STATUS "Looking for package Imath.") +find_package(Imath CONFIG) +if (NOT TARGET Imath::Imath) + # Couldn't find Imath::Imath, find IlmBase (OpenEXR 2.x) + set(_ASSUME_VERSION 2) + message(STATUS "Could not find target Imath::Imath, likely OpenEXR 2.x.") + message(STATUS "Looking for package IlmBase") + find_package(IlmBase CONFIG) + if (NOT TARGET IlmBase_FOUND) + message(STATUS "Could not find IlmBase") + endif () +else () + message(STATUS "Found target Imath::Imath, likely OpenEXR 3.x.") + set(_ASSUME_VERSION 3) +endif () + +message(STATUS "Looking for package OpenEXR, required version ${_ASSUME_VERSION}") + +find_package(OpenEXR ${_ASSUME_VERSION} CONFIG REQUIRED) + +if(OpenEXR_FOUND) + message(STATUS "Found OpenEXR ${_ASSUME_VERSION}.x") +else() + message(STATUS "Could not find OpenEXR ${_ASSUME_VERSION}.x") +endif () + +unset(_ASSUME_VERSION) diff --git a/cmake/ospray.cmake b/cmake/ospray.cmake index 32528845..e625e9fd 100644 --- a/cmake/ospray.cmake +++ b/cmake/ospray.cmake @@ -10,24 +10,49 @@ message(STATUS "Looking for OSPRay...") find_package(ospray QUIET) if(NOT DEFINED OSPRAY_VERSION) - set(OSPRAY_VERSION 3.0.0) + set(OSPRAY_VERSION 3.1.0) endif() if(ospray_FOUND) message(STATUS "Found OSPRay") else() + + message(STATUS "OSPRay package not found...") + ## Download and build if not found if(WIN32) set(_ARCHIVE_EXT "windows.zip") - set(OSPRAY_TAG ".sycl") elseif(APPLE) set(_ARCHIVE_EXT "macosx.zip") else() set(_ARCHIVE_EXT "linux.tar.gz") endif() + set(_FILENAME "ospray-${OSPRAY_VERSION}.x86_64.${_ARCHIVE_EXT}") + + message(STATUS "Looking for ${_FILENAME}") + + # If a nightly build exists of requested version, use that. Otherwise pull + # release version from github. + if(DEFINED ENV{STORAGE_PATH}) + file(TO_CMAKE_PATH "$ENV{STORAGE_PATH}" STORAGE_PATH) + set(_NIGHTLIES_DIR "${STORAGE_PATH}/packages/renderkit/") + set(_LOCAL_FILE "${_NIGHTLIES_DIR}/${_FILENAME}") + message(STATUS "Checking ${_NIGHTLIES_DIR} for nightly ${_LOCAL_FILE}") + file(GLOB _nightly_build_files ${_NIGHTLIES_DIR}/*.${_ARCHIVE_EXT}) + foreach(_file ${_nightly_build_files}) + message(STATUS " - ${_file}") + endforeach() + if(EXISTS "${_LOCAL_FILE}") + message(STATUS "Using OSPRay nightly build") + set(OSPRAY_URL "${_LOCAL_FILE}") + else() + message(STATUS "OSPRay nightly build not found") + endif() + endif() + if(NOT DEFINED OSPRAY_URL) - set(OSPRAY_URL "https://github.com/ospray/ospray/releases/download/v${OSPRAY_VERSION}/ospray-${OSPRAY_VERSION}${OSPRAY_TAG}.x86_64.${_ARCHIVE_EXT}") + set(OSPRAY_URL "https://github.com/ospray/ospray/releases/download/v${OSPRAY_VERSION}/${_FILENAME}") endif() include(FetchContent) diff --git a/cmake/package.cmake b/cmake/package.cmake index e8ca4041..d5c7ce22 100644 --- a/cmake/package.cmake +++ b/cmake/package.cmake @@ -63,8 +63,7 @@ if (WIN32) # Windows specific settings set(CPACK_PACKAGE_INSTALL_DIRECTORY "Intel\\\\OSPRay Studio v${PROJECT_VERSION_MAJOR}") math(EXPR _VERSION_NUMBER "10000*${PROJECT_VERSION_MAJOR} + 100*${PROJECT_VERSION_MINOR} + ${PROJECT_VERSION_PATCH}") - # XXX Added a 0 before ${_VERSION_NUMBER} until PROJECT_VERSION_MAJOR > 0 - set(CPACK_WIX_PRODUCT_GUID "F71844B9-31BF-4B28-A7B1-5206AB20${_VERSION_NUMBER}") + set(CPACK_WIX_PRODUCT_GUID "F71844B9-31BF-4B28-A7B1-5206AB2${_VERSION_NUMBER}") set(CPACK_WIX_UPGRADE_GUID "F71844B9-31BF-4B28-A7B1-5206AB2${PROJECT_VERSION_MAJOR}0000") # upgrade as long as major version is the same set(CPACK_WIX_CMAKE_PACKAGE_REGISTRY TRUE) endif() diff --git a/cmake/pybind11.cmake b/cmake/pybind11.cmake index abdcce3d..68b4ff9f 100644 --- a/cmake/pybind11.cmake +++ b/cmake/pybind11.cmake @@ -6,7 +6,7 @@ ## if(NOT DEFINED PYBIND11_VERSION) - set(PYBIND11_VERSION 2.10.3) + set(PYBIND11_VERSION 2.11.1) endif() ## diff --git a/cmake/rkcommon.cmake b/cmake/rkcommon.cmake index 6a5e24ca..1589f407 100644 --- a/cmake/rkcommon.cmake +++ b/cmake/rkcommon.cmake @@ -13,7 +13,7 @@ message(STATUS "Looking for rkcommon...") find_package(rkcommon QUIET) if(NOT DEFINED RKCOMMON_VERSION) - set(RKCOMMON_VERSION 1.12.0) + set(RKCOMMON_VERSION 1.13.0) endif() if(rkcommon_FOUND) diff --git a/cmake/tbb.cmake b/cmake/tbb.cmake index 1270ed10..bd6d063e 100644 --- a/cmake/tbb.cmake +++ b/cmake/tbb.cmake @@ -6,7 +6,7 @@ if(TBB_FOUND) endif() if(NOT DEFINED TBB_VERSION) - set(TBB_VERSION 2021.10.0) + set(TBB_VERSION 2021.11.0) endif() option(FORCE_TBB_VERSION "Force CMake to find ${TBB_VERSION} (typically for compatibility with pre-built OSPRay)" OFF) diff --git a/external/cli11/CLI11.hpp b/external/cli11/CLI11.hpp index 3913fa9c..02b9e0b6 100644 --- a/external/cli11/CLI11.hpp +++ b/external/cli11/CLI11.hpp @@ -1,11 +1,11 @@ -// CLI11: Version 2.3.2 +// CLI11: Version 2.4.0 // Originally designed by Henry Schreiner // https://github.com/CLIUtils/CLI11 // // This is a standalone header file generated by MakeSingleHeader.py in CLI11/scripts -// from: v2.3.2 +// from: v2.4.0 // -// CLI11 2.3.2 Copyright (c) 2017-2022 University of Cincinnati, developed by Henry +// CLI11 2.4.0 Copyright (c) 2017-2024 University of Cincinnati, developed by Henry // Schreiner under NSF AWARD 1414736. All rights reserved. // // Redistribution and use in source and binary forms of CLI11, with or without @@ -34,34 +34,40 @@ #pragma once // Standard combined includes: -#include -#include -#include -#include -#include -#include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #include #include -#include +#include +#include +#include +#include #include -#include +#include +#include +#include #include -#include #include -#include -#include -#include -#include -#include -#include +#include +#include +#include #define CLI11_VERSION_MAJOR 2 -#define CLI11_VERSION_MINOR 3 -#define CLI11_VERSION_PATCH 2 -#define CLI11_VERSION "2.3.2" +#define CLI11_VERSION_MINOR 4 +#define CLI11_VERSION_PATCH 0 +#define CLI11_VERSION "2.4.0" @@ -124,17 +130,7 @@ #endif #endif -/** Inline macro **/ -#ifdef CLI11_COMPILE -#define CLI11_INLINE -#else -#define CLI11_INLINE inline -#endif - - - -// C standard library -// Only needed for existence checking +/** availability */ #if defined CLI11_CPP17 && defined __has_include && !defined CLI11_HAS_FILESYSTEM #if __has_include() // Filesystem cannot be used if targeting macOS < 10.15 @@ -161,6 +157,44 @@ #endif #endif +/** availability */ +#if defined(__GNUC__) && !defined(__llvm__) && !defined(__INTEL_COMPILER) && __GNUC__ < 5 +#define CLI11_HAS_CODECVT 0 +#else +#define CLI11_HAS_CODECVT 1 +#include +#endif + +/** disable deprecations */ +#if defined(__GNUC__) // GCC or clang +#define CLI11_DIAGNOSTIC_PUSH _Pragma("GCC diagnostic push") +#define CLI11_DIAGNOSTIC_POP _Pragma("GCC diagnostic pop") + +#define CLI11_DIAGNOSTIC_IGNORE_DEPRECATED _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") + +#elif defined(_MSC_VER) +#define CLI11_DIAGNOSTIC_PUSH __pragma(warning(push)) +#define CLI11_DIAGNOSTIC_POP __pragma(warning(pop)) + +#define CLI11_DIAGNOSTIC_IGNORE_DEPRECATED __pragma(warning(disable : 4996)) + +#else +#define CLI11_DIAGNOSTIC_PUSH +#define CLI11_DIAGNOSTIC_POP + +#define CLI11_DIAGNOSTIC_IGNORE_DEPRECATED + +#endif + +/** Inline macro **/ +#ifdef CLI11_COMPILE +#define CLI11_INLINE +#else +#define CLI11_INLINE inline +#endif + + + #if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0 #include // NOLINT(build/include) #else @@ -170,9 +204,244 @@ + +#ifdef CLI11_CPP17 +#include +#endif // CLI11_CPP17 + +#if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0 +#include +#include // NOLINT(build/include) +#endif // CLI11_HAS_FILESYSTEM + + + +#if defined(_WIN32) +#if !(defined(_AMD64_) || defined(_X86_) || defined(_ARM_)) +#if defined(__amd64__) || defined(__amd64) || defined(__x86_64__) || defined(__x86_64) || defined(_M_X64) || \ + defined(_M_AMD64) +#define _AMD64_ +#elif defined(i386) || defined(__i386) || defined(__i386__) || defined(__i386__) || defined(_M_IX86) +#define _X86_ +#elif defined(__arm__) || defined(_M_ARM) || defined(_M_ARMT) +#define _ARM_ +#elif defined(__aarch64__) || defined(_M_ARM64) +#define _ARM64_ +#elif defined(_M_ARM64EC) +#define _ARM64EC_ +#endif +#endif + +// first +#ifndef NOMINMAX +// if NOMINMAX is already defined we don't want to mess with that either way +#define NOMINMAX +#include +#undef NOMINMAX +#else +#include +#endif + +// second +#include +// third +#include +#include +#endif + + namespace CLI { +/// Convert a wide string to a narrow string. +CLI11_INLINE std::string narrow(const std::wstring &str); +CLI11_INLINE std::string narrow(const wchar_t *str); +CLI11_INLINE std::string narrow(const wchar_t *str, std::size_t size); + +/// Convert a narrow string to a wide string. +CLI11_INLINE std::wstring widen(const std::string &str); +CLI11_INLINE std::wstring widen(const char *str); +CLI11_INLINE std::wstring widen(const char *str, std::size_t size); + +#ifdef CLI11_CPP17 +CLI11_INLINE std::string narrow(std::wstring_view str); +CLI11_INLINE std::wstring widen(std::string_view str); +#endif // CLI11_CPP17 + +#if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0 +/// Convert a char-string to a native path correctly. +CLI11_INLINE std::filesystem::path to_path(std::string_view str); +#endif // CLI11_HAS_FILESYSTEM + + + + +namespace detail { + +#if !CLI11_HAS_CODECVT +/// Attempt to set one of the acceptable unicode locales for conversion +CLI11_INLINE void set_unicode_locale() { + static const std::array unicode_locales{{"C.UTF-8", "en_US.UTF-8", ".UTF-8"}}; + + for(const auto &locale_name : unicode_locales) { + if(std::setlocale(LC_ALL, locale_name) != nullptr) { + return; + } + } + throw std::runtime_error("CLI::narrow: could not set locale to C.UTF-8"); +} + +template struct scope_guard_t { + F closure; + + explicit scope_guard_t(F closure_) : closure(closure_) {} + ~scope_guard_t() { closure(); } +}; + +template CLI11_NODISCARD CLI11_INLINE scope_guard_t scope_guard(F &&closure) { + return scope_guard_t{std::forward(closure)}; +} + +#endif // !CLI11_HAS_CODECVT + +CLI11_DIAGNOSTIC_PUSH +CLI11_DIAGNOSTIC_IGNORE_DEPRECATED + +CLI11_INLINE std::string narrow_impl(const wchar_t *str, std::size_t str_size) { +#if CLI11_HAS_CODECVT +#ifdef _WIN32 + return std::wstring_convert>().to_bytes(str, str + str_size); + +#else + return std::wstring_convert>().to_bytes(str, str + str_size); + +#endif // _WIN32 +#else // CLI11_HAS_CODECVT + (void)str_size; + std::mbstate_t state = std::mbstate_t(); + const wchar_t *it = str; + + std::string old_locale = std::setlocale(LC_ALL, nullptr); + auto sg = scope_guard([&] { std::setlocale(LC_ALL, old_locale.c_str()); }); + set_unicode_locale(); + + std::size_t new_size = std::wcsrtombs(nullptr, &it, 0, &state); + if(new_size == static_cast(-1)) { + throw std::runtime_error("CLI::narrow: conversion error in std::wcsrtombs at offset " + + std::to_string(it - str)); + } + std::string result(new_size, '\0'); + std::wcsrtombs(const_cast(result.data()), &str, new_size, &state); + + return result; + +#endif // CLI11_HAS_CODECVT +} + +CLI11_INLINE std::wstring widen_impl(const char *str, std::size_t str_size) { +#if CLI11_HAS_CODECVT +#ifdef _WIN32 + return std::wstring_convert>().from_bytes(str, str + str_size); + +#else + return std::wstring_convert>().from_bytes(str, str + str_size); + +#endif // _WIN32 +#else // CLI11_HAS_CODECVT + (void)str_size; + std::mbstate_t state = std::mbstate_t(); + const char *it = str; + + std::string old_locale = std::setlocale(LC_ALL, nullptr); + auto sg = scope_guard([&] { std::setlocale(LC_ALL, old_locale.c_str()); }); + set_unicode_locale(); + + std::size_t new_size = std::mbsrtowcs(nullptr, &it, 0, &state); + if(new_size == static_cast(-1)) { + throw std::runtime_error("CLI::widen: conversion error in std::mbsrtowcs at offset " + + std::to_string(it - str)); + } + std::wstring result(new_size, L'\0'); + std::mbsrtowcs(const_cast(result.data()), &str, new_size, &state); + + return result; + +#endif // CLI11_HAS_CODECVT +} + +CLI11_DIAGNOSTIC_POP + +} // namespace detail + +CLI11_INLINE std::string narrow(const wchar_t *str, std::size_t str_size) { return detail::narrow_impl(str, str_size); } +CLI11_INLINE std::string narrow(const std::wstring &str) { return detail::narrow_impl(str.data(), str.size()); } +// Flawfinder: ignore +CLI11_INLINE std::string narrow(const wchar_t *str) { return detail::narrow_impl(str, std::wcslen(str)); } + +CLI11_INLINE std::wstring widen(const char *str, std::size_t str_size) { return detail::widen_impl(str, str_size); } +CLI11_INLINE std::wstring widen(const std::string &str) { return detail::widen_impl(str.data(), str.size()); } +// Flawfinder: ignore +CLI11_INLINE std::wstring widen(const char *str) { return detail::widen_impl(str, std::strlen(str)); } + +#ifdef CLI11_CPP17 +CLI11_INLINE std::string narrow(std::wstring_view str) { return detail::narrow_impl(str.data(), str.size()); } +CLI11_INLINE std::wstring widen(std::string_view str) { return detail::widen_impl(str.data(), str.size()); } +#endif // CLI11_CPP17 + +#if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0 +CLI11_INLINE std::filesystem::path to_path(std::string_view str) { + return std::filesystem::path{ +#ifdef _WIN32 + widen(str) +#else + str +#endif // _WIN32 + }; +} +#endif // CLI11_HAS_FILESYSTEM + + + + +namespace detail { +#ifdef _WIN32 +/// Decode and return UTF-8 argv from GetCommandLineW. +CLI11_INLINE std::vector compute_win32_argv(); +#endif +} // namespace detail + + + +namespace detail { + +#ifdef _WIN32 +CLI11_INLINE std::vector compute_win32_argv() { + std::vector result; + int argc = 0; + + auto deleter = [](wchar_t **ptr) { LocalFree(ptr); }; + // NOLINTBEGIN(*-avoid-c-arrays) + auto wargv = std::unique_ptr(CommandLineToArgvW(GetCommandLineW(), &argc), deleter); + // NOLINTEND(*-avoid-c-arrays) + + if(wargv == nullptr) { + throw std::runtime_error("CommandLineToArgvW failed with code " + std::to_string(GetLastError())); + } + + result.reserve(static_cast(argc)); + for(size_t i = 0; i < static_cast(argc); ++i) { + result.push_back(narrow(wargv[i])); + } + + return result; +} +#endif + +} // namespace detail + + + + /// Include the items in this namespace to get free conversion of enums to/from streams. /// (This is available inside CLI as well, so CLI11 will use this without a using statement). namespace enums { @@ -270,6 +539,9 @@ inline std::string trim_copy(const std::string &str) { /// remove quotes at the front and back of a string either '"' or '\'' CLI11_INLINE std::string &remove_quotes(std::string &str); +/// remove quotes from all elements of a string vector and process escaped components +CLI11_INLINE void remove_quotes(std::vector &args); + /// Add a leader to the beginning of all new lines (nothing is added /// at the start of the first line). `"; "` would be for ini files /// @@ -290,14 +562,16 @@ CLI11_INLINE std::ostream &format_aliases(std::ostream &out, const std::vector bool valid_first_char(T c) { return ((c != '-') && (c != '!') && (c != ' ') && c != '\n'); } +template bool valid_first_char(T c) { + return ((c != '-') && (static_cast(c) > 33)); // space and '!' not allowed +} /// Verify following characters of an option template bool valid_later_char(T c) { // = and : are value separators, { has special meaning for option defaults, - // and \n would just be annoying to deal with in many places allowing space here has too much potential for - // inadvertent entry errors and bugs - return ((c != '=') && (c != ':') && (c != '{') && (c != ' ') && c != '\n'); + // and control codes other than tab would just be annoying to deal with in many places allowing space here has too + // much potential for inadvertent entry errors and bugs + return ((c != '=') && (c != ':') && (c != '{') && ((static_cast(c) > 32) || c == '\t')); } /// Verify an option/subcommand name @@ -360,18 +634,46 @@ template inline std::string find_and_modify(std::string str, return str; } +/// close a sequence of characters indicated by a closure character. Brackets allows sub sequences +/// recognized bracket sequences include "'`[(<{ other closure characters are assumed to be literal strings +CLI11_INLINE std::size_t close_sequence(const std::string &str, std::size_t start, char closure_char); + /// Split a string '"one two" "three"' into 'one two', 'three' -/// Quote characters can be ` ' or " +/// Quote characters can be ` ' or " or bracket characters [{(< with matching to the matching bracket CLI11_INLINE std::vector split_up(std::string str, char delimiter = '\0'); +/// get the value of an environmental variable or empty string if empty +CLI11_INLINE std::string get_environment_value(const std::string &env_name); + /// This function detects an equal or colon followed by an escaped quote after an argument /// then modifies the string to replace the equality with a space. This is needed /// to allow the split up function to work properly and is intended to be used with the find_and_modify function /// the return value is the offset+1 which is required by the find_and_modify function. CLI11_INLINE std::size_t escape_detect(std::string &str, std::size_t offset); -/// Add quotes if the string contains spaces -CLI11_INLINE std::string &add_quotes_if_needed(std::string &str); +/// @brief detect if a string has escapable characters +/// @param str the string to do the detection on +/// @return true if the string has escapable characters +CLI11_INLINE bool has_escapable_character(const std::string &str); + +/// @brief escape all escapable characters +/// @param str the string to escape +/// @return a string with the escapble characters escaped with '\' +CLI11_INLINE std::string add_escaped_characters(const std::string &str); + +/// @brief replace the escaped characters with their equivalent +CLI11_INLINE std::string remove_escaped_characters(const std::string &str); + +/// generate a string with all non printable characters escaped to hex codes +CLI11_INLINE std::string binary_escape_string(const std::string &string_to_escape); + +CLI11_INLINE bool is_binary_escaped_string(const std::string &escaped_string); + +/// extract an escaped binary_string +CLI11_INLINE std::string extract_binary_string(const std::string &escaped_string); + +/// process a quoted string, remove the quotes and if appropriate handle escaped characters +CLI11_INLINE bool process_quoted_string(std::string &str, char string_char = '\"', char literal_char = '\''); } // namespace detail @@ -421,7 +723,17 @@ CLI11_INLINE std::string &rtrim(std::string &str, const std::string &filter) { } CLI11_INLINE std::string &remove_quotes(std::string &str) { - if(str.length() > 1 && (str.front() == '"' || str.front() == '\'')) { + if(str.length() > 1 && (str.front() == '"' || str.front() == '\'' || str.front() == '`')) { + if(str.front() == str.back()) { + str.pop_back(); + str.erase(str.begin(), str.begin() + 1); + } + } + return str; +} + +CLI11_INLINE std::string &remove_outer(std::string &str, char key) { + if(str.length() > 1 && (str.front() == key)) { if(str.front() == str.back()) { str.pop_back(); str.erase(str.begin(), str.begin() + 1); @@ -541,37 +853,220 @@ find_member(std::string name, const std::vector names, bool ignore_ return (it != std::end(names)) ? (it - std::begin(names)) : (-1); } +static const std::string escapedChars("\b\t\n\f\r\"\\"); +static const std::string escapedCharsCode("btnfr\"\\"); +static const std::string bracketChars{"\"'`[(<{"}; +static const std::string matchBracketChars("\"'`])>}"); + +CLI11_INLINE bool has_escapable_character(const std::string &str) { + return (str.find_first_of(escapedChars) != std::string::npos); +} + +CLI11_INLINE std::string add_escaped_characters(const std::string &str) { + std::string out; + out.reserve(str.size() + 4); + for(char s : str) { + auto sloc = escapedChars.find_first_of(s); + if(sloc != std::string::npos) { + out.push_back('\\'); + out.push_back(escapedCharsCode[sloc]); + } else { + out.push_back(s); + } + } + return out; +} + +CLI11_INLINE std::uint32_t hexConvert(char hc) { + int hcode{0}; + if(hc >= '0' && hc <= '9') { + hcode = (hc - '0'); + } else if(hc >= 'A' && hc <= 'F') { + hcode = (hc - 'A' + 10); + } else if(hc >= 'a' && hc <= 'f') { + hcode = (hc - 'a' + 10); + } else { + hcode = -1; + } + return static_cast(hcode); +} + +CLI11_INLINE char make_char(std::uint32_t code) { return static_cast(static_cast(code)); } + +CLI11_INLINE void append_codepoint(std::string &str, std::uint32_t code) { + if(code < 0x80) { // ascii code equivalent + str.push_back(static_cast(code)); + } else if(code < 0x800) { // \u0080 to \u07FF + // 110yyyyx 10xxxxxx; 0x3f == 0b0011'1111 + str.push_back(make_char(0xC0 | code >> 6)); + str.push_back(make_char(0x80 | (code & 0x3F))); + } else if(code < 0x10000) { // U+0800...U+FFFF + if(0xD800 <= code && code <= 0xDFFF) { + throw std::invalid_argument("[0xD800, 0xDFFF] are not valid UTF-8."); + } + // 1110yyyy 10yxxxxx 10xxxxxx + str.push_back(make_char(0xE0 | code >> 12)); + str.push_back(make_char(0x80 | (code >> 6 & 0x3F))); + str.push_back(make_char(0x80 | (code & 0x3F))); + } else if(code < 0x110000) { // U+010000 ... U+10FFFF + // 11110yyy 10yyxxxx 10xxxxxx 10xxxxxx + str.push_back(make_char(0xF0 | code >> 18)); + str.push_back(make_char(0x80 | (code >> 12 & 0x3F))); + str.push_back(make_char(0x80 | (code >> 6 & 0x3F))); + str.push_back(make_char(0x80 | (code & 0x3F))); + } +} + +CLI11_INLINE std::string remove_escaped_characters(const std::string &str) { + + std::string out; + out.reserve(str.size()); + for(auto loc = str.begin(); loc < str.end(); ++loc) { + if(*loc == '\\') { + if(str.end() - loc < 2) { + throw std::invalid_argument("invalid escape sequence " + str); + } + auto ecloc = escapedCharsCode.find_first_of(*(loc + 1)); + if(ecloc != std::string::npos) { + out.push_back(escapedChars[ecloc]); + ++loc; + } else if(*(loc + 1) == 'u') { + // must have 4 hex characters + if(str.end() - loc < 6) { + throw std::invalid_argument("unicode sequence must have 4 hex codes " + str); + } + std::uint32_t code{0}; + std::uint32_t mplier{16 * 16 * 16}; + for(int ii = 2; ii < 6; ++ii) { + std::uint32_t res = hexConvert(*(loc + ii)); + if(res > 0x0F) { + throw std::invalid_argument("unicode sequence must have 4 hex codes " + str); + } + code += res * mplier; + mplier = mplier / 16; + } + append_codepoint(out, code); + loc += 5; + } else if(*(loc + 1) == 'U') { + // must have 8 hex characters + if(str.end() - loc < 10) { + throw std::invalid_argument("unicode sequence must have 8 hex codes " + str); + } + std::uint32_t code{0}; + std::uint32_t mplier{16 * 16 * 16 * 16 * 16 * 16 * 16}; + for(int ii = 2; ii < 10; ++ii) { + std::uint32_t res = hexConvert(*(loc + ii)); + if(res > 0x0F) { + throw std::invalid_argument("unicode sequence must have 8 hex codes " + str); + } + code += res * mplier; + mplier = mplier / 16; + } + append_codepoint(out, code); + loc += 9; + } else if(*(loc + 1) == '0') { + out.push_back('\0'); + ++loc; + } else { + throw std::invalid_argument(std::string("unrecognized escape sequence \\") + *(loc + 1) + " in " + str); + } + } else { + out.push_back(*loc); + } + } + return out; +} + +CLI11_INLINE std::size_t close_string_quote(const std::string &str, std::size_t start, char closure_char) { + std::size_t loc{0}; + for(loc = start + 1; loc < str.size(); ++loc) { + if(str[loc] == closure_char) { + break; + } + if(str[loc] == '\\') { + // skip the next character for escaped sequences + ++loc; + } + } + return loc; +} + +CLI11_INLINE std::size_t close_literal_quote(const std::string &str, std::size_t start, char closure_char) { + auto loc = str.find_first_of(closure_char, start + 1); + return (loc != std::string::npos ? loc : str.size()); +} + +CLI11_INLINE std::size_t close_sequence(const std::string &str, std::size_t start, char closure_char) { + + auto bracket_loc = matchBracketChars.find(closure_char); + switch(bracket_loc) { + case 0: + return close_string_quote(str, start, closure_char); + case 1: + case 2: + case std::string::npos: + return close_literal_quote(str, start, closure_char); + default: + break; + } + + std::string closures(1, closure_char); + auto loc = start + 1; + + while(loc < str.size()) { + if(str[loc] == closures.back()) { + closures.pop_back(); + if(closures.empty()) { + return loc; + } + } + bracket_loc = bracketChars.find(str[loc]); + if(bracket_loc != std::string::npos) { + switch(bracket_loc) { + case 0: + loc = close_string_quote(str, loc, str[loc]); + break; + case 1: + case 2: + loc = close_literal_quote(str, loc, str[loc]); + break; + default: + closures.push_back(matchBracketChars[bracket_loc]); + break; + } + } + ++loc; + } + if(loc > str.size()) { + loc = str.size(); + } + return loc; +} + CLI11_INLINE std::vector split_up(std::string str, char delimiter) { - const std::string delims("\'\"`"); auto find_ws = [delimiter](char ch) { return (delimiter == '\0') ? std::isspace(ch, std::locale()) : (ch == delimiter); }; trim(str); std::vector output; - bool embeddedQuote = false; - char keyChar = ' '; while(!str.empty()) { - if(delims.find_first_of(str[0]) != std::string::npos) { - keyChar = str[0]; - auto end = str.find_first_of(keyChar, 1); - while((end != std::string::npos) && (str[end - 1] == '\\')) { // deal with escaped quotes - end = str.find_first_of(keyChar, end + 1); - embeddedQuote = true; - } - if(end != std::string::npos) { - output.push_back(str.substr(1, end - 1)); + if(bracketChars.find_first_of(str[0]) != std::string::npos) { + auto bracketLoc = bracketChars.find_first_of(str[0]); + auto end = close_sequence(str, 0, matchBracketChars[bracketLoc]); + if(end >= str.size()) { + output.push_back(std::move(str)); + str.clear(); + } else { + output.push_back(str.substr(0, end + 1)); if(end + 2 < str.size()) { str = str.substr(end + 2); } else { str.clear(); } - - } else { - output.push_back(str.substr(1)); - str = ""; } + } else { auto it = std::find_if(std::begin(str), std::end(str), find_ws); if(it != std::end(str)) { @@ -580,14 +1075,9 @@ CLI11_INLINE std::vector split_up(std::string str, char delimiter) str = std::string(it + 1, str.end()); } else { output.push_back(str); - str = ""; + str.clear(); } } - // transform any embedded quotes into the regular character - if(embeddedQuote) { - output.back() = find_and_replace(output.back(), std::string("\\") + keyChar, std::string(1, keyChar)); - embeddedQuote = false; - } trim(str); } return output; @@ -605,15 +1095,140 @@ CLI11_INLINE std::size_t escape_detect(std::string &str, std::size_t offset) { return offset + 1; } -CLI11_INLINE std::string &add_quotes_if_needed(std::string &str) { - if((str.front() != '"' && str.front() != '\'') || str.front() != str.back()) { - char quote = str.find('"') < str.find('\'') ? '\'' : '"'; - if(str.find(' ') != std::string::npos) { - str.insert(0, 1, quote); - str.append(1, quote); +CLI11_INLINE std::string binary_escape_string(const std::string &string_to_escape) { + // s is our escaped output string + std::string escaped_string{}; + // loop through all characters + for(char c : string_to_escape) { + // check if a given character is printable + // the cast is necessary to avoid undefined behaviour + if(isprint(static_cast(c)) == 0) { + std::stringstream stream; + // if the character is not printable + // we'll convert it to a hex string using a stringstream + // note that since char is signed we have to cast it to unsigned first + stream << std::hex << static_cast(static_cast(c)); + std::string code = stream.str(); + escaped_string += std::string("\\x") + (code.size() < 2 ? "0" : "") + code; + + } else { + escaped_string.push_back(c); } } - return str; + if(escaped_string != string_to_escape) { + auto sqLoc = escaped_string.find('\''); + while(sqLoc != std::string::npos) { + escaped_string.replace(sqLoc, sqLoc + 1, "\\x27"); + sqLoc = escaped_string.find('\''); + } + escaped_string.insert(0, "'B\"("); + escaped_string.push_back(')'); + escaped_string.push_back('"'); + escaped_string.push_back('\''); + } + return escaped_string; +} + +CLI11_INLINE bool is_binary_escaped_string(const std::string &escaped_string) { + size_t ssize = escaped_string.size(); + if(escaped_string.compare(0, 3, "B\"(") == 0 && escaped_string.compare(ssize - 2, 2, ")\"") == 0) { + return true; + } + return (escaped_string.compare(0, 4, "'B\"(") == 0 && escaped_string.compare(ssize - 3, 3, ")\"'") == 0); +} + +CLI11_INLINE std::string extract_binary_string(const std::string &escaped_string) { + std::size_t start{0}; + std::size_t tail{0}; + size_t ssize = escaped_string.size(); + if(escaped_string.compare(0, 3, "B\"(") == 0 && escaped_string.compare(ssize - 2, 2, ")\"") == 0) { + start = 3; + tail = 2; + } else if(escaped_string.compare(0, 4, "'B\"(") == 0 && escaped_string.compare(ssize - 3, 3, ")\"'") == 0) { + start = 4; + tail = 3; + } + + if(start == 0) { + return escaped_string; + } + std::string outstring; + + outstring.reserve(ssize - start - tail); + std::size_t loc = start; + while(loc < ssize - tail) { + // ssize-2 to skip )" at the end + if(escaped_string[loc] == '\\' && (escaped_string[loc + 1] == 'x' || escaped_string[loc + 1] == 'X')) { + auto c1 = escaped_string[loc + 2]; + auto c2 = escaped_string[loc + 3]; + + std::uint32_t res1 = hexConvert(c1); + std::uint32_t res2 = hexConvert(c2); + if(res1 <= 0x0F && res2 <= 0x0F) { + loc += 4; + outstring.push_back(static_cast(res1 * 16 + res2)); + continue; + } + } + outstring.push_back(escaped_string[loc]); + ++loc; + } + return outstring; +} + +CLI11_INLINE void remove_quotes(std::vector &args) { + for(auto &arg : args) { + if(arg.front() == '\"' && arg.back() == '\"') { + remove_quotes(arg); + // only remove escaped for string arguments not literal strings + arg = remove_escaped_characters(arg); + } else { + remove_quotes(arg); + } + } +} + +CLI11_INLINE bool process_quoted_string(std::string &str, char string_char, char literal_char) { + if(str.size() <= 1) { + return false; + } + if(detail::is_binary_escaped_string(str)) { + str = detail::extract_binary_string(str); + return true; + } + if(str.front() == string_char && str.back() == string_char) { + detail::remove_outer(str, string_char); + if(str.find_first_of('\\') != std::string::npos) { + str = detail::remove_escaped_characters(str); + } + return true; + } + if((str.front() == literal_char || str.front() == '`') && str.back() == str.front()) { + detail::remove_outer(str, str.front()); + return true; + } + return false; +} + +std::string get_environment_value(const std::string &env_name) { + char *buffer = nullptr; + std::string ename_string; + +#ifdef _MSC_VER + // Windows version + std::size_t sz = 0; + if(_dupenv_s(&buffer, &sz, env_name.c_str()) == 0 && buffer != nullptr) { + ename_string = std::string(buffer); + free(buffer); + } +#else + // This also works on Windows, but gives a warning + buffer = std::getenv(env_name.c_str()); + if(buffer != nullptr) { + ename_string = std::string(buffer); + } +#endif + return ename_string; } } // namespace detail @@ -722,7 +1337,13 @@ class BadNameString : public ConstructionError { CLI11_ERROR_DEF(ConstructionError, BadNameString) CLI11_ERROR_SIMPLE(BadNameString) static BadNameString OneCharName(std::string name) { return BadNameString("Invalid one char name: " + name); } + static BadNameString MissingDash(std::string name) { + return BadNameString("Long names strings require 2 dashes " + name); + } static BadNameString BadLongName(std::string name) { return BadNameString("Bad long name: " + name); } + static BadNameString BadPositionalName(std::string name) { + return BadNameString("Invalid positional Name: " + name); + } static BadNameString DashesOnly(std::string name) { return BadNameString("Must have a name, not just dashes: " + name); } @@ -1087,11 +1708,19 @@ template class is_direct_constructible { static auto test(int, std::true_type) -> decltype( // NVCC warns about narrowing conversions here #ifdef __CUDACC__ +#ifdef __NVCC_DIAG_PRAGMA_SUPPORT__ +#pragma nv_diag_suppress 2361 +#else #pragma diag_suppress 2361 +#endif #endif TT{std::declval()} #ifdef __CUDACC__ +#ifdef __NVCC_DIAG_PRAGMA_SUPPORT__ +#pragma nv_diag_default 2361 +#else #pragma diag_default 2361 +#endif #endif , std::is_move_assignable()); @@ -1171,8 +1800,10 @@ struct is_mutable_container< decltype(std::declval().clear()), decltype(std::declval().insert(std::declval().end())>(), std::declval()))>, - void>> - : public conditional_t::value, std::false_type, std::true_type> {}; + void>> : public conditional_t::value || + std::is_constructible::value, + std::false_type, + std::true_type> {}; // check to see if an object is a mutable container (fail by default) template struct is_readable_container : std::false_type {}; @@ -1475,6 +2106,8 @@ enum class object_category : int { // string like types string_assignable = 23, string_constructible = 24, + wstring_assignable = 25, + wstring_constructible = 26, other = 45, // special wrapper or container types wrapper_value = 50, @@ -1523,12 +2156,23 @@ template struct classify_object struct classify_object::value>::type> { static constexpr object_category value{object_category::floating_point}; }; +#if defined _MSC_VER +// in MSVC wstring should take precedence if available this isn't as useful on other compilers due to the broader use of +// utf-8 encoding +#define WIDE_STRING_CHECK \ + !std::is_assignable::value && !std::is_constructible::value +#define STRING_CHECK true +#else +#define WIDE_STRING_CHECK true +#define STRING_CHECK !std::is_assignable::value && !std::is_constructible::value +#endif /// String and similar direct assignment template -struct classify_object::value && !std::is_integral::value && - std::is_assignable::value>::type> { +struct classify_object< + T, + typename std::enable_if::value && !std::is_integral::value && WIDE_STRING_CHECK && + std::is_assignable::value>::type> { static constexpr object_category value{object_category::string_assignable}; }; @@ -1538,10 +2182,27 @@ struct classify_object< T, typename std::enable_if::value && !std::is_integral::value && !std::is_assignable::value && (type_count::value == 1) && - std::is_constructible::value>::type> { + WIDE_STRING_CHECK && std::is_constructible::value>::type> { static constexpr object_category value{object_category::string_constructible}; }; +/// Wide strings +template +struct classify_object::value && !std::is_integral::value && + STRING_CHECK && std::is_assignable::value>::type> { + static constexpr object_category value{object_category::wstring_assignable}; +}; + +template +struct classify_object< + T, + typename std::enable_if::value && !std::is_integral::value && + !std::is_assignable::value && (type_count::value == 1) && + STRING_CHECK && std::is_constructible::value>::type> { + static constexpr object_category value{object_category::wstring_constructible}; +}; + /// Enumerations template struct classify_object::value>::type> { static constexpr object_category value{object_category::enumeration}; @@ -1554,12 +2215,13 @@ template struct classify_object struct uncommon_type { - using type = typename std::conditional::value && !std::is_integral::value && - !std::is_assignable::value && - !std::is_constructible::value && !is_complex::value && - !is_mutable_container::value && !std::is_enum::value, - std::true_type, - std::false_type>::type; + using type = typename std::conditional< + !std::is_floating_point::value && !std::is_integral::value && + !std::is_assignable::value && !std::is_constructible::value && + !std::is_assignable::value && !std::is_constructible::value && + !is_complex::value && !is_mutable_container::value && !std::is_enum::value, + std::true_type, + std::false_type>::type; static constexpr bool value = type::value; }; @@ -1748,7 +2410,7 @@ bool integral_conversion(const std::string &input, T &output) noexcept { if(input.empty() || input.front() == '-') { return false; } - char *val = nullptr; + char *val{nullptr}; errno = 0; std::uint64_t output_ll = std::strtoull(input.c_str(), &val, 0); if(errno == ERANGE) { @@ -1764,6 +2426,33 @@ bool integral_conversion(const std::string &input, T &output) noexcept { output = (output_sll < 0) ? static_cast(0) : static_cast(output_sll); return (static_cast(output) == output_sll); } + // remove separators + if(input.find_first_of("_'") != std::string::npos) { + std::string nstring = input; + nstring.erase(std::remove(nstring.begin(), nstring.end(), '_'), nstring.end()); + nstring.erase(std::remove(nstring.begin(), nstring.end(), '\''), nstring.end()); + return integral_conversion(nstring, output); + } + if(input.compare(0, 2, "0o") == 0) { + val = nullptr; + errno = 0; + output_ll = std::strtoull(input.c_str() + 2, &val, 8); + if(errno == ERANGE) { + return false; + } + output = static_cast(output_ll); + return (val == (input.c_str() + input.size()) && static_cast(output) == output_ll); + } + if(input.compare(0, 2, "0b") == 0) { + val = nullptr; + errno = 0; + output_ll = std::strtoull(input.c_str() + 2, &val, 2); + if(errno == ERANGE) { + return false; + } + output = static_cast(output_ll); + return (val == (input.c_str() + input.size()) && static_cast(output) == output_ll); + } return false; } @@ -1788,11 +2477,38 @@ bool integral_conversion(const std::string &input, T &output) noexcept { output = static_cast(1); return true; } + // remove separators + if(input.find_first_of("_'") != std::string::npos) { + std::string nstring = input; + nstring.erase(std::remove(nstring.begin(), nstring.end(), '_'), nstring.end()); + nstring.erase(std::remove(nstring.begin(), nstring.end(), '\''), nstring.end()); + return integral_conversion(nstring, output); + } + if(input.compare(0, 2, "0o") == 0) { + val = nullptr; + errno = 0; + output_ll = std::strtoll(input.c_str() + 2, &val, 8); + if(errno == ERANGE) { + return false; + } + output = static_cast(output_ll); + return (val == (input.c_str() + input.size()) && static_cast(output) == output_ll); + } + if(input.compare(0, 2, "0b") == 0) { + val = nullptr; + errno = 0; + output_ll = std::strtoll(input.c_str() + 2, &val, 2); + if(errno == ERANGE) { + return false; + } + output = static_cast(output_ll); + return (val == (input.c_str() + input.size()) && static_cast(output) == output_ll); + } return false; } -/// Convert a flag into an integer value typically binary flags -inline std::int64_t to_flag_value(std::string val) { +/// Convert a flag into an integer value typically binary flags sets errno to nonzero if conversion failed +inline std::int64_t to_flag_value(std::string val) noexcept { static const std::string trueString("true"); static const std::string falseString("false"); if(val == trueString) { @@ -1820,7 +2536,8 @@ inline std::int64_t to_flag_value(std::string val) { ret = 1; break; default: - throw std::invalid_argument("unrecognized character"); + errno = EINVAL; + return -1; } return ret; } @@ -1829,7 +2546,11 @@ inline std::int64_t to_flag_value(std::string val) { } else if(val == falseString || val == "off" || val == "no" || val == "disable") { ret = -1; } else { - ret = std::stoll(val); + char *loc_ptr{nullptr}; + ret = std::strtoll(val.c_str(), &loc_ptr, 0); + if(loc_ptr != (val.c_str() + val.size()) && errno == 0) { + errno = EINVAL; + } } return ret; } @@ -1858,18 +2579,16 @@ bool lexical_cast(const std::string &input, T &output) { template ::value == object_category::boolean_value, detail::enabler> = detail::dummy> bool lexical_cast(const std::string &input, T &output) { - try { - auto out = to_flag_value(input); + errno = 0; + auto out = to_flag_value(input); + if(errno == 0) { output = (out > 0); - return true; - } catch(const std::invalid_argument &) { - return false; - } catch(const std::out_of_range &) { - // if the number is out of the range of a 64 bit value then it is still a number and for this purpose is still - // valid all we care about the sign + } else if(errno == ERANGE) { output = (input[0] != '-'); - return true; + } else { + return false; } + return true; } /// Floats @@ -1882,7 +2601,17 @@ bool lexical_cast(const std::string &input, T &output) { char *val = nullptr; auto output_ld = std::strtold(input.c_str(), &val); output = static_cast(output_ld); - return val == (input.c_str() + input.size()); + if(val == (input.c_str() + input.size())) { + return true; + } + // remove separators + if(input.find_first_of("_'") != std::string::npos) { + std::string nstring = input; + nstring.erase(std::remove(nstring.begin(), nstring.end(), '_'), nstring.end()); + nstring.erase(std::remove(nstring.begin(), nstring.end(), '\''), nstring.end()); + return lexical_cast(nstring, output); + } + return false; } /// complex @@ -1934,6 +2663,23 @@ bool lexical_cast(const std::string &input, T &output) { return true; } +/// Wide strings +template < + typename T, + enable_if_t::value == object_category::wstring_assignable, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + output = widen(input); + return true; +} + +template < + typename T, + enable_if_t::value == object_category::wstring_constructible, detail::enabler> = detail::dummy> +bool lexical_cast(const std::string &input, T &output) { + output = T{widen(input)}; + return true; +} + /// Enumerations template ::value == object_category::enumeration, detail::enabler> = detail::dummy> @@ -2062,7 +2808,9 @@ template ::value && (classify_object::value == object_category::string_assignable || - classify_object::value == object_category::string_constructible), + classify_object::value == object_category::string_constructible || + classify_object::value == object_category::wstring_assignable || + classify_object::value == object_category::wstring_constructible), detail::enabler> = detail::dummy> bool lexical_assign(const std::string &input, AssignTo &output) { return lexical_cast(input, output); @@ -2073,7 +2821,9 @@ template ::value && std::is_assignable::value && classify_object::value != object_category::string_assignable && - classify_object::value != object_category::string_constructible, + classify_object::value != object_category::string_constructible && + classify_object::value != object_category::wstring_assignable && + classify_object::value != object_category::wstring_constructible, detail::enabler> = detail::dummy> bool lexical_assign(const std::string &input, AssignTo &output) { if(input.empty()) { @@ -2112,9 +2862,17 @@ bool lexical_assign(const std::string &input, AssignTo &output) { output = 0; return true; } - int val = 0; + int val{0}; if(lexical_cast(input, val)) { +#if defined(__clang__) +/* on some older clang compilers */ +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wsign-conversion" +#endif output = val; +#if defined(__clang__) +#pragma clang diagnostic pop +#endif return true; } return false; @@ -2169,12 +2927,12 @@ template = detail::dummy> bool lexical_conversion(const std::vector &strings, AssignTo &output) { // the remove const is to handle pair types coming from a container - typename std::remove_const::type>::type v1; - typename std::tuple_element<1, ConvertTo>::type v2; - bool retval = lexical_assign(strings[0], v1); - if(strings.size() > 1) { - retval = retval && lexical_assign(strings[1], v2); - } + using FirstType = typename std::remove_const::type>::type; + using SecondType = typename std::tuple_element<1, ConvertTo>::type; + FirstType v1; + SecondType v2; + bool retval = lexical_assign(strings[0], v1); + retval = retval && lexical_assign((strings.size() > 1) ? strings[1] : std::string{}, v2); if(retval) { output = AssignTo{v1, v2}; } @@ -2189,6 +2947,9 @@ template = detail::dummy> bool lexical_conversion(const std::vector &strings, AssignTo &output) { output.erase(output.begin(), output.end()); + if(strings.empty()) { + return true; + } if(strings.size() == 1 && strings[0] == "{}") { return true; } @@ -2333,7 +3094,7 @@ tuple_type_conversion(std::vector &strings, AssignTo &output) { std::size_t index{subtype_count_min::value}; const std::size_t mx_count{subtype_count::value}; - const std::size_t mx{(std::max)(mx_count, strings.size())}; + const std::size_t mx{(std::min)(mx_count, strings.size() - 1)}; while(index < mx) { if(is_separator(strings[index])) { @@ -2343,7 +3104,11 @@ tuple_type_conversion(std::vector &strings, AssignTo &output) { } bool retval = lexical_conversion( std::vector(strings.begin(), strings.begin() + static_cast(index)), output); - strings.erase(strings.begin(), strings.begin() + static_cast(index) + 1); + if(strings.size() > index) { + strings.erase(strings.begin(), strings.begin() + static_cast(index) + 1); + } else { + strings.clear(); + } return retval; } @@ -2487,12 +3252,13 @@ inline std::string sum_string_vector(const std::vector &values) { double tv{0.0}; auto comp = lexical_cast(arg, tv); if(!comp) { - try { - tv = static_cast(detail::to_flag_value(arg)); - } catch(const std::exception &) { - fail = true; + errno = 0; + auto fv = detail::to_flag_value(arg); + fail = (errno != 0); + if(fail) { break; } + tv = static_cast(fv); } val += tv; } @@ -2501,13 +3267,10 @@ inline std::string sum_string_vector(const std::vector &values) { output.append(arg); } } else { - if(val <= static_cast((std::numeric_limits::min)()) || - val >= static_cast((std::numeric_limits::max)()) || - std::ceil(val) == std::floor(val)) { - output = detail::value_string(static_cast(val)); - } else { - output = detail::value_string(val); - } + std::ostringstream out; + out.precision(16); + out << val; + output = out.str(); } return output; } @@ -2553,7 +3316,7 @@ CLI11_INLINE bool split_short(const std::string ¤t, std::string &name, std } CLI11_INLINE bool split_long(const std::string ¤t, std::string &name, std::string &value) { - if(current.size() > 2 && current.substr(0, 2) == "--" && valid_first_char(current[2])) { + if(current.size() > 2 && current.compare(0, 2, "--") == 0 && valid_first_char(current[2])) { auto loc = current.find_first_of('='); if(loc != std::string::npos) { name = current.substr(2, loc - 2); @@ -2625,7 +3388,6 @@ get_names(const std::vector &input) { std::vector short_names; std::vector long_names; std::string pos_name; - for(std::string name : input) { if(name.length() == 0) { continue; @@ -2633,6 +3395,8 @@ get_names(const std::vector &input) { if(name.length() > 1 && name[0] == '-' && name[1] != '-') { if(name.length() == 2 && valid_first_char(name[1])) short_names.emplace_back(1, name[1]); + else if(name.length() > 2) + throw BadNameString::MissingDash(name); else throw BadNameString::OneCharName(name); } else if(name.length() > 2 && name.substr(0, 2) == "--") { @@ -2644,12 +3408,15 @@ get_names(const std::vector &input) { } else if(name == "-" || name == "--") { throw BadNameString::DashesOnly(name); } else { - if(pos_name.length() > 0) + if(!pos_name.empty()) throw BadNameString::MultiPositionalNames(name); - pos_name = name; + if(valid_name_string(name)) { + pos_name = name; + } else { + throw BadNameString::BadPositionalName(name); + } } } - return std::make_tuple(short_names, long_names, pos_name); } @@ -2666,7 +3433,6 @@ struct ConfigItem { /// This is the name std::string name{}; - /// Listing of inputs std::vector inputs{}; @@ -2729,8 +3495,8 @@ class ConfigBase : public Config { char valueDelimiter = '='; /// the character to use around strings char stringQuote = '"'; - /// the character to use around single characters - char characterQuote = '\''; + /// the character to use around single characters and literal strings + char literalQuote = '\''; /// the maximum number of layers to allow uint8_t maximumLayers{255}; /// the separator used to separator parent layers @@ -2766,10 +3532,10 @@ class ConfigBase : public Config { valueDelimiter = vSep; return this; } - /// Specify the quote characters used around strings and characters - ConfigBase *quoteCharacter(char qString, char qChar) { + /// Specify the quote characters used around strings and literal strings + ConfigBase *quoteCharacter(char qString, char literalChar) { stringQuote = qString; - characterQuote = qChar; + literalQuote = literalChar; return this; } /// Specify the maximum number of parents @@ -3001,6 +3767,11 @@ class IPV4Validator : public Validator { IPV4Validator(); }; +class EscapedStringTransformer : public Validator { + public: + EscapedStringTransformer(); +}; + } // namespace detail // Static is not needed here, because global const implies static. @@ -3020,6 +3791,9 @@ const detail::NonexistentPathValidator NonexistentPath; /// Check for an IP4 address const detail::IPV4Validator ValidIPV4; +/// convert escaped characters into their associated values +const detail::EscapedStringTransformer EscapedString; + /// Validate the input as a particular type template class TypeValidator : public Validator { public: @@ -3772,14 +4546,14 @@ namespace detail { #if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0 CLI11_INLINE path_type check_path(const char *file) noexcept { std::error_code ec; - auto stat = std::filesystem::status(file, ec); + auto stat = std::filesystem::status(to_path(file), ec); if(ec) { return path_type::nonexistent; } switch(stat.type()) { case std::filesystem::file_type::none: // LCOV_EXCL_LINE case std::filesystem::file_type::not_found: - return path_type::nonexistent; + return path_type::nonexistent; // LCOV_EXCL_LINE case std::filesystem::file_type::directory: return path_type::directory; case std::filesystem::file_type::symlink: @@ -3873,10 +4647,29 @@ CLI11_INLINE IPV4Validator::IPV4Validator() : Validator("IPV4") { return std::string("Each IP number must be between 0 and 255 ") + var; } } - return std::string(); + return std::string{}; }; } +CLI11_INLINE EscapedStringTransformer::EscapedStringTransformer() { + func_ = [](std::string &str) { + try { + if(str.size() > 1 && (str.front() == '\"' || str.front() == '\'' || str.front() == '`') && + str.front() == str.back()) { + process_quoted_string(str); + } else if(str.find_first_of('\\') != std::string::npos) { + if(detail::is_binary_escaped_string(str)) { + str = detail::extract_binary_string(str); + } else { + str = remove_escaped_characters(str); + } + } + return std::string{}; + } catch(const std::invalid_argument &ia) { + return std::string(ia.what()); + } + }; +} } // namespace detail CLI11_INLINE FileOnDefaultPath::FileOnDefaultPath(std::string default_path, bool enableErrorReturn) @@ -4175,7 +4968,8 @@ enum class MultiOptionPolicy : char { TakeFirst, //!< take only the first Expected number of arguments Join, //!< merge all the arguments together into a single string via the delimiter character default('\n') TakeAll, //!< just get all the passed argument regardless - Sum //!< sum all the arguments together if numerical or concatenate directly without delimiter + Sum, //!< sum all the arguments together if numerical or concatenate directly without delimiter + Reverse, //!< take only the last Expected number of arguments in reverse order }; /// This is the CRTP base class for Option and OptionDefaults. It was designed this way @@ -4683,12 +5477,12 @@ class Option : public OptionBase