annotate graal/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/ForeignAccessFactory.java @ 19117:4f30f1e7e1e6

Fold if nodes at parse time.
author Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
date Wed, 04 Feb 2015 03:19:37 +0100
parents d6dba4c723c0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18746
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
1 /*
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
2 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
4 *
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
7 * published by the Free Software Foundation. Oracle designates this
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
8 * particular file as subject to the "Classpath" exception as provided
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
10 *
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
15 * accompanied this code).
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
16 *
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License version
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
20 *
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
23 * questions.
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
24 */
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
25 package com.oracle.truffle.api.interop;
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
26
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
27 import com.oracle.truffle.api.*;
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
28 import com.oracle.truffle.api.interop.messages.*;
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
29
18865
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
30 /**
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
31 * Interface of a factory that produces AST snippets that can access a foreign {@code TruffleObject}
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
32 * . A Truffle language implementation accesses a {@code TruffleObject} via a {@code Message}. The
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
33 * {@code TruffleObject} instance provides a {@code ForeignAccessFactory} instance that provides an
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
34 * AST snippet for a given {@code Message}.
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
35 */
18746
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
36 public interface ForeignAccessFactory {
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
37
18865
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
38 /**
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
39 * Provides a {@code InteropPredicate} that tests whether a {@code TruffleObject} can be
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
40 * accessed using AST snippets, produced by this {@code ForeignAccessFactory}.
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
41 *
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
42 * @return the {@code InteropPredicate} that tests if a {@code TruffleObject} can be accessed by
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
43 * AST snipptes, produces by this {@code ForeignAccessFactory}.
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
44 */
18746
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
45 InteropPredicate getLanguageCheck();
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
46
18865
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
47 /**
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
48 * Provides an AST snippet to access a {@code TruffleObject}.
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
49 *
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
50 * @param tree the {@code Message} that represents the access to a {@code TruffleObject}.
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
51 * @return the AST snippet for accessing the {@code TruffleObject}, wrapped as a
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
52 * {@code CallTarget}.
d6dba4c723c0 Interop: improve exception names and JavaDoc
Matthias Grimmer <grimmer@ssw.jku.at>
parents: 18746
diff changeset
53 */
18746
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
54 CallTarget getAccess(Message tree);
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
55
5294b624e2f0 Interop: add interface
Matthias Grimmer <grimmer@ssw.jku.at>
parents:
diff changeset
56 }