jdk/src/share/classes/java/lang/Compiler.java
author duke
Sat, 01 Dec 2007 00:00:00 +0000
changeset 2 90ce3da70b43
child 51 6fe31bc95bbc
permissions -rw-r--r--
Initial load
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1995-2006 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.lang;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * The {@code Compiler} class is provided to support Java-to-native-code
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * compilers and related services. By design, the {@code Compiler} class does
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * nothing; it serves as a placeholder for a JIT compiler implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * <p> When the Java Virtual Machine first starts, it determines if the system
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * property {@code java.compiler} exists. (System properties are accessible
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * through {@link System#getProperty(String)} and {@link
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * System#getProperty(String, String)}.  If so, it is assumed to be the name of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * a library (with a platform-dependent exact location and type); {@link
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * System#loadLibrary} is called to load that library. If this loading
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * succeeds, the function named {@code java_lang_Compiler_start()} in that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * library is called.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * <p> If no compiler is available, these methods do nothing.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * @author  Frank Yellin
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * @since   JDK1.0
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
public final class Compiler  {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    private Compiler() {}               // don't make instances
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    private static native void initialize();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    private static native void registerNatives();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
    static {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
        registerNatives();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
        java.security.AccessController.doPrivileged
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
            (new java.security.PrivilegedAction() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
                public Object run() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
                    boolean loaded = false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
                    String jit = System.getProperty("java.compiler");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
                    if ((jit != null) && (!jit.equals("NONE")) &&
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
                        (!jit.equals("")))
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
                    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
                        try {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
                            System.loadLibrary(jit);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
                            initialize();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
                            loaded = true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
                        } catch (UnsatisfiedLinkError e) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
                            System.err.println("Warning: JIT compiler \"" +
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
                              jit + "\" not found. Will use interpreter.");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
                        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
                    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
                    String info = System.getProperty("java.vm.info");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
                    if (loaded) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
                        System.setProperty("java.vm.info", info + ", " + jit);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
                    } else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
                        System.setProperty("java.vm.info", info + ", nojit");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
                    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
                    return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
                }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
            });
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     * Compiles the specified class.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * @param  clazz
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     *         A class
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
     * @return  {@code true} if the compilation succeeded; {@code false} if the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
     *          compilation failed or no compiler is available
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     * @throws  NullPointerException
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
     *          If {@code clazz} is {@code null}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
    public static native boolean compileClass(Class<?> clazz);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     * Compiles all classes whose name matches the specified string.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
     * @param  string
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
     *         The name of the classes to compile
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     * @return  {@code true} if the compilation succeeded; {@code false} if the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     *          compilation failed or no compiler is available
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
     * @throws  NullPointerException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     *          If {@code string} is {@code null}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
    public static native boolean compileClasses(String string);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
     * Examines the argument type and its fields and perform some documented
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
     * operation.  No specific operations are required.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
     * @param  any
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
     *         An argument
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
     * @return  A compiler-specific value, or {@code null} if no compiler is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
     *          available
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
     * @throws  NullPointerException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
     *          If {@code any} is {@code null}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
    public static native Object command(Object any);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
     * Cause the Compiler to resume operation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
    public static native void enable();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
     * Cause the Compiler to cease operation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
    public static native void disable();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
}