author | jlahoda |
Wed, 11 Mar 2015 22:24:05 +0100 | |
changeset 29427 | 44f4e6905b67 |
parent 29291 | 076c277565f7 |
child 29957 | 7740f9657f56 |
permissions | -rw-r--r-- |
14952 | 1 |
/* |
15359 | 2 |
* Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. |
14952 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
7 |
* published by the Free Software Foundation. Oracle designates this |
|
8 |
* particular file as subject to the "Classpath" exception as provided |
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
|
10 |
* |
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
24 |
*/ |
|
25 |
||
26 |
package com.sun.tools.doclint; |
|
27 |
||
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
28 |
import java.io.IOException; |
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
29 |
import java.io.StringWriter; |
14952 | 30 |
import java.net.URI; |
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
31 |
import java.net.URISyntaxException; |
14952 | 32 |
import java.util.Deque; |
33 |
import java.util.EnumSet; |
|
19120
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
34 |
import java.util.HashMap; |
14952 | 35 |
import java.util.HashSet; |
36 |
import java.util.LinkedList; |
|
37 |
import java.util.List; |
|
19120
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
38 |
import java.util.Map; |
14952 | 39 |
import java.util.Set; |
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
40 |
import java.util.regex.Matcher; |
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
41 |
import java.util.regex.Pattern; |
14952 | 42 |
|
43 |
import javax.lang.model.element.Element; |
|
44 |
import javax.lang.model.element.ElementKind; |
|
45 |
import javax.lang.model.element.ExecutableElement; |
|
46 |
import javax.lang.model.element.Name; |
|
20255
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
47 |
import javax.lang.model.element.VariableElement; |
14952 | 48 |
import javax.lang.model.type.TypeKind; |
49 |
import javax.lang.model.type.TypeMirror; |
|
50 |
import javax.tools.Diagnostic.Kind; |
|
19120
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
51 |
import javax.tools.JavaFileObject; |
14952 | 52 |
|
53 |
import com.sun.source.doctree.AttributeTree; |
|
54 |
import com.sun.source.doctree.AuthorTree; |
|
55 |
import com.sun.source.doctree.DocCommentTree; |
|
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
56 |
import com.sun.source.doctree.DocRootTree; |
14952 | 57 |
import com.sun.source.doctree.DocTree; |
58 |
import com.sun.source.doctree.EndElementTree; |
|
59 |
import com.sun.source.doctree.EntityTree; |
|
60 |
import com.sun.source.doctree.ErroneousTree; |
|
61 |
import com.sun.source.doctree.IdentifierTree; |
|
62 |
import com.sun.source.doctree.InheritDocTree; |
|
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
63 |
import com.sun.source.doctree.LinkTree; |
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
64 |
import com.sun.source.doctree.LiteralTree; |
14952 | 65 |
import com.sun.source.doctree.ParamTree; |
66 |
import com.sun.source.doctree.ReferenceTree; |
|
67 |
import com.sun.source.doctree.ReturnTree; |
|
68 |
import com.sun.source.doctree.SerialDataTree; |
|
69 |
import com.sun.source.doctree.SerialFieldTree; |
|
70 |
import com.sun.source.doctree.SinceTree; |
|
71 |
import com.sun.source.doctree.StartElementTree; |
|
72 |
import com.sun.source.doctree.TextTree; |
|
73 |
import com.sun.source.doctree.ThrowsTree; |
|
21500
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
74 |
import com.sun.source.doctree.UnknownBlockTagTree; |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
75 |
import com.sun.source.doctree.UnknownInlineTagTree; |
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
76 |
import com.sun.source.doctree.ValueTree; |
14952 | 77 |
import com.sun.source.doctree.VersionTree; |
24069 | 78 |
import com.sun.source.tree.Tree; |
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
79 |
import com.sun.source.util.DocTreePath; |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
80 |
import com.sun.source.util.DocTreePathScanner; |
14952 | 81 |
import com.sun.source.util.TreePath; |
82 |
import com.sun.tools.doclint.HtmlTag.AttrKind; |
|
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
83 |
import com.sun.tools.javac.tree.DocPretty; |
29291
076c277565f7
8073550: java* tools: replace obj.getClass hacks with Assert.checkNonNull or Objects.requireNonNull
mcimadamore
parents:
26266
diff
changeset
|
84 |
import com.sun.tools.javac.util.Assert; |
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
85 |
import com.sun.tools.javac.util.DefinedBy; |
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
86 |
import com.sun.tools.javac.util.DefinedBy.Api; |
22153
f9f06fcca59d
8029800: Flags.java uses String.toLowerCase without specifying Locale
jlahoda
parents:
21500
diff
changeset
|
87 |
import com.sun.tools.javac.util.StringUtils; |
14952 | 88 |
import static com.sun.tools.doclint.Messages.Group.*; |
89 |
||
90 |
||
91 |
/** |
|
92 |
* Validate a doc comment. |
|
93 |
* |
|
94 |
* <p><b>This is NOT part of any supported API. |
|
95 |
* If you write code that depends on this, you do so at your own |
|
96 |
* risk. This code and its internal interfaces are subject to change |
|
97 |
* or deletion without notice.</b></p> |
|
98 |
*/ |
|
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
99 |
public class Checker extends DocTreePathScanner<Void, Void> { |
14952 | 100 |
final Env env; |
101 |
||
19120
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
102 |
Set<Element> foundParams = new HashSet<>(); |
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
103 |
Set<TypeMirror> foundThrows = new HashSet<>(); |
20254
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
104 |
Map<Element, Set<String>> foundAnchors = new HashMap<>(); |
14952 | 105 |
boolean foundInheritDoc = false; |
106 |
boolean foundReturn = false; |
|
107 |
||
15370 | 108 |
public enum Flag { |
14952 | 109 |
TABLE_HAS_CAPTION, |
110 |
HAS_ELEMENT, |
|
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
111 |
HAS_INLINE_TAG, |
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
112 |
HAS_TEXT, |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
113 |
REPORTED_BAD_INLINE |
14952 | 114 |
} |
115 |
||
116 |
static class TagStackItem { |
|
117 |
final DocTree tree; // typically, but not always, StartElementTree |
|
118 |
final HtmlTag tag; |
|
119 |
final Set<HtmlTag.Attr> attrs; |
|
120 |
final Set<Flag> flags; |
|
121 |
TagStackItem(DocTree tree, HtmlTag tag) { |
|
122 |
this.tree = tree; |
|
123 |
this.tag = tag; |
|
124 |
attrs = EnumSet.noneOf(HtmlTag.Attr.class); |
|
125 |
flags = EnumSet.noneOf(Flag.class); |
|
126 |
} |
|
127 |
@Override |
|
128 |
public String toString() { |
|
129 |
return String.valueOf(tag); |
|
130 |
} |
|
131 |
} |
|
132 |
||
133 |
private Deque<TagStackItem> tagStack; // TODO: maybe want to record starting tree as well |
|
134 |
private HtmlTag currHeaderTag; |
|
135 |
||
16799
fbe4d27b8791
8006346: doclint should make allowance for headers generated by standard doclet
jjg
parents:
16562
diff
changeset
|
136 |
private final int implicitHeaderLevel; |
fbe4d27b8791
8006346: doclint should make allowance for headers generated by standard doclet
jjg
parents:
16562
diff
changeset
|
137 |
|
14952 | 138 |
// <editor-fold defaultstate="collapsed" desc="Top level"> |
139 |
||
140 |
Checker(Env env) { |
|
29291
076c277565f7
8073550: java* tools: replace obj.getClass hacks with Assert.checkNonNull or Objects.requireNonNull
mcimadamore
parents:
26266
diff
changeset
|
141 |
this.env = Assert.checkNonNull(env); |
19120
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
142 |
tagStack = new LinkedList<>(); |
16799
fbe4d27b8791
8006346: doclint should make allowance for headers generated by standard doclet
jjg
parents:
16562
diff
changeset
|
143 |
implicitHeaderLevel = env.implicitHeaderLevel; |
14952 | 144 |
} |
145 |
||
146 |
public Void scan(DocCommentTree tree, TreePath p) { |
|
29427
44f4e6905b67
8071851: Provide filtering of doclint checking based on packages
jlahoda
parents:
29291
diff
changeset
|
147 |
env.initTypes(); |
14952 | 148 |
env.setCurrent(p, tree); |
149 |
||
150 |
boolean isOverridingMethod = !env.currOverriddenMethods.isEmpty(); |
|
151 |
||
24069 | 152 |
if (p.getLeaf().getKind() == Tree.Kind.PACKAGE) { |
153 |
// If p points to a package, the implied declaration is the |
|
19123
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
154 |
// package declaration (if any) for the compilation unit. |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
155 |
// Handle this case specially, because doc comments are only |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
156 |
// expected in package-info files. |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
157 |
JavaFileObject fo = p.getCompilationUnit().getSourceFile(); |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
158 |
boolean isPkgInfo = fo.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE); |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
159 |
if (tree == null) { |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
160 |
if (isPkgInfo) |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
161 |
reportMissing("dc.missing.comment"); |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
162 |
return null; |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
163 |
} else { |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
164 |
if (!isPkgInfo) |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
165 |
reportReference("dc.unexpected.comment"); |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
166 |
} |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
167 |
} else { |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
168 |
if (tree == null) { |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
169 |
if (!isSynthetic() && !isOverridingMethod) |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
170 |
reportMissing("dc.missing.comment"); |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
171 |
return null; |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
172 |
} |
14952 | 173 |
} |
174 |
||
175 |
tagStack.clear(); |
|
176 |
currHeaderTag = null; |
|
177 |
||
178 |
foundParams.clear(); |
|
179 |
foundThrows.clear(); |
|
180 |
foundInheritDoc = false; |
|
181 |
foundReturn = false; |
|
182 |
||
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
183 |
scan(new DocTreePath(p, tree), null); |
14952 | 184 |
|
185 |
if (!isOverridingMethod) { |
|
186 |
switch (env.currElement.getKind()) { |
|
187 |
case METHOD: |
|
188 |
case CONSTRUCTOR: { |
|
189 |
ExecutableElement ee = (ExecutableElement) env.currElement; |
|
190 |
checkParamsDocumented(ee.getTypeParameters()); |
|
191 |
checkParamsDocumented(ee.getParameters()); |
|
192 |
switch (ee.getReturnType().getKind()) { |
|
193 |
case VOID: |
|
194 |
case NONE: |
|
195 |
break; |
|
196 |
default: |
|
197 |
if (!foundReturn |
|
198 |
&& !foundInheritDoc |
|
199 |
&& !env.types.isSameType(ee.getReturnType(), env.java_lang_Void)) { |
|
200 |
reportMissing("dc.missing.return"); |
|
201 |
} |
|
202 |
} |
|
203 |
checkThrowsDocumented(ee.getThrownTypes()); |
|
204 |
} |
|
205 |
} |
|
206 |
} |
|
207 |
||
208 |
return null; |
|
209 |
} |
|
210 |
||
211 |
private void reportMissing(String code, Object... args) { |
|
212 |
env.messages.report(MISSING, Kind.WARNING, env.currPath.getLeaf(), code, args); |
|
213 |
} |
|
214 |
||
19123
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
215 |
private void reportReference(String code, Object... args) { |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
216 |
env.messages.report(REFERENCE, Kind.WARNING, env.currPath.getLeaf(), code, args); |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
217 |
} |
50733e28eaca
8021215: javac gives incorrect doclint warnings on normal package statements
jjg
parents:
19120
diff
changeset
|
218 |
|
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
219 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 220 |
public Void visitDocComment(DocCommentTree tree, Void ignore) { |
221 |
super.visitDocComment(tree, ignore); |
|
222 |
for (TagStackItem tsi: tagStack) { |
|
21017
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
223 |
warnIfEmpty(tsi, null); |
14952 | 224 |
if (tsi.tree.getKind() == DocTree.Kind.START_ELEMENT |
225 |
&& tsi.tag.endKind == HtmlTag.EndKind.REQUIRED) { |
|
226 |
StartElementTree t = (StartElementTree) tsi.tree; |
|
227 |
env.messages.error(HTML, t, "dc.tag.not.closed", t.getName()); |
|
228 |
} |
|
229 |
} |
|
230 |
return null; |
|
231 |
} |
|
232 |
// </editor-fold> |
|
233 |
||
234 |
// <editor-fold defaultstate="collapsed" desc="Text and entities."> |
|
235 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
236 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 237 |
public Void visitText(TextTree tree, Void ignore) { |
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
238 |
if (hasNonWhitespace(tree)) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
239 |
checkAllowsText(tree); |
14952 | 240 |
markEnclosingTag(Flag.HAS_TEXT); |
241 |
} |
|
242 |
return null; |
|
243 |
} |
|
244 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
245 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 246 |
public Void visitEntity(EntityTree tree, Void ignore) { |
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
247 |
checkAllowsText(tree); |
14952 | 248 |
markEnclosingTag(Flag.HAS_TEXT); |
249 |
String name = tree.getName().toString(); |
|
250 |
if (name.startsWith("#")) { |
|
22153
f9f06fcca59d
8029800: Flags.java uses String.toLowerCase without specifying Locale
jlahoda
parents:
21500
diff
changeset
|
251 |
int v = StringUtils.toLowerCase(name).startsWith("#x") |
14952 | 252 |
? Integer.parseInt(name.substring(2), 16) |
253 |
: Integer.parseInt(name.substring(1), 10); |
|
254 |
if (!Entity.isValid(v)) { |
|
255 |
env.messages.error(HTML, tree, "dc.entity.invalid", name); |
|
256 |
} |
|
257 |
} else if (!Entity.isValid(name)) { |
|
258 |
env.messages.error(HTML, tree, "dc.entity.invalid", name); |
|
259 |
} |
|
260 |
return null; |
|
261 |
} |
|
262 |
||
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
263 |
void checkAllowsText(DocTree tree) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
264 |
TagStackItem top = tagStack.peek(); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
265 |
if (top != null |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
266 |
&& top.tree.getKind() == DocTree.Kind.START_ELEMENT |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
267 |
&& !top.tag.acceptsText()) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
268 |
if (top.flags.add(Flag.REPORTED_BAD_INLINE)) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
269 |
env.messages.error(HTML, tree, "dc.text.not.allowed", |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
270 |
((StartElementTree) top.tree).getName()); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
271 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
272 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
273 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
274 |
|
14952 | 275 |
// </editor-fold> |
276 |
||
277 |
// <editor-fold defaultstate="collapsed" desc="HTML elements"> |
|
278 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
279 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 280 |
public Void visitStartElement(StartElementTree tree, Void ignore) { |
281 |
final Name treeName = tree.getName(); |
|
282 |
final HtmlTag t = HtmlTag.get(treeName); |
|
283 |
if (t == null) { |
|
284 |
env.messages.error(HTML, tree, "dc.tag.unknown", treeName); |
|
285 |
} else { |
|
15707
7b2411328a5c
8007566: DocLint too aggressive with not allowed here: <p>
jjg
parents:
15371
diff
changeset
|
286 |
boolean done = false; |
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
287 |
for (TagStackItem tsi: tagStack) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
288 |
if (tsi.tag.accepts(t)) { |
21017
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
289 |
while (tagStack.peek() != tsi) { |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
290 |
warnIfEmpty(tagStack.peek(), null); |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
291 |
tagStack.pop(); |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
292 |
} |
15707
7b2411328a5c
8007566: DocLint too aggressive with not allowed here: <p>
jjg
parents:
15371
diff
changeset
|
293 |
done = true; |
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
294 |
break; |
15707
7b2411328a5c
8007566: DocLint too aggressive with not allowed here: <p>
jjg
parents:
15371
diff
changeset
|
295 |
} else if (tsi.tag.endKind != HtmlTag.EndKind.OPTIONAL) { |
7b2411328a5c
8007566: DocLint too aggressive with not allowed here: <p>
jjg
parents:
15371
diff
changeset
|
296 |
done = true; |
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
297 |
break; |
15707
7b2411328a5c
8007566: DocLint too aggressive with not allowed here: <p>
jjg
parents:
15371
diff
changeset
|
298 |
} |
7b2411328a5c
8007566: DocLint too aggressive with not allowed here: <p>
jjg
parents:
15371
diff
changeset
|
299 |
} |
7b2411328a5c
8007566: DocLint too aggressive with not allowed here: <p>
jjg
parents:
15371
diff
changeset
|
300 |
if (!done && HtmlTag.BODY.accepts(t)) { |
21017
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
301 |
while (!tagStack.isEmpty()) { |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
302 |
warnIfEmpty(tagStack.peek(), null); |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
303 |
tagStack.pop(); |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
304 |
} |
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
305 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
306 |
|
21017
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
307 |
markEnclosingTag(Flag.HAS_ELEMENT); |
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
308 |
checkStructure(tree, t); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
309 |
|
14952 | 310 |
// tag specific checks |
311 |
switch (t) { |
|
312 |
// check for out of sequence headers, such as <h1>...</h1> <h3>...</h3> |
|
313 |
case H1: case H2: case H3: case H4: case H5: case H6: |
|
314 |
checkHeader(tree, t); |
|
315 |
break; |
|
316 |
} |
|
317 |
||
318 |
if (t.flags.contains(HtmlTag.Flag.NO_NEST)) { |
|
319 |
for (TagStackItem i: tagStack) { |
|
320 |
if (t == i.tag) { |
|
321 |
env.messages.warning(HTML, tree, "dc.tag.nested.not.allowed", treeName); |
|
322 |
break; |
|
323 |
} |
|
324 |
} |
|
325 |
} |
|
326 |
} |
|
327 |
||
328 |
// check for self closing tags, such as <a id="name"/> |
|
329 |
if (tree.isSelfClosing()) { |
|
330 |
env.messages.error(HTML, tree, "dc.tag.self.closing", treeName); |
|
331 |
} |
|
332 |
||
333 |
try { |
|
334 |
TagStackItem parent = tagStack.peek(); |
|
335 |
TagStackItem top = new TagStackItem(tree, t); |
|
336 |
tagStack.push(top); |
|
337 |
||
338 |
super.visitStartElement(tree, ignore); |
|
339 |
||
340 |
// handle attributes that may or may not have been found in start element |
|
341 |
if (t != null) { |
|
342 |
switch (t) { |
|
343 |
case CAPTION: |
|
344 |
if (parent != null && parent.tag == HtmlTag.TABLE) |
|
345 |
parent.flags.add(Flag.TABLE_HAS_CAPTION); |
|
346 |
break; |
|
347 |
||
348 |
case IMG: |
|
349 |
if (!top.attrs.contains(HtmlTag.Attr.ALT)) |
|
350 |
env.messages.error(ACCESSIBILITY, tree, "dc.no.alt.attr.for.image"); |
|
351 |
break; |
|
352 |
} |
|
353 |
} |
|
354 |
||
355 |
return null; |
|
356 |
} finally { |
|
357 |
||
358 |
if (t == null || t.endKind == HtmlTag.EndKind.NONE) |
|
359 |
tagStack.pop(); |
|
360 |
} |
|
361 |
} |
|
362 |
||
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
363 |
private void checkStructure(StartElementTree tree, HtmlTag t) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
364 |
Name treeName = tree.getName(); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
365 |
TagStackItem top = tagStack.peek(); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
366 |
switch (t.blockType) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
367 |
case BLOCK: |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
368 |
if (top == null || top.tag.accepts(t)) |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
369 |
return; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
370 |
|
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
371 |
switch (top.tree.getKind()) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
372 |
case START_ELEMENT: { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
373 |
if (top.tag.blockType == HtmlTag.BlockType.INLINE) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
374 |
Name name = ((StartElementTree) top.tree).getName(); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
375 |
env.messages.error(HTML, tree, "dc.tag.not.allowed.inline.element", |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
376 |
treeName, name); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
377 |
return; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
378 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
379 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
380 |
break; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
381 |
|
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
382 |
case LINK: |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
383 |
case LINK_PLAIN: { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
384 |
String name = top.tree.getKind().tagName; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
385 |
env.messages.error(HTML, tree, "dc.tag.not.allowed.inline.tag", |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
386 |
treeName, name); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
387 |
return; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
388 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
389 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
390 |
break; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
391 |
|
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
392 |
case INLINE: |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
393 |
if (top == null || top.tag.accepts(t)) |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
394 |
return; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
395 |
break; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
396 |
|
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
397 |
case LIST_ITEM: |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
398 |
case TABLE_ITEM: |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
399 |
if (top != null) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
400 |
// reset this flag so subsequent bad inline content gets reported |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
401 |
top.flags.remove(Flag.REPORTED_BAD_INLINE); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
402 |
if (top.tag.accepts(t)) |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
403 |
return; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
404 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
405 |
break; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
406 |
|
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
407 |
case OTHER: |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
408 |
env.messages.error(HTML, tree, "dc.tag.not.allowed", treeName); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
409 |
return; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
410 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
411 |
|
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
412 |
env.messages.error(HTML, tree, "dc.tag.not.allowed.here", treeName); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
413 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
414 |
|
14952 | 415 |
private void checkHeader(StartElementTree tree, HtmlTag tag) { |
416 |
// verify the new tag |
|
417 |
if (getHeaderLevel(tag) > getHeaderLevel(currHeaderTag) + 1) { |
|
418 |
if (currHeaderTag == null) { |
|
419 |
env.messages.error(ACCESSIBILITY, tree, "dc.tag.header.sequence.1", tag); |
|
420 |
} else { |
|
421 |
env.messages.error(ACCESSIBILITY, tree, "dc.tag.header.sequence.2", |
|
422 |
tag, currHeaderTag); |
|
423 |
} |
|
424 |
} |
|
425 |
||
426 |
currHeaderTag = tag; |
|
427 |
} |
|
428 |
||
429 |
private int getHeaderLevel(HtmlTag tag) { |
|
430 |
if (tag == null) |
|
16799
fbe4d27b8791
8006346: doclint should make allowance for headers generated by standard doclet
jjg
parents:
16562
diff
changeset
|
431 |
return implicitHeaderLevel; |
14952 | 432 |
switch (tag) { |
433 |
case H1: return 1; |
|
434 |
case H2: return 2; |
|
435 |
case H3: return 3; |
|
436 |
case H4: return 4; |
|
437 |
case H5: return 5; |
|
438 |
case H6: return 6; |
|
439 |
default: throw new IllegalArgumentException(); |
|
440 |
} |
|
441 |
} |
|
442 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
443 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 444 |
public Void visitEndElement(EndElementTree tree, Void ignore) { |
445 |
final Name treeName = tree.getName(); |
|
446 |
final HtmlTag t = HtmlTag.get(treeName); |
|
447 |
if (t == null) { |
|
448 |
env.messages.error(HTML, tree, "dc.tag.unknown", treeName); |
|
449 |
} else if (t.endKind == HtmlTag.EndKind.NONE) { |
|
450 |
env.messages.error(HTML, tree, "dc.tag.end.not.permitted", treeName); |
|
451 |
} else { |
|
15363 | 452 |
boolean done = false; |
14952 | 453 |
while (!tagStack.isEmpty()) { |
454 |
TagStackItem top = tagStack.peek(); |
|
455 |
if (t == top.tag) { |
|
456 |
switch (t) { |
|
457 |
case TABLE: |
|
458 |
if (!top.attrs.contains(HtmlTag.Attr.SUMMARY) |
|
459 |
&& !top.flags.contains(Flag.TABLE_HAS_CAPTION)) { |
|
460 |
env.messages.error(ACCESSIBILITY, tree, |
|
461 |
"dc.no.summary.or.caption.for.table"); |
|
462 |
} |
|
463 |
} |
|
21017
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
464 |
warnIfEmpty(top, tree); |
14952 | 465 |
tagStack.pop(); |
15363 | 466 |
done = true; |
14952 | 467 |
break; |
468 |
} else if (top.tag == null || top.tag.endKind != HtmlTag.EndKind.REQUIRED) { |
|
469 |
tagStack.pop(); |
|
470 |
} else { |
|
471 |
boolean found = false; |
|
472 |
for (TagStackItem si: tagStack) { |
|
473 |
if (si.tag == t) { |
|
474 |
found = true; |
|
475 |
break; |
|
476 |
} |
|
477 |
} |
|
478 |
if (found && top.tree.getKind() == DocTree.Kind.START_ELEMENT) { |
|
479 |
env.messages.error(HTML, top.tree, "dc.tag.start.unmatched", |
|
480 |
((StartElementTree) top.tree).getName()); |
|
481 |
tagStack.pop(); |
|
482 |
} else { |
|
483 |
env.messages.error(HTML, tree, "dc.tag.end.unexpected", treeName); |
|
15363 | 484 |
done = true; |
14952 | 485 |
break; |
486 |
} |
|
487 |
} |
|
488 |
} |
|
15363 | 489 |
|
490 |
if (!done && tagStack.isEmpty()) { |
|
491 |
env.messages.error(HTML, tree, "dc.tag.end.unexpected", treeName); |
|
492 |
} |
|
14952 | 493 |
} |
494 |
||
495 |
return super.visitEndElement(tree, ignore); |
|
496 |
} |
|
21017
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
497 |
|
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
498 |
void warnIfEmpty(TagStackItem tsi, DocTree endTree) { |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
499 |
if (tsi.tag != null && tsi.tree instanceof StartElementTree) { |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
500 |
if (tsi.tag.flags.contains(HtmlTag.Flag.EXPECT_CONTENT) |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
501 |
&& !tsi.flags.contains(Flag.HAS_TEXT) |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
502 |
&& !tsi.flags.contains(Flag.HAS_ELEMENT) |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
503 |
&& !tsi.flags.contains(Flag.HAS_INLINE_TAG)) { |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
504 |
DocTree tree = (endTree != null) ? endTree : tsi.tree; |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
505 |
Name treeName = ((StartElementTree) tsi.tree).getName(); |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
506 |
env.messages.warning(HTML, tree, "dc.tag.empty", treeName); |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
507 |
} |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
508 |
} |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
509 |
} |
f61558e07e14
8026368: doclint does not report empty tags when tag closed implicitly
jjg
parents:
20256
diff
changeset
|
510 |
|
14952 | 511 |
// </editor-fold> |
512 |
||
513 |
// <editor-fold defaultstate="collapsed" desc="HTML attributes"> |
|
514 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
515 |
@Override @DefinedBy(Api.COMPILER_TREE) @SuppressWarnings("fallthrough") |
14952 | 516 |
public Void visitAttribute(AttributeTree tree, Void ignore) { |
517 |
HtmlTag currTag = tagStack.peek().tag; |
|
518 |
if (currTag != null) { |
|
519 |
Name name = tree.getName(); |
|
520 |
HtmlTag.Attr attr = currTag.getAttr(name); |
|
521 |
if (attr != null) { |
|
522 |
boolean first = tagStack.peek().attrs.add(attr); |
|
523 |
if (!first) |
|
524 |
env.messages.error(HTML, tree, "dc.attr.repeated", name); |
|
525 |
} |
|
526 |
AttrKind k = currTag.getAttrKind(name); |
|
527 |
switch (k) { |
|
528 |
case OK: |
|
529 |
break; |
|
530 |
||
531 |
case INVALID: |
|
532 |
env.messages.error(HTML, tree, "dc.attr.unknown", name); |
|
533 |
break; |
|
534 |
||
535 |
case OBSOLETE: |
|
536 |
env.messages.warning(ACCESSIBILITY, tree, "dc.attr.obsolete", name); |
|
537 |
break; |
|
538 |
||
539 |
case USE_CSS: |
|
540 |
env.messages.warning(ACCESSIBILITY, tree, "dc.attr.obsolete.use.css", name); |
|
541 |
break; |
|
542 |
} |
|
543 |
||
544 |
if (attr != null) { |
|
545 |
switch (attr) { |
|
546 |
case NAME: |
|
547 |
if (currTag != HtmlTag.A) { |
|
548 |
break; |
|
549 |
} |
|
15359 | 550 |
// fallthrough |
14952 | 551 |
case ID: |
552 |
String value = getAttrValue(tree); |
|
15359 | 553 |
if (value == null) { |
554 |
env.messages.error(HTML, tree, "dc.anchor.value.missing"); |
|
555 |
} else { |
|
556 |
if (!validName.matcher(value).matches()) { |
|
557 |
env.messages.error(HTML, tree, "dc.invalid.anchor", value); |
|
558 |
} |
|
19120
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
559 |
if (!checkAnchor(value)) { |
15359 | 560 |
env.messages.error(HTML, tree, "dc.anchor.already.defined", value); |
561 |
} |
|
14952 | 562 |
} |
563 |
break; |
|
564 |
||
565 |
case HREF: |
|
566 |
if (currTag == HtmlTag.A) { |
|
567 |
String v = getAttrValue(tree); |
|
568 |
if (v == null || v.isEmpty()) { |
|
569 |
env.messages.error(HTML, tree, "dc.attr.lacks.value"); |
|
570 |
} else { |
|
571 |
Matcher m = docRoot.matcher(v); |
|
572 |
if (m.matches()) { |
|
573 |
String rest = m.group(2); |
|
574 |
if (!rest.isEmpty()) |
|
575 |
checkURI(tree, rest); |
|
576 |
} else { |
|
577 |
checkURI(tree, v); |
|
578 |
} |
|
579 |
} |
|
580 |
} |
|
581 |
break; |
|
18001 | 582 |
|
583 |
case VALUE: |
|
584 |
if (currTag == HtmlTag.LI) { |
|
585 |
String v = getAttrValue(tree); |
|
586 |
if (v == null || v.isEmpty()) { |
|
587 |
env.messages.error(HTML, tree, "dc.attr.lacks.value"); |
|
588 |
} else if (!validNumber.matcher(v).matches()) { |
|
589 |
env.messages.error(HTML, tree, "dc.attr.not.number"); |
|
590 |
} |
|
591 |
} |
|
592 |
break; |
|
14952 | 593 |
} |
594 |
} |
|
595 |
} |
|
596 |
||
597 |
// TODO: basic check on value |
|
598 |
||
599 |
return super.visitAttribute(tree, ignore); |
|
600 |
} |
|
601 |
||
19120
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
602 |
private boolean checkAnchor(String name) { |
20254
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
603 |
Element e = getEnclosingPackageOrClass(env.currElement); |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
604 |
if (e == null) |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
605 |
return true; |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
606 |
Set<String> set = foundAnchors.get(e); |
19120
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
607 |
if (set == null) |
20254
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
608 |
foundAnchors.put(e, set = new HashSet<>()); |
19120
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
609 |
return set.add(name); |
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
610 |
} |
7766f69bffc7
8020313: doclint doesn't reset HTML anchors correctly
jjg
parents:
18001
diff
changeset
|
611 |
|
20254
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
612 |
private Element getEnclosingPackageOrClass(Element e) { |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
613 |
while (e != null) { |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
614 |
switch (e.getKind()) { |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
615 |
case CLASS: |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
616 |
case ENUM: |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
617 |
case INTERFACE: |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
618 |
case PACKAGE: |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
619 |
return e; |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
620 |
default: |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
621 |
e = e.getEnclosingElement(); |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
622 |
} |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
623 |
} |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
624 |
return e; |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
625 |
} |
8246fe4d6638
8025246: [doclint] doclint is showing error on anchor already defined when it's not
jjg
parents:
19125
diff
changeset
|
626 |
|
14952 | 627 |
// http://www.w3.org/TR/html401/types.html#type-name |
628 |
private static final Pattern validName = Pattern.compile("[A-Za-z][A-Za-z0-9-_:.]*"); |
|
629 |
||
18001 | 630 |
private static final Pattern validNumber = Pattern.compile("-?[0-9]+"); |
631 |
||
14952 | 632 |
// pattern to remove leading {@docRoot}/? |
633 |
private static final Pattern docRoot = Pattern.compile("(?i)(\\{@docRoot *\\}/?)?(.*)"); |
|
634 |
||
635 |
private String getAttrValue(AttributeTree tree) { |
|
636 |
if (tree.getValue() == null) |
|
637 |
return null; |
|
638 |
||
639 |
StringWriter sw = new StringWriter(); |
|
640 |
try { |
|
641 |
new DocPretty(sw).print(tree.getValue()); |
|
642 |
} catch (IOException e) { |
|
643 |
// cannot happen |
|
644 |
} |
|
645 |
// ignore potential use of entities for now |
|
646 |
return sw.toString(); |
|
647 |
} |
|
648 |
||
649 |
private void checkURI(AttributeTree tree, String uri) { |
|
650 |
try { |
|
651 |
URI u = new URI(uri); |
|
652 |
} catch (URISyntaxException e) { |
|
653 |
env.messages.error(HTML, tree, "dc.invalid.uri", uri); |
|
654 |
} |
|
655 |
} |
|
656 |
// </editor-fold> |
|
657 |
||
658 |
// <editor-fold defaultstate="collapsed" desc="javadoc tags"> |
|
659 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
660 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 661 |
public Void visitAuthor(AuthorTree tree, Void ignore) { |
662 |
warnIfEmpty(tree, tree.getName()); |
|
663 |
return super.visitAuthor(tree, ignore); |
|
664 |
} |
|
665 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
666 |
@Override @DefinedBy(Api.COMPILER_TREE) |
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
667 |
public Void visitDocRoot(DocRootTree tree, Void ignore) { |
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
668 |
markEnclosingTag(Flag.HAS_INLINE_TAG); |
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
669 |
return super.visitDocRoot(tree, ignore); |
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
670 |
} |
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
671 |
|
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
672 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 673 |
public Void visitInheritDoc(InheritDocTree tree, Void ignore) { |
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
674 |
markEnclosingTag(Flag.HAS_INLINE_TAG); |
14952 | 675 |
// TODO: verify on overridden method |
676 |
foundInheritDoc = true; |
|
677 |
return super.visitInheritDoc(tree, ignore); |
|
678 |
} |
|
679 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
680 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 681 |
public Void visitLink(LinkTree tree, Void ignore) { |
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
682 |
markEnclosingTag(Flag.HAS_INLINE_TAG); |
14952 | 683 |
// simulate inline context on tag stack |
684 |
HtmlTag t = (tree.getKind() == DocTree.Kind.LINK) |
|
685 |
? HtmlTag.CODE : HtmlTag.SPAN; |
|
686 |
tagStack.push(new TagStackItem(tree, t)); |
|
687 |
try { |
|
688 |
return super.visitLink(tree, ignore); |
|
689 |
} finally { |
|
690 |
tagStack.pop(); |
|
691 |
} |
|
692 |
} |
|
693 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
694 |
@Override @DefinedBy(Api.COMPILER_TREE) |
15363 | 695 |
public Void visitLiteral(LiteralTree tree, Void ignore) { |
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
696 |
markEnclosingTag(Flag.HAS_INLINE_TAG); |
15363 | 697 |
if (tree.getKind() == DocTree.Kind.CODE) { |
698 |
for (TagStackItem tsi: tagStack) { |
|
699 |
if (tsi.tag == HtmlTag.CODE) { |
|
15366
545307ec740c
8006228: Doclint doesn't detect <code> {@code nested inline} </code>
jjg
parents:
15363
diff
changeset
|
700 |
env.messages.warning(HTML, tree, "dc.tag.code.within.code"); |
15363 | 701 |
break; |
702 |
} |
|
703 |
} |
|
704 |
} |
|
705 |
return super.visitLiteral(tree, ignore); |
|
706 |
} |
|
707 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
708 |
@Override @DefinedBy(Api.COMPILER_TREE) |
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
709 |
@SuppressWarnings("fallthrough") |
14952 | 710 |
public Void visitParam(ParamTree tree, Void ignore) { |
711 |
boolean typaram = tree.isTypeParameter(); |
|
712 |
IdentifierTree nameTree = tree.getName(); |
|
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
713 |
Element paramElement = nameTree != null ? env.trees.getElement(new DocTreePath(getCurrentPath(), nameTree)) : null; |
14952 | 714 |
|
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
715 |
if (paramElement == null) { |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
716 |
switch (env.currElement.getKind()) { |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
717 |
case CLASS: case INTERFACE: { |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
718 |
if (!typaram) { |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
719 |
env.messages.error(REFERENCE, tree, "dc.invalid.param"); |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
720 |
break; |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
721 |
} |
14952 | 722 |
} |
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
723 |
case METHOD: case CONSTRUCTOR: { |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
724 |
env.messages.error(REFERENCE, nameTree, "dc.param.name.not.found"); |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
725 |
break; |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
726 |
} |
14952 | 727 |
|
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
728 |
default: |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
729 |
env.messages.error(REFERENCE, tree, "dc.invalid.param"); |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
730 |
break; |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
731 |
} |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
732 |
} else { |
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
733 |
foundParams.add(paramElement); |
14952 | 734 |
} |
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
735 |
|
14952 | 736 |
warnIfEmpty(tree, tree.getDescription()); |
737 |
return super.visitParam(tree, ignore); |
|
738 |
} |
|
739 |
||
740 |
private void checkParamsDocumented(List<? extends Element> list) { |
|
741 |
if (foundInheritDoc) |
|
742 |
return; |
|
743 |
||
744 |
for (Element e: list) { |
|
745 |
if (!foundParams.contains(e)) { |
|
746 |
CharSequence paramName = (e.getKind() == ElementKind.TYPE_PARAMETER) |
|
747 |
? "<" + e.getSimpleName() + ">" |
|
748 |
: e.getSimpleName(); |
|
749 |
reportMissing("dc.missing.param", paramName); |
|
750 |
} |
|
751 |
} |
|
752 |
} |
|
753 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
754 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 755 |
public Void visitReference(ReferenceTree tree, Void ignore) { |
20256
9154c5cc0d9f
8002154: [doclint] doclint should check for issues which are errors in javadoc
jjg
parents:
20255
diff
changeset
|
756 |
String sig = tree.getSignature(); |
9154c5cc0d9f
8002154: [doclint] doclint should check for issues which are errors in javadoc
jjg
parents:
20255
diff
changeset
|
757 |
if (sig.contains("<") || sig.contains(">")) |
9154c5cc0d9f
8002154: [doclint] doclint should check for issues which are errors in javadoc
jjg
parents:
20255
diff
changeset
|
758 |
env.messages.error(REFERENCE, tree, "dc.type.arg.not.allowed"); |
9154c5cc0d9f
8002154: [doclint] doclint should check for issues which are errors in javadoc
jjg
parents:
20255
diff
changeset
|
759 |
|
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
760 |
Element e = env.trees.getElement(getCurrentPath()); |
14952 | 761 |
if (e == null) |
762 |
env.messages.error(REFERENCE, tree, "dc.ref.not.found"); |
|
763 |
return super.visitReference(tree, ignore); |
|
764 |
} |
|
765 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
766 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 767 |
public Void visitReturn(ReturnTree tree, Void ignore) { |
768 |
Element e = env.trees.getElement(env.currPath); |
|
769 |
if (e.getKind() != ElementKind.METHOD |
|
770 |
|| ((ExecutableElement) e).getReturnType().getKind() == TypeKind.VOID) |
|
771 |
env.messages.error(REFERENCE, tree, "dc.invalid.return"); |
|
772 |
foundReturn = true; |
|
773 |
warnIfEmpty(tree, tree.getDescription()); |
|
774 |
return super.visitReturn(tree, ignore); |
|
775 |
} |
|
776 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
777 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 778 |
public Void visitSerialData(SerialDataTree tree, Void ignore) { |
779 |
warnIfEmpty(tree, tree.getDescription()); |
|
780 |
return super.visitSerialData(tree, ignore); |
|
781 |
} |
|
782 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
783 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 784 |
public Void visitSerialField(SerialFieldTree tree, Void ignore) { |
785 |
warnIfEmpty(tree, tree.getDescription()); |
|
786 |
return super.visitSerialField(tree, ignore); |
|
787 |
} |
|
788 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
789 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 790 |
public Void visitSince(SinceTree tree, Void ignore) { |
791 |
warnIfEmpty(tree, tree.getBody()); |
|
792 |
return super.visitSince(tree, ignore); |
|
793 |
} |
|
794 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
795 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 796 |
public Void visitThrows(ThrowsTree tree, Void ignore) { |
797 |
ReferenceTree exName = tree.getExceptionName(); |
|
17549
65ea6f3b72d9
8009724: Enhance the DocTree API with DocTreePath
jlahoda
parents:
16799
diff
changeset
|
798 |
Element ex = env.trees.getElement(new DocTreePath(getCurrentPath(), exName)); |
14952 | 799 |
if (ex == null) { |
800 |
env.messages.error(REFERENCE, tree, "dc.ref.not.found"); |
|
19125
db8cab0ecbd9
8020556: doclint does not check type variables for @throws
jjg
parents:
19123
diff
changeset
|
801 |
} else if (isThrowable(ex.asType())) { |
14952 | 802 |
switch (env.currElement.getKind()) { |
803 |
case CONSTRUCTOR: |
|
804 |
case METHOD: |
|
805 |
if (isCheckedException(ex.asType())) { |
|
806 |
ExecutableElement ee = (ExecutableElement) env.currElement; |
|
807 |
checkThrowsDeclared(exName, ex.asType(), ee.getThrownTypes()); |
|
808 |
} |
|
809 |
break; |
|
810 |
default: |
|
811 |
env.messages.error(REFERENCE, tree, "dc.invalid.throws"); |
|
812 |
} |
|
813 |
} else { |
|
814 |
env.messages.error(REFERENCE, tree, "dc.invalid.throws"); |
|
815 |
} |
|
816 |
warnIfEmpty(tree, tree.getDescription()); |
|
817 |
return scan(tree.getDescription(), ignore); |
|
818 |
} |
|
819 |
||
19125
db8cab0ecbd9
8020556: doclint does not check type variables for @throws
jjg
parents:
19123
diff
changeset
|
820 |
private boolean isThrowable(TypeMirror tm) { |
db8cab0ecbd9
8020556: doclint does not check type variables for @throws
jjg
parents:
19123
diff
changeset
|
821 |
switch (tm.getKind()) { |
db8cab0ecbd9
8020556: doclint does not check type variables for @throws
jjg
parents:
19123
diff
changeset
|
822 |
case DECLARED: |
db8cab0ecbd9
8020556: doclint does not check type variables for @throws
jjg
parents:
19123
diff
changeset
|
823 |
case TYPEVAR: |
db8cab0ecbd9
8020556: doclint does not check type variables for @throws
jjg
parents:
19123
diff
changeset
|
824 |
return env.types.isAssignable(tm, env.java_lang_Throwable); |
db8cab0ecbd9
8020556: doclint does not check type variables for @throws
jjg
parents:
19123
diff
changeset
|
825 |
} |
db8cab0ecbd9
8020556: doclint does not check type variables for @throws
jjg
parents:
19123
diff
changeset
|
826 |
return false; |
db8cab0ecbd9
8020556: doclint does not check type variables for @throws
jjg
parents:
19123
diff
changeset
|
827 |
} |
db8cab0ecbd9
8020556: doclint does not check type variables for @throws
jjg
parents:
19123
diff
changeset
|
828 |
|
14952 | 829 |
private void checkThrowsDeclared(ReferenceTree tree, TypeMirror t, List<? extends TypeMirror> list) { |
830 |
boolean found = false; |
|
831 |
for (TypeMirror tl : list) { |
|
832 |
if (env.types.isAssignable(t, tl)) { |
|
833 |
foundThrows.add(tl); |
|
834 |
found = true; |
|
835 |
} |
|
836 |
} |
|
837 |
if (!found) |
|
838 |
env.messages.error(REFERENCE, tree, "dc.exception.not.thrown", t); |
|
839 |
} |
|
840 |
||
841 |
private void checkThrowsDocumented(List<? extends TypeMirror> list) { |
|
842 |
if (foundInheritDoc) |
|
843 |
return; |
|
844 |
||
845 |
for (TypeMirror tl: list) { |
|
846 |
if (isCheckedException(tl) && !foundThrows.contains(tl)) |
|
847 |
reportMissing("dc.missing.throws", tl); |
|
848 |
} |
|
849 |
} |
|
850 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
851 |
@Override @DefinedBy(Api.COMPILER_TREE) |
21500
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
852 |
public Void visitUnknownBlockTag(UnknownBlockTagTree tree, Void ignore) { |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
853 |
checkUnknownTag(tree, tree.getTagName()); |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
854 |
return super.visitUnknownBlockTag(tree, ignore); |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
855 |
} |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
856 |
|
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
857 |
@Override @DefinedBy(Api.COMPILER_TREE) |
21500
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
858 |
public Void visitUnknownInlineTag(UnknownInlineTagTree tree, Void ignore) { |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
859 |
checkUnknownTag(tree, tree.getTagName()); |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
860 |
return super.visitUnknownInlineTag(tree, ignore); |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
861 |
} |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
862 |
|
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
863 |
private void checkUnknownTag(DocTree tree, String tagName) { |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
864 |
if (env.customTags != null && !env.customTags.contains(tagName)) |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
865 |
env.messages.error(SYNTAX, tree, "dc.tag.unknown", tagName); |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
866 |
} |
475e59d3b40c
8006248: Since addition of -Xdoclint, javadoc ignores unknown tags
bpatel
parents:
21017
diff
changeset
|
867 |
|
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
868 |
@Override @DefinedBy(Api.COMPILER_TREE) |
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
869 |
public Void visitValue(ValueTree tree, Void ignore) { |
20255
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
870 |
ReferenceTree ref = tree.getReference(); |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
871 |
if (ref == null || ref.getSignature().isEmpty()) { |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
872 |
if (!isConstant(env.currElement)) |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
873 |
env.messages.error(REFERENCE, tree, "dc.value.not.allowed.here"); |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
874 |
} else { |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
875 |
Element e = env.trees.getElement(new DocTreePath(getCurrentPath(), ref)); |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
876 |
if (!isConstant(e)) |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
877 |
env.messages.error(REFERENCE, tree, "dc.value.not.a.constant"); |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
878 |
} |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
879 |
|
16562
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
880 |
markEnclosingTag(Flag.HAS_INLINE_TAG); |
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
881 |
return super.visitValue(tree, ignore); |
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
882 |
} |
9f09744e221a
8010317: DocLint incorrectly reports some <pre> tags as empty
jjg
parents:
15707
diff
changeset
|
883 |
|
20255
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
884 |
private boolean isConstant(Element e) { |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
885 |
if (e == null) |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
886 |
return false; |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
887 |
|
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
888 |
switch (e.getKind()) { |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
889 |
case FIELD: |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
890 |
Object value = ((VariableElement) e).getConstantValue(); |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
891 |
return (value != null); // can't distinguish "not a constant" from "constant is null" |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
892 |
default: |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
893 |
return false; |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
894 |
} |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
895 |
} |
f8be1ea20e1a
8025272: doclint needs to check for valid usage of @value tag
jjg
parents:
20254
diff
changeset
|
896 |
|
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
897 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 898 |
public Void visitVersion(VersionTree tree, Void ignore) { |
899 |
warnIfEmpty(tree, tree.getBody()); |
|
900 |
return super.visitVersion(tree, ignore); |
|
901 |
} |
|
902 |
||
26266
2d24bda701dc
8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents:
25874
diff
changeset
|
903 |
@Override @DefinedBy(Api.COMPILER_TREE) |
14952 | 904 |
public Void visitErroneous(ErroneousTree tree, Void ignore) { |
905 |
env.messages.error(SYNTAX, tree, null, tree.getDiagnostic().getMessage(null)); |
|
906 |
return null; |
|
907 |
} |
|
908 |
// </editor-fold> |
|
909 |
||
910 |
// <editor-fold defaultstate="collapsed" desc="Utility methods"> |
|
911 |
||
912 |
private boolean isCheckedException(TypeMirror t) { |
|
913 |
return !(env.types.isAssignable(t, env.java_lang_Error) |
|
914 |
|| env.types.isAssignable(t, env.java_lang_RuntimeException)); |
|
915 |
} |
|
916 |
||
917 |
private boolean isSynthetic() { |
|
918 |
switch (env.currElement.getKind()) { |
|
919 |
case CONSTRUCTOR: |
|
920 |
// A synthetic default constructor has the same pos as the |
|
921 |
// enclosing class |
|
922 |
TreePath p = env.currPath; |
|
923 |
return env.getPos(p) == env.getPos(p.getParentPath()); |
|
924 |
} |
|
925 |
return false; |
|
926 |
} |
|
927 |
||
928 |
void markEnclosingTag(Flag flag) { |
|
929 |
TagStackItem top = tagStack.peek(); |
|
930 |
if (top != null) |
|
931 |
top.flags.add(flag); |
|
932 |
} |
|
933 |
||
934 |
String toString(TreePath p) { |
|
935 |
StringBuilder sb = new StringBuilder("TreePath["); |
|
936 |
toString(p, sb); |
|
937 |
sb.append("]"); |
|
938 |
return sb.toString(); |
|
939 |
} |
|
940 |
||
941 |
void toString(TreePath p, StringBuilder sb) { |
|
942 |
TreePath parent = p.getParentPath(); |
|
943 |
if (parent != null) { |
|
944 |
toString(parent, sb); |
|
945 |
sb.append(","); |
|
946 |
} |
|
947 |
sb.append(p.getLeaf().getKind()).append(":").append(env.getPos(p)).append(":S").append(env.getStartPos(p)); |
|
948 |
} |
|
949 |
||
950 |
void warnIfEmpty(DocTree tree, List<? extends DocTree> list) { |
|
951 |
for (DocTree d: list) { |
|
952 |
switch (d.getKind()) { |
|
953 |
case TEXT: |
|
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
954 |
if (hasNonWhitespace((TextTree) d)) |
14952 | 955 |
return; |
956 |
break; |
|
957 |
default: |
|
958 |
return; |
|
959 |
} |
|
960 |
} |
|
961 |
env.messages.warning(SYNTAX, tree, "dc.empty", tree.getKind().tagName); |
|
962 |
} |
|
15371
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
963 |
|
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
964 |
boolean hasNonWhitespace(TextTree tree) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
965 |
String s = tree.getBody(); |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
966 |
for (int i = 0; i < s.length(); i++) { |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
967 |
if (!Character.isWhitespace(s.charAt(i))) |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
968 |
return true; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
969 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
970 |
return false; |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
971 |
} |
8f719dc43e1f
8006251: doclint: incorrect position for diagnostic for illegal text in tags
jjg
parents:
15370
diff
changeset
|
972 |
|
14952 | 973 |
// </editor-fold> |
974 |
||
975 |
} |