1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache License, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 */ 18 package org.apache.bcel.util; 19 20 import java.io.File; 21 import java.io.FileOutputStream; 22 import java.io.IOException; 23 import java.io.PrintWriter; 24 import java.util.HashSet; 25 import java.util.Set; 26 27 import org.apache.bcel.Const; 28 import org.apache.bcel.Constants; 29 import org.apache.bcel.classfile.Attribute; 30 import org.apache.bcel.classfile.ClassParser; 31 import org.apache.bcel.classfile.ConstantPool; 32 import org.apache.bcel.classfile.JavaClass; 33 import org.apache.bcel.classfile.Method; 34 import org.apache.bcel.classfile.Utility; 35 36 /** 37 * Read class file(s) and convert them into HTML files. 38 * 39 * Given a JavaClass object "class" that is in package "package" five files 40 * will be created in the specified directory. 41 * 42 * <OL> 43 * <LI> "package"."class".html as the main file which defines the frames for 44 * the following subfiles. 45 * <LI> "package"."class"_attributes.html contains all (known) attributes found in the file 46 * <LI> "package"."class"_cp.html contains the constant pool 47 * <LI> "package"."class"_code.html contains the byte code 48 * <LI> "package"."class"_methods.html contains references to all methods and fields of the class 49 * </OL> 50 * 51 * All subfiles reference each other appropriately, e.g. clicking on a 52 * method in the Method's frame will jump to the appropriate method in 53 * the Code frame. 54 * 55 * @version $Id$ 56 */ 57 public class Class2HTML implements Constants { 58 59 private final JavaClass java_class; // current class object 60 private final String dir; 61 private static String class_package; // name of package, unclean to make it static, but ... 62 private static String class_name; // name of current class, dito 63 private static ConstantPool constant_pool; 64 private static final Set<String> basic_types = new HashSet<>(); 65 66 static { 67 basic_types.add("int"); 68 basic_types.add("short"); 69 basic_types.add("boolean"); 70 basic_types.add("void"); 71 basic_types.add("char"); 72 basic_types.add("byte"); 73 basic_types.add("long"); 74 basic_types.add("double"); 75 basic_types.add("float"); 76 } 77 78 /** 79 * Write contents of the given JavaClass into HTML files. 80 * 81 * @param java_class The class to write 82 * @param dir The directory to put the files in 83 */ 84 public Class2HTML(final JavaClass java_class, final String dir) throws IOException { 85 final Method[] methods = java_class.getMethods(); 86 this.java_class = java_class; 87 this.dir = dir; 88 class_name = java_class.getClassName(); // Remember full name 89 constant_pool = java_class.getConstantPool(); 90 // Get package name by tacking off everything after the last `.' 91 final int index = class_name.lastIndexOf('.'); 92 if (index > -1) { 93 class_package = class_name.substring(0, index); 94 } else { 95 class_package = ""; // default package 96 } 97 final ConstantHTML constant_html = new ConstantHTML(dir, class_name, class_package, methods, 98 constant_pool); 99 /* Attributes can't be written in one step, so we just open a file 100 * which will be written consequently. 101 */ 102 final AttributeHTML attribute_html = new AttributeHTML(dir, class_name, constant_pool, 103 constant_html); 104 new MethodHTML(dir, class_name, methods, java_class.getFields(), 105 constant_html, attribute_html); 106 // Write main file (with frames, yuk) 107 writeMainHTML(attribute_html); 108 new CodeHTML(dir, class_name, methods, constant_pool, constant_html); 109 attribute_html.close(); 110 } 111 112 113 public static void main( final String[] argv ) throws IOException { 114 final String[] file_name = new String[argv.length]; 115 int files = 0; 116 ClassParser parser = null; 117 JavaClass java_class = null; 118 String zip_file = null; 119 final char sep = File.separatorChar; 120 String dir = "." + sep; // Where to store HTML files 121 /* Parse command line arguments. 122 */ 123 for (int i = 0; i < argv.length; i++) { 124 if (argv[i].charAt(0) == '-') { // command line switch 125 if (argv[i].equals("-d")) { // Specify target directory, default '.' 126 dir = argv[++i]; 127 if (!dir.endsWith("" + sep)) { 128 dir = dir + sep; 129 } 130 final File store = new File(dir); 131 if (!store.isDirectory()) { 132 final boolean created = store.mkdirs(); // Create target directory if necessary 133 if (!created) { 134 if (!store.isDirectory()) { 135 System.out.println("Tried to create the directory " + dir + " but failed"); 136 } 137 } 138 } 139 } else if (argv[i].equals("-zip")) { 140 zip_file = argv[++i]; 141 } else { 142 System.out.println("Unknown option " + argv[i]); 143 } 144 } else { 145 file_name[files++] = argv[i]; 146 } 147 } 148 if (files == 0) { 149 System.err.println("Class2HTML: No input files specified."); 150 } else { // Loop through files ... 151 for (int i = 0; i < files; i++) { 152 System.out.print("Processing " + file_name[i] + "..."); 153 if (zip_file == null) { 154 parser = new ClassParser(file_name[i]); // Create parser object from file 155 } else { 156 parser = new ClassParser(zip_file, file_name[i]); // Create parser object from zip file 157 } 158 java_class = parser.parse(); 159 new Class2HTML(java_class, dir); 160 System.out.println("Done."); 161 } 162 } 163 } 164 165 166 /** 167 * Utility method that converts a class reference in the constant pool, 168 * i.e., an index to a string. 169 */ 170 static String referenceClass( final int index ) { 171 String str = constant_pool.getConstantString(index, Const.CONSTANT_Class); 172 str = Utility.compactClassName(str); 173 str = Utility.compactClassName(str, class_package + ".", true); 174 return "<A HREF=\"" + class_name + "_cp.html#cp" + index + "\" TARGET=ConstantPool>" + str 175 + "</A>"; 176 } 177 178 179 static String referenceType( final String type ) { 180 String short_type = Utility.compactClassName(type); 181 short_type = Utility.compactClassName(short_type, class_package + ".", true); 182 final int index = type.indexOf('['); // Type is an array? 183 String base_type = type; 184 if (index > -1) { 185 base_type = type.substring(0, index); // Tack of the `[' 186 } 187 // test for basic type 188 if (basic_types.contains(base_type)) { 189 return "<FONT COLOR=\"#00FF00\">" + type + "</FONT>"; 190 } 191 return "<A HREF=\"" + base_type + ".html\" TARGET=_top>" + short_type + "</A>"; 192 } 193 194 195 static String toHTML( final String str ) { 196 final StringBuilder buf = new StringBuilder(); 197 for (int i = 0; i < str.length(); i++) { 198 char ch; 199 switch (ch = str.charAt(i)) { 200 case '<': 201 buf.append("<"); 202 break; 203 case '>': 204 buf.append(">"); 205 break; 206 case '\n': 207 buf.append("\\n"); 208 break; 209 case '\r': 210 buf.append("\\r"); 211 break; 212 default: 213 buf.append(ch); 214 } 215 } 216 return buf.toString(); 217 } 218 219 220 private void writeMainHTML( final AttributeHTML attribute_html ) throws IOException { 221 try (PrintWriter file = new PrintWriter(new FileOutputStream(dir + class_name + ".html"))) { 222 file.println("<HTML>\n" + "<HEAD><TITLE>Documentation for " + class_name + "</TITLE>" + "</HEAD>\n" 223 + "<FRAMESET BORDER=1 cols=\"30%,*\">\n" + "<FRAMESET BORDER=1 rows=\"80%,*\">\n" 224 + "<FRAME NAME=\"ConstantPool\" SRC=\"" + class_name + "_cp.html" + "\"\n MARGINWIDTH=\"0\" " 225 + "MARGINHEIGHT=\"0\" FRAMEBORDER=\"1\" SCROLLING=\"AUTO\">\n" + "<FRAME NAME=\"Attributes\" SRC=\"" 226 + class_name + "_attributes.html" + "\"\n MARGINWIDTH=\"0\" " 227 + "MARGINHEIGHT=\"0\" FRAMEBORDER=\"1\" SCROLLING=\"AUTO\">\n" + "</FRAMESET>\n" 228 + "<FRAMESET BORDER=1 rows=\"80%,*\">\n" + "<FRAME NAME=\"Code\" SRC=\"" + class_name 229 + "_code.html\"\n MARGINWIDTH=0 " + "MARGINHEIGHT=0 FRAMEBORDER=1 SCROLLING=\"AUTO\">\n" 230 + "<FRAME NAME=\"Methods\" SRC=\"" + class_name + "_methods.html\"\n MARGINWIDTH=0 " 231 + "MARGINHEIGHT=0 FRAMEBORDER=1 SCROLLING=\"AUTO\">\n" + "</FRAMESET></FRAMESET></HTML>"); 232 } 233 final Attribute[] attributes = java_class.getAttributes(); 234 for (int i = 0; i < attributes.length; i++) { 235 attribute_html.writeAttribute(attributes[i], "class" + i); 236 } 237 } 238 } 239
