blob: 7d37f10c5077a4549b836a559d37a63f9ffcd034 (
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
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
// 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.packages;
import com.google.common.base.Verify;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.LabelSyntaxException;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.vfs.PathFragment;
/**
* A class that represents some packages that are included in the visibility list of a rule.
*/
public abstract class PackageSpecification {
private static final String PACKAGE_LABEL = "__pkg__";
private static final String SUBTREE_LABEL = "__subpackages__";
private static final String ALL_BENEATH_SUFFIX = "/...";
public static final PackageSpecification EVERYTHING =
new PackageSpecification() {
@Override
public boolean containsPackage(PackageIdentifier packageName) {
return true;
}
@Override
protected String asString() {
return "//...";
}
};
public abstract boolean containsPackage(PackageIdentifier packageName);
@Override
public int hashCode() {
return asString().hashCode();
}
@Override
public final String toString() {
return asString();
}
protected abstract String asString();
@Override
public boolean equals(Object that) {
if (this == that) {
return true;
}
if (!(that instanceof PackageSpecification)) {
return false;
}
return this.asString().equals(((PackageSpecification) that).asString());
}
/**
* Parses a string as a visibility specification.
* Throws {@link InvalidPackageSpecificationException} if the label cannot be parsed.
*
* <p>Note that these strings are different from what {@link #fromLabel} understands.
*/
public static PackageSpecification fromString(Label context, final String spec)
throws InvalidPackageSpecificationException {
String result = spec;
boolean allBeneath = false;
if (result.endsWith(ALL_BENEATH_SUFFIX)) {
allBeneath = true;
result = result.substring(0, result.length() - ALL_BENEATH_SUFFIX.length());
if (result.equals("/")) {
// Special case: //... will not end in /...
return EVERYTHING;
}
}
if (!spec.startsWith("//")) {
throw new InvalidPackageSpecificationException("invalid package name '" + spec
+ "': must start with '//'");
}
PackageIdentifier packageId;
try {
packageId = PackageIdentifier.parse(result);
} catch (LabelSyntaxException e) {
throw new InvalidPackageSpecificationException(
"invalid package name '" + spec + "': " + e.getMessage());
}
Verify.verify(packageId.getRepository().isDefault());
packageId = PackageIdentifier.create(
context.getPackageIdentifier().getRepository(), packageId.getPackageFragment());
return allBeneath ?
new AllPackagesBeneath(packageId) :
new SinglePackage(packageId);
}
/**
* Parses a label as a visibility specification. returns null if the label cannot be parsed.
*
* <p>Note that these strings are different from what {@link #fromString} understands.
*/
public static PackageSpecification fromLabel(Label label) {
if (label.getName().equals(PACKAGE_LABEL)) {
return new SinglePackage(label.getPackageIdentifier());
} else if (label.getName().equals(SUBTREE_LABEL)) {
return new AllPackagesBeneath(label.getPackageIdentifier());
} else {
return null;
}
}
private static class SinglePackage extends PackageSpecification {
private PackageIdentifier singlePackageName;
public SinglePackage(PackageIdentifier packageName) {
this.singlePackageName = packageName;
}
@Override
public boolean containsPackage(PackageIdentifier packageName) {
return this.singlePackageName.equals(packageName);
}
@Override
protected String asString() {
return singlePackageName.toString();
}
}
private static class AllPackagesBeneath extends PackageSpecification {
private PackageIdentifier prefix;
public AllPackagesBeneath(PackageIdentifier prefix) {
this.prefix = prefix;
}
@Override
public boolean containsPackage(PackageIdentifier packageName) {
return packageName.getRepository().equals(prefix.getRepository())
&& packageName.getPackageFragment().startsWith(prefix.getPackageFragment());
}
@Override
protected String asString() {
return prefix.equals(new PathFragment("")) ? "..." : prefix + "/...";
}
}
/**
* Exception class to be thrown when a specification cannot be parsed.
*/
public static class InvalidPackageSpecificationException extends Exception {
public InvalidPackageSpecificationException(String message) {
super(message);
}
}
}
|
