aoqi@0: /*
aefimov@3315:  * Copyright (c) 2012, 2016, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclint;
aoqi@0: 
aoqi@0: import java.io.IOException;
aoqi@0: import java.io.StringWriter;
aoqi@0: import java.net.URI;
aoqi@0: import java.net.URISyntaxException;
aoqi@0: import java.util.Deque;
aoqi@0: import java.util.EnumSet;
aoqi@0: import java.util.HashMap;
aoqi@0: import java.util.HashSet;
aoqi@0: import java.util.LinkedList;
aoqi@0: import java.util.List;
aoqi@0: import java.util.Map;
aoqi@0: import java.util.Set;
aoqi@0: import java.util.regex.Matcher;
aoqi@0: import java.util.regex.Pattern;
aoqi@0: 
aoqi@0: import javax.lang.model.element.Element;
aoqi@0: import javax.lang.model.element.ElementKind;
aoqi@0: import javax.lang.model.element.ExecutableElement;
aoqi@0: import javax.lang.model.element.Name;
aoqi@0: import javax.lang.model.element.VariableElement;
aoqi@0: import javax.lang.model.type.TypeKind;
aoqi@0: import javax.lang.model.type.TypeMirror;
aoqi@0: import javax.tools.Diagnostic.Kind;
aoqi@0: import javax.tools.JavaFileObject;
aoqi@0: 
aoqi@0: import com.sun.source.doctree.AttributeTree;
aoqi@0: import com.sun.source.doctree.AuthorTree;
aoqi@0: import com.sun.source.doctree.DocCommentTree;
aoqi@0: import com.sun.source.doctree.DocRootTree;
aoqi@0: import com.sun.source.doctree.DocTree;
aoqi@0: import com.sun.source.doctree.EndElementTree;
aoqi@0: import com.sun.source.doctree.EntityTree;
aoqi@0: import com.sun.source.doctree.ErroneousTree;
aoqi@0: import com.sun.source.doctree.IdentifierTree;
aoqi@0: import com.sun.source.doctree.InheritDocTree;
aoqi@0: import com.sun.source.doctree.LinkTree;
aoqi@0: import com.sun.source.doctree.LiteralTree;
aoqi@0: import com.sun.source.doctree.ParamTree;
aoqi@0: import com.sun.source.doctree.ReferenceTree;
aoqi@0: import com.sun.source.doctree.ReturnTree;
aoqi@0: import com.sun.source.doctree.SerialDataTree;
aoqi@0: import com.sun.source.doctree.SerialFieldTree;
aoqi@0: import com.sun.source.doctree.SinceTree;
aoqi@0: import com.sun.source.doctree.StartElementTree;
aoqi@0: import com.sun.source.doctree.TextTree;
aoqi@0: import com.sun.source.doctree.ThrowsTree;
aoqi@0: import com.sun.source.doctree.UnknownBlockTagTree;
aoqi@0: import com.sun.source.doctree.UnknownInlineTagTree;
aoqi@0: import com.sun.source.doctree.ValueTree;
aoqi@0: import com.sun.source.doctree.VersionTree;
aoqi@0: import com.sun.source.util.DocTreePath;
aoqi@0: import com.sun.source.util.DocTreePathScanner;
aoqi@0: import com.sun.source.util.TreePath;
aoqi@0: import com.sun.tools.doclint.HtmlTag.AttrKind;
aoqi@0: import com.sun.tools.javac.tree.DocPretty;
aoqi@0: import com.sun.tools.javac.util.StringUtils;
aoqi@0: import static com.sun.tools.doclint.Messages.Group.*;
aoqi@0: 
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Validate a doc comment.
aoqi@0:  *
aoqi@0:  * <p><b>This is NOT part of any supported API.
aoqi@0:  * If you write code that depends on this, you do so at your own
aoqi@0:  * risk.  This code and its internal interfaces are subject to change
aoqi@0:  * or deletion without notice.</b></p>
aoqi@0:  */
aoqi@0: public class Checker extends DocTreePathScanner<Void, Void> {
aoqi@0:     final Env env;
aoqi@0: 
aoqi@0:     Set<Element> foundParams = new HashSet<>();
aoqi@0:     Set<TypeMirror> foundThrows = new HashSet<>();
aoqi@0:     Map<Element, Set<String>> foundAnchors = new HashMap<>();
aoqi@0:     boolean foundInheritDoc = false;
aoqi@0:     boolean foundReturn = false;
aoqi@0: 
aoqi@0:     public enum Flag {
aoqi@0:         TABLE_HAS_CAPTION,
aoqi@0:         HAS_ELEMENT,
aoqi@0:         HAS_INLINE_TAG,
aoqi@0:         HAS_TEXT,
aoqi@0:         REPORTED_BAD_INLINE
aoqi@0:     }
aoqi@0: 
aoqi@0:     static class TagStackItem {
aoqi@0:         final DocTree tree; // typically, but not always, StartElementTree
aoqi@0:         final HtmlTag tag;
aoqi@0:         final Set<HtmlTag.Attr> attrs;
aoqi@0:         final Set<Flag> flags;
aoqi@0:         TagStackItem(DocTree tree, HtmlTag tag) {
aoqi@0:             this.tree = tree;
aoqi@0:             this.tag = tag;
aoqi@0:             attrs = EnumSet.noneOf(HtmlTag.Attr.class);
aoqi@0:             flags = EnumSet.noneOf(Flag.class);
aoqi@0:         }
aoqi@0:         @Override
aoqi@0:         public String toString() {
aoqi@0:             return String.valueOf(tag);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aefimov@3315:     private final Deque<TagStackItem> tagStack; // TODO: maybe want to record starting tree as well
aoqi@0:     private HtmlTag currHeaderTag;
aoqi@0: 
aoqi@0:     private final int implicitHeaderLevel;
aoqi@0: 
aoqi@0:     // <editor-fold defaultstate="collapsed" desc="Top level">
aoqi@0: 
aoqi@0:     Checker(Env env) {
aoqi@0:         env.getClass();
aoqi@0:         this.env = env;
aoqi@0:         tagStack = new LinkedList<>();
aoqi@0:         implicitHeaderLevel = env.implicitHeaderLevel;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public Void scan(DocCommentTree tree, TreePath p) {
aoqi@0:         env.setCurrent(p, tree);
aoqi@0: 
aoqi@0:         boolean isOverridingMethod = !env.currOverriddenMethods.isEmpty();
aoqi@0: 
aoqi@0:         if (p.getLeaf() == p.getCompilationUnit()) {
aoqi@0:             // If p points to a compilation unit, the implied declaration is the
aoqi@0:             // package declaration (if any) for the compilation unit.
aoqi@0:             // Handle this case specially, because doc comments are only
aoqi@0:             // expected in package-info files.
aoqi@0:             JavaFileObject fo = p.getCompilationUnit().getSourceFile();
aoqi@0:             boolean isPkgInfo = fo.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE);
aoqi@0:             if (tree == null) {
aoqi@0:                 if (isPkgInfo)
aoqi@0:                     reportMissing("dc.missing.comment");
aoqi@0:                 return null;
aoqi@0:             } else {
aoqi@0:                 if (!isPkgInfo)
aoqi@0:                     reportReference("dc.unexpected.comment");
aoqi@0:             }
aoqi@0:         } else {
aoqi@0:             if (tree == null) {
aoqi@0:                 if (!isSynthetic() && !isOverridingMethod)
aoqi@0:                     reportMissing("dc.missing.comment");
aoqi@0:                 return null;
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         tagStack.clear();
aoqi@0:         currHeaderTag = null;
aoqi@0: 
aoqi@0:         foundParams.clear();
aoqi@0:         foundThrows.clear();
aoqi@0:         foundInheritDoc = false;
aoqi@0:         foundReturn = false;
aoqi@0: 
aoqi@0:         scan(new DocTreePath(p, tree), null);
aoqi@0: 
aoqi@0:         if (!isOverridingMethod) {
aoqi@0:             switch (env.currElement.getKind()) {
aoqi@0:                 case METHOD:
aoqi@0:                 case CONSTRUCTOR: {
aoqi@0:                     ExecutableElement ee = (ExecutableElement) env.currElement;
aoqi@0:                     checkParamsDocumented(ee.getTypeParameters());
aoqi@0:                     checkParamsDocumented(ee.getParameters());
aoqi@0:                     switch (ee.getReturnType().getKind()) {
aoqi@0:                         case VOID:
aoqi@0:                         case NONE:
aoqi@0:                             break;
aoqi@0:                         default:
aoqi@0:                             if (!foundReturn
aoqi@0:                                     && !foundInheritDoc
aoqi@0:                                     && !env.types.isSameType(ee.getReturnType(), env.java_lang_Void)) {
aoqi@0:                                 reportMissing("dc.missing.return");
aoqi@0:                             }
aoqi@0:                     }
aoqi@0:                     checkThrowsDocumented(ee.getThrownTypes());
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         return null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void reportMissing(String code, Object... args) {
aoqi@0:         env.messages.report(MISSING, Kind.WARNING, env.currPath.getLeaf(), code, args);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void reportReference(String code, Object... args) {
aoqi@0:         env.messages.report(REFERENCE, Kind.WARNING, env.currPath.getLeaf(), code, args);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitDocComment(DocCommentTree tree, Void ignore) {
aoqi@0:         super.visitDocComment(tree, ignore);
aoqi@0:         for (TagStackItem tsi: tagStack) {
aoqi@0:             warnIfEmpty(tsi, null);
aoqi@0:             if (tsi.tree.getKind() == DocTree.Kind.START_ELEMENT
aoqi@0:                     && tsi.tag.endKind == HtmlTag.EndKind.REQUIRED) {
aoqi@0:                 StartElementTree t = (StartElementTree) tsi.tree;
aoqi@0:                 env.messages.error(HTML, t, "dc.tag.not.closed", t.getName());
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return null;
aoqi@0:     }
aoqi@0:     // </editor-fold>
aoqi@0: 
aoqi@0:     // <editor-fold defaultstate="collapsed" desc="Text and entities.">
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitText(TextTree tree, Void ignore) {
aoqi@0:         if (hasNonWhitespace(tree)) {
aoqi@0:             checkAllowsText(tree);
aoqi@0:             markEnclosingTag(Flag.HAS_TEXT);
aoqi@0:         }
aoqi@0:         return null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitEntity(EntityTree tree, Void ignore) {
aoqi@0:         checkAllowsText(tree);
aoqi@0:         markEnclosingTag(Flag.HAS_TEXT);
aoqi@0:         String name = tree.getName().toString();
aoqi@0:         if (name.startsWith("#")) {
aoqi@0:             int v = StringUtils.toLowerCase(name).startsWith("#x")
aoqi@0:                     ? Integer.parseInt(name.substring(2), 16)
aoqi@0:                     : Integer.parseInt(name.substring(1), 10);
aoqi@0:             if (!Entity.isValid(v)) {
aoqi@0:                 env.messages.error(HTML, tree, "dc.entity.invalid", name);
aoqi@0:             }
aoqi@0:         } else if (!Entity.isValid(name)) {
aoqi@0:             env.messages.error(HTML, tree, "dc.entity.invalid", name);
aoqi@0:         }
aoqi@0:         return null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     void checkAllowsText(DocTree tree) {
aoqi@0:         TagStackItem top = tagStack.peek();
aoqi@0:         if (top != null
aoqi@0:                 && top.tree.getKind() == DocTree.Kind.START_ELEMENT
aoqi@0:                 && !top.tag.acceptsText()) {
aoqi@0:             if (top.flags.add(Flag.REPORTED_BAD_INLINE)) {
aoqi@0:                 env.messages.error(HTML, tree, "dc.text.not.allowed",
aoqi@0:                         ((StartElementTree) top.tree).getName());
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     // </editor-fold>
aoqi@0: 
aoqi@0:     // <editor-fold defaultstate="collapsed" desc="HTML elements">
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitStartElement(StartElementTree tree, Void ignore) {
aoqi@0:         final Name treeName = tree.getName();
aoqi@0:         final HtmlTag t = HtmlTag.get(treeName);
aoqi@0:         if (t == null) {
aoqi@0:             env.messages.error(HTML, tree, "dc.tag.unknown", treeName);
aoqi@0:         } else {
aoqi@0:             boolean done = false;
aoqi@0:             for (TagStackItem tsi: tagStack) {
aoqi@0:                 if (tsi.tag.accepts(t)) {
aoqi@0:                     while (tagStack.peek() != tsi) {
aoqi@0:                         warnIfEmpty(tagStack.peek(), null);
aoqi@0:                         tagStack.pop();
aoqi@0:                     }
aoqi@0:                     done = true;
aoqi@0:                     break;
aoqi@0:                 } else if (tsi.tag.endKind != HtmlTag.EndKind.OPTIONAL) {
aoqi@0:                     done = true;
aoqi@0:                     break;
aoqi@0:                 }
aoqi@0:             }
aoqi@0:             if (!done && HtmlTag.BODY.accepts(t)) {
aoqi@0:                 while (!tagStack.isEmpty()) {
aoqi@0:                     warnIfEmpty(tagStack.peek(), null);
aoqi@0:                     tagStack.pop();
aoqi@0:                 }
aoqi@0:             }
aoqi@0: 
aoqi@0:             markEnclosingTag(Flag.HAS_ELEMENT);
aoqi@0:             checkStructure(tree, t);
aoqi@0: 
aoqi@0:             // tag specific checks
aoqi@0:             switch (t) {
aoqi@0:                 // check for out of sequence headers, such as <h1>...</h1>  <h3>...</h3>
aoqi@0:                 case H1: case H2: case H3: case H4: case H5: case H6:
aoqi@0:                     checkHeader(tree, t);
aoqi@0:                     break;
aoqi@0:             }
aoqi@0: 
aoqi@0:             if (t.flags.contains(HtmlTag.Flag.NO_NEST)) {
aoqi@0:                 for (TagStackItem i: tagStack) {
aoqi@0:                     if (t == i.tag) {
aoqi@0:                         env.messages.warning(HTML, tree, "dc.tag.nested.not.allowed", treeName);
aoqi@0:                         break;
aoqi@0:                     }
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         // check for self closing tags, such as <a id="name"/>
aoqi@0:         if (tree.isSelfClosing()) {
aoqi@0:             env.messages.error(HTML, tree, "dc.tag.self.closing", treeName);
aoqi@0:         }
aoqi@0: 
aoqi@0:         try {
aoqi@0:             TagStackItem parent = tagStack.peek();
aoqi@0:             TagStackItem top = new TagStackItem(tree, t);
aoqi@0:             tagStack.push(top);
aoqi@0: 
aoqi@0:             super.visitStartElement(tree, ignore);
aoqi@0: 
aoqi@0:             // handle attributes that may or may not have been found in start element
aoqi@0:             if (t != null) {
aoqi@0:                 switch (t) {
aoqi@0:                     case CAPTION:
aoqi@0:                         if (parent != null && parent.tag == HtmlTag.TABLE)
aoqi@0:                             parent.flags.add(Flag.TABLE_HAS_CAPTION);
aoqi@0:                         break;
aoqi@0: 
aoqi@0:                     case IMG:
aoqi@0:                         if (!top.attrs.contains(HtmlTag.Attr.ALT))
aoqi@0:                             env.messages.error(ACCESSIBILITY, tree, "dc.no.alt.attr.for.image");
aoqi@0:                         break;
aoqi@0:                 }
aoqi@0:             }
aoqi@0: 
aoqi@0:             return null;
aoqi@0:         } finally {
aoqi@0: 
aoqi@0:             if (t == null || t.endKind == HtmlTag.EndKind.NONE)
aoqi@0:                 tagStack.pop();
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void checkStructure(StartElementTree tree, HtmlTag t) {
aoqi@0:         Name treeName = tree.getName();
aoqi@0:         TagStackItem top = tagStack.peek();
aoqi@0:         switch (t.blockType) {
aoqi@0:             case BLOCK:
aoqi@0:                 if (top == null || top.tag.accepts(t))
aoqi@0:                     return;
aoqi@0: 
aoqi@0:                 switch (top.tree.getKind()) {
aoqi@0:                     case START_ELEMENT: {
aoqi@0:                         if (top.tag.blockType == HtmlTag.BlockType.INLINE) {
aoqi@0:                             Name name = ((StartElementTree) top.tree).getName();
aoqi@0:                             env.messages.error(HTML, tree, "dc.tag.not.allowed.inline.element",
aoqi@0:                                     treeName, name);
aoqi@0:                             return;
aoqi@0:                         }
aoqi@0:                     }
aoqi@0:                     break;
aoqi@0: 
aoqi@0:                     case LINK:
aoqi@0:                     case LINK_PLAIN: {
aoqi@0:                         String name = top.tree.getKind().tagName;
aoqi@0:                         env.messages.error(HTML, tree, "dc.tag.not.allowed.inline.tag",
aoqi@0:                                 treeName, name);
aoqi@0:                         return;
aoqi@0:                     }
aoqi@0:                 }
aoqi@0:                 break;
aoqi@0: 
aoqi@0:             case INLINE:
aoqi@0:                 if (top == null || top.tag.accepts(t))
aoqi@0:                     return;
aoqi@0:                 break;
aoqi@0: 
aoqi@0:             case LIST_ITEM:
aoqi@0:             case TABLE_ITEM:
aoqi@0:                 if (top != null) {
aoqi@0:                     // reset this flag so subsequent bad inline content gets reported
aoqi@0:                     top.flags.remove(Flag.REPORTED_BAD_INLINE);
aoqi@0:                     if (top.tag.accepts(t))
aoqi@0:                         return;
aoqi@0:                 }
aoqi@0:                 break;
aoqi@0: 
aoqi@0:             case OTHER:
aefimov@3315:                 switch (t) {
aefimov@3315:                     case SCRIPT:
aefimov@3315:                         // <script> may or may not be allowed, depending on --allow-script-in-comments
aefimov@3315:                         // but we allow it here, and rely on a separate scanner to detect all uses
aefimov@3315:                         // of JavaScript, including <script> tags, and use in attributes, etc.
aefimov@3315:                         break;
aefimov@3315: 
aefimov@3315:                     default:
aefimov@3315:                         env.messages.error(HTML, tree, "dc.tag.not.allowed", treeName);
aefimov@3315:                 }
aoqi@0:                 return;
aoqi@0:         }
aoqi@0: 
aoqi@0:         env.messages.error(HTML, tree, "dc.tag.not.allowed.here", treeName);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void checkHeader(StartElementTree tree, HtmlTag tag) {
aoqi@0:         // verify the new tag
aoqi@0:         if (getHeaderLevel(tag) > getHeaderLevel(currHeaderTag) + 1) {
aoqi@0:             if (currHeaderTag == null) {
aoqi@0:                 env.messages.error(ACCESSIBILITY, tree, "dc.tag.header.sequence.1", tag);
aoqi@0:             } else {
aoqi@0:                 env.messages.error(ACCESSIBILITY, tree, "dc.tag.header.sequence.2",
aoqi@0:                     tag, currHeaderTag);
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         currHeaderTag = tag;
aoqi@0:     }
aoqi@0: 
aoqi@0:     private int getHeaderLevel(HtmlTag tag) {
aoqi@0:         if (tag == null)
aoqi@0:             return implicitHeaderLevel;
aoqi@0:         switch (tag) {
aoqi@0:             case H1: return 1;
aoqi@0:             case H2: return 2;
aoqi@0:             case H3: return 3;
aoqi@0:             case H4: return 4;
aoqi@0:             case H5: return 5;
aoqi@0:             case H6: return 6;
aoqi@0:             default: throw new IllegalArgumentException();
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitEndElement(EndElementTree tree, Void ignore) {
aoqi@0:         final Name treeName = tree.getName();
aoqi@0:         final HtmlTag t = HtmlTag.get(treeName);
aoqi@0:         if (t == null) {
aoqi@0:             env.messages.error(HTML, tree, "dc.tag.unknown", treeName);
aoqi@0:         } else if (t.endKind == HtmlTag.EndKind.NONE) {
aoqi@0:             env.messages.error(HTML, tree, "dc.tag.end.not.permitted", treeName);
aoqi@0:         } else {
aoqi@0:             boolean done = false;
aoqi@0:             while (!tagStack.isEmpty()) {
aoqi@0:                 TagStackItem top = tagStack.peek();
aoqi@0:                 if (t == top.tag) {
aoqi@0:                     switch (t) {
aoqi@0:                         case TABLE:
aoqi@0:                             if (!top.attrs.contains(HtmlTag.Attr.SUMMARY)
aoqi@0:                                     && !top.flags.contains(Flag.TABLE_HAS_CAPTION)) {
aoqi@0:                                 env.messages.error(ACCESSIBILITY, tree,
aoqi@0:                                         "dc.no.summary.or.caption.for.table");
aoqi@0:                             }
aoqi@0:                     }
aoqi@0:                     warnIfEmpty(top, tree);
aoqi@0:                     tagStack.pop();
aoqi@0:                     done = true;
aoqi@0:                     break;
aoqi@0:                 } else if (top.tag == null || top.tag.endKind != HtmlTag.EndKind.REQUIRED) {
aoqi@0:                     tagStack.pop();
aoqi@0:                 } else {
aoqi@0:                     boolean found = false;
aoqi@0:                     for (TagStackItem si: tagStack) {
aoqi@0:                         if (si.tag == t) {
aoqi@0:                             found = true;
aoqi@0:                             break;
aoqi@0:                         }
aoqi@0:                     }
aoqi@0:                     if (found && top.tree.getKind() == DocTree.Kind.START_ELEMENT) {
aoqi@0:                         env.messages.error(HTML, top.tree, "dc.tag.start.unmatched",
aoqi@0:                                 ((StartElementTree) top.tree).getName());
aoqi@0:                         tagStack.pop();
aoqi@0:                     } else {
aoqi@0:                         env.messages.error(HTML, tree, "dc.tag.end.unexpected", treeName);
aoqi@0:                         done = true;
aoqi@0:                         break;
aoqi@0:                     }
aoqi@0:                 }
aoqi@0:             }
aoqi@0: 
aoqi@0:             if (!done && tagStack.isEmpty()) {
aoqi@0:                 env.messages.error(HTML, tree, "dc.tag.end.unexpected", treeName);
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         return super.visitEndElement(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     void warnIfEmpty(TagStackItem tsi, DocTree endTree) {
aoqi@0:         if (tsi.tag != null && tsi.tree instanceof StartElementTree) {
aoqi@0:             if (tsi.tag.flags.contains(HtmlTag.Flag.EXPECT_CONTENT)
aoqi@0:                     && !tsi.flags.contains(Flag.HAS_TEXT)
aoqi@0:                     && !tsi.flags.contains(Flag.HAS_ELEMENT)
aoqi@0:                     && !tsi.flags.contains(Flag.HAS_INLINE_TAG)) {
aoqi@0:                 DocTree tree = (endTree != null) ? endTree : tsi.tree;
aoqi@0:                 Name treeName = ((StartElementTree) tsi.tree).getName();
aoqi@0:                 env.messages.warning(HTML, tree, "dc.tag.empty", treeName);
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     // </editor-fold>
aoqi@0: 
aoqi@0:     // <editor-fold defaultstate="collapsed" desc="HTML attributes">
aoqi@0: 
aoqi@0:     @Override @SuppressWarnings("fallthrough")
aoqi@0:     public Void visitAttribute(AttributeTree tree, Void ignore) {
aoqi@0:         HtmlTag currTag = tagStack.peek().tag;
aoqi@0:         if (currTag != null) {
aoqi@0:             Name name = tree.getName();
aoqi@0:             HtmlTag.Attr attr = currTag.getAttr(name);
aoqi@0:             if (attr != null) {
aoqi@0:                 boolean first = tagStack.peek().attrs.add(attr);
aoqi@0:                 if (!first)
aoqi@0:                     env.messages.error(HTML, tree, "dc.attr.repeated", name);
aoqi@0:             }
aoqi@0: 
aefimov@3315:             // for now, doclint allows all attribute names beginning with "on" as event handler names,
aefimov@3315:             // without checking the validity or applicability of the name
aefimov@3315:             if (!name.toString().startsWith("on")) {
aefimov@3315:                 AttrKind k = currTag.getAttrKind(name);
aefimov@3315:                 switch (k) {
aefimov@3315:                     case OK:
aefimov@3315:                         break;
aoqi@0: 
aefimov@3315:                     case INVALID:
aefimov@3315:                         env.messages.error(HTML, tree, "dc.attr.unknown", name);
aefimov@3315:                         break;
aoqi@0: 
aefimov@3315:                     case OBSOLETE:
aefimov@3315:                         env.messages.warning(ACCESSIBILITY, tree, "dc.attr.obsolete", name);
aefimov@3315:                         break;
aefimov@3315: 
aefimov@3315:                     case USE_CSS:
aefimov@3315:                         env.messages.warning(ACCESSIBILITY, tree, "dc.attr.obsolete.use.css", name);
aefimov@3315:                         break;
aefimov@3315:                 }
aoqi@0:             }
aoqi@0: 
aoqi@0:             if (attr != null) {
aoqi@0:                 switch (attr) {
aoqi@0:                     case NAME:
aoqi@0:                         if (currTag != HtmlTag.A) {
aoqi@0:                             break;
aoqi@0:                         }
aoqi@0:                         // fallthrough
aoqi@0:                     case ID:
aoqi@0:                         String value = getAttrValue(tree);
aoqi@0:                         if (value == null) {
aoqi@0:                             env.messages.error(HTML, tree, "dc.anchor.value.missing");
aoqi@0:                         } else {
aoqi@0:                             if (!validName.matcher(value).matches()) {
aoqi@0:                                 env.messages.error(HTML, tree, "dc.invalid.anchor", value);
aoqi@0:                             }
aoqi@0:                             if (!checkAnchor(value)) {
aoqi@0:                                 env.messages.error(HTML, tree, "dc.anchor.already.defined", value);
aoqi@0:                             }
aoqi@0:                         }
aoqi@0:                         break;
aoqi@0: 
aoqi@0:                     case HREF:
aoqi@0:                         if (currTag == HtmlTag.A) {
aoqi@0:                             String v = getAttrValue(tree);
aoqi@0:                             if (v == null || v.isEmpty()) {
aoqi@0:                                 env.messages.error(HTML, tree, "dc.attr.lacks.value");
aoqi@0:                             } else {
aoqi@0:                                 Matcher m = docRoot.matcher(v);
aoqi@0:                                 if (m.matches()) {
aoqi@0:                                     String rest = m.group(2);
aoqi@0:                                     if (!rest.isEmpty())
aoqi@0:                                         checkURI(tree, rest);
aoqi@0:                                 } else {
aoqi@0:                                     checkURI(tree, v);
aoqi@0:                                 }
aoqi@0:                             }
aoqi@0:                         }
aoqi@0:                         break;
aoqi@0: 
aoqi@0:                     case VALUE:
aoqi@0:                         if (currTag == HtmlTag.LI) {
aoqi@0:                             String v = getAttrValue(tree);
aoqi@0:                             if (v == null || v.isEmpty()) {
aoqi@0:                                 env.messages.error(HTML, tree, "dc.attr.lacks.value");
aoqi@0:                             } else if (!validNumber.matcher(v).matches()) {
aoqi@0:                                 env.messages.error(HTML, tree, "dc.attr.not.number");
aoqi@0:                             }
aoqi@0:                         }
aoqi@0:                         break;
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         // TODO: basic check on value
aoqi@0: 
aoqi@0:         return super.visitAttribute(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private boolean checkAnchor(String name) {
aoqi@0:         Element e = getEnclosingPackageOrClass(env.currElement);
aoqi@0:         if (e == null)
aoqi@0:             return true;
aoqi@0:         Set<String> set = foundAnchors.get(e);
aoqi@0:         if (set == null)
aoqi@0:             foundAnchors.put(e, set = new HashSet<>());
aoqi@0:         return set.add(name);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private Element getEnclosingPackageOrClass(Element e) {
aoqi@0:         while (e != null) {
aoqi@0:             switch (e.getKind()) {
aoqi@0:                 case CLASS:
aoqi@0:                 case ENUM:
aoqi@0:                 case INTERFACE:
aoqi@0:                 case PACKAGE:
aoqi@0:                     return e;
aoqi@0:                 default:
aoqi@0:                     e = e.getEnclosingElement();
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return e;
aoqi@0:     }
aoqi@0: 
aoqi@0:     // http://www.w3.org/TR/html401/types.html#type-name
aoqi@0:     private static final Pattern validName = Pattern.compile("[A-Za-z][A-Za-z0-9-_:.]*");
aoqi@0: 
aoqi@0:     private static final Pattern validNumber = Pattern.compile("-?[0-9]+");
aoqi@0: 
aoqi@0:     // pattern to remove leading {@docRoot}/?
aoqi@0:     private static final Pattern docRoot = Pattern.compile("(?i)(\\{@docRoot *\\}/?)?(.*)");
aoqi@0: 
aoqi@0:     private String getAttrValue(AttributeTree tree) {
aoqi@0:         if (tree.getValue() == null)
aoqi@0:             return null;
aoqi@0: 
aoqi@0:         StringWriter sw = new StringWriter();
aoqi@0:         try {
aoqi@0:             new DocPretty(sw).print(tree.getValue());
aoqi@0:         } catch (IOException e) {
aoqi@0:             // cannot happen
aoqi@0:         }
aoqi@0:         // ignore potential use of entities for now
aoqi@0:         return sw.toString();
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void checkURI(AttributeTree tree, String uri) {
aefimov@3315:         // allow URIs beginning with javascript:, which would otherwise be rejected by the URI API.
aefimov@3315:         if (uri.startsWith("javascript:"))
aefimov@3315:             return;
aoqi@0:         try {
aoqi@0:             URI u = new URI(uri);
aoqi@0:         } catch (URISyntaxException e) {
aoqi@0:             env.messages.error(HTML, tree, "dc.invalid.uri", uri);
aoqi@0:         }
aoqi@0:     }
aoqi@0:     // </editor-fold>
aoqi@0: 
aoqi@0:     // <editor-fold defaultstate="collapsed" desc="javadoc tags">
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitAuthor(AuthorTree tree, Void ignore) {
aoqi@0:         warnIfEmpty(tree, tree.getName());
aoqi@0:         return super.visitAuthor(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitDocRoot(DocRootTree tree, Void ignore) {
aoqi@0:         markEnclosingTag(Flag.HAS_INLINE_TAG);
aoqi@0:         return super.visitDocRoot(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitInheritDoc(InheritDocTree tree, Void ignore) {
aoqi@0:         markEnclosingTag(Flag.HAS_INLINE_TAG);
aoqi@0:         // TODO: verify on overridden method
aoqi@0:         foundInheritDoc = true;
aoqi@0:         return super.visitInheritDoc(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitLink(LinkTree tree, Void ignore) {
aoqi@0:         markEnclosingTag(Flag.HAS_INLINE_TAG);
aoqi@0:         // simulate inline context on tag stack
aoqi@0:         HtmlTag t = (tree.getKind() == DocTree.Kind.LINK)
aoqi@0:                 ? HtmlTag.CODE : HtmlTag.SPAN;
aoqi@0:         tagStack.push(new TagStackItem(tree, t));
aoqi@0:         try {
aoqi@0:             return super.visitLink(tree, ignore);
aoqi@0:         } finally {
aoqi@0:             tagStack.pop();
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitLiteral(LiteralTree tree, Void ignore) {
aoqi@0:         markEnclosingTag(Flag.HAS_INLINE_TAG);
aoqi@0:         if (tree.getKind() == DocTree.Kind.CODE) {
aoqi@0:             for (TagStackItem tsi: tagStack) {
aoqi@0:                 if (tsi.tag == HtmlTag.CODE) {
aoqi@0:                     env.messages.warning(HTML, tree, "dc.tag.code.within.code");
aoqi@0:                     break;
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return super.visitLiteral(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     @SuppressWarnings("fallthrough")
aoqi@0:     public Void visitParam(ParamTree tree, Void ignore) {
aoqi@0:         boolean typaram = tree.isTypeParameter();
aoqi@0:         IdentifierTree nameTree = tree.getName();
aoqi@0:         Element paramElement = nameTree != null ? env.trees.getElement(new DocTreePath(getCurrentPath(), nameTree)) : null;
aoqi@0: 
aoqi@0:         if (paramElement == null) {
aoqi@0:             switch (env.currElement.getKind()) {
aoqi@0:                 case CLASS: case INTERFACE: {
aoqi@0:                     if (!typaram) {
aoqi@0:                         env.messages.error(REFERENCE, tree, "dc.invalid.param");
aoqi@0:                         break;
aoqi@0:                     }
aoqi@0:                 }
aoqi@0:                 case METHOD: case CONSTRUCTOR: {
aoqi@0:                     env.messages.error(REFERENCE, nameTree, "dc.param.name.not.found");
aoqi@0:                     break;
aoqi@0:                 }
aoqi@0: 
aoqi@0:                 default:
aoqi@0:                     env.messages.error(REFERENCE, tree, "dc.invalid.param");
aoqi@0:                     break;
aoqi@0:             }
aoqi@0:         } else {
aoqi@0:             foundParams.add(paramElement);
aoqi@0:         }
aoqi@0: 
aoqi@0:         warnIfEmpty(tree, tree.getDescription());
aoqi@0:         return super.visitParam(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void checkParamsDocumented(List<? extends Element> list) {
aoqi@0:         if (foundInheritDoc)
aoqi@0:             return;
aoqi@0: 
aoqi@0:         for (Element e: list) {
aoqi@0:             if (!foundParams.contains(e)) {
aoqi@0:                 CharSequence paramName = (e.getKind() == ElementKind.TYPE_PARAMETER)
aoqi@0:                         ? "<" + e.getSimpleName() + ">"
aoqi@0:                         : e.getSimpleName();
aoqi@0:                 reportMissing("dc.missing.param", paramName);
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitReference(ReferenceTree tree, Void ignore) {
aoqi@0:         String sig = tree.getSignature();
aoqi@0:         if (sig.contains("<") || sig.contains(">"))
aoqi@0:             env.messages.error(REFERENCE, tree, "dc.type.arg.not.allowed");
aoqi@0: 
aoqi@0:         Element e = env.trees.getElement(getCurrentPath());
aoqi@0:         if (e == null)
aoqi@0:             env.messages.error(REFERENCE, tree, "dc.ref.not.found");
aoqi@0:         return super.visitReference(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitReturn(ReturnTree tree, Void ignore) {
aoqi@0:         Element e = env.trees.getElement(env.currPath);
aoqi@0:         if (e.getKind() != ElementKind.METHOD
aoqi@0:                 || ((ExecutableElement) e).getReturnType().getKind() == TypeKind.VOID)
aoqi@0:             env.messages.error(REFERENCE, tree, "dc.invalid.return");
aoqi@0:         foundReturn = true;
aoqi@0:         warnIfEmpty(tree, tree.getDescription());
aoqi@0:         return super.visitReturn(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitSerialData(SerialDataTree tree, Void ignore) {
aoqi@0:         warnIfEmpty(tree, tree.getDescription());
aoqi@0:         return super.visitSerialData(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitSerialField(SerialFieldTree tree, Void ignore) {
aoqi@0:         warnIfEmpty(tree, tree.getDescription());
aoqi@0:         return super.visitSerialField(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitSince(SinceTree tree, Void ignore) {
aoqi@0:         warnIfEmpty(tree, tree.getBody());
aoqi@0:         return super.visitSince(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitThrows(ThrowsTree tree, Void ignore) {
aoqi@0:         ReferenceTree exName = tree.getExceptionName();
aoqi@0:         Element ex = env.trees.getElement(new DocTreePath(getCurrentPath(), exName));
aoqi@0:         if (ex == null) {
aoqi@0:             env.messages.error(REFERENCE, tree, "dc.ref.not.found");
aoqi@0:         } else if (isThrowable(ex.asType())) {
aoqi@0:             switch (env.currElement.getKind()) {
aoqi@0:                 case CONSTRUCTOR:
aoqi@0:                 case METHOD:
aoqi@0:                     if (isCheckedException(ex.asType())) {
aoqi@0:                         ExecutableElement ee = (ExecutableElement) env.currElement;
aoqi@0:                         checkThrowsDeclared(exName, ex.asType(), ee.getThrownTypes());
aoqi@0:                     }
aoqi@0:                     break;
aoqi@0:                 default:
aoqi@0:                     env.messages.error(REFERENCE, tree, "dc.invalid.throws");
aoqi@0:             }
aoqi@0:         } else {
aoqi@0:             env.messages.error(REFERENCE, tree, "dc.invalid.throws");
aoqi@0:         }
aoqi@0:         warnIfEmpty(tree, tree.getDescription());
aoqi@0:         return scan(tree.getDescription(), ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private boolean isThrowable(TypeMirror tm) {
aoqi@0:         switch (tm.getKind()) {
aoqi@0:             case DECLARED:
aoqi@0:             case TYPEVAR:
aoqi@0:                 return env.types.isAssignable(tm, env.java_lang_Throwable);
aoqi@0:         }
aoqi@0:         return false;
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void checkThrowsDeclared(ReferenceTree tree, TypeMirror t, List<? extends TypeMirror> list) {
aoqi@0:         boolean found = false;
aoqi@0:         for (TypeMirror tl : list) {
aoqi@0:             if (env.types.isAssignable(t, tl)) {
aoqi@0:                 foundThrows.add(tl);
aoqi@0:                 found = true;
aoqi@0:             }
aoqi@0:         }
aoqi@0:         if (!found)
aoqi@0:             env.messages.error(REFERENCE, tree, "dc.exception.not.thrown", t);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void checkThrowsDocumented(List<? extends TypeMirror> list) {
aoqi@0:         if (foundInheritDoc)
aoqi@0:             return;
aoqi@0: 
aoqi@0:         for (TypeMirror tl: list) {
aoqi@0:             if (isCheckedException(tl) && !foundThrows.contains(tl))
aoqi@0:                 reportMissing("dc.missing.throws", tl);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitUnknownBlockTag(UnknownBlockTagTree tree, Void ignore) {
aoqi@0:         checkUnknownTag(tree, tree.getTagName());
aoqi@0:         return super.visitUnknownBlockTag(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitUnknownInlineTag(UnknownInlineTagTree tree, Void ignore) {
aoqi@0:         checkUnknownTag(tree, tree.getTagName());
aoqi@0:         return super.visitUnknownInlineTag(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void checkUnknownTag(DocTree tree, String tagName) {
aoqi@0:         if (env.customTags != null && !env.customTags.contains(tagName))
aoqi@0:             env.messages.error(SYNTAX, tree, "dc.tag.unknown", tagName);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitValue(ValueTree tree, Void ignore) {
aoqi@0:         ReferenceTree ref = tree.getReference();
aoqi@0:         if (ref == null || ref.getSignature().isEmpty()) {
aoqi@0:             if (!isConstant(env.currElement))
aoqi@0:                 env.messages.error(REFERENCE, tree, "dc.value.not.allowed.here");
aoqi@0:         } else {
aoqi@0:             Element e = env.trees.getElement(new DocTreePath(getCurrentPath(), ref));
aoqi@0:             if (!isConstant(e))
aoqi@0:                 env.messages.error(REFERENCE, tree, "dc.value.not.a.constant");
aoqi@0:         }
aoqi@0: 
aoqi@0:         markEnclosingTag(Flag.HAS_INLINE_TAG);
aoqi@0:         return super.visitValue(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private boolean isConstant(Element e) {
aoqi@0:         if (e == null)
aoqi@0:             return false;
aoqi@0: 
aoqi@0:         switch (e.getKind()) {
aoqi@0:             case FIELD:
aoqi@0:                 Object value = ((VariableElement) e).getConstantValue();
aoqi@0:                 return (value != null); // can't distinguish "not a constant" from "constant is null"
aoqi@0:             default:
aoqi@0:                 return false;
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitVersion(VersionTree tree, Void ignore) {
aoqi@0:         warnIfEmpty(tree, tree.getBody());
aoqi@0:         return super.visitVersion(tree, ignore);
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Void visitErroneous(ErroneousTree tree, Void ignore) {
aoqi@0:         env.messages.error(SYNTAX, tree, null, tree.getDiagnostic().getMessage(null));
aoqi@0:         return null;
aoqi@0:     }
aoqi@0:     // </editor-fold>
aoqi@0: 
aoqi@0:     // <editor-fold defaultstate="collapsed" desc="Utility methods">
aoqi@0: 
aoqi@0:     private boolean isCheckedException(TypeMirror t) {
aoqi@0:         return !(env.types.isAssignable(t, env.java_lang_Error)
aoqi@0:                 || env.types.isAssignable(t, env.java_lang_RuntimeException));
aoqi@0:     }
aoqi@0: 
aoqi@0:     private boolean isSynthetic() {
aoqi@0:         switch (env.currElement.getKind()) {
aoqi@0:             case CONSTRUCTOR:
aoqi@0:                 // A synthetic default constructor has the same pos as the
aoqi@0:                 // enclosing class
aoqi@0:                 TreePath p = env.currPath;
aoqi@0:                 return env.getPos(p) == env.getPos(p.getParentPath());
aoqi@0:         }
aoqi@0:         return false;
aoqi@0:     }
aoqi@0: 
aoqi@0:     void markEnclosingTag(Flag flag) {
aoqi@0:         TagStackItem top = tagStack.peek();
aoqi@0:         if (top != null)
aoqi@0:             top.flags.add(flag);
aoqi@0:     }
aoqi@0: 
aoqi@0:     String toString(TreePath p) {
aoqi@0:         StringBuilder sb = new StringBuilder("TreePath[");
aoqi@0:         toString(p, sb);
aoqi@0:         sb.append("]");
aoqi@0:         return sb.toString();
aoqi@0:     }
aoqi@0: 
aoqi@0:     void toString(TreePath p, StringBuilder sb) {
aoqi@0:         TreePath parent = p.getParentPath();
aoqi@0:         if (parent != null) {
aoqi@0:             toString(parent, sb);
aoqi@0:             sb.append(",");
aoqi@0:         }
aoqi@0:        sb.append(p.getLeaf().getKind()).append(":").append(env.getPos(p)).append(":S").append(env.getStartPos(p));
aoqi@0:     }
aoqi@0: 
aoqi@0:     void warnIfEmpty(DocTree tree, List<? extends DocTree> list) {
aoqi@0:         for (DocTree d: list) {
aoqi@0:             switch (d.getKind()) {
aoqi@0:                 case TEXT:
aoqi@0:                     if (hasNonWhitespace((TextTree) d))
aoqi@0:                         return;
aoqi@0:                     break;
aoqi@0:                 default:
aoqi@0:                     return;
aoqi@0:             }
aoqi@0:         }
aoqi@0:         env.messages.warning(SYNTAX, tree, "dc.empty", tree.getKind().tagName);
aoqi@0:     }
aoqi@0: 
aoqi@0:     boolean hasNonWhitespace(TextTree tree) {
aoqi@0:         String s = tree.getBody();
aoqi@0:         for (int i = 0; i < s.length(); i++) {
aoqi@0:             if (!Character.isWhitespace(s.charAt(i)))
aoqi@0:                 return true;
aoqi@0:         }
aoqi@0:         return false;
aoqi@0:     }
aoqi@0: 
aoqi@0:     // </editor-fold>
aoqi@0: 
aoqi@0: }