Examples with TargetControl com.google.devtools.build.xcode.xcodegen.proto.XcodeGenProtos.TargetControl used on opensource projects

Example 1 with TargetControl

use of com.google.devtools.build.xcode.xcodegen.proto.XcodeGenProtos.TargetControl in project bazel by bazelbuild.

the class XcodeProvider method targetControl.

private TargetControl targetControl() {
    String buildFilePath = label.getPackageFragment().getSafePathString() + "/BUILD";
    NestedSet<String> userHeaderSearchPaths = NestedSetBuilder.<String>linkOrder().addTransitive(propagatedUserHeaderSearchPaths).addTransitive(nonPropagatedUserHeaderSearchPaths).addTransitive(strictlyPropagatedUserHeaderSearchPaths).build();
    NestedSet<String> headerSearchPaths = NestedSetBuilder.<String>linkOrder().addTransitive(propagatedHeaderSearchPaths).addTransitive(nonPropagatedHeaderSearchPaths).addTransitive(strictlyPropagatedHeaderSearchPaths).build();
    // Automatic SDK frameworks are no longer propagated through ObjcProvider; they are now added
    // during the link action. To preserve the existing Xcode project generation, we need to add
    // them to the Xcode target below, unless it is a watchOS 1 application.
    Set<SdkFramework> automaticSdkFrameworks = (productType != WATCH_OS1_APPLICATION) ? ImmutableSet.copyOf(AUTOMATIC_SDK_FRAMEWORKS) : ImmutableSet.<SdkFramework>of();
    // TODO(bazel-team): Add provisioning profile information when Xcodegen supports it.
    TargetControl.Builder targetControl = TargetControl.newBuilder().setName(label.getName()).setLabel(xcodeTargetName(label)).setProductType(productType.getIdentifier()).addSupportFile(buildFilePath).addAllImportedLibrary(Artifact.toExecPaths(objcProvider.get(IMPORTED_LIBRARY))).addAllImportedLibrary(Artifact.toExecPaths(ccLibraries(objcProvider))).addAllUserHeaderSearchPath(userHeaderSearchPaths).addAllHeaderSearchPath(headerSearchPaths).addAllSupportFile(Artifact.toExecPaths(headers)).addAllCopt(compilationModeCopts).addAllCopt(CompilationSupport.DEFAULT_COMPILER_FLAGS).addAllCopt(Interspersing.prependEach("-D", objcProvider.get(DEFINE))).addAllCopt(copts).addAllLinkopt(Interspersing.beforeEach("-force_load", objcProvider.get(FORCE_LOAD_FOR_XCODEGEN))).addAllLinkopt(CompilationSupport.DEFAULT_LINKER_FLAGS).addAllLinkopt(Interspersing.beforeEach("-weak_framework", SdkFramework.names(objcProvider.get(WEAK_SDK_FRAMEWORK)))).addAllBuildSetting(xcodeprojBuildSettings).addAllBuildSetting(AppleToolchain.defaultWarningsForXcode()).addAllSdkFramework(SdkFramework.names(automaticSdkFrameworks)).addAllSdkFramework(SdkFramework.names(objcProvider.get(SDK_FRAMEWORK))).addAllFramework(PathFragment.safePathStrings(objcProvider.get(STATIC_FRAMEWORK_DIR))).addAllFrameworkSearchPathOnly(PathFragment.safePathStrings(objcProvider.get(FRAMEWORK_SEARCH_PATH_ONLY))).addAllXcassetsDir(PathFragment.safePathStrings(objcProvider.get(XCASSETS_DIR))).addAllXcdatamodel(PathFragment.safePathStrings(Xcdatamodels.datamodelDirs(objcProvider.get(XCDATAMODEL)))).addAllBundleImport(PathFragment.safePathStrings(objcProvider.get(BUNDLE_IMPORT_DIR))).addAllSdkDylib(objcProvider.get(SDK_DYLIB)).addAllGeneralResourceFile(Artifact.toExecPaths(objcProvider.get(GENERAL_RESOURCE_FILE))).addAllGeneralResourceFile(PathFragment.safePathStrings(objcProvider.get(GENERAL_RESOURCE_DIR)));
    if (CAN_LINK_PRODUCT_TYPES.contains(productType)) {
        // For builds with --ios_multi_cpus set, we may have several copies of some XCodeProviders
        // in the dependencies (one per cpu architecture). We deduplicate the corresponding
        // xcode target names with a LinkedHashSet before adding to the TargetControl.
        Set<String> jreTargetNames = new HashSet<>();
        for (XcodeProvider jreDependency : jreDependencies) {
            jreTargetNames.add(jreDependency.dependencyXcodeTargetName());
        }
        Set<DependencyControl> dependencySet = new LinkedHashSet<>();
        Set<DependencyControl> jreDependencySet = new LinkedHashSet<>();
        for (XcodeProvider dependency : propagatedDependencies) {
            // Only add a library target to a binary's dependencies if it has source files to compile
            // and it is not from the "non_propagated_deps" attribute. Xcode cannot build targets
            // without a source file in the PBXSourceFilesBuildPhase, so if such a target is present in
            // the control file, it is only to get Xcodegen to put headers and resources not used by the
            // final binary in the Project Navigator.
            //
            // The exceptions to this rule are objc_bundle_library and ios_extension targets. Bundles
            // are generally used for resources and can lack a PBXSourceFilesBuildPhase in the project
            // file and still be considered valid by Xcode.
            //
            // ios_extension targets are an exception because they have no CompilationArtifact object
            // but do have a dummy source file to make Xcode happy.
            boolean hasSources = dependency.compilationArtifacts.isPresent() && dependency.compilationArtifacts.get().getArchive().isPresent();
            if (hasSources || (dependency.productType == XcodeProductType.BUNDLE || (dependency.productType == XcodeProductType.WATCH_OS1_APPLICATION))) {
                String dependencyXcodeTargetName = dependency.dependencyXcodeTargetName();
                Set<DependencyControl> set = jreTargetNames.contains(dependencyXcodeTargetName) ? jreDependencySet : dependencySet;
                set.add(DependencyControl.newBuilder().setTargetLabel(dependencyXcodeTargetName).build());
            }
        }
        for (DependencyControl dependencyControl : dependencySet) {
            targetControl.addDependency(dependencyControl);
        }
        // Make sure that JRE dependencies are ordered after other propagated dependencies.
        for (DependencyControl dependencyControl : jreDependencySet) {
            targetControl.addDependency(dependencyControl);
        }
    }
    for (XcodeProvider justTestHost : testHost.asSet()) {
        targetControl.addDependency(DependencyControl.newBuilder().setTargetLabel(xcodeTargetName(justTestHost.label)).setTestHost(true).build());
    }
    for (XcodeProvider extension : extensions) {
        targetControl.addDependency(DependencyControl.newBuilder().setTargetLabel(xcodeTargetName(extension.label)).build());
    }
    if (bundleInfoplist.isPresent()) {
        targetControl.setInfoplist(bundleInfoplist.get().getExecPathString());
    }
    for (CompilationArtifacts artifacts : compilationArtifacts.asSet()) {
        targetControl.addAllSourceFile(Artifact.toExecPaths(artifacts.getSrcs())).addAllSupportFile(Artifact.toExecPaths(artifacts.getAdditionalHdrs())).addAllSupportFile(Artifact.toExecPaths(artifacts.getPrivateHdrs())).addAllNonArcSourceFile(Artifact.toExecPaths(artifacts.getNonArcSrcs()));
        for (Artifact pchFile : artifacts.getPchFile().asSet()) {
            targetControl.setPchPath(pchFile.getExecPathString()).addSupportFile(pchFile.getExecPathString());
        }
    }
    for (Artifact artifact : additionalSources) {
        targetControl.addSourceFile(artifact.getExecPathString());
    }
    if (objcProvider.is(Flag.USES_CPP)) {
        targetControl.addSdkDylib("libc++");
    }
    return targetControl.build();
}

Example 2 with TargetControl

use of com.google.devtools.build.xcode.xcodegen.proto.XcodeGenProtos.TargetControl in project bazel by bazelbuild.

the class XcodeprojGeneration method xcodeproj.

/** Generates a project file. */
public static PBXProject xcodeproj(Path workspaceRoot, Control control, Iterable<PbxReferencesProcessor> postProcessors) {
    checkArgument(control.hasPbxproj(), "Must set pbxproj field on control proto.");
    FileSystem fileSystem = workspaceRoot.getFileSystem();
    XcodeprojPath<Path> outputPath = XcodeprojPath.converter().fromPath(RelativePaths.fromString(fileSystem, control.getPbxproj()));
    NSDictionary projBuildConfigMap = new NSDictionary();
    projBuildConfigMap.put("ARCHS", cpuArchitectures(control.getCpuArchitectureList()));
    projBuildConfigMap.put("VALID_ARCHS", new NSArray(new NSString("armv7"), new NSString("armv7s"), new NSString("arm64"), new NSString("i386"), new NSString("x86_64")));
    projBuildConfigMap.put("CLANG_ENABLE_OBJC_ARC", "YES");
    projBuildConfigMap.put("SDKROOT", "iphoneos");
    projBuildConfigMap.put("IPHONEOS_DEPLOYMENT_TARGET", "7.0");
    projBuildConfigMap.put("GCC_VERSION", "com.apple.compilers.llvm.clang.1_0");
    projBuildConfigMap.put("CODE_SIGN_IDENTITY[sdk=iphoneos*]", "iPhone Developer");
    // Disable bitcode for now.
    // TODO(bazel-team): Need to re-enable once we have real Xcode 7 support.
    projBuildConfigMap.put("ENABLE_BITCODE", "NO");
    for (XcodeprojBuildSetting projectSetting : control.getBuildSettingList()) {
        projBuildConfigMap.put(projectSetting.getName(), projectSetting.getValue());
    }
    PBXProject project = new PBXProject(outputPath.getProjectName());
    project.getMainGroup().setPath(workspaceRoot.toString());
    if (workspaceRoot.isAbsolute()) {
        project.getMainGroup().setSourceTree(SourceTree.ABSOLUTE);
    }
    try {
        project.getBuildConfigurationList().getBuildConfigurationsByName().get(DEFAULT_OPTIONS_NAME).setBuildSettings(projBuildConfigMap);
    } catch (ExecutionException e) {
        throw new RuntimeException(e);
    }
    Map<String, TargetInfo> targetInfoByLabel = new HashMap<>();
    List<String> usedTargetNames = new ArrayList<>();
    PBXFileReferences fileReferences = new PBXFileReferences();
    LibraryObjects libraryObjects = new LibraryObjects(fileReferences);
    PBXBuildFiles pbxBuildFiles = new PBXBuildFiles(fileReferences);
    Resources resources = Resources.fromTargetControls(fileSystem, pbxBuildFiles, control.getTargetList());
    Xcdatamodels xcdatamodels = Xcdatamodels.fromTargetControls(fileSystem, pbxBuildFiles, control.getTargetList());
    // We use a hash set for the Project Navigator files so that the same PBXFileReference does not
    // get added twice. Because PBXFileReference uses equality-by-identity semantics, this requires
    // the PBXFileReferences cache to properly return the same reference for functionally-equivalent
    // files.
    Set<PBXReference> projectNavigatorFiles = new LinkedHashSet<>();
    for (TargetControl targetControl : control.getTargetList()) {
        checkArgument(targetControl.hasName(), "TargetControl requires a name: %s", targetControl);
        checkArgument(targetControl.hasLabel(), "TargetControl requires a label: %s", targetControl);
        ProductType productType = productType(targetControl);
        Preconditions.checkArgument((productType != ProductType.APPLICATION) || hasAtLeastOneCompilableSource(targetControl), APP_NEEDS_SOURCE_ERROR);
        PBXSourcesBuildPhase sourcesBuildPhase = new PBXSourcesBuildPhase();
        for (SourceFile source : SourceFile.allSourceFiles(fileSystem, targetControl)) {
            PBXFileReference fileRef = fileReferences.get(FileReference.of(source.path().toString(), SourceTree.GROUP));
            projectNavigatorFiles.add(fileRef);
            if (Equaling.of(source.buildType(), BuildType.NO_BUILD)) {
                continue;
            }
            PBXBuildFile buildFile = new PBXBuildFile(fileRef);
            if (Equaling.of(source.buildType(), BuildType.NON_ARC_BUILD)) {
                buildFile.setSettings(Optional.of(nonArcCompileSettings()));
            }
            sourcesBuildPhase.getFiles().add(buildFile);
        }
        sourcesBuildPhase.getFiles().addAll(xcdatamodels.buildFiles().get(targetControl));
        PBXFileReference productReference = fileReferences.get(productReference(targetControl));
        projectNavigatorFiles.add(productReference);
        NSDictionary targetBuildConfigMap = new NSDictionary();
        // TODO(bazel-team): Stop adding the workspace root automatically once the
        // released version of Bazel starts passing it.
        targetBuildConfigMap.put("USER_HEADER_SEARCH_PATHS", headerSearchPaths(plus(targetControl.getUserHeaderSearchPathList(), "$(WORKSPACE_ROOT)")));
        targetBuildConfigMap.put("HEADER_SEARCH_PATHS", headerSearchPaths(plus(targetControl.getHeaderSearchPathList(), "$(inherited)")));
        targetBuildConfigMap.put("FRAMEWORK_SEARCH_PATHS", frameworkSearchPaths(Iterables.concat(targetControl.getFrameworkList(), targetControl.getFrameworkSearchPathOnlyList())));
        targetBuildConfigMap.put("WORKSPACE_ROOT", workspaceRoot.toString());
        if (targetControl.hasPchPath()) {
            targetBuildConfigMap.put("GCC_PREFIX_HEADER", "$(WORKSPACE_ROOT)/" + targetControl.getPchPath());
        }
        targetBuildConfigMap.put("PRODUCT_NAME", productName(targetControl));
        if (targetControl.hasInfoplist()) {
            targetBuildConfigMap.put("INFOPLIST_FILE", "$(WORKSPACE_ROOT)/" + targetControl.getInfoplist());
        }
        // Double-quotes in copt strings need to be escaped for XCode.
        if (targetControl.getCoptCount() > 0) {
            List<String> escapedCopts = Lists.transform(targetControl.getCoptList(), QUOTE_ESCAPER.asFunction());
            targetBuildConfigMap.put("OTHER_CFLAGS", NSObject.wrap(escapedCopts));
        }
        targetBuildConfigMap.put("OTHER_LDFLAGS", NSObject.wrap(otherLdflags(targetControl)));
        for (XcodeprojBuildSetting setting : targetControl.getBuildSettingList()) {
            String name = setting.getName();
            String value = setting.getValue();
            // TODO(bazel-team): Remove this hack after next Bazel release.
            if (name.equals("CODE_SIGN_ENTITLEMENTS") && !value.startsWith("$")) {
                value = "$(WORKSPACE_ROOT)/" + value;
            }
            targetBuildConfigMap.put(name, value);
        }
        // Note that HFS+ (the Mac filesystem) is usually case insensitive, so we cast all target
        // names to lower case before checking for duplication because otherwise users may end up
        // having duplicated intermediate build directories that can interfere with the build.
        String targetName = targetControl.getName();
        String targetNameInLowerCase = targetName.toLowerCase();
        if (usedTargetNames.contains(targetNameInLowerCase)) {
            // Use the label in the odd case where we have two targets with the same name.
            targetName = targetControl.getLabel();
            targetNameInLowerCase = targetName.toLowerCase();
        }
        checkState(!usedTargetNames.contains(targetNameInLowerCase), "Name (case-insensitive) already exists for target with label/name %s/%s in list: %s", targetControl.getLabel(), targetControl.getName(), usedTargetNames);
        usedTargetNames.add(targetNameInLowerCase);
        PBXNativeTarget target = new PBXNativeTarget(targetName, productType);
        try {
            target.getBuildConfigurationList().getBuildConfigurationsByName().get(DEFAULT_OPTIONS_NAME).setBuildSettings(targetBuildConfigMap);
        } catch (ExecutionException e) {
            throw new RuntimeException(e);
        }
        target.setProductReference(productReference);
        // We only add frameworks here and not dylibs because of differences in how
        // Xcode 6 and Xcode 7 specify dylibs in the project organizer.
        // (Xcode 6 -> *.dylib, Xcode 7 -> *.tbd)
        PBXFrameworksBuildPhase frameworksPhase = buildFrameworksInfo(libraryObjects, targetControl);
        PBXResourcesBuildPhase resourcesPhase = resources.resourcesBuildPhase(targetControl);
        for (String importedArchive : targetControl.getImportedLibraryList()) {
            PBXFileReference fileReference = fileReferences.get(FileReference.of(importedArchive, SourceTree.GROUP).withExplicitFileType(FILE_TYPE_ARCHIVE_LIBRARY));
            projectNavigatorFiles.add(fileReference);
        }
        project.getTargets().add(target);
        target.getBuildPhases().add(frameworksPhase);
        target.getBuildPhases().add(sourcesBuildPhase);
        target.getBuildPhases().add(resourcesPhase);
        checkState(!Mapping.of(targetInfoByLabel, targetControl.getLabel()).isPresent(), "Mapping already exists for target with label %s in map: %s", targetControl.getLabel(), targetInfoByLabel);
        targetInfoByLabel.put(targetControl.getLabel(), new TargetInfo(targetControl, target, frameworksPhase, resourcesPhase, new PBXBuildFile(productReference), new LocalPBXTargetDependency(new LocalPBXContainerItemProxy(project, target, ProxyType.TARGET_REFERENCE)), targetBuildConfigMap));
    }
    for (HasProjectNavigatorFiles references : ImmutableList.of(pbxBuildFiles, libraryObjects)) {
        Iterables.addAll(projectNavigatorFiles, references.mainGroupReferences());
    }
    Iterable<PBXReference> processedProjectFiles = projectNavigatorFiles;
    for (PbxReferencesProcessor postProcessor : postProcessors) {
        processedProjectFiles = postProcessor.process(processedProjectFiles);
    }
    Iterables.addAll(project.getMainGroup().getChildren(), processedProjectFiles);
    for (TargetInfo targetInfo : targetInfoByLabel.values()) {
        TargetControl targetControl = targetInfo.control;
        for (DependencyControl dependency : targetControl.getDependencyList()) {
            targetInfo.addDependencyInfo(dependency, targetInfoByLabel);
        }
        if (!Equaling.of(ProductType.STATIC_LIBRARY, productType(targetControl)) && !targetControl.getImportedLibraryList().isEmpty()) {
            // We add a script build phase to copy the imported libraries to BUILT_PRODUCT_DIR with
            // unique names before linking them to work around an Xcode issue where imported libraries
            // with duplicated names lead to link errors.
            //
            // Internally Xcode uses linker flag -l{LIBRARY_NAME} to link a particular library and
            // delegates to the linker to locate the actual library using library search paths. So given
            // two imported libraries with the same name: a/b/libfoo.a, c/d/libfoo.a, Xcode uses
            // duplicate linker flag -lfoo to link both of the libraries. Depending on the order of
            // the library search paths, the linker will only be able to locate and link one of the
            // libraries.
            //
            // With this workaround using a script build phase, all imported libraries to link have
            // unique names. For the previous example with a/b/libfoo.a and c/d/libfoo.a, the script
            // build phase will copy them to BUILT_PRODUCTS_DIR with unique names libfoo_b_a.a and
            // libfoo_d_c.a, respectively. The linker flags Xcode uses to link them will be
            // -lfoo_d_c and -lfoo_b_a, with no duplication.
            PBXShellScriptBuildPhase scriptBuildPhase = new PBXShellScriptBuildPhase();
            scriptBuildPhase.setShellScript("for ((i=0; i < ${SCRIPT_INPUT_FILE_COUNT}; i++)) do\n" + "  INPUT_FILE=\"SCRIPT_INPUT_FILE_${i}\"\n" + "  OUTPUT_FILE=\"SCRIPT_OUTPUT_FILE_${i}\"\n" + "  cp -v -f \"${!INPUT_FILE}\" \"${!OUTPUT_FILE}\"\n" + "done");
            for (String importedLibrary : targetControl.getImportedLibraryList()) {
                String uniqueImportedLibrary = uniqueImportedLibraryName(importedLibrary);
                scriptBuildPhase.getInputPaths().add("$(WORKSPACE_ROOT)/" + importedLibrary);
                scriptBuildPhase.getOutputPaths().add("$(BUILT_PRODUCTS_DIR)/" + uniqueImportedLibrary);
                FileReference fileReference = FileReference.of(uniqueImportedLibrary, SourceTree.BUILT_PRODUCTS_DIR).withExplicitFileType(FILE_TYPE_ARCHIVE_LIBRARY);
                targetInfo.frameworksPhase.getFiles().add(pbxBuildFiles.getStandalone(fileReference));
            }
            targetInfo.nativeTarget.getBuildPhases().add(scriptBuildPhase);
        }
    }
    return project;
}

Example 3 with TargetControl

use of com.google.devtools.build.xcode.xcodegen.proto.XcodeGenProtos.TargetControl in project bazel by bazelbuild.

the class Resources method fromTargetControls.

public static Resources fromTargetControls(FileSystem fileSystem, PBXBuildFiles pbxBuildFiles, Iterable<TargetControl> targetControls) {
    ImmutableSetMultimap.Builder<TargetControl, PBXBuildFile> buildFiles = new ImmutableSetMultimap.Builder<>();
    for (TargetControl targetControl : targetControls) {
        List<PBXBuildFile> targetBuildFiles = new ArrayList<>();
        Iterable<String> simpleImports = Iterables.concat(targetControl.getXcassetsDirList(), targetControl.getBundleImportList());
        // bundle and link it properly, and add the {@code lastKnownFileType} property.
        for (String simpleImport : simpleImports) {
            targetBuildFiles.add(pbxBuildFiles.getStandalone(FileReference.of(simpleImport, SourceTree.GROUP)));
        }
        Iterables.addAll(targetBuildFiles, pbxBuildFiles.get(AggregateReferenceType.PBXVariantGroup, RelativePaths.fromStrings(fileSystem, targetControl.getGeneralResourceFileList())));
        // references we generated with fileObjects will be added to the main group later.
        if (!Equaling.of(ProductType.STATIC_LIBRARY, XcodeprojGeneration.productType(targetControl))) {
            buildFiles.putAll(targetControl, targetBuildFiles);
        }
    }
    return new Resources(buildFiles.build());
}