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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
// Copyright 2014 Google Inc. 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.syntax;
import com.google.common.base.Functions;
import com.google.common.base.Preconditions;
import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableList.Builder;
import com.google.common.collect.Iterables;
import java.util.List;
import javax.annotation.Nullable;
/**
* Either the arguments to a glob call (the include and exclude lists) or the
* contents of a fixed list that was appended to a list of glob results.
* (The latter need to be stored by {@link GlobList} in order to fully
* reproduce the inputs that created the output list.)
*
* <p>For example, the expression
* <code>glob(['*.java']) + ['x.properties']</code>
* will result in two GlobCriteria: one has include = ['*.java'], glob = true
* and the other, include = ['x.properties'], glob = false.
*/
public class GlobCriteria {
/**
* A list of names or patterns that are included by this glob. They should
* consist of characters that are valid in labels in the BUILD language.
*/
private final ImmutableList<String> include;
/**
* A list of names or patterns that are excluded by this glob. They should
* consist of characters that are valid in labels in the BUILD language.
*/
private final ImmutableList<String> exclude;
/** True if the includes list was passed to glob(), false if not. */
private final boolean glob;
/**
* Parses criteria from its {@link #toExpression} form.
* Package-private for use by tests and GlobList.
* @throws IllegalArgumentException if the expression cannot be parsed
*/
public static GlobCriteria parse(String text) {
if (text.startsWith("glob([") && text.endsWith("])")) {
int excludeIndex = text.indexOf("], exclude=[");
if (excludeIndex == -1) {
String listText = text.substring(6, text.length() - 2);
return new GlobCriteria(parseList(listText), ImmutableList.<String>of(), true);
} else {
String listText = text.substring(6, excludeIndex);
String excludeText = text.substring(excludeIndex + 12, text.length() - 2);
return new GlobCriteria(parseList(listText), parseList(excludeText), true);
}
} else if (text.startsWith("[") && text.endsWith("]")) {
String listText = text.substring(1, text.length() - 1);
return new GlobCriteria(parseList(listText), ImmutableList.<String>of(), false);
} else {
throw new IllegalArgumentException(
"unrecognized format (not from toExpression?): " + text);
}
}
/**
* Constructs a copy of a given glob critera object, with additional exclude patterns added.
*
* @param base a glob criteria object to copy. Must be an actual glob
* @param excludes a list of pattern strings indicating new excludes to provide
* @return a new glob criteria object which contains the same parameters as {@code base}, with
* the additional patterns in {@code excludes} added.
* @throws IllegalArgumentException if {@code base} is not a glob
*/
public static GlobCriteria createWithAdditionalExcludes(GlobCriteria base,
List<String> excludes) {
Preconditions.checkArgument(base.isGlob());
return fromGlobCall(base.include,
ImmutableList.copyOf(Iterables.concat(base.exclude, excludes)));
}
/**
* Constructs a copy of a fixed list, converted to Strings.
*/
public static GlobCriteria fromList(Iterable<?> list) {
Iterable<String> strings = Iterables.transform(list, Functions.toStringFunction());
return new GlobCriteria(ImmutableList.copyOf(strings), ImmutableList.<String>of(), false);
}
/**
* Constructs a glob call with include and exclude list.
*
* @param include list of included patterns
* @param exclude list of excluded patterns
*/
public static GlobCriteria fromGlobCall(
ImmutableList<String> include, ImmutableList<String> exclude) {
return new GlobCriteria(include, exclude, true);
}
/**
* Constructs a glob call with include and exclude list.
*/
private GlobCriteria(ImmutableList<String> include, ImmutableList<String> exclude, boolean glob) {
this.include = include;
this.exclude = exclude;
this.glob = glob;
}
/**
* Returns the patterns that were included in this {@code glob()} call.
*/
public ImmutableList<String> getIncludePatterns() {
return include;
}
/**
* Returns the patterns that were excluded in this {@code glob()} call.
*/
public ImmutableList<String> getExcludePatterns() {
return exclude;
}
/**
* Returns true if the include list was passed to {@code glob()}, false
* if it was a fixed list. If this returns false, the exclude list will
* always be empty.
*/
public boolean isGlob() {
return glob;
}
/**
* Returns a String that represents this glob as a BUILD expression.
* For example, <code>glob(['abc', 'def'], exclude=['uvw', 'xyz'])</code>
* or <code>['foo', 'bar', 'baz']</code>.
*/
public String toExpression() {
StringBuilder sb = new StringBuilder();
if (glob) {
sb.append("glob(");
}
sb.append('[');
appendList(sb, include);
if (!exclude.isEmpty()) {
sb.append("], exclude=[");
appendList(sb, exclude);
}
sb.append(']');
if (glob) {
sb.append(')');
}
return sb.toString();
}
@Override
public String toString() {
return toExpression();
}
/**
* Takes a list of Strings, quotes them in single quotes, and appends them to
* a StringBuilder separated by a comma and space. This can be parsed back
* out by {@link #parseList}.
*/
private static void appendList(StringBuilder sb, List<String> list) {
boolean first = true;
for (String content : list) {
if (!first) {
sb.append(", ");
}
sb.append('\'').append(content).append('\'');
first = false;
}
}
/**
* Takes a String in the format created by {@link #appendList} and returns
* the original Strings. A null String (which may be returned when Pattern
* does not find a match) or the String "" (which will be captured in "[]")
* will result in an empty list.
*/
private static ImmutableList<String> parseList(@Nullable String text) {
if (text == null) {
return ImmutableList.of();
}
Iterable<String> split = Splitter.on(", ").split(text);
Builder<String> listBuilder = ImmutableList.builder();
for (String element : split) {
if (!element.isEmpty()) {
if ((element.length() < 2) || !element.startsWith("'") || !element.endsWith("'")) {
throw new IllegalArgumentException("expected a filename or pattern in quotes: " + text);
}
listBuilder.add(element.substring(1, element.length() - 1));
}
}
return listBuilder.build();
}
}
|
