Cazadorro
commented
11 months ago Okay, I've got a proof of concept of how I would attempt this, I managed to replicate this in my private registry,
First, each port has the following file structure:
port/
stb-image/
cmake/
config.cmake.in
CMakeLists.txt
portfile.cmake
vcpkg.json
stb-hexwave/ ...
stb-image-write/ ... config.cmake.in contains the typical:
@PACKAGE_INIT@
include("${CMAKE_CURRENT_LIST_DIR}/stb-imageTargets.cmake")
include(CMakeFindDependencyMacro)
check_required_components(stb-image)CMakeLists.txt likewise acts like a normal CMakeLists.txt, except we create the implementation file for the given header (note version is derived from the table in the repo, as the author doesn't use tags, even further showing the balkanization of the header files there):
cmake_minimum_required(VERSION 3.26)
project(stb-image)
if(NOT APPLE)
set(CMAKE_INSTALL_RPATH $ORIGIN)
endif()
file(WRITE ${CMAKE_CURRENT_SOURCE_DIR}/stb_image.c
"#define STB_IMAGE_IMPLEMENTATION
#include \"stb_image.h\"")
add_library(stb-image)
#https://discourse.cmake.org/t/installing-headers-the-modern-way-regurgitated-and-revisited/3238/3
#https://crascit.com/wp-content/uploads/2019/09/Deep-CMake-For-Library-Authors-Craig-Scott-CppCon-2019.pdf
target_sources(stb-image PUBLIC
FILE_SET HEADERS
TYPE HEADERS
FILES
#BASE_DIRS .... not needed if we have no "base dirs" to treat as root dir for include purposes
stb_image.h
)
target_sources(stb-image
PRIVATE
stb_image.c
)
target_include_directories(stb-image PUBLIC
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
)
set_target_properties(stb-image PROPERTIES
SOVERSION 2
VERSION 2.29.0)
add_library(stb::image ALIAS stb-image)
set_target_properties(stb-image PROPERTIES EXPORT_NAME image)
include(CMakePackageConfigHelpers)
include(GNUInstallDirs)
install(TARGETS stb-image
EXPORT stb-image_Targets
FILE_SET HEADERS DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
COMPONENT stb-image_Development
INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
COMPONENT stb-image_RunTime
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
COMPONENT stb-image_RunTIme
NAMELINK_COMPONENT stb-image_Development
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
COMPONENT stb-image_Development
)
set(stb-image_INSTALL_CMAKEDIR
${CMAKE_INSTALL_DATADIR}/stb-image
CACHE STRING "Path to stb-image cmake files"
)
install(EXPORT stb-image_Targets
DESTINATION ${stb-image_INSTALL_CMAKEDIR}
NAMESPACE stb::
FILE stb-imageTargets.cmake
COMPONENT stb-image_Development
)
configure_package_config_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/config.cmake.in
"${CMAKE_CURRENT_BINARY_DIR}/stb-imageConfig.cmake"
INSTALL_DESTINATION ${stb-image_INSTALL_CMAKEDIR}
)
get_target_property(stb-image_VERSION stb-image VERSION)
write_basic_package_version_file(stb-imageConfigVersion.cmake VERSION ${stb-image_VERSION} COMPATIBILITY SameMajorVersion)
install(FILES
${CMAKE_CURRENT_BINARY_DIR}/stb-imageConfig.cmake
${CMAKE_CURRENT_BINARY_DIR}/stb-imageConfigVersion.cmake
DESTINATION ${stb-image_INSTALL_CMAKEDIR}
)
Then portfile.cmake contains:
vcpkg_download_distfile(
ARCHIVE
URLS "https://raw.githubusercontent.com/nothings/stb/master/stb_image.h"
FILENAME "stb_image.h"
SHA512 92EA97568AE2466249DBDCDC4BD378AA3A594BBAF9FA6F21C112F1BC617035BF2B03DB1661A35CF7169E066329E43CE93E184A314A7833F57F5E3B40EE9F0B65
)
vcpkg_noextract_source_archive(
SOURCE_PATH
ARCHIVE "${ARCHIVE}"
NO_REMOVE_ONE_LEVEL
)
file(COPY "${CMAKE_CURRENT_LIST_DIR}/CMakeLists.txt" DESTINATION "${SOURCE_PATH}")
file(COPY "${CMAKE_CURRENT_LIST_DIR}/cmake" DESTINATION "${SOURCE_PATH}")
vcpkg_configure_cmake(
SOURCE_PATH "${SOURCE_PATH}"
PREFER_NINJA
)
vcpkg_install_cmake()
vcpkg_fixup_cmake_targets()
file(REMOVE_RECURSE "${CURRENT_PACKAGES_DIR}/debug/include")note I created a new function called vcpkg_noextract_source_archive because I couldn't figure out what function would allow me to just create a source path based on the file I used and not force it to extract on it, and to generate a proper ${SOURCE_PATH} which would automatically be removed. I just edited vcpkg_extract_source_archive and turned the tar -xfz command into a CMake copy command.
vcpkg_execute_required_process(
ALLOW_IN_DOWNLOAD_MODE
COMMAND "${CMAKE_COMMAND}" -E copy "${arg_ARCHIVE}" "${temp_dir}"
WORKING_DIRECTORY "${temp_dir}"
LOGNAME extract
)and left everything else the same.
Finally my vcpkg.json looks like this:
{
"name": "stb-image",
"version-string": "2.29.0",
"homepage": "https://github.com/nothings/stb",
"dependencies": [
{
"name": "vcpkg-cmake",
"host": true
},
{
"name": "vcpkg-cmake-config",
"host": true
}
]
}Note I think I'm using the outdated versions of vcpkg-cmake-config functions etc, so i would probably upgrade to those, but for now I was just trying to get a proof of concept working. Additionally, if there really is no base way to handle just file downloads in VCPKG's built in commands that manage ${SOURCE_PATH}, then I would probably add a new CMake host vcpkg dependency to the vpckg.json here allowing me to use my vcpkg_noextract_source_archive function.
This same process would then be repeated nearly exactly for every single other library in the list above, except for stb-vorbis because it actually has the opposite problem as the other libraries, and neesd to be turned into a header only library instead. See this: http://nothings.org/stb_vorbis/
You can also avoid having to cut-and-paste the header file with new releases by doing the following:
create 'stb_vorbis.h' #define STB_VORBIS_HEADER_ONLY #include "stb_vorbis.c"
In addition those files with features (like vorbis) would have the features added.
I'm also missing the LISCENSE installation which would be duplicated per library in this instance, I just didn't bother yet with it.
I have no problem giving this treatment to the rest of the libraries, but I'll pause my work until I know it's useful here, since I only actually use stb_image and stb_image_write
dg0yt
xiaozhuai
maxime-modulopi
petersteneteg
Is your feature request related to a problem? Please describe.
Note, I'm planning on doing the work for this anyway in a personal vcpkg registry regardless of how people feel, but this is a fairly big change so I can't just make a pull request for this.
stb is not a real "header only library" yet, vcpkg treats as if it is in the port. Most files require
STB_XXX_IMPLEMENTATIONinside only in a single source file to work properly, it's not a simple include process. It's also not a single library, it's several separate libraries that don't have dependencies on one another. I propose that instead of the current set up, the port for stb get split intoand each properly deal with
STB_XXX_IMPLEMENTATIONProposed solution
Each of these ports would use fetch content/fiile download/external project add to grab the relevant files. Features could then be enabled for each relevant library with features (for example, stb-vorbis), and each would be able to be used via stb::image stb::truetype etc... in the relevant cmake file. As it stands, the naive solution with out VCPKG is actually easier to manage stb than vcpkg's solution is.
Describe alternatives you've considered
We could instead add "features" to stb which would include each of the relevant libraries, but this would break anybody who's relying on stb right now. The change above would not necessitate a change to the stb port itself, besides maybe deprecating it if need be. Additionally, there libraries aren't even features. Unlike a regular repo, each of the stb_files.h should really be their own repo and project, it's just organized as one repo.
Additional context
Our current code depends on the whole
STB_XXX_IMPLEMENTATIONissue being fixed, so that we don't have to worry about includingstb_xxx.hfiles in more than one place causing issues. With out changes, it's impossible to use VCPKG's publically availible stb port in our codebase.