Package the polyscope project with vcpkg

[1309896340]

I try to use vcpkg to build my project. I need the polyscope project to run my code. However, this project is not in vcpkg's repo. So I try to package it by myself. I try to follow the tutorial from Tutorial: Package a library with vcpkg but meet some problems.

This is my workspace folder tree

• /
  • custom-overlay/
    • polyscope/
      • portfile.cmake
      • vcpkg.json
  • vcpkg-configuration.json

This is portfile.cmake content

vcpkg_check_linkage(ONLY_DYNAMIC_LIBRARY)

vcpkg_from_github(
    OUT_SOURCE_PATH SOURCE_PATH
    REPO nmwsharp/polyscope
    REF "v${VERSION}"
    SHA512 4d8c6ab5488059e3cbc77e2ce51043edd9e19919b8b50b27ec7c448cbf1c93ba1f2c5331b7772c243c67d243043fe39f21374968fbe0b6b05d308318e55dbe97
    HEAD_REF master
)
vcpkg_cmake_configure(
    SOURCE_PATH "${SOURCE_PATH}"
)
vcpkg_cmake_install()
vcpkg_cmake_config_fixup(PACKAGE_NAME "polyscope")
file(REMOVE_RECURSE "${CURRENT_PACKAGES_DIR}/debug/include")
file(INSTALL "${SOURCE_PATH}/LICENSE" DESTINATION "${CURRENT_PACKAGES_DIR}/share/${PORT}" RENAME copyright)
configure_file("${CMAKE_CURRENT_LIST_DIR}/usage" "${CURRENT_PACKAGES_DIR}/share/${PORT}/usage" COPYONLY)

This is vcpkg.json content

{
    "name": "polyscope",
    "version": "2.3.0",
    "homepage": "https://github.com/nmwsharp/polyscope",
    "description": "Polyscope is a C++/Python viewer and user interface for 3D data such as meshes and point clouds.",
    "license": "MIT",
    "dependencies": [
        "vcpkg-cmake",
        "glm",
        "glfw3",
        "happly"
    ]
}

Then I vcpkg install polyscope --overlay-ports=/path/to/custom-overlay then get the error below

Computing installation plan...
The following packages will be built and installed:
    polyscope:[email protected] -- C:\Users\admin\Desktop\package-polyscope\custom-overlay\polyscope
Detecting compiler hash for triplet x64-windows...
Compiler found: D:/myfile/software/VisualStudio2022/VC/Tools/MSVC/14.41.34120/bin/Hostx64/x64/cl.exe
Restored 0 package(s) from C:\Users\admin\AppData\Local\vcpkg\archives in 156 us. Use --debug to see more details.
Installing 1/1 polyscope:[email protected]...
Building polyscope:[email protected]...
C:\Users\admin\Desktop\package-polyscope\custom-overlay\polyscope: info: installing overlay port from here
-- Using cached nmwsharp-polyscope-v2.3.0.tar.gz.
-- Cleaning sources at D:/myfile/software/vcpkg/buildtrees/polyscope/src/v2.3.0-dcfb7b26cb.clean. Use --editable to skip cleaning for the packages you specify.
-- Extracting source D:/myfile/software/vcpkg/downloads/nmwsharp-polyscope-v2.3.0.tar.gz
-- Using source at D:/myfile/software/vcpkg/buildtrees/polyscope/src/v2.3.0-dcfb7b26cb.clean
-- Found external ninja('1.11.0').
-- Configuring x64-windows
CMake Error at scripts/cmake/vcpkg_execute_required_process.cmake:127 (message):
    Command failed: D:/myfile/software/VisualStudio2022/Common7/IDE/CommonExtensions/Microsoft/CMake/Ninja/ninja.exe -v
    Working Directory: D:/myfile/software/vcpkg/buildtrees/polyscope/x64-windows-rel/vcpkg-parallel-configure
    Error code: 1
    See logs for more information:
      D:\myfile\software\vcpkg\buildtrees\polyscope\config-x64-windows-dbg-CMakeCache.txt.log
      D:\myfile\software\vcpkg\buildtrees\polyscope\config-x64-windows-rel-CMakeCache.txt.log
      D:\myfile\software\vcpkg\buildtrees\polyscope\config-x64-windows-dbg-CMakeConfigureLog.yaml.log
      D:\myfile\software\vcpkg\buildtrees\polyscope\config-x64-windows-rel-CMakeConfigureLog.yaml.log
      D:\myfile\software\vcpkg\buildtrees\polyscope\config-x64-windows-out.log

Call Stack (most recent call first):
  installed/x64-windows/share/vcpkg-cmake/vcpkg_cmake_configure.cmake:269 (vcpkg_execute_required_process)
  C:/Users/admin/Desktop/package-polyscope/custom-overlay/polyscope/portfile.cmake:12 (vcpkg_cmake_configure)
  scripts/ports.cmake:192 (include)


error: building polyscope:x64-windows failed with: BUILD_FAILED
See https://learn.microsoft.com/vcpkg/troubleshoot/build-failures?WT.mc_id=vcpkg_inproduct_cli for more information.
Elapsed time to handle polyscope:x64-windows: 6 s
Please ensure you're using the latest port files with `git pull` and `vcpkg update`.
Then check for known issues at:
  https://github.com/microsoft/vcpkg/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+polyscope
You can submit a new issue at:
  https://github.com/microsoft/vcpkg/issues/new?title=[polyscope]+Build+error+on+x64-windows&body=Copy+issue+body+from+D%3A%2Fmyfile%2Fsoftware%2Fvcpkg%2Finstalled%2Fvcpkg%2Fissue_body.md

This is my guess:
The project polyscope has three submodules in deps folder. When vcpkg downloads polyscope project, the submodules are not downloaded. So when it add_subdirectory() them, error occur.

How to deal with it ? I'm new to use package management tools.

[YunchengLiu]

I manually downloaded these submodule files and moved them to the target directory, which at least solved the problem.

However, when building as a dynamic library, polyscope needs to link to various dependent libraries. I am not very proficient in cmake and don't know how to modify this. If it involves modifying polyscope/cmakelists.txt, I think I can use patch files to modify it non-invasively.

Note that I have only solved the problem of downloading submodules and preliminary building. I have not yet performed the final complete build, so I am not sure whether the deployment of pdb, etc. is correct.

vcpkg_check_linkage(ONLY_DYNAMIC_LIBRARY)

vcpkg_from_github(
    OUT_SOURCE_PATH SOURCE_PATH
    REPO nmwsharp/polyscope
    REF "v${VERSION}"
    SHA512 4d8c6ab5488059e3cbc77e2ce51043edd9e19919b8b50b27ec7c448cbf1c93ba1f2c5331b7772c243c67d243043fe39f21374968fbe0b6b05d308318e55dbe97
    HEAD_REF master
)

vcpkg_from_github(
    OUT_SOURCE_PATH GLFW_SUBMODULE_PATH
    REPO glfw/glfw
    REF e2c9264
    SHA512  ead18e7c9188dd4c152cc9ea5ee06a137ced958d273224086e306bb469ebd170c5c86ecac33755fddfebe1fa5f5f48f02fd081bb6df74460731778fbaa4dce4b
)

vcpkg_from_github(
    OUT_SOURCE_PATH GLM_SUBMODULE_PATH
    REPO g-truc/glm
    REF 0af55cc
    SHA512 f66bf7f419b4458dd10524dc96fa2b5651374cf80ac198566ed0a80e6f66fc0cbeb6010edf0f984c4c415e84289b64002f664c6b43c00d39e9d92389b321696d
)

vcpkg_from_github(
    OUT_SOURCE_PATH HAPPLY_SUBMODULE_PATH
    REPO nmwsharp/happly
    REF 88f7972
    SHA512 79f2be2d4f5583bc4ea63d92af142fc1a59c91610dee5d2bbbd3fbfb6ff6cd697cd6cc6d740ac3878278257f550c739832b2ecf10887b0607045e9f09a35c92c
)

vcpkg_from_github(
    OUT_SOURCE_PATH IMGUI_SUBMODULE_PATH
    REPO ocornut/imgui
    REF 277ae93
    SHA512 3f8cde363f3a5160419db602fba8246dbcfba9639df097b72186233d83a4c72ea6cfdc27d30445e8556b6e3866246cd96c05c3ae701b9ec4e1f388d1b52e0c9d
)

file(INSTALL "${GLFW_SUBMODULE_PATH}/" DESTINATION "${SOURCE_PATH}/deps/glfw" FILE_PERMISSIONS OWNER_WRITE OWNER_READ GROUP_READ WORLD_READ)

file(INSTALL "${GLM_SUBMODULE_PATH}/" DESTINATION "${SOURCE_PATH}/deps/glm" FILE_PERMISSIONS OWNER_WRITE OWNER_READ GROUP_READ WORLD_READ)

file(INSTALL "${HAPPLY_SUBMODULE_PATH}/" DESTINATION "${SOURCE_PATH}/deps/happly" FILE_PERMISSIONS OWNER_WRITE OWNER_READ GROUP_READ WORLD_READ)

file(INSTALL "${IMGUI_SUBMODULE_PATH}/" DESTINATION "${SOURCE_PATH}/deps/imgui/imgui" FILE_PERMISSIONS OWNER_WRITE OWNER_READ GROUP_READ WORLD_READ)

vcpkg_cmake_configure(
    SOURCE_PATH "${SOURCE_PATH}"
)

vcpkg_install_cmake()
vcpkg_cmake_config_fixup(PACKAGE_NAME "polyscope")
file(REMOVE_RECURSE "${CURRENT_PACKAGES_DIR}/debug/include")
file(INSTALL "${SOURCE_PATH}/LICENSE" DESTINATION "${CURRENT_PACKAGES_DIR}/share/${PORT}" RENAME copyright)
configure_file("${CMAKE_CURRENT_LIST_DIR}/usage" "${CURRENT_PACKAGES_DIR}/share/${PORT}/usage" COPYONLY)
vcpkg_copy_pdbs()

[YunchengLiu]

If all dependencies of polyscope are to be changed to vcpkg, I think more work will need to be done on the build script of polyscope. At least some issues from a long time ago do not seem to have made much obvious progress.