comparison graal/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/package-info.java @ 21770:c76742cc2c6f

Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Mon, 08 Jun 2015 04:50:13 +0200
parents
children b0df81ea5b20
comparison
equal deleted inserted replaced
21769:b6309a7d5a44 21770:c76742cc2c6f
1 /*
2 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 /**
27 * Inter-operability between different languages is covered by this package.
28 * In case you are implementing own {@link com.oracle.truffle.api.TruffleLanguage} and you want
29 * to interact with other {@link com.oracle.truffle.api.TruffleLanguage language implementations}
30 * you need to use types from this package.
31 * <p>
32 * Different languages can exchange either wrappers of primitive Java
33 * types (like {@link Integer}, {@link Double}, {@link String}), or they
34 * can export their own types (if they implement {@link TruffleObject} interface).
35 * Btw. One can recognize foreign object if it implements {@link TruffleObject}.
36 * <p>
37 * To use {@link TruffleObject} from a different language one needs to ask
38 * the language to build appropriate AST for a given {@link Message}. To do
39 * so use {@link ForeignAccess#node(com.oracle.truffle.api.interop.Message)}
40 * and when calling it {@link ForeignAccess#execute(com.oracle.truffle.api.nodes.Node, com.oracle.truffle.api.frame.VirtualFrame, com.oracle.truffle.api.interop.TruffleObject, java.lang.Object...)}.
41 */
42 package com.oracle.truffle.api.interop;
43