Fix the documentation generator to use rule definition instances instead of classes.
--
MOS_MIGRATED_REVID=120794657
diff --git a/src/main/java/com/google/devtools/build/docgen/BuildDocCollector.java b/src/main/java/com/google/devtools/build/docgen/BuildDocCollector.java
index 7bb4f71..870bf95 100644
--- a/src/main/java/com/google/devtools/build/docgen/BuildDocCollector.java
+++ b/src/main/java/com/google/devtools/build/docgen/BuildDocCollector.java
@@ -154,7 +154,7 @@
if (ruleClass != null) {
if (ruleClass.isDocumented()) {
Class<? extends RuleDefinition> ruleDefinition =
- ruleClassProvider.getRuleClassDefinition(ruleDoc.getRuleName());
+ ruleClassProvider.getRuleClassDefinition(ruleDoc.getRuleName()).getClass();
for (Attribute attribute : ruleClass.getAttributes()) {
String attrName = attribute.getName();
List<RuleDocumentationAttribute> attributeDocList =
@@ -167,7 +167,9 @@
int minLevel = Integer.MAX_VALUE;
RuleDocumentationAttribute bestAttributeDoc = null;
for (RuleDocumentationAttribute attributeDoc : attributeDocList) {
- int level = attributeDoc.getDefinitionClassAncestryLevel(ruleDefinition);
+ int level = attributeDoc.getDefinitionClassAncestryLevel(
+ ruleDefinition,
+ ruleClassProvider);
if (level >= 0 && level < minLevel) {
bestAttributeDoc = attributeDoc;
minLevel = level;
diff --git a/src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java b/src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java
index b1b60fb..2182269 100644
--- a/src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java
+++ b/src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java
@@ -16,6 +16,7 @@
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
+import com.google.devtools.build.lib.analysis.ConfiguredRuleClassProvider;
import com.google.devtools.build.lib.analysis.RuleDefinition;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.packages.Attribute;
@@ -219,7 +220,8 @@
* RuleDocumentationAttribute in the rule definition ancestry graph. Returns -1
* if definitionClass is not the ancestor (transitively) of usingClass.
*/
- int getDefinitionClassAncestryLevel(Class<? extends RuleDefinition> usingClass) {
+ int getDefinitionClassAncestryLevel(Class<? extends RuleDefinition> usingClass,
+ ConfiguredRuleClassProvider ruleClassProvider) {
if (usingClass.equals(definitionClass)) {
return 0;
}
@@ -231,7 +233,7 @@
// Searching the shortest path from usingClass to this.definitionClass using BFS
do {
Class<? extends RuleDefinition> ancestor = toVisit.removeFirst();
- visitAncestor(ancestor, visited, toVisit);
+ visitAncestor(ancestor, visited, toVisit, ruleClassProvider);
if (ancestor.equals(definitionClass)) {
return visited.get(ancestor);
}
@@ -242,13 +244,9 @@
private void visitAncestor(
Class<? extends RuleDefinition> usingClass,
Map<Class<? extends RuleDefinition>, Integer> visited,
- LinkedList<Class<? extends RuleDefinition>> toVisit) {
- RuleDefinition instance;
- try {
- instance = usingClass.newInstance();
- } catch (IllegalAccessException | InstantiationException e) {
- throw new IllegalStateException(e);
- }
+ LinkedList<Class<? extends RuleDefinition>> toVisit,
+ ConfiguredRuleClassProvider ruleClassProvider) {
+ RuleDefinition instance = getRuleDefinition(usingClass, ruleClassProvider);
for (Class<? extends RuleDefinition> ancestor : instance.getMetadata().ancestors()) {
if (!visited.containsKey(ancestor)) {
toVisit.addLast(ancestor);
@@ -257,6 +255,18 @@
}
}
+ private RuleDefinition getRuleDefinition(Class<? extends RuleDefinition> usingClass,
+ ConfiguredRuleClassProvider ruleClassProvider) {
+ if (ruleClassProvider == null) {
+ try {
+ return usingClass.newInstance();
+ } catch (IllegalAccessException | InstantiationException e) {
+ throw new IllegalStateException(e);
+ }
+ }
+ return ruleClassProvider.getRuleClassDefinition(usingClass.getName());
+ }
+
private int getAttributeOrderingPriority(RuleDocumentationAttribute attribute) {
if (DocgenConsts.ATTRIBUTE_ORDERING.containsKey(attribute.attributeName)) {
return DocgenConsts.ATTRIBUTE_ORDERING.get(attribute.attributeName);
diff --git a/src/main/java/com/google/devtools/build/docgen/SourceFileReader.java b/src/main/java/com/google/devtools/build/docgen/SourceFileReader.java
index 78f0b6d..433d396 100644
--- a/src/main/java/com/google/devtools/build/docgen/SourceFileReader.java
+++ b/src/main/java/com/google/devtools/build/docgen/SourceFileReader.java
@@ -213,7 +213,7 @@
final ListMultimap<String, RuleDocumentationAttribute> docAttributes) {
// End of a attribute, create RuleDocumentationAttribute object
docAttributes.put(attributeName, RuleDocumentationAttribute.create(
- ruleClassProvider.getRuleClassDefinition(ruleName),
+ ruleClassProvider.getRuleClassDefinition(ruleName).getClass(),
attributeName, sb.toString(), startLineCnt, javaSourceFilePath, flags));
sb = new StringBuilder();
inBlazeAttributeDocs = false;
