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
|
// 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.docgen;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.io.ByteStreams;
import com.google.common.io.Files;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
/**
* A class to contain the base definition of common BUILD rule attributes.
*/
public class PredefinedAttributes {
/**
* List of documentation for common attributes of *_test rules, relative to
* {@link com.google.devtools.build.docgen}.
*/
public static final ImmutableList<String> TEST_ATTRIBUTES_DOCFILES = ImmutableList.of(
"templates/attributes/test/args.html",
"templates/attributes/test/size.html",
"templates/attributes/test/timeout.html",
"templates/attributes/test/flaky.html",
"templates/attributes/test/shard_count.html",
"templates/attributes/test/local.html");
/**
* List of common attributes documentation, relative to {@link com.google.devtools.build.docgen}.
*/
public static final ImmutableList<String> COMMON_ATTRIBUTES_DOCFILES =
ImmutableList.of(
"templates/attributes/common/compatible_with.html",
"templates/attributes/common/data.html",
"templates/attributes/common/deprecation.html",
"templates/attributes/common/deps.html",
"templates/attributes/common/distribs.html",
"templates/attributes/common/features.html",
"templates/attributes/common/licenses.html",
"templates/attributes/common/restricted_to.html",
"templates/attributes/common/tags.html",
"templates/attributes/common/testonly.html",
"templates/attributes/common/toolchains.html",
"templates/attributes/common/visibility.html");
/**
* List of documentation for common attributes of *_binary rules, relative to
* {@link com.google.devtools.build.docgen}.
*/
public static final ImmutableList<String> BINARY_ATTRIBUTES_DOCFILES =
ImmutableList.of(
"templates/attributes/binary/args.html",
"templates/attributes/binary/output_licenses.html");
private static ImmutableMap<String, RuleDocumentationAttribute> generateAttributeMap(
String commonType, ImmutableList<String> filenames) {
ImmutableMap.Builder<String, RuleDocumentationAttribute> builder =
ImmutableMap.<String, RuleDocumentationAttribute>builder();
for (String filename : filenames) {
String name = Files.getNameWithoutExtension(filename);
try {
InputStream stream = PredefinedAttributes.class.getResourceAsStream(filename);
if (stream == null) {
throw new IllegalStateException("Resource " + filename + " not found");
}
String content = new String(ByteStreams.toByteArray(stream), StandardCharsets.UTF_8);
builder.put(name, RuleDocumentationAttribute.create(name, commonType, content));
} catch (IOException e) {
throw new IllegalStateException("Exception while reading " + filename, e);
}
}
return builder.build();
}
public static final ImmutableMap<String, RuleDocumentationAttribute> COMMON_ATTRIBUTES =
generateAttributeMap(DocgenConsts.COMMON_ATTRIBUTES, COMMON_ATTRIBUTES_DOCFILES);
public static final ImmutableMap<String, RuleDocumentationAttribute> BINARY_ATTRIBUTES =
generateAttributeMap(DocgenConsts.BINARY_ATTRIBUTES, BINARY_ATTRIBUTES_DOCFILES);
public static final ImmutableMap<String, RuleDocumentationAttribute> TEST_ATTRIBUTES =
generateAttributeMap(DocgenConsts.TEST_ATTRIBUTES, TEST_ATTRIBUTES_DOCFILES);
}
|
