Mercurial > hg > graal-jvmci-8

comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/source/SourceSection.java @ 16068:74e142bd2b12

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Truffle/Source: major API revision - All source-related classes now in com.oracle.truffle.api.source - SourceFactory replaced with factory methods on Source - Revision, renaming, and documentation to methods on Source and SourceSection - NullSourceSection is now a utility class
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Fri, 06 Jun 2014 22:13:00 -0700
parents
children 33bdafbf285d
comparison
equal deleted inserted replaced
16067:915ebb306fcc 16068:74e142bd2b12
1 /*
2 * Copyright (c) 2013, 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.source;
26
27 /**
28 * Description of contiguous section of text within a {@link Source} of program code; supports
29 * multiple modes of access to the text and its location. A special {@linkplain NullSourceSection
30 * null subtype} should be used for code that is not available from source, e.g language builtins.
31 *
32 * @see Source#createSection(String, int, int, int, int)
33 * @see Source#createSection(String, int, int, int)
34 * @see Source#createSection(String, int, int)
35 * @see Source#createSection(String, int)
36 * @see NullSourceSection
37 */
38 public interface SourceSection {
39
40 // TODO support alternate text representations/encodings
41
42 /**
43 * Representation of the source program that contains this section.
44 *
45 * @return the source object
46 */
47 Source getSource();
48
49 /**
50 * Returns 1-based line number of the first character in this section (inclusive).
51 *
52 * @return the starting line number
53 */
54 int getStartLine();
55
56 /**
57 * Gets a representation of the first line of the section, suitable for a hash key.
58 */
59 LineLocation getLineLocation();
60
61 /**
62 * Returns the 1-based column number of the first character in this section (inclusive).
63 *
64 * @return the starting column number
65 */
66 int getStartColumn();
67
68 /**
69 * Returns the 0-based index of the first character in this section.
70 *
71 * @return the starting character index
72 */
73 int getCharIndex();
74
75 /**
76 * Returns the length of this section in characters.
77 *
78 * @return the number of characters in the section
79 */
80 int getCharLength();
81
82 /**
83 * Returns the index of the text position immediately following the last character in the
84 * section.
85 *
86 * @return the end position of the section
87 */
88 int getCharEndIndex();
89
90 /**
91 * Returns terse text describing this source section, typically used for printing the section.
92 *
93 * @return the identifier of the section
94 */
95 String getIdentifier();
96
97 /**
98 * Returns text described by this section.
99 *
100 * @return the code as a String object
101 */
102 String getCode();
103
104 /**
105 * Returns a short description of the source section, using just the file name, rather than its
106 * full path.
107 *
108 * @return a short description of the source section
109 */
110 String getShortDescription();
111
112 }