annotate graal/com.oracle.truffle.api.codegen/src/com/oracle/truffle/api/codegen/NodeChild.java @ 10591:3cc5fb59916e

Truffle-DSL: Renamed @NodeClass to @NodeContainer. splitByMethodName is not an option anymore and is always enabled if a @NodeContainer is used.
author Christian Humer <christian.humer@gmail.com>
date Fri, 28 Jun 2013 12:19:51 +0200
parents 8b2573c8d47f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9220
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
1 /*
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
2 * Copyright (c) 2012, 2012, Oracle and/or its affiliates. All rights reserved.
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
4 *
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
7 * published by the Free Software Foundation.
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
8 *
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
13 * accompanied this code).
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
14 *
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
18 *
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
21 * questions.
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
22 */
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
23 package com.oracle.truffle.api.codegen;
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
24
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
25 import java.lang.annotation.*;
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
26
9285
90eb4bb7f755 Added some javadoc to executeWith.
Christian Humer <christian.humer@gmail.com>
parents: 9220
diff changeset
27 import com.oracle.truffle.api.nodes.*;
90eb4bb7f755 Added some javadoc to executeWith.
Christian Humer <christian.humer@gmail.com>
parents: 9220
diff changeset
28
10443
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
29 /**
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
30 * A {@link NodeChild} element defines an executable child for the enclosing {@link Node}. A
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
31 * {@link Node} contains multiple {@link NodeChildren} specified in linear execution order.
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
32 */
9220
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
33 @Retention(RetentionPolicy.CLASS)
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
34 @Target({ElementType.TYPE})
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
35 public @interface NodeChild {
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
36
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
37 String value() default "";
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
38
10591
3cc5fb59916e Truffle-DSL: Renamed @NodeClass to @NodeContainer. splitByMethodName is not an option anymore and is always enabled if a @NodeContainer is used.
Christian Humer <christian.humer@gmail.com>
parents: 10443
diff changeset
39 Class<?> type() default Node.class;
9220
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
40
9285
90eb4bb7f755 Added some javadoc to executeWith.
Christian Humer <christian.humer@gmail.com>
parents: 9220
diff changeset
41 /**
10443
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
42 * The {@link #executeWith()} property allows a node to pass the result of one child's
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
43 * executable as an input to another child's executable. These referenced children must be
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
44 * defined before the current node in the execution order. The current node {@link #type()}
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
45 * attribute must be set to a {@link Node} which supports the evaluated execution with the
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
46 * number of {@link #executeWith()} arguments that are defined. For example if this child is
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
47 * executed with one argument, the {@link #type()} attribute must define a node which publicly
8b2573c8d47f dsl cleanup.
Christian Humer <christian.humer@gmail.com>
parents: 9285
diff changeset
48 * declares a method with the signature <code>Object execute*(VirtualFrame, Object)</code>.
9285
90eb4bb7f755 Added some javadoc to executeWith.
Christian Humer <christian.humer@gmail.com>
parents: 9220
diff changeset
49 */
9220
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
50 String[] executeWith() default {};
97ad6d3e7557 Codegen API changes. Executed child nodes are now defined using @NodeChildren instead of fields.
Christian Humer <christian.humer@gmail.com>
parents:
diff changeset
51 }