blob: d6d029da64c529c527a6fbd423156fb7e208fbc9 [file] [log] [blame]
/*
* Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code 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
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.nashorn.internal.runtime;
import static jdk.nashorn.internal.lookup.Lookup.MH;
import static jdk.nashorn.internal.runtime.UnwarrantedOptimismException.isValid;
import java.lang.invoke.MethodHandle;
import jdk.internal.dynalink.linker.LinkRequest;
import jdk.nashorn.internal.codegen.ObjectClassGenerator;
import jdk.nashorn.internal.objects.Global;
/**
* This class represents the result from a find property search.
*/
public final class FindProperty {
/** Object where search began. */
private final ScriptObject self;
/** Object where search finish. */
private final ScriptObject prototype;
/** Found property. */
private final Property property;
/**
* Constructor
*
* @param self script object where search began
* @param prototype prototype where property was found, may be {@code self} if not inherited
* @param property property that was search result
*/
public FindProperty(final ScriptObject self, final ScriptObject prototype, final Property property) {
this.self = self;
this.prototype = prototype;
this.property = property;
}
/**
* Return a copy of this FindProperty with a different property.
*
* @param newProperty the new property
* @return the new FindProperty instance
*/
public FindProperty replaceProperty(final Property newProperty) {
assert this.property.getKey().equals(newProperty.getKey());
assert this.property.getSlot() == newProperty.getSlot();
return new FindProperty(self, prototype, newProperty);
}
/**
* Ask for a getter that returns the given type. The type has nothing to do with the
* internal representation of the property. It may be an Object (boxing primitives) or
* a primitive (primitive fields with -Dnashorn.fields.dual=true)
* @see ObjectClassGenerator
*
* @param type type of getter, e.g. int.class if we want a function with {@code get()I} signature
* @param programPoint program point, or INVALID_PROGRAM_POINT if pessimistic
* @param request link request
*
* @return method handle for the getter
*/
public MethodHandle getGetter(final Class<?> type, final int programPoint, final LinkRequest request) {
MethodHandle getter;
if (isValid(programPoint)) {
getter = property.getOptimisticGetter(type, programPoint);
} else {
getter = property.getGetter(type);
}
if (property instanceof UserAccessorProperty) {
getter = MH.insertArguments(getter, 1, UserAccessorProperty.getINVOKE_UA_GETTER(type, programPoint));
if (isValid(programPoint) && type.isPrimitive()) {
getter = MH.insertArguments(getter, 1, programPoint);
}
property.setType(type);
return insertAccessorsGetter((UserAccessorProperty) property, request, getter);
}
return getter;
}
/**
* Ask for a setter that sets the given type. The type has nothing to do with the
* internal representation of the property. It may be an Object (boxing primitives) or
* a primitive (primitive fields with -Dnashorn.fields.dual=true)
* @see ObjectClassGenerator
*
* @param type type of setter, e.g. int.class if we want a function with {@code set(I)V} signature
* @param strict are we in strict mode
* @param request link request
*
* @return method handle for the getter
*/
public MethodHandle getSetter(final Class<?> type, final boolean strict, final LinkRequest request) {
MethodHandle setter = property.getSetter(type, getOwner().getMap());
if (property instanceof UserAccessorProperty) {
setter = MH.insertArguments(setter, 1, UserAccessorProperty.getINVOKE_UA_SETTER(type), strict ? property.getKey() : null);
property.setType(type);
return insertAccessorsGetter((UserAccessorProperty) property, request, setter);
}
return setter;
}
// Fold an accessor getter into the method handle of a user accessor property.
private MethodHandle insertAccessorsGetter(final UserAccessorProperty uap, final LinkRequest request, final MethodHandle mh) {
MethodHandle superGetter = uap.getAccessorsGetter();
if (isInherited()) {
superGetter = ScriptObject.addProtoFilter(superGetter, getProtoChainLength());
}
if (request != null && !(request.getReceiver() instanceof ScriptObject)) {
final MethodHandle wrapFilter = Global.getPrimitiveWrapFilter(request.getReceiver());
superGetter = MH.filterArguments(superGetter, 0, wrapFilter.asType(wrapFilter.type().changeReturnType(superGetter.type().parameterType(0))));
}
superGetter = MH.asType(superGetter, superGetter.type().changeParameterType(0, Object.class));
return MH.foldArguments(mh, superGetter);
}
/**
* Return the {@code ScriptObject} owning of the property: this means the prototype.
* @return owner of property
*/
public ScriptObject getOwner() {
return prototype;
}
/**
* Return the {@code ScriptObject} where the search started. This is usually the ScriptObject the
* operation was started on, except for properties found inside a 'with' statement, where it is the
* top-level 'with' expression object.
*
* @return the start object.
*/
public ScriptObject getSelf() {
return self;
}
/**
* Return the appropriate receiver for a getter.
* @return appropriate receiver
*/
public ScriptObject getGetterReceiver() {
return property != null && property instanceof UserAccessorProperty ? self : prototype;
}
/**
* Return the appropriate receiver for a setter.
* @return appropriate receiver
*/
public ScriptObject getSetterReceiver() {
return property != null && property.hasSetterFunction(prototype) ? self : prototype;
}
/**
* Return the property that was found
* @return property
*/
public Property getProperty() {
return property;
}
/**
* Check if the property found was inherited, i.e. not directly in the self
* @return true if inherited property
*/
public boolean isInherited() {
return self != prototype;
}
/**
* Check if the property found was NOT inherited, i.e. defined in the script
* object, rather than in the prototype
* @return true if not inherited
*/
public boolean isSelf() {
return self == prototype;
}
/**
* Check if the property is in the scope
* @return true if on scope
*/
public boolean isScope() {
return prototype.isScope();
}
/**
* Get the property value from self as object.
* @return the property value
*/
public int getIntValue() {
return property.getIntValue(getGetterReceiver(), getOwner());
}
/**
* Get the property value from self as object.
* @return the property value
*/
public double getDoubleValue() {
return property.getDoubleValue(getGetterReceiver(), getOwner());
}
/**
* Get the property value from self as object.
* @return the property value
*/
public Object getObjectValue() {
return property.getObjectValue(getGetterReceiver(), getOwner());
}
/**
* Set the property value in self.
*
* @param value the new value
* @param strict strict flag
*/
public void setValue(final int value, final boolean strict) {
property.setValue(getSetterReceiver(), getOwner(), value, strict);
}
/**
* Set the property value in self.
*
* @param value the new value
* @param strict strict flag
*/
public void setValue(final double value, final boolean strict) {
property.setValue(getSetterReceiver(), getOwner(), value, strict);
}
/**
* Set the property value in self.
*
* @param value the new value
* @param strict strict flag
*/
public void setValue(final Object value, final boolean strict) {
property.setValue(getSetterReceiver(), getOwner(), value, strict);
}
/**
* Get the number of objects in the prototype chain between the {@code self} and the
* {@code owner} objects.
* @return the prototype chain length
*/
int getProtoChainLength() {
assert self != null;
int length = 0;
for (ScriptObject obj = self; obj != prototype; obj = obj.getProto()) {
assert !(obj instanceof WithObject);
++length;
}
return length;
}
@Override
public String toString() {
return "[FindProperty: " + property.getKey() + ']';
}
}