Mercurial > hg > graal-compiler

comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/PhylumTag.java @ 15279:0c6d8a08e31b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Sun, 20 Apr 2014 20:37:27 -0700
parents
children bb9473723904
comparison
equal deleted inserted replaced
14862:0e713dba33bb 15279:0c6d8a08e31b
1 /*
2 * Copyright (c) 2014, 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.instrument;
26
27 /**
28 * Program element "tags" that define user-visible behavior for debugging and other simple tools.
29 * These categories (<em>phyla</em>) should correspond to program structures that are meaningful to
30 * a guest language programmer.
31 * <p>
32 * An untagged Truffle node should be understood as an artifact of the guest language implementation
33 * and should not be visible to the user of a guest language programming tool. Nodes may also have
34 * more than one tag, for example a variable assignment that is also a statement. Finally, the
35 * assignment of tags to nodes could depending on the use-case of whatever tool is using them.
36 * <p>
37 * This is a somewhat language-agnostic set of phyla, suitable for conventional imperative
38 * languages, and is being developed incrementally.
39 * <p>
40 * The need for alternative sets of tags is likely to arise, perhaps for other families of languages
41 * (for example for mostly expression-oriented languages) or even for specific languages.
42 * <p>
43 * These are listed alphabetically so that listing from some collection classes will come out in
44 * that order.
45 * <p>
46 * <strong>Disclaimer:</strong> experimental interface under development.
47 */
48 public enum PhylumTag {
49
50 /**
51 * Marker for a variable assignment.
52 */
53 ASSIGNMENT,
54
55 /**
56 * Marker for a call site.
57 */
58 CALL,
59
60 /**
61 * Marker for a location where a guest language exception is about to be thrown.
62 */
63 THROW,
64
65 /**
66 * Marker for a location where ordinary "stepping" should halt.
67 */
68 STATEMENT;
69
70 }