com.sun.org.apache.bcel.internal.util.MethodHTML Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jaxp-ri Show documentation
Java API for XML Processing Reference Implementation
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

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 [email protected].
 *
 * 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
 * .
 */

import com.sun.org.apache.bcel.internal.classfile.*;
import java.io.*;

/**
 * Convert methods and fields into HTML file.
 *
 * @version $Id: MethodHTML.java,v 1.3 2007-07-19 04:34:52 ofung Exp $
 * @author  M. Dahm
 * 
 */
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("");
    file.println("" +
		 "");
    for(int i=0; i < fields.length; i++)
      writeField(fields[i]);
    file.println("Access flags Type Field name");
    
    file.println("" +
		 "" +
		 "");
    for(int i=0; i < methods.length; i++)
      writeMethod(methods[i], i);
    
    file.println("Access flags Return type Method name Arguments
");
    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, " ", " ");

    file.print("" + access + "\n" +
	       Class2HTML.referenceType(type) + "" +
	       name + "");
					
    attributes = field.getAttributes();

    // Write them to the Attributes.html file with anchor "[]"
    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("= " + str + "\n");
	break;
      }
    }
	
    file.println("");
  }

  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  and spaces are places to break
     * lines. Both we don't want...
     */
    access 	= Utility.replace(access, " ", " ");
    html_name 	= Class2HTML.toHTML(name);

    file.print("" +
	       access + "");

    file.print("" + Class2HTML.referenceType(type) + "" +
	       "" + html_name + "\n(");

    for(int i=0; i < args.length; i++) {
      file.print(Class2HTML.referenceType(args[i]));
      if(i < args.length - 1)
	file.print(", ");
    }

    file.print(")");

    // 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("throws");
	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("");
      } 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); 
      }
    }
  }
}