• Home
• org.pkl-lang
• pkl-config-java-all
• 0.27.0
• source code
• SourceSection.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.pkl.thirdparty.graalvm.polyglot.SourceSection Maven / Gradle / Ivy

/*
 * Copyright (c) 2017, 2022, 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 org.pkl.thirdparty.graalvm.polyglot;

import org.pkl.thirdparty.graalvm.polyglot.impl.AbstractPolyglotImpl.AbstractSourceSectionDispatch;

/**
 * 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 are
 * designed to be used as keys in hash maps.
 *
 * @since 19.0
 */
public final class SourceSection {

    final Source source;
    final AbstractSourceSectionDispatch dispatch;
    final Object receiver;

    SourceSection(Source source, AbstractSourceSectionDispatch dispatch, Object receiver) {
        this.source = source;
        this.dispatch = dispatch;
        this.receiver = receiver;
    }

    /**
     * Returns whether this is a special instance that signifies that source information is
     * available. 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.
     *
     * @since 19.0
     */
    public boolean isAvailable() {
        return dispatch.isAvailable(receiver);
    }

    /**
     * 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 boolean hasLines() {
        return dispatch.hasLines(receiver);
    }

    /**
     * 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 boolean hasColumns() {
        return dispatch.hasColumns(receiver);
    }

    /**
     * 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 boolean hasCharIndex() {
        return dispatch.hasCharIndex(receiver);
    }

    /**
     * Representation of the source program that contains this section.
     *
     * @return the source object.
     * @since 19.0
     */
    public 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 19.0
     */
    public int getStartLine() {
        return dispatch.getStartLine(receiver);
    }

    /**
     * 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 19.0
     */
    public int getStartColumn() {
        return dispatch.getStartColumn(receiver);
    }

    /**
     * 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 19.0
     */
    public int getEndLine() {
        return dispatch.getEndLine(receiver);
    }

    /**
     * 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 19.0
     */
    public int getEndColumn() {
        return dispatch.getEndColumn(receiver);
    }

    /**
     * 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 19.0
     */
    public int getCharIndex() {
        return dispatch.getCharIndex(receiver);
    }

    /**
     * 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 19.0
     */
    public int getCharLength() {
        return dispatch.getCharLength(receiver);
    }

    /**
     * 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 19.0
     */
    public int getCharEndIndex() {
        return dispatch.getCharEndIndex(receiver);
    }

    /**
     * @since 19.0
     * @deprecated use {@link #getCharacters()} instead.
     */
    @Deprecated(since = "19.0")
    public CharSequence getCode() {
        return dispatch.getCode(receiver);
    }

    /**
     * Returns the source code fragment described by this section. Returns an empty string for out
     * of bounds or {@link #isAvailable() unavailable} source sections.
     *
     * @return the code as a string.
     * @since 19.0
     */
    public CharSequence getCharacters() {
        return dispatch.getCode(receiver);
    }

    /**
     * Returns an implementation-defined string representation of this source section to be used for
     * debugging purposes only.
     *
     * @see #getCharacters()
     * @since 19.0
     */
    @Override
    public String toString() {
        return dispatch.toString(receiver);
    }

    /** @since 19.0 or earlier */
    @Override
    public int hashCode() {
        return dispatch.hashCode(receiver);
    }

    /** @since 19.0 or earlier */
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }

        Object otherImpl = obj;
        if (otherImpl instanceof SourceSection) {
            otherImpl = ((SourceSection) obj).receiver;
        }
        return dispatch.equals(receiver, otherImpl);
    }

}