ca.mestevens.ios.utils.XcodeProjectUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xcode-maven-plugin Show documentation
Show all versions of xcode-maven-plugin Show documentation
A maven plugin to facilitate xcode building/dependency management/testing
package ca.mestevens.ios.utils;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import lombok.Data;
import org.apache.maven.plugin.MojoExecutionException;
import ca.mestevens.ios.xcode.parser.exceptions.InvalidObjectFormatException;
import ca.mestevens.ios.xcode.parser.models.CommentedIdentifier;
import ca.mestevens.ios.xcode.parser.models.PBXBuildFile;
import ca.mestevens.ios.xcode.parser.models.PBXBuildPhase;
import ca.mestevens.ios.xcode.parser.models.PBXFileElement;
import ca.mestevens.ios.xcode.parser.models.PBXTarget;
import ca.mestevens.ios.xcode.parser.models.XCConfigurationList;
import ca.mestevens.ios.xcode.parser.models.XCodeProject;
@Data
public class XcodeProjectUtil {
private String pbxProjLocation;
private XCodeProject xcodeProject;
public XcodeProjectUtil(String pbxProjLocation) throws InvalidObjectFormatException {
this.pbxProjLocation = pbxProjLocation;
this.xcodeProject = new XCodeProject(pbxProjLocation);
}
public void addDependenciesToTarget(String targetName, List dependencyFiles) throws MojoExecutionException {
try {
List frameworkIdentifiers = new ArrayList();
List fileReferenceIdentifiers = new ArrayList();
List copyIdentifiers = new ArrayList();
boolean containsFrameworks = false;
boolean containsLibraries = false;
//Add the framework files as file references and build files
for (File dependencyFile : dependencyFiles) {
String frameworkPath = dependencyFile.getAbsolutePath().substring(dependencyFile.getAbsolutePath().lastIndexOf("target"));
PBXFileElement fileReference = xcodeProject.getFileReferenceWithPath(frameworkPath);
if (fileReference == null) {
fileReference = xcodeProject.createFileReference(frameworkPath, "SOURCE_ROOT");
}
List buildFiles = xcodeProject.getBuildFileWithFileRefPath(frameworkPath);
if (buildFiles.isEmpty()) {
buildFiles = xcodeProject.getBuildFileWithFileRefPath("\"" + frameworkPath + "\"");
}
PBXBuildFile buildFile = null;
PBXBuildFile copyBuildFile = null;
for (PBXBuildFile existingFile : buildFiles) {
if (existingFile.getReference().getComment().contains(dependencyFile.getName() + " in Frameworks")) {
buildFile = existingFile;
} else if (existingFile.getReference().getComment().contains(dependencyFile.getName() + " in Embed Frameworks")) {
copyBuildFile = existingFile;
}
}
String fileExtension = dependencyFile.getAbsolutePath().substring(dependencyFile.getAbsolutePath().lastIndexOf('.') + 1);
if (fileExtension.equals("a")) {
containsLibraries = true;
}
if (fileExtension.equals("framework")) {
containsFrameworks = true;
}
if (buildFile == null) {
buildFile = xcodeProject.createBuildFileFromFileReferencePath(frameworkPath, dependencyFile.getName() + " in Frameworks");
}
if (copyBuildFile == null && fileExtension.equals("framework")) {
copyBuildFile = xcodeProject.createBuildFileFromFileReferencePath(frameworkPath, dependencyFile.getName() + " in Embed Frameworks");
copyBuildFile.getSettings().put("ATTRIBUTES", "(CodeSignOnCopy, )");
}
frameworkIdentifiers.add(buildFile.getReference());
fileReferenceIdentifiers.add(fileReference.getReference());
if (copyBuildFile != null) {
copyIdentifiers.add(copyBuildFile.getReference());
}
}
//Grab the first target
String targetIdentifier = "";
String copyFrameworksBuildPhaseIdentifier = "";
for (PBXTarget target : xcodeProject.getNativeTargets()) {
if (target.getName() != null && (target.getName().equals(targetName) || target.getName().equals("\"" + targetName + "\""))) {
targetIdentifier = target.getReference().getIdentifier();
for(CommentedIdentifier buildPhase : target.getBuildPhases()) {
if (buildPhase.getComment().contains("Embed Frameworks")) {
copyFrameworksBuildPhaseIdentifier = buildPhase.getIdentifier();
}
}
}
}
if (targetIdentifier.equals("")) {
return;
}
//If the Embed Frameworks phase doesn't exist, create it
boolean foundExistingPhase = false;
for(PBXBuildPhase copyFilesBuildPhase : xcodeProject.getCopyFilesBuildPhases()) {
if (copyFilesBuildPhase.getReference().getIdentifier().equals(copyFrameworksBuildPhaseIdentifier)) {
for(CommentedIdentifier identifier : copyIdentifiers) {
boolean foundFile = false;
for (CommentedIdentifier fileIdentifier : copyFilesBuildPhase.getFiles()) {
if (fileIdentifier.getComment().equals(identifier.getComment())) {
foundFile = true;
}
}
if (!foundFile) {
copyFilesBuildPhase.getFiles().add(identifier);
}
}
foundExistingPhase = true;
}
}
if (!foundExistingPhase) {
PBXBuildPhase copyFrameworksBuildPhase = new PBXBuildPhase("PBXCopyFilesBuildPhase", "\"Embed Frameworks\"", copyIdentifiers, "\"\"", 10);
xcodeProject.addCopyFilesBuildPhase(targetIdentifier, copyFrameworksBuildPhase);
}
//Get the configuration list identifier for the first target
String existingFrameworksPhaseId = null;
String buildConfigurationList = null;
PBXTarget nativeTarget = xcodeProject.getNativeTargetWithIdentifier(targetIdentifier);
for(CommentedIdentifier buildPhaseIdentifier : nativeTarget.getBuildPhases()) {
if (buildPhaseIdentifier.getComment().equals("Frameworks")) {
existingFrameworksPhaseId = buildPhaseIdentifier.getIdentifier();
buildConfigurationList = nativeTarget.getBuildConfigurationList().getIdentifier();
break;
}
}
//Add the framework build files to the frameworks build phase
PBXBuildPhase frameworksBuildPhase = xcodeProject.getFrameworksBuildPhaseWithIdentifier(existingFrameworksPhaseId);
if (frameworksBuildPhase.getReference().getIdentifier().equals(existingFrameworksPhaseId)) {
for(CommentedIdentifier identifier : frameworkIdentifiers) {
if (!frameworksBuildPhase.getFiles().contains(identifier)) {
frameworksBuildPhase.getFiles().add(identifier);
}
}
}
//Add the properties to the build configuration
XCConfigurationList configuration = xcodeProject.getConfigurationListWithIdentifier(buildConfigurationList);
for(CommentedIdentifier identifier : configuration.getBuildConfigurations()) {
if (containsFrameworks) {
//FRAMEWORK_SEARCH_PATHS
List frameworkSearchPaths = xcodeProject.getBuildConfigurationPropertyAsList(identifier.getIdentifier(), "FRAMEWORK_SEARCH_PATHS");
if (frameworkSearchPaths != null) {
if (!frameworkSearchPaths.contains("\"${PROJECT_DIR}/target/xcode-dependencies/frameworks/**\"")) {
frameworkSearchPaths.add("\"${PROJECT_DIR}/target/xcode-dependencies/frameworks/**\"");
xcodeProject.setBuildConfigurationProperty(identifier.getIdentifier(), "FRAMEWORK_SEARCH_PATHS", frameworkSearchPaths);
}
} else {
frameworkSearchPaths = new ArrayList();
frameworkSearchPaths.add("\"${PROJECT_DIR}/target/xcode-dependencies/frameworks/**\"");
xcodeProject.setBuildConfigurationProperty(identifier.getIdentifier(), "FRAMEWORK_SEARCH_PATHS", frameworkSearchPaths);
}
//LD_RUNPATH_SEARCH_PATHS
String ldRunpathSearchPaths = xcodeProject.getBuildConfigurationProperty(identifier.getIdentifier(), "LD_RUNPATH_SEARCH_PATHS");
if (ldRunpathSearchPaths != null) {
if (ldRunpathSearchPaths.startsWith("\"")) {
ldRunpathSearchPaths = ldRunpathSearchPaths.substring(1);
}
if (ldRunpathSearchPaths.endsWith("\"")) {
ldRunpathSearchPaths = ldRunpathSearchPaths.substring(0, ldRunpathSearchPaths.length() - 1);
}
ldRunpathSearchPaths = ldRunpathSearchPaths.trim();
if (!ldRunpathSearchPaths.contains("@loader_path/Frameworks")) {
ldRunpathSearchPaths = ldRunpathSearchPaths.concat(" @loader_path/Frameworks");
}
if (!ldRunpathSearchPaths.contains("@executable_path/Frameworks")) {
ldRunpathSearchPaths = ldRunpathSearchPaths.concat(" @executable_path/Frameworks");
}
ldRunpathSearchPaths = "\"" + ldRunpathSearchPaths + "\"";
xcodeProject.setBuildConfigurationProperty(identifier.getIdentifier(), "LD_RUNPATH_SEARCH_PATHS", ldRunpathSearchPaths);
} else {
xcodeProject.setBuildConfigurationProperty(identifier.getIdentifier(), "LD_RUNPATH_SEARCH_PATHS", "\"@loader_path/Frameworks @executable_path/Frameworks\"");
}
}
if (containsLibraries) {
//HEADER_SEARCH_PATHS
List headerSearchPaths = xcodeProject.getBuildConfigurationPropertyAsList(identifier.getIdentifier(), "HEADER_SEARCH_PATHS");
if (headerSearchPaths == null) {
headerSearchPaths = new ArrayList();
}
if (!headerSearchPaths.contains("\"${PROJECT_DIR}/target/xcode-dependencies/libraries/**\"")) {
headerSearchPaths.add("\"${PROJECT_DIR}/target/xcode-dependencies/libraries/**\"");
xcodeProject.setBuildConfigurationProperty(identifier.getIdentifier(), "HEADER_SEARCH_PATHS", headerSearchPaths);
}
//LIBRARY_SEARCH_PATHS
List librarySearchPaths = xcodeProject.getBuildConfigurationPropertyAsList(identifier.getIdentifier(), "LIBRARY_SEARCH_PATHS");
if (librarySearchPaths == null) {
librarySearchPaths = new ArrayList();
}
if (!librarySearchPaths.contains("\"${PROJECT_DIR}/target/xcode-dependencies/libraries/**\"")) {
librarySearchPaths.add("\"${PROJECT_DIR}/target/xcode-dependencies/libraries/**\"");
xcodeProject.setBuildConfigurationProperty(identifier.getIdentifier(), "LIBRARY_SEARCH_PATHS", librarySearchPaths);
}
}
}
//Add/Edit the Frameworks group
String frameworkGroupIdentifier = null;
for(PBXFileElement group : xcodeProject.getGroups()) {
if (group.getName() != null && (group.getName().equals("Frameworks") || group.getName().equals("\"Frameworks\""))) {
frameworkGroupIdentifier = group.getReference().getIdentifier();
}
}
PBXFileElement frameworkGroup = null;
if (frameworkGroupIdentifier != null) {
frameworkGroup = xcodeProject.getGroupWithIdentifier(frameworkGroupIdentifier);
} else {
String mainGroupIdentifier = xcodeProject.getProject().getMainGroup().getIdentifier();
frameworkGroup = xcodeProject.createGroup("Frameworks", mainGroupIdentifier);
}
for (CommentedIdentifier fileReference : fileReferenceIdentifiers) {
boolean found = false;
for (CommentedIdentifier child : frameworkGroup.getChildren()) {
if (child.getComment().equals(fileReference.getComment())) {
found = true;
}
}
if (!found) {
frameworkGroup.addChild(fileReference);
}
}
} catch (Exception ex) {
ex.printStackTrace();
throw new MojoExecutionException(ex.getMessage());
}
}
public void writeProject() throws IOException {
Files.write(Paths.get(pbxProjLocation), xcodeProject.toString().getBytes());
}
}