/*
MIT License
Copyright (c) 2021 REX ISAAC RAPHAEL
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#if UNITY_IOS
using System;
using System.Collections.Generic;
using System.IO;
using System.Text.RegularExpressions;
using UnityEditor;
using UnityEditor.iOS.Xcode;
///
/// Adding this post build script to Unity project enables the flutter-unity-widget to access it
///
public static class XcodePostBuild
{
///
/// The identifier added to touched file to avoid double edits when building to existing directory without
/// replace existing content.
///
private const string TouchedMarker = "https://github.com/juicycleff/flutter-unity-view-widget";
//trigger this manually from build.cs as [PostProcessBuild] or IPostprocessBuildWithReport don't always seem to trigger.
public static void PostBuild(BuildTarget target, string pathToBuiltProject)
{
if (target != BuildTarget.iOS)
{
return;
}
PatchUnityNativeCode(pathToBuiltProject);
UpdateUnityProjectFiles(pathToBuiltProject);
UpdateBuildSettings(pathToBuiltProject);
}
///
/// We need to set particular build settings on the UnityFramework target.
/// This includes:
/// - skip_install = NO (It is YES by default)
///
///
private static void UpdateBuildSettings(string pathToBuildProject)
{
var pbx = new PBXProject();
var pbxPath = Path.Combine(pathToBuildProject, "Unity-iPhone.xcodeproj/project.pbxproj");
pbx.ReadFromFile(pbxPath);
var targetGuid = pbx.GetUnityFrameworkTargetGuid();
var projGuid = pbx.ProjectGuid();
// TODO: Rex optional set this value
// Set skip_install to NO
pbx.SetBuildProperty(targetGuid, "SKIP_INSTALL", "YES");
// Set some linker flags
pbx.SetBuildProperty(projGuid, "ENABLE_BITCODE", "NO");
// Persist changes
pbx.WriteToFile(pbxPath);
}
///
/// We need to add the Data folder to the UnityFramework framework
///
private static void UpdateUnityProjectFiles(string pathToBuiltProject)
{
var pbx = new PBXProject();
var pbxPath = Path.Combine(pathToBuiltProject, "Unity-iPhone.xcodeproj/project.pbxproj");
pbx.ReadFromFile(pbxPath);
// PatchRemoveTargetMembership(pathToBuiltProject);
// Add unityLibrary/Data
var targetGuid = pbx.TargetGuidByName("UnityFramework");
var fileGuid = pbx.AddFolderReference(Path.Combine(pathToBuiltProject, "Data"), "Data");
pbx.AddFileToBuild(targetGuid, fileGuid);
pbx.WriteToFile(pbxPath);
}
///
/// Make necessary changes to Unity build output that enables it to be embedded into existing Xcode project.
///
private static void PatchUnityNativeCode(string pathToBuiltProject)
{
if (!CheckUnityAppController(Path.Combine(pathToBuiltProject, "Classes/UnityAppController.h")))
{
EditUnityAppControllerH(Path.Combine(pathToBuiltProject, "Classes/UnityAppController.h"));
MarkUnityAppControllerH(Path.Combine(pathToBuiltProject, "Classes/UnityAppController.h"));
}
if (!CheckUnityAppController(Path.Combine(pathToBuiltProject, "Classes/UnityAppController.mm")))
{
EditUnityAppControllerMM(Path.Combine(pathToBuiltProject, "Classes/UnityAppController.mm"));
MarkUnityAppControllerMM(Path.Combine(pathToBuiltProject, "Classes/UnityAppController.mm"));
}
}
private static bool MarkUnityAppControllerH(string path)
{
var inScope = false;
var mark = false;
EditCodeFile(path, line =>
{
inScope |= line.Contains("include \"RenderPluginDelegate.h\"");
if (inScope)
{
if (line.Trim() == "")
{
inScope = false;
return new string[]
{
"",
"// Edited by " + TouchedMarker,
"",
};
}
return new string[] { line };
}
return new string[] { line };
});
return mark;
}
private static bool MarkUnityAppControllerMM(string path)
{
var inScope = false;
var mark = false;
EditCodeFile(path, line =>
{
inScope |= line.Contains("#include ");
if (inScope)
{
if (line.Trim() == "")
{
inScope = false;
return new string[]
{
"",
"// Edited by " + TouchedMarker,
"",
};
}
return new string[] { line };
}
return new string[] { line };
});
return mark;
}
private static bool CheckUnityAppController(string path)
{
var mark = false;
EditCodeFile(path, line =>
{
mark |= line.Contains("// Edited by " + TouchedMarker);
return new string[] { line };
});
return mark;
}
///
/// Edit 'UnityAppController.h': returns 'UnityAppController' from 'AppDelegate' class.
///
private static void EditUnityAppControllerH(string path)
{
var inScope = false;
var markerDetected = false;
// Modify inline GetAppController
EditCodeFile(path, line =>
{
inScope |= line.Contains("include \"RenderPluginDelegate.h\"");
if (inScope && !markerDetected)
{
if (line.Trim() == "")
{
inScope = false;
markerDetected = true;
return new string[]
{
"",
"// Added by " + TouchedMarker,
"@protocol UnityEventListener ",
"- (void)onSceneLoaded:(NSString *)name buildIndex:(NSInteger *)bIndex loaded:(bool *)isLoaded valid:(bool *)IsValid;",
"- (void)onMessage:(NSString *)message;",
"@end",
"",
};
}
return new string[] { line };
}
return new string[] { line };
});
inScope = false;
markerDetected = false;
// Modify inline GetAppController
EditCodeFile(path, line =>
{
inScope |= line.Contains("include \"RenderPluginDelegate.h\"");
if (inScope && !markerDetected)
{
if (line.Trim() == "")
{
inScope = false;
markerDetected = true;
return new string[]
{
"",
"// Added by " + TouchedMarker,
"typedef void(^unitySceneLoadedCallbackType)(const char* name, const int* buildIndex, const bool* isLoaded, const bool* IsValid);",
"",
"typedef void(^unityMessageCallbackType)(const char* message);",
"",
};
}
return new string[] { line };
}
return new string[] { line };
});
inScope = false;
markerDetected = false;
// Modify inline GetAppController
EditCodeFile(path, line =>
{
inScope |= line.Contains("quitHandler)");
if (inScope && !markerDetected)
{
if (line.Trim() == "")
{
inScope = false;
markerDetected = true;
return new string[]
{
"@property (nonatomic, copy) void(^unitySceneLoadedHandler)(const char* name, const int* buildIndex, const bool* isLoaded, const bool* IsValid);",
"@property (nonatomic, copy) void(^unityMessageHandler)(const char* message);",
};
}
return new string[] { line };
}
return new string[] { line };
});
}
///
/// Edit 'UnityAppController.mm': triggers 'UnityReady' notification after Unity is actually started.
///
private static void EditUnityAppControllerMM(string path)
{
var inScope = false;
var markerDetected = false;
EditCodeFile(path, line =>
{
if (line.Trim() == "@end")
{
return new string[]
{
"",
"// Added by " + TouchedMarker,
"extern \"C\" void OnUnityMessage(const char* message)",
"{",
" if (GetAppController().unityMessageHandler) {",
" GetAppController().unityMessageHandler(message);",
" }",
"}",
"",
"extern \"C\" void OnUnitySceneLoaded(const char* name, const int* buildIndex, const bool* isLoaded, const bool* IsValid)",
"{",
" if (GetAppController().unitySceneLoadedHandler) {",
" GetAppController().unitySceneLoadedHandler(name, buildIndex, isLoaded, IsValid);",
" }",
"}",
line,
};
}
inScope |= line.Contains("- (void)startUnity:");
markerDetected |= inScope && line.Contains(TouchedMarker);
//Find the end of the startUnity function, a } without any indentation. (regex: starts with } followed by any whitespace)
//Avoid indentation before } as newer unity versions include an if-statement inside this function.
if (inScope && Regex.Match(line, @"^}(\s)*$").Success)
{
inScope = false;
if (markerDetected)
{
return new string[] { line };
}
else
{
//Add a UnityReady notification at the end of the startUnity function.
return new string[]
{
" // Modified by " + TouchedMarker,
@" [[NSNotificationCenter defaultCenter] postNotificationName: @""UnityReady"" object:self];",
"}",
};
}
}
return new string[] { line };
});
}
private static void EditCodeFile(string path, Func> lineHandler)
{
var bakPath = path + ".bak";
if (File.Exists(bakPath))
{
File.Delete(bakPath);
}
File.Move(path, bakPath);
using (var reader = File.OpenText(bakPath))
using (var stream = File.Create(path))
using (var writer = new StreamWriter(stream))
{
string line;
while ((line = reader.ReadLine()) != null)
{
var outputs = lineHandler(line);
foreach (var o in outputs)
{
writer.WriteLine(o);
}
}
}
}
}
#endif