fix: include all public headers unconditionally in umbrella header#595
Open
mikefullerton wants to merge 1 commit intogoogle:mainfrom
Open
fix: include all public headers unconditionally in umbrella header#595mikefullerton wants to merge 1 commit intogoogle:mainfrom
mikefullerton wants to merge 1 commit intogoogle:mainfrom
Conversation
GIDAppCheckError.h and GIDSignInButton.h were conditionally imported in the umbrella header (GoogleSignIn.h) but declared unconditionally in the module map. This caused "umbrella header does not include header" warnings during Xcode's precompiled module generation. Both headers already have their own internal #if TARGET_OS guards, so importing them unconditionally in the umbrella header is safe — they compile to empty on unsupported platforms.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Author
|
I signed the CLA agreement |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
GIDAppCheckError.handGIDSignInButton.hare conditionally imported in the umbrella header (GoogleSignIn.h) using#if TARGET_OS_IOSguards, but the module map declares them unconditionally. This produces warnings during Xcode's precompiled module generation:This affects every project that uses GoogleSignIn via SPM on macOS.
Fix
Remove the
#if TARGET_OSguard around the imports inGoogleSignIn.h. Both headers already have their own internal platform guards:GIDAppCheckError.h:#if TARGET_OS_IOS && !TARGET_OS_MACCATALYSTGIDSignInButton.h:#if TARGET_OS_IOS || TARGET_OS_MACCATALYSTSo importing them unconditionally in the umbrella header is safe — they compile to empty on unsupported platforms.
Testing