Mercurial > hg > truffle

annotate truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/StandardSyntaxTag.java @ 21972:ff6f34159b8a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Providing package-info for most of API packages. Feel free to provide your package-info.java for anything that has API in its name.
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Tue, 23 Jun 2015 12:44:41 +0200
parents 9c8c0937da41
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15605
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
1 /*
19696
27fe86a6fb49 Truffle/Instrumentation: Javadoc
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 19507
diff changeset
2 * Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
15605
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
4 *
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
7 * published by the Free Software Foundation. Oracle designates this
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
8 * particular file as subject to the "Classpath" exception as provided
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
10 *
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
15 * accompanied this code).
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
16 *
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License version
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
20 *
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
23 * questions.
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
24 */
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
25 package com.oracle.truffle.api.instrument;
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
26
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
27 /**
16391
50d79ad439f1 Truffle/Instrumentation: rename PhylumTag to SyntaxTag (along with related classes/methods)
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 15605
diff changeset
28 * A somewhat language-agnostic set of user-sensible syntactic categories, suitable for conventional
50d79ad439f1 Truffle/Instrumentation: rename PhylumTag to SyntaxTag (along with related classes/methods)
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 15605
diff changeset
29 * imperative languages, and is being developed incrementally.
15605
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
30 * <p>
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
31 * The need for alternative sets of tags is likely to arise, perhaps for other families of languages
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
32 * (for example for mostly expression-oriented languages) or even for specific languages.
19507
1cde96b96673 Fixed code format issues.
Roland Schatz <roland.schatz@oracle.com>
parents: 18485
diff changeset
33 *
15605
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
34 * @see Probe
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
35 */
16391
50d79ad439f1 Truffle/Instrumentation: rename PhylumTag to SyntaxTag (along with related classes/methods)
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 15605
diff changeset
36 public enum StandardSyntaxTag implements SyntaxTag {
15605
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
37
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
38 /**
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
39 * Marker for a variable assignment.
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
40 */
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
41 ASSIGNMENT("assignment", "a variable assignment"),
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
42
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
43 /**
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
44 * Marker for a call site.
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
45 */
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
46 CALL("call", "a method/procedure call site"),
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
47
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
48 /**
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
49 * Marker for a location where a guest language exception is about to be thrown.
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
50 */
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
51 THROW("throw", "creator of an exception"),
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
52
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
53 /**
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
54 * Marker for a location where ordinary "stepping" should halt.
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
55 */
16576
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
56 STATEMENT("statement", "basic unit of the language, suitable for \"stepping\" in a debugger"),
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
57
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
58 /**
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
59 * Marker for the start of the body of a method.
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
60 */
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
61 START_METHOD("start-method", "start of the body of a method"),
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
62
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
63 /**
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
64 * Marker for the start of the body of a loop.
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
65 */
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
66 START_LOOP("start-loop", "start of the body of a loop"),
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
67
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
68 /**
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
69 * Marker that is attached to some arbitrary locations that appear often-enough in an AST so
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
70 * that a location with this tag is regularly executed. Could be the start of method and loop
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
71 * bodies. May be used to implement some kind of safepoint functionality.
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
72 */
a01fe4b301a8 Truffle/Instrument: new syntax tags for periodically appearing locations.
Chris Seaton <chris.seaton@oracle.com>
parents: 16391
diff changeset
73 PERIODIC("periodic", "arbitrary locations that appear often-enough in an AST so that a location with this tag is regularly executed");
15605
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
74
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
75 private final String name;
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
76 private final String description;
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
77
16391
50d79ad439f1 Truffle/Instrumentation: rename PhylumTag to SyntaxTag (along with related classes/methods)
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 15605
diff changeset
78 private StandardSyntaxTag(String name, String description) {
15605
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
79 this.name = name;
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
80 this.description = description;
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
81 }
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
82
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
83 public String getName() {
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
84 return name;
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
85 }
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
86
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
87 public String getDescription() {
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
88 return description;
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
89 }
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
90
bb9473723904 Truffle/Instrumentation:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
91 }