Support static libraries in plugins for iOS.

lib/definitions/xcode.d.ts

@@ -1,10 +1,10 @@
 declare module "xcode" {
- interface FrameworkOptions {
+ interface Options {
  [key: string]: any;
 
  customFramework?: boolean;
-
  embed?: boolean;
+ relativePath?: string;
  }
 
  class project {
@@ -15,9 +15,13 @@ declare module "xcode" {
 
  writeSync(): string;
 
- addFramework(filepath: string, options?: FrameworkOptions): void;
- removeFramework(filePath: string, options?: FrameworkOptions): void;
-
+ addFramework(filepath: string, options?: Options): void;
+ removeFramework(filePath: string, options?: Options): void;
+
+ addPbxGroup(filePathsArray: any[], name: string, path: string, sourceTree: string): void;
+
+ addToHeaderSearchPaths(options?: Options): void;
+ removeFromHeaderSearchPaths(options?: Options): void;
  updateBuildProperty(key: string, value: any): void;
  }
 }

lib/services/ios-project-service.ts

@@ -200,29 +200,63 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 
 	public addLibrary(libraryPath: string): IFuture<void> {
  return (() => {
- this.validateFramework(libraryPath).wait();
+ let extension = path.extname(libraryPath);
+ if (extension === ".framework") {
+ this.addDynamicFramework(libraryPath);
+ } else {
+ this.$errors.failWithoutHelp(`The bundle at ${libraryPath} does not appear to be a dynamic framework package.`);
+ }
+ }).future<void>()();
+	}
+
+	private addDynamicFramework(frameworkPath: string): IFuture<void> {
+ return (() => {
+ this.validateFramework(frameworkPath).wait();
 
  let targetPath = path.join("lib", this.platformData.normalizedPlatformName);
  let fullTargetPath = path.join(this.$projectData.projectDir, targetPath);
  this.$fs.ensureDirectoryExists(fullTargetPath).wait();
- shell.cp("-R", libraryPath, fullTargetPath);
+ shell.cp("-R", frameworkPath, fullTargetPath);
 
  let project = this.createPbxProj();
-
- let frameworkName = path.basename(libraryPath, path.extname(libraryPath));
- let frameworkBinaryPath = path.join(libraryPath, frameworkName);
+ let frameworkName = path.basename(frameworkPath, path.extname(frameworkPath));
+ let frameworkBinaryPath = path.join(frameworkPath, frameworkName);
  let isDynamic = _.contains(this.$childProcess.exec(`otool -Vh ${frameworkBinaryPath}`).wait(), " DYLIB ");
 
- let frameworkAddOptions: xcode.FrameworkOptions = { customFramework: true };
+ let frameworkAddOptions: xcode.Options = { customFramework: true };
 
  if(isDynamic) {
  frameworkAddOptions["embed"] = true;
  project.updateBuildProperty("IPHONEOS_DEPLOYMENT_TARGET", "8.0");
  this.$logger.info("The iOS Deployment Target is now 8.0 in order to support Cocoa Touch Frameworks.");
  }
 
- let frameworkPath = this.getFrameworkRelativePath(libraryPath);
- project.addFramework(frameworkPath, frameworkAddOptions);
+ let frameworkRelativePath = this.getLibSubpathRelativeToProjectPath(path.basename(frameworkPath));
+ project.addFramework(frameworkRelativePath, frameworkAddOptions);
+ this.savePbxProj(project).wait();
+ }).future<void>()();
+	}
+
+	private addStaticLibrary(staticLibPath: string): IFuture<void> {
+ return (() => {
+ this.validateStaticLibrary(staticLibPath).wait();
+ // Copy files to lib folder.
+ let libraryName = path.basename(staticLibPath, ".a");
+ let libDestinationPath = path.join(this.$projectData.projectDir, path.join("lib", this.platformData.normalizedPlatformName));
+ let headersSubpath = path.join("include", libraryName);
+ this.$fs.ensureDirectoryExists(path.join(libDestinationPath, headersSubpath)).wait();
+ shell.cp("-Rf", staticLibPath, libDestinationPath);
+ shell.cp("-Rf", path.join(path.dirname(staticLibPath), headersSubpath), path.join(libDestinationPath, "include"));
+
+ // Add static library to project file and setup header search paths
+ let project = this.createPbxProj();
+ let relativeStaticLibPath = this.getLibSubpathRelativeToProjectPath(path.basename(staticLibPath));
+ project.addFramework(relativeStaticLibPath);
+
+ let relativeHeaderSearchPath = path.join(this.getLibSubpathRelativeToProjectPath(headersSubpath));
+ project.addToHeaderSearchPaths({ relativePath: relativeHeaderSearchPath });
+
+ this.generateMobulemap(path.join(libDestinationPath, headersSubpath), libraryName);
  this.savePbxProj(project).wait();
  }).future<void>()();
 	}
@@ -307,10 +341,9 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
  return name.replace(/\\\"/g, "\"");
 	}
 
-	private getFrameworkRelativePath(libraryPath: string): string {
- let frameworkName = path.basename(libraryPath, path.extname(libraryPath));
+	private getLibSubpathRelativeToProjectPath(subPath: string): string {
  let targetPath = path.join("lib", this.platformData.normalizedPlatformName);
- let frameworkPath = path.relative("platforms/ios", path.join(targetPath, frameworkName + ".framework"));
+ let frameworkPath = path.relative("platforms/ios", path.join(targetPath, subPath));
  return frameworkPath;
 	}
 
@@ -332,15 +365,19 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 	public preparePluginNativeCode(pluginData: IPluginData, opts?: any): IFuture<void> {
  return (() => {
  let pluginPlatformsFolderPath = pluginData.pluginPlatformsFolderPath(IOSProjectService.IOS_PLATFORM_NAME);
+
  this.prepareFrameworks(pluginPlatformsFolderPath, pluginData).wait();
- this.prepareCocoapods(pluginPlatformsFolderPath, opts).wait();
+ this.prepareStaticLibs(pluginPlatformsFolderPath, pluginData).wait();
+ this.prepareCocoapods(pluginPlatformsFolderPath).wait();
  }).future<void>()();
 	}
 
 	public removePluginNativeCode(pluginData: IPluginData): IFuture<void> {
  return (() => {
  let pluginPlatformsFolderPath = pluginData.pluginPlatformsFolderPath(IOSProjectService.IOS_PLATFORM_NAME);
+
  this.removeFrameworks(pluginPlatformsFolderPath, pluginData).wait();
+ this.removeStaticLibs(pluginPlatformsFolderPath, pluginData).wait();
  this.removeCocoapods(pluginPlatformsFolderPath).wait();
  }).future<void>()();
 	}
@@ -377,10 +414,10 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
  }).future<void>()();
 	}
 
-	private getAllFrameworksForPlugin(pluginData: IPluginData): IFuture<string[]> {
- let filterCallback = (fileName: string, pluginPlatformsFolderPath: string) => path.extname(fileName) === ".framework";
+	private getAllLibsForPluginWithFileExtension(pluginData: IPluginData, fileExtension: string): IFuture<string[]> {
+ let filterCallback = (fileName: string, pluginPlatformsFolderPath: string) => path.extname(fileName) === fileExtension;
  return this.getAllNativeLibrariesForPlugin(pluginData, IOSProjectService.IOS_PLATFORM_NAME, filterCallback);
-	}
+	};
 
 	private buildPathToXcodeProjectFile(version: string): string {
  return path.join(this.$npmInstallationManager.getCachedPackagePath(this.platformData.frameworkPackageName, version), constants.PROJECT_FRAMEWORK_FOLDER_NAME, util.format("%s.xcodeproj", IOSProjectService.IOS_PROJECT_NAME_PLACEHOLDER), "project.pbxproj");
@@ -400,6 +437,24 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
  }).future<void>()();
 	}
 
+	private validateStaticLibrary(libraryPath: string): IFuture<void> {
+ return (() => {
+ if (path.extname(libraryPath) !== ".a") {
+ this.$errors.failWithoutHelp(`The bundle at ${libraryPath} does not contain a valid static library in the '.a' file format.`);
+ }
+
+ let expectedArchs = ["armv7", "arm64", "i386"];
+ let archsInTheFatFile = this.$childProcess.exec("lipo -i " + libraryPath).wait();
+
+ expectedArchs.forEach(expectedArch => {
+ if (archsInTheFatFile.indexOf(expectedArch) < 0) {
+ this.$errors.failWithoutHelp(`The static library at ${libraryPath} is not built for one or more of the following required architectures: 
+ ${expectedArchs.join(", ")}. The static library must be built for all required architectures.`);
+ }
+ });
+ }).future<void>()();
+	}
+
 	private replaceFileContent(file: string): IFuture<void> {
  return (() => {
  let fileContent = this.$fs.readText(file).wait();
@@ -424,13 +479,20 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 
 	private prepareFrameworks(pluginPlatformsFolderPath: string, pluginData: IPluginData): IFuture<void> {
  return (() => {
- _.each(this.getAllFrameworksForPlugin(pluginData).wait(), fileName => this.addLibrary(path.join(pluginPlatformsFolderPath, fileName)).wait());
+ _.each(this.getAllLibsForPluginWithFileExtension(pluginData, ".framework").wait(), fileName => this.addDynamicFramework(path.join(pluginPlatformsFolderPath, fileName)).wait());
+ }).future<void>()();
+	}
+
+	private prepareStaticLibs(pluginPlatformsFolderPath: string, pluginData: IPluginData): IFuture<void> {
+ return (() => {
+ _.each(this.getAllLibsForPluginWithFileExtension(pluginData, ".a").wait(), fileName => this.addStaticLibrary(path.join(pluginPlatformsFolderPath, fileName)).wait());
  }).future<void>()();
 	}
 
 	private prepareCocoapods(pluginPlatformsFolderPath: string, opts?: any): IFuture<void> {
  return (() => {
  let pluginPodFilePath = path.join(pluginPlatformsFolderPath, "Podfile");
+
  if(this.$fs.exists(pluginPodFilePath).wait()) {
  if(!this.$fs.exists(this.projectPodFilePath).wait()) {
  this.$fs.writeFile(this.projectPodFilePath, "use_frameworks!\n").wait();
@@ -450,17 +512,33 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 	private removeFrameworks(pluginPlatformsFolderPath: string, pluginData: IPluginData): IFuture<void> {
  return (() => {
  let project = this.createPbxProj();
-
- _.each(this.getAllFrameworksForPlugin(pluginData).wait(), fileName => {
- let fullFrameworkPath = path.join(pluginPlatformsFolderPath, fileName);
- let relativeFrameworkPath = this.getFrameworkRelativePath(fullFrameworkPath);
+ _.each(this.getAllLibsForPluginWithFileExtension(pluginData, ".framework").wait(), fileName => {
+ let relativeFrameworkPath = this.getLibSubpathRelativeToProjectPath(fileName);
  project.removeFramework(relativeFrameworkPath, { customFramework: true, embed: true });
  });
 
  this.savePbxProj(project).wait();
  }).future<void>()();
 	}
 
+	private removeStaticLibs(pluginPlatformsFolderPath: string, pluginData: IPluginData): IFuture<void> {
+ return (() => {
+ let project = this.createPbxProj();
+
+ _.each(this.getAllLibsForPluginWithFileExtension(pluginData, ".a").wait(), fileName => {
+ let staticLibPath = path.join(pluginPlatformsFolderPath, fileName);
+ let relativeStaticLibPath = this.getLibSubpathRelativeToProjectPath(path.basename(staticLibPath));
+ project.removeFramework(relativeStaticLibPath);
+
+ let headersSubpath = path.join("include", path.basename(staticLibPath, ".a"));
+ let relativeHeaderSearchPath = path.join(this.getLibSubpathRelativeToProjectPath(headersSubpath));
+ project.removeFromHeaderSearchPaths({ relativePath: relativeHeaderSearchPath });
+ });
+
+ this.savePbxProj(project).wait();
+ }).future<void>()();
+	}
+
 	private removeCocoapods(pluginPlatformsFolderPath: string): IFuture<void> {
  return (() => {
  let pluginPodFilePath = path.join(pluginPlatformsFolderPath, "Podfile");
@@ -481,5 +559,22 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 	private buildPodfileContent(pluginPodFilePath: string, pluginPodFileContent: string): string {
  return `# Begin Podfile - ${pluginPodFilePath} ${os.EOL} ${pluginPodFileContent} ${os.EOL} # End Podfile ${os.EOL}`;
 	}
+
+	private generateMobulemap(headersFolderPath: string, libraryName: string): void {
+ let headersFilter = (fileName: string, containingFolderPath: string) => (path.extname(fileName) === ".h" && this.$fs.getFsStats(path.join(containingFolderPath, fileName)).wait().isFile());
+ let headersFolderContents = this.$fs.readDirectory(headersFolderPath).wait();
+ let headers = _(headersFolderContents).filter(item => headersFilter(item, headersFolderPath)).value();
+
+ if (!headers.length) {
+ this.$fs.deleteFile(path.join(headersFolderPath, "module.modulemap")).wait();
+ return;
+ }
+
+ headers = _.map(headers, value => `header "${value}"`);
+
+ let modulemap = `module ${libraryName} { explicit module ${libraryName} { ${headers.join(" ")} } }`;
+ this.$fs.writeFile(path.join(headersFolderPath, "module.modulemap"), modulemap).wait();
+	}
 }
+
 $injector.register("iOSProjectService", IOSProjectService);

package.json

@@ -72,7 +72,7 @@
  "vinyl-filter-since": "2.0.2",
  "winreg": "0.0.12",
  "ws": "0.7.1",
- "xcode": "https://github.com/NativeScript/node-xcode/archive/NativeScript-1.2.2.tar.gz",
+ "xcode": "https://github.com/NativeScript/node-xcode/archive/1.4.0.tar.gz",
  "xmldom": "0.1.19",
  "xmlhttprequest": "https://github.com/telerik/node-XMLHttpRequest/tarball/master",
  "xmlmerge-js": "0.2.4",

test/ios-project-service.ts

@@ -72,6 +72,9 @@ describe("Cocoapods support", () => {
  iOSProjectService.prepareFrameworks = (pluginPlatformsFolderPath: string, pluginData: IPluginData): IFuture<void> => {
  return Future.fromResult();
  };
+ iOSProjectService.prepareStaticLibs = (pluginPlatformsFolderPath: string, pluginData: IPluginData): IFuture<void> => {
+ return Future.fromResult();
+ };
 
  let pluginPath = temp.mkdirSync("pluginDirectory");
  let pluginPlatformsFolderPath = path.join(pluginPath, "platforms", "ios");
@@ -124,9 +127,15 @@ describe("Cocoapods support", () => {
  iOSProjectService.prepareFrameworks = (pluginPlatformsFolderPath: string, pluginData: IPluginData): IFuture<void> => {
  return Future.fromResult();
  };
+ iOSProjectService.prepareStaticLibs = (pluginPlatformsFolderPath: string, pluginData: IPluginData): IFuture<void> => {
+ return Future.fromResult();
+ };
  iOSProjectService.removeFrameworks = (pluginPlatformsFolderPath: string, pluginData: IPluginData): IFuture<void> => {
  return Future.fromResult();
  };
+ iOSProjectService.removeStaticLibs = (pluginPlatformsFolderPath: string, pluginData: IPluginData): IFuture<void> => {
+ return Future.fromResult();
+ };
 
  let pluginPath = temp.mkdirSync("pluginDirectory");
  let pluginPlatformsFolderPath = path.join(pluginPath, "platforms", "ios");
@@ -159,3 +168,78 @@ describe("Cocoapods support", () => {
  });
 	}
 });
+
+describe("Static libraries support", () => {
+	if (require("os").platform() !== "darwin") {
+ console.log("Skipping static library tests. They work only on darwin.");
+ return;
+	}
+
+	let projectName = "projectDirectory";
+	let projectPath = temp.mkdirSync(projectName);
+	let libraryName = "testLibrary1";
+	let headers = ["TestHeader1.h", "TestHeader2.h"];
+	let testInjector = createTestInjector(projectPath, projectName);
+	let fs: IFileSystem = testInjector.resolve("fs");
+	let staticLibraryPath = path.join(path.join(temp.mkdirSync("pluginDirectory"), "platforms", "ios"));
+	let staticLibraryHeadersPath = path.join(staticLibraryPath,"include", libraryName);
+
+	it("checks validation of header files", () => {
+ let iOSProjectService = testInjector.resolve("iOSProjectService");
+ fs.ensureDirectoryExists(staticLibraryHeadersPath).wait();
+ _.each(headers, header => { fs.writeFile(path.join(staticLibraryHeadersPath, header), "").wait(); });
+
+ // Add all header files.
+ fs.writeFile(path.join(staticLibraryHeadersPath, libraryName + ".a"), "").wait();
+
+ let error: any;
+ try {
+ iOSProjectService.validateStaticLibrary(path.join(staticLibraryPath, libraryName + ".a")).wait();
+ } catch(err) {
+ error = err;
+ }
+
+ assert.instanceOf(error, Error, "Expect to fail, the .a file is not a static library.");
+	});
+
+	it("checks generation of modulemaps", () => {
+ let iOSProjectService = testInjector.resolve("iOSProjectService");
+ fs.ensureDirectoryExists(staticLibraryHeadersPath).wait();
+ _.each(headers, header => { fs.writeFile(path.join(staticLibraryHeadersPath, header), "").wait(); });
+
+ iOSProjectService.generateMobulemap(staticLibraryHeadersPath, libraryName);
+ // Read the generated modulemap and verify it.
+ let modulemap = fs.readFile(path.join(staticLibraryHeadersPath, "module.modulemap")).wait();
+ let headerCommands = _.map(headers, value => `header "${value}"`);
+ let modulemapExpectation = `module ${libraryName} { explicit module ${libraryName} { ${headerCommands.join(" ")} } }`;
+
+ assert.equal(modulemap, modulemapExpectation);
+
+ // Delete all header files. And try to regenerate modulemap. 
+ _.each(headers, header => { fs.deleteFile(path.join(staticLibraryHeadersPath, header)).wait(); });
+ iOSProjectService.generateMobulemap(staticLibraryHeadersPath, libraryName);
+
+ let error: any;
+ try {
+ modulemap = fs.readFile(path.join(staticLibraryHeadersPath, "module.modulemap")).wait();
+ } catch(err) {
+ error = err;
+ }
+
+ assert.instanceOf(error, Error, "Expect to fail, there shouldn't be a module.modulemap file.");
+	});
+});
+
+describe("Relative paths", () => {
+ it("checks for correct calculation of relative paths", () => {
+ let projectName = "projectDirectory";
+ let projectPath = temp.mkdirSync(projectName);
+ let subpath = "sub/path";
+
+ let testInjector = createTestInjector(projectPath, projectName);
+ let iOSProjectService = testInjector.resolve("iOSProjectService");
+
+ let result = iOSProjectService.getLibSubpathRelativeToProjectPath(subpath);
+ assert.equal(result, path.join("../../lib/iOS/", subpath));
+ });
+});