Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   https://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.bcel.util;
020
021import java.io.File;
022import java.io.FileNotFoundException;
023import java.io.IOException;
024import java.io.PrintWriter;
025import java.io.UnsupportedEncodingException;
026import java.nio.charset.Charset;
027import java.nio.charset.StandardCharsets;
028import java.util.HashSet;
029import java.util.Set;
030
031import org.apache.bcel.Const;
032import org.apache.bcel.Constants;
033import org.apache.bcel.classfile.Attribute;
034import org.apache.bcel.classfile.ClassParser;
035import org.apache.bcel.classfile.ConstantPool;
036import org.apache.bcel.classfile.JavaClass;
037import org.apache.bcel.classfile.Method;
038import org.apache.bcel.classfile.Utility;
039
040/**
041 * Read class file(s) and convert them into HTML files.
042 *
043 * Given a JavaClass object "class" that is in package "package" five files will be created in the specified directory.
044 *
045 * <OL>
046 * <LI>"package"."class".html as the main file which defines the frames for the following subfiles.
047 * <LI>"package"."class"_attributes.html contains all (known) attributes found in the file
048 * <LI>"package"."class"_cp.html contains the constant pool
049 * <LI>"package"."class"_code.html contains the byte code
050 * <LI>"package"."class"_methods.html contains references to all methods and fields of the class
051 * </OL>
052 *
053 * All subfiles reference each other appropriately, for example clicking on a method in the Method's frame will jump to the
054 * appropriate method in the Code frame.
055 */
056public class Class2HTML implements Constants {
057
058    private static String classPackage; // name of package, unclean to make it static, but ...
059    private static String className; // name of current class, dito
060    private static ConstantPool constantPool;
061    private static final Set<String> basicTypes = new HashSet<>();
062    static {
063        basicTypes.add("int");
064        basicTypes.add("short");
065        basicTypes.add("boolean");
066        basicTypes.add("void");
067        basicTypes.add("char");
068        basicTypes.add("byte");
069        basicTypes.add("long");
070        basicTypes.add("double");
071        basicTypes.add("float");
072    }
073
074    public static void main(final String[] argv) throws IOException {
075        final String[] fileName = new String[argv.length];
076        int files = 0;
077        ClassParser parser = null;
078        JavaClass javaClass = null;
079        String zipFile = null;
080        final char sep = File.separatorChar;
081        String dir = "." + sep; // Where to store HTML files
082        /*
083         * Parse command line arguments.
084         */
085        for (int i = 0; i < argv.length; i++) {
086            if (argv[i].charAt(0) == '-') { // command line switch
087                if (argv[i].equals("-d")) { // Specify target directory, default '.'
088                    dir = argv[++i];
089                    if (!dir.endsWith("" + sep)) {
090                        dir += sep;
091                    }
092                    final File store = new File(dir);
093                    if (!store.isDirectory()) {
094                        final boolean created = store.mkdirs(); // Create target directory if necessary
095                        if (!created && !store.isDirectory()) {
096                            System.out.println("Tried to create the directory " + dir + " but failed");
097                        }
098                    }
099                } else if (argv[i].equals("-zip")) {
100                    zipFile = argv[++i];
101                } else {
102                    System.out.println("Unknown option " + argv[i]);
103                }
104            } else {
105                fileName[files++] = argv[i];
106            }
107        }
108        if (files == 0) {
109            System.err.println("Class2HTML: No input files specified.");
110        } else { // Loop through files ...
111            for (int i = 0; i < files; i++) {
112                System.out.print("Processing " + fileName[i] + "...");
113                if (zipFile == null) {
114                    parser = new ClassParser(fileName[i]); // Create parser object from file
115                } else {
116                    parser = new ClassParser(zipFile, fileName[i]); // Create parser object from ZIP file
117                }
118                javaClass = parser.parse();
119                new Class2HTML(javaClass, dir);
120                System.out.println("Done.");
121            }
122        }
123    }
124
125    /**
126     * Utility method that converts a class reference in the constant pool, i.e., an index to a string.
127     */
128    static String referenceClass(final int index) {
129        String str = constantPool.getConstantString(index, Const.CONSTANT_Class);
130        str = Utility.compactClassName(str);
131        str = Utility.compactClassName(str, classPackage + ".", true);
132        return "<A HREF=\"" + className + "_cp.html#cp" + index + "\" TARGET=ConstantPool>" + str + "</A>";
133    }
134
135    static String referenceType(final String type) {
136        String shortType = Utility.compactClassName(type);
137        shortType = Utility.compactClassName(shortType, classPackage + ".", true);
138        final int index = type.indexOf('['); // Type is an array?
139        String baseType = type;
140        if (index > -1) {
141            baseType = type.substring(0, index); // Tack of the '['
142        }
143        // test for basic type
144        if (basicTypes.contains(baseType)) {
145            return "<FONT COLOR=\"#00FF00\">" + type + "</FONT>";
146        }
147        return "<A HREF=\"" + baseType + ".html\" TARGET=_top>" + shortType + "</A>";
148    }
149
150    static String toHTML(final String str) {
151        final StringBuilder buf = new StringBuilder();
152        for (int i = 0; i < str.length(); i++) {
153            final char ch;
154            switch (ch = str.charAt(i)) {
155            case '<':
156                buf.append("&lt;");
157                break;
158            case '>':
159                buf.append("&gt;");
160                break;
161            case '\n':
162                buf.append("\\n");
163                break;
164            case '\r':
165                buf.append("\\r");
166                break;
167            default:
168                buf.append(ch);
169            }
170        }
171        return buf.toString();
172    }
173
174    private final JavaClass javaClass; // current class object
175
176    private final String dir;
177
178    /**
179     * Writes contents of the given JavaClass into HTML files.
180     *
181     * @param javaClass The class to write
182     * @param dir The directory to put the files in
183     * @throws IOException Thrown when an I/O exception of some sort has occurred.
184     */
185    public Class2HTML(final JavaClass javaClass, final String dir) throws IOException {
186        this(javaClass, dir, StandardCharsets.UTF_8);
187    }
188
189    private Class2HTML(final JavaClass javaClass, final String dir, final Charset charset) throws IOException {
190        final Method[] methods = javaClass.getMethods();
191        this.javaClass = javaClass;
192        this.dir = dir;
193        className = javaClass.getClassName(); // Remember full name
194        constantPool = javaClass.getConstantPool();
195        // Get package name by tacking off everything after the last '.'
196        final int index = className.lastIndexOf('.');
197        if (index > -1) {
198            classPackage = className.substring(0, index);
199        } else {
200            classPackage = ""; // default package
201        }
202        final ConstantHTML constantHtml = new ConstantHTML(dir, className, classPackage, methods, constantPool, charset);
203        /*
204         * Attributes can't be written in one step, so we just open a file which will be written consequently.
205         */
206        try (AttributeHTML attributeHtml = new AttributeHTML(dir, className, constantPool, constantHtml, charset)) {
207            new MethodHTML(dir, className, methods, javaClass.getFields(), constantHtml, attributeHtml, charset);
208            // Write main file (with frames, yuk)
209            writeMainHTML(attributeHtml, charset);
210            new CodeHTML(dir, className, methods, constantPool, constantHtml, charset);
211        }
212    }
213
214    private void writeMainHTML(final AttributeHTML attributeHtml, final Charset charset) throws FileNotFoundException, UnsupportedEncodingException {
215        try (PrintWriter file = new PrintWriter(dir + className + ".html", charset.name())) {
216            // @formatter:off
217            file.println("<HTML>\n"
218                + "<HEAD><TITLE>Documentation for " + className + "</TITLE></HEAD>\n"
219                + "<FRAMESET BORDER=1 cols=\"30%,*\">\n"
220                + "<FRAMESET BORDER=1 rows=\"80%,*\">\n"
221                + "<FRAME NAME=\"ConstantPool\" SRC=\"" + className + "_cp.html" + "\"\n"
222                + "MARGINWIDTH=\"0\" "
223                + "MARGINHEIGHT=\"0\" FRAMEBORDER=\"1\" SCROLLING=\"AUTO\">\n"
224                + "<FRAME NAME=\"Attributes\" SRC=\"" + className + "_attributes.html\"\n"
225                + " MARGINWIDTH=\"0\" MARGINHEIGHT=\"0\" FRAMEBORDER=\"1\" SCROLLING=\"AUTO\">\n"
226                + "</FRAMESET>\n"
227                + "<FRAMESET BORDER=1 rows=\"80%,*\">\n"
228                + "<FRAME NAME=\"Code\" SRC=\"" + className + "_code.html\"\n"
229                + " MARGINWIDTH=0 "
230                + "MARGINHEIGHT=0 FRAMEBORDER=1 SCROLLING=\"AUTO\">\n"
231                + "<FRAME NAME=\"Methods\" SRC=\"" + className + "_methods.html\"\n"
232                + " MARGINWIDTH=0 "
233                + "MARGINHEIGHT=0 FRAMEBORDER=1 SCROLLING=\"AUTO\">\n"
234                + "</FRAMESET></FRAMESET></HTML>");
235            // @formatter:on
236        }
237        final Attribute[] attributes = javaClass.getAttributes();
238        for (int i = 0; i < attributes.length; i++) {
239            attributeHtml.writeAttribute(attributes[i], "class" + i);
240        }
241    }
242}