[vcpkg-fixup-cmake-targets] Rewrite the traversal code with `-framework NAME` on OSX by JackBoosY · Pull Request #19629 · microsoft/vcpkg

JackBoosY · 2021-08-18T07:39:36Z

vcpkg/scripts/cmake/vcpkg_fixup_cmake_targets.cmake

Lines 230 to 232 in ab60f27

    
                       file(READ "${targets_file}" targets_content) 
        
                       string(REGEX MATCHALL "INTERFACE_LINK_LIBRARIES[^\n]*\n" library_contents "${targets_content}") 
        
                       foreach(line IN LISTS library_contents)

Because foreach (IN LISTS) separates each item according to a space, it incorrectly replaces the contents of non-INTERFACE_LINK_LIBRARIES. Such as:

set_target_properties(VTK::opengl PROPERTIES
  INTERFACE_COMPILE_DEFINITIONS "GL_SILENCE_DEPRECATION"
  INTERFACE_INCLUDE_DIRECTORIES "-framework OpenGL"
  INTERFACE_LINK_LIBRARIES "-framework OpenGL;-framework OpenGL"
  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "-framework OpenGL"
)

Fix that.

Now, this will fix

set_target_properties(VTK::opengl PROPERTIES
  INTERFACE_COMPILE_DEFINITIONS "GL_SILENCE_DEPRECATION"
  INTERFACE_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"
  INTERFACE_LINK_LIBRARIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework;/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"
  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"
)

to

set_target_properties(VTK::opengl PROPERTIES
  INTERFACE_COMPILE_DEFINITIONS "GL_SILENCE_DEPRECATION"
  INTERFACE_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"
  INTERFACE_LINK_LIBRARIES "-framework OpenGL;-framework OpenGL"
  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"
)

…amework NAME`on OSX

JackBoosY · 2021-08-18T07:42:48Z

cc @strega-nil-ms for review this PR.

github-actions

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

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 6b24f0fa76d171c5756f01f407682f7274cfe238 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/baseline.json b/versions/baseline.json
index 2855173..11f44b1 100644
--- a/versions/baseline.json
+++ b/versions/baseline.json
@@ -6617,7 +6617,7 @@
       "port-version": 0
     },
     "vcpkg-cmake-config": {
-      "baseline": "2021-08-11",
+      "baseline": "2021-08-18",
       "port-version": 0
     },
     "vcpkg-gfortran": {
diff --git a/versions/v-/vcpkg-cmake-config.json b/versions/v-/vcpkg-cmake-config.json
index affac6b..5ffdb7e 100644
--- a/versions/v-/vcpkg-cmake-config.json
+++ b/versions/v-/vcpkg-cmake-config.json
@@ -1,5 +1,10 @@
 {
   "versions": [
+    {
+      "git-tree": "dd7d67c81c2442c831a298d136b019a2bd138565",
+      "version-date": "2021-08-18",
+      "port-version": 0
+    },
     {
       "git-tree": "b3abb12ba8ab43770aea4e5a8d4915319bd295ee",
       "version-date": "2021-08-11",

ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.cmake

scripts/cmake/vcpkg_fixup_cmake_targets.cmake

github-actions

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

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 6b24f0fa76d171c5756f01f407682f7274cfe238 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/v-/vcpkg-cmake-config.json b/versions/v-/vcpkg-cmake-config.json
index 5ffdb7e..26dfa00 100644
--- a/versions/v-/vcpkg-cmake-config.json
+++ b/versions/v-/vcpkg-cmake-config.json
@@ -1,7 +1,7 @@
 {
   "versions": [
     {
-      "git-tree": "dd7d67c81c2442c831a298d136b019a2bd138565",
+      "git-tree": "0a1806a80ccf0f85fd4f79c5f2780adc4d92d78e",
       "version-date": "2021-08-18",
       "port-version": 0
     },

github-actions

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

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 6b24f0fa76d171c5756f01f407682f7274cfe238 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/v-/vcpkg-cmake-config.json b/versions/v-/vcpkg-cmake-config.json
index 5ffdb7e..26dfa00 100644
--- a/versions/v-/vcpkg-cmake-config.json
+++ b/versions/v-/vcpkg-cmake-config.json
@@ -1,7 +1,7 @@
 {
   "versions": [
     {
-      "git-tree": "dd7d67c81c2442c831a298d136b019a2bd138565",
+      "git-tree": "0a1806a80ccf0f85fd4f79c5f2780adc4d92d78e",
       "version-date": "2021-08-18",
       "port-version": 0
     },

Neumann-A · 2021-08-18T08:05:31Z

So this is what broke paraview

dg0yt · 2021-08-18T08:15:35Z

target_link_libraries(main PRIVATE -framework OpenGL)

How about

target_link_libraries(main PRIVATE OpenGL.framework)

instead of evil spaces?

scripts/cmake/vcpkg_fixup_cmake_targets.cmake

ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.cmake

github-actions

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

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 6b24f0fa76d171c5756f01f407682f7274cfe238 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/v-/vcpkg-cmake-config.json b/versions/v-/vcpkg-cmake-config.json
index 5ffdb7e..fc78074 100644
--- a/versions/v-/vcpkg-cmake-config.json
+++ b/versions/v-/vcpkg-cmake-config.json
@@ -1,7 +1,7 @@
 {
   "versions": [
     {
-      "git-tree": "dd7d67c81c2442c831a298d136b019a2bd138565",
+      "git-tree": "9f58eaa512e112b8a91d276b92a4dcbc52eef2ba",
       "version-date": "2021-08-18",
       "port-version": 0
     },

github-actions

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

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 6b24f0fa76d171c5756f01f407682f7274cfe238 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/v-/vcpkg-cmake-config.json b/versions/v-/vcpkg-cmake-config.json
index 5ffdb7e..26dfa00 100644
--- a/versions/v-/vcpkg-cmake-config.json
+++ b/versions/v-/vcpkg-cmake-config.json
@@ -1,7 +1,7 @@
 {
   "versions": [
     {
-      "git-tree": "dd7d67c81c2442c831a298d136b019a2bd138565",
+      "git-tree": "0a1806a80ccf0f85fd4f79c5f2780adc4d92d78e",
       "version-date": "2021-08-18",
       "port-version": 0
     },

github-actions

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

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 6b24f0fa76d171c5756f01f407682f7274cfe238 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/v-/vcpkg-cmake-config.json b/versions/v-/vcpkg-cmake-config.json
index 5ffdb7e..783aaa1 100644
--- a/versions/v-/vcpkg-cmake-config.json
+++ b/versions/v-/vcpkg-cmake-config.json
@@ -1,7 +1,7 @@
 {
   "versions": [
     {
-      "git-tree": "dd7d67c81c2442c831a298d136b019a2bd138565",
+      "git-tree": "d4b5ea86aea3416a957fbe2384610feb6106f730",
       "version-date": "2021-08-18",
       "port-version": 0
     },

JackBoosY · 2021-08-20T07:35:15Z

versions/v-/vcpkg-cmake-config.json

 {
  "versions": [
+    {
+      "git-tree": "dd7d67c81c2442c831a298d136b019a2bd138565",


Suggested change

"git-tree": "dd7d67c81c2442c831a298d136b019a2bd138565",

"git-tree": "d4b5ea86aea3416a957fbe2384610feb6106f730",

Neumann-A · 2021-08-20T17:40:03Z

INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"

Isn't there some kind of env variable the full path could be replaced with ? Because this changes doesn't change the fact that there are still full paths in the configs.

dg0yt · 2021-08-20T17:58:20Z

INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"

Isn't there some kind of env variable the full path could be replaced with ? Because this changes doesn't change the fact that there are still full paths in the configs.

There is existing code that removes the path part for link libraries if it is in CMAKE_CXX_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES

vcpkg/scripts/cmake/vcpkg_fixup_cmake_targets.cmake

Line 250 in ab60f27

    
                               list(FIND VCPKG_DETECTED_CMAKE_CXX_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES "${path}" index)

Should this be applied to include directories, too?

JackBoosY · 2021-08-23T01:57:55Z

INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"

Isn't there some kind of env variable the full path could be replaced with ? Because this changes doesn't change the fact that there are still full paths in the configs.

I wish too, but I didn't find that.

github-actions

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

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 025e564979cc01d0fbc5c920aa8a36635efb01bb -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/v-/vcpkg-cmake-config.json b/versions/v-/vcpkg-cmake-config.json
index 042a2dc..ed1308b 100644
--- a/versions/v-/vcpkg-cmake-config.json
+++ b/versions/v-/vcpkg-cmake-config.json
@@ -1,15 +1,10 @@
 {
   "versions": [
     {
-      "git-tree": "dd7d67c81c2442c831a298d136b019a2bd138565",
+      "git-tree": "fddc25466db06c2b22135793bce00f8c482a338c",
       "version-date": "2021-08-18",
       "port-version": 0
     },
-    {
-      "git-tree": "b3abb12ba8ab43770aea4e5a8d4915319bd295ee",
-      "version-date": "2021-08-11",
-      "port-version": 0
-    },
     {
       "git-tree": "330cc51bc99c6b71ed5fb51901f6f838684015a5",
       "version-date": "2021-05-22",

JackBoosY · 2021-08-23T06:50:50Z

INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"

Isn't there some kind of env variable the full path could be replaced with ? Because this changes doesn't change the fact that there are still full paths in the configs.

There is existing code that removes the path part for link libraries if it is in CMAKE_CXX_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES

vcpkg/scripts/cmake/vcpkg_fixup_cmake_targets.cmake

Line 250 in ab60f27

list(FIND VCPKG_DETECTED_CMAKE_CXX_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES "${path}" index)

Should this be applied to include directories, too?

No, the original error was caused by changing the value of *_INCLUDE_DIRECTORIES to -framework VALUE.

dg0yt · 2021-08-23T07:28:36Z

No, the original error was caused by changing the value of *_INCLUDE_DIRECTORIES to -framework VALUE.

Sure.

I am concerned that INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework" contains an absolute path from the port build environment, and it might limit the usability of the binary cache items if the consuming environment uses another path for the SDK.

cenit · 2021-08-23T09:56:56Z

i agree with @dg0yt and @Neumann-A

this is a half-backed fix, because there are still absolute paths. Why fixing only some? We still have the problems of having absolute paths in the configs! Better to fix none in the end, instead of a half-solution?

so to say: what is this PR fixing, in the end?

JackBoosY · 2021-08-24T00:14:16Z

@cenit See #16259, the origin PR wants to replace those absolute system paths in cmake files.

cenit · 2021-08-24T06:49:33Z

@cenit See #16259, the origin PR wants to replace those absolute system paths in cmake files.

yeah I know.
But why leaving absolute paths in INTERFACE_INCLUDE_DIRECTORIES and INTERFACE_SYSTEM_INCLUDE_DIRECTORIES ? Since you added -framework properly, those lines might even be removed if they do not contain any additional library.
Leaving them with an absolute path is just asking for troubles in future (portability and binary cache are definitely broken with those absolute paths left behind)!

dg0yt · 2021-08-24T07:36:00Z

We know how to the substitution now, and we know the ports to look at for verification. Do it right and completely.
(We might immediately add a hard check which just blindly searches for known build system path strings in ...config.cmake files, .pc files and ...-config scripts.)

JackBoosY · 2021-08-24T09:07:25Z

@dg0yt But we don't know which expression should be replaced.

Neumann-A · 2021-08-24T09:29:36Z

@JackBoosY:

(/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/[^;"]+) ? + maybe a ;; and ;" replacement

cenit · 2021-08-24T10:16:44Z

@dg0yt But we don't know which expression should be replaced.

nothing, it's not necessary if you have a proper "-framework VALUE" in the interface_link_library slot.
You can remove them from INTERFACE_INCLUDE_DIRECTORIES and INTERFACE_SYSTEM_INCLUDE_DIRECTORIES and it should work, without having to fix them! Did you try this way?

cenit · 2021-08-24T10:17:49Z

Of course, before removing everything from those fields, you have to be sure there are not other libraries, which are not part of the "fixed" frameworks included in the fixed "interface_link_libraries" line ;)

cenit · 2021-08-24T10:19:31Z

so to say

set_target_properties(VTK::opengl PROPERTIES
  INTERFACE_COMPILE_DEFINITIONS "GL_SILENCE_DEPRECATION"
  INTERFACE_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"
  INTERFACE_LINK_LIBRARIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework;/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"
  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "/Library/Developer/CommandLineTools/SDKs/MacOSX11.3.sdk/System/Library/Frameworks/OpenGL.framework"
)

should become

set_target_properties(VTK::opengl PROPERTIES
  INTERFACE_COMPILE_DEFINITIONS "GL_SILENCE_DEPRECATION"
  INTERFACE_LINK_LIBRARIES "-framework OpenGL"
)

JackBoosY · 2021-11-23T07:35:11Z

Temporary close this issue because I have no good idea about that.

cenit · 2021-11-23T13:17:47Z

@autoantwort how did you manage this issue in your “remove absolute paths” heroic effort?

autoantwort · 2021-11-23T17:04:43Z

The absolute path check only checks for absolute paths to the package and the installed dir paths.

[vcpkg baseline][vcpkg-fixup-cmake-targets] Add double quotes to `-fr…

3354458

…amework NAME`on OSX

JackBoosY added info:internal category:tool-update The issue is with build tool or build script, which requires update or should be executed correctly labels Aug 18, 2021

JackBoosY requested a review from strega-nil-ms August 18, 2021 07:39

JackBoosY assigned PhoebeHui Aug 18, 2021

JackBoosY changed the title ~~[vcpkg baseline][vcpkg-fixup-cmake-targets] Add double quotes to `-fr…~~ [vcpkg baseline][vcpkg-fixup-cmake-targets] Add double quotes to -framework NAMEon OSX Aug 18, 2021

JackBoosY changed the title ~~[vcpkg baseline][vcpkg-fixup-cmake-targets] Add double quotes to -framework NAMEon OSX~~ [vcpkg baseline][vcpkg-fixup-cmake-targets] Add double quotes to -framework NAME on OSX Aug 18, 2021

github-actions bot requested changes Aug 18, 2021

View reviewed changes

version

f8a4530

github-actions bot approved these changes Aug 18, 2021

View reviewed changes

JackBoosY commented Aug 18, 2021

View reviewed changes

ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.cmake Outdated Show resolved Hide resolved

scripts/cmake/vcpkg_fixup_cmake_targets.cmake Outdated Show resolved Hide resolved

JackBoosY added 2 commits August 18, 2021 15:58

Update ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.cmake

d4fbc48

Update scripts/cmake/vcpkg_fixup_cmake_targets.cmake

27f7ee8

github-actions bot requested changes Aug 18, 2021

View reviewed changes

JackBoosY commented Aug 18, 2021

View reviewed changes

scripts/cmake/vcpkg_fixup_cmake_targets.cmake Outdated Show resolved Hide resolved

ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.cmake Outdated Show resolved Hide resolved

JackBoosY added 2 commits August 18, 2021 16:22

Update scripts/cmake/vcpkg_fixup_cmake_targets.cmake

abbb4cd

Update ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.cmake

fd228ab

github-actions bot requested changes Aug 18, 2021

View reviewed changes

JackBoosY changed the title ~~[vcpkg baseline][vcpkg-fixup-cmake-targets] Add double quotes to -framework NAME on OSX~~ [vcpkg baseline][vcpkg-fixup-cmake-targets] Change the replace string with -framework NAME on OSX Aug 18, 2021

Fix the order issue

a9bd069

github-actions bot requested changes Aug 20, 2021

View reviewed changes

JackBoosY marked this pull request as ready for review August 20, 2021 07:15

JackBoosY commented Aug 20, 2021

View reviewed changes

JackBoosY added the requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. label Aug 20, 2021

Merge branch 'master' into dev/jack/fix-vcpkg-fixup-cmake-targets

1b9c073

github-actions bot requested changes Aug 23, 2021

View reviewed changes

JackBoosY changed the title ~~[vcpkg baseline][vcpkg-fixup-cmake-targets] Rewrite the traversal code with -framework NAME on OSX~~ [vcpkg-fixup-cmake-targets] Rewrite the traversal code with -framework NAME on OSX Aug 24, 2021

PhoebeHui marked this pull request as draft August 26, 2021 06:10

PhoebeHui removed the requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. label Sep 14, 2021

JackBoosY mentioned this pull request Oct 8, 2021

[libopensp] new port #20391

Merged

1 task

JackBoosY closed this Nov 23, 2021

dg0yt mentioned this pull request May 9, 2022

[crashpad] Support more targets and cross-compile for Android #23827

Closed

	file(READ "${targets_file}" targets_content)
	string(REGEX MATCHALL "INTERFACE_LINK_LIBRARIES[^\n]*\n" library_contents "${targets_content}")
	foreach(line IN LISTS library_contents)

	"git-tree": "dd7d67c81c2442c831a298d136b019a2bd138565",
	"git-tree": "d4b5ea86aea3416a957fbe2384610feb6106f730",

Conversation

JackBoosY commented Aug 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JackBoosY commented Aug 18, 2021

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Neumann-A commented Aug 18, 2021

Uh oh!

dg0yt commented Aug 18, 2021

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

JackBoosY Aug 20, 2021

Choose a reason for hiding this comment

Uh oh!

Neumann-A commented Aug 20, 2021

Uh oh!

dg0yt commented Aug 20, 2021

Uh oh!

JackBoosY commented Aug 23, 2021

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

JackBoosY commented Aug 23, 2021

Uh oh!

dg0yt commented Aug 23, 2021

Uh oh!

cenit commented Aug 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JackBoosY commented Aug 24, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cenit commented Aug 24, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dg0yt commented Aug 24, 2021

Uh oh!

JackBoosY commented Aug 24, 2021

Uh oh!

Neumann-A commented Aug 24, 2021

Uh oh!

cenit commented Aug 24, 2021

Uh oh!

cenit commented Aug 24, 2021

Uh oh!

cenit commented Aug 24, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JackBoosY commented Nov 23, 2021

Uh oh!

cenit commented Nov 23, 2021

Uh oh!

autoantwort commented Nov 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

JackBoosY commented Aug 18, 2021 •

edited

Loading

cenit commented Aug 23, 2021 •

edited

Loading

JackBoosY commented Aug 24, 2021 •

edited

Loading

cenit commented Aug 24, 2021 •

edited

Loading

cenit commented Aug 24, 2021 •

edited

Loading