Mercurial > hg > truffle

annotate truffle/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/package-info.java @ 22494:cff4a9d3e72a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Enumerating allowed interop types
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Mon, 14 Dec 2015 08:46:35 +0100
parents 0bd14859636f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21770
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
1 /*
22004
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
2 * Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
21770
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
4 *
22004
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
7 * published by the Free Software Foundation. Oracle designates this
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
8 * particular file as subject to the "Classpath" exception as provided
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
21770
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
10 *
22004
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
21770
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
15 * accompanied this code).
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
16 *
22004
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
17 * You should have received a copy of the GNU General Public License version
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
21770
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
20 *
22004
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
11e0412c5b0e Make headers valid for checkstyle again.
Christian Humer <christian.humer@gmail.com>
parents: 22003
diff changeset
23 * questions.
21770
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
24 */
22061
0bd14859636f interop API is stable
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22004
diff changeset
25
0bd14859636f interop API is stable
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22004
diff changeset
26 /*
0bd14859636f interop API is stable
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22004
diff changeset
27 @ApiInfo(
0bd14859636f interop API is stable
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22004
diff changeset
28 group="Stable"
0bd14859636f interop API is stable
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22004
diff changeset
29 )
0bd14859636f interop API is stable
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22004
diff changeset
30 */
0bd14859636f interop API is stable
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22004
diff changeset
31
21770
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
32 /**
21775
b0df81ea5b20 use qualified references in package-info.java javadoc to accommodate limitation in Eclipse
Doug Simon <doug.simon@oracle.com>
parents: 21770
diff changeset
33 * This package provides inter-operability between different
b0df81ea5b20 use qualified references in package-info.java javadoc to accommodate limitation in Eclipse
Doug Simon <doug.simon@oracle.com>
parents: 21770
diff changeset
34 * {@link com.oracle.truffle.api.TruffleLanguage Truffle languages}.
21770
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
35 * <p>
22494
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
36 * Languages can exchange primitive Java type wrapper objects (e.g.,
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
37 * {@link java.lang.Byte},
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
38 * {@link java.lang.Short},
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
39 * {@link java.lang.Integer},
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
40 * {@link java.lang.Long},
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
41 * {@link java.lang.Float},
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
42 * {@link java.lang.Double},
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
43 * {@link java.lang.Character},
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
44 * {@link java.lang.Boolean},
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
45 * and {@link java.lang.String})
cff4a9d3e72a Enumerating allowed interop types
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 22061
diff changeset
46 * as well as any type implementing
22003
5bc7f7b867ab Making debugger always on for each TruffleVM execution. Introducing EventConsumer to process such debugger events. Requesting each RootNode to be associated with a TruffleLanguage, so debugger can find out proper context for each Node where executions gets suspended.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
47 * {@link com.oracle.truffle.api.interop.TruffleObject}. Foreign objects are precisely those
5bc7f7b867ab Making debugger always on for each TruffleVM execution. Introducing EventConsumer to process such debugger events. Requesting each RootNode to be associated with a TruffleLanguage, so debugger can find out proper context for each Node where executions gets suspended.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
48 * implementing {@link com.oracle.truffle.api.interop.TruffleObject}.
21770
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
49 * <p>
22003
5bc7f7b867ab Making debugger always on for each TruffleVM execution. Introducing EventConsumer to process such debugger events. Requesting each RootNode to be associated with a TruffleLanguage, so debugger can find out proper context for each Node where executions gets suspended.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
50 * To use a {@link com.oracle.truffle.api.interop.TruffleObject} from a different language, you need
5bc7f7b867ab Making debugger always on for each TruffleVM execution. Introducing EventConsumer to process such debugger events. Requesting each RootNode to be associated with a TruffleLanguage, so debugger can find out proper context for each Node where executions gets suspended.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
51 * to ask the language to build appropriate AST for a given
21775
b0df81ea5b20 use qualified references in package-info.java javadoc to accommodate limitation in Eclipse
Doug Simon <doug.simon@oracle.com>
parents: 21770
diff changeset
52 * {@link com.oracle.truffle.api.interop.Message} with
22003
5bc7f7b867ab Making debugger always on for each TruffleVM execution. Introducing EventConsumer to process such debugger events. Requesting each RootNode to be associated with a TruffleLanguage, so debugger can find out proper context for each Node where executions gets suspended.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
53 * {@link com.oracle.truffle.api.interop.Message#createNode}. The message can then be executed with
5bc7f7b867ab Making debugger always on for each TruffleVM execution. Introducing EventConsumer to process such debugger events. Requesting each RootNode to be associated with a TruffleLanguage, so debugger can find out proper context for each Node where executions gets suspended.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
54 * {@link com.oracle.truffle.api.interop.ForeignAccess#execute}.
21770
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
55 */
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
56 package com.oracle.truffle.api.interop;
c76742cc2c6f Polishing inter-operability APIs: Exposing only Message, TruffleObject and ForeignAccess-related classes.
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
57