Mercurial > hg > truffle

annotate truffle/com.oracle.truffle.api.dsl/src/com/oracle/truffle/api/dsl/Fallback.java @ 22157:dc83cc1f94f2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Using fully qualified imports
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 16 Sep 2015 11:33:22 +0200
parents 9c8c0937da41
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10597
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
1 /*
18128
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
2 * Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved.
10597
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
4 *
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
11279
494b818b527c Adding "Classpath" exception to the classes in the com.oracle.truffle.api and the com.oracle.truffle.api.dsl package.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 10597
diff changeset
7 * published by the Free Software Foundation. Oracle designates this
494b818b527c Adding "Classpath" exception to the classes in the com.oracle.truffle.api and the com.oracle.truffle.api.dsl package.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 10597
diff changeset
8 * particular file as subject to the "Classpath" exception as provided
494b818b527c Adding "Classpath" exception to the classes in the com.oracle.truffle.api and the com.oracle.truffle.api.dsl package.
Thomas Wuerthinger <thomas.wuerthinger@oracle.com>
parents: 10597
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
10597
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
10 *
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
15 * accompanied this code).
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
16 *
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License version
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
20 *
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
23 * questions.
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
24 */
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
25 package com.oracle.truffle.api.dsl;
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
26
22157
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
27 import com.oracle.truffle.api.nodes.Node;
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
28 import java.lang.annotation.ElementType;
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
29 import java.lang.annotation.Retention;
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
30 import java.lang.annotation.RetentionPolicy;
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
31 import java.lang.annotation.Target;
18128
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
32
10597
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
33 /**
18128
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
34 * <p>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
35 * A method annotated with {@link Fallback} is treated as a {@link Specialization} that implicitly
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
36 * links all the guards of all other declared {@link Specialization} annotated methods of the
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
37 * operation in a negated form. As a consequence it cannot declare any other guards. The expected
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
38 * signature of the method must match to the signature of a {@link Specialization} with the
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
39 * additional limitation that only generically executable argument types are allowed. A generically
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
40 * executable argument is a an argument hat can be executed from the child {@link Node} using an
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
41 * execute method without {@link UnsupportedOperationException}. In many cases the generically
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
42 * executable type is {@link Object}. An operation is limited to just one {@link Fallback}
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
43 * specialization which is always ordered at the end of the specialization chain.
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
44 * </p>
10597
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
45 *
18128
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
46 * <p>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
47 * A simple example showing the use of the {@link Fallback} annotation in a DSL operation:
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
48 * </p>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
49 *
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
50 * <pre>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
51 * &#064;Specialization int doInt(int a) {..}
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
52 * &#064;Specialization int doDouble(double a) {..}
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
53 * &#064;Fallback int orElse(Object a) {..}
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
54 * </pre>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
55 *
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
56 * <p>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
57 * The previous example could be redeclared just using {@link Specialization} annotated methods as
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
58 * follows:
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
59 * </p>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
60 *
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
61 * <pre>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
62 * &#064;Specialization int doInt(int a) {..}
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
63 * &#064;Specialization int doDouble(double a) {..}
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
64 * &#064;Specialization(guard={"!isInt(a)", "!isDouble(a)"})
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
65 * int orElse(Object a) {..}
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
66 * </pre>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
67 *
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
68 * <p>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
69 * <b>Performance note:</b> For operations with a lot of {@link Specialization} annotated methods
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
70 * the use of {@link Fallback} might generate a guard that is very big. Try to avoid the use of
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
71 * {@link Fallback} for specializations that are significantly important for peak performance.
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
72 * </p>
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
73 *
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
74 * @see Specialization
7b6a4ae58de4 Truffle-DSL: improve JavaDoc for @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 16760
diff changeset
75 * @see NodeChild
10597
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
76 */
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
77 @Retention(RetentionPolicy.CLASS)
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
78 @Target({ElementType.METHOD})
16760
9f38d222fa6c Truffle-DSL: renamed @Generic to @Fallback.
Christian Humer <christian.humer@gmail.com>
parents: 11279
diff changeset
79 public @interface Fallback {
10597
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
80
79041ab43660 Truffle-DSL: API-change: Renamed truffle.api.codegen to truffle.api.dsl for all projects and packages.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
81 }