darlinghq/xcbuild
1
0
Fork 0
mirror of https://github.com/darlinghq/xcbuild.git synced 2025-02-22 17:34:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Move module map resolution to a separate class.

Browse Source 
Module maps are relatively separate from product types.
This commit is contained in:
Grant Paul 2016-07-21 18:54:54 -07:00
parent 25f784e7d8
commit 92a348d244
5 changed files with 227 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Libraries/pbxbuild/CMakeLists.txt
View File

@ -48,6 +48,7 @@ add_library(pbxbuild SHARED
Sources/Phase/CopyFilesResolver.cpp
Sources/Phase/HeadersResolver.cpp
Sources/Phase/LegacyTargetResolver.cpp
Sources/Phase/ModuleMapResolver.cpp
Sources/Phase/ProductTypeResolver.cpp
Sources/Phase/SwiftResolver.cpp
Sources/Phase/ResourcesResolver.cpp

43
Libraries/pbxbuild/Headers/pbxbuild/Phase/ModuleMapResolver.h Normal file
View File

@ -0,0 +1,43 @@
/**
Copyright (c) 2015-present, Facebook, Inc.
All rights reserved.
This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree. An additional grant
of patent rights can be found in the PATENTS file in the same directory.
*/
#ifndef __pbxbuild_Phase_ModuleMapResolver_h
#define __pbxbuild_Phase_ModuleMapResolver_h
#include <pbxbuild/Tool/Invocation.h>
#include <pbxproj/PBX/Target.h>
#include <string>
#include <ext/optional>
namespace pbxsetting { class Environment; }
namespace pbxbuild {
namespace Phase {
class Context;
class Environment;
class ModuleMapResolver {
public:
ModuleMapResolver();
~ModuleMapResolver();
public:
bool resolve(Phase::Environment const &phaseEnvironment, Phase::Context *phaseContext) const;
public:
static ext::optional<Tool::Invocation::AuxiliaryFile::Chunk>
Contents(pbxsetting::Environment const &environment, pbxproj::PBX::Target::shared_ptr const &target, std::string const &workingDirectory);
};
}
}
#endif // !__pbxbuild_Phase_ModuleMapResolver_h

174
Libraries/pbxbuild/Sources/Phase/ModuleMapResolver.cpp Normal file
View File

@ -0,0 +1,174 @@
/**
Copyright (c) 2015-present, Facebook, Inc.
All rights reserved.
This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree. An additional grant
of patent rights can be found in the PATENTS file in the same directory.
*/
#include <pbxbuild/Phase/ModuleMapResolver.h>
#include <pbxbuild/Phase/Environment.h>
#include <pbxbuild/Phase/Context.h>
#include <pbxbuild/Tool/CopyResolver.h>
#include <pbxsetting/Environment.h>
#include <pbxsetting/Type.h>
#include <libutil/FSUtil.h>
namespace Phase = pbxbuild::Phase;
namespace Tool = pbxbuild::Tool;
using libutil::FSUtil;
Phase::ModuleMapResolver::
ModuleMapResolver()
{
}
Phase::ModuleMapResolver::
~ModuleMapResolver()
{
}
static ext::optional<std::string>
FindUmbrellaHeaderName(pbxsetting::Environment const &environment, std::string const &moduleName, pbxproj::PBX::Target::shared_ptr const &target)
{
std::string lowerModuleName;
std::transform(moduleName.begin(), moduleName.end(), std::back_inserter(lowerModuleName), ::tolower);
ext::optional<std::string> umbrellaHeader;
for (pbxproj::PBX::BuildPhase::shared_ptr const &buildPhase : target->buildPhases()) {
if (buildPhase->type() != pbxproj::PBX::BuildPhase::Type::Headers) {
continue;
}
for (pbxproj::PBX::BuildFile::shared_ptr const &buildFile : buildPhase->files()) {
if (buildFile->fileRef() == nullptr) {
continue;
}
std::string filePath = environment.expand(buildFile->fileRef()->resolve());
if (FSUtil::GetFileExtension(filePath) == "h") {
std::string baseName = FSUtil::GetBaseNameWithoutExtension(filePath);
std::string lowerBaseName;
std::transform(baseName.begin(), baseName.end(), std::back_inserter(lowerBaseName), ::tolower);
if (lowerBaseName == lowerModuleName) {
return baseName;
}
}
}
}
return ext::nullopt;
}
ext::optional<Tool::Invocation::AuxiliaryFile::Chunk> Phase::ModuleMapResolver::
Contents(pbxsetting::Environment const &environment, pbxproj::PBX::Target::shared_ptr const &target, std::string const &workingDirectory)
{
std::string inputModuleMapPath = environment.resolve("MODULEMAP_FILE");
if (!inputModuleMapPath.empty()) {
/*
* Copy in the input module map as an auxiliary file.
*/
std::string path = FSUtil::ResolveRelativePath(inputModuleMapPath, workingDirectory);
return Tool::Invocation::AuxiliaryFile::Chunk::File(path);
} else {
/*
* Find umbrella header: a header with the same name as the target's module.
*/
std::string moduleName = environment.resolve("PRODUCT_MODULE_NAME");
ext::optional<std::string> umbrellaHeaderName = FindUmbrellaHeaderName(environment, moduleName, target);
if (umbrellaHeaderName) {
/*
* Generate a module map as an auxiliary file.
*/
auto contents = std::string();
contents += "framework module " + moduleName + " {\n";
contents += " umbrella header \"" + *umbrellaHeaderName + "\"\n";
contents += " \n";
contents += " export *\n";
contents += " module * { export * }\n";
contents += "}\n";
auto data = std::vector<uint8_t>(contents.begin(), contents.end());
return Tool::Invocation::AuxiliaryFile::Chunk::Data(data);
} else {
return ext::nullopt;
}
}
}
bool Phase::ModuleMapResolver::
resolve(Phase::Environment const &phaseEnvironment, Phase::Context *phaseContext) const
{
pbxsetting::Environment const &environment = phaseEnvironment.targetEnvironment().environment();
std::string const &workingDirectory = phaseContext->toolContext().workingDirectory();
/*
* Check if creating module maps is even requested.
*/
if (!pbxsetting::Type::ParseBoolean(environment.resolve("DEFINES_MODULE"))) {
return true;
}
std::string intermediateModuleMapRoot = environment.resolve("TARGET_TEMP_DIR");
// TODO: what about non-framework product types?
std::string finalModuleMapRoot = environment.resolve("TARGET_BUILD_DIR") + "/" + environment.resolve("CONTENTS_FOLDER_PATH") + "/" + "Modules";
/*
* Handle the standard module map, either copied or generated.
*/
ext::optional<Tool::Invocation::AuxiliaryFile::Chunk> contents = Contents(environment, phaseEnvironment.target(), workingDirectory);
if (contents) {
std::string intermediateModuleMapPath = intermediateModuleMapRoot + "/" + "module.modulemap";
auto moduleMapAuxiliaryFile = Tool::Invocation::AuxiliaryFile(intermediateModuleMapPath, { *contents });
/* Define source module map. */
// TODO: it would be nicer to attach this to the copy invocation created below
Tool::Invocation invocation;
invocation.auxiliaryFiles().push_back(moduleMapAuxiliaryFile);
phaseContext->toolContext().invocations().push_back(invocation);
/* Copy in the module map as part of the build. */
if (Tool::CopyResolver const *copyResolver = phaseContext->copyResolver(phaseEnvironment)) {
copyResolver->resolve(&phaseContext->toolContext(), environment, { intermediateModuleMapPath }, finalModuleMapRoot, "Ditto");
} else {
fprintf(stderr, "warning: failed to get copy tool for module map\n");
}
} else {
fprintf(stderr, "warning: target defines module, but has no umbrella header\n");
}
/*
* Handle the private module map. This module map can only be specified; it is never auto-generated.
*/
std::string inputPrivateModuleMapPath = environment.resolve("MODULEMAP_PRIVATE_FILE");
if (!inputPrivateModuleMapPath.empty()) {
/*
* Copy in the private module map.
*/
std::string intermediatePrivateModuleMapPath = intermediateModuleMapRoot + "/" + "module.private.modulemap";
auto privateModuleMapAuxiliaryFile = Tool::Invocation::AuxiliaryFile::File(
intermediatePrivateModuleMapPath,
FSUtil::ResolveRelativePath(inputPrivateModuleMapPath, workingDirectory));
/* Define source module map. */
// TODO: it would be nicer to attach this to the copy invocation created below
Tool::Invocation invocation;
invocation.auxiliaryFiles().push_back(privateModuleMapAuxiliaryFile);
phaseContext->toolContext().invocations().push_back(invocation);
/* Copy in the module map as part of the build. */
if (Tool::CopyResolver const *copyResolver = phaseContext->copyResolver(phaseEnvironment)) {
copyResolver->resolve(&phaseContext->toolContext(), environment, { intermediatePrivateModuleMapPath }, finalModuleMapRoot, "Ditto");
} else {
fprintf(stderr, "warning: failed to get copy tool for module map\n");
}
}
return true;
}

9
Libraries/pbxbuild/Sources/Phase/PhaseInvocations.cpp
View File

@ -13,6 +13,7 @@
#include <pbxbuild/Phase/CopyFilesResolver.h>
#include <pbxbuild/Phase/HeadersResolver.h>
#include <pbxbuild/Phase/LegacyTargetResolver.h>
#include <pbxbuild/Phase/ModuleMapResolver.h>
#include <pbxbuild/Phase/ProductTypeResolver.h>
#include <pbxbuild/Phase/ResourcesResolver.h>
#include <pbxbuild/Phase/FrameworksResolver.h>
@ -182,6 +183,14 @@ Create(Phase::Environment const &phaseEnvironment, pbxproj::PBX::Target::shared_
}
}
/*
* Module maps need to be generated.
*/
Phase::ModuleMapResolver moduleMap = Phase::ModuleMapResolver();
if (!moduleMap.resolve(phaseEnvironment, &phaseContext)) {
fprintf(stderr, "error: unable to resolve module map\n");
}
/*
* Swift requires the standard library be copied into the product.
*/

143
Libraries/pbxbuild/Sources/Phase/ProductTypeResolver.cpp
View File

@ -269,140 +269,6 @@ ResolveFrameworkStructure(Phase::Environment const &phaseEnvironment, Phase::Con
return true;
}
static ext::optional<std::string>
FindUmbrellaHeaderName(pbxsetting::Environment const &environment, std::string const &moduleName, pbxproj::PBX::Target::shared_ptr const &target)
{
std::string lowerModuleName;
std::transform(moduleName.begin(), moduleName.end(), std::back_inserter(lowerModuleName), ::tolower);
ext::optional<std::string> umbrellaHeader;
for (pbxproj::PBX::BuildPhase::shared_ptr const &buildPhase : target->buildPhases()) {
if (buildPhase->type() != pbxproj::PBX::BuildPhase::Type::Headers) {
continue;
}
for (pbxproj::PBX::BuildFile::shared_ptr const &buildFile : buildPhase->files()) {
if (buildFile->fileRef() == nullptr) {
continue;
}
std::string filePath = environment.expand(buildFile->fileRef()->resolve());
if (FSUtil::GetFileExtension(filePath) == "h") {
std::string baseName = FSUtil::GetBaseNameWithoutExtension(filePath);
std::string lowerBaseName;
std::transform(baseName.begin(), baseName.end(), std::back_inserter(lowerBaseName), ::tolower);
if (lowerBaseName == lowerModuleName) {
return baseName;
}
}
}
}
return ext::nullopt;
}
static ext::optional<Tool::Invocation::AuxiliaryFile::Chunk>
ModuleMapContents(pbxsetting::Environment const &environment, std::string const &workingDirectory, pbxproj::PBX::Target::shared_ptr const &target)
{
std::string inputModuleMapPath = environment.resolve("MODULEMAP_FILE");
if (!inputModuleMapPath.empty()) {
/*
* Copy in the input module map as an auxiliary file.
*/
std::string path = FSUtil::ResolveRelativePath(inputModuleMapPath, workingDirectory);
return Tool::Invocation::AuxiliaryFile::Chunk::File(path);
} else {
/*
* Find umbrella header: a header with the same name as the target's module.
*/
std::string moduleName = environment.resolve("PRODUCT_MODULE_NAME");
ext::optional<std::string> umbrellaHeaderName = FindUmbrellaHeaderName(environment, moduleName, target);
if (umbrellaHeaderName) {
/*
* Generate a module map as an auxiliary file.
*/
auto contents = std::string();
contents += "framework module " + moduleName + " {\n";
contents += " umbrella header \"" + *umbrellaHeaderName + "\"\n";
contents += " \n";
contents += " export *\n";
contents += " module * { export * }\n";
contents += "}\n";
auto data = std::vector<uint8_t>(contents.begin(), contents.end());
return Tool::Invocation::AuxiliaryFile::Chunk::Data(data);
} else {
return ext::nullopt;
}
}
}
static bool
ResolveModuleMap(Phase::Environment const &phaseEnvironment, Phase::Context *phaseContext, pbxsetting::Environment const &environment)
{
std::string const &workingDirectory = phaseContext->toolContext().workingDirectory();
std::string intermediateModuleMapRoot = environment.resolve("TARGET_TEMP_DIR");
// TODO: what about non-framework product types?
std::string finalModuleMapRoot = environment.resolve("TARGET_BUILD_DIR") + "/" + environment.resolve("CONTENTS_FOLDER_PATH") + "/" + "Modules";
/*
* Handle the standard module map, either copied or generated.
*/
ext::optional<Tool::Invocation::AuxiliaryFile::Chunk> contents = ModuleMapContents(environment, workingDirectory, phaseEnvironment.target());
if (contents) {
std::string intermediateModuleMapPath = intermediateModuleMapRoot + "/" + "module.modulemap";
auto moduleMapAuxiliaryFile = Tool::Invocation::AuxiliaryFile(intermediateModuleMapPath, { *contents });
/* Define source module map. */
// TODO: it would be nicer to attach this to the copy invocation created below
Tool::Invocation invocation;
invocation.auxiliaryFiles().push_back(moduleMapAuxiliaryFile);
phaseContext->toolContext().invocations().push_back(invocation);
/* Copy in the module map as part of the build. */
if (Tool::CopyResolver const *copyResolver = phaseContext->copyResolver(phaseEnvironment)) {
copyResolver->resolve(&phaseContext->toolContext(), environment, { intermediateModuleMapPath }, finalModuleMapRoot, "Ditto");
} else {
fprintf(stderr, "warning: failed to get copy tool for module map\n");
}
} else {
fprintf(stderr, "warning: target defines module, but has no umbrella header\n");
}
/*
* Handle the private module map. This module map can only be specified; it is never auto-generated.
*/
std::string inputPrivateModuleMapPath = environment.resolve("MODULEMAP_PRIVATE_FILE");
if (!inputPrivateModuleMapPath.empty()) {
/*
* Copy in the private module map.
*/
std::string intermediatePrivateModuleMapPath = intermediateModuleMapRoot + "/" + "module.private.modulemap";
auto privateModuleMapAuxiliaryFile = Tool::Invocation::AuxiliaryFile::File(
intermediatePrivateModuleMapPath,
FSUtil::ResolveRelativePath(inputPrivateModuleMapPath, workingDirectory));
/* Define source module map. */
// TODO: it would be nicer to attach this to the copy invocation created below
Tool::Invocation invocation;
invocation.auxiliaryFiles().push_back(privateModuleMapAuxiliaryFile);
phaseContext->toolContext().invocations().push_back(invocation);
/* Copy in the module map as part of the build. */
if (Tool::CopyResolver const *copyResolver = phaseContext->copyResolver(phaseEnvironment)) {
copyResolver->resolve(&phaseContext->toolContext(), environment, { intermediatePrivateModuleMapPath }, finalModuleMapRoot, "Ditto");
} else {
fprintf(stderr, "warning: failed to get copy tool for module map\n");
}
}
return true;
}
bool Phase::ProductTypeResolver::
resolve(Phase::Environment const &phaseEnvironment, Phase::Context *phaseContext) const
{
@ -469,15 +335,6 @@ resolve(Phase::Environment const &phaseEnvironment, Phase::Context *phaseContext
}
}
/*
* Create the product's module maps, if required.
*/
if (pbxsetting::Type::ParseBoolean(environment.resolve("DEFINES_MODULE"))) {
if (!ResolveModuleMap(phaseEnvironment, phaseContext, environment)) {
return false;
}
}
/*
* Validate the product; specific checks are in the validation tool.
*/