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
|
// 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.ListMultimap;
import com.google.common.escape.CharEscaperBuilder;
import com.google.common.escape.Escaper;
import com.google.devtools.build.docgen.DocgenConsts.RuleType;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import java.util.List;
/**
* Helper class for representing a rule family in the rule summary table template.
*
* <p>The rules are separated into categories by rule class: binary, library, test, and
* other.
*/
@Immutable
public class RuleFamily {
private static final Escaper FAMILY_NAME_ESCAPER = new CharEscaperBuilder()
.addEscape('+', "p")
.addEscapes(new char[] {'[', ']', '(', ')'}, "")
.addEscapes(new char[] {' ', '/'}, "-")
.toEscaper();
private final String name;
private final String id;
private final ImmutableList<RuleDocumentation> binaryRules;
private final ImmutableList<RuleDocumentation> libraryRules;
private final ImmutableList<RuleDocumentation> testRules;
private final ImmutableList<RuleDocumentation> otherRules1;
private final ImmutableList<RuleDocumentation> otherRules2;
private final ImmutableList<RuleDocumentation> rules;
RuleFamily(ListMultimap<RuleType, RuleDocumentation> ruleTypeMap, String name) {
this.name = name;
this.id = normalize(name);
this.binaryRules = ImmutableList.copyOf(ruleTypeMap.get(RuleType.BINARY));
this.libraryRules = ImmutableList.copyOf(ruleTypeMap.get(RuleType.LIBRARY));
this.testRules = ImmutableList.copyOf(ruleTypeMap.get(RuleType.TEST));
final ImmutableList<RuleDocumentation> otherRules =
ImmutableList.copyOf(ruleTypeMap.get(RuleType.OTHER));
if (otherRules.size() >= 4) {
this.otherRules1 = ImmutableList.copyOf(otherRules.subList(0, otherRules.size() / 2));
this.otherRules2 =
ImmutableList.copyOf(otherRules.subList(otherRules.size() / 2, otherRules.size()));
} else {
this.otherRules1 = otherRules;
this.otherRules2 = ImmutableList.of();
}
rules = ImmutableList.<RuleDocumentation>builder()
.addAll(binaryRules)
.addAll(libraryRules)
.addAll(testRules)
.addAll(otherRules1)
.addAll(otherRules2)
.build();
}
/*
* Returns a "normalized" version of the input string. Used to convert rule family names into
* strings that are more friendly as file names. For example, "C / C++" is converted to
* "c-cpp".
*/
static String normalize(String s) {
return FAMILY_NAME_ESCAPER.escape(s.toLowerCase()).replaceAll("[-]+", "-");
}
public int size() {
return rules.size();
}
public String getName() {
return name;
}
public String getId() {
return id;
}
public List<RuleDocumentation> getBinaryRules() {
return binaryRules;
}
public List<RuleDocumentation> getLibraryRules() {
return libraryRules;
}
public List<RuleDocumentation> getTestRules() {
return testRules;
}
public List<RuleDocumentation> getOtherRules1() {
return otherRules1;
}
public List<RuleDocumentation> getOtherRules2() {
return otherRules2;
}
public List<RuleDocumentation> getRules() {
return rules;
}
}
|
