New packages: libimobiledevice, getopt, readline (#3504)

* Add libplist

* Add libusbmuxd

* Fix typos

* Add getopt

* Add libimobiledevice

* Fix typos

* Add libideviceactivation

* Add ideviceinstaller

* Include utilities

* Install usbmuxd

* Add readline

* Fix readline on 64-bit windows

* Add libirecovery

* libideviceactivation: include tools

* Bump versions to fix build issues

* Bump versions

* Add idevicerestore

* [getopt][getopt-win32] Rename to getopt-win32 and only install on Windows Desktop

* [readline][readline-win32] Rename to readline-win32 and only install for Windows Desktop

* [vcpkg_from_github][vcpkg_apply_patches] Make PATCHES relative to the current port directory

* [vcpkg_install_msbuild][vcpkg_check_linkage] Introduce vcpkg_install_msbuild() and vcpkg_check_linkage().

* [libimobiledevice et al] Use vcpkg_from_github() and vcpkg_install_msbuild()

* [readline] Fix static builds

7 files changed, 283 insertions, 5 deletions

diff --git a/scripts/buildsystems/msbuild/vcpkg.targets b/scripts/buildsystems/msbuild/vcpkg.targets
index 499052e4d..456783f4d 100644
--- a/scripts/buildsystems/msbuild/vcpkg.targets
+++ b/scripts/buildsystems/msbuild/vcpkg.targets
@@ -47,13 +47,14 @@
   <PropertyGroup Condition="'$(Platform)|$(ApplicationType)|$(ApplicationTypeRevision)' == 'arm64|Windows Store|10.0'">
     <VcpkgEnabled Condition="'$(VcpkgEnabled)' == ''">true</VcpkgEnabled>
     <VcpkgTriplet Condition="'$(VcpkgTriplet)' == ''">arm64-uwp</VcpkgTriplet>
-  </PropertyGroup>  
+  </PropertyGroup>
 
   <PropertyGroup Condition="'$(VcpkgEnabled)' == 'true'">
     <VcpkgConfiguration Condition="'$(VcpkgConfiguration)' == ''">$(Configuration)</VcpkgConfiguration>
     <VcpkgNormalizedConfiguration Condition="$(VcpkgConfiguration.StartsWith('Debug'))">Debug</VcpkgNormalizedConfiguration>
     <VcpkgNormalizedConfiguration Condition="$(VcpkgConfiguration.StartsWith('Release')) or '$(VcpkgConfiguration)' == 'RelWithDebInfo' or '$(VcpkgConfiguration)' == 'MinSizeRel'">Release</VcpkgNormalizedConfiguration>
     <VcpkgRoot Condition="'$(VcpkgRoot)' == ''">$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), .vcpkg-root))\installed\$(VcpkgTriplet)\</VcpkgRoot>
+    <VcpkgApplocalDeps Condition="'$(VcpkgApplocalDeps)' == ''">true</VcpkgApplocalDeps>
   </PropertyGroup>
 
   <ItemDefinitionGroup Condition="'$(VcpkgEnabled)' == 'true'">
@@ -77,7 +78,7 @@
     <Message Text="Vcpkg is unable to link because we cannot decide between Release and Debug libraries. Please define the property VcpkgConfiguration to be 'Release' or 'Debug' (currently '$(VcpkgConfiguration)')." Importance="High" Condition="'$(VcpkgEnabled)' == 'true' and '$(VcpkgNormalizedConfiguration)' == ''"/>
   </Target>
 
-  <Target Name="AppLocalFromInstalled" AfterTargets="CopyFilesToOutputDirectory" BeforeTargets="CopyLocalFilesOutputGroup;RegisterOutput" Condition="'$(VcpkgEnabled)' == 'true'">
+  <Target Name="AppLocalFromInstalled" AfterTargets="CopyFilesToOutputDirectory" BeforeTargets="CopyLocalFilesOutputGroup;RegisterOutput" Condition="'$(VcpkgEnabled)' == 'true' and '$(VcpkgApplocalDeps)' == 'true'">
     <WriteLinesToFile
     File="$(TLogLocation)$(ProjectName).write.1u.tlog"
     Lines="^$(TargetPath);$([System.IO.Path]::Combine($(ProjectDir),$(IntDir)))vcpkg.applocal.log" Encoding="Unicode"/>
diff --git a/scripts/cmake/vcpkg_apply_patches.cmake b/scripts/cmake/vcpkg_apply_patches.cmake
index d62fbbf84..ac0b78e20 100644
--- a/scripts/cmake/vcpkg_apply_patches.cmake
+++ b/scripts/cmake/vcpkg_apply_patches.cmake
@@ -37,10 +37,11 @@ function(vcpkg_apply_patches)
     find_program(GIT NAMES git git.cmd)
     set(PATCHNUM 0)
     foreach(PATCH ${_ap_PATCHES})
+        get_filename_component(ABSOLUTE_PATCH "${PATCH}" ABSOLUTE BASE_DIR "${CURRENT_PORT_DIR}")
         message(STATUS "Applying patch ${PATCH}")
         set(LOGNAME patch-${TARGET_TRIPLET}-${PATCHNUM})
         execute_process(
-            COMMAND ${GIT} --work-tree=. --git-dir=.git apply "${PATCH}" --ignore-whitespace --whitespace=nowarn --verbose
+            COMMAND ${GIT} --work-tree=. --git-dir=.git apply "${ABSOLUTE_PATCH}" --ignore-whitespace --whitespace=nowarn --verbose
             OUTPUT_FILE ${CURRENT_BUILDTREES_DIR}/${LOGNAME}-out.log
             ERROR_FILE ${CURRENT_BUILDTREES_DIR}/${LOGNAME}-err.log
             WORKING_DIRECTORY ${_ap_SOURCE_PATH}
diff --git a/scripts/cmake/vcpkg_build_msbuild.cmake b/scripts/cmake/vcpkg_build_msbuild.cmake
index fdf519f2c..7a65127f0 100644
--- a/scripts/cmake/vcpkg_build_msbuild.cmake
+++ b/scripts/cmake/vcpkg_build_msbuild.cmake
@@ -1,6 +1,6 @@
 ## # vcpkg_build_msbuild
 ##
-## Build an msbuild-based project.
+## Build an msbuild-based project. Deprecated in favor of `vcpkg_install_msbuild()`.
 ##
 ## ## Usage
 ## ```cmake
diff --git a/scripts/cmake/vcpkg_check_linkage.cmake b/scripts/cmake/vcpkg_check_linkage.cmake
new file mode 100644
index 000000000..022e2b860
--- /dev/null
+++ b/scripts/cmake/vcpkg_check_linkage.cmake
@@ -0,0 +1,53 @@
+## # vcpkg_check_linkage

+##

+## Asserts the available library and CRT linkage options for the port.

+##

+## ## Usage

+## ```cmake

+## vcpkg_check_linkage(

+##     [ONLY_STATIC_LIBRARY | ONLY_DYNAMIC_LIBRARY]

+##     [ONLY_STATIC_CRT | ONLY_DYNAMIC_CRT]

+## )

+## ```

+##

+## ## Parameters

+## ### ONLY_STATIC_LIBRARY

+## Indicates that this port can only be built with static library linkage.

+##

+## ### ONLY_DYNAMIC_LIBRARY

+## Indicates that this port can only be built with dynamic/shared library linkage.

+##

+## ### ONLY_STATIC_CRT

+## Indicates that this port can only be built with static CRT linkage.

+##

+## ### ONLY_DYNAMIC_CRT

+## Indicates that this port can only be built with dynamic/shared CRT linkage.

+##

+## ## Notes

+## This command will either alter the settings for `VCPKG_LIBRARY_LINKAGE` or fail, depending on what was requested by the user versus what the library supports.

+##

+## ## Examples

+##

+## * [libimobiledevice](https://github.com/Microsoft/vcpkg/blob/master/ports/libimobiledevice/portfile.cmake)

+function(vcpkg_check_linkage)

+    cmake_parse_arguments(_csc "ONLY_STATIC_LIBRARY;ONLY_DYNAMIC_LIBRARY;ONLY_DYNAMIC_CRT;ONLY_STATIC_CRT" "" "" ${ARGN})

+

+    if(_csc_ONLY_STATIC_LIBRARY AND VCPKG_LIBRARY_LINKAGE STREQUAL "dynamic")

+        message(STATUS "Note: ${PORT} only supports static library linkage. Building static library.")

+        set(VCPKG_LIBRARY_LINKAGE static)

+    endif()

+    if(_csc_ONLY_DYNAMIC_LIBRARY AND VCPKG_LIBRARY_LINKAGE STREQUAL "static")

+        message(STATUS "Note: ${PORT} only supports dynamic library linkage. Building dynamic library.")

+        if(VCPKG_CRT_LINKAGE STREQUAL "static")

+            message(FATAL_ERROR "Refusing to build unexpected dynamic library against the static CRT. If this is desired, please configure your triplet to directly request this configuration.")

+        endif()

+        set(VCPKG_LIBRARY_LINKAGE dynamic)

+    endif()

+

+    if(_csc_ONLY_DYNAMIC_CRT AND VCPKG_CRT_LINKAGE STREQUAL "static")

+        message(FATAL_ERROR "${PORT} only supports dynamic crt linkage")

+    endif()

+    if(_csc_ONLY_STATIC_CRT AND VCPKG_CRT_LINKAGE STREQUAL "dynamic")

+        message(FATAL_ERROR "${PORT} only supports static crt linkage")

+    endif()

+endfunction()

diff --git a/scripts/cmake/vcpkg_common_functions.cmake b/scripts/cmake/vcpkg_common_functions.cmake
index 8914ac549..6677af00a 100644
--- a/scripts/cmake/vcpkg_common_functions.cmake
+++ b/scripts/cmake/vcpkg_common_functions.cmake
@@ -1,4 +1,5 @@
 include(vcpkg_acquire_msys)
+include(vcpkg_check_linkage)
 include(vcpkg_download_distfile)
 include(vcpkg_extract_source_archive)
 include(vcpkg_execute_required_process)
@@ -13,6 +14,7 @@ include(vcpkg_build_msbuild)
 include(vcpkg_build_qmake)
 include(vcpkg_install_cmake)
 include(vcpkg_install_meson)
+include(vcpkg_install_msbuild)
 include(vcpkg_configure_cmake)
 include(vcpkg_configure_meson)
 include(vcpkg_configure_qmake)
diff --git a/scripts/cmake/vcpkg_from_github.cmake b/scripts/cmake/vcpkg_from_github.cmake
index fbceb2aae..68baa908e 100644
--- a/scripts/cmake/vcpkg_from_github.cmake
+++ b/scripts/cmake/vcpkg_from_github.cmake
@@ -117,7 +117,8 @@ function(vcpkg_from_github)
         # Hash the archive hash along with the patches. Take the first 10 chars of the hash
         set(PATCHSET_HASH "${_vdud_SHA512}")
         foreach(PATCH IN LISTS _vdud_PATCHES)
-            file(SHA512 ${PATCH} CURRENT_HASH)
+            get_filename_component(ABSOLUTE_PATCH "${PATCH}" ABSOLUTE BASE_DIR "${CURRENT_PORT_DIR}")
+            file(SHA512 ${ABSOLUTE_PATCH} CURRENT_HASH)
             string(APPEND PATCHSET_HASH ${CURRENT_HASH})
         endforeach()
 
diff --git a/scripts/cmake/vcpkg_install_msbuild.cmake b/scripts/cmake/vcpkg_install_msbuild.cmake
new file mode 100644
index 000000000..ad700dd35
--- /dev/null
+++ b/scripts/cmake/vcpkg_install_msbuild.cmake
@@ -0,0 +1,220 @@
+## # vcpkg_install_msbuild
+##
+## Build and install an msbuild-based project. This replaces `vcpkg_build_msbuild()`.
+##
+## ## Usage
+## ```cmake
+## vcpkg_install_msbuild(
+##     SOURCE_PATH <${SOURCE_PATH}>
+##     PROJECT_SUBPATH <port.sln>
+##     [INCLUDES_SUBPATH <include>]
+##     [LICENSE_SUBPATH <LICENSE>]
+##     [RELEASE_CONFIGURATION <Release>]
+##     [DEBUG_CONFIGURATION <Debug>]
+##     [TARGET <Build>]
+##     [TARGET_PLATFORM_VERSION <10.0.15063.0>]
+##     [PLATFORM <${TRIPLET_SYSTEM_ARCH}>]
+##     [PLATFORM_TOOLSET <${VCPKG_PLATFORM_TOOLSET}>]
+##     [OPTIONS </p:ZLIB_INCLUDE_PATH=X>...]
+##     [OPTIONS_RELEASE </p:ZLIB_LIB=X>...]
+##     [OPTIONS_DEBUG </p:ZLIB_LIB=X>...]
+##     [USE_VCPKG_INTEGRATION]
+##     [ALLOW_ROOT_INCLUDES | REMOVE_ROOT_INCLUDES]
+## )
+## ```
+##
+## ## Parameters
+## ### SOURCE_PATH
+## The path to the root of the source tree.
+##
+## Because MSBuild uses in-source builds, the source tree will be copied into a temporary location for the build. This
+## parameter is the base for that copy and forms the base for all XYZ_SUBPATH options.
+##
+## ### USE_VCPKG_INTEGRATION
+## Apply the normal `integrate install` integration for building the project.
+##
+## By default, projects built with this command will not automatically link libraries or have header paths set.
+##
+## ### PROJECT_SUBPATH
+## The subpath to the solution (`.sln`) or project (`.vcxproj`) file relative to `SOURCE_PATH`.
+##
+## ### LICENSE_SUBPATH
+## The subpath to the license file relative to `SOURCE_PATH`.
+##
+## ### INCLUDES_SUBPATH
+## The subpath to the includes directory relative to `SOURCE_PATH`.
+##
+## This parameter should be a directory and should not end in a trailing slash.
+##
+## ### ALLOW_ROOT_INCLUDES
+## Indicates that top-level include files (e.g. `include/zlib.h`) should be allowed.
+##
+## ### REMOVE_ROOT_INCLUDES
+## Indicates that top-level include files (e.g. `include/Makefile.am`) should be removed.
+##
+## ### RELEASE_CONFIGURATION
+## The configuration (``/p:Configuration`` msbuild parameter) used for Release builds.
+##
+## ### DEBUG_CONFIGURATION
+## The configuration (``/p:Configuration`` msbuild parameter)
+## used for Debug builds.
+##
+## ### TARGET_PLATFORM_VERSION
+## The WindowsTargetPlatformVersion (``/p:WindowsTargetPlatformVersion`` msbuild parameter)
+##
+## ### TARGET
+## The MSBuild target to build. (``/t:<TARGET>``)
+##
+## ### PLATFORM
+## The platform (``/p:Platform`` msbuild parameter) used for the build.
+##
+## ### PLATFORM_TOOLSET
+## The platform toolset (``/p:PlatformToolset`` msbuild parameter) used for the build.
+##
+## ### OPTIONS
+## Additional options passed to msbuild for all builds.
+##
+## ### OPTIONS_RELEASE
+## Additional options passed to msbuild for Release builds. These are in addition to `OPTIONS`.
+##
+## ### OPTIONS_DEBUG
+## Additional options passed to msbuild for Debug builds. These are in addition to `OPTIONS`.
+##
+## ## Examples
+##
+## * [libimobiledevice](https://github.com/Microsoft/vcpkg/blob/master/ports/libimobiledevice/portfile.cmake)
+
+function(vcpkg_install_msbuild)
+    cmake_parse_arguments(
+        _csc
+        "USE_VCPKG_INTEGRATION;ALLOW_ROOT_INCLUDES;REMOVE_ROOT_INCLUDES"
+        "SOURCE_PATH;PROJECT_SUBPATH;INCLUDES_SUBPATH;LICENSE_SUBPATH;RELEASE_CONFIGURATION;DEBUG_CONFIGURATION;PLATFORM;PLATFORM_TOOLSET;TARGET_PLATFORM_VERSION;TARGET"
+        "OPTIONS;OPTIONS_RELEASE;OPTIONS_DEBUG"
+        ${ARGN}
+    )
+
+    if(NOT DEFINED _csc_RELEASE_CONFIGURATION)
+        set(_csc_RELEASE_CONFIGURATION Release)
+    endif()
+    if(NOT DEFINED _csc_DEBUG_CONFIGURATION)
+        set(_csc_DEBUG_CONFIGURATION Debug)
+    endif()
+    if(NOT DEFINED _csc_PLATFORM)
+        if(VCPKG_TARGET_ARCHITECTURE STREQUAL x64)
+            set(_csc_PLATFORM  x64)
+        elseif(VCPKG_TARGET_ARCHITECTURE STREQUAL x86)
+            set(_csc_PLATFORM  Win32)
+        elseif(VCPKG_TARGET_ARCHITECTURE STREQUAL ARM)
+            set(_csc_PLATFORM  ARM)
+        else()
+            message(FATAL_ERROR "Unsupported target architecture")
+        endif()
+    endif()
+    if(NOT DEFINED _csc_PLATFORM_TOOLSET)
+        set(_csc_PLATFORM_TOOLSET ${VCPKG_PLATFORM_TOOLSET})
+    endif()
+    if(NOT DEFINED _csc_TARGET_PLATFORM_VERSION)
+        vcpkg_get_windows_sdk(_csc_TARGET_PLATFORM_VERSION)
+    endif()
+    if(NOT DEFINED _csc_TARGET)
+        set(_csc_TARGET Rebuild)
+    endif()
+
+    list(APPEND _csc_OPTIONS
+        /t:${_csc_TARGET}
+        /p:Platform=${_csc_PLATFORM}
+        /p:PlatformToolset=${_csc_PLATFORM_TOOLSET}
+        /p:VCPkgLocalAppDataDisabled=true
+        /p:UseIntelMKL=No
+        /p:WindowsTargetPlatformVersion=${_csc_TARGET_PLATFORM_VERSION}
+        /m
+    )
+
+    if(VCPKG_LIBRARY_LINKAGE STREQUAL "static")
+        # Disable LTCG for static libraries because this setting introduces ABI incompatibility between minor compiler versions
+        # TODO: Add a way for the user to override this if they want to opt-in to incompatibility
+        list(APPEND _csc_OPTIONS /p:WholeProgramOptimization=false)
+    endif()
+
+    if(_csc_USE_VCPKG_INTEGRATION)
+        list(APPEND _csc_OPTIONS /p:ForceImportBeforeCppTargets=${VCPKG_ROOT_DIR}/scripts/buildsystems/msbuild/vcpkg.targets /p:VcpkgApplocalDeps=false)
+    endif()
+
+    get_filename_component(SOURCE_PATH_SUFFIX "${_csc_SOURCE_PATH}" NAME)
+    if(NOT DEFINED VCPKG_BUILD_TYPE OR VCPKG_BUILD_TYPE STREQUAL "release")
+        message(STATUS "Building ${_csc_PROJECT_SUBPATH} for Release")
+        file(REMOVE_RECURSE ${CURRENT_BUILDTREES_DIR}/${TARGET_TRIPLET}-rel)
+        file(MAKE_DIRECTORY ${CURRENT_BUILDTREES_DIR}/${TARGET_TRIPLET}-rel)
+        file(COPY ${_csc_SOURCE_PATH} DESTINATION ${CURRENT_BUILDTREES_DIR}/${TARGET_TRIPLET}-rel)
+        set(SOURCE_COPY_PATH ${CURRENT_BUILDTREES_DIR}/${TARGET_TRIPLET}-rel/${SOURCE_PATH_SUFFIX})
+        vcpkg_execute_required_process(
+            COMMAND msbuild ${SOURCE_COPY_PATH}/${_csc_PROJECT_SUBPATH}
+                /p:Configuration=${_csc_RELEASE_CONFIGURATION}
+                ${_csc_OPTIONS}
+                ${_csc_OPTIONS_RELEASE}
+            WORKING_DIRECTORY ${SOURCE_COPY_PATH}
+            LOGNAME build-${TARGET_TRIPLET}-rel
+        )
+        file(GLOB_RECURSE LIBS ${SOURCE_COPY_PATH}/*.lib)
+        file(GLOB_RECURSE DLLS ${SOURCE_COPY_PATH}/*.dll)
+        file(GLOB_RECURSE EXES ${SOURCE_COPY_PATH}/*.exe)
+        if(LIBS)
+            file(COPY ${LIBS} DESTINATION ${CURRENT_PACKAGES_DIR}/lib)
+        endif()
+        if(DLLS)
+            file(COPY ${DLLS} DESTINATION ${CURRENT_PACKAGES_DIR}/bin)
+        endif()
+        if(EXES)
+            file(COPY ${EXES} DESTINATION ${CURRENT_PACKAGES_DIR}/tools/${PORT})
+            vcpkg_copy_tool_dependencies(${CURRENT_PACKAGES_DIR}/tools/${PORT})
+        endif()
+    endif()
+
+    if(NOT DEFINED VCPKG_BUILD_TYPE OR VCPKG_BUILD_TYPE STREQUAL "debug")
+        message(STATUS "Building ${_csc_PROJECT_SUBPATH} for Debug")
+        file(REMOVE_RECURSE ${CURRENT_BUILDTREES_DIR}/${TARGET_TRIPLET}-dbg)
+        file(MAKE_DIRECTORY ${CURRENT_BUILDTREES_DIR}/${TARGET_TRIPLET}-dbg)
+        file(COPY ${_csc_SOURCE_PATH} DESTINATION ${CURRENT_BUILDTREES_DIR}/${TARGET_TRIPLET}-dbg)
+        set(SOURCE_COPY_PATH ${CURRENT_BUILDTREES_DIR}/${TARGET_TRIPLET}-dbg/${SOURCE_PATH_SUFFIX})
+        vcpkg_execute_required_process(
+            COMMAND msbuild ${SOURCE_COPY_PATH}/${_csc_PROJECT_SUBPATH}
+                /p:Configuration=${_csc_DEBUG_CONFIGURATION}
+                ${_csc_OPTIONS}
+                ${_csc_OPTIONS_DEBUG}
+            WORKING_DIRECTORY ${SOURCE_COPY_PATH}
+            LOGNAME build-${TARGET_TRIPLET}-dbg
+        )
+        file(GLOB_RECURSE LIBS ${SOURCE_COPY_PATH}/*.lib)
+        file(GLOB_RECURSE DLLS ${SOURCE_COPY_PATH}/*.dll)
+        if(LIBS)
+            file(COPY ${LIBS} DESTINATION ${CURRENT_PACKAGES_DIR}/debug/lib)
+        endif()
+        if(DLLS)
+            file(COPY ${DLLS} DESTINATION ${CURRENT_PACKAGES_DIR}/debug/bin)
+        endif()
+    endif()
+
+    vcpkg_copy_pdbs()
+
+    file(REMOVE_RECURSE
+        ${CURRENT_BUILDTREES_DIR}/${TARGET_TRIPLET}-dbg
+        ${CURRENT_BUILDTREES_DIR}/${TARGET_TRIPLET}-rel
+    )
+
+    if(DEFINED _csc_INCLUDES_SUBPATH)
+        file(COPY ${_csc_SOURCE_PATH}/${_csc_INCLUDES_SUBPATH}/ DESTINATION ${CURRENT_PACKAGES_DIR}/include/)
+        file(GLOB ROOT_INCLUDES LIST_DIRECTORIES false ${CURRENT_PACKAGES_DIR}/include/*)
+        if(ROOT_INCLUDES)
+            if(_csc_REMOVE_ROOT_INCLUDES)
+                file(REMOVE ${ROOT_INCLUDES})
+            elseif(_csc_ALLOW_ROOT_INCLUDES)
+            else()
+                message(FATAL_ERROR "Top-level files were found in ${CURRENT_PACKAGES_DIR}/include; this may indicate a problem with the call to `vcpkg_install_msbuild()`.\nTo avoid conflicts with other libraries, it is recommended to not put includes into the root `include/` directory.\nPass either ALLOW_ROOT_INCLUDES or REMOVE_ROOT_INCLUDES to handle these files.\n")
+            endif()
+        endif()
+    endif()
+
+    if(DEFINED _csc_LICENSE_SUBPATH)
+        file(INSTALL ${_csc_SOURCE_PATH}/${_csc_LICENSE_SUBPATH} DESTINATION ${CURRENT_PACKAGES_DIR}/share/${PORT} RENAME copyright)
+    endif()
+endfunction()