Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Fix for creating a fat framework using lipo in Xcode 10.2
#!/bin/sh
if [ -z "$XCODE_VERSION_CORRECT" ]
then
export SUDO_ASKPASS="${PROJECT_DIR}/../scripts/askpass.sh"
fi
UNIVERSAL_OUTPUTFOLDER=${BUILD_DIR}/${CONFIGURATION}-universal
# make sure the output directory exists
mkdir -p "${UNIVERSAL_OUTPUTFOLDER}"
# Step 1. Build Device and Simulator versions
# add BITCODE_GENERATION_MODE=bitcode to support bitcode
echo "Building for devices"
xcodebuild -target "${PROJECT_NAME}" -configuration ${CONFIGURATION} -sdk iphoneos ONLY_ACTIVE_ARCH=NO BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}" clean build
# add BITCODE_GENERATION_MODE=marker to support bitcode
echo "Building for simulators"
xcodebuild -target "${PROJECT_NAME}" -configuration ${CONFIGURATION} -sdk iphonesimulator ONLY_ACTIVE_ARCH=NO BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}" clean build
# Step 2. Copy the framework structure (from iphoneos build) to the universal folder
echo "Copying framework structure"
cp -R "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework" "${UNIVERSAL_OUTPUTFOLDER}/"
# Step 3. Copy Swift modules from iphonesimulator build (if it exists) to the copied framework directory
echo "Copying simulator Swift modules"
SIMULATOR_SWIFT_MODULES_DIR="${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/Modules/${PROJECT_NAME}.swiftmodule/."
if [ -d "${SIMULATOR_SWIFT_MODULES_DIR}" ]; then
cp -R "${SIMULATOR_SWIFT_MODULES_DIR}" "${UNIVERSAL_OUTPUTFOLDER}/${PROJECT_NAME}.framework/Modules/${PROJECT_NAME}.swiftmodule"
fi
# Step 4. Create new combined simulator and device swift header file
COMBINED_PATH="${BUILD_DIR}/iOS + iOS Simulator/${PROJECT_NAME}-Swift.h"
mkdir -p "${BUILD_DIR}/iOS + iOS Simulator/"
touch "${COMBINED_PATH}"
echo "#if TARGET_OS_SIMULATOR" >> "${COMBINED_PATH}"
cat "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/Headers/${PROJECT_NAME}-Swift.h" >> "${COMBINED_PATH}"
echo "#else" >> "${COMBINED_PATH}"
echo "//Start of iphoneos" >> "${COMBINED_PATH}"
cat "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework/Headers/${PROJECT_NAME}-Swift.h" >> "${COMBINED_PATH}"
echo "#endif" >> "${COMBINED_PATH}"
# Step 5. Create universal binary file using lipo and place the combined executable in the copied framework directory
echo "Creating universal binary using lipo"
lipo -create -output "${UNIVERSAL_OUTPUTFOLDER}/${PROJECT_NAME}.framework/${PROJECT_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/${PROJECT_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework/${PROJECT_NAME}"
# Step 6. Overwrite generated -Swift.h file with combined -Swift.h file -- Kknown Issue with XCode 10.2 https://developer.apple.com/documentation/xcode_release_notes/xcode_10_2_release_notes#3141454
cat "$COMBINED_PATH" > "${UNIVERSAL_OUTPUTFOLDER}/${PROJECT_NAME}.framework/Headers/${PROJECT_NAME}-Swift.h"
# Step 7. Convenience step to copy the framework to the project's directory
cp -R "${UNIVERSAL_OUTPUTFOLDER}/${PROJECT_NAME}.framework" "${PROJECT_DIR}/../package/"
# Step 8. Convenience step to open the project's directory in Finder
open "${PROJECT_DIR}/../package/"
@philmartin83

This comment has been minimized.

Copy link

commented Apr 10, 2019

this compiles and builds my framework fine, but when I try to build my framework in a project I get a lot of compile errors about “duplicated declaration”, when I import the -swift.h file I get duplicate declarations, I assume this is because there are simulator and the device -swift.h files being concatenated together, making 2 declarations of the same method is there a way to stop this from happening. I’m using your script above in XCode as a build phase.

@Shehryar

This comment has been minimized.

Copy link
Owner Author

commented Apr 23, 2019

Try deleting derived data and cleaning the simulator. I had the same issue but it was resolved after deleting derived data. Sorry this is a lot later - Github's email notification got filtered

@davidbilly

This comment has been minimized.

Copy link

commented Apr 29, 2019

Hi @Shehyar, thanks for the build script :D

Anyway, i'm encountered some issue which "TARGET_OS_SIMULATOR" always false on my swift framework header as i'm using simulator to runs the app.
So, my workaround was adding "#include <TargetConditionals.h>" in first line of the header.

My workaround :
# Step 4. Create new combined simulator and device swift header file
COMBINED_PATH="${BUILD_DIR}/iOS + iOS Simulator/${PROJECT_NAME}-Swift.h"
mkdir -p "${BUILD_DIR}/iOS + iOS Simulator/"
touch "${COMBINED_PATH}"
echo "#include <TargetConditionals.h>" >> "${COMBINED_PATH}"
echo "#if TARGET_OS_SIMULATOR" >> "${COMBINED_PATH}"
cat "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/Headers/${PROJECT_NAME}-Swift.h" >> "${COMBINED_PATH}"
echo "#else" >> "${COMBINED_PATH}"
echo "//Start of iphoneos" >> "${COMBINED_PATH}"
cat "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework/Headers/${PROJECT_NAME}-Swift.h" >> "${COMBINED_PATH}"
echo "#endif" >> "${COMBINED_PATH}"

Lastly, not sure this just happens to me and i hope this can solve for those encounter this issue.

@davidesoldan

This comment has been minimized.

Copy link

commented May 10, 2019

Try deleting derived data and cleaning the simulator. I had the same issue but it was resolved after deleting derived data. Sorry this is a lot later - Github's email notification got filtered

Hi Shehryar, I have the same problem as philmartin83.
Unfortunately cleaning derived data doesn't work for me ... do you have any other advice to make this work?

Anyway thanks a lot for your great script!

@davidesoldan

This comment has been minimized.

Copy link

commented May 10, 2019

Hi Shehryar,
I think I've figured out what was my problem.
If I build several times the fat framework, your script keeps appending the code to the first created
"${BUILD_DIR}/iOS + iOS Simulator/${PROJECT_NAME}-Swift.h"
So you were right, cleaning derived data is the solution, but this is needed before every build of the fat framework, not when you use the framework in another project.
Changing step 4 of your script, deleting at every build the "iOS + iOS Simulator" directory should solve the problem

# Step 4. Create new combined simulator and device swift header file
COMBINED_PATH="${BUILD_DIR}/iOS + iOS Simulator/${PROJECT_NAME}-Swift.h"
# If remnants from a previous build exist, delete them.
if [ -d "${BUILD_DIR}/iOS + iOS Simulator/" ]; then
    rm -rf "${BUILD_DIR}/iOS + iOS Simulator/"
fi
mkdir -p "${BUILD_DIR}/iOS + iOS Simulator/"
touch "${COMBINED_PATH}"
echo "#if TARGET_OS_SIMULATOR" >> "${COMBINED_PATH}"
cat "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/Headers/${PROJECT_NAME}-Swift.h" >> "${COMBINED_PATH}"
echo "#else" >> "${COMBINED_PATH}"
echo "//Start of iphoneos" >> "${COMBINED_PATH}"
cat "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework/Headers/${PROJECT_NAME}-Swift.h" >> "${COMBINED_PATH}"
echo "#endif" >> "${COMBINED_PATH}"

Thanks again for your script, it really saved me a lot of headaches!

@GiuseppePiscopo

This comment has been minimized.

Copy link

commented May 29, 2019

Not strictly related to the Xcode 10 issue, but I'll try:

we're running this script from a Run Script phase in an Aggregate target, as suggested in this post. While BUILD_DIRis correctly set to some directory under DerivedData which is then used, there's still some output found in a build directory found right in project root.

This directory is created upon the first invocation of xcodebuild, as visible from following output text (workspace dir omitted for brevity, MyLib is the project):

** CLEAN SUCCEEDED **

note: Using new build system
note: Planning build
note: Constructing build description
CreateBuildDirectory [...workspace dir]/MyLib/build (in target: MyLib)
    cd [...workspace dir]/MyLib
    builtin-create-build-directory [...workspace dir]/MyLib/build

I'm fine with having that directory right under project root, but does anyone know how to at least set a custom name for that? TA

@Shehryar

This comment has been minimized.

Copy link
Owner Author

commented Jun 17, 2019

You could probably achieve that if you write a bash script, and then call that from the run script phase. That way you can easily access the whole file system and just copy that folder under the root to anywhere you'd like.

@Rickyip

This comment has been minimized.

Copy link

commented Aug 16, 2019

Hi Shehryar,
I think I've figured out what was my problem.
If I build several times the fat framework, your script keeps appending the code to the first created
"${BUILD_DIR}/iOS + iOS Simulator/${PROJECT_NAME}-Swift.h"
So you were right, cleaning derived data is the solution, but this is needed before every build of the fat framework, not when you use the framework in another project.
Changing step 4 of your script, deleting at every build the "iOS + iOS Simulator" directory should solve the problem

# Step 4. Create new combined simulator and device swift header file
COMBINED_PATH="${BUILD_DIR}/iOS + iOS Simulator/${PROJECT_NAME}-Swift.h"
# If remnants from a previous build exist, delete them.
if [ -d "${BUILD_DIR}/iOS + iOS Simulator/" ]; then
    rm -rf "${BUILD_DIR}/iOS + iOS Simulator/"
fi
mkdir -p "${BUILD_DIR}/iOS + iOS Simulator/"
touch "${COMBINED_PATH}"
echo "#if TARGET_OS_SIMULATOR" >> "${COMBINED_PATH}"
cat "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/Headers/${PROJECT_NAME}-Swift.h" >> "${COMBINED_PATH}"
echo "#else" >> "${COMBINED_PATH}"
echo "//Start of iphoneos" >> "${COMBINED_PATH}"
cat "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework/Headers/${PROJECT_NAME}-Swift.h" >> "${COMBINED_PATH}"
echo "#endif" >> "${COMBINED_PATH}"

Thanks again for your script, it really saved me a lot of headaches!

Thanks....This modification works very well!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.