blob: b80c8ec9b0ee2002a00c10389dc79e3a53a6161d (
plain)
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
|
// Copyright 2014 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.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.TransitiveInfoProvider;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
/**
* This provider is exported by java_library rules and proto_library rules with attribute
* "j2objc_api_version=1" to support distributed J2ObjC translation and proto compilation.
*/
@Immutable
public final class J2ObjcMappingFileProvider implements TransitiveInfoProvider {
private final NestedSet<Artifact> headerMappingFiles;
private final NestedSet<Artifact> classMappingFiles;
private final NestedSet<Artifact> dependencyMappingFiles;
/**
* Constructs a {@link J2ObjcMappingFileProvider} with mapping files to export mappings required
* by J2ObjC translation and proto compilation.
*
* @param headerMappingFiles a nested set of header mapping files which map Java classes to
* their associated translated ObjC header. Used by J2ObjC to output correct import directives
* during translation.
* @param classMappingFiles a nested set of class mapping files which map Java class names to
* their associated ObjC class names. Used to support J2ObjC package prefixes.
* @param dependencyMappingFiles a nested set of dependency mapping files which map translated
* ObjC files to their translated direct dependency files. Used to support J2ObjC dead code
* analysis and removal.
*/
public J2ObjcMappingFileProvider(NestedSet<Artifact> headerMappingFiles,
NestedSet<Artifact> classMappingFiles, NestedSet<Artifact> dependencyMappingFiles) {
this.headerMappingFiles = headerMappingFiles;
this.classMappingFiles = classMappingFiles;
this.dependencyMappingFiles = dependencyMappingFiles;
}
/**
* Returns the ObjC header to Java type mapping files for J2ObjC translation. J2ObjC needs these
* mapping files to be able to output translated files with correct header import paths in the
* same directories of the Java source files.
*/
public NestedSet<Artifact> getHeaderMappingFiles() {
return headerMappingFiles;
}
/**
* Returns the Java class name to ObjC class name mapping files. J2ObjC transpiler and J2ObjC
* proto plugin needs this mapping files to support "objc_class_prefix" proto option, which sets
* the ObjC class prefix on generated protos.
*/
public NestedSet<Artifact> getClassMappingFiles() {
return classMappingFiles;
}
/**
* Returns the mapping files containing file dependency information among the translated ObjC
* source files. They are used to strip unused translated files before the compilation and linking
* actions at binary level.
*/
public NestedSet<Artifact> getDependencyMappingFiles() {
return dependencyMappingFiles;
}
/**
* A builder for this provider that is optimized for collection information from transitive
* dependencies.
*/
public static final class Builder {
private final NestedSetBuilder<Artifact> headerMappingFiles = NestedSetBuilder.stableOrder();
private final NestedSetBuilder<Artifact> classMappingFiles = NestedSetBuilder.stableOrder();
private final NestedSetBuilder<Artifact> depEntryFiles = NestedSetBuilder.stableOrder();
public Builder addTransitive(J2ObjcMappingFileProvider provider) {
headerMappingFiles.addTransitive(provider.getHeaderMappingFiles());
classMappingFiles.addTransitive(provider.getClassMappingFiles());
depEntryFiles.addTransitive(provider.getDependencyMappingFiles());
return this;
}
public J2ObjcMappingFileProvider build() {
return new J2ObjcMappingFileProvider(
headerMappingFiles.build(), classMappingFiles.build(), depEntryFiles.build());
}
}
}
|