path: root/sources/scalac/symtab/classfile/CLRPackageParser.java

/*     ____ ____  ____ ____  ______                                     *\
**    / __// __ \/ __// __ \/ ____/    SOcos COmpiles Scala             **
**  __\_ \/ /_/ / /__/ /_/ /\_ \       (c) 2002, LAMP/EPFL              **
** /_____/\____/\___/\____/____/                                        **
\*                                                                      */

// $Id$

package scalac.symtab.classfile;

import java.util.List;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Map;
import java.util.HashMap;
import java.util.Set;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Arrays;
import java.util.Comparator;

import java.io.File;

import scala.tools.util.AbstractFile;
import scala.tools.util.ByteArrayFile;

import scalac.Global;
import scalac.CompilerCommand;
import scalac.util.Debug;
import scalac.util.Name;
import scalac.util.NameTransformer;
import scalac.symtab.Modifiers;
import scalac.symtab.Symbol;
import scalac.symtab.SymbolLoader;
import scalac.symtab.Scope;
import scalac.symtab.SymbolNameWriter;

import ch.epfl.lamp.compiler.msil.*;
/**
 */
public class CLRPackageParser {

    //##########################################################################

    private static CLRPackageParser instance;

    /** Return the unique instance of the CLRPackageParser class */
    public static CLRPackageParser instance() {
	assert instance != null;
	return instance;
    }

    /** Initialize the CLRPackageParser */
    public static void init(CompilerCommand args) {
	instance = new CLRPackageParser(args);
    }

    //##########################################################################

    public final Type BYTE;
    public final Type UBYTE;
    public final Type CHAR;
    public final Type SHORT;
    public final Type USHORT;
    public final Type INT;
    public final Type UINT;
    public final Type LONG;
    public final Type ULONG;
    public final Type FLOAT;
    public final Type DOUBLE;
    public final Type BOOLEAN;
    public final Type VOID;
    public final Type ENUM;

    public final Type OBJECT;
    public final Type STRING;
    public final Type STRING_ARRAY;

    public final Type SCALA_SYMTAB_ATTR;

    private final SymbolNameWriter snw = new SymbolNameWriter();

    private Type[] types;

    private CLRPackageParser(CompilerCommand args) {
	scala.tools.util.ClassPath.addFilesInPath(
            assemrefs, args.assemrefs.value);
	Assembly mscorlib = findAssembly("mscorlib.dll");
	Type.initMSCORLIB(mscorlib);
	findAssembly("vjslib.dll");
	findAssembly("scala.dll");

	BYTE    = getType("System.SByte");
	UBYTE   = getType("System.Byte");
	CHAR    = getType("System.Char");
	SHORT   = getType("System.Int16");
	USHORT  = getType("System.UInt16");
	INT     = getType("System.Int32");
	UINT    = getType("System.UInt32");
	LONG    = getType("System.Int64");
	ULONG   = getType("System.UInt64");
	FLOAT   = getType("System.Single");
	DOUBLE  = getType("System.Double");
	BOOLEAN = getType("System.Boolean");
	VOID    = getType("System.Void");
	ENUM    = getType("System.Enum");

	OBJECT = getType("System.Object");
	STRING = getType("System.String");
	STRING_ARRAY = getType("System.String[]");

	SCALA_SYMTAB_ATTR = Type.GetType("scala.support.SymtabAttribute");

	Type[] types = Type.EmptyTypes;
	Iterator as = assemblies.iterator();
	while (as.hasNext()) {
	    Type[] atypes = ((Assembly)as.next()).GetTypes();
	    int j = 0;
	    for (int i = 0; i < atypes.length; i++)
		// skip nested types
		if (!atypes[i].IsNotPublic() && atypes[i].DeclaringType == null)
		    atypes[j++] = atypes[i];
	    Type[] btypes = new Type[types.length + j];
	    System.arraycopy(types, 0, btypes, 0, types.length);
	    System.arraycopy(atypes, 0, btypes, types.length, j);
	    types = btypes;
	}
	 Comparator typeNameComparator = new Comparator() {
		 public int compare(Object o1, Object o2) {
		     Type t1 = (Type)o1;
		     Type t2 = (Type)o2;
		     return t1.FullName.compareTo(t2.FullName);
		 }
	     };

	Arrays.sort(types, typeNameComparator);
	this.types = types;
    }

    //##########################################################################

    private java.util.Map syms2members = new HashMap();
    private java.util.Map members2syms = new HashMap();

    public Type[] getTypes() { return types; }

    public void map(Symbol sym, MemberInfo m) {
	syms2members.put(sym, m);
	members2syms.put(m, sym);
    }

    public MemberInfo getMember(Symbol sym) {
	return (MemberInfo)syms2members.get(sym);
    }

    public Symbol getSymbol(MemberInfo m) {
	return (Symbol)members2syms.get(m);
    }

    public Type getType(String name) {
	Type t = Type.GetType(name);
	//assert t != null : name;
	return t;
    }

    public Type mkArrayType(Type elemType) {
	return getType(elemType.FullName + "[]");
    }

    //##########################################################################
    // assembly loading methods

    // a list of all loaded assemblies
    protected final java.util.List assemblies = new LinkedList();

    // a set of all directories and assembly files
    protected final Set/*<File>*/ assemrefs = new LinkedHashSet();

    /** Load the assembly with the given name
     */
    private Assembly findAssembly(String name) {
	// see if the assembly is referenced directly
	for (Iterator assems = assemrefs.iterator(); assems.hasNext();) {
	    File file = (File)assems.next();
	    if (!file.getName().equals(name))
		continue;
	    Assembly assem = Assembly.LoadFrom(file.getPath());
	    if (assem != null) {
		assems.remove();
		assemblies.add(assem);
		return assem;
	    }
	}
	// look in directories specified with the '-r' option
	for (Iterator assems = assemrefs.iterator(); assems.hasNext();) {
	    File d = (File)assems.next();
	    if (!d.isDirectory())
		continue;
	    File file = new File(d, name);
	    if (file.exists()) {
		Assembly assem = Assembly.LoadFrom(file.getPath());
		if (assem != null) {
		    assemblies.add(assem);
		    return assem;
		}
	    }
	}
	// try in the current directory
	File file = new File(".", name);
	if (file.exists()) {
	    Assembly assem = Assembly.LoadFrom(file.getPath());
	    if (assem != null) {
		assemblies.add(assem);
		return assem;
	    }
	}
	System.err.println("Cannot find assembly " + name
			   + "; use the -r option to specify its location");
	throw Debug.abort();
    }

    /** Load the rest of the assemblies specified with the '-r' option
     */
    private void findAllAssemblies() {
	for (Iterator assems = assemrefs.iterator(); assems.hasNext();) {
	    File f = (File)assems.next();
	    if (f.isFile()) {
		Assembly assem = Assembly.LoadFrom(f.getPath());
		if (assem != null) {
		    assemblies.add(assem);
		}
	    }
	    assems.remove();
	}
	assert assemrefs.isEmpty();
    }

    //##########################################################################
    // collect the members contained in a given namespace

    private Symbol pakage;
    private HashMap/*<String,Type>*/ typesMap;
    private Set/*<String>*/ namespacesSet;

    private static final String[] BANNED = new String[] {
	"scala.AnyVal", "scala.Array", "scala.Boolean", "scala.Byte",
	"scala.Char", "scala.Double", "scala.Float", "scala.Function0",
	"scala.Function1", "scala.Function2", "scala.Function3",
	"scala.Function4", "scala.Function5", "scala.Function6",
	"scala.Function7", "scala.Function8", "scala.Function9", "scala.Int",
	"scala.Long", "scala.MatchError", "scala.Ref", "scala.ScalaObject",
	"scala.Short", "scala.Type", "scala.Unit", "scala.runtime.NativeLoop",
	"scala.runtime.ResultOrException", "scala.runtime.RunTime",
	"java.lang.Object", "java.lang.String", "java.lang.CharSequence",
	"java.lang.StringBuffer", "java.lang.Byte", "java.lang.Float",
	"java.lang.Double", "java.lang.Cloneable"
    };
    private static final Set BANNED_TYPES = new HashSet();
    static {
	for (int i = 0; i < BANNED.length; i++) {
	    BANNED_TYPES.add(BANNED[i]);
	}
    }

    /** Find the position of the first type whose name starts with
     *  the given prefix; return the length of the types array if no match
     *  is found so the result can be used to terminate loop conditions
     */
    private int findFirst(String prefix) {
	int m = 0, n = types.length - 1;
	while (m < n) {
	    int l = (m + n) / 2;
	    int res = types[l].FullName.compareTo(prefix);
	    if (res < 0) m = l + 1;
	    else n = l;
	}
	return types[m].FullName.startsWith(prefix) ? m : types.length;
    }

    /** Collects the members contained in the given Scala package (namespace)
     */
    private void enumerateMembers(Symbol pakage) {
	if (this.pakage == pakage)
	    return;
	this.pakage = pakage;
	typesMap = new HashMap();
	namespacesSet = new LinkedHashSet();

	String namespace = pakage.isRoot() ? "" : snw.toString(pakage) + ".";
	int nl = namespace.length();
	for (int i = findFirst(namespace);
	     i < types.length && types[i].FullName.startsWith(namespace);
	     i++)
	{
	    Type type = types[i];
	    if (BANNED_TYPES.contains(type.FullName)) {
		//System.out.println("Skipping CLR type " + type);
		continue;
	    }
	    int k = type.FullName.indexOf(".", nl);
	    if (k < 0) {
		typesMap.put(type.Name, type);
	    } else {
		namespacesSet.add(type.Namespace.substring(nl, k));
	    }
	}
    }

    /** return a mapping from type names to types contained
     *  in the given Scala package (namespace)
     */
    HashMap getTypes(Symbol pakage) {
	enumerateMembers(pakage);
	return typesMap;
    }

    /** Returns a set of the namespaces contained
     *  in the given Scala package (namespace)
     */
    Set getNamespaces(Symbol pakage) {
	enumerateMembers(pakage);
	return namespacesSet;
    }

    boolean shouldLoadClassfile(Symbol pakage, String name) {
	String fullname = snw.toString(pakage) + "." + name;
	return BANNED_TYPES.contains(fullname);
    }

    /** Imports a CLR type in a scala package (only called from PackageParser)
     */
    void importType(Type type, Symbol pakage, Scope members) {
	// discard top level types
	if (type.Namespace.equals("")) {
	    return;
	}

	assert snw.toString(pakage).equals(type.Namespace)
	    : Debug.show(pakage) + " << " + type.FullName;
	Object[] symtab_attr=type.GetCustomAttributes(SCALA_SYMTAB_ATTR, false);
	AbstractFile symtab = null;
	for (int l = 0; l < symtab_attr.length; l++) {
	    MemberInfo.Attribute a = (MemberInfo.Attribute)symtab_attr[l];
	    if (a.GetType() == SCALA_SYMTAB_ATTR) {
		symtab = new ByteArrayFile
		    (type.FullName, type.Assembly.GetName().toString(),
		     a.getValue());
		break;
	    }
	}
	SymbolLoader loader = symtab == null ? completer()
	    : new SymblParser(Global.instance, symtab);

	Name classname = Name.fromString(type.Name).toTypeName();
	Symbol clazz =
	    pakage.newLoadedClass(Modifiers.JAVA, classname, loader, members);
	Type moduleType = getType(type.FullName + "$");
	map(clazz, type);
// 	map(clazz, moduleType != null ? moduleType : type);
    }

    private CLRClassParser completer;
    private CLRClassParser completer() {
	if (completer == null)
	    completer = new CLRClassParser(Global.instance, this);
	return completer;
    }


    //##########################################################################
} // CLRPackageParser