src/jdk/internal/dynalink/linker/LinkerServices.java

Thu, 14 Feb 2013 13:22:26 +0100

author
attila
date
Thu, 14 Feb 2013 13:22:26 +0100
changeset 90
5a820fb11814
child 101
f8221ce53c2e
permissions
-rw-r--r--

8008085: Integrate Dynalink source code into Nashorn codebase
Reviewed-by: jlaskey, lagergren, sundar

attila@90 1 /*
attila@90 2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
attila@90 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
attila@90 4 *
attila@90 5 * This code is free software; you can redistribute it and/or modify it
attila@90 6 * under the terms of the GNU General Public License version 2 only, as
attila@90 7 * published by the Free Software Foundation. Oracle designates this
attila@90 8 * particular file as subject to the "Classpath" exception as provided
attila@90 9 * by Oracle in the LICENSE file that accompanied this code.
attila@90 10 *
attila@90 11 * This code is distributed in the hope that it will be useful, but WITHOUT
attila@90 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
attila@90 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
attila@90 14 * version 2 for more details (a copy is included in the LICENSE file that
attila@90 15 * accompanied this code).
attila@90 16 *
attila@90 17 * You should have received a copy of the GNU General Public License version
attila@90 18 * 2 along with this work; if not, write to the Free Software Foundation,
attila@90 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
attila@90 20 *
attila@90 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
attila@90 22 * or visit www.oracle.com if you need additional information or have any
attila@90 23 * questions.
attila@90 24 */
attila@90 25
attila@90 26 /*
attila@90 27 * This file is available under and governed by the GNU General Public
attila@90 28 * License version 2 only, as published by the Free Software Foundation.
attila@90 29 * However, the following notice accompanied the original version of this
attila@90 30 * file, and Oracle licenses the original version of this file under the BSD
attila@90 31 * license:
attila@90 32 */
attila@90 33 /*
attila@90 34 Copyright 2009-2013 Attila Szegedi
attila@90 35
attila@90 36 Licensed under both the Apache License, Version 2.0 (the "Apache License")
attila@90 37 and the BSD License (the "BSD License"), with licensee being free to
attila@90 38 choose either of the two at their discretion.
attila@90 39
attila@90 40 You may not use this file except in compliance with either the Apache
attila@90 41 License or the BSD License.
attila@90 42
attila@90 43 If you choose to use this file in compliance with the Apache License, the
attila@90 44 following notice applies to you:
attila@90 45
attila@90 46 You may obtain a copy of the Apache License at
attila@90 47
attila@90 48 http://www.apache.org/licenses/LICENSE-2.0
attila@90 49
attila@90 50 Unless required by applicable law or agreed to in writing, software
attila@90 51 distributed under the License is distributed on an "AS IS" BASIS,
attila@90 52 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
attila@90 53 implied. See the License for the specific language governing
attila@90 54 permissions and limitations under the License.
attila@90 55
attila@90 56 If you choose to use this file in compliance with the BSD License, the
attila@90 57 following notice applies to you:
attila@90 58
attila@90 59 Redistribution and use in source and binary forms, with or without
attila@90 60 modification, are permitted provided that the following conditions are
attila@90 61 met:
attila@90 62 * Redistributions of source code must retain the above copyright
attila@90 63 notice, this list of conditions and the following disclaimer.
attila@90 64 * Redistributions in binary form must reproduce the above copyright
attila@90 65 notice, this list of conditions and the following disclaimer in the
attila@90 66 documentation and/or other materials provided with the distribution.
attila@90 67 * Neither the name of the copyright holder nor the names of
attila@90 68 contributors may be used to endorse or promote products derived from
attila@90 69 this software without specific prior written permission.
attila@90 70
attila@90 71 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
attila@90 72 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
attila@90 73 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
attila@90 74 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
attila@90 75 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
attila@90 76 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
attila@90 77 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
attila@90 78 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
attila@90 79 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
attila@90 80 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
attila@90 81 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
attila@90 82 */
attila@90 83
attila@90 84 package jdk.internal.dynalink.linker;
attila@90 85
attila@90 86 import java.lang.invoke.MethodHandle;
attila@90 87 import java.lang.invoke.MethodHandles;
attila@90 88 import java.lang.invoke.MethodType;
attila@90 89 import jdk.internal.dynalink.DynamicLinker;
attila@90 90 import jdk.internal.dynalink.linker.ConversionComparator.Comparison;
attila@90 91
attila@90 92
attila@90 93 /**
attila@90 94 * Interface for services provided to {@link GuardingDynamicLinker} instances by the {@link DynamicLinker} that owns
attila@90 95 * them. You can think of it as the interface of the {@link DynamicLinker} that faces the {@link GuardingDynamicLinker}
attila@90 96 * s.
attila@90 97 *
attila@90 98 * @author Attila Szegedi
attila@90 99 */
attila@90 100 public interface LinkerServices {
attila@90 101 /**
attila@90 102 * Similar to {@link MethodHandle#asType(MethodType)} except it also hooks in method handles produced by
attila@90 103 * {@link GuardingTypeConverterFactory} implementations, providing for language-specific type coercing of
attila@90 104 * parameters. It will apply {@link MethodHandle#asType(MethodType)} for all primitive-to-primitive,
attila@90 105 * wrapper-to-primitive, primitive-to-wrapper conversions as well as for all upcasts. For all other conversions,
attila@90 106 * it'll insert {@link MethodHandles#filterArguments(MethodHandle, int, MethodHandle...)} with composite filters
attila@90 107 * provided by {@link GuardingTypeConverterFactory} implementations. It doesn't use language-specific conversions on
attila@90 108 * the return type.
attila@90 109 *
attila@90 110 * @param handle target method handle
attila@90 111 * @param fromType the types of source arguments
attila@90 112 * @return a method handle that is a suitable combination of {@link MethodHandle#asType(MethodType)} and
attila@90 113 * {@link MethodHandles#filterArguments(MethodHandle, int, MethodHandle...)} with
attila@90 114 * {@link GuardingTypeConverterFactory} produced type converters as filters.
attila@90 115 */
attila@90 116 public MethodHandle asType(MethodHandle handle, MethodType fromType);
attila@90 117
attila@90 118 /**
attila@90 119 * Given a source and target type, returns a method handle that converts between them. Never returns null; in worst
attila@90 120 * case it will return an identity conversion (that might fail for some values at runtime). You rarely need to use
attila@90 121 * this method directly; you should mostly rely on {@link #asType(MethodHandle, MethodType)} instead. You really
attila@90 122 * only need this method if you have a piece of your program that is written in Java, and you need to reuse existing
attila@90 123 * type conversion machinery in a non-invokedynamic context.
attila@90 124 * @param sourceType the type to convert from
attila@90 125 * @param targetType the type to convert to
attila@90 126 * @return a method handle performing the conversion.
attila@90 127 */
attila@90 128 public MethodHandle getTypeConverter(Class<?> sourceType, Class<?> targetType);
attila@90 129
attila@90 130 /**
attila@90 131 * Returns true if there might exist a conversion between the requested types (either an automatic JVM conversion,
attila@90 132 * or one provided by any available {@link GuardingTypeConverterFactory}), or false if there definitely does not
attila@90 133 * exist a conversion between the requested types. Note that returning true does not guarantee that the conversion
attila@90 134 * will succeed at runtime (notably, if the "from" or "to" types are sufficiently generic), but returning false
attila@90 135 * guarantees that it would fail.
attila@90 136 *
attila@90 137 * @param from the source type for the conversion
attila@90 138 * @param to the target type for the conversion
attila@90 139 * @return true if there can be a conversion, false if there can not.
attila@90 140 */
attila@90 141 public boolean canConvert(Class<?> from, Class<?> to);
attila@90 142
attila@90 143 /**
attila@90 144 * Creates a guarded invocation using the {@link DynamicLinker} that exposes this linker services interface. Linkers
attila@90 145 * can typically use them to delegate linking of wrapped objects.
attila@90 146 *
attila@90 147 * @param linkRequest a request for linking the invocation
attila@90 148 * @return a guarded invocation linked by the top-level linker (or any of its delegates). Can be null if no
attila@90 149 * available linker is able to link the invocation.
attila@90 150 * @throws Exception in case the top-level linker throws an exception
attila@90 151 */
attila@90 152 public GuardedInvocation getGuardedInvocation(LinkRequest linkRequest) throws Exception;
attila@90 153
attila@90 154 /**
attila@90 155 * Determines which of the two type conversions from a source type to the two target types is preferred. This is
attila@90 156 * used for dynamic overloaded method resolution. If the source type is convertible to exactly one target type with
attila@90 157 * a method invocation conversion, it is chosen, otherwise available {@link ConversionComparator}s are consulted.
attila@90 158 * @param sourceType the source type.
attila@90 159 * @param targetType1 one potential target type
attila@90 160 * @param targetType2 another potential target type.
attila@90 161 * @return one of Comparison constants that establish which - if any - of the target types is preferable for the
attila@90 162 * conversion.
attila@90 163 */
attila@90 164 public Comparison compareConversion(Class<?> sourceType, Class<?> targetType1, Class<?> targetType2);
attila@90 165 }

mercurial