| /* |
| * Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package jdk.javadoc.internal.doclets.formats.html; |
| |
| import java.util.*; |
| |
| import javax.lang.model.element.AnnotationMirror; |
| import javax.lang.model.element.Element; |
| import javax.lang.model.element.ModuleElement; |
| import javax.lang.model.element.PackageElement; |
| import javax.lang.model.element.TypeElement; |
| import javax.lang.model.type.TypeMirror; |
| import javax.lang.model.util.SimpleElementVisitor8; |
| |
| import com.sun.source.doctree.DocTree; |
| import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants; |
| import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle; |
| import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag; |
| import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree; |
| import jdk.javadoc.internal.doclets.formats.html.markup.Navigation; |
| import jdk.javadoc.internal.doclets.formats.html.markup.Navigation.PageMode; |
| import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; |
| import jdk.javadoc.internal.doclets.toolkit.ClassWriter; |
| import jdk.javadoc.internal.doclets.toolkit.Content; |
| import jdk.javadoc.internal.doclets.toolkit.taglets.ParamTaglet; |
| import jdk.javadoc.internal.doclets.toolkit.util.ClassTree; |
| import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper; |
| import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; |
| import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants; |
| |
| /** |
| * Generate the Class Information Page. |
| * |
| * <p><b>This is NOT part of any supported API. |
| * If you write code that depends on this, you do so at your own risk. |
| * This code and its internal interfaces are subject to change or |
| * deletion without notice.</b> |
| * |
| * @see javax.lang.model.element.TypeElement |
| * @see java.util.Collections |
| * @see java.util.List |
| * @see java.util.ArrayList |
| * @see java.util.HashMap |
| * |
| * @author Atul M Dambalkar |
| * @author Robert Field |
| * @author Bhavesh Patel (Modified) |
| */ |
| public class ClassWriterImpl extends SubWriterHolderWriter implements ClassWriter { |
| |
| protected final TypeElement typeElement; |
| |
| protected final ClassTree classtree; |
| |
| private final Navigation navBar; |
| |
| /** |
| * @param configuration the configuration data for the doclet |
| * @param typeElement the class being documented. |
| * @param classTree the class tree for the given class. |
| */ |
| public ClassWriterImpl(HtmlConfiguration configuration, TypeElement typeElement, |
| ClassTree classTree) { |
| super(configuration, configuration.docPaths.forClass(typeElement)); |
| this.typeElement = typeElement; |
| configuration.currentTypeElement = typeElement; |
| this.classtree = classTree; |
| this.navBar = new Navigation(typeElement, configuration, fixedNavDiv, PageMode.CLASS, path); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public Content getHeader(String header) { |
| HtmlTree bodyTree = getBody(true, getWindowTitle(utils.getSimpleName(typeElement))); |
| HtmlTree htmlTree = (configuration.allowTag(HtmlTag.HEADER)) |
| ? HtmlTree.HEADER() |
| : bodyTree; |
| addTop(htmlTree); |
| Content linkContent = getModuleLink(utils.elementUtils.getModuleOf(typeElement), |
| contents.moduleLabel); |
| navBar.setNavLinkModule(linkContent); |
| navBar.setMemberSummaryBuilder(configuration.getBuilderFactory().getMemberSummaryBuilder(this)); |
| navBar.setUserHeader(getUserHeaderFooter(true)); |
| htmlTree.addContent(navBar.getContent(true)); |
| if (configuration.allowTag(HtmlTag.HEADER)) { |
| bodyTree.addContent(htmlTree); |
| } |
| bodyTree.addContent(HtmlConstants.START_OF_CLASS_DATA); |
| HtmlTree div = new HtmlTree(HtmlTag.DIV); |
| div.setStyle(HtmlStyle.header); |
| if (configuration.showModules) { |
| ModuleElement mdle = configuration.docEnv.getElementUtils().getModuleOf(typeElement); |
| Content classModuleLabel = HtmlTree.SPAN(HtmlStyle.moduleLabelInType, contents.moduleLabel); |
| Content moduleNameDiv = HtmlTree.DIV(HtmlStyle.subTitle, classModuleLabel); |
| moduleNameDiv.addContent(Contents.SPACE); |
| moduleNameDiv.addContent(getModuleLink(mdle, |
| new StringContent(mdle.getQualifiedName()))); |
| div.addContent(moduleNameDiv); |
| } |
| PackageElement pkg = utils.containingPackage(typeElement); |
| if (!pkg.isUnnamed()) { |
| Content classPackageLabel = HtmlTree.SPAN(HtmlStyle.packageLabelInType, contents.packageLabel); |
| Content pkgNameDiv = HtmlTree.DIV(HtmlStyle.subTitle, classPackageLabel); |
| pkgNameDiv.addContent(Contents.SPACE); |
| Content pkgNameContent = getPackageLink(pkg, |
| new StringContent(utils.getPackageName(pkg))); |
| pkgNameDiv.addContent(pkgNameContent); |
| div.addContent(pkgNameDiv); |
| } |
| LinkInfoImpl linkInfo = new LinkInfoImpl(configuration, |
| LinkInfoImpl.Kind.CLASS_HEADER, typeElement); |
| //Let's not link to ourselves in the header. |
| linkInfo.linkToSelf = false; |
| Content headerContent = new StringContent(header); |
| Content heading = HtmlTree.HEADING(HtmlConstants.CLASS_PAGE_HEADING, true, |
| HtmlStyle.title, headerContent); |
| heading.addContent(getTypeParameterLinks(linkInfo)); |
| div.addContent(heading); |
| if (configuration.allowTag(HtmlTag.MAIN)) { |
| mainTree.addContent(div); |
| } else { |
| bodyTree.addContent(div); |
| } |
| return bodyTree; |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public Content getClassContentHeader() { |
| return getContentHeader(); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addFooter(Content contentTree) { |
| contentTree.addContent(HtmlConstants.END_OF_CLASS_DATA); |
| Content htmlTree = (configuration.allowTag(HtmlTag.FOOTER)) |
| ? HtmlTree.FOOTER() |
| : contentTree; |
| navBar.setUserFooter(getUserHeaderFooter(false)); |
| htmlTree.addContent(navBar.getContent(false)); |
| addBottom(htmlTree); |
| if (configuration.allowTag(HtmlTag.FOOTER)) { |
| contentTree.addContent(htmlTree); |
| } |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void printDocument(Content contentTree) throws DocFileIOException { |
| printHtmlDocument(configuration.metakeywords.getMetaKeywords(typeElement), |
| true, contentTree); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public Content getClassInfoTreeHeader() { |
| return getMemberTreeHeader(); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public Content getClassInfo(Content classInfoTree) { |
| return getMemberTree(HtmlStyle.description, classInfoTree); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addClassSignature(String modifiers, Content classInfoTree) { |
| Content hr = new HtmlTree(HtmlTag.HR); |
| classInfoTree.addContent(hr); |
| Content pre = new HtmlTree(HtmlTag.PRE); |
| addAnnotationInfo(typeElement, pre); |
| pre.addContent(modifiers); |
| LinkInfoImpl linkInfo = new LinkInfoImpl(configuration, |
| LinkInfoImpl.Kind.CLASS_SIGNATURE, typeElement); |
| //Let's not link to ourselves in the signature. |
| linkInfo.linkToSelf = false; |
| Content className = new StringContent(utils.getSimpleName(typeElement)); |
| Content parameterLinks = getTypeParameterLinks(linkInfo); |
| if (configuration.linksource) { |
| addSrcLink(typeElement, className, pre); |
| pre.addContent(parameterLinks); |
| } else { |
| Content span = HtmlTree.SPAN(HtmlStyle.typeNameLabel, className); |
| span.addContent(parameterLinks); |
| pre.addContent(span); |
| } |
| if (!utils.isInterface(typeElement)) { |
| TypeMirror superclass = utils.getFirstVisibleSuperClass(typeElement); |
| if (superclass != null) { |
| pre.addContent(DocletConstants.NL); |
| pre.addContent("extends "); |
| Content link = getLink(new LinkInfoImpl(configuration, |
| LinkInfoImpl.Kind.CLASS_SIGNATURE_PARENT_NAME, |
| superclass)); |
| pre.addContent(link); |
| } |
| } |
| List<? extends TypeMirror> interfaces = typeElement.getInterfaces(); |
| if (!interfaces.isEmpty()) { |
| boolean isFirst = true; |
| for (TypeMirror type : interfaces) { |
| TypeElement tDoc = utils.asTypeElement(type); |
| if (!(utils.isPublic(tDoc) || utils.isLinkable(tDoc))) { |
| continue; |
| } |
| if (isFirst) { |
| pre.addContent(DocletConstants.NL); |
| pre.addContent(utils.isInterface(typeElement) ? "extends " : "implements "); |
| isFirst = false; |
| } else { |
| pre.addContent(", "); |
| } |
| Content link = getLink(new LinkInfoImpl(configuration, |
| LinkInfoImpl.Kind.CLASS_SIGNATURE_PARENT_NAME, |
| type)); |
| pre.addContent(link); |
| } |
| } |
| classInfoTree.addContent(pre); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addClassDescription(Content classInfoTree) { |
| if(!configuration.nocomment) { |
| // generate documentation for the class. |
| if (!utils.getFullBody(typeElement).isEmpty()) { |
| addInlineComment(typeElement, classInfoTree); |
| } |
| } |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addClassTagInfo(Content classInfoTree) { |
| if(!configuration.nocomment) { |
| // Print Information about all the tags here |
| addTagsInfo(typeElement, classInfoTree); |
| } |
| } |
| |
| /** |
| * Get the class hierarchy tree for the given class. |
| * |
| * @param type the class to print the hierarchy for |
| * @return a content tree for class inheritence |
| */ |
| private Content getClassInheritenceTree(TypeMirror type) { |
| TypeMirror sup; |
| HtmlTree classTreeUl = new HtmlTree(HtmlTag.UL); |
| classTreeUl.setStyle(HtmlStyle.inheritance); |
| Content liTree = null; |
| do { |
| sup = utils.getFirstVisibleSuperClass(type); |
| if (sup != null) { |
| HtmlTree ul = new HtmlTree(HtmlTag.UL); |
| ul.setStyle(HtmlStyle.inheritance); |
| ul.addContent(getTreeForClassHelper(type)); |
| if (liTree != null) |
| ul.addContent(liTree); |
| Content li = HtmlTree.LI(ul); |
| liTree = li; |
| type = sup; |
| } else |
| classTreeUl.addContent(getTreeForClassHelper(type)); |
| } while (sup != null); |
| if (liTree != null) |
| classTreeUl.addContent(liTree); |
| return classTreeUl; |
| } |
| |
| /** |
| * Get the class helper tree for the given class. |
| * |
| * @param type the class to print the helper for |
| * @return a content tree for class helper |
| */ |
| private Content getTreeForClassHelper(TypeMirror type) { |
| Content li = new HtmlTree(HtmlTag.LI); |
| if (type.equals(typeElement.asType())) { |
| Content typeParameters = getTypeParameterLinks( |
| new LinkInfoImpl(configuration, LinkInfoImpl.Kind.TREE, |
| typeElement)); |
| if (configuration.shouldExcludeQualifier(utils.containingPackage(typeElement).toString())) { |
| li.addContent(utils.asTypeElement(type).getSimpleName()); |
| li.addContent(typeParameters); |
| } else { |
| li.addContent(utils.asTypeElement(type).getQualifiedName()); |
| li.addContent(typeParameters); |
| } |
| } else { |
| Content link = getLink(new LinkInfoImpl(configuration, |
| LinkInfoImpl.Kind.CLASS_TREE_PARENT, type) |
| .label(configuration.getClassName(utils.asTypeElement(type)))); |
| li.addContent(link); |
| } |
| return li; |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addClassTree(Content classContentTree) { |
| if (!utils.isClass(typeElement)) { |
| return; |
| } |
| classContentTree.addContent(getClassInheritenceTree(typeElement.asType())); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addTypeParamInfo(Content classInfoTree) { |
| if (!utils.getTypeParamTrees(typeElement).isEmpty()) { |
| Content typeParam = (new ParamTaglet()).getTagletOutput(typeElement, |
| getTagletWriterInstance(false)); |
| Content dl = HtmlTree.DL(typeParam); |
| classInfoTree.addContent(dl); |
| } |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addSubClassInfo(Content classInfoTree) { |
| if (utils.isClass(typeElement)) { |
| if (typeElement.getQualifiedName().contentEquals("java.lang.Object") || |
| typeElement.getQualifiedName().contentEquals("org.omg.CORBA.Object")) { |
| return; // Don't generate the list, too huge |
| } |
| Set<TypeElement> subclasses = classtree.directSubClasses(typeElement, false); |
| if (!subclasses.isEmpty()) { |
| Content label = contents.subclassesLabel; |
| Content dt = HtmlTree.DT(label); |
| Content dl = HtmlTree.DL(dt); |
| dl.addContent(getClassLinks(LinkInfoImpl.Kind.SUBCLASSES, |
| subclasses)); |
| classInfoTree.addContent(dl); |
| } |
| } |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addSubInterfacesInfo(Content classInfoTree) { |
| if (utils.isInterface(typeElement)) { |
| Set<TypeElement> subInterfaces = classtree.allSubClasses(typeElement, false); |
| if (!subInterfaces.isEmpty()) { |
| Content label = contents.subinterfacesLabel; |
| Content dt = HtmlTree.DT(label); |
| Content dl = HtmlTree.DL(dt); |
| dl.addContent(getClassLinks(LinkInfoImpl.Kind.SUBINTERFACES, |
| subInterfaces)); |
| classInfoTree.addContent(dl); |
| } |
| } |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addInterfaceUsageInfo (Content classInfoTree) { |
| if (!utils.isInterface(typeElement)) { |
| return; |
| } |
| if (typeElement.getQualifiedName().contentEquals("java.lang.Cloneable") || |
| typeElement.getQualifiedName().contentEquals("java.io.Serializable")) { |
| return; // Don't generate the list, too big |
| } |
| Set<TypeElement> implcl = classtree.implementingClasses(typeElement); |
| if (!implcl.isEmpty()) { |
| Content label = contents.implementingClassesLabel; |
| Content dt = HtmlTree.DT(label); |
| Content dl = HtmlTree.DL(dt); |
| dl.addContent(getClassLinks(LinkInfoImpl.Kind.IMPLEMENTED_CLASSES, |
| implcl)); |
| classInfoTree.addContent(dl); |
| } |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addImplementedInterfacesInfo(Content classInfoTree) { |
| SortedSet<TypeMirror> interfaces = new TreeSet<>(utils.makeTypeMirrorClassUseComparator()); |
| interfaces.addAll(utils.getAllInterfaces(typeElement)); |
| if (utils.isClass(typeElement) && !interfaces.isEmpty()) { |
| Content label = contents.allImplementedInterfacesLabel; |
| Content dt = HtmlTree.DT(label); |
| Content dl = HtmlTree.DL(dt); |
| dl.addContent(getClassLinks(LinkInfoImpl.Kind.IMPLEMENTED_INTERFACES, interfaces)); |
| classInfoTree.addContent(dl); |
| } |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addSuperInterfacesInfo(Content classInfoTree) { |
| SortedSet<TypeMirror> interfaces = |
| new TreeSet<>(utils.makeTypeMirrorIndexUseComparator()); |
| interfaces.addAll(utils.getAllInterfaces(typeElement)); |
| |
| if (utils.isInterface(typeElement) && !interfaces.isEmpty()) { |
| Content label = contents.allSuperinterfacesLabel; |
| Content dt = HtmlTree.DT(label); |
| Content dl = HtmlTree.DL(dt); |
| dl.addContent(getClassLinks(LinkInfoImpl.Kind.SUPER_INTERFACES, interfaces)); |
| classInfoTree.addContent(dl); |
| } |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addNestedClassInfo(final Content classInfoTree) { |
| Element outerClass = typeElement.getEnclosingElement(); |
| if (outerClass == null) |
| return; |
| new SimpleElementVisitor8<Void, Void>() { |
| @Override |
| public Void visitType(TypeElement e, Void p) { |
| Content label = utils.isInterface(e) |
| ? contents.enclosingInterfaceLabel |
| : contents.enclosingClassLabel; |
| Content dt = HtmlTree.DT(label); |
| Content dl = HtmlTree.DL(dt); |
| Content dd = new HtmlTree(HtmlTag.DD); |
| dd.addContent(getLink(new LinkInfoImpl(configuration, |
| LinkInfoImpl.Kind.CLASS, e))); |
| dl.addContent(dd); |
| classInfoTree.addContent(dl); |
| return null; |
| } |
| }.visit(outerClass); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addFunctionalInterfaceInfo (Content classInfoTree) { |
| if (isFunctionalInterface()) { |
| Content dt = HtmlTree.DT(contents.functionalInterface); |
| Content dl = HtmlTree.DL(dt); |
| Content dd = new HtmlTree(HtmlTag.DD); |
| dd.addContent(contents.functionalInterfaceMessage); |
| dl.addContent(dd); |
| classInfoTree.addContent(dl); |
| } |
| } |
| |
| public boolean isFunctionalInterface() { |
| List<? extends AnnotationMirror> annotationMirrors = ((Element) typeElement).getAnnotationMirrors(); |
| for (AnnotationMirror anno : annotationMirrors) { |
| if (utils.isFunctionalInterface(anno)) { |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void addClassDeprecationInfo(Content classInfoTree) { |
| List<? extends DocTree> deprs = utils.getBlockTags(typeElement, DocTree.Kind.DEPRECATED); |
| if (utils.isDeprecated(typeElement)) { |
| Content deprLabel = HtmlTree.SPAN(HtmlStyle.deprecatedLabel, getDeprecatedPhrase(typeElement)); |
| Content div = HtmlTree.DIV(HtmlStyle.deprecationBlock, deprLabel); |
| if (!deprs.isEmpty()) { |
| CommentHelper ch = utils.getCommentHelper(typeElement); |
| DocTree dt = deprs.get(0); |
| List<? extends DocTree> commentTags = ch.getBody(configuration, dt); |
| if (!commentTags.isEmpty()) { |
| addInlineDeprecatedComment(typeElement, deprs.get(0), div); |
| } |
| } |
| classInfoTree.addContent(div); |
| } |
| } |
| |
| /** |
| * Get links to the given classes. |
| * |
| * @param context the id of the context where the link will be printed |
| * @param list the list of classes |
| * @return a content tree for the class list |
| */ |
| private Content getClassLinks(LinkInfoImpl.Kind context, Collection<?> list) { |
| Content dd = new HtmlTree(HtmlTag.DD); |
| boolean isFirst = true; |
| for (Object type : list) { |
| if (!isFirst) { |
| Content separator = new StringContent(", "); |
| dd.addContent(separator); |
| } else { |
| isFirst = false; |
| } |
| // TODO: should we simply split this method up to avoid instanceof ? |
| if (type instanceof TypeElement) { |
| Content link = getLink( |
| new LinkInfoImpl(configuration, context, (TypeElement)(type))); |
| dd.addContent(HtmlTree.CODE(link)); |
| } else { |
| Content link = getLink( |
| new LinkInfoImpl(configuration, context, ((TypeMirror)type))); |
| dd.addContent(HtmlTree.CODE(link)); |
| } |
| } |
| return dd; |
| } |
| |
| /** |
| * Return the TypeElement being documented. |
| * |
| * @return the TypeElement being documented. |
| */ |
| @Override |
| public TypeElement getTypeElement() { |
| return typeElement; |
| } |
| } |
