Mercurial > hg > graal-compiler

comparison graal/com.oracle.truffle.api.codegen/src/com/oracle/truffle/api/codegen/TypeSystem.java @ 7291:a748e4d44694

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Truffle API to specify type-specalized Node classes; annotation processor for automatic code generation of the type-specialized Node classes during the build process
author Christian Humer <christian.humer@gmail.com>
date Fri, 21 Dec 2012 10:44:31 -0800
parents
children 6343a09b2ec1
comparison
equal deleted inserted replaced
7290:a81db08fe930 7291:a748e4d44694
1 /*
2 * Copyright (c) 2012, 2012, 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.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23 package com.oracle.truffle.api.codegen;
24
25 import java.lang.annotation.*;
26
27 import com.oracle.truffle.api.nodes.*;
28
29 /**
30 * <p>
31 * Annotates a type system class that represents type information for a node. Generates code for converting and managing
32 * types. Methods contained in the type system may be annotated with {@link TypeCast}, {@link TypeCheck} or
33 * {@link GuardCheck}. These methods alter the default behavior of the type system.
34 * </p>
35 *
36 *
37 * <b>Example:</b>
38 * <p>
39 * Shows a <code>@TypeSystem</code> definition with three types. In this example BigIntegers can be also treated as
40 * integers if their bit width is less than 32.
41 * </p>
42 *
43 * <pre>
44 *
45 * &#064;TypeSystem(types = {int.class, BigInteger.class, String.class}, nodeBaseClass = TypedNode.class)
46 * public abstract class Types {
47 *
48 * &#064;TypeCheck
49 * public boolean isInteger(Object value) {
50 * return value instanceof Integer || (value instanceof BigInteger &amp;&amp; ((BigInteger) value).bitLength() &lt; Integer.SIZE);
51 * }
52 *
53 * &#064;TypeCast
54 * public int asInteger(Object value) {
55 * if (value instanceof Integer) {
56 * return (int) value;
57 * } else {
58 * return ((BigInteger) value).intValue();
59 * }
60 * }
61 * }
62 * </pre>
63 *
64 * @see TypeCast
65 * @see TypeCheck
66 * @see GuardCheck
67 */
68 @Retention(RetentionPolicy.CLASS)
69 @Target({ElementType.TYPE})
70 public @interface TypeSystem {
71
72 /**
73 * Sets the types contained by this type system. The order of types also determines the order of specialization.
74 */
75 Class[] types();
76
77 /**
78 * Specifies whether the node base class has an executeVoid method or not. Operations derived from this type system
79 * will automatically implement executeVoid for all generated nodes. Defaults to false.
80 */
81 boolean hasVoid() default false;
82
83 /**
84 * Specifies the node base class used for generated code that uses this type system. The node base class must extend
85 * {@link Node} and provide a public non-final method <code>${type} execute${typeName}(VirtualFrame)</code> for all
86 * types specified in the types attribute.
87 */
88 Class< ? extends Node> nodeBaseClass();
89
90 }