Mercurial > hg > truffle
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/package-info.java Mon Jun 08 04:50:13 2015 +0200 @@ -0,0 +1,43 @@ +/* + * Copyright (c) 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. + */ + +/** + * Inter-operability between different languages is covered by this package. + * In case you are implementing own {@link com.oracle.truffle.api.TruffleLanguage} and you want + * to interact with other {@link com.oracle.truffle.api.TruffleLanguage language implementations} + * you need to use types from this package. + * <p> + * Different languages can exchange either wrappers of primitive Java + * types (like {@link Integer}, {@link Double}, {@link String}), or they + * can export their own types (if they implement {@link TruffleObject} interface). + * Btw. One can recognize foreign object if it implements {@link TruffleObject}. + * <p> + * To use {@link TruffleObject} from a different language one needs to ask + * the language to build appropriate AST for a given {@link Message}. To do + * so use {@link ForeignAccess#node(com.oracle.truffle.api.interop.Message)} + * 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...)}. + */ +package com.oracle.truffle.api.interop; +