< prev index next >
src/java.xml/share/classes/com/sun/org/apache/bcel/internal/util/Class2HTML.java
Print this page
*** 1,8 ****
/*
! * reserved comment block
! * DO NOT REMOVE OR ALTER!
*/
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
--- 1,7 ----
/*
! * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
*/
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
*** 16,229 ****
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package com.sun.org.apache.bcel.internal.util;
!
! import java.io.*;
! import java.util.BitSet;
! import com.sun.org.apache.bcel.internal.classfile.*;
! import com.sun.org.apache.bcel.internal.Constants;
/**
* Read class file(s) and convert them into HTML files.
*
! * Given a JavaClass object "class" that is in package "package" five files
! * will be created in the specified directory.
*
* <OL>
! * <LI> "package"."class".html as the main file which defines the frames for
! * the following subfiles.
! * <LI> "package"."class"_attributes.html contains all (known) attributes found in the file
* <LI> "package"."class"_cp.html contains the constant pool
* <LI> "package"."class"_code.html contains the byte code
! * <LI> "package"."class"_methods.html contains references to all methods and fields of the class
* </OL>
*
! * All subfiles reference each other appropiately, e.g. clicking on a
! * method in the Method's frame will jump to the appropiate method in
! * the Code frame.
! *
! * @author <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
! */
! public class Class2HTML implements Constants
! {
! private JavaClass java_class; // current class object
! private String dir;
private static String class_package; // name of package, unclean to make it static, but ...
private static String class_name; // name of current class, dito
private static ConstantPool constant_pool;
/**
* Write contents of the given JavaClass into HTML files.
*
* @param java_class The class to write
* @param dir The directory to put the files in
*/
! public Class2HTML(JavaClass java_class, String dir) throws IOException {
! Method[] methods = java_class.getMethods();
!
this.java_class = java_class;
this.dir = dir;
class_name = java_class.getClassName(); // Remember full name
constant_pool = java_class.getConstantPool();
-
// Get package name by tacking off everything after the last `.'
! int index = class_name.lastIndexOf('.');
! if(index > -1)
class_package = class_name.substring(0, index);
! else
class_package = ""; // default package
!
! ConstantHTML constant_html = new ConstantHTML(dir, class_name, class_package, methods,
constant_pool);
-
/* Attributes can't be written in one step, so we just open a file
* which will be written consequently.
*/
! AttributeHTML attribute_html = new AttributeHTML(dir, class_name, constant_pool, constant_html);
!
! MethodHTML method_html = new MethodHTML(dir, class_name, methods, java_class.getFields(),
constant_html, attribute_html);
// Write main file (with frames, yuk)
writeMainHTML(attribute_html);
new CodeHTML(dir, class_name, methods, constant_pool, constant_html);
attribute_html.close();
}
! public static void _main(String argv[])
! {
! String[] file_name = new String[argv.length];
! int files=0;
! ClassParser parser=null;
! JavaClass java_class=null;
String zip_file = null;
! char sep = SecuritySupport.getSystemProperty("file.separator").toCharArray()[0];
String dir = "." + sep; // Where to store HTML files
-
- try {
/* Parse command line arguments.
*/
! for(int i=0; i < argv.length; i++) {
! if(argv[i].charAt(0) == '-') { // command line switch
! if(argv[i].equals("-d")) { // Specify target directory, default '.'
dir = argv[++i];
!
! if(!dir.endsWith("" + sep))
dir = dir + sep;
! new File(dir).mkdirs(); // Create target directory if necessary
}
! else if(argv[i].equals("-zip"))
zip_file = argv[++i];
! else
System.out.println("Unknown option " + argv[i]);
}
! else // add file name to list */
file_name[files++] = argv[i];
}
!
! if(files == 0)
System.err.println("Class2HTML: No input files specified.");
! else { // Loop through files ...
! for(int i=0; i < files; i++) {
System.out.print("Processing " + file_name[i] + "...");
! if(zip_file == null)
parser = new ClassParser(file_name[i]); // Create parser object from file
! else
parser = new ClassParser(zip_file, file_name[i]); // Create parser object from zip file
!
java_class = parser.parse();
new Class2HTML(java_class, dir);
System.out.println("Done.");
}
}
- } catch(Exception e) {
- System.out.println(e);
- e.printStackTrace(System.out);
- }
}
/**
* Utility method that converts a class reference in the constant pool,
* i.e., an index to a string.
*/
! static String referenceClass(int index) {
! String str = constant_pool.getConstantString(index, CONSTANT_Class);
str = Utility.compactClassName(str);
str = Utility.compactClassName(str, class_package + ".", true);
!
! return "<A HREF=\"" + class_name + "_cp.html#cp" + index +
! "\" TARGET=ConstantPool>" + str + "</A>";
}
! static final String referenceType(String type) {
String short_type = Utility.compactClassName(type);
short_type = Utility.compactClassName(short_type, class_package + ".", true);
!
! int index = type.indexOf('['); // Type is an array?
! if(index > -1)
! type = type.substring(0, index); // Tack of the `['
!
// test for basic type
! if(type.equals("int") || type.equals("short") || type.equals("boolean") || type.equals("void") ||
! type.equals("char") || type.equals("byte") || type.equals("long") || type.equals("double") ||
! type.equals("float"))
return "<FONT COLOR=\"#00FF00\">" + type + "</FONT>";
! else
! return "<A HREF=\"" + type + ".html\" TARGET=_top>" + short_type + "</A>";
}
! static String toHTML(String str) {
! StringBuffer buf = new StringBuffer();
!
! try { // Filter any characters HTML doesn't like such as < and > in particular
! for(int i=0; i < str.length(); i++) {
char ch;
!
! switch(ch=str.charAt(i)) {
! case '<': buf.append("<"); break;
! case '>': buf.append(">"); break;
! case '\n': buf.append("\\n"); break;
! case '\r': buf.append("\\r"); break;
! default: buf.append(ch);
}
}
- } catch(StringIndexOutOfBoundsException e) {} // Never occurs
-
return buf.toString();
}
! private void writeMainHTML(AttributeHTML attribute_html) throws IOException {
! PrintWriter file = new PrintWriter(new FileOutputStream(dir + class_name + ".html"));
! Attribute[] attributes = java_class.getAttributes();
!
! file.println("<HTML>\n" + "<HEAD><TITLE>Documentation for " + class_name + "</TITLE>" +
! "</HEAD>\n" +
! "<FRAMESET BORDER=1 cols=\"30%,*\">\n" +
! "<FRAMESET BORDER=1 rows=\"80%,*\">\n" +
!
! "<FRAME NAME=\"ConstantPool\" SRC=\"" + class_name + "_cp.html" + "\"\n MARGINWIDTH=\"0\" " +
! "MARGINHEIGHT=\"0\" FRAMEBORDER=\"1\" SCROLLING=\"AUTO\">\n" +
! "<FRAME NAME=\"Attributes\" SRC=\"" + class_name + "_attributes.html" +
! "\"\n MARGINWIDTH=\"0\" " +
! "MARGINHEIGHT=\"0\" FRAMEBORDER=\"1\" SCROLLING=\"AUTO\">\n" +
! "</FRAMESET>\n" +
!
! "<FRAMESET BORDER=1 rows=\"80%,*\">\n" +
! "<FRAME NAME=\"Code\" SRC=\"" + class_name + "_code.html\"\n MARGINWIDTH=0 " +
! "MARGINHEIGHT=0 FRAMEBORDER=1 SCROLLING=\"AUTO\">\n" +
! "<FRAME NAME=\"Methods\" SRC=\"" + class_name + "_methods.html\"\n MARGINWIDTH=0 " +
! "MARGINHEIGHT=0 FRAMEBORDER=1 SCROLLING=\"AUTO\">\n" +
! "</FRAMESET></FRAMESET></HTML>"
! );
!
! file.close();
!
! for(int i=0; i < attributes.length; i++)
attribute_html.writeAttribute(attributes[i], "class" + i);
}
}
--- 15,236 ----
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.sun.org.apache.bcel.internal.util;
! import java.io.File;
! import java.io.FileOutputStream;
! import java.io.IOException;
! import java.io.PrintWriter;
! import java.util.HashSet;
! import java.util.Set;
!
! import com.sun.org.apache.bcel.internal.Const;
! import com.sun.org.apache.bcel.internal.classfile.Attribute;
! import com.sun.org.apache.bcel.internal.classfile.ClassParser;
! import com.sun.org.apache.bcel.internal.classfile.ConstantPool;
! import com.sun.org.apache.bcel.internal.classfile.JavaClass;
! import com.sun.org.apache.bcel.internal.classfile.Method;
! import com.sun.org.apache.bcel.internal.classfile.Utility;
/**
* Read class file(s) and convert them into HTML files.
*
! * Given a JavaClass object "class" that is in package "package" five files will
! * be created in the specified directory.
*
* <OL>
! * <LI> "package"."class".html as the main file which defines the frames for the
! * following subfiles.
! * <LI> "package"."class"_attributes.html contains all (known) attributes found
! * in the file
* <LI> "package"."class"_cp.html contains the constant pool
* <LI> "package"."class"_code.html contains the byte code
! * <LI> "package"."class"_methods.html contains references to all methods and
! * fields of the class
* </OL>
*
! * All subfiles reference each other appropriately, e.g. clicking on a method in
! * the Method's frame will jump to the appropriate method in the Code frame.
! *
! * @version $Id: Class2HTML.java 1749603 2016-06-21 20:50:19Z ggregory $
! */
! public class Class2HTML {
+ private final JavaClass java_class; // current class object
+ private final String dir;
private static String class_package; // name of package, unclean to make it static, but ...
private static String class_name; // name of current class, dito
private static ConstantPool constant_pool;
+ private static final Set<String> basic_types = new HashSet<>();
+
+ static {
+ basic_types.add("int");
+ basic_types.add("short");
+ basic_types.add("boolean");
+ basic_types.add("void");
+ basic_types.add("char");
+ basic_types.add("byte");
+ basic_types.add("long");
+ basic_types.add("double");
+ basic_types.add("float");
+ }
/**
* Write contents of the given JavaClass into HTML files.
*
* @param java_class The class to write
* @param dir The directory to put the files in
*/
! public Class2HTML(final JavaClass java_class, final String dir) throws IOException {
! final Method[] methods = java_class.getMethods();
this.java_class = java_class;
this.dir = dir;
class_name = java_class.getClassName(); // Remember full name
constant_pool = java_class.getConstantPool();
// Get package name by tacking off everything after the last `.'
! final int index = class_name.lastIndexOf('.');
! if (index > -1) {
class_package = class_name.substring(0, index);
! } else {
class_package = ""; // default package
! }
! final ConstantHTML constant_html = new ConstantHTML(dir, class_name, class_package, methods,
constant_pool);
/* Attributes can't be written in one step, so we just open a file
* which will be written consequently.
*/
! final AttributeHTML attribute_html = new AttributeHTML(dir, class_name, constant_pool,
! constant_html);
! new MethodHTML(dir, class_name, methods, java_class.getFields(),
constant_html, attribute_html);
// Write main file (with frames, yuk)
writeMainHTML(attribute_html);
new CodeHTML(dir, class_name, methods, constant_pool, constant_html);
attribute_html.close();
}
! public static void _main(final String[] argv) throws IOException {
! final String[] file_name = new String[argv.length];
! int files = 0;
! ClassParser parser = null;
! JavaClass java_class = null;
String zip_file = null;
! final char sep = File.separatorChar;
String dir = "." + sep; // Where to store HTML files
/* Parse command line arguments.
*/
! for (int i = 0; i < argv.length; i++) {
! if (argv[i].charAt(0) == '-') { // command line switch
! if (argv[i].equals("-d")) { // Specify target directory, default '.'
dir = argv[++i];
! if (!dir.endsWith("" + sep)) {
dir = dir + sep;
+ }
+ final File store = new File(dir);
! if (!store.isDirectory()) {
! final boolean created = store.mkdirs(); // Create target directory if necessary
! if (!created) {
! if (!store.isDirectory()) {
! System.out.println("Tried to create the directory " + dir + " but failed");
! }
! }
}
! } else if (argv[i].equals("-zip")) {
zip_file = argv[++i];
! } else {
System.out.println("Unknown option " + argv[i]);
}
! } else {
file_name[files++] = argv[i];
}
! }
! if (files == 0) {
System.err.println("Class2HTML: No input files specified.");
! } else { // Loop through files ...
! for (int i = 0; i < files; i++) {
System.out.print("Processing " + file_name[i] + "...");
! if (zip_file == null) {
parser = new ClassParser(file_name[i]); // Create parser object from file
! } else {
parser = new ClassParser(zip_file, file_name[i]); // Create parser object from zip file
! }
java_class = parser.parse();
new Class2HTML(java_class, dir);
System.out.println("Done.");
}
}
}
/**
* Utility method that converts a class reference in the constant pool,
* i.e., an index to a string.
*/
! static String referenceClass(final int index) {
! String str = constant_pool.getConstantString(index, Const.CONSTANT_Class);
str = Utility.compactClassName(str);
str = Utility.compactClassName(str, class_package + ".", true);
! return "<A HREF=\"" + class_name + "_cp.html#cp" + index + "\" TARGET=ConstantPool>" + str
! + "</A>";
}
! static String referenceType(final String type) {
String short_type = Utility.compactClassName(type);
short_type = Utility.compactClassName(short_type, class_package + ".", true);
! final int index = type.indexOf('['); // Type is an array?
! String base_type = type;
! if (index > -1) {
! base_type = type.substring(0, index); // Tack of the `['
! }
// test for basic type
! if (basic_types.contains(base_type)) {
return "<FONT COLOR=\"#00FF00\">" + type + "</FONT>";
! }
! return "<A HREF=\"" + base_type + ".html\" TARGET=_top>" + short_type + "</A>";
}
! static String toHTML(final String str) {
! final StringBuilder buf = new StringBuilder();
! for (int i = 0; i < str.length(); i++) {
char ch;
! switch (ch = str.charAt(i)) {
! case '<':
! buf.append("<");
! break;
! case '>':
! buf.append(">");
! break;
! case '\n':
! buf.append("\\n");
! break;
! case '\r':
! buf.append("\\r");
! break;
! default:
! buf.append(ch);
}
}
return buf.toString();
}
! private void writeMainHTML(final AttributeHTML attribute_html) throws IOException {
! try (PrintWriter file = new PrintWriter(new FileOutputStream(dir + class_name + ".html"))) {
! file.println("<HTML>\n" + "<HEAD><TITLE>Documentation for " + class_name + "</TITLE>" + "</HEAD>\n"
! + "<FRAMESET BORDER=1 cols=\"30%,*\">\n" + "<FRAMESET BORDER=1 rows=\"80%,*\">\n"
! + "<FRAME NAME=\"ConstantPool\" SRC=\"" + class_name + "_cp.html" + "\"\n MARGINWIDTH=\"0\" "
! + "MARGINHEIGHT=\"0\" FRAMEBORDER=\"1\" SCROLLING=\"AUTO\">\n" + "<FRAME NAME=\"Attributes\" SRC=\""
! + class_name + "_attributes.html" + "\"\n MARGINWIDTH=\"0\" "
! + "MARGINHEIGHT=\"0\" FRAMEBORDER=\"1\" SCROLLING=\"AUTO\">\n" + "</FRAMESET>\n"
! + "<FRAMESET BORDER=1 rows=\"80%,*\">\n" + "<FRAME NAME=\"Code\" SRC=\"" + class_name
! + "_code.html\"\n MARGINWIDTH=0 " + "MARGINHEIGHT=0 FRAMEBORDER=1 SCROLLING=\"AUTO\">\n"
! + "<FRAME NAME=\"Methods\" SRC=\"" + class_name + "_methods.html\"\n MARGINWIDTH=0 "
! + "MARGINHEIGHT=0 FRAMEBORDER=1 SCROLLING=\"AUTO\">\n" + "</FRAMESET></FRAMESET></HTML>");
! }
! final Attribute[] attributes = java_class.getAttributes();
! for (int i = 0; i < attributes.length; i++) {
attribute_html.writeAttribute(attributes[i], "class" + i);
}
+ }
}
< prev index next >