truffle: graal/com.oracle.truffle.api/src/com/oracle/truffle/api/source/Source.java annotate

author	Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date	Fri, 06 Jun 2014 22:13:00 -0700
parents
children	6f7d3f3703d3

rev	line source
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1 /*
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	2 * Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved.
74e142bd2b12 Truffle/Source: major API revision 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.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	4 *
74e142bd2b12 Truffle/Source: major API revision 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
74e142bd2b12 Truffle/Source: major API revision 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
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	7 * published by the Free Software Foundation. Oracle designates this
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	8 * particular file as subject to the "Classpath" exception as provided
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	9 * by Oracle in the LICENSE file that accompanied this code.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	10 *
74e142bd2b12 Truffle/Source: major API revision 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
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
74e142bd2b12 Truffle/Source: major API revision 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
74e142bd2b12 Truffle/Source: major API revision 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
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	15 * accompanied this code).
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	16 *
74e142bd2b12 Truffle/Source: major API revision 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
74e142bd2b12 Truffle/Source: major API revision 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,
74e142bd2b12 Truffle/Source: major API revision 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.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	20 *
74e142bd2b12 Truffle/Source: major API revision 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
74e142bd2b12 Truffle/Source: major API revision 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
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	23 * questions.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	24 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	25 package com.oracle.truffle.api.source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	26
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	27 import java.io.*;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	28 import java.lang.ref.*;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	29 import java.net.*;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	30 import java.util.*;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	31
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	32 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	33 * Representation of a guest language source code unit and its contents. Sources originate in
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	34 * several ways:
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	35 * <ul>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	36 * <li><strong>Literal:</strong> A named text string. These are not indexed and should be considered
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	37 * value objects; equality is defined based on contents. <br>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	38 * See {@link Source#fromText(String, String)}</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	39 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	40 * <li><strong>File:</strong> Each file is represented as a canonical object, indexed by the
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	41 * absolute, canonical path name of the file. File contents are <em>read lazily</em> and contents
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	42 * optionally <em>cached</em>. <br>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	43 * See {@link Source#fromFileName(String)}<br>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	44 * See {@link Source#fromFileName(String, boolean)}</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	45 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	46 * <li><strong>URL:</strong> Each URL source is represented as a canonical object, indexed by the
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	47 * URL. Contents are <em>read eagerly</em> and <em>cached</em>. <br>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	48 * See {@link Source#fromURL(URL, String)}</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	49 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	50 * <li><strong>Reader:</strong> Contents are <em>read eagerly</em> and treated as a <em>Literal</em>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	51 * . <br>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	52 * See {@link Source#fromReader(Reader, String)}</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	53 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	54 * <li><strong>Pseudo File:</strong> A literal text string that can be retrieved by name as if it
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	55 * were a file, unlike literal sources; useful for testing. <br>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	56 * See {@link Source#asPseudoFile(String, String)}</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	57 * </ul>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	58 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	59 * <strong>File cache:</strong>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	60 * <ol>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	61 * <li>File content caching is optional, <em>off</em> by default.</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	62 * <li>The first access to source file contents will result in the contents being read, and (if
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	63 * enabled) cached.</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	64 * <li>If file contents have been cached, access to contents via {@link Source#getInputStream()} or
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	65 * {@link Source#getReader()} will be provided from the cache.</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	66 * <li>Any access to file contents via the cache will result in a timestamp check and possible cache
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	67 * reload.</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	68 * </ol>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	69 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	70 public abstract class Source {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	71
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	72 // TODO (mlvdv) consider canonicalizing and reusing SourceSection instances
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	73 // TOOD (mlvdv) connect SourceSections into a spatial tree for fast geometric lookup
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	74
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	75 // Files and pseudo files are indexed.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	76 private static final Map<String, WeakReference<Source>> filePathToSource = new HashMap<>();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	77
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	78 private static boolean fileCacheEnabled = true;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	79
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	80 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	81 * Gets the canonical representation of a source file, whose contents will be read lazily and
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	82 * then cached.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	83 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	84 * @param fileName name
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	85 * @param reset forces any existing {@link Source} cache to be cleared, forcing a re-read
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	86 * @return canonical representation of the file's contents.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	87 * @throws IOException if the file can not be read
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	88 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	89 public static Source fromFileName(String fileName, boolean reset) throws IOException {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	90
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	91 final WeakReference<Source> nameRef = filePathToSource.get(fileName);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	92 Source source = nameRef == null ? null : nameRef.get();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	93 if (source == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	94 final File file = new File(fileName);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	95 if (!file.canRead()) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	96 throw new IOException("Can't read file " + fileName);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	97 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	98 final String path = file.getCanonicalPath();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	99 final WeakReference<Source> pathRef = filePathToSource.get(path);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	100 source = pathRef == null ? null : pathRef.get();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	101 if (source == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	102 source = new FileSource(file, fileName, path);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	103 filePathToSource.put(path, new WeakReference<>(source));
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	104 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	105 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	106 if (reset) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	107 source.reset();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	108 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	109 return source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	110 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	111
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	112 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	113 * Gets the canonical representation of a source file, whose contents will be read lazily and
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	114 * then cached.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	115 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	116 * @param fileName name
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	117 * @return canonical representation of the file's contents.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	118 * @throws IOException if the file can not be read
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	119 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	120 public static Source fromFileName(String fileName) throws IOException {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	121 return fromFileName(fileName, false);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	122 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	123
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	124 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	125 * Creates a non-canonical source from literal text.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	126 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	127 * @param code textual source code
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	128 * @param description a note about the origin, for error messages and debugging
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	129 * @return a newly created, non-indexed source representation
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	130 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	131 public static Source fromText(String code, String description) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	132 assert code != null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	133 return new LiteralSource(description, code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	134 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	135
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	136 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	137 * Creates a source whose contents will be read immediately from a URL and cached.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	138 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	139 * @param url
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	140 * @param name identifies the origin, possibly useful for debugging
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	141 * @return a newly created, non-indexed source representation
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	142 * @throws IOException if reading fails
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	143 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	144 public static Source fromURL(URL url, String name) throws IOException {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	145 return URLSource.get(url, name);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	146 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	147
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	148 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	149 * Creates a source whose contents will be read immediately and cached.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	150 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	151 * @param reader
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	152 * @param description a note about the origin, possibly useful for debugging
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	153 * @return a newly created, non-indexed source representation
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	154 * @throws IOException if reading fails
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	155 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	156 public static Source fromReader(Reader reader, String description) throws IOException {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	157 return new LiteralSource(description, read(reader));
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	158 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	159
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	160 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	161 * Creates a source from literal text, but which acts as a file and can be retrieved by name
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	162 * (unlike other literal sources); intended for testing.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	163 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	164 * @param code textual source code
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	165 * @param pseudoFileName string to use for indexing/lookup
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	166 * @return a newly created, source representation, canonical with respect to its name
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	167 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	168 public static Source asPseudoFile(String code, String pseudoFileName) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	169 final Source source = new LiteralSource(pseudoFileName, code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	170 filePathToSource.put(pseudoFileName, new WeakReference<>(source));
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	171 return source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	172 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	173
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	174 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	175 * Enables/disables caching of file contents, <em>disabled</em> by default. Caching of sources
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	176 * created from literal text or readers is always enabled.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	177 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	178 public static void setFileCaching(boolean enabled) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	179 fileCacheEnabled = enabled;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	180 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	181
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	182 private static String read(Reader reader) throws IOException {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	183 final StringBuilder builder = new StringBuilder();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	184 final char[] buffer = new char[1024];
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	185
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	186 while (true) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	187 final int n = reader.read(buffer);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	188 if (n == -1) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	189 break;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	190 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	191 builder.append(buffer, 0, n);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	192 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	193
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	194 return builder.toString();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	195 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	196
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	197 protected Source() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	198 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	199
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	200 protected TextMap textMap = null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	201
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	202 protected abstract void reset();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	203
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	204 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	205 * Returns the name of this resource holding a guest language program. An example would be the
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	206 * name of a guest language source code file.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	207 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	208 * @return the name of the guest language program
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	209 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	210 public abstract String getName();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	211
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	212 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	213 * Returns a short version of the name of the resource holding a guest language program (as
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	214 * described in @getName). For example, this could be just the name of the file, rather than a
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	215 * full path.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	216 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	217 * @return the short name of the guest language program
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	218 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	219 public abstract String getShortName();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	220
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	221 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	222 * The normalized, canonical name if the source is a file.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	223 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	224 public abstract String getPath();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	225
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	226 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	227 * The URL if the source is retrieved via URL.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	228 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	229 public abstract URL getURL();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	230
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	231 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	232 * Access to the source contents.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	233 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	234 public abstract Reader getReader();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	235
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	236 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	237 * Access to the source contents.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	238 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	239 public final InputStream getInputStream() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	240 return new ByteArrayInputStream(getCode().getBytes());
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	241 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	242
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	243 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	244 * Return the complete text of the code.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	245 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	246 public abstract String getCode();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	247
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	248 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	249 * Gets the text (not including a possible terminating newline) in a (1-based) numbered line.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	250 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	251 public final String getCode(int lineNumber) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	252 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	253 final int offset = textMap.lineStartOffset(lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	254 final int length = textMap.lineLength(lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	255 return getCode().substring(offset, offset + length);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	256 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	257
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	258 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	259 * The number of text lines in the source, including empty lines; characters at the end of the
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	260 * source without a terminating newline count as a line.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	261 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	262 public final int getLineCount() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	263 return checkTextMap().lineCount();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	264 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	265
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	266 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	267 * Given a 0-based character offset, return the 1-based number of the line that includes the
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	268 * position.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	269 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	270 public final int getLineNumber(int offset) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	271 return checkTextMap().offsetToLine(offset);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	272 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	273
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	274 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	275 * Given a 1-based line number, return the 0-based offset of the first character in the line.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	276 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	277 public final int getLineStartOffset(int lineNumber) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	278 return checkTextMap().lineStartOffset(lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	279 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	280
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	281 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	282 * The number of characters (not counting a possible terminating newline) in a (1-based)
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	283 * numbered line.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	284 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	285 public final int getLineLength(int lineNumber) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	286 return checkTextMap().lineLength(lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	287 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	288
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	289 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	290 * Creates a representation of a contiguous region of text in the source.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	291 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	292 * This method performs no checks on the validity of the arguments.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	293 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	294 * The resulting representation defines hash/equality around equivalent location, presuming that
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	295 * {@link Source} representations are canonical.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	296 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	297 * @param identifier terse description of the region
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	298 * @param startLine 1-based line number of the first character in the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	299 * @param startColumn 1-based column number of the first character in the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	300 * @param charIndex the 0-based index of the first character of the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	301 * @param length the number of characters in the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	302 * @return newly created object representing the specified region
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	303 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	304 public final SourceSection createSection(String identifier, int startLine, int startColumn, int charIndex, int length) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	305 return new DefaultSourceSection(this, identifier, startLine, startColumn, charIndex, length);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	306 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	307
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	308 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	309 * Creates a representation of a contiguous region of text in the source. Computes the
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	310 * {@code charIndex} value by building a {@linkplain TextMap map} of lines in the source.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	311 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	312 * Checks the position arguments for consistency with the source.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	313 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	314 * The resulting representation defines hash/equality around equivalent location, presuming that
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	315 * {@link Source} representations are canonical.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	316 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	317 * @param identifier terse description of the region
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	318 * @param startLine 1-based line number of the first character in the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	319 * @param startColumn 1-based column number of the first character in the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	320 * @param length the number of characters in the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	321 * @return newly created object representing the specified region
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	322 * @throws IllegalArgumentException if arguments are outside the text of the source
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	323 * @throws IllegalStateException if the source is one of the "null" instances
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	324 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	325 public final SourceSection createSection(String identifier, int startLine, int startColumn, int length) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	326 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	327 final int lineStartOffset = textMap.lineStartOffset(startLine);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	328 if (startColumn > textMap.lineLength(startLine)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	329 throw new IllegalArgumentException("column out of range");
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	330 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	331 final int startOffset = lineStartOffset + startColumn - 1;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	332 return new DefaultSourceSection(this, identifier, startLine, startColumn, startOffset, length);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	333 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	334
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	335 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	336 * Creates a representation of a contiguous region of text in the source. Computes the
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	337 * {@code (startLine, startColumn)} values by building a {@linkplain TextMap map} of lines in
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	338 * the source.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	339 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	340 * Checks the position arguments for consistency with the source.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	341 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	342 * The resulting representation defines hash/equality around equivalent location, presuming that
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	343 * {@link Source} representations are canonical.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	344 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	345 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	346 * @param identifier terse description of the region
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	347 * @param charIndex 0-based position of the first character in the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	348 * @param length the number of characters in the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	349 * @return newly created object representing the specified region
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	350 * @throws IllegalArgumentException if either of the arguments are outside the text of the
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	351 * source
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	352 * @throws IllegalStateException if the source is one of the "null" instances
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	353 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	354 public final SourceSection createSection(String identifier, int charIndex, int length) throws IllegalArgumentException {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	355 final int codeLength = getCode().length();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	356 if (!(charIndex >= 0 && length >= 0 && charIndex + length <= codeLength)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	357 throw new IllegalArgumentException("text positions out of range");
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	358 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	359 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	360 final int startLine = getLineNumber(charIndex);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	361 final int startColumn = charIndex - getLineStartOffset(startLine) + 1;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	362
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	363 return new DefaultSourceSection(this, identifier, startLine, startColumn, charIndex, length);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	364 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	365
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	366 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	367 * Creates a representation of a line of text in the source identified only by line number, from
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	368 * which the character information will be computed.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	369 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	370 * @param identifier terse description of the line
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	371 * @param lineNumber 1-based line number of the first character in the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	372 * @return newly created object representing the specified line
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	373 * @throws IllegalArgumentException if the line does not exist the source
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	374 * @throws IllegalStateException if the source is one of the "null" instances
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	375 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	376 public final SourceSection createSection(String identifier, int lineNumber) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	377 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	378 final int charIndex = textMap.lineStartOffset(lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	379 final int length = textMap.lineLength(lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	380 return createSection(identifier, charIndex, length);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	381 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	382
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	383 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	384 * Creates a representation of a line number in this source, suitable for use as a hash table
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	385 * key with equality defined to mean equivalent location.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	386 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	387 * @param lineNumber a 1-based line number in this source
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	388 * @return a representation of a line in this source
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	389 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	390 public final LineLocation createLineLocation(int lineNumber) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	391 return new LineLocationImpl(this, lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	392 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	393
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	394 private TextMap checkTextMap() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	395 if (textMap == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	396 final String code = getCode();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	397 if (code == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	398 throw new RuntimeException("can't read file " + getName());
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	399 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	400 textMap = new TextMap(code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	401 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	402 return textMap;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	403 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	404
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	405 private static final class LiteralSource extends Source {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	406
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	407 private final String name; // Name used originally to describe the source
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	408 private final String code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	409
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	410 public LiteralSource(String name, String code) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	411 this.name = name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	412 this.code = code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	413 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	414
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	415 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	416 public String getName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	417 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	418 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	419
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	420 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	421 public String getShortName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	422 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	423 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	424
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	425 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	426 public String getCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	427 return code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	428 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	429
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	430 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	431 public String getPath() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	432 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	433 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	434
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	435 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	436 public URL getURL() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	437 return null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	438 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	439
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	440 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	441 public Reader getReader() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	442 return new StringReader(code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	443 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	444
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	445 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	446 protected void reset() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	447 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	448
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	449 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	450 public int hashCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	451 final int prime = 31;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	452 int result = 1;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	453 result = prime * result + name.hashCode();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	454 result = prime * result + (code == null ? 0 : code.hashCode());
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	455 return result;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	456 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	457
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	458 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	459 public boolean equals(Object obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	460 if (this == obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	461 return true;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	462 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	463 if (obj == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	464 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	465 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	466 if (!(obj instanceof LiteralSource)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	467 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	468 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	469 LiteralSource other = (LiteralSource) obj;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	470 return name.equals(other.name) && code.equals(other.code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	471 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	472
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	473 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	474
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	475 private static final class FileSource extends Source {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	476
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	477 private final File file;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	478 private final String name; // Name used originally to describe the source
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	479 private final String path; // Normalized path description of an actual file
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	480
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	481 private String code = null; // A cache of the file's contents
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	482 private long timeStamp; // timestamp of the cache in the file system
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	483
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	484 public FileSource(File file, String name, String path) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	485 this.file = file;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	486 this.name = name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	487 this.path = path;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	488 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	489
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	490 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	491 public String getName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	492 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	493 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	494
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	495 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	496 public String getShortName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	497 return file.getName();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	498 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	499
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	500 @Override

16068

74e142bd2b12 Truffle/Source: major API revision