com.oracle.truffle.sl.builtins.SLBuiltinNode Maven / Gradle / Ivy
/*
* Copyright (c) 2012, 2014, 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.sl.builtins;
import com.oracle.truffle.api.dsl.GenerateNodeFactory;
import com.oracle.truffle.api.dsl.NodeChild;
import com.oracle.truffle.api.dsl.NodeField;
import com.oracle.truffle.sl.nodes.SLExpressionNode;
import com.oracle.truffle.sl.runtime.SLContext;
import com.oracle.truffle.sl.runtime.SLFunctionRegistry;
/**
* Base class for all builtin functions. It contains the Truffle DSL annotation {@link NodeChild}
* that defines the function arguments.
* Builtin functions need access to the {@link SLContext}. Instead of defining a Java field manually
* and setting it in a constructor, we use the Truffle DSL annotation {@link NodeField} that
* generates the field and constructor automatically.
*
* The builtin functions are registered in {@link SLContext#installBuiltins}. Every builtin node
* subclass is instantiated there, wrapped into a function, and added to the
* {@link SLFunctionRegistry}. This ensures that builtin functions can be called like user-defined
* functions; there is no special function lookup or call node for builtin functions.
*/
@NodeChild(value = "arguments", type = SLExpressionNode[].class)
@NodeField(name = "context", type = SLContext.class)
@GenerateNodeFactory
public abstract class SLBuiltinNode extends SLExpressionNode {
/**
* Accessor for the {@link SLContext}. The implementation of this method is generated
* automatically based on the {@link NodeField} annotation on the class.
*/
public abstract SLContext getContext();
}