Mercurial > jdk8-mips64-public > langtools / file revision
src/share/classes/com/sun/tools/doclint/Checker.java@1e533c1bfb01
src/share/classes/com/sun/tools/doclint/Checker.java
Wed, 17 Jul 2013 19:12:03 -0700
- author
- jjg
- date
- Wed, 17 Jul 2013 19:12:03 -0700
- changeset 1912
- 1e533c1bfb01
- parent 1793
- 391f97e270c2
- child 1915
- 129751018061
- permissions
- -rw-r--r--
8020313: doclint doesn't reset HTML anchors correctly
Reviewed-by: mcimadamore
1 /*
2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
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 */
26 package com.sun.tools.doclint;
28 import java.io.IOException;
29 import java.io.StringWriter;
30 import java.net.URI;
31 import java.net.URISyntaxException;
32 import java.util.Deque;
33 import java.util.EnumSet;
34 import java.util.HashMap;
35 import java.util.HashSet;
36 import java.util.LinkedList;
37 import java.util.List;
38 import java.util.Map;
39 import java.util.Set;
40 import java.util.regex.Matcher;
41 import java.util.regex.Pattern;
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;
47 import javax.lang.model.type.TypeKind;
48 import javax.lang.model.type.TypeMirror;
49 import javax.tools.Diagnostic.Kind;
50 import javax.tools.JavaFileObject;
52 import com.sun.source.doctree.AttributeTree;
53 import com.sun.source.doctree.AuthorTree;
54 import com.sun.source.doctree.DocCommentTree;
55 import com.sun.source.doctree.DocRootTree;
56 import com.sun.source.doctree.DocTree;
57 import com.sun.source.doctree.EndElementTree;
58 import com.sun.source.doctree.EntityTree;
59 import com.sun.source.doctree.ErroneousTree;
60 import com.sun.source.doctree.IdentifierTree;
61 import com.sun.source.doctree.InheritDocTree;
62 import com.sun.source.doctree.LinkTree;
63 import com.sun.source.doctree.LiteralTree;
64 import com.sun.source.doctree.ParamTree;
65 import com.sun.source.doctree.ReferenceTree;
66 import com.sun.source.doctree.ReturnTree;
67 import com.sun.source.doctree.SerialDataTree;
68 import com.sun.source.doctree.SerialFieldTree;
69 import com.sun.source.doctree.SinceTree;
70 import com.sun.source.doctree.StartElementTree;
71 import com.sun.source.doctree.TextTree;
72 import com.sun.source.doctree.ThrowsTree;
73 import com.sun.source.doctree.ValueTree;
74 import com.sun.source.doctree.VersionTree;
75 import com.sun.source.util.DocTreePath;
76 import com.sun.source.util.DocTreePathScanner;
77 import com.sun.source.util.TreePath;
78 import com.sun.tools.doclint.HtmlTag.AttrKind;
79 import com.sun.tools.javac.tree.DocPretty;
80 import static com.sun.tools.doclint.Messages.Group.*;
83 /**
84 * Validate a doc comment.
85 *
86 * <p><b>This is NOT part of any supported API.
87 * If you write code that depends on this, you do so at your own
88 * risk. This code and its internal interfaces are subject to change
89 * or deletion without notice.</b></p>
90 */
91 public class Checker extends DocTreePathScanner<Void, Void> {
92 final Env env;
94 Set<Element> foundParams = new HashSet<>();
95 Set<TypeMirror> foundThrows = new HashSet<>();
96 Map<JavaFileObject, Set<String>> foundAnchors = new HashMap<>();
97 boolean foundInheritDoc = false;
98 boolean foundReturn = false;
100 public enum Flag {
101 TABLE_HAS_CAPTION,
102 HAS_ELEMENT,
103 HAS_INLINE_TAG,
104 HAS_TEXT,
105 REPORTED_BAD_INLINE
106 }
108 static class TagStackItem {
109 final DocTree tree; // typically, but not always, StartElementTree
110 final HtmlTag tag;
111 final Set<HtmlTag.Attr> attrs;
112 final Set<Flag> flags;
113 TagStackItem(DocTree tree, HtmlTag tag) {
114 this.tree = tree;
115 this.tag = tag;
116 attrs = EnumSet.noneOf(HtmlTag.Attr.class);
117 flags = EnumSet.noneOf(Flag.class);
118 }
119 @Override
120 public String toString() {
121 return String.valueOf(tag);
122 }
123 }
125 private Deque<TagStackItem> tagStack; // TODO: maybe want to record starting tree as well
126 private HtmlTag currHeaderTag;
128 private final int implicitHeaderLevel;
130 // <editor-fold defaultstate="collapsed" desc="Top level">
132 Checker(Env env) {
133 env.getClass();
134 this.env = env;
135 tagStack = new LinkedList<>();
136 implicitHeaderLevel = env.implicitHeaderLevel;
137 }
139 public Void scan(DocCommentTree tree, TreePath p) {
140 env.setCurrent(p, tree);
142 boolean isOverridingMethod = !env.currOverriddenMethods.isEmpty();
144 if (tree == null) {
145 if (!isSynthetic() && !isOverridingMethod)
146 reportMissing("dc.missing.comment");
147 return null;
148 }
150 tagStack.clear();
151 currHeaderTag = null;
153 foundParams.clear();
154 foundThrows.clear();
155 foundInheritDoc = false;
156 foundReturn = false;
158 scan(new DocTreePath(p, tree), null);
160 if (!isOverridingMethod) {
161 switch (env.currElement.getKind()) {
162 case METHOD:
163 case CONSTRUCTOR: {
164 ExecutableElement ee = (ExecutableElement) env.currElement;
165 checkParamsDocumented(ee.getTypeParameters());
166 checkParamsDocumented(ee.getParameters());
167 switch (ee.getReturnType().getKind()) {
168 case VOID:
169 case NONE:
170 break;
171 default:
172 if (!foundReturn
173 && !foundInheritDoc
174 && !env.types.isSameType(ee.getReturnType(), env.java_lang_Void)) {
175 reportMissing("dc.missing.return");
176 }
177 }
178 checkThrowsDocumented(ee.getThrownTypes());
179 }
180 }
181 }
183 return null;
184 }
186 private void reportMissing(String code, Object... args) {
187 env.messages.report(MISSING, Kind.WARNING, env.currPath.getLeaf(), code, args);
188 }
190 @Override
191 public Void visitDocComment(DocCommentTree tree, Void ignore) {
192 super.visitDocComment(tree, ignore);
193 for (TagStackItem tsi: tagStack) {
194 if (tsi.tree.getKind() == DocTree.Kind.START_ELEMENT
195 && tsi.tag.endKind == HtmlTag.EndKind.REQUIRED) {
196 StartElementTree t = (StartElementTree) tsi.tree;
197 env.messages.error(HTML, t, "dc.tag.not.closed", t.getName());
198 }
199 }
200 return null;
201 }
202 // </editor-fold>
204 // <editor-fold defaultstate="collapsed" desc="Text and entities.">
206 @Override
207 public Void visitText(TextTree tree, Void ignore) {
208 if (hasNonWhitespace(tree)) {
209 checkAllowsText(tree);
210 markEnclosingTag(Flag.HAS_TEXT);
211 }
212 return null;
213 }
215 @Override
216 public Void visitEntity(EntityTree tree, Void ignore) {
217 checkAllowsText(tree);
218 markEnclosingTag(Flag.HAS_TEXT);
219 String name = tree.getName().toString();
220 if (name.startsWith("#")) {
221 int v = name.toLowerCase().startsWith("#x")
222 ? Integer.parseInt(name.substring(2), 16)
223 : Integer.parseInt(name.substring(1), 10);
224 if (!Entity.isValid(v)) {
225 env.messages.error(HTML, tree, "dc.entity.invalid", name);
226 }
227 } else if (!Entity.isValid(name)) {
228 env.messages.error(HTML, tree, "dc.entity.invalid", name);
229 }
230 return null;
231 }
233 void checkAllowsText(DocTree tree) {
234 TagStackItem top = tagStack.peek();
235 if (top != null
236 && top.tree.getKind() == DocTree.Kind.START_ELEMENT
237 && !top.tag.acceptsText()) {
238 if (top.flags.add(Flag.REPORTED_BAD_INLINE)) {
239 env.messages.error(HTML, tree, "dc.text.not.allowed",
240 ((StartElementTree) top.tree).getName());
241 }
242 }
243 }
245 // </editor-fold>
247 // <editor-fold defaultstate="collapsed" desc="HTML elements">
249 @Override
250 public Void visitStartElement(StartElementTree tree, Void ignore) {
251 markEnclosingTag(Flag.HAS_ELEMENT);
252 final Name treeName = tree.getName();
253 final HtmlTag t = HtmlTag.get(treeName);
254 if (t == null) {
255 env.messages.error(HTML, tree, "dc.tag.unknown", treeName);
256 } else {
257 boolean done = false;
258 for (TagStackItem tsi: tagStack) {
259 if (tsi.tag.accepts(t)) {
260 while (tagStack.peek() != tsi) tagStack.pop();
261 done = true;
262 break;
263 } else if (tsi.tag.endKind != HtmlTag.EndKind.OPTIONAL) {
264 done = true;
265 break;
266 }
267 }
268 if (!done && HtmlTag.BODY.accepts(t)) {
269 tagStack.clear();
270 }
272 checkStructure(tree, t);
274 // tag specific checks
275 switch (t) {
276 // check for out of sequence headers, such as <h1>...</h1> <h3>...</h3>
277 case H1: case H2: case H3: case H4: case H5: case H6:
278 checkHeader(tree, t);
279 break;
280 }
282 if (t.flags.contains(HtmlTag.Flag.NO_NEST)) {
283 for (TagStackItem i: tagStack) {
284 if (t == i.tag) {
285 env.messages.warning(HTML, tree, "dc.tag.nested.not.allowed", treeName);
286 break;
287 }
288 }
289 }
290 }
292 // check for self closing tags, such as <a id="name"/>
293 if (tree.isSelfClosing()) {
294 env.messages.error(HTML, tree, "dc.tag.self.closing", treeName);
295 }
297 try {
298 TagStackItem parent = tagStack.peek();
299 TagStackItem top = new TagStackItem(tree, t);
300 tagStack.push(top);
302 super.visitStartElement(tree, ignore);
304 // handle attributes that may or may not have been found in start element
305 if (t != null) {
306 switch (t) {
307 case CAPTION:
308 if (parent != null && parent.tag == HtmlTag.TABLE)
309 parent.flags.add(Flag.TABLE_HAS_CAPTION);
310 break;
312 case IMG:
313 if (!top.attrs.contains(HtmlTag.Attr.ALT))
314 env.messages.error(ACCESSIBILITY, tree, "dc.no.alt.attr.for.image");
315 break;
316 }
317 }
319 return null;
320 } finally {
322 if (t == null || t.endKind == HtmlTag.EndKind.NONE)
323 tagStack.pop();
324 }
325 }
327 private void checkStructure(StartElementTree tree, HtmlTag t) {
328 Name treeName = tree.getName();
329 TagStackItem top = tagStack.peek();
330 switch (t.blockType) {
331 case BLOCK:
332 if (top == null || top.tag.accepts(t))
333 return;
335 switch (top.tree.getKind()) {
336 case START_ELEMENT: {
337 if (top.tag.blockType == HtmlTag.BlockType.INLINE) {
338 Name name = ((StartElementTree) top.tree).getName();
339 env.messages.error(HTML, tree, "dc.tag.not.allowed.inline.element",
340 treeName, name);
341 return;
342 }
343 }
344 break;
346 case LINK:
347 case LINK_PLAIN: {
348 String name = top.tree.getKind().tagName;
349 env.messages.error(HTML, tree, "dc.tag.not.allowed.inline.tag",
350 treeName, name);
351 return;
352 }
353 }
354 break;
356 case INLINE:
357 if (top == null || top.tag.accepts(t))
358 return;
359 break;
361 case LIST_ITEM:
362 case TABLE_ITEM:
363 if (top != null) {
364 // reset this flag so subsequent bad inline content gets reported
365 top.flags.remove(Flag.REPORTED_BAD_INLINE);
366 if (top.tag.accepts(t))
367 return;
368 }
369 break;
371 case OTHER:
372 env.messages.error(HTML, tree, "dc.tag.not.allowed", treeName);
373 return;
374 }
376 env.messages.error(HTML, tree, "dc.tag.not.allowed.here", treeName);
377 }
379 private void checkHeader(StartElementTree tree, HtmlTag tag) {
380 // verify the new tag
381 if (getHeaderLevel(tag) > getHeaderLevel(currHeaderTag) + 1) {
382 if (currHeaderTag == null) {
383 env.messages.error(ACCESSIBILITY, tree, "dc.tag.header.sequence.1", tag);
384 } else {
385 env.messages.error(ACCESSIBILITY, tree, "dc.tag.header.sequence.2",
386 tag, currHeaderTag);
387 }
388 }
390 currHeaderTag = tag;
391 }
393 private int getHeaderLevel(HtmlTag tag) {
394 if (tag == null)
395 return implicitHeaderLevel;
396 switch (tag) {
397 case H1: return 1;
398 case H2: return 2;
399 case H3: return 3;
400 case H4: return 4;
401 case H5: return 5;
402 case H6: return 6;
403 default: throw new IllegalArgumentException();
404 }
405 }
407 @Override
408 public Void visitEndElement(EndElementTree tree, Void ignore) {
409 final Name treeName = tree.getName();
410 final HtmlTag t = HtmlTag.get(treeName);
411 if (t == null) {
412 env.messages.error(HTML, tree, "dc.tag.unknown", treeName);
413 } else if (t.endKind == HtmlTag.EndKind.NONE) {
414 env.messages.error(HTML, tree, "dc.tag.end.not.permitted", treeName);
415 } else {
416 boolean done = false;
417 while (!tagStack.isEmpty()) {
418 TagStackItem top = tagStack.peek();
419 if (t == top.tag) {
420 switch (t) {
421 case TABLE:
422 if (!top.attrs.contains(HtmlTag.Attr.SUMMARY)
423 && !top.flags.contains(Flag.TABLE_HAS_CAPTION)) {
424 env.messages.error(ACCESSIBILITY, tree,
425 "dc.no.summary.or.caption.for.table");
426 }
427 }
428 if (t.flags.contains(HtmlTag.Flag.EXPECT_CONTENT)
429 && !top.flags.contains(Flag.HAS_TEXT)
430 && !top.flags.contains(Flag.HAS_ELEMENT)
431 && !top.flags.contains(Flag.HAS_INLINE_TAG)) {
432 env.messages.warning(HTML, tree, "dc.tag.empty", treeName);
433 }
434 tagStack.pop();
435 done = true;
436 break;
437 } else if (top.tag == null || top.tag.endKind != HtmlTag.EndKind.REQUIRED) {
438 tagStack.pop();
439 } else {
440 boolean found = false;
441 for (TagStackItem si: tagStack) {
442 if (si.tag == t) {
443 found = true;
444 break;
445 }
446 }
447 if (found && top.tree.getKind() == DocTree.Kind.START_ELEMENT) {
448 env.messages.error(HTML, top.tree, "dc.tag.start.unmatched",
449 ((StartElementTree) top.tree).getName());
450 tagStack.pop();
451 } else {
452 env.messages.error(HTML, tree, "dc.tag.end.unexpected", treeName);
453 done = true;
454 break;
455 }
456 }
457 }
459 if (!done && tagStack.isEmpty()) {
460 env.messages.error(HTML, tree, "dc.tag.end.unexpected", treeName);
461 }
462 }
464 return super.visitEndElement(tree, ignore);
465 }
466 // </editor-fold>
468 // <editor-fold defaultstate="collapsed" desc="HTML attributes">
470 @Override @SuppressWarnings("fallthrough")
471 public Void visitAttribute(AttributeTree tree, Void ignore) {
472 HtmlTag currTag = tagStack.peek().tag;
473 if (currTag != null) {
474 Name name = tree.getName();
475 HtmlTag.Attr attr = currTag.getAttr(name);
476 if (attr != null) {
477 boolean first = tagStack.peek().attrs.add(attr);
478 if (!first)
479 env.messages.error(HTML, tree, "dc.attr.repeated", name);
480 }
481 AttrKind k = currTag.getAttrKind(name);
482 switch (k) {
483 case OK:
484 break;
486 case INVALID:
487 env.messages.error(HTML, tree, "dc.attr.unknown", name);
488 break;
490 case OBSOLETE:
491 env.messages.warning(ACCESSIBILITY, tree, "dc.attr.obsolete", name);
492 break;
494 case USE_CSS:
495 env.messages.warning(ACCESSIBILITY, tree, "dc.attr.obsolete.use.css", name);
496 break;
497 }
499 if (attr != null) {
500 switch (attr) {
501 case NAME:
502 if (currTag != HtmlTag.A) {
503 break;
504 }
505 // fallthrough
506 case ID:
507 String value = getAttrValue(tree);
508 if (value == null) {
509 env.messages.error(HTML, tree, "dc.anchor.value.missing");
510 } else {
511 if (!validName.matcher(value).matches()) {
512 env.messages.error(HTML, tree, "dc.invalid.anchor", value);
513 }
514 if (!checkAnchor(value)) {
515 env.messages.error(HTML, tree, "dc.anchor.already.defined", value);
516 }
517 }
518 break;
520 case HREF:
521 if (currTag == HtmlTag.A) {
522 String v = getAttrValue(tree);
523 if (v == null || v.isEmpty()) {
524 env.messages.error(HTML, tree, "dc.attr.lacks.value");
525 } else {
526 Matcher m = docRoot.matcher(v);
527 if (m.matches()) {
528 String rest = m.group(2);
529 if (!rest.isEmpty())
530 checkURI(tree, rest);
531 } else {
532 checkURI(tree, v);
533 }
534 }
535 }
536 break;
538 case VALUE:
539 if (currTag == HtmlTag.LI) {
540 String v = getAttrValue(tree);
541 if (v == null || v.isEmpty()) {
542 env.messages.error(HTML, tree, "dc.attr.lacks.value");
543 } else if (!validNumber.matcher(v).matches()) {
544 env.messages.error(HTML, tree, "dc.attr.not.number");
545 }
546 }
547 break;
548 }
549 }
550 }
552 // TODO: basic check on value
554 return super.visitAttribute(tree, ignore);
555 }
557 private boolean checkAnchor(String name) {
558 JavaFileObject fo = env.currPath.getCompilationUnit().getSourceFile();
559 Set<String> set = foundAnchors.get(fo);
560 if (set == null)
561 foundAnchors.put(fo, set = new HashSet<>());
562 return set.add(name);
563 }
565 // http://www.w3.org/TR/html401/types.html#type-name
566 private static final Pattern validName = Pattern.compile("[A-Za-z][A-Za-z0-9-_:.]*");
568 private static final Pattern validNumber = Pattern.compile("-?[0-9]+");
570 // pattern to remove leading {@docRoot}/?
571 private static final Pattern docRoot = Pattern.compile("(?i)(\\{@docRoot *\\}/?)?(.*)");
573 private String getAttrValue(AttributeTree tree) {
574 if (tree.getValue() == null)
575 return null;
577 StringWriter sw = new StringWriter();
578 try {
579 new DocPretty(sw).print(tree.getValue());
580 } catch (IOException e) {
581 // cannot happen
582 }
583 // ignore potential use of entities for now
584 return sw.toString();
585 }
587 private void checkURI(AttributeTree tree, String uri) {
588 try {
589 URI u = new URI(uri);
590 } catch (URISyntaxException e) {
591 env.messages.error(HTML, tree, "dc.invalid.uri", uri);
592 }
593 }
594 // </editor-fold>
596 // <editor-fold defaultstate="collapsed" desc="javadoc tags">
598 @Override
599 public Void visitAuthor(AuthorTree tree, Void ignore) {
600 warnIfEmpty(tree, tree.getName());
601 return super.visitAuthor(tree, ignore);
602 }
604 @Override
605 public Void visitDocRoot(DocRootTree tree, Void ignore) {
606 markEnclosingTag(Flag.HAS_INLINE_TAG);
607 return super.visitDocRoot(tree, ignore);
608 }
610 @Override
611 public Void visitInheritDoc(InheritDocTree tree, Void ignore) {
612 markEnclosingTag(Flag.HAS_INLINE_TAG);
613 // TODO: verify on overridden method
614 foundInheritDoc = true;
615 return super.visitInheritDoc(tree, ignore);
616 }
618 @Override
619 public Void visitLink(LinkTree tree, Void ignore) {
620 markEnclosingTag(Flag.HAS_INLINE_TAG);
621 // simulate inline context on tag stack
622 HtmlTag t = (tree.getKind() == DocTree.Kind.LINK)
623 ? HtmlTag.CODE : HtmlTag.SPAN;
624 tagStack.push(new TagStackItem(tree, t));
625 try {
626 return super.visitLink(tree, ignore);
627 } finally {
628 tagStack.pop();
629 }
630 }
632 @Override
633 public Void visitLiteral(LiteralTree tree, Void ignore) {
634 markEnclosingTag(Flag.HAS_INLINE_TAG);
635 if (tree.getKind() == DocTree.Kind.CODE) {
636 for (TagStackItem tsi: tagStack) {
637 if (tsi.tag == HtmlTag.CODE) {
638 env.messages.warning(HTML, tree, "dc.tag.code.within.code");
639 break;
640 }
641 }
642 }
643 return super.visitLiteral(tree, ignore);
644 }
646 @Override
647 @SuppressWarnings("fallthrough")
648 public Void visitParam(ParamTree tree, Void ignore) {
649 boolean typaram = tree.isTypeParameter();
650 IdentifierTree nameTree = tree.getName();
651 Element paramElement = nameTree != null ? env.trees.getElement(new DocTreePath(getCurrentPath(), nameTree)) : null;
653 if (paramElement == null) {
654 switch (env.currElement.getKind()) {
655 case CLASS: case INTERFACE: {
656 if (!typaram) {
657 env.messages.error(REFERENCE, tree, "dc.invalid.param");
658 break;
659 }
660 }
661 case METHOD: case CONSTRUCTOR: {
662 env.messages.error(REFERENCE, nameTree, "dc.param.name.not.found");
663 break;
664 }
666 default:
667 env.messages.error(REFERENCE, tree, "dc.invalid.param");
668 break;
669 }
670 } else {
671 foundParams.add(paramElement);
672 }
674 warnIfEmpty(tree, tree.getDescription());
675 return super.visitParam(tree, ignore);
676 }
678 private void checkParamsDocumented(List<? extends Element> list) {
679 if (foundInheritDoc)
680 return;
682 for (Element e: list) {
683 if (!foundParams.contains(e)) {
684 CharSequence paramName = (e.getKind() == ElementKind.TYPE_PARAMETER)
685 ? "<" + e.getSimpleName() + ">"
686 : e.getSimpleName();
687 reportMissing("dc.missing.param", paramName);
688 }
689 }
690 }
692 @Override
693 public Void visitReference(ReferenceTree tree, Void ignore) {
694 Element e = env.trees.getElement(getCurrentPath());
695 if (e == null)
696 env.messages.error(REFERENCE, tree, "dc.ref.not.found");
697 return super.visitReference(tree, ignore);
698 }
700 @Override
701 public Void visitReturn(ReturnTree tree, Void ignore) {
702 Element e = env.trees.getElement(env.currPath);
703 if (e.getKind() != ElementKind.METHOD
704 || ((ExecutableElement) e).getReturnType().getKind() == TypeKind.VOID)
705 env.messages.error(REFERENCE, tree, "dc.invalid.return");
706 foundReturn = true;
707 warnIfEmpty(tree, tree.getDescription());
708 return super.visitReturn(tree, ignore);
709 }
711 @Override
712 public Void visitSerialData(SerialDataTree tree, Void ignore) {
713 warnIfEmpty(tree, tree.getDescription());
714 return super.visitSerialData(tree, ignore);
715 }
717 @Override
718 public Void visitSerialField(SerialFieldTree tree, Void ignore) {
719 warnIfEmpty(tree, tree.getDescription());
720 return super.visitSerialField(tree, ignore);
721 }
723 @Override
724 public Void visitSince(SinceTree tree, Void ignore) {
725 warnIfEmpty(tree, tree.getBody());
726 return super.visitSince(tree, ignore);
727 }
729 @Override
730 public Void visitThrows(ThrowsTree tree, Void ignore) {
731 ReferenceTree exName = tree.getExceptionName();
732 Element ex = env.trees.getElement(new DocTreePath(getCurrentPath(), exName));
733 if (ex == null) {
734 env.messages.error(REFERENCE, tree, "dc.ref.not.found");
735 } else if (ex.asType().getKind() == TypeKind.DECLARED
736 && env.types.isAssignable(ex.asType(), env.java_lang_Throwable)) {
737 switch (env.currElement.getKind()) {
738 case CONSTRUCTOR:
739 case METHOD:
740 if (isCheckedException(ex.asType())) {
741 ExecutableElement ee = (ExecutableElement) env.currElement;
742 checkThrowsDeclared(exName, ex.asType(), ee.getThrownTypes());
743 }
744 break;
745 default:
746 env.messages.error(REFERENCE, tree, "dc.invalid.throws");
747 }
748 } else {
749 env.messages.error(REFERENCE, tree, "dc.invalid.throws");
750 }
751 warnIfEmpty(tree, tree.getDescription());
752 return scan(tree.getDescription(), ignore);
753 }
755 private void checkThrowsDeclared(ReferenceTree tree, TypeMirror t, List<? extends TypeMirror> list) {
756 boolean found = false;
757 for (TypeMirror tl : list) {
758 if (env.types.isAssignable(t, tl)) {
759 foundThrows.add(tl);
760 found = true;
761 }
762 }
763 if (!found)
764 env.messages.error(REFERENCE, tree, "dc.exception.not.thrown", t);
765 }
767 private void checkThrowsDocumented(List<? extends TypeMirror> list) {
768 if (foundInheritDoc)
769 return;
771 for (TypeMirror tl: list) {
772 if (isCheckedException(tl) && !foundThrows.contains(tl))
773 reportMissing("dc.missing.throws", tl);
774 }
775 }
777 @Override
778 public Void visitValue(ValueTree tree, Void ignore) {
779 markEnclosingTag(Flag.HAS_INLINE_TAG);
780 return super.visitValue(tree, ignore);
781 }
783 @Override
784 public Void visitVersion(VersionTree tree, Void ignore) {
785 warnIfEmpty(tree, tree.getBody());
786 return super.visitVersion(tree, ignore);
787 }
789 @Override
790 public Void visitErroneous(ErroneousTree tree, Void ignore) {
791 env.messages.error(SYNTAX, tree, null, tree.getDiagnostic().getMessage(null));
792 return null;
793 }
794 // </editor-fold>
796 // <editor-fold defaultstate="collapsed" desc="Utility methods">
798 private boolean isCheckedException(TypeMirror t) {
799 return !(env.types.isAssignable(t, env.java_lang_Error)
800 || env.types.isAssignable(t, env.java_lang_RuntimeException));
801 }
803 private boolean isSynthetic() {
804 switch (env.currElement.getKind()) {
805 case CONSTRUCTOR:
806 // A synthetic default constructor has the same pos as the
807 // enclosing class
808 TreePath p = env.currPath;
809 return env.getPos(p) == env.getPos(p.getParentPath());
810 }
811 return false;
812 }
814 void markEnclosingTag(Flag flag) {
815 TagStackItem top = tagStack.peek();
816 if (top != null)
817 top.flags.add(flag);
818 }
820 String toString(TreePath p) {
821 StringBuilder sb = new StringBuilder("TreePath[");
822 toString(p, sb);
823 sb.append("]");
824 return sb.toString();
825 }
827 void toString(TreePath p, StringBuilder sb) {
828 TreePath parent = p.getParentPath();
829 if (parent != null) {
830 toString(parent, sb);
831 sb.append(",");
832 }
833 sb.append(p.getLeaf().getKind()).append(":").append(env.getPos(p)).append(":S").append(env.getStartPos(p));
834 }
836 void warnIfEmpty(DocTree tree, List<? extends DocTree> list) {
837 for (DocTree d: list) {
838 switch (d.getKind()) {
839 case TEXT:
840 if (hasNonWhitespace((TextTree) d))
841 return;
842 break;
843 default:
844 return;
845 }
846 }
847 env.messages.warning(SYNTAX, tree, "dc.empty", tree.getKind().tagName);
848 }
850 boolean hasNonWhitespace(TextTree tree) {
851 String s = tree.getBody();
852 for (int i = 0; i < s.length(); i++) {
853 if (!Character.isWhitespace(s.charAt(i)))
854 return true;
855 }
856 return false;
857 }
859 // </editor-fold>
861 }
