com.oracle.truffle.api.dsl.NodeChild Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-api Show documentation
Truffle is a multi-language framework for executing dynamic languages that achieves high performance when combined with Graal.
There is a newer version: 24.1.1
Show newest version
/*
 * Copyright (c) 2012, 2021, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.oracle.truffle.api.dsl;

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.oracle.truffle.api.nodes.Node;

/**
 * A {@link NodeChild} element defines an executable child for the enclosing {@link Node}. A
 * {@link Node} contains multiple {@link NodeChildren} specified in linear execution order.
 *
 * @since 0.8 or earlier
 */
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE})
@Repeatable(NodeChildren.class)
public @interface NodeChild {
    /** @since 0.8 or earlier */
    String value() default "";

    /** @since 0.8 or earlier */
    Class type() default Node.class;

    /**
     * The {@link #executeWith()} property allows a node to pass the result of one child's
     * executable as an input to another child's executable. These referenced children must be
     * defined before the current node in the execution order. The current node {@link #type()}
     * attribute must be set to a {@link Node} which supports the evaluated execution with the
     * number of {@link #executeWith()} arguments that are defined. For example if this child is
     * executed with one argument, the {@link #type()} attribute must define a node which publicly
     * declares a method with the signature Object execute*(VirtualFrame, Object).
     *
     * @since 0.8 or earlier
     */
    String[] executeWith() default {};

    /**
     * Allows implicit creation of this child node. If this property is {@code false} (the default),
     * the factory method of the parent node needs to be called with an instance of the child node
     * as argument. If {@link #implicit} is {@code true}, the child node will be implicitly created
     * when calling the factory method of the parent node.
     *
     * @since 21.1
     */
    boolean implicit() default false;

    /**
     * Defines the initializer expression for implicit child node creation. Specifying this property
     * will enable {@link #implicit()} mode on this child node automatically, this should not be
     * specified together with {@link #implicit()}. If {@link #implicit()} is {@code true}, the
     * initializer expression defaults to {@code "create()"}.
     *
     * @see #implicit()
     * @see Cached
     * @since 21.1
     */
    String implicitCreate() default "create()";

    /**
     * Allow this child node to be used in uncached mode. If set to {@code false} (the default),
     * only execute methods that have an explicit argument for the child value can be used on the
     * uncached version of the parent node. If set to {@code true}, execute methods that do not have
     * an explicit argument for the child value use an uncached version of the child node to compute
     * the missing value.
     *
     * @see GenerateUncached
     * @since 21.1
     */
    boolean allowUncached() default false;

    /**
     * Defines the expression to get an uncached instance of the child node. Specifying this
     * property will implicitly enable {@link #allowUncached()} on this child node, this should not
     * be specified together with {@link #allowUncached()}. If {@link #allowUncached()} is
     * {@code true}, the uncached expression defaults to {@code "getUncached()"}.
     *
     * @see #allowUncached()
     * @see Cached
     * @since 21.1
     */
    String uncached() default "getUncached()";
}