Mercurial > hg > graal-compiler
view graal/com.oracle.truffle.api/src/com/oracle/truffle/api/Source.java @ 16051:da9b9b625818
Truffle FrameDescriptor: add compiler asserts
author | Bernhard Urban <bernhard.urban@jku.at> |
---|---|
date | Fri, 06 Jun 2014 09:40:22 +0200 |
parents | ebdeb414d64c |
children |
line wrap: on
line source
/* * Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.oracle.truffle.api; import java.io.*; import java.net.*; import com.oracle.truffle.api.source.*; /** * Represents a unit of guest language source code. */ public interface Source { /** * Returns the name of this resource holding a guest language program. An example would be the * name of a guest language source code file. * * @return the name of the guest language program */ String getName(); /** * Returns a short version of the name of the resource holding a guest language program (as * described in @getName). For example, this could be just the name of the file, rather than a * full path. * * @return the short name of the guest language program */ String getShortName(); /** * The normalized, canonical name if the source is a file. */ String getPath(); /** * The URL if the source is retrieved via URL. */ URL getURL(); /** * Access to the source contents. */ Reader getReader(); /** * Access to the source contents. */ InputStream getInputStream(); /** * Return the complete text of the code. */ String getCode(); /** * Given a 1-based line number, return the text in the line, not including a possible * terminating newline. */ String getCode(int lineNumber); /** * The number of text lines in the source, including empty lines; characters at the end of the * source without a terminating newline count as a line. */ int getLineCount(); /** * Given a 0-based character offset, return the 1-based number of the line that includes the * position. */ int getLineNumber(int offset); /** * Given a 1-based line number, return the 0-based offset of the first character in the line. */ int getLineStartOffset(int lineNumber); /** * The number of characters (not counting a possible terminating newline) in a (1-based) * numbered line. */ int getLineLength(int lineNumber); /** * Creates a representation of a contiguous region of text in the source. Computes the * {@code (startLine, startColumn)} values by building a {@linkplain TextMap map} of lines in * the source. * <p> * Checks the position arguments for consistency with the source. * <p> * The resulting representation defines hash/equality around equivalent location, presuming that * {@link Source} representations are cannonical. * * * @param identifier terse description of the region * @param charIndex 0-based position of the first character in the section * @param length the number of characters in the section * @return newly created object representing the specified region * @throws IllegalArgumentException if either of the arguments are outside the text of the * source * @throws IllegalStateException if the source is one of the "null" instances */ SourceSection createSection(String identifier, int charIndex, int length) throws IllegalArgumentException, IllegalStateException; /** * Creates a representation of a contiguous region of text in the source. Computes the * {@code charIndex} value by building a {@linkplain TextMap map} of lines in the source. * <p> * Checks the position arguments for consistency with the source. * <p> * The resulting representation defines hash/equality around equivalent location, presuming that * {@link Source} representations are cannonical. * * @param identifier terse description of the region * @param startLine 1-based line number of the first character in the section * @param startColumn 1-based column number of the first character in the section * @param length the number of characters in the section * @return newly created object representing the specified region * @throws IllegalArgumentException if arguments are outside the text of the source * @throws IllegalStateException if the source is one of the "null" instances */ SourceSection createSection(String identifier, int startLine, int startColumn, int length); /** * Creates a representation of a contiguous region of text in the source. * <p> * This method performs no checks on the validity of the arguments. * <p> * The resulting representation defines hash/equality around equivalent location, presuming that * {@link Source} representations are cannonical. * * @param identifier terse description of the region * @param startLine 1-based line number of the first character in the section * @param startColumn 1-based column number of the first character in the section * @param charIndex the 0-based index of the first character of the section * @param length the number of characters in the section * @return newly created object representing the specified region */ SourceSection createSection(String identifier, int startLine, int startColumn, int charIndex, int length); }