1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
// Copyright 2017 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org /licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.rules.objc;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.packages.Info;
import com.google.devtools.build.lib.packages.NativeProvider;
import com.google.devtools.build.lib.vfs.PathFragment;
import javax.annotation.Nullable;
/**
* Provider containing information about an Apple dynamic framework. This provider contains:
*
* <ul>
* <li>'framework_dirs': The framework path names used as link inputs in order to link against the
* dynamic framework
* <li>'framework_files': The full set of artifacts that should be included as inputs to link
* against the dynamic framework
* <li>'binary': The dylib binary artifact of the dynamic framework
* <li>'objc': An {@link ObjcProvider} which contains information about the transitive
* dependencies linked into the binary, (intended so that bundle loaders depending on this
* executable may avoid relinking symbols included in the loadable binary
* </ul>
*/
public final class AppleDynamicFrameworkProvider extends Info {
/** Skylark name for the AppleDynamicFrameworkProvider. */
public static final String SKYLARK_NAME = "AppleDynamicFramework";
/** Skylark constructor and identifier for AppleDynamicFrameworkProvider. */
public static final NativeProvider<AppleDynamicFrameworkProvider> SKYLARK_CONSTRUCTOR =
new NativeProvider<AppleDynamicFrameworkProvider>(
AppleDynamicFrameworkProvider.class, SKYLARK_NAME) {};
/** Field name for the dylib binary artifact of the dynamic framework. */
public static final String DYLIB_BINARY_FIELD_NAME = "binary";
/** Field name for the framework path names of the dynamic framework. */
public static final String FRAMEWORK_DIRS_FIELD_NAME = "framework_dirs";
/** Field name for the framework link-input artifacts of the dynamic framework. */
public static final String FRAMEWORK_FILES_FIELD_NAME = "framework_files";
/** Field name for the {@link ObjcProvider} containing dependency information. */
public static final String OBJC_PROVIDER_FIELD_NAME = "objc";
private final NestedSet<PathFragment> dynamicFrameworkDirs;
private final NestedSet<Artifact> dynamicFrameworkFiles;
private final @Nullable Artifact dylibBinary;
private final ObjcProvider depsObjcProvider;
public AppleDynamicFrameworkProvider(@Nullable Artifact dylibBinary,
ObjcProvider depsObjcProvider,
NestedSet<PathFragment> dynamicFrameworkDirs,
NestedSet<Artifact> dynamicFrameworkFiles) {
super(SKYLARK_CONSTRUCTOR,
skylarkValueMap(dylibBinary, depsObjcProvider, dynamicFrameworkDirs,
dynamicFrameworkFiles));
this.dylibBinary = dylibBinary;
this.depsObjcProvider = depsObjcProvider;
this.dynamicFrameworkDirs = dynamicFrameworkDirs;
this.dynamicFrameworkFiles = dynamicFrameworkFiles;
}
private static ImmutableMap<String, Object> skylarkValueMap(
@Nullable Artifact dylibBinary,
ObjcProvider depsObjcProvider,
NestedSet<PathFragment> dynamicFrameworkDirs,
NestedSet<Artifact> dynamicFrameworkFiles) {
ImmutableMap.Builder<String, Object> mapBuilder = ImmutableMap.<String, Object>builder()
.put(FRAMEWORK_DIRS_FIELD_NAME, dynamicFrameworkDirs)
.put(FRAMEWORK_FILES_FIELD_NAME, dynamicFrameworkFiles)
.put(OBJC_PROVIDER_FIELD_NAME, depsObjcProvider);
if (dylibBinary != null) {
mapBuilder.put(DYLIB_BINARY_FIELD_NAME, dylibBinary);
}
return mapBuilder.build();
}
/**
* Returns the framework path names used as link inputs in order to link against the dynamic
* framework.
*/
public NestedSet<PathFragment> getDynamicFrameworkDirs() {
return dynamicFrameworkDirs;
}
/**
* Returns the full set of artifacts that should be included as inputs to link against the
* dynamic framework.
*/
public NestedSet<Artifact> getDynamicFrameworkFiles() {
return dynamicFrameworkFiles;
}
/**
* Returns the multi-architecture dylib binary of the dynamic framework. May return null if
* the rule providing the framework only specified framework imports.
*/
@Nullable
public Artifact getAppleDylibBinary() {
return dylibBinary;
}
/**
* Returns the {@link ObjcProvider} which contains information about the transitive dependencies
* linked into the dylib.
*/
public ObjcProvider getDepsObjcProvider() {
return depsObjcProvider;
}
}
|