1/*
2 * Copyright (c) 1998, 2015, 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 */
25
26package com.sun.tools.doclets.formats.html;
27
28import java.io.*;
29import java.util.*;
30
31import com.sun.javadoc.*;
32import com.sun.tools.doclets.formats.html.markup.*;
33import com.sun.tools.doclets.internal.toolkit.*;
34import com.sun.tools.doclets.internal.toolkit.util.*;
35
36/**
37 * Abstract class to print the class hierarchy page for all the Classes. This
38 * is sub-classed by {@link PackageTreeWriter} and {@link TreeWriter} to
39 * generate the Package Tree and global Tree(for all the classes and packages)
40 * pages.
41 *
42 *  <p><b>This is NOT part of any supported API.
43 *  If you write code that depends on this, you do so at your own risk.
44 *  This code and its internal interfaces are subject to change or
45 *  deletion without notice.</b>
46 *
47 * @author Atul M Dambalkar
48 */
49@Deprecated
50public abstract class AbstractTreeWriter extends HtmlDocletWriter {
51
52    /**
53     * The class and interface tree built by using {@link ClassTree}
54     */
55    protected final ClassTree classtree;
56
57    /**
58     * Constructor initializes classtree variable. This constructor will be used
59     * while generating global tree file "overview-tree.html".
60     *
61     * @param configuration  The current configuration
62     * @param filename   File to be generated.
63     * @param classtree  Tree built by {@link ClassTree}.
64     * @throws IOException
65     * @throws DocletAbortException
66     */
67    protected AbstractTreeWriter(ConfigurationImpl configuration,
68                                 DocPath filename, ClassTree classtree)
69                                 throws IOException {
70        super(configuration, filename);
71        this.classtree = classtree;
72    }
73
74    /**
75     * Add each level of the class tree. For each sub-class or
76     * sub-interface indents the next level information.
77     * Recurses itself to add subclasses info.
78     *
79     * @param parent the superclass or superinterface of the list
80     * @param list list of the sub-classes at this level
81     * @param isEnum true if we are generating a tree for enums
82     * @param contentTree the content tree to which the level information will be added
83     */
84    protected void addLevelInfo(ClassDoc parent, Collection<ClassDoc> list,
85            boolean isEnum, Content contentTree) {
86        if (!list.isEmpty()) {
87            Content ul = new HtmlTree(HtmlTag.UL);
88            for (ClassDoc local : list) {
89                HtmlTree li = new HtmlTree(HtmlTag.LI);
90                li.addStyle(HtmlStyle.circle);
91                addPartialInfo(local, li);
92                addExtendsImplements(parent, local, li);
93                addLevelInfo(local, classtree.subs(local, isEnum),
94                             isEnum, li);   // Recurse
95                ul.addContent(li);
96            }
97            contentTree.addContent(ul);
98        }
99    }
100
101    /**
102     * Add the heading for the tree depending upon tree type if it's a
103     * Class Tree or Interface tree.
104     *
105     * @param list List of classes which are at the most base level, all the
106     * other classes in this run will derive from these classes
107     * @param heading heading for the tree
108     * @param div the content tree to which the tree will be added
109     */
110    protected void addTree(SortedSet<ClassDoc> list, String heading, HtmlTree div) {
111        if (!list.isEmpty()) {
112            ClassDoc firstClassDoc = list.first();
113            Content headingContent = getResource(heading);
114            Content sectionHeading = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, true,
115                    headingContent);
116            HtmlTree htmlTree;
117            if (configuration.allowTag(HtmlTag.SECTION)) {
118                htmlTree = HtmlTree.SECTION(sectionHeading);
119            } else {
120                div.addContent(sectionHeading);
121                htmlTree = div;
122            }
123            addLevelInfo(!firstClassDoc.isInterface()? firstClassDoc : null,
124                    list, list == classtree.baseEnums(), htmlTree);
125            if (configuration.allowTag(HtmlTag.SECTION)) {
126                div.addContent(htmlTree);
127            }
128        }
129    }
130
131    /**
132     * Add information regarding the classes which this class extends or
133     * implements.
134     *
135     * @param parent the parent class of the class being documented
136     * @param cd the classdoc under consideration
137     * @param contentTree the content tree to which the information will be added
138     */
139    protected void addExtendsImplements(ClassDoc parent, ClassDoc cd,
140            Content contentTree) {
141        ClassDoc[] interfaces = cd.interfaces();
142        if (interfaces.length > (cd.isInterface()? 1 : 0)) {
143            Arrays.sort(interfaces);
144            int counter = 0;
145            for (ClassDoc intf : interfaces) {
146                if (parent != intf) {
147                    if (!(intf.isPublic() ||
148                          utils.isLinkable(intf, configuration))) {
149                        continue;
150                    }
151                    if (counter == 0) {
152                        if (cd.isInterface()) {
153                            contentTree.addContent(" (");
154                            contentTree.addContent(getResource("doclet.also"));
155                            contentTree.addContent(" extends ");
156                        } else {
157                            contentTree.addContent(" (implements ");
158                        }
159                    } else {
160                        contentTree.addContent(", ");
161                    }
162                    addPreQualifiedClassLink(LinkInfoImpl.Kind.TREE,
163                                             intf, contentTree);
164                    counter++;
165                }
166            }
167            if (counter > 0) {
168                contentTree.addContent(")");
169            }
170        }
171    }
172
173    /**
174     * Add information about the class kind, if it's a "class" or "interface".
175     *
176     * @param cd the class being documented
177     * @param contentTree the content tree to which the information will be added
178     */
179    protected void addPartialInfo(ClassDoc cd, Content contentTree) {
180        addPreQualifiedStrongClassLink(LinkInfoImpl.Kind.TREE, cd, contentTree);
181    }
182
183    /**
184     * Get the tree label for the navigation bar.
185     *
186     * @return a content tree for the tree label
187     */
188    protected Content getNavLinkTree() {
189        Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, treeLabel);
190        return li;
191    }
192}
193