Travis Build: OS X Startup Crash Fix (#1962)

* Travis: Mac OS X Build Fix

Addresses the issue of the nightly builds crashing on OS X. In short,
the changes needed were to rename the references within the binaries in
order to make the app “self-contained”.

* Travis: Mac OS X Terminal

Launches citra with a terminal (instead of going straight for the QT
application, skipping the debugging terminal).

* Travis: Clean Up Lines

* Travis: Fix of EOL Issue

* Travis: Merge Fixes from Build Branch

* Travis: Forward OS X Arguments

* Travis: Forward OS X Arg x2

The issue is, is that sure “open citra-qt.app —args test” works, but
drag and drop doesn’t!

* Travis: Something needed to be escaped

.travis-upload.sh

@@ -23,6 +23,97 @@ if [ "$TRAVIS_BRANCH" = "master" ]; then
 
         # move SDL2 libs into folder for deployment
         dylibbundler -b -x "${REV_NAME}/citra" -cd -d "${REV_NAME}/libs" -p "@executable_path/libs/"
+
+        # Make the changes to make the citra-qt app standalone (i.e. not dependent on the current brew installation).
+        # To do this, the absolute references to each and every QT framework must be re-written to point to the local frameworks
+        # (in the Contents/Frameworks folder).
+        # The "install_name_tool" is used to do so.
+
+        # Coreutils is a hack to coerce Homebrew to point to the absolute Cellar path (symlink dereferenced). i.e:
+        # ls -l /usr/local/opt/qt5:: /usr/local/opt/qt5 -> ../Cellar/qt5/5.6.1-1
+        # grealpath ../Cellar/qt5/5.6.1-1:: /usr/local/Cellar/qt5/5.6.1-1
+        brew install coreutils
+
+        REV_NAME_ALT=$REV_NAME/
+        # grealpath is located in coreutils, there is no "realpath" for OS X :(
+        QT_BREWS_PATH=$(grealpath "$(brew --prefix qt5)")
+        BREW_PATH=$(brew --prefix)
+        QT_VERSION_NUM=5
+
+        $BREW_PATH/opt/qt5/bin/macdeployqt "${REV_NAME_ALT}citra-qt.app" \
+            -executable="${REV_NAME_ALT}citra-qt.app/Contents/MacOS/citra-qt"
+
+        # These are the files that macdeployqt packed into Contents/Frameworks/ - we don't want those, so we replace them.
+        declare -a macos_libs=("QtCore" "QtWidgets" "QtGui" "QtOpenGL" "QtPrintSupport")
+
+        for macos_lib in "${macos_libs[@]}"
+        do
+            SC_FRAMEWORK_PART=$macos_lib.framework/Versions/$QT_VERSION_NUM/$macos_lib
+            # Replace macdeployqt versions of the Frameworks with our own (from /usr/local/opt/qt5/lib/)
+            cp "$BREW_PATH/opt/qt5/lib/$SC_FRAMEWORK_PART" "${REV_NAME_ALT}citra-qt.app/Contents/Frameworks/$SC_FRAMEWORK_PART"
+
+            # Replace references within the embedded Framework files with "internal" versions.
+            for macos_lib2 in "${macos_libs[@]}"
+            do
+                # Since brew references both the non-symlinked and symlink paths of QT5, it needs to be duplicated.
+                # /usr/local/Cellar/qt5/5.6.1-1/lib and /usr/local/opt/qt5/lib both resolve to the same files.
+                # So the two lines below are effectively duplicates when resolved as a path, but as strings, they aren't.
+                RM_FRAMEWORK_PART=$macos_lib2.framework/Versions/$QT_VERSION_NUM/$macos_lib2
+                install_name_tool -change \
+                    $QT_BREWS_PATH/lib/$RM_FRAMEWORK_PART \
+                    @executable_path/../Frameworks/$RM_FRAMEWORK_PART \
+                    "${REV_NAME_ALT}citra-qt.app/Contents/Frameworks/$SC_FRAMEWORK_PART"
+                install_name_tool -change \
+                    "$BREW_PATH/opt/qt5/lib/$RM_FRAMEWORK_PART" \
+                    @executable_path/../Frameworks/$RM_FRAMEWORK_PART \
+                    "${REV_NAME_ALT}citra-qt.app/Contents/Frameworks/$SC_FRAMEWORK_PART"
+            done
+        done
+
+        # Handles `This application failed to start because it could not find or load the Qt platform plugin "cocoa"`
+        # Which manifests itself as:
+        # "Exception Type: EXC_CRASH (SIGABRT) | Exception Codes: 0x0000000000000000, 0x0000000000000000 | Exception Note: EXC_CORPSE_NOTIFY"
+        # There may be more dylibs needed to be fixed...
+        declare -a macos_plugins=("Plugins/platforms/libqcocoa.dylib")
+
+        for macos_lib in "${macos_plugins[@]}"
+        do
+            install_name_tool -id @executable_path/../$macos_lib "${REV_NAME_ALT}citra-qt.app/Contents/$macos_lib"
+            for macos_lib2 in "${macos_libs[@]}"
+            do
+                RM_FRAMEWORK_PART=$macos_lib2.framework/Versions/$QT_VERSION_NUM/$macos_lib2
+                install_name_tool -change \
+                    $QT_BREWS_PATH/lib/$RM_FRAMEWORK_PART \
+                    @executable_path/../Frameworks/$RM_FRAMEWORK_PART \
+                    "${REV_NAME_ALT}citra-qt.app/Contents/$macos_lib"
+                install_name_tool -change \
+                    "$BREW_PATH/opt/qt5/lib/$RM_FRAMEWORK_PART" \
+                    @executable_path/../Frameworks/$RM_FRAMEWORK_PART \
+                    "${REV_NAME_ALT}citra-qt.app/Contents/$macos_lib"
+            done
+        done
+
+        for macos_lib in "${macos_libs[@]}"
+        do
+            # Debugging info for Travis-CI
+            otool -L "${REV_NAME_ALT}citra-qt.app/Contents/Frameworks/$macos_lib.framework/Versions/$QT_VERSION_NUM/$macos_lib"
+        done
+
+        # Make the citra-qt.app application launch a debugging terminal.
+        # Store away the actual binary
+        mv ${REV_NAME_ALT}citra-qt.app/Contents/MacOS/citra-qt ${REV_NAME_ALT}citra-qt.app/Contents/MacOS/citra-qt-bin
+
+        cat > ${REV_NAME_ALT}citra-qt.app/Contents/MacOS/citra-qt <<EOL
+#!/usr/bin/env bash
+cd "\`dirname "\$0"\`"
+chmod +x citra-qt-bin
+open citra-qt-bin --args "\$@"
+EOL
+        # Content that will serve as the launching script for citra (within the .app folder)
+
+        # Make the launching script executable
+        chmod +x ${REV_NAME_ALT}citra-qt.app/Contents/MacOS/citra-qt
+
     fi
 
     # Copy documentation