Mercurial > hg > truffle
comparison truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/NodeInfo.java @ 21951:9c8c0937da41
Moving all sources into truffle subdirectory
author | Jaroslav Tulach <jaroslav.tulach@oracle.com> |
---|---|
date | Wed, 17 Jun 2015 10:58:08 +0200 |
parents | graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/NodeInfo.java@4293efaaab76 |
children | dc83cc1f94f2 |
comparison
equal
deleted
inserted
replaced
21950:2a5011c7e641 | 21951:9c8c0937da41 |
---|---|
1 /* | |
2 * Copyright (c) 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. Oracle designates this | |
8 * particular file as subject to the "Classpath" exception as provided | |
9 * by Oracle in the LICENSE file that accompanied this code. | |
10 * | |
11 * This code is distributed in the hope that it will be useful, but WITHOUT | |
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
14 * version 2 for more details (a copy is included in the LICENSE file that | |
15 * accompanied this code). | |
16 * | |
17 * You should have received a copy of the GNU General Public License version | |
18 * 2 along with this work; if not, write to the Free Software Foundation, | |
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
20 * | |
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
22 * or visit www.oracle.com if you need additional information or have any | |
23 * questions. | |
24 */ | |
25 package com.oracle.truffle.api.nodes; | |
26 | |
27 import java.lang.annotation.*; | |
28 | |
29 /** | |
30 * Annotation for providing additional information on nodes. | |
31 */ | |
32 @Retention(RetentionPolicy.RUNTIME) | |
33 @Target(ElementType.TYPE) | |
34 public @interface NodeInfo { | |
35 | |
36 /** | |
37 * Short name representing the node that can be used for debugging. | |
38 * | |
39 * @return the short name | |
40 */ | |
41 String shortName() default ""; | |
42 | |
43 /** | |
44 * Provides a rough estimate for the cost of the annotated {@link Node}. This estimate can be | |
45 * used by runtime systems or guest languages to implement heuristics based on Truffle ASTs. | |
46 * | |
47 * @see Node#getCost() | |
48 * @see NodeCost | |
49 */ | |
50 NodeCost cost() default NodeCost.MONOMORPHIC; | |
51 | |
52 /** | |
53 * A human readable explanation of the purpose of the annotated {@link Node}. Can be used e.g. | |
54 * for debugging or visualization purposes. | |
55 * | |
56 * @return the description | |
57 */ | |
58 String description() default ""; | |
59 | |
60 /** | |
61 * A description, providing a user-readable explanation of the source language of the annotated | |
62 * {@link Node}. Can be used e.g. for debugging or visualization purposes. Typically this | |
63 * information is set only in an abstract base node for the language implementation. | |
64 * | |
65 * @return the description | |
66 */ | |
67 String language() default ""; | |
68 } |