/*

 * Copyright (c) 2007, 2008, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.tools.javap;

import java.net.URI;

import java.text.DateFormat;

import java.util.Collection;

import java.util.Date;

import java.util.List;

import com.sun.tools.classfile.AccessFlags;

import com.sun.tools.classfile.Attribute;

import com.sun.tools.classfile.Attributes;

import com.sun.tools.classfile.ClassFile;

import com.sun.tools.classfile.Code_attribute;

import com.sun.tools.classfile.ConstantPool;

import com.sun.tools.classfile.ConstantPoolException;

import com.sun.tools.classfile.ConstantValue_attribute;

import com.sun.tools.classfile.Descriptor;

import com.sun.tools.classfile.DescriptorException;

import com.sun.tools.classfile.Exceptions_attribute;

import com.sun.tools.classfile.Field;

import com.sun.tools.classfile.Method;

import com.sun.tools.classfile.Signature;

import com.sun.tools.classfile.Signature_attribute;

import com.sun.tools.classfile.SourceFile_attribute;

import com.sun.tools.classfile.Type;

import static com.sun.tools.classfile.AccessFlags.*;

/*

 *  The main javap class to write the contents of a class file as text.

 *

 *  This code and its internal interfaces are subject to change or

 *  deletion without notice.</b>

 */

public class ClassWriter extends BasicWriter {

    static ClassWriter instance(Context context) {

        ClassWriter instance = context.get(ClassWriter.class);

        if (instance == null)

            instance = new ClassWriter(context);

        return instance;

    }

    protected ClassWriter(Context context) {

        super(context);

        context.put(ClassWriter.class, this);

        options = Options.instance(context);

        attrWriter = AttributeWriter.instance(context);

        codeWriter = CodeWriter.instance(context);

        constantWriter = ConstantWriter.instance(context);

    }

    void setDigest(String name, byte[] digest) {

        this.digestName = name;

        this.digest = digest;

    }

    void setFile(URI uri) {

        this.uri = uri;

    }

    void setFileSize(int size) {

        this.size = size;

    }

    void setLastModified(long lastModified) {

        this.lastModified = lastModified;

    }

    protected ClassFile getClassFile() {

        return classFile;

    }

    protected void setClassFile(ClassFile cf) {

        classFile = cf;

        constant_pool = classFile.constant_pool;

    }

    protected Method getMethod() {

        return method;

    }

    protected void setMethod(Method m) {

        method = m;

    }

    public void write(ClassFile cf) {

        setClassFile(cf);

        if ((options.sysInfo || options.verbose) && !options.compat) {

            if (uri != null) {

                if (uri.getScheme().equals("file"))

                    println("Classfile " + uri.getPath());

                else

                    println("Classfile " + uri);

            }

            indent(+1);

            if (lastModified != -1) {

                Date lm = new Date(lastModified);

                DateFormat df = DateFormat.getDateInstance();

                if (size > 0) {

                    println("Last modified " + df.format(lm) + "; size " + size + " bytes");

                } else {

                    println("Last modified " + df.format(lm));

                }

            } else if (size > 0) {

                println("Size " + size + " bytes");

            }

            if (digestName != null && digest != null) {

                StringBuilder sb = new StringBuilder();

                for (byte b: digest)

                    sb.append(String.format("%02x", b));

                println(digestName + " checksum " + sb);

            }

        }

        Attribute sfa = cf.getAttribute(Attribute.SourceFile);

        if (sfa instanceof SourceFile_attribute) {

            println("Compiled from \"" + getSourceFile((SourceFile_attribute) sfa) + "\"");

        }

        if ((options.sysInfo || options.verbose) && !options.compat) {

            indent(-1);

        }

        String name = getJavaName(classFile);

        AccessFlags flags = cf.access_flags;

        writeModifiers(flags.getClassModifiers());

        if (classFile.isClass())

            print("class ");

        else if (classFile.isInterface())

            print("interface ");

        print(name);

        Signature_attribute sigAttr = getSignature(cf.attributes);

        if (sigAttr == null) {

            // use info from class file header

            if (classFile.isClass() && classFile.super_class != 0 ) {

                String sn = getJavaSuperclassName(cf);

                print(" extends ");

                print(sn);

            }

            for (int i = 0; i < classFile.interfaces.length; i++) {

                print(i == 0 ? (classFile.isClass() ? " implements " : " extends ") : ",");

                print(getJavaInterfaceName(classFile, i));

            }

        } else {

            try {

                Type t = sigAttr.getParsedSignature().getType(constant_pool);

                // The signature parser cannot disambiguate between a

                // FieldType and a ClassSignatureType that only contains a superclass type.

                if (t instanceof Type.ClassSigType)

                    print(getJavaName(t.toString()));

                else {

                    print(" extends ");

                    print(getJavaName(t.toString()));

                }

            } catch (ConstantPoolException e) {

                print(report(e));

            }

        }

        if (options.verbose) {

            println();

            indent(+1);

            attrWriter.write(cf, cf.attributes, constant_pool);

            println("minor version: " + cf.minor_version);

            println("major version: " + cf.major_version);

            if (!options.compat)

              writeList("flags: ", flags.getClassFlags(), NEWLINE);

            indent(-1);

            constantWriter.writeConstantPool();

        } else {

            print(" ");

        }

        println("{");

        indent(+1);

        writeFields();

        writeMethods();

        indent(-1);

        println("}");

    }

    protected void writeFields() {

        for (Field f: classFile.fields) {

            writeField(f);

        }

    }

    protected void writeField(Field f) {

        if (!options.checkAccess(f.access_flags))

            return;

        AccessFlags flags = f.access_flags;

        writeModifiers(flags.getFieldModifiers());

        Signature_attribute sigAttr = getSignature(f.attributes);

        if (sigAttr == null)

            print(getJavaFieldType(f.descriptor));

        else {

            try {

                Type t = sigAttr.getParsedSignature().getType(constant_pool);

                print(getJavaName(t.toString()));

            } catch (ConstantPoolException e) {

                // report error?

                // fall back on non-generic descriptor

                print(getJavaFieldType(f.descriptor));

            }

        }

        print(" ");

        print(getFieldName(f));

        if (options.showConstants && !options.compat) { // BUG 4111861 print static final field contents

            Attribute a = f.attributes.get(Attribute.ConstantValue);

            if (a instanceof ConstantValue_attribute) {

                print(" = ");

                ConstantValue_attribute cv = (ConstantValue_attribute) a;

                print(getConstantValue(f.descriptor, cv.constantvalue_index));

            }

        }

        print(";");

        println();

        indent(+1);

        if (options.showInternalSignatures)

            println("Signature: " + getValue(f.descriptor));

        if (options.verbose && !options.compat)

            writeList("flags: ", flags.getFieldFlags(), NEWLINE);

        if (options.showAllAttrs) {

            for (Attribute attr: f.attributes)

                attrWriter.write(f, attr, constant_pool);

            println();

        }

        indent(-1);

        if (options.showDisassembled || options.showLineAndLocalVariableTables)

            println();

    }

    protected void writeMethods() {

        for (Method m: classFile.methods)

            writeMethod(m);

        setPendingNewline(false);

    }

    protected void writeMethod(Method m) {

        if (!options.checkAccess(m.access_flags))

            return;

        method = m;

        AccessFlags flags = m.access_flags;

        Descriptor d;

        Type.MethodType methodType;

        List<? extends Type> methodExceptions;

        Signature_attribute sigAttr = getSignature(m.attributes);

        if (sigAttr == null) {

            d = m.descriptor;

            methodType = null;

            methodExceptions = null;

        } else {

            Signature methodSig = sigAttr.getParsedSignature();

            d = methodSig;

            try {

                methodType = (Type.MethodType) methodSig.getType(constant_pool);

                methodExceptions = methodType.throwsTypes;

                if (methodExceptions != null && methodExceptions.size() == 0)

                    methodExceptions = null;

            } catch (ConstantPoolException e) {

                // report error?

                // fall back on standard descriptor

                methodType = null;

                methodExceptions = null;

            }

        }

        writeModifiers(flags.getMethodModifiers());

        if (methodType != null) {

            writeListIfNotEmpty("<", methodType.typeParamTypes, "> ");

        }

        if (getName(m).equals("<init>")) {

            print(getJavaName(classFile));

            print(getJavaParameterTypes(d, flags));

        } else if (getName(m).equals("<clinit>")) {

            print("{}");

        } else {

            print(getJavaReturnType(d));

            print(" ");

            print(getName(m));

            print(getJavaParameterTypes(d, flags));

        }

        Attribute e_attr = m.attributes.get(Attribute.Exceptions);

        if (e_attr != null) { // if there are generic exceptions, there must be erased exceptions

            if (e_attr instanceof Exceptions_attribute) {

                Exceptions_attribute exceptions = (Exceptions_attribute) e_attr;

                print(" throws ");

                if (methodExceptions != null) { // use generic list if available

                    writeList("", methodExceptions, "");

                } else {

                    for (int i = 0; i < exceptions.number_of_exceptions; i++) {

                        if (i > 0)

                            print(", ");

                        print(getJavaException(exceptions, i));

                    }

                }

            } else {

                report("Unexpected or invalid value for Exceptions attribute");

            }

        }

        println(";");

        indent(+1);

        if (options.showInternalSignatures) {

            println("Signature: " + getValue(m.descriptor));

        }

        if (options.verbose && !options.compat) {

            writeList("flags: ", flags.getMethodFlags(), NEWLINE);

        }

        Code_attribute code = null;

        Attribute c_attr = m.attributes.get(Attribute.Code);

        if (c_attr != null) {

            if (c_attr instanceof Code_attribute)

                code = (Code_attribute) c_attr;

            else

                report("Unexpected or invalid value for Code attribute");

        }

        if (options.showDisassembled && !options.showAllAttrs) {

            if (code != null) {

                println("Code:");

                codeWriter.writeInstrs(code);

                codeWriter.writeExceptionTable(code);

            }

        }

        if (options.showLineAndLocalVariableTables) {

            if (code != null) {

                attrWriter.write(code, code.attributes.get(Attribute.LineNumberTable), constant_pool);

                attrWriter.write(code, code.attributes.get(Attribute.LocalVariableTable), constant_pool);

            }

        }

        if (options.showAllAttrs) {

            Attribute[] attrs = m.attributes.attrs;

            for (Attribute attr: attrs)

                attrWriter.write(m, attr, constant_pool);

        }

        indent(-1);

        // set pendingNewline to write a newline before the next method (if any)

        // if a separator is desired

        setPendingNewline(

                options.showDisassembled ||

                options.showAllAttrs ||

                options.showInternalSignatures ||

                options.showLineAndLocalVariableTables ||

                options.verbose);

    }

    void writeModifiers(Collection<String> items) {

        for (Object item: items) {

            print(item);

            print(" ");

        }

    }

    void writeList(String prefix, Collection<?> items, String suffix) {

        print(prefix);

        String sep = "";

        for (Object item: items) {

            print(sep);

            print(item);

            sep = ", ";

        }

        print(suffix);

    }

    void writeListIfNotEmpty(String prefix, List<?> items, String suffix) {

        if (items != null && items.size() > 0)

            writeList(prefix, items, suffix);

    }

    Signature_attribute getSignature(Attributes attributes) {

        if (options.compat) // javap does not recognize recent attributes

            return null;

        return (Signature_attribute) attributes.get(Attribute.Signature);

    }

    String adjustVarargs(AccessFlags flags, String params) {

        if (flags.is(ACC_VARARGS) && !options.compat) {

            int i = params.lastIndexOf("[]");

            if (i > 0)

                return params.substring(0, i) + "..." + params.substring(i+2);

        }

        return params;

    }

    String getJavaName(ClassFile cf) {

        try {

            return getJavaName(cf.getName());

        } catch (ConstantPoolException e) {

            return report(e);

        }

    }

    String getJavaSuperclassName(ClassFile cf) {

        try {

            return getJavaName(cf.getSuperclassName());

        } catch (ConstantPoolException e) {

            return report(e);

        }

    }

    String getJavaInterfaceName(ClassFile cf, int index) {

        try {

            return getJavaName(cf.getInterfaceName(index));

        } catch (ConstantPoolException e) {

            return report(e);

        }

    }

    String getJavaFieldType(Descriptor d) {

        try {

            return getJavaName(d.getFieldType(constant_pool));

        } catch (ConstantPoolException e) {

            return report(e);

        } catch (DescriptorException e) {

            return report(e);

        }

    }

    String getJavaReturnType(Descriptor d) {

        try {

            return getJavaName(d.getReturnType(constant_pool));

        } catch (ConstantPoolException e) {

            return report(e);

        } catch (DescriptorException e) {

            return report(e);

        }

    }

    String getJavaParameterTypes(Descriptor d, AccessFlags flags) {

        try {

            return getJavaName(adjustVarargs(flags, d.getParameterTypes(constant_pool)));

        } catch (ConstantPoolException e) {

            return report(e);

        } catch (DescriptorException e) {

            return report(e);

        }

    }

    String getJavaException(Exceptions_attribute attr, int index) {

        try {

            return getJavaName(attr.getException(index, constant_pool));

        } catch (ConstantPoolException e) {

            return report(e);

        }

    }

    String getValue(Descriptor d) {

        try {

            return d.getValue(constant_pool);

        } catch (ConstantPoolException e) {

            return report(e);

        }

    }

    String getFieldName(Field f) {

        try {

            return f.getName(constant_pool);