| /* |
| * Copyright (c) 2003, 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.ArrayList; |
| import java.util.List; |
| |
| import javax.lang.model.element.AnnotationMirror; |
| import javax.lang.model.element.Element; |
| import javax.lang.model.element.TypeElement; |
| import javax.lang.model.type.DeclaredType; |
| import javax.lang.model.type.TypeMirror; |
| |
| import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder; |
| import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration; |
| import jdk.javadoc.internal.doclets.toolkit.Content; |
| import jdk.javadoc.internal.doclets.toolkit.Resources; |
| import jdk.javadoc.internal.doclets.toolkit.util.DocPath; |
| import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
| import jdk.javadoc.internal.doclets.toolkit.util.links.LinkFactory; |
| import jdk.javadoc.internal.doclets.toolkit.util.links.LinkInfo; |
| |
| /** |
| * A factory that returns a link given the information about it. |
| * |
| * <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> |
| * |
| * @author Jamie Ho |
| */ |
| public class LinkFactoryImpl extends LinkFactory { |
| |
| private final HtmlDocletWriter m_writer; |
| private final DocPaths docPaths; |
| |
| public LinkFactoryImpl(HtmlDocletWriter writer) { |
| super(writer.configuration.utils); |
| m_writer = writer; |
| docPaths = writer.configuration.docPaths; |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| protected Content newContent() { |
| return new ContentBuilder(); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| protected Content getClassLink(LinkInfo linkInfo) { |
| BaseConfiguration configuration = m_writer.configuration; |
| LinkInfoImpl classLinkInfo = (LinkInfoImpl) linkInfo; |
| boolean noLabel = linkInfo.label == null || linkInfo.label.isEmpty(); |
| TypeElement typeElement = classLinkInfo.typeElement; |
| // Create a tool tip if we are linking to a class or interface. Don't |
| // create one if we are linking to a member. |
| String title = ""; |
| if (classLinkInfo.where == null || classLinkInfo.where.length() == 0) { |
| boolean isTypeLink = classLinkInfo.type != null && |
| utils.isTypeVariable(utils.getComponentType(classLinkInfo.type)); |
| title = getClassToolTip(typeElement, isTypeLink); |
| } |
| Content label = classLinkInfo.getClassLinkLabel(configuration); |
| |
| Content link = new ContentBuilder(); |
| if (utils.isIncluded(typeElement)) { |
| if (configuration.isGeneratedDoc(typeElement)) { |
| DocPath filename = getPath(classLinkInfo); |
| if (linkInfo.linkToSelf || |
| !(docPaths.forName(typeElement)).equals(m_writer.filename)) { |
| link.addContent(m_writer.links.createLink( |
| filename.fragment(classLinkInfo.where), |
| label, |
| classLinkInfo.isStrong, |
| title, |
| classLinkInfo.target)); |
| if (noLabel && !classLinkInfo.excludeTypeParameterLinks) { |
| link.addContent(getTypeParameterLinks(linkInfo)); |
| } |
| return link; |
| } |
| } |
| } else { |
| Content crossLink = m_writer.getCrossClassLink( |
| typeElement, classLinkInfo.where, |
| label, classLinkInfo.isStrong, true); |
| if (crossLink != null) { |
| link.addContent(crossLink); |
| if (noLabel && !classLinkInfo.excludeTypeParameterLinks) { |
| link.addContent(getTypeParameterLinks(linkInfo)); |
| } |
| return link; |
| } |
| } |
| // Can't link so just write label. |
| link.addContent(label); |
| if (noLabel && !classLinkInfo.excludeTypeParameterLinks) { |
| link.addContent(getTypeParameterLinks(linkInfo)); |
| } |
| return link; |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| protected Content getTypeParameterLinks(LinkInfo linkInfo, boolean isClassLabel){ |
| Content links = newContent(); |
| List<TypeMirror> vars = new ArrayList<>(); |
| TypeMirror ctype = linkInfo.type != null |
| ? utils.getComponentType(linkInfo.type) |
| : null; |
| if (linkInfo.executableElement != null) { |
| linkInfo.executableElement.getTypeParameters().stream().forEach((t) -> { |
| vars.add(t.asType()); |
| }); |
| } else if (linkInfo.type != null && utils.isDeclaredType(linkInfo.type)) { |
| ((DeclaredType)linkInfo.type).getTypeArguments().stream().forEach(vars::add); |
| } else if (ctype != null && utils.isDeclaredType(ctype)) { |
| ((DeclaredType)ctype).getTypeArguments().stream().forEach(vars::add); |
| } else if (linkInfo.typeElement != null) { |
| linkInfo.typeElement.getTypeParameters().stream().forEach((t) -> { |
| vars.add(t.asType()); |
| }); |
| } else { |
| // Nothing to document. |
| return links; |
| } |
| if (((linkInfo.includeTypeInClassLinkLabel && isClassLabel) |
| || (linkInfo.includeTypeAsSepLink && !isClassLabel)) && !vars.isEmpty()) { |
| links.addContent("<"); |
| boolean many = false; |
| for (TypeMirror t : vars) { |
| if (many) { |
| links.addContent(","); |
| links.addContent(Contents.ZERO_WIDTH_SPACE); |
| } |
| links.addContent(getTypeParameterLink(linkInfo, t)); |
| many = true; |
| } |
| links.addContent(">"); |
| } |
| return links; |
| } |
| |
| /** |
| * Returns a link to the given type parameter. |
| * |
| * @param linkInfo the information about the link to construct |
| * @param typeParam the type parameter to link to |
| * @return the link |
| */ |
| protected Content getTypeParameterLink(LinkInfo linkInfo, TypeMirror typeParam) { |
| LinkInfoImpl typeLinkInfo = new LinkInfoImpl(m_writer.configuration, |
| ((LinkInfoImpl) linkInfo).getContext(), typeParam); |
| typeLinkInfo.excludeTypeBounds = linkInfo.excludeTypeBounds; |
| typeLinkInfo.excludeTypeParameterLinks = linkInfo.excludeTypeParameterLinks; |
| typeLinkInfo.linkToSelf = linkInfo.linkToSelf; |
| typeLinkInfo.isJava5DeclarationLocation = false; |
| return getLink(typeLinkInfo); |
| } |
| |
| @Override |
| public Content getTypeAnnotationLinks(LinkInfo linkInfo) { |
| ContentBuilder links = new ContentBuilder(); |
| List<? extends AnnotationMirror> annotations; |
| if (utils.isAnnotated(linkInfo.type)) { |
| annotations = linkInfo.type.getAnnotationMirrors(); |
| } else if (utils.isTypeVariable(linkInfo.type)) { |
| // TODO: use the context for now, and special case for Receiver_Types, |
| // which takes the default case. |
| switch (((LinkInfoImpl)linkInfo).context) { |
| case MEMBER_TYPE_PARAMS: |
| case EXECUTABLE_MEMBER_PARAM: |
| case CLASS_SIGNATURE: |
| Element element = utils.typeUtils.asElement(linkInfo.type); |
| annotations = element.getAnnotationMirrors(); |
| break; |
| default: |
| annotations = linkInfo.type.getAnnotationMirrors(); |
| break; |
| } |
| |
| } else { |
| return links; |
| } |
| |
| if (annotations.isEmpty()) |
| return links; |
| |
| List<Content> annos = m_writer.getAnnotations(0, annotations, false, linkInfo.isJava5DeclarationLocation); |
| |
| boolean isFirst = true; |
| for (Content anno : annos) { |
| if (!isFirst) { |
| links.addContent(" "); |
| } |
| links.addContent(anno); |
| isFirst = false; |
| } |
| if (!annos.isEmpty()) { |
| links.addContent(" "); |
| } |
| |
| return links; |
| } |
| |
| /** |
| * Given a class, return the appropriate tool tip. |
| * |
| * @param typeElement the class to get the tool tip for. |
| * @return the tool tip for the appropriate class. |
| */ |
| private String getClassToolTip(TypeElement typeElement, boolean isTypeLink) { |
| Resources resources = m_writer.configuration.getResources(); |
| if (isTypeLink) { |
| return resources.getText("doclet.Href_Type_Param_Title", |
| utils.getSimpleName(typeElement)); |
| } else if (utils.isInterface(typeElement)){ |
| return resources.getText("doclet.Href_Interface_Title", |
| utils.getPackageName(utils.containingPackage(typeElement))); |
| } else if (utils.isAnnotationType(typeElement)) { |
| return resources.getText("doclet.Href_Annotation_Title", |
| utils.getPackageName(utils.containingPackage(typeElement))); |
| } else if (utils.isEnum(typeElement)) { |
| return resources.getText("doclet.Href_Enum_Title", |
| utils.getPackageName(utils.containingPackage(typeElement))); |
| } else { |
| return resources.getText("doclet.Href_Class_Title", |
| utils.getPackageName(utils.containingPackage(typeElement))); |
| } |
| } |
| |
| /** |
| * Return path to the given file name in the given package. So if the name |
| * passed is "Object.html" and the name of the package is "java.lang", and |
| * if the relative path is "../.." then returned string will be |
| * "../../java/lang/Object.html" |
| * |
| * @param linkInfo the information about the link. |
| */ |
| private DocPath getPath(LinkInfoImpl linkInfo) { |
| if (linkInfo.context == LinkInfoImpl.Kind.PACKAGE_FRAME) { |
| //Not really necessary to do this but we want to be consistent |
| //with 1.4.2 output. |
| return docPaths.forName(linkInfo.typeElement); |
| } |
| return m_writer.pathToRoot.resolve(docPaths.forClass(linkInfo.typeElement)); |
| } |
| } |
