Pk.java :  » Development » RetroGuard » COM » rl » obf » Java Open Source

/* ===========================================================================
 * $RCSfile: Pk.java,v $
 * ===========================================================================
 *
 * RetroGuard -- an obfuscation package for Java classfiles.
 *
 * Copyright (c) 1998-2006 Mark Welsh (markw@retrologic.com)
 *
 * This program can be redistributed and/or modified under the terms of the 
 * Version 2 of the GNU General Public License as published by the Free 
 * Software Foundation.
 *
 * This program 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 for more details.
 *
 */

package COM.rl.obf;

import java.io.*;
import java.lang.reflect.*;
import java.util.*;
import COM.rl.util.*;
import COM.rl.obf.classfile.*;

/**
 * Tree item representing a package.
 *
 * @author      Mark Welsh
 */
public class Pk extends PkCl
{
    // Constants -------------------------------------------------------------


    // Fields ----------------------------------------------------------------
    private Hashtable pks = new Hashtable(); // Owns a list of sub-package levels
    private String repackageName = null;     // Compact name for this package


    // Class Methods ---------------------------------------------------------
    /** Create the root entry for a tree. */
    public static Pk createRoot(ClassTree classTree) 
    {
        return new Pk(classTree);
    }


    // Instance Methods ------------------------------------------------------
    /** Constructor for default package level. */
    public Pk(ClassTree classTree)
    {
        this(null, "");
        this.classTree = classTree;
    }

    /** Constructor for regular package levels. */
    public Pk(TreeItem parent, String name)
    {
        super(parent, name);
        if (parent == null && !name.equals(""))
        {
            System.err.println("Internal error: only the default package has no parent");
        }
        else if (parent != null && name.equals(""))
        {
            System.err.println("Internal error: the default package cannot have a parent");
        }
    }

    /** Set the repackage name of the entry. */
    public void setRepackageName(String repackageName) 
    {
        this.repackageName = repackageName;
    }

    /** Return the repackage name of the entry. */
    public String getRepackageName() { return this.repackageName; }

    /** Get a package level by name. */
    public Pk getPackage(String name) throws Exception 
    {
        return (Pk)pks.get(name);
    }

    /** Get a package level by obfuscated name. */
    public Pk getObfPackage(String name) throws Exception 
    {
  for (Enumeration enm = pks.elements(); enm.hasMoreElements(); )
  {
      Pk pk = (Pk)enm.nextElement();
      if (name.equals(pk.getOutName())) 
      {
    return pk;
      }
  }
        return null;
    }

    /** Get a package level by obfuscated repackage name. */
    public Pk getObfRepackage(String name) throws Exception 
    {
  for (Enumeration enm = pks.elements(); enm.hasMoreElements(); )
  {
      Pk pk = (Pk)enm.nextElement();
      if (name.equals(pk.getRepackageName())) 
      {
    return pk;
      }
            Pk sub = pk.getObfRepackage(name);
            if (sub != null) 
            {
                return sub;
            }
  }
        return null;
    }

    /** Get an Enumeration of packages. */
    public Enumeration getPackageEnum() throws Exception 
    {
        return pks.elements();
    }

    /** Return number of packages. */
    public int getPackageCount() {return pks.size();}

    /** Add a sub-package level. */
    public Pk addPackage(String name) throws Exception
    {
        Pk pk = getPackage(name);
        if (pk == null)
        {
            pk = new Pk(this, name);
            pks.put(name, pk);
        }
        return pk;
    }

    /** Add a class. */
    public Cl addClass(String name, String superName, String[] interfaceNames, int access) throws Exception
    {
        return addClass(false, name, superName, interfaceNames, access);
    }

    /** Add a placeholder class. */
    public Cl addPlaceholderClass(String name) throws Exception
    {
        return addPlaceholderClass(false, name);
    }

    /** Generate unique obfuscated names for this namespace. */
    public void generateNames() throws Exception
    {
        super.generateNames();
        generateNames(pks);
    }

    /** Generate unique-across-run obfuscated repackage name. */
    public void repackageName(NameMaker nm) throws Exception
    {
        if (!isFixed())
        {
            setRepackageName(nm.nextName(null));
            setOutName(getInName());
        }
    }

    /** Construct and return the full obfuscated name of the entry. */
    public String getFullOutName()
    {
        if (getRepackageName() == null)
        {
            return super.getFullOutName();
        }
        else
        {
            return getRepackageName();
        }
    }
}