diff graal/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/DynamicObject.java @ 18407:f439fdb137a3

Truffle: initial commit of object API
author Andreas Woess <andreas.woess@jku.at>
date Tue, 18 Nov 2014 16:18:45 +0100
parents
children 6db7923af642
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/graal/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/DynamicObject.java	Tue Nov 18 16:18:45 2014 +0100
@@ -0,0 +1,134 @@
+/*
+ * Copyright (c) 2013, 2014, 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 com.oracle.truffle.api.object;
+
+import com.oracle.truffle.api.*;
+
+public interface DynamicObject extends TypedObject {
+    /**
+     * Get the object's current shape.
+     */
+    Shape getShape();
+
+    /**
+     * Get property value.
+     *
+     * @param key property identifier
+     * @param defaultValue return value if property is not found
+     * @return property value or defaultValue if object has no such property
+     */
+    Object get(Object key, Object defaultValue);
+
+    /**
+     * Set value of existing property.
+     *
+     * @param key property identifier
+     * @param value value to be set
+     * @return {@code true} if successful or {@code false} if property not found
+     */
+    boolean set(Object key, Object value);
+
+    /**
+     * Define new property or redefine existing property.
+     *
+     * @param key property identifier
+     * @param value value to be set
+     * @param flags flags to be set
+     */
+    void define(Object key, Object value, int flags);
+
+    /**
+     * Define new property with a static location or change existing property.
+     *
+     * @param key property identifier
+     * @param value value to be set
+     * @param flags flags to be set
+     * @param locationFactory factory function that creates a location for a given shape and value
+     */
+    void define(Object key, Object value, int flags, LocationFactory locationFactory);
+
+    /**
+     * Change property flags.
+     *
+     * @param key property identifier
+     * @param newFlags flags to be set
+     * @return {@code true} if successful or {@code false} if property not found
+     */
+    boolean changeFlags(Object key, int newFlags);
+
+    /**
+     * Change property flags.
+     *
+     * @param key property identifier
+     * @param flagsUpdateFunction function updating old flags to new flags
+     * @return {@code true} if successful or {@code false} if property not found
+     */
+    boolean changeFlags(Object key, FlagsFunction flagsUpdateFunction);
+
+    /**
+     * Delete property.
+     *
+     * @param key property identifier
+     * @return {@code true} if successful or {@code false} if property not found
+     */
+    boolean delete(Object key);
+
+    /**
+     * Returns the number of properties in this object.
+     */
+    int size();
+
+    /**
+     * Returns {@code true} if this object contains no properties.
+     */
+    boolean isEmpty();
+
+    /**
+     * Set object shape and grow storage if necessary.
+     *
+     * @param oldShape the object's current shape (must equal {@link #getShape()})
+     * @param newShape the new shape to be set
+     */
+    void setShapeAndGrow(Shape oldShape, Shape newShape);
+
+    /**
+     * Set object shape and resize storage if necessary.
+     *
+     * @param oldShape the object's current shape (must equal {@link #getShape()})
+     * @param newShape the new shape to be set
+     */
+    void setShapeAndResize(Shape oldShape, Shape newShape);
+
+    /**
+     * Ensure object shape is up-to-date.
+     *
+     * @return {@code true} if shape has changed
+     */
+    boolean updateShape();
+
+    public interface FlagsFunction {
+        int apply(int t);
+    }
+}