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