/*

 * 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.java.util.jar.pack;

import java.lang.reflect.Modifier;

import java.util.*;

import java.util.zip.*;

import java.util.jar.*;

import java.io.*;

import com.sun.java.util.jar.pack.ConstantPool.*;

/**

 * Define the main data structure transmitted by pack/unpack.

 * @author John Rose

 */

class Package implements Constants {

    int verbose;

    {

        PropMap pmap = Utils.currentPropMap();

        if (pmap != null)

            verbose = pmap.getInteger(Utils.DEBUG_VERBOSE);

    }

    int magic;

    int package_minver;

    int package_majver;

    int default_modtime = NO_MODTIME;

    int default_options = 0;  // FO_DEFLATE_HINT

    short default_class_majver = -1; // fill in later

    short default_class_minver = 0;  // fill in later

    // These fields can be adjusted by driver properties.

    short min_class_majver = JAVA_MIN_CLASS_MAJOR_VERSION;

    short min_class_minver = JAVA_MIN_CLASS_MINOR_VERSION;

    short observed_max_class_majver = min_class_majver;

    short observed_max_class_minver = min_class_minver;

    // What constants are used in this unit?

    ConstantPool.IndexGroup cp = new ConstantPool.IndexGroup();

    Package() {

        magic          = JAVA_PACKAGE_MAGIC;

        package_minver = -1;  // fill in later

        package_majver = 0;   // fill in later

    }

    public

    void reset() {

        cp = new ConstantPool.IndexGroup();

        classes.clear();

        files.clear();

    }

    int getPackageVersion() {

        return (package_majver << 16) + (int)package_minver;

    }

    // Special empty versions of Code and InnerClasses, used for markers.

    public static final Attribute.Layout attrCodeEmpty;

    public static final Attribute.Layout attrInnerClassesEmpty;

    public static final Attribute.Layout attrSourceFileSpecial;

    public static final Map attrDefs;

    static {

        HashMap ad = new HashMap(2);

        attrCodeEmpty = Attribute.define(ad, ATTR_CONTEXT_METHOD,

                                         "Code", "").layout();

        attrInnerClassesEmpty = Attribute.define(ad, ATTR_CONTEXT_CLASS,

                                                 "InnerClasses", "").layout();

        attrSourceFileSpecial = Attribute.define(ad, ATTR_CONTEXT_CLASS,

                                                 "SourceFile", "RUNH").layout();

        attrDefs = Collections.unmodifiableMap(ad);

    }

    int getDefaultClassVersion() {

        return (default_class_majver << 16) + (char)default_class_minver;

    }

    /** Return the highest version number of all classes,

     *  or 0 if there are no classes.

     */

    int getHighestClassVersion() {

        int res = 0;  // initial low value

        for (Iterator i = classes.iterator(); i.hasNext(); ) {

            Class cls = (Class) i.next();

            int ver = cls.getVersion();

            if (res < ver)  res = ver;

        }

        return res;

    }

    /** Convenience function to choose an archive version based

     *  on the class file versions observed within the archive.

     */

    void choosePackageVersion() {

        assert(package_majver <= 0);  // do not call this twice

        int classver = getHighestClassVersion();

            package_majver = JAVA5_PACKAGE_MAJOR_VERSION;

            package_minver = JAVA5_PACKAGE_MINOR_VERSION;

        } else {

            package_majver = JAVA6_PACKAGE_MAJOR_VERSION;

            package_minver = JAVA6_PACKAGE_MINOR_VERSION;

        }

    }

    // What Java classes are in this unit?

    // Fixed 6211177, converted to throw IOException

    void checkVersion() throws IOException {

        if (magic != JAVA_PACKAGE_MAGIC) {

            String gotMag = Integer.toHexString(magic);

            String expMag = Integer.toHexString(JAVA_PACKAGE_MAGIC);

            throw new IOException("Unexpected package magic number: got "+gotMag+"; expected "+expMag);

        }

        if ((package_majver != JAVA6_PACKAGE_MAJOR_VERSION  &&

             package_majver != JAVA5_PACKAGE_MAJOR_VERSION) ||

             (package_minver != JAVA6_PACKAGE_MINOR_VERSION &&

             package_minver != JAVA5_PACKAGE_MINOR_VERSION)) {

            String gotVer = package_majver+"."+package_minver;

            String expVer = JAVA6_PACKAGE_MAJOR_VERSION+"."+JAVA6_PACKAGE_MINOR_VERSION+

                            " OR "+

                            JAVA5_PACKAGE_MAJOR_VERSION+"."+JAVA5_PACKAGE_MINOR_VERSION;

            throw new IOException("Unexpected package minor version: got "+gotVer+"; expected "+expVer);

        }

    }

    ArrayList classes = new ArrayList();

    public List getClasses() {

        return classes;

    }

    public

    class Class extends Attribute.Holder implements Comparable {

        public Package getPackage() { return Package.this; }

        // Optional file characteristics and data source (a "class stub")

        File file;

        // File header

        int magic;

        short minver, majver;

        // Local constant pool (one-way mapping of index => package cp).

        Entry[] cpMap;

        // Class header

        //int flags;  // in Attribute.Holder.this.flags

        ClassEntry thisClass;

        ClassEntry superClass;

        ClassEntry[] interfaces;

        // Class parts

        ArrayList fields;

        ArrayList methods;

        //ArrayList attributes;  // in Attribute.Holder.this.attributes

        // Note that InnerClasses may be collected at the package level.

        ArrayList innerClasses;

        Class(int flags, ClassEntry thisClass, ClassEntry superClass, ClassEntry[] interfaces) {

            this.magic      = JAVA_MAGIC;

            this.minver     = default_class_minver;

            this.majver     = default_class_majver;

            this.flags      = flags;

            this.thisClass  = thisClass;

            this.superClass = superClass;

            this.interfaces = interfaces;

            boolean added = classes.add(this);

            assert(added);

        }

        Class(String classFile) {

            // A blank class; must be read with a ClassReader, etc.

            initFile(newStub(classFile));

        }

        List getFields() { return fields == null ? noFields : fields; }

        List getMethods() { return methods == null ? noMethods : methods; }

        public String getName() {

            return thisClass.stringValue();

        }

        int getVersion() {

            return (majver << 16) + (char)minver;

        }

        String getVersionString() {

            return versionStringOf(majver, minver);

        }

        // Note:  equals and hashCode are identity-based.

        public int compareTo(Object o) {

            Class that = (Class)o;

            String n0 = this.getName();

            String n1 = that.getName();

            return n0.compareTo(n1);

        }

        String getObviousSourceFile() {

            return Package.getObviousSourceFile(getName());

        }

        private void transformSourceFile(boolean minimize) {

            // Replace "obvious" SourceFile by null.

            Attribute olda = getAttribute(attrSourceFileSpecial);

            if (olda == null)

                return;  // no SourceFile attr.

            String obvious = getObviousSourceFile();

            ArrayList ref = new ArrayList(1);

            olda.visitRefs(this, VRM_PACKAGE, ref);

            Utf8Entry sfName = (Utf8Entry) ref.get(0);

            Attribute a = olda;

            if (sfName == null) {

                if (minimize) {

                    // A pair of zero bytes.  Cannot use predef. layout.

                    a = Attribute.find(ATTR_CONTEXT_CLASS, "SourceFile", "H");

                    a = a.addContent(new byte[2]);

                } else {

                    // Expand null attribute to the obvious string.

                    byte[] bytes = new byte[2];

                    sfName = getRefString(obvious);

                    Object f = null;

                    f = Fixups.add(f, bytes, 0, Fixups.U2_FORMAT, sfName);

                    a = attrSourceFileSpecial.addContent(bytes, f);

                }

            } else if (obvious.equals(sfName.stringValue())) {

                if (minimize) {

                    // Replace by an all-zero attribute.

                    a = attrSourceFileSpecial.addContent(new byte[2]);

                } else {

                    assert(false);

                }

            }

            if (a != olda) {

                if (verbose > 2)

                    Utils.log.fine("recoding obvious SourceFile="+obvious);

                List newAttrs = new ArrayList(getAttributes());

                int where = newAttrs.indexOf(olda);

                newAttrs.set(where, a);

                setAttributes(newAttrs);

            }

        }

        void minimizeSourceFile() {

            transformSourceFile(true);

        }

        void expandSourceFile() {

            transformSourceFile(false);

        }

        protected Entry[] getCPMap() {

            return cpMap;

        }

        protected void setCPMap(Entry[] cpMap) {

            this.cpMap = cpMap;

        }

        boolean hasInnerClasses() {

            return innerClasses != null;

        }

        List getInnerClasses() {

            return innerClasses;

        }

        public void setInnerClasses(Collection ics) {

            innerClasses = (ics == null) ? null : new ArrayList(ics);

            // Edit the attribute list, if necessary.

            Attribute a = getAttribute(attrInnerClassesEmpty);

            if (innerClasses != null && a == null)

                addAttribute(attrInnerClassesEmpty.canonicalInstance());

            else if (innerClasses == null && a != null)

                removeAttribute(a);

        }

        /** Given a global map of ICs (keyed by thisClass),

         *  compute the subset of its Map.values which are

         *  required to be present in the local InnerClasses

         *  attribute.  Perform this calculation without

         *  reference to any actual InnerClasses attribute.

         *  <p>

         *  The order of the resulting list is consistent

         *  with that of Package.this.allInnerClasses.

         */

        public List computeGloballyImpliedICs() {

            HashSet cpRefs = new HashSet();

            {   // This block temporarily displaces this.innerClasses.

                ArrayList innerClassesSaved = innerClasses;

                innerClasses = null;  // ignore for the moment

                visitRefs(VRM_CLASSIC, cpRefs);

                innerClasses = innerClassesSaved;

            }

            ConstantPool.completeReferencesIn(cpRefs, true);

            HashSet icRefs = new HashSet();

            for (Iterator i = cpRefs.iterator(); i.hasNext(); ) {

                Entry e = (Entry) i.next();

                // Restrict cpRefs to InnerClasses entries only.

                if (!(e instanceof ClassEntry))  continue;

                // For every IC reference, add its outers also.

                while (e != null) {

                    InnerClass ic = getGlobalInnerClass(e);

                    if (ic == null)  break;

                    if (!icRefs.add(e))  break;

                    e = ic.outerClass;

                    // If we add A$B$C to the mix, we must also add A$B.

                }

            }

            // This loop is structured this way so as to accumulate

            // entries into impliedICs in an order which reflects

            // the order of allInnerClasses.

            ArrayList impliedICs = new ArrayList();

            for (Iterator i = allInnerClasses.iterator(); i.hasNext(); ) {

                InnerClass ic = (InnerClass) i.next();

                // This one is locally relevant if it describes

                // a member of the current class, or if the current

                // class uses it somehow.  In the particular case

                // where thisClass is an inner class, it will already

                // be a member of icRefs.

                if (icRefs.contains(ic.thisClass)

                    || ic.outerClass == this.thisClass) {

                    // Add every relevant class to the IC attribute:

                    if (verbose > 1)

                        Utils.log.fine("Relevant IC: "+ic);

                    impliedICs.add(ic);

                }

            }

            return impliedICs;

        }

        // Helper for both minimizing and expanding.

        // Computes a symmetric difference.

        private List computeICdiff() {

            List impliedICs = computeGloballyImpliedICs();

            List actualICs  = getInnerClasses();

            if (actualICs == null)  actualICs = Collections.EMPTY_LIST;

            // Symmetric difference is calculated from I, A like this:

            //  diff = (I+A) - (I*A)

            // Note that the center C is unordered, but the result

            // preserves the original ordering of I and A.

            //

            // Class file rules require that outers precede inners.

            // So, add I before A, in case A$B$Z is local, but A$B

            // is implicit.  The reverse is never the case.

            if (actualICs.isEmpty()) {

                return impliedICs;

                // Diff is I since A is empty.

            }

            if (impliedICs.isEmpty()) {

                return actualICs;

                // Diff is A since I is empty.

            }

            // (I*A) is non-trivial

            HashSet center = new HashSet(actualICs);

            center.retainAll(new HashSet(impliedICs));

            impliedICs.addAll(actualICs);

            impliedICs.removeAll(center);

            // Diff is now I^A = (I+A)-(I*A).

            return impliedICs;

        }

        /** When packing, anticipate the effect of expandLocalICs.

         *  Replace the local ICs by their symmetric difference

         *  with the globally implied ICs for this class; if this

         *  difference is empty, remove the local ICs altogether.

         *  <p>

         *  An empty local IC attribute is reserved to signal

         *  the unpacker to delete the attribute altogether,

         *  so a missing local IC attribute signals the unpacker

         *  to use the globally implied ICs changed.

         */

        void minimizeLocalICs() {

            List diff = computeICdiff();

            List actualICs = innerClasses;

            List localICs;  // will be the diff, modulo edge cases

            if (diff.isEmpty()) {

                // No diff, so transmit no attribute.

                localICs = null;

                if (actualICs != null && actualICs.isEmpty()) {

                    // Odd case:  No implied ICs, and a zero length attr.

                    // Do not support it directly.

                    if (verbose > 0)

                        Utils.log.info("Warning: Dropping empty InnerClasses attribute from "+this);

                }

            } else if (actualICs == null) {

                // No local IC attribute, even though some are implied.

                // Signal with trivial attribute.

                localICs = Collections.EMPTY_LIST;

            } else {

                // Transmit a non-empty diff, which will create

                // a local ICs attribute.

                localICs = diff;

            }

            // Reduce the set to the symmetric difference.

            setInnerClasses(localICs);

            if (verbose > 1 && localICs != null)

                Utils.log.fine("keeping local ICs in "+this+": "+localICs);

        }

        /** When unpacking, undo the effect of minimizeLocalICs.

         *  Must return negative if any IC tuples may have been deleted.

         *  Otherwise, return positive if any IC tuples were added.

         */

        int expandLocalICs() {

            List localICs = innerClasses;

            List actualICs;

            int changed;

            if (localICs == null) {

                // Diff was empty.  (Common case.)

                List impliedICs = computeGloballyImpliedICs();

                if (impliedICs.isEmpty()) {

                    actualICs = null;

                    changed = 0;

                } else {

                    actualICs = impliedICs;

                    changed = 1;  // added more tuples

                }

            } else if (localICs.isEmpty()) {

                // It was a non-empty diff, but the local ICs were absent.

                actualICs = null;

                changed = 0;  // [] => null, no tuple change

            } else {

                // Non-trivial diff was transmitted.

                actualICs = computeICdiff();

                // If we only added more ICs, return +1.

                changed = actualICs.containsAll(localICs)? +1: -1;

            }

            setInnerClasses(actualICs);

            return changed;

        }

        public abstract

        class Member extends Attribute.Holder implements Comparable {

            DescriptorEntry descriptor;

            protected Member(int flags, DescriptorEntry descriptor) {

                this.flags = flags;

                this.descriptor = descriptor;

            }

            public Class thisClass() { return Class.this; }

            public DescriptorEntry getDescriptor() {

                return descriptor;

            }

            public String getName() {

                return descriptor.nameRef.stringValue();

            }

            public String getType() {

                return descriptor.typeRef.stringValue();

            }

            protected Entry[] getCPMap() {

                return cpMap;

            }

            protected void visitRefs(int mode, Collection refs) {

                if (verbose > 2)  Utils.log.fine("visitRefs "+this);

                // Careful:  The descriptor is used by the package,

                // but the classfile breaks it into component refs.

                if (mode == VRM_CLASSIC) {

                    refs.add(descriptor.nameRef);

                    refs.add(descriptor.typeRef);

                } else {

                    refs.add(descriptor);

                }

                // Handle attribute list:

                super.visitRefs(mode, refs);

            }

            public String toString() {

                return Class.this + "." + descriptor.prettyString();

            }

        }

        public

        class Field extends Member {

            // Order is significant for fields:  It is visible to reflection.

            int order;

            public Field(int flags, DescriptorEntry descriptor) {

                super(flags, descriptor);

                assert(!descriptor.isMethod());

                if (fields == null)

                    fields = new ArrayList();

                boolean added = fields.add(this);

                assert(added);

                order = fields.size();

            }