asm/xml/SAXClassAdapter.java

/***
 * ASM XML Adapter
 * Copyright (c) 2004, Eugene Kuleshov
 * 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. Neither the name of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS 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 COPYRIGHT OWNER OR 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.
 */
package org.objectweb.asm.xml;

import org.objectweb.asm.AnnotationVisitor;
import org.objectweb.asm.Attribute;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.TypeAnnotationVisitor;
import org.objectweb.asm.FieldVisitor;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;
import org.xml.sax.ContentHandler;
import org.xml.sax.helpers.AttributesImpl;

/**
 * A {@link org.objectweb.asm.ClassVisitor ClassVisitor} that generates SAX 2.0
 * events from the visited class. It can feed any kind of
 * {@link org.xml.sax.ContentHandler ContentHandler}, e.g. XML serializer, XSLT
 * or XQuery engines.
 *
 * @see org.objectweb.asm.xml.Processor
 * @see org.objectweb.asm.xml.ASMContentHandler
 *
 * @author Eugene Kuleshov
 */
public final class SAXClassAdapter extends SAXAdapter implements ClassVisitor {
    private boolean singleDocument;

    /**
     * Constructs a new {@link SAXClassAdapter SAXClassAdapter} object.
     *
     * @param h content handler that will be used to send SAX 2.0 events.
     * @param singleDocument if <tt>true</tt> adapter will not produce
     *        {@link ContentHandler#startDocument() startDocument()} and
     *        {@link ContentHandler#endDocument() endDocument()} events.
     */
    public SAXClassAdapter(ContentHandler h, boolean singleDocument) {
        super(h);
        this.singleDocument = singleDocument;
        if (!singleDocument) {
            addDocumentStart();
        }
    }

    public void visitSource(String source, String debug) {
        if (source == null && debug == null) {
            return;
        }

        AttributesImpl att = new AttributesImpl();
        if (source != null)
            att.addAttribute("", "file", "file", "", encode(source));
        if (debug != null)
            att.addAttribute("", "debug", "debug", "", encode(debug));

        addElement("source", att);
    }

    public void visitOuterClass(String owner, String name, String desc) {
        AttributesImpl att = new AttributesImpl();
        att.addAttribute("", "owner", "owner", "", owner);
        if (name != null)
            att.addAttribute("", "name", "name", "", name);
        if (desc != null)
            att.addAttribute("", "desc", "desc", "", desc);

        addElement("outerclass", att);
    }

    public final void visitAttribute(Attribute attr) {
        // TODO Auto-generated SAXClassAdapter.visitAttribute
    }

    public AnnotationVisitor visitAnnotation(String desc, boolean visible) {
        return new SAXAnnotationAdapter(getContentHandler(),
                "annotation",
                visible ? 1 : -1,
                null,
                desc);
    }

    public TypeAnnotationVisitor visitTypeAnnotation(
        String desc, boolean visible, boolean inCode) {
        throw new RuntimeException("Jaime did not implement yet");
    }

    public void visit(
        int version,
        int access,
        String name,
        String signature,
        String superName,
        String[] interfaces)
    {
        StringBuffer sb = new StringBuffer();
        if ((access & Opcodes.ACC_PUBLIC) != 0)
            sb.append("public ");
        if ((access & Opcodes.ACC_PRIVATE) != 0)
            sb.append("private ");
        if ((access & Opcodes.ACC_PROTECTED) != 0)
            sb.append("protected ");
        if ((access & Opcodes.ACC_FINAL) != 0)
            sb.append("final ");
        if ((access & Opcodes.ACC_SUPER) != 0)
            sb.append("super ");
        if ((access & Opcodes.ACC_INTERFACE) != 0)
            sb.append("interface ");
        if ((access & Opcodes.ACC_ABSTRACT) != 0)
            sb.append("abstract ");
        if ((access & Opcodes.ACC_SYNTHETIC) != 0)
            sb.append("synthetic ");
        if ((access & Opcodes.ACC_ANNOTATION) != 0)
            sb.append("annotation ");
        if ((access & Opcodes.ACC_ENUM) != 0)
            sb.append("enum ");
        if ((access & Opcodes.ACC_DEPRECATED) != 0)
            sb.append("deprecated ");

        AttributesImpl att = new AttributesImpl();
        att.addAttribute("", "access", "access", "", sb.toString());
        if (name != null)
            att.addAttribute("", "name", "name", "", name);
        if (signature != null)
            att.addAttribute("",
                    "signature",
                    "signature",
                    "",
                    encode(signature));
        if (superName != null)
            att.addAttribute("", "parent", "parent", "", superName);
        att.addAttribute("",
                "major",
                "major",
                "",
                Integer.toString(version & 0xFFFF));
        att.addAttribute("",
                "minor",
                "minor",
                "",
                Integer.toString(version >>> 16));
        addStart("class", att);

        addStart("interfaces", new AttributesImpl());
        if (interfaces != null && interfaces.length > 0) {
            for (int i = 0; i < interfaces.length; i++) {
                AttributesImpl att2 = new AttributesImpl();
                att2.addAttribute("", "name", "name", "", interfaces[i]);
                addElement("interface", att2);
            }
        }
        addEnd("interfaces");
    }

    public FieldVisitor visitField(
        int access,
        String name,
        String desc,
        String signature,
        Object value)
    {
        StringBuffer sb = new StringBuffer();
        if ((access & Opcodes.ACC_PUBLIC) != 0)
            sb.append("public ");
        if ((access & Opcodes.ACC_PRIVATE) != 0)
            sb.append("private ");
        if ((access & Opcodes.ACC_PROTECTED) != 0)
            sb.append("protected ");
        if ((access & Opcodes.ACC_STATIC) != 0)
            sb.append("static ");
        if ((access & Opcodes.ACC_FINAL) != 0)
            sb.append("final ");
        if ((access & Opcodes.ACC_VOLATILE) != 0)
            sb.append("volatile ");
        if ((access & Opcodes.ACC_TRANSIENT) != 0)
            sb.append("transient ");
        if ((access & Opcodes.ACC_SYNTHETIC) != 0)
            sb.append("synthetic ");
        if ((access & Opcodes.ACC_ENUM) != 0)
            sb.append("enum ");
        if ((access & Opcodes.ACC_DEPRECATED) != 0)
            sb.append("deprecated ");

        AttributesImpl att = new AttributesImpl();
        att.addAttribute("", "access", "access", "", sb.toString());
        att.addAttribute("", "name", "name", "", name);
        att.addAttribute("", "desc", "desc", "", desc);
        if (signature != null)
            att.addAttribute("",
                    "signature",
                    "signature",
                    "",
                    encode(signature));
        if (value != null) {
            att.addAttribute("", "value", "value", "", encode(value.toString()));
        }

        return new SAXFieldAdapter(getContentHandler(), att);
    }

    public MethodVisitor visitMethod(
        int access,
        String name,
        String desc,
        String signature,
        String[] exceptions)
    {
        StringBuffer sb = new StringBuffer();
        if ((access & Opcodes.ACC_PUBLIC) != 0)
            sb.append("public ");
        if ((access & Opcodes.ACC_PRIVATE) != 0)
            sb.append("private ");
        if ((access & Opcodes.ACC_PROTECTED) != 0)
            sb.append("protected ");
        if ((access & Opcodes.ACC_STATIC) != 0)
            sb.append("static ");
        if ((access & Opcodes.ACC_FINAL) != 0)
            sb.append("final ");
        if ((access & Opcodes.ACC_SYNCHRONIZED) != 0)
            sb.append("synchronized ");
        if ((access & Opcodes.ACC_BRIDGE) != 0)
            sb.append("bridge ");
        if ((access & Opcodes.ACC_VARARGS) != 0)
            sb.append("varargs ");
        if ((access & Opcodes.ACC_NATIVE) != 0)
            sb.append("native ");
        if ((access & Opcodes.ACC_ABSTRACT) != 0)
            sb.append("abstract ");
        if ((access & Opcodes.ACC_STRICT) != 0)
            sb.append("strict ");
        if ((access & Opcodes.ACC_SYNTHETIC) != 0)
            sb.append("synthetic ");
        if ((access & Opcodes.ACC_DEPRECATED) != 0)
            sb.append("deprecated ");

        AttributesImpl att = new AttributesImpl();
        att.addAttribute("", "access", "access", "", sb.toString());
        att.addAttribute("", "name", "name", "", name);
        att.addAttribute("", "desc", "desc", "", desc);
        if (signature != null) {
            att.addAttribute("", "signature", "signature", "", signature);
        }
        addStart("method", att);

        addStart("exceptions", new AttributesImpl());
        if (exceptions != null && exceptions.length > 0) {
            for (int i = 0; i < exceptions.length; i++) {
                AttributesImpl att2 = new AttributesImpl();
                att2.addAttribute("", "name", "name", "", exceptions[i]);
                addElement("exception", att2);
            }
        }
        addEnd("exceptions");

        return new SAXCodeAdapter(getContentHandler(), access);
    }

    public final void visitInnerClass(
        String name,
        String outerName,
        String innerName,
        int access)
    {
        StringBuffer sb = new StringBuffer();
        if ((access & Opcodes.ACC_PUBLIC) != 0)
            sb.append("public ");
        if ((access & Opcodes.ACC_PRIVATE) != 0)
            sb.append("private ");
        if ((access & Opcodes.ACC_PROTECTED) != 0)
            sb.append("protected ");
        if ((access & Opcodes.ACC_STATIC) != 0)
            sb.append("static ");
        if ((access & Opcodes.ACC_FINAL) != 0)
            sb.append("final ");
        if ((access & Opcodes.ACC_SUPER) != 0)
            sb.append("super ");
        if ((access & Opcodes.ACC_INTERFACE) != 0)
            sb.append("interface ");
        if ((access & Opcodes.ACC_ABSTRACT) != 0)
            sb.append("abstract ");
        if ((access & Opcodes.ACC_SYNTHETIC) != 0)
            sb.append("synthetic ");
        if ((access & Opcodes.ACC_ANNOTATION) != 0)
            sb.append("annotation ");
        if ((access & Opcodes.ACC_ENUM) != 0)
            sb.append("enum ");
        if ((access & Opcodes.ACC_DEPRECATED) != 0)
            sb.append("deprecated ");

        AttributesImpl att = new AttributesImpl();
        att.addAttribute("", "access", "access", "", sb.toString());
        if (name != null)
            att.addAttribute("", "name", "name", "", name);
        if (outerName != null)
            att.addAttribute("", "outerName", "outerName", "", outerName);
        if (innerName != null)
            att.addAttribute("", "innerName", "innerName", "", innerName);
        addElement("innerclass", att);
    }

    public final void visitEnd() {
        addEnd("class");
        if (!singleDocument) {
            addDocumentEnd();
        }
    }

    static final String encode(String s) {
        StringBuffer sb = new StringBuffer();
        for (int i = 0; i < s.length(); i++) {
            char c = s.charAt(i);
            if (c == '\\') {
                sb.append("\\\\");
            } else if (c < 0x20 || c > 0x7f) {
                sb.append("\\u");
                if (c < 0x10) {
                    sb.append("000");
                } else if (c < 0x100) {
                    sb.append("00");
                } else if (c < 0x1000) {
                    sb.append("0");
                }
                sb.append(Integer.toString(c, 16));
            } else {
                sb.append(c);
            }
        }
        return sb.toString();
    }

}