source: trunk/abcl/src/org/armedbear/lisp/JavaClassLoader.java

/*
 * JavaClassLoader.java
 *
 * Copyright (C) 2003-2005 Peter Graves
 * $Id: JavaClassLoader.java 15439 2020-10-29 16:54:32Z mevenson $
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * As a special exception, the copyright holders of this library give you
 * permission to link this library with independent modules to produce an
 * executable, regardless of the license terms of these independent
 * modules, and to copy and distribute the resulting executable under
 * terms of your choice, provided that you also meet, for each linked
 * independent module, the terms and conditions of the license of that
 * module.  An independent module is a module which is not derived from
 * or based on this library.  If you modify this library, you may extend
 * this exception to your version of the library, but you are not
 * obligated to do so.  If you do not wish to do so, delete this
 * exception statement from your version.
 */

package org.armedbear.lisp;

import static org.armedbear.lisp.Lisp.*;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.io.DataInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.net.URLClassLoader;

public class JavaClassLoader extends URLClassLoader {

    private static JavaClassLoader persistentInstance;

    public static boolean checkPreCompiledClassLoader = true;
    
    public Class<?> loadClass(String name) throws ClassNotFoundException {
        if (checkPreCompiledClassLoader) {
            Class<?> c = findPrecompiledClassOrNull(name);
            if (c != null) {
                return c;                       
            }
        }
        return loadClass(name, false);
    }
    
    /**
     * Returns a class loaded by the system or bootstrap class loader;
     * or return null if not found.
     * 
     * On AOT systems like GCJ and IKVM this means a class implemented in ASM or CLR
     * 
     * like findLoadedClass it does not throw an exception if a class is not found
     */
    public Class<?> findPrecompiledClassOrNull(String name) {
        ClassLoader ourCL = JavaClassLoader.class.getClassLoader();
        while (ourCL != null) {
            try {
                return Class.forName(name, true, ourCL);
            } catch (ClassNotFoundException cnf) {
            }
            ourCL = ourCL.getParent();
        }
        try {
            return findSystemClass(name);
        } catch (ClassNotFoundException e) {
            return null;
        }
    }
    
    public byte[] getFunctionClassBytes(String name) {
        Pathname pathname 
          = (Pathname)Pathname.create(name.substring("org/armedbear/lisp/".length()) 
                    + "." + Lisp._COMPILE_FILE_CLASS_EXTENSION_.symbolValue().getStringValue());
        return readFunctionBytes(pathname);
    }

    public byte[] getFunctionClassBytes(Class<?> functionClass) {
        String className = functionClass.getName();
        try {
            String ext = Lisp._COMPILE_FILE_CLASS_EXTENSION_.symbolValue().getStringValue();
            InputStream is = getResourceAsStream(className.replace('.', '/') + "." + ext);
            if (is != null) {
                byte[] imgDataBa = new byte[(int) is.available()];
                DataInputStream dataIs = new DataInputStream(is);
                dataIs.readFully(imgDataBa);
                return imgDataBa;
            }
        } catch (IOException e) {
        }
        return getFunctionClassBytes(className);
    }

    final public byte[] getFunctionClassBytes(Function f) {
        byte[] b = getFunctionClassBytes(f.getClass());
        f.setClassBytes(b);
        return b;
    }

    private static Set<String> packages = Collections.synchronizedSet(new HashSet<String>());

    public JavaClassLoader()
    {
        this(JavaClassLoader.class.getClassLoader());
    }

    public JavaClassLoader(ClassLoader parent) {
        super(new URL[] {}, parent);
    }
    
    public JavaClassLoader(JavaClassLoader parent) {
        super(new URL[] {}, (ClassLoader)parent);
    }

    public JavaClassLoader(URL[] classpath, ClassLoader parent) {
        super(classpath, parent);
    }

    public static JavaClassLoader getPersistentInstance()
    {
        return getPersistentInstance(null);
    }

    public static JavaClassLoader getPersistentInstance(String packageName)
    {
        if (persistentInstance == null)
            persistentInstance = new JavaClassLoader();
        definePackage(packageName);
        return persistentInstance;
    }

    private static void definePackage(String packageName)
    {
        if (packageName != null && !packages.contains(packageName)) {
            persistentInstance.definePackage(packageName,"","1.0","","","1.0","",null);
            packages.add(packageName);
        }
    }

    public Class<?> loadClassFromByteArray(byte[] classbytes) {
        return loadClassFromByteArray(null, classbytes);
    }

    public Class<?> loadClassFromByteArray(String className,
                                                byte[] classbytes)
    {
        try {
            long length = classbytes.length; 
            if (length < Integer.MAX_VALUE) {
                Class<?> c =
                    defineLispClass(className, classbytes, 0, (int) length);
                if (c != null) {
                    resolveClass(c);
                    return c;
                }
            }
        }
        catch (LinkageError e) {
                throw e;
        }
        catch (Throwable t) {
            Debug.trace(t);
        }
        return null;
    }

    protected final Class<?> defineLispClass(String name, byte[] b, int off, int len)
                throws ClassFormatError {        
        ///if (checkPreCompiledClassLoader) Debug.trace("DEFINE JAVA CLASS " + name + " " + len);
        return defineClass(name, b, off, len);
    }
    
    public Class<?> loadClassFromByteArray(String className, byte[] bytes,
                                                int offset, int length)
    {
        try {
            Class<?> c = defineLispClass(className, bytes, offset, length);
            if (c != null) {
                resolveClass(c);
                return c;
            }
        }
        catch (VerifyError e)
          {
            error(new LispError("Class verification failed: " + e.getMessage()));
          }
        catch (Throwable t) {
            Debug.trace(t);
        }
        return null;
    }

    @Override
    public void addURL(URL url) {
        super.addURL(url);
    }

    public static final Symbol CLASSLOADER = PACKAGE_JAVA.intern("*CLASSLOADER*");

    private static final Primitive GET_DEFAULT_CLASSLOADER = new pf_get_default_classloader();
    private static final class pf_get_default_classloader extends Primitive {
        
        private final LispObject defaultClassLoader = new JavaObject(new JavaClassLoader());

        pf_get_default_classloader() {
            super("get-default-classloader", PACKAGE_JAVA, true, "");
        }

        @Override
        public LispObject execute() {
            return defaultClassLoader;
        }
    };

    // ### make-classloader &optional parent => java-class-loader
    private static final Primitive MAKE_CLASSLOADER = new pf_make_classloader();
    private static final class pf_make_classloader extends Primitive 
    {
        pf_make_classloader() 
        {
            super("make-classloader", PACKAGE_JAVA, true, "&optional parent");
        }

        @Override
        public LispObject execute() {
            return new JavaObject(new JavaClassLoader(getCurrentClassLoader()));
        }

        @Override
        public LispObject execute(LispObject parent) {
            return new JavaObject(new JavaClassLoader((ClassLoader) parent.javaInstance(ClassLoader.class)));
        }
    };

    // ### dump-classpath &optional classloader => list-of-pathname-lists
    private static final Primitive DUMP_CLASSPATH = new pf_dump_classpath();
    private static final class pf_dump_classpath extends Primitive 
    {
        pf_dump_classpath() 
        {
            super("dump-classpath", PACKAGE_JAVA, true, "&optional classloader");
        }

        @Override
        public LispObject execute() {
            return execute(new JavaObject(getCurrentClassLoader()));
        }

        @Override
        public LispObject execute(LispObject classloader) {
            LispObject list = NIL;
            Object o = classloader.javaInstance();
            while(o instanceof ClassLoader) {
                ClassLoader cl = (ClassLoader) o;
                list = list.push(dumpClassPath(cl));
                o = cl.getParent();
            }
            return list.nreverse();
        }
    };

    private static final Primitive GET_CURRENT_CLASSLOADER = new pf_get_current_classloader();
    @DocString(name="get-current-classloader")
    private static final class pf_get_current_classloader extends Primitive {
        pf_get_current_classloader() {
            super("get-current-classloader", PACKAGE_JAVA, true);
        }
        @Override 
        public LispObject execute() {
            return new JavaObject(getCurrentClassLoader());
        }
    };
        
    // ### %add-to-classpath jar-or-jars &optional (classloader (get-current-classloader))
    private static final Primitive ADD_TO_CLASSPATH = new pf_add_to_classpath();
    private static final class pf_add_to_classpath extends Primitive 
    {
        pf_add_to_classpath() 
        {
            super("%add-to-classpath", PACKAGE_JAVA, false, 
                  "jar-or-jars &optional (classloader (get-current-classloader))");
        }

        @Override
        public LispObject execute(LispObject jarOrJars) {
            return execute(jarOrJars, new JavaObject(getCurrentClassLoader()));
        }

        @Override
        public LispObject execute(LispObject jarOrJars, LispObject classloader) {
            Object o = classloader.javaInstance();
            if(o instanceof JavaClassLoader) {
                JavaClassLoader jcl = (JavaClassLoader) o;
                if(jarOrJars instanceof Cons) {
                    while(jarOrJars != NIL) {
                        addURL(jcl, jarOrJars.car());
                        jarOrJars = jarOrJars.cdr();
                    }
                } else {
                    addURL(jcl, jarOrJars);
                }
                return T;
            } else {
                return error(new TypeError(o + " must be an instance of " + JavaClassLoader.class.getName()));
            }
        }
    };

    protected static void addURL(JavaClassLoader jcl, LispObject jar) {
      URLPathname urlPathname = null;
      if (jar instanceof URLPathname) {
        urlPathname = (URLPathname)jar;
      } else if (jar instanceof Pathname) {
        urlPathname = URLPathname.createFromFile((Pathname)jar);
      } else if (jar instanceof AbstractString) {
        String namestring = jar.getStringValue();
        if (!Pathname.isValidURL(namestring)) {
          Pathname p = Pathname.create(namestring);
          if (p != null) {
            urlPathname = URLPathname.create(p);
          }
        } else {
          urlPathname = URLPathname.create(namestring);
        }
      }
      if (urlPathname == null) {
        error(new TypeError(jar + " must be a pathname designator"));
      }
      jcl.addURL(urlPathname.toURL());
    }


    public static LispObject dumpClassPath(ClassLoader o) {
        if(o instanceof URLClassLoader) {
            LispObject list = NIL;
            for(URL u : ((URLClassLoader) o).getURLs()) {
                list = list.push(URLPathname.create(u));
            }
            return new Cons(new JavaObject(o), list.nreverse());
        } else {
            return new JavaObject(o);
        }
    }

    public static ClassLoader getCurrentClassLoader() {
        LispObject classLoader = CLASSLOADER.symbolValueNoThrow();
        if(classLoader != null) {
            return (ClassLoader) classLoader.javaInstance(ClassLoader.class);
        } else {
            return Lisp.class.getClassLoader();
        }
    }



}