com.oracle.truffle.api.source.SourceSection Maven / Gradle / Ivy
Show all versions of truffle-api Show documentation
/*
* Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.oracle.truffle.api.source;
/**
* Description of contiguous section of text within a {@link Source} of program code.; supports
* multiple modes of access to the text and its location.
*
* Two available source sections are considered equal if their sources, start and length are equal.
* {@link #isAvailable() Unavailable} source sections are compared by identity. Source sections can
* be used as keys in hash maps.
*
* @see Source#createSection(int)
* @see Source#createSection(int, int)
* @see Source#createSection(int, int, int)
* @see Source#createSection(int, int, int, int)
* @see Source#createUnavailableSection()
* @since 0.8 or earlier
*/
public abstract class SourceSection {
final Source source;
SourceSection(Source source) {
assert source != null;
this.source = source;
}
/**
* Returns whether this is a special instance that signifies that source information is
* available. Unavailable source sections can be created using
* {@link Source#createUnavailableSection()}. Available source sections are never equal to
* unavailable source sections. Unavailable source sections return the same indices and lengths
* as empty source sections starting at character index 0.
*
* @see Source#createUnavailableSection()
* @since 0.18
*/
public abstract boolean isAvailable();
/**
* Returns whether the source section is in bounds of the {@link #getSource() source}
* {@link Source#getCharacters() code}.
*/
abstract boolean isValid();
/**
* Returns true if this section has a line number information, false
* otherwise. When true, {@link #getStartLine()} and {@link #getEndLine()} return
* valid line numbers, when false, {@link #getStartLine()} and
* {@link #getEndLine()} return 1.
*
* @since 19.0
*/
public abstract boolean hasLines();
/**
* Returns true if this section has a column number information, false
* otherwise. When true, {@link #hasLines()} is true as well,
* {@link #getStartColumn()} and {@link #getEndColumn()} return valid column numbers. When
* false, {@link #getStartColumn()} and {@link #getEndColumn()} return
* 1.
*
* @since 19.0
*/
public abstract boolean hasColumns();
/**
* Returns true if this section has a character index information,
* false otherwise. When true, {@link #getCharIndex()},
* {@link #getCharEndIndex()} and {@link #getCharLength()} return valid character indices, when
* false, {@link #getCharIndex()}, {@link #getCharEndIndex()} and
* {@link #getCharLength()} return 0.
*
* @since 19.0
*/
public abstract boolean hasCharIndex();
/**
* Representation of the source program that contains this section.
*
* @return the source object
* @since 0.8 or earlier
*/
public final Source getSource() {
return source;
}
/**
* Returns 1-based line number of the first character in this section (inclusive). Returns
* 1 for out of bounds or {@link #isAvailable() unavailable} source sections, or
* source sections not {@link #hasLines() having lines}.
*
* @return the starting line number
* @see #hasLines()
* @since 0.8 or earlier
*/
public abstract int getStartLine();
/**
* Returns the 1-based column number of the first character in this section (inclusive). Returns
* 1 for out of bounds or {@link #isAvailable() unavailable} source sections, or
* source sections not {@link #hasColumns() having columns}.
*
* @return the starting column number
* @see #hasColumns()
* @since 0.8 or earlier
*/
public abstract int getStartColumn();
/**
* Returns 1-based line number of the last character in this section (inclusive). Returns
* 1 for out of bounds or {@link #isAvailable() unavailable} source sections, or
* source sections not {@link #hasLines() having lines}.
*
* @return the starting line number
* @see #hasLines()
* @since 0.8 or earlier
*/
public abstract int getEndLine();
/**
* Returns the 1-based column number of the last character in this section (inclusive). Returns
* 1 for out of bounds or {@link #isAvailable() unavailable} source sections, or
* source sections not {@link #hasColumns() having columns}.
*
* @return the starting column number
* @see #hasColumns()
* @since 0.8 or earlier
*/
public abstract int getEndColumn();
/**
* Returns the 0-based index of the first character in this section. Returns 0 for
* {@link #isAvailable() unavailable} source sections, or sections not {@link #hasCharIndex()
* having character index}. The returned index might be out of bounds of the source code if
* assertions (-ea) are not enabled.
*
* @return the starting character index
* @see #hasCharIndex()
* @since 0.8 or earlier
*/
public abstract int getCharIndex();
/**
* Returns the length of this section in characters. Returns 0 for
* {@link #isAvailable() unavailable} source sections, or sections not {@link #hasCharIndex()
* having character index}. The returned length might be out of bounds of the source code if
* assertions (-ea) are not enabled.
*
* @return the number of characters in the section
* @see #hasCharIndex()
* @since 0.8 or earlier
*/
public abstract int getCharLength();
/**
* Returns the index of the text position immediately following the last character in the
* section. Returns 0 for {@link #isAvailable() unavailable} source sections, or
* sections not {@link #hasCharIndex() having character index}. The returned index might be out
* of bounds of the source code if assertions (-ea) are not enabled.
*
* @return the end position of the section
* @see #hasCharIndex()
* @since 0.8 or earlier
*/
public abstract int getCharEndIndex();
/**
* Returns the source code fragment described by this section. Returns an empty character
* sequence for out of bounds or {@link #isAvailable() unavailable} source sections, or sections
* whose source does not {@link Source#hasCharacters() have characters}.
*
* @return the code as a CharSequence
* @see Source#hasCharacters()
* @since 0.28
*/
public abstract CharSequence getCharacters();
/**
* Returns an implementation-defined string representation of this source section to be used for
* debugging purposes only.
*
* @see #getCharacters()
* @since 0.8 or earlier
*/
@Override
public final String toString() {
StringBuilder b = new StringBuilder();
b.append("SourceSection(source=").append(getSource().getName());
if (isAvailable()) {
if (hasLines()) {
b.append(" [").append(getStartLine());
if (hasColumns()) {
b.append(':').append(getStartColumn());
}
b.append(" - ").append(getEndLine());
if (hasColumns()) {
b.append(':').append(getEndColumn());
}
b.append("]");
}
if (hasCharIndex()) {
b.append(", index=").append(getCharIndex());
b.append(", length=").append(getCharLength());
}
if (isValid()) {
if (source.hasCharacters()) {
b.append(", characters=").append(getCharacters().toString().replaceAll("\\n", "\\\\n"));
} else {
b.append(", characters not known");
}
} else {
b.append(", valid=false");
}
} else {
b.append(" available=false");
}
b.append(")");
return b.toString();
}
/** @since 0.8 or earlier */
@Override
public abstract int hashCode();
/** @since 0.8 or earlier */
@Override
public abstract boolean equals(Object obj);
}