-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
build: Xcode accomodating CMake setup #1688
Merged
Merged
Conversation
This file contains 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
Closing to test github contributor status |
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #1688 +/- ##
======================================
Coverage 1.51% 1.51%
======================================
Files 275 275
Lines 27006 27006
Branches 14473 14473
======================================
Hits 409 409
Misses 26339 26339
Partials 258 258 ☔ View full report in Codecov by Sentry. |
WerWolv
reviewed
May 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 description
This PR implements some rudimentary Xcode support for building and editing ImHex.
Implementation description
Problem 1: Xcode is a multi-configuration buildsystem
The project is already rather CMake generator independent, thus it did not need to change much to support Xcode's multi-configuration paradigm:
By default, CMake generates a
.xcodeproj
in which targets build their artifacts into the specified<>_OUTPUT_DIRECTORY
, postfixed by the currently active configuration. To better fit the existing paradigm, I instead opted ot introduceIMHEX_MAIN_OUTPUT_DIRECTORY
. This variable is equal to the previously usedRUNTIME_OUTPUT_DIRECTORY
when using other generators, and is changed to include a configuration specific prefix when used with Xcode.The result is different output directories when using Xcode, and no changes when using any other generator.
Problem 2: ImHex does not support AppleClang
To allow building the codebase with Xcode, I have introduced
IMHEX_IDE_HELPERS_OVERRIDE_XCODE_COMPILER
. Specifying this option toON
will force CMake to honor the user specified compiler settings, even when using the Xcode generator.In practice this can be used together with the new "xcode" CMakePreset to build the project with mainline clang using
xcodebuild
, or Xcode itself by generating a buildsystem like so:This solution is of course not without flaws. The inner workings are a particularly ugly hack, and mainline clang does not implement the necessary extensions to allow Xcode to index the code. Regardless this option is useful to enable future work in terms of bundling/signing macOS applications in the "intended" way using Xcode without additional source modifications.
Problem 3: Vanilla CMake + Xcode = Bad developer UX
By default, the CMake generated
.xcodeproj
is a mess. Tons of targets are scattered about, and source files are not organized beyond grouping them into a "Source Files" and "Header Files" group.Even "Header Files" is missing, because the ImHex build system does not regard private header files of libraries as sources of a target, and Xcode does not try to guess this information.
The solution is twofold:
IMHEX_IDE_HELPERS_INTRUSIVE_IDE_TWEAKS
which automatically creates source file trees in Xcode targets, and discovers the non-declared header files via the folder convention.Screenshots
N/A
Additional things
As a bonus:
IMHEX_OFFLINE_BUILD
assumes that ImHex-Patterns is cloned into the source tree. I have added an additional fallback that tries to locate it as a sibling folder of${CMAKE_SOURCE_DIR}
, as this meshes better with my filesystem setup.The setup was tested with
CMake 3.29.2
,Xcode 15.2
, andllvm@17
from homebrew.