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
|
/*
* Copyright 2015 The Kythe 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.kythe.analyzers.java;
import static com.google.devtools.kythe.analyzers.java.KytheTreeScanner.DocKind.JAVADOC;
import com.google.auto.value.AutoValue;
import com.google.common.base.Splitter;
import com.google.common.flogger.FluentLogger;
import com.google.devtools.kythe.analyzers.base.EntrySet;
import com.google.devtools.kythe.proto.Storage.VName;
import com.sun.source.doctree.DeprecatedTree;
import com.sun.source.doctree.ReferenceTree;
import com.sun.source.tree.CompilationUnitTree;
import com.sun.source.util.DocSourcePositions;
import com.sun.source.util.DocTreePath;
import com.sun.source.util.DocTreePathScanner;
import com.sun.source.util.DocTrees;
import com.sun.source.util.TreePath;
import com.sun.tools.javac.api.JavacTrees;
import com.sun.tools.javac.code.Symbol;
import com.sun.tools.javac.tree.DCTree.DCDocComment;
import com.sun.tools.javac.tree.DCTree.DCReference;
import com.sun.tools.javac.util.Context;
import com.sun.tools.javac.util.Position;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
public class KytheDocTreeScanner extends DocTreePathScanner<Void, DCDocComment> {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
private final KytheTreeScanner treeScanner;
private final List<MiniAnchor<Symbol>> miniAnchors;
private Optional<String> deprecation;
private final DocTrees trees;
public KytheDocTreeScanner(KytheTreeScanner treeScanner, Context context) {
this.treeScanner = treeScanner;
this.miniAnchors = new ArrayList<>();
this.trees = JavacTrees.instance(context);
}
@AutoValue
abstract static class DocCommentVisitResult {
abstract boolean documented();
abstract Optional<String> deprecation();
private static final DocCommentVisitResult UNDOCUMENTED =
create(/* documented= */ false, /* deprecation= */ Optional.empty());
static DocCommentVisitResult create(Optional<String> deprecation) {
return create(/* documented= */ true, deprecation);
}
private static DocCommentVisitResult create(boolean documented, Optional<String> deprecation) {
return new AutoValue_KytheDocTreeScanner_DocCommentVisitResult(documented, deprecation);
}
}
public DocCommentVisitResult visitDocComment(TreePath treePath, VName node, EntrySet absNode) {
// TODO(#1501): always use absNode
DCDocComment doc = (DCDocComment) trees.getDocCommentTree(treePath);
if (doc == null) {
return DocCommentVisitResult.UNDOCUMENTED;
}
miniAnchors.clear();
deprecation = Optional.empty();
scan(new DocTreePath(treePath, doc), doc);
String bracketed =
MiniAnchor.bracket(
doc.comment.getText(),
new MiniAnchor.PositionTransform() {
@Override
public int transform(int pos) {
return doc.comment.getSourcePos(pos);
}
},
miniAnchors);
List<Symbol> anchoredTo = new ArrayList<>(miniAnchors.size());
for (MiniAnchor<Symbol> miniAnchor : miniAnchors) {
anchoredTo.add(miniAnchor.getAnchoredTo());
}
treeScanner.emitDoc(
JAVADOC, bracketed, anchoredTo, node, absNode == null ? null : absNode.getVName());
return DocCommentVisitResult.create(deprecation);
}
@Override
public Void visitReference(ReferenceTree tree, DCDocComment doc) {
DCReference ref = (DCReference) tree;
Symbol sym = null;
try {
sym = (Symbol) trees.getElement(getCurrentPath());
} catch (Throwable e) {
logger.atWarning().withCause(e).log("Failed to resolve documentation reference: %s", tree);
}
if (sym == null) {
return null;
}
int startPos = (int) ref.getSourcePosition(doc);
int endPos = ref.getEndPos(doc);
treeScanner.emitDocReference(sym, startPos, endPos);
miniAnchors.add(new MiniAnchor<Symbol>(sym, startPos, endPos));
return null;
}
@Override
public Void visitDeprecated(DeprecatedTree node, DCDocComment doc) {
if (node.getBody().isEmpty()) {
// deprecated tag is empty
deprecation = Optional.of("");
return null;
}
CompilationUnitTree unit = getCurrentPath().getTreePath().getCompilationUnit();
DocSourcePositions positions = trees.getSourcePositions();
int start = (int) positions.getStartPosition(unit, doc, node.getBody().get(0));
int end = (int) positions.getEndPosition(unit, doc, node);
if (end == Position.NOPOS) {
// deprecated tag is empty
deprecation = Optional.of("");
return null;
}
CharSequence source;
try {
source = unit.getSourceFile().getCharContent(/* ignoreEncodingErrors= */ true);
} catch (IOException e) {
return null;
}
// Join lines from multi-line @deprecated tags, removing the leading `*` from the javadoc.
String text =
Splitter.onPattern("\\R").splitToList(source.subSequence(start, end)).stream()
.map(String::trim)
.map(l -> l.startsWith("*") ? l.substring(1).trim() : l)
.collect(Collectors.joining(" "));
// Save the contents of the @deprecated tag to emit.
deprecation = Optional.of(text);
return null;
}
}
|
