[cppwinrt] port rewrite to use cppwint.exe tool from NuGet Gallery #24967

walbourn · 2022-05-27T23:57:25Z

The existing cppwinrt port really does nothing beyond verifying the installed Windows SDK has pre-generated cppwinrt headers. The Windows SDK headers for C++/WinRT are old, and the recommendation is to use the Microsoft.Windows.CppWinRT NuGet instead. This package contains the latest cppwinrt.exe compiler tool that is then executed using the installed Windows SDK to generate the latest C++/WinRT projections from the Windows SDK .winmd files.

This updated port now does this as well for the installed Windows SDK headers when the port is installed.

This port is not as full-featured as the NuGet package which leverages MSBuild machinery to automatically generate projections for Xaml and authored WinRT components, but this is a big step up from what was there before.

walbourn · 2022-05-27T23:58:49Z

@BillyONeal @kennykerr Please review this as well.

walbourn · 2022-05-28T00:00:41Z

Validated the supported triplets:

vcpkg install cppwinrt:x86-windows
vcpkg install cppwinrt:x86-windows-static
vcpkg install cppwinrt:x86-windows-static-md
vcpkg install cppwinrt:x64-windows
vcpkg install cppwinrt:x64-windows-static
vcpkg install cppwinrt:x64-windows-static-md
vcpkg install cppwinrt:arm-windows
vcpkg install cppwinrt:arm64-windows
vcpkg install cppwinrt:arm64-windows-static
vcpkg install cppwinrt:arm64-windows-static-md
vcpkg install cppwinrt:x86-uwp
vcpkg install cppwinrt:x64-uwp
vcpkg install cppwinrt:arm-uwp
vcpkg install cppwinrt:arm64-uwp

ports/cppwinrt/portfile.cmake

walbourn · 2022-05-30T23:51:51Z

Note I've verified consuming the port from CMake works as expected using:

find_package(cppwinrt CONFIG REQUIRED)
target_link_libraries(<target> PRIVATE Microsoft::CppWinRT)

This results in

(a) the generated C++/WinRT headers are in the INCLUDE path before the Windows SDK
(b) the target links against cppwinrt_fast_forwarder.lib
(c) the target uses C++17 or later

ras0219-msft

Thanks for the PR!

ras0219-msft · 2022-06-02T18:31:33Z

ports/cppwinrt/CMakeLists.txt.in

+  PATHS "${CMAKE_CURRENT_SOURCE_DIR}/build/native/lib/${CPPWINRT_ARCH}"
+  REQUIRED NO_DEFAULT_PATH)
+
+#--- Find Windows SDK Version


Instead of searching for a windows sdk, the build should:

Require ENV{WindowsSDKDir} and ENV{WindowsSDKVersion to be set (if not, fail)

Require Windows.Foundation.FoundationContract to exist (if not, fail)

Simplified logic since in most cases it's already finding it from CMAKE_SYSTEM_VERSION.

I tried this approach and it works locally, but fails in the ADO pipelines. I've restored the scanning SDK versions fallback for cases where it isn't able to rely on the envvars.

ports/cppwinrt/CMakeLists.txt.in

ports/cppwinrt/CppWinRT-config.cmake.in

ports/cppwinrt/portfile.cmake

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

github-actions

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

error: checked-in files for cppwinrt have changed but the version was not updated
version: 2.0.220418.1
old SHA: da4c6dd987474ee70f7d28715d791d5fa625264b
new SHA: f0b448081be6fba10e25084686a490cbd800cac6
Did you remember to update the version or port version?
Use --overwrite-version to bypass this check
***No files were updated***

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

github-actions

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

error: checked-in files for cppwinrt have changed but the version was not updated
version: 2.0.220418.1
old SHA: da4c6dd987474ee70f7d28715d791d5fa625264b
new SHA: 92c49ba0383df451fc8468c02552b5f2fd30aeac
Did you remember to update the version or port version?
Use --overwrite-version to bypass this check
***No files were updated***

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

github-actions

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

error: checked-in files for cppwinrt have changed but the version was not updated
version: 2.0.220418.1
old SHA: da4c6dd987474ee70f7d28715d791d5fa625264b
new SHA: 461c350a7afd51f12570934c778fed578e360b29
Did you remember to update the version or port version?
Use --overwrite-version to bypass this check
***No files were updated***

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

github-actions

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

error: checked-in files for cppwinrt have changed but the version was not updated
version: 2.0.220418.1
old SHA: da4c6dd987474ee70f7d28715d791d5fa625264b
new SHA: a5a9985a4ad486f761568067b38aec6419d82b2c
Did you remember to update the version or port version?
Use --overwrite-version to bypass this check
***No files were updated***

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

github-actions

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

error: checked-in files for cppwinrt have changed but the version was not updated
version: 2.0.220418.1
old SHA: da4c6dd987474ee70f7d28715d791d5fa625264b
new SHA: de946a53fc6995484d31e8d3968e0348a9f1bd88
Did you remember to update the version or port version?
Use --overwrite-version to bypass this check
***No files were updated***

github-actions

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

error: checked-in files for cppwinrt have changed but the version was not updated
version: 2.0.220418.1
old SHA: da4c6dd987474ee70f7d28715d791d5fa625264b
new SHA: dd1a129028ac288130d7fef3a4de8edfe9dd3622
Did you remember to update the version or port version?
Use --overwrite-version to bypass this check
***No files were updated***

github-actions

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

error: checked-in files for cppwinrt have changed but the version was not updated
version: 2.0.220418.1
old SHA: ff0b0e37642ae2f1798430f20ce763264e477b85
new SHA: 2332b10338616af4bd8ac79a8d5f8787dafe99a8
Did you remember to update the version or port version?
Use --overwrite-version to bypass this check
***No files were updated***

walbourn · 2022-06-03T07:08:30Z

After all code review, revalidated supported triplets and checked consuming of this port.

vcpkg install cppwinrt:x86-windows
vcpkg install cppwinrt:x86-windows-static
vcpkg install cppwinrt:x86-windows-static-md
vcpkg install cppwinrt:x64-windows
vcpkg install cppwinrt:x64-windows-static
vcpkg install cppwinrt:x64-windows-static-md
vcpkg install cppwinrt:arm-windows
vcpkg install cppwinrt:arm64-windows
vcpkg install cppwinrt:arm64-windows-static
vcpkg install cppwinrt:arm64-windows-static-md
vcpkg install cppwinrt:x86-uwp
vcpkg install cppwinrt:x64-uwp
vcpkg install cppwinrt:arm-uwp
vcpkg install cppwinrt:arm64-uwp

ras0219-msft · 2022-06-04T02:49:07Z

As I was looking into why the Windows SDK env vars wouldn't work, I noticed a bunch of other little things that could be touched up:

The CMake build was entirely unnecessary -- it's just running the header generator and doesn't need a compiler at all!
The examples online indicate that the headers should be included via #include <winrt/...> -- this means we want them at include/winrt/... instead of include/cppwinrt/winrt/....
I have switched to enumerating the Windows SDK contents in the CMake instead of the cppwinrt tool -- this avoids touching the registry and so opens the possibility for consuming arbitrary copies of the WinSDK instead of requiring the installer.

I'd appreciate it if you could double check the change I pushed and ensure it still works for you as well, if it does this LGTM. Thanks again!

walbourn · 2022-06-04T04:37:27Z

@ras0219-msft

The examples online indicate that the headers should be included via #include <winrt/...> -- this means we want them at include/winrt/... instead of include/cppwinrt/winrt/....

The reason I had it install to include/cppwinrt/winrt and set the include path to include/cppwinrt was so that:

(a) You can still use #include <winrt/ to get the headers
(b) You would not get the updated cppwinrt headers if you had the vcpkg port installed to your vcpkg instance, used some other port that pointed to include, but had NOT added the specific CppWinRT target to your project.

If that isn't a concern, then this is fine.

ports/cppwinrt/vcpkg.json

Co-authored-by: LilyWangLL <94091114+LilyWangLL@users.noreply.github.com>

github-actions

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

error: checked-in files for cppwinrt have changed but the version was not updated
version: 2.0.220418.1
old SHA: d4e517abedddb8d20362bc9cbae6716ecf3a7f62
new SHA: 18d6860cc0a36639fe348d27ab4cb763dfc0e879
Did you remember to update the version or port version?
Use --overwrite-version to bypass this check
***No files were updated***

ras0219-msft · 2022-06-06T20:00:07Z

LGTM, thanks!

walbourn added 3 commits May 27, 2022 16:49

[cppwinrt] rewrote port to leverage cppwinrt.exe tool from nuget.org

f8be791

Reformat

c72ca5a

Update baseline

d91cfad

github-actions bot approved these changes May 27, 2022

View reviewed changes

walbourn mentioned this pull request May 27, 2022

[cppwinrt] update to 2.0.220131.2 #23249

Closed

walbourn commented May 28, 2022

View reviewed changes

ports/cppwinrt/portfile.cmake Show resolved Hide resolved

walbourn mentioned this pull request May 28, 2022

VCPKG should have a variable to indicate if the HOST supports x64 native executables #24966

Closed

FrankXie05 assigned LilyWangLL May 30, 2022

LilyWangLL added the category:port-update The issue is with a library, which is requesting update new revision label May 30, 2022

LilyWangLL approved these changes May 30, 2022

View reviewed changes

LilyWangLL requested a review from BillyONeal May 30, 2022 06:34

LilyWangLL added the info:reviewed Pull Request changes follow basic guidelines label Jun 2, 2022

ras0219-msft requested changes Jun 2, 2022

View reviewed changes

ras0219-msft added the requires:author-response label Jun 2, 2022

Update ports/cppwinrt/portfile.cmake

ff9fe89

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

github-actions bot requested changes Jun 2, 2022

View reviewed changes

Update ports/cppwinrt/CMakeLists.txt.in

70b7c83

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

github-actions bot requested changes Jun 2, 2022

View reviewed changes

Update ports/cppwinrt/portfile.cmake

ecbd345

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

github-actions bot requested changes Jun 2, 2022

View reviewed changes

walbourn and others added 3 commits June 2, 2022 16:04

Update ports/cppwinrt/portfile.cmake

ab78e5e

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

Update ports/cppwinrt/CMakeLists.txt.in

795ff21

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

Update ports/cppwinrt/CMakeLists.txt.in

c05f2e3

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

github-actions bot requested changes Jun 2, 2022

View reviewed changes

Update ports/cppwinrt/CppWinRT-config.cmake.in

3def581

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

github-actions bot requested changes Jun 2, 2022

View reviewed changes

Fix build break

f3b8539

github-actions bot requested changes Jun 3, 2022

View reviewed changes

Update baseline

ca084a1

github-actions bot approved these changes Jun 3, 2022

View reviewed changes

walbourn added 2 commits June 2, 2022 20:29

Still need SDK version scanning fallback for ADO pipelines

15761c7

Refresh baseline

1e0b42c

github-actions bot approved these changes Jun 3, 2022

View reviewed changes

walbourn added 2 commits June 3, 2022 00:06

Additional code review

5fc61e0

Update baseline

4af8e7c

github-actions bot approved these changes Jun 3, 2022

View reviewed changes

walbourn added 2 commits June 3, 2022 00:19

Don't need a config-version file for a VCPKG only CMake

1ef408a

Baseline update

eac884f

github-actions bot approved these changes Jun 3, 2022

View reviewed changes

[cppwinrt] Simplify port

11e5262

github-actions bot approved these changes Jun 4, 2022

View reviewed changes

ras0219-msft approved these changes Jun 4, 2022

View reviewed changes

LilyWangLL requested changes Jun 6, 2022

View reviewed changes

ports/cppwinrt/vcpkg.json Outdated Show resolved Hide resolved

Update ports/cppwinrt/vcpkg.json

3d528c3

Co-authored-by: LilyWangLL <94091114+LilyWangLL@users.noreply.github.com>

github-actions bot requested changes Jun 6, 2022

View reviewed changes

Update baseline

52db78b

github-actions bot approved these changes Jun 6, 2022

View reviewed changes

LilyWangLL removed the requires:author-response label Jun 6, 2022

LilyWangLL approved these changes Jun 6, 2022

View reviewed changes

ras0219-msft merged commit 904a51f into microsoft:master Jun 6, 2022

walbourn deleted the cppwinrtportrewrite branch June 6, 2022 20:10

FrankXie05 mentioned this pull request Dec 30, 2022

[cppwinrt] update to 2.0.221121.5 #28635

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[cppwinrt] port rewrite to use cppwint.exe tool from NuGet Gallery #24967

[cppwinrt] port rewrite to use cppwint.exe tool from NuGet Gallery #24967

walbourn commented May 27, 2022 •

edited

Loading

walbourn commented May 27, 2022

walbourn commented May 28, 2022 •

edited

Loading

walbourn commented May 30, 2022 •

edited

Loading

ras0219-msft left a comment

ras0219-msft Jun 2, 2022

walbourn Jun 2, 2022

walbourn Jun 3, 2022

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

walbourn commented Jun 3, 2022

ras0219-msft commented Jun 4, 2022 •

edited

Loading

walbourn commented Jun 4, 2022 •

edited

Loading

github-actions bot left a comment

ras0219-msft commented Jun 6, 2022

[cppwinrt] port rewrite to use cppwint.exe tool from NuGet Gallery #24967

[cppwinrt] port rewrite to use cppwint.exe tool from NuGet Gallery #24967

Conversation

walbourn commented May 27, 2022 • edited Loading

walbourn commented May 27, 2022

walbourn commented May 28, 2022 • edited Loading

walbourn commented May 30, 2022 • edited Loading

ras0219-msft left a comment

Choose a reason for hiding this comment

ras0219-msft Jun 2, 2022

Choose a reason for hiding this comment

walbourn Jun 2, 2022

Choose a reason for hiding this comment

walbourn Jun 3, 2022

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

walbourn commented Jun 3, 2022

ras0219-msft commented Jun 4, 2022 • edited Loading

walbourn commented Jun 4, 2022 • edited Loading

github-actions bot left a comment

Choose a reason for hiding this comment

ras0219-msft commented Jun 6, 2022

walbourn commented May 27, 2022 •

edited

Loading

walbourn commented May 28, 2022 •

edited

Loading

walbourn commented May 30, 2022 •

edited

Loading

ras0219-msft commented Jun 4, 2022 •

edited

Loading

walbourn commented Jun 4, 2022 •

edited

Loading