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