jaxp/src/com/sun/org/apache/bcel/internal/util/MethodHTML.java
changeset 12457 c348e06f0e82
parent 6 7f561c08de6b
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jaxp/src/com/sun/org/apache/bcel/internal/util/MethodHTML.java	Thu Apr 12 08:38:26 2012 -0700
@@ -0,0 +1,202 @@
+/*
+ * reserved comment block
+ * DO NOT REMOVE OR ALTER!
+ */
+package com.sun.org.apache.bcel.internal.util;
+
+/* ====================================================================
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2001 The Apache Software Foundation.  All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. The end-user documentation included with the redistribution,
+ *    if any, must include the following acknowledgment:
+ *       "This product includes software developed by the
+ *        Apache Software Foundation (http://www.apache.org/)."
+ *    Alternately, this acknowledgment may appear in the software itself,
+ *    if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "Apache" and "Apache Software Foundation" and
+ *    "Apache BCEL" must not be used to endorse or promote products
+ *    derived from this software without prior written permission. For
+ *    written permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache",
+ *    "Apache BCEL", nor may "Apache" appear in their name, without
+ *    prior written permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ */
+
+import com.sun.org.apache.bcel.internal.classfile.*;
+import java.io.*;
+
+/**
+ * Convert methods and fields into HTML file.
+ *
+ * @author  <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
+ *
+ */
+final class MethodHTML implements com.sun.org.apache.bcel.internal.Constants {
+  private String        class_name;     // name of current class
+  private PrintWriter   file;           // file to write to
+  private ConstantHTML  constant_html;
+  private AttributeHTML attribute_html;
+
+  MethodHTML(String dir, String class_name,
+             Method[] methods, Field[] fields,
+             ConstantHTML constant_html, AttributeHTML attribute_html) throws IOException
+  {
+    this.class_name     = class_name;
+    this.attribute_html = attribute_html;
+    this.constant_html  = constant_html;
+
+    file = new PrintWriter(new FileOutputStream(dir + class_name + "_methods.html"));
+
+    file.println("<HTML><BODY BGCOLOR=\"#C0C0C0\"><TABLE BORDER=0>");
+    file.println("<TR><TH ALIGN=LEFT>Access&nbsp;flags</TH><TH ALIGN=LEFT>Type</TH>" +
+                 "<TH ALIGN=LEFT>Field&nbsp;name</TH></TR>");
+    for(int i=0; i < fields.length; i++)
+      writeField(fields[i]);
+    file.println("</TABLE>");
+
+    file.println("<TABLE BORDER=0><TR><TH ALIGN=LEFT>Access&nbsp;flags</TH>" +
+                 "<TH ALIGN=LEFT>Return&nbsp;type</TH><TH ALIGN=LEFT>Method&nbsp;name</TH>" +
+                 "<TH ALIGN=LEFT>Arguments</TH></TR>");
+    for(int i=0; i < methods.length; i++)
+      writeMethod(methods[i], i);
+
+    file.println("</TABLE></BODY></HTML>");
+    file.close();
+  }
+
+  /**
+   * Print field of class.
+   *
+   * @param field field to print
+   * @exception java.io.IOException
+   */
+  private void writeField(Field field) throws IOException {
+    String       type   = Utility.signatureToString(field.getSignature());
+    String       name   = field.getName();
+    String       access = Utility.accessToString(field.getAccessFlags());
+    Attribute[]  attributes;
+
+    access = Utility.replace(access, " ", "&nbsp;");
+
+    file.print("<TR><TD><FONT COLOR=\"#FF0000\">" + access + "</FONT></TD>\n<TD>" +
+               Class2HTML.referenceType(type) + "</TD><TD><A NAME=\"field" + name + "\">" +
+               name + "</A></TD>");
+
+    attributes = field.getAttributes();
+
+    // Write them to the Attributes.html file with anchor "<name>[<i>]"
+    for(int i=0; i < attributes.length; i++)
+      attribute_html.writeAttribute(attributes[i], name + "@" + i);
+
+    for(int i=0; i < attributes.length; i++) {
+      if(attributes[i].getTag() == ATTR_CONSTANT_VALUE) { // Default value
+        String str = ((ConstantValue)attributes[i]).toString();
+
+        // Reference attribute in _attributes.html
+        file.print("<TD>= <A HREF=\"" + class_name + "_attributes.html#" +
+                   name + "@" + i + "\" TARGET=\"Attributes\">" + str + "</TD>\n");
+        break;
+      }
+    }
+
+    file.println("</TR>");
+  }
+
+  private final void writeMethod(Method method, int method_number) throws IOException {
+    // Get raw signature
+    String       signature      = method.getSignature();
+    // Get array of strings containing the argument types
+    String[]     args           = Utility.methodSignatureArgumentTypes(signature, false);
+    // Get return type string
+    String       type           = Utility.methodSignatureReturnType(signature, false);
+    // Get method name
+    String       name           = method.getName(), html_name;
+    // Get method's access flags
+    String       access         = Utility.accessToString(method.getAccessFlags());
+    // Get the method's attributes, the Code Attribute in particular
+    Attribute[]  attributes     = method.getAttributes();
+
+    /* HTML doesn't like names like <clinit> and spaces are places to break
+     * lines. Both we don't want...
+     */
+    access      = Utility.replace(access, " ", "&nbsp;");
+    html_name   = Class2HTML.toHTML(name);
+
+    file.print("<TR VALIGN=TOP><TD><FONT COLOR=\"#FF0000\"><A NAME=method" + method_number + ">" +
+               access + "</A></FONT></TD>");
+
+    file.print("<TD>" + Class2HTML.referenceType(type) + "</TD><TD>" +
+               "<A HREF=" + class_name + "_code.html#method" + method_number +
+               " TARGET=Code>" + html_name + "</A></TD>\n<TD>(");
+
+    for(int i=0; i < args.length; i++) {
+      file.print(Class2HTML.referenceType(args[i]));
+      if(i < args.length - 1)
+        file.print(", ");
+    }
+
+    file.print(")</TD></TR>");
+
+    // Check for thrown exceptions
+    for(int i=0; i < attributes.length; i++) {
+      attribute_html.writeAttribute(attributes[i], "method" + method_number + "@" + i,
+                                    method_number);
+
+      byte tag = attributes[i].getTag();
+      if(tag == ATTR_EXCEPTIONS) {
+        file.print("<TR VALIGN=TOP><TD COLSPAN=2></TD><TH ALIGN=LEFT>throws</TH><TD>");
+        int[] exceptions = ((ExceptionTable)attributes[i]).getExceptionIndexTable();
+
+        for(int j=0; j < exceptions.length; j++) {
+          file.print(constant_html.referenceConstant(exceptions[j]));
+
+          if(j < exceptions.length - 1)
+            file.print(", ");
+        }
+        file.println("</TD></TR>");
+      } else if(tag == ATTR_CODE) {
+        Attribute[] c_a = ((Code)attributes[i]).getAttributes();
+
+        for(int j=0; j < c_a.length; j++)
+          attribute_html.writeAttribute(c_a[j], "method" + method_number + "@" + i + "@" + j,
+                                        method_number);
+      }
+    }
+  }
+}