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
124
125
126
127
128
129
130
131
|
// 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.proto;
import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableList;
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.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
// TODO(carmi): Rename the class to ProtoInfoProvider.
/**
* Configured target classes that implement this class can contribute .proto files to the
* compilation of proto_library rules.
*/
@AutoValue
@Immutable
@SkylarkModule(name = "ProtoSourcesProvider", doc = "")
public abstract class ProtoSourcesProvider implements TransitiveInfoProvider {
/** The name of the field in Skylark used to access this class. */
public static final String SKYLARK_NAME = "proto";
public static ProtoSourcesProvider create(
NestedSet<Artifact> transitiveImports,
NestedSet<Artifact> transitiveProtoSources,
ImmutableList<Artifact> protoSources,
NestedSet<Artifact> checkDepsProtoSources,
Artifact directDescriptorSet,
NestedSet<Artifact> transitiveDescriptorSets) {
return new AutoValue_ProtoSourcesProvider(
transitiveImports,
transitiveProtoSources,
protoSources,
checkDepsProtoSources,
directDescriptorSet,
transitiveDescriptorSets);
}
/**
* Transitive imports including weak dependencies This determines the order of "-I" arguments to
* the protocol compiler, and that is probably important
*/
@SkylarkCallable(
name = "transitive_imports",
doc = "Transitive imports including weak dependencies.",
structField = true
)
public abstract NestedSet<Artifact> getTransitiveImports();
/** Returns the proto sources for this rule and all its dependent protocol buffer rules. */
@SkylarkCallable(
name = "transitive_sources",
doc = "Proto sources for this rule and all its dependent protocol buffer rules.",
structField = true
)
// TODO(bazel-team): The difference between transitive imports and transitive proto sources
// should never be used by Skylark or by an Aspect. One of these two should be removed,
// preferably soon, before Skylark users start depending on them.
public abstract NestedSet<Artifact> getTransitiveProtoSources();
/** Returns the proto sources from the 'srcs' attribute. */
@SkylarkCallable(
name = "direct_sources",
doc = "Proto sources from the 'srcs' attribute.",
structField = true
)
public abstract ImmutableList<Artifact> getDirectProtoSources();
/**
* Returns the proto sources from the 'srcs' attribute. If the library is a proxy library that has
* no sources, return the sources from the direct deps.
*
* <p>This must be a set to avoid collecting the same source twice when depending on 2 proxy
* proto_library's that depend on the same proto_library.
*/
@SkylarkCallable(
name = "check_deps_sources",
doc =
"Proto sources from the 'srcs' attribute. If the library is a proxy library "
+ "that has no sources, it contains the check_deps_sources "
+ "from this library's direct deps.",
structField = true
)
public abstract NestedSet<Artifact> getCheckDepsProtoSources();
/**
* Be careful while using this artifact - it is the parsing of the transitive set of .proto files.
* It's possible to cause a O(n^2) behavior, where n is the length of a proto chain-graph.
* (remember that proto-compiler reads all transitive .proto files, even when producing the
* direct-srcs descriptor set)
*/
@SkylarkCallable(
name = "direct_descriptor_set",
doc = "The FileDescriptorSet of the direct sources. If no srcs, contains an empty file. ",
structField = true
)
public abstract Artifact directDescriptorSet();
/**
* Be careful while using this artifact - it is the parsing of the transitive set of .proto files.
* It's possible to cause a O(n^2) behavior, where n is the length of a proto chain-graph.
* (remember that proto-compiler reads all transitive .proto files, even when producing the
* direct-srcs descriptor set)
*/
@SkylarkCallable(
name = "transitive_descriptor_sets",
doc =
"A set of FileDescriptorSet files of all dependent proto_library rules, and this one's. "
+ "This is not the same as passing --include_imports to proto-compiler. "
+ "Will be empty if no dependencies. ",
structField = true
)
public abstract NestedSet<Artifact> transitiveDescriptorSets();
ProtoSourcesProvider() {}
}
|
