From 186d1357f08e969349e899e6667dd3caa5c96430 Mon Sep 17 00:00:00 2001 From: Stefan Marr Date: Wed, 20 Jan 2016 16:36:39 +0100 Subject: [PATCH 1/4] Consistently name ObjectType parameter objectType The opertions name looks like a historical artifact. Signed-off-by: Stefan Marr --- .../src/com/oracle/truffle/api/object/Layout.java | 6 +++--- .../src/com/oracle/truffle/object/basic/BasicLayout.java | 4 ++-- .../src/com/oracle/truffle/object/basic/ShapeBasic.java | 4 ++-- .../src/com/oracle/truffle/object/LayoutImpl.java | 8 ++++---- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Layout.java b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Layout.java index cbaccbf128e2..8f7387b68da6 100644 --- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Layout.java +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Layout.java @@ -65,11 +65,11 @@ public static Layout createLayout() { public abstract Class getType(); - public abstract Shape createShape(ObjectType operations); + public abstract Shape createShape(ObjectType objectType); - public abstract Shape createShape(ObjectType operations, Object sharedData); + public abstract Shape createShape(ObjectType objectType, Object sharedData); - public abstract Shape createShape(ObjectType operations, Object sharedData, int id); + public abstract Shape createShape(ObjectType objectType, Object sharedData, int id); /** * Create an allocator for static property creation. Reserves all array extension slots. diff --git a/truffle/com.oracle.truffle.object.basic/src/com/oracle/truffle/object/basic/BasicLayout.java b/truffle/com.oracle.truffle.object.basic/src/com/oracle/truffle/object/basic/BasicLayout.java index 5256a480f49d..c3b354654083 100644 --- a/truffle/com.oracle.truffle.object.basic/src/com/oracle/truffle/object/basic/BasicLayout.java +++ b/truffle/com.oracle.truffle.object.basic/src/com/oracle/truffle/object/basic/BasicLayout.java @@ -62,8 +62,8 @@ public DynamicObject newInstance(Shape shape) { } @Override - public Shape createShape(ObjectType operations, Object sharedData, int id) { - return new ShapeBasic(this, sharedData, operations, id); + public Shape createShape(ObjectType objectType, Object sharedData, int id) { + return new ShapeBasic(this, sharedData, objectType, id); } @Override diff --git a/truffle/com.oracle.truffle.object.basic/src/com/oracle/truffle/object/basic/ShapeBasic.java b/truffle/com.oracle.truffle.object.basic/src/com/oracle/truffle/object/basic/ShapeBasic.java index ba9662d24bda..30386ec267e8 100644 --- a/truffle/com.oracle.truffle.object.basic/src/com/oracle/truffle/object/basic/ShapeBasic.java +++ b/truffle/com.oracle.truffle.object.basic/src/com/oracle/truffle/object/basic/ShapeBasic.java @@ -29,8 +29,8 @@ import com.oracle.truffle.object.Transition; public final class ShapeBasic extends ShapeImpl { - public ShapeBasic(Layout layout, Object sharedData, ObjectType operations, int id) { - super(layout, operations, sharedData, id); + public ShapeBasic(Layout layout, Object sharedData, ObjectType objectType, int id) { + super(layout, objectType, sharedData, id); } public ShapeBasic(Layout layout, Object sharedData, ShapeImpl parent, ObjectType objectType, PropertyMap propertyMap, Transition transition, Allocator allocator, int id) { diff --git a/truffle/com.oracle.truffle.object/src/com/oracle/truffle/object/LayoutImpl.java b/truffle/com.oracle.truffle.object/src/com/oracle/truffle/object/LayoutImpl.java index c004bdf02c7b..330cc132c329 100644 --- a/truffle/com.oracle.truffle.object/src/com/oracle/truffle/object/LayoutImpl.java +++ b/truffle/com.oracle.truffle.object/src/com/oracle/truffle/object/LayoutImpl.java @@ -68,13 +68,13 @@ public Class getType() { } @Override - public final Shape createShape(ObjectType operations, Object sharedData) { - return createShape(operations, sharedData, 0); + public final Shape createShape(ObjectType objectType, Object sharedData) { + return createShape(objectType, sharedData, 0); } @Override - public final Shape createShape(ObjectType operations) { - return createShape(operations, null); + public final Shape createShape(ObjectType objectType) { + return createShape(objectType, null); } public boolean isAllowedIntToDouble() { From f23c539f18039e0df4e43412e2c243503249c106 Mon Sep 17 00:00:00 2001 From: Stefan Marr Date: Wed, 20 Jan 2016 16:36:59 +0100 Subject: [PATCH 2/4] Added comments to Layout.createShape(...) Signed-off-by: Stefan Marr --- .../com/oracle/truffle/api/object/Layout.java | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Layout.java b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Layout.java index 8f7387b68da6..ed292a06e06b 100644 --- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Layout.java +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Layout.java @@ -65,10 +65,29 @@ public static Layout createLayout() { public abstract Class getType(); + /** + * Create a root shape. + * + * @param objectType that describes the object instance with this shape. + */ public abstract Shape createShape(ObjectType objectType); + /** + * Create a root shape. + * + * @param objectType that describes the object instance with this shape. + * @param sharedData for language-specific use + */ public abstract Shape createShape(ObjectType objectType, Object sharedData); + /** + * Create a root shape. + * + * @param objectType that describes the object instance with this shape. + * @param sharedData for language-specific use + * @param id for language-specific use + * @return + */ public abstract Shape createShape(ObjectType objectType, Object sharedData, int id); /** From 8cc9be7cd0349bbfef01aebc99b72aed77250109 Mon Sep 17 00:00:00 2001 From: Stefan Marr Date: Wed, 20 Jan 2016 16:37:23 +0100 Subject: [PATCH 3/4] Make comments in Location a little more precise. Signed-off-by: Stefan Marr --- .../src/com/oracle/truffle/api/object/Location.java | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Location.java b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Location.java index e6ad315d7534..d508227af2bb 100644 --- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Location.java +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Location.java @@ -125,7 +125,7 @@ public final void set(DynamicObject store, Object value) throws IncompatibleLoca protected abstract void setInternal(DynamicObject store, Object value) throws IncompatibleLocationException; /** - * Returns {@code true} if the location can be set to the value. + * Returns {@code true} if the location can be set to the given value. * * @param store the receiver object * @param value the value in question @@ -144,9 +144,10 @@ public boolean canSet(Object value) { } /** - * Returns {@code true} if the location is compatible with the value. + * Returns {@code true} if the location is compatible with the type of the value. * - * The value may still be rejected if {@link #canSet(DynamicObject, Object)} returns false. + * The actual value may still be rejected if {@link #canSet(DynamicObject, Object)} returns + * false. * * @param value the value in question */ From f846c77c84f3a8a4a232b2a93e4c3e399a073d76 Mon Sep 17 00:00:00 2001 From: Stefan Marr Date: Wed, 20 Jan 2016 16:38:01 +0100 Subject: [PATCH 4/4] Document that Property.flags is for language-specific use Signed-off-by: Stefan Marr --- .../src/com/oracle/truffle/api/object/Property.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Property.java b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Property.java index 4145d6311a37..3b387a2ea5af 100644 --- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Property.java +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Property.java @@ -34,6 +34,8 @@ protected Property() { /** * Create a new property. + * + * @param flags, for language-specific use */ public static Property create(Object key, Location location, int flags) { return Layout.getFactory().createProperty(key, location, flags); @@ -45,7 +47,7 @@ public static Property create(Object key, Location location, int flags) { public abstract Object getKey(); /** - * Get property flags. + * Get property flags, which are free for language-specific use. */ public abstract int getFlags();