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

annotate graal/com.oracle.truffle.api/src/com/oracle/truffle/api/source/Source.java @ 21291:70bbc530a2d3

Truffle/Source: - factory methods for a new kind of Source representing the contents of a sub-range of an existing Source; - hide the Appendable subclass; Source.append() now throws UnsupportedOperationException if called on a non-appendable subclass.

author	Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date	Mon, 11 May 2015 16:49:57 -0700
parents	1516d26e8f2b
children	8eadc82f4a93

rev	line source
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1 /*
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	2 * Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.
16068 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
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	32 import com.oracle.truffle.api.instrument.*;
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	33
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	34 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	35 * 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	36 * several ways:
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	37 * <ul>
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	38 * <li><strong>Literal:</strong> An anonymous text string: not named and not indexed. These should
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	39 * be considered value objects; equality is defined based on contents.<br>
18672 f17b2a0303db Truffle/Source: change signature of Source factory methods to take literal text as CharSequence instead of String. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	40 * See {@link Source#fromText(CharSequence, String)}</li>
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	41 * <p>
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	42 * <li><strong>Named Literal:</strong> A text string that can be retrieved by name as if it were a
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	43 * file, but without any assumption that the name is related to a file path. Creating a new literal
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	44 * with an already existing name will replace its predecessor in the index.<br>
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	45 * See {@link Source#fromNamedText(CharSequence, String)}<br>
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	46 * See {@link Source#find(String)}</li>
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	47 * <p>
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	48 * <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	49 * 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	50 * optionally <em>cached</em>. <br>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	51 * See {@link Source#fromFileName(String)}<br>
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	52 * See {@link Source#fromFileName(String, boolean)}<br>
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	53 * See {@link Source#find(String)}</li>
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	54 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	55 * <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	56 * URL. Contents are <em>read eagerly</em> and <em>cached</em>. <br>
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	57 * See {@link Source#fromURL(URL, String)}<br>
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	58 * See {@link Source#find(String)}</li>
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	59 * <p>
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	60 * <li><strong>Reader:</strong> Contents are <em>read eagerly</em> and treated as an anonymous
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	61 * (non-indexed) <em>Literal</em> . <br>
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	62 * See {@link Source#fromReader(Reader, String)}</li>
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	63 * <p>
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	64 * <li><strong>Sub-Source:</strong> A representation of the contents of a sub-range of another
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	65 * {@link Source}.<br>
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	66 * See @link {@link Source#subSource(Source, int, int)}<br>
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	67 * See @link {@link Source#subSource(Source, int)}</li>
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	68 * <p>
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	69 * <li><strong>AppendableSource:</strong> Literal contents are provided by the client,
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	70 * incrementally, after the instance is created.<br>
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	71 * See {@link Source#fromAppendableText(String)}<br>
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	72 * See {@link Source#fromNamedAppendableText(String)}</li>
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	73 * </ul>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	74 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	75 * <strong>File cache:</strong>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	76 * <ol>
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	77 * <li>File content caching is optional, <em>on</em> by default.</li>
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	78 * <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	79 * enabled) cached.</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	80 * <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	81 * {@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	82 * <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	83 * reload.</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	84 * </ol>
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	85 * <p>
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	86 *
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	87 * @see SourceTag
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	88 * @see SourceListener
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	89 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	90 public abstract class Source {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	91
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	92 // 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	93 // 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	94
20906 c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	95 public enum Tags implements SourceTag {
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	96
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	97 /**
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	98 * From bytes.
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	99 */
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	100 FROM_BYTES("bytes", "read from bytes"),
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	101
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	102 /**
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	103 * Read from a file.
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	104 */
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	105 FROM_FILE("file", "read from a file"),
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	106
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	107 /**
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	108 * From literal text.
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	109 */
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	110 FROM_LITERAL("literal", "from literal text"),
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	111
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	112 /**
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	113 * From a {@linkplain java.io.Reader Reader}.
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	114 */
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	115 FROM_READER("reader", "read from a Java Reader"),
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	116
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	117 /**
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	118 * Read from a URL.
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	119 */
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	120 FROM_URL("URL", "read from a URL");
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	121
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	122 private final String name;
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	123 private final String description;
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	124
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	125 private Tags(String name, String description) {
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	126 this.name = name;
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	127 this.description = description;
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	128 }
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	129
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	130 public String getName() {
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	131 return name;
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	132 }
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	133
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	134 public String getDescription() {
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	135 return description;
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	136 }
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	137
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	138 }
c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	139
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	140 /**
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	141 * All Sources that have been created.
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	142 */
20022 eebf140fa6e4 syncronize the access to Source.allSources. Should fix random crashes we experienced before. Christian Wirth <christian.wirth@oracle.com> parents: 19697 diff changeset	143 private static final List<WeakReference<Source>> allSources = Collections.synchronizedList(new ArrayList<WeakReference<Source>>());
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	144
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	145 /**
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	146 * Index of all named sources.
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	147 */
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	148 private static final Map<String, WeakReference<Source>> nameToSource = new HashMap<>();
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	149
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	150 private static boolean fileCacheEnabled = true;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	151
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	152 private static final List<SourceListener> sourceListeners = new ArrayList<>();
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	153
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	154 /**
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	155 * Locates an existing instance by the name under which it was indexed.
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	156 */
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	157 public static Source find(String name) {
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	158 final WeakReference<Source> nameRef = nameToSource.get(name);
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	159 return nameRef == null ? null : nameRef.get();
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	160 }
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	161
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	162 /**
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	163 * 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	164 * then cached.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	165 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	166 * @param fileName name
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	167 * @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	168 * @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	169 * @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	170 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	171 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	172
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	173 final WeakReference<Source> nameRef = nameToSource.get(fileName);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	174 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	175 if (source == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	176 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	177 if (!file.canRead()) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	178 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	179 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	180 final String path = file.getCanonicalPath();
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	181 final WeakReference<Source> pathRef = nameToSource.get(path);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	182 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	183 if (source == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	184 source = new FileSource(file, fileName, path);
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	185 nameToSource.put(path, new WeakReference<>(source));
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	186 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	187 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	188 if (reset) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	189 source.reset();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	190 }
20906 c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	191 notifyNewSource(source).tagAs(Tags.FROM_FILE);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	192 return source;
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
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 * 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	197 * then cached.
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 * @param fileName name
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	200 * @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	201 * @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	202 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	203 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	204 return fromFileName(fileName, false);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	205 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	206
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	207 /**
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	208 * Gets the canonical representation of a source file, whose contents have already been read and
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	209 * need not be read again. It is confirmed that the file resolves to a file name, so it can be
19690 c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	210 * indexed by canonical path. It is not confirmed that the text supplied agrees with the file's
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	211 * contents or even whether the file is readable.
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	212 *
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	213 * @param chars textual source code already read from the file
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	214 * @param fileName
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	215 * @return canonical representation of the file's contents.
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	216 * @throws IOException if the file cannot be found
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	217 */
19690 c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	218 public static Source fromFileName(CharSequence chars, String fileName) throws IOException {
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	219
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	220 final WeakReference<Source> nameRef = nameToSource.get(fileName);
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	221 Source source = nameRef == null ? null : nameRef.get();
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	222 if (source == null) {
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	223 final File file = new File(fileName);
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	224 // We are going to trust that the fileName is readable.
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	225 final String path = file.getCanonicalPath();
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	226 final WeakReference<Source> pathRef = nameToSource.get(path);
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	227 source = pathRef == null ? null : pathRef.get();
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	228 if (source == null) {
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	229 source = new FileSource(file, fileName, path, chars);
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	230 nameToSource.put(path, new WeakReference<>(source));
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	231 }
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	232 }
20906 c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	233 notifyNewSource(source).tagAs(Tags.FROM_FILE);
19690 c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	234 return source;
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	235 }
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	236
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	237 /**
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	238 * Creates an anonymous source from literal text: not named and not indexed.
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	239 *
18672 f17b2a0303db Truffle/Source: change signature of Source factory methods to take literal text as CharSequence instead of String. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	240 * @param chars textual source code
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	241 * @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	242 * @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	243 */
18672 f17b2a0303db Truffle/Source: change signature of Source factory methods to take literal text as CharSequence instead of String. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	244 public static Source fromText(CharSequence chars, String description) {
f17b2a0303db Truffle/Source: change signature of Source factory methods to take literal text as CharSequence instead of String. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	245 assert chars != null;
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	246 final LiteralSource source = new LiteralSource(description, chars.toString());
20906 c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	247 notifyNewSource(source).tagAs(Tags.FROM_LITERAL);
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	248 return source;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	249 }
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 /**
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	252 * Creates an anonymous source from literal text that is provided incrementally after creation:
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	253 * not named and not indexed.
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	254 *
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	255 * @param description a note about the origin, for error messages and debugging
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	256 * @return a newly created, non-indexed, initially empty, appendable source representation
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	257 */
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	258 public static Source fromAppendableText(String description) {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	259 final Source source = new AppendableLiteralSource(description);
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	260 notifyNewSource(source).tagAs(Tags.FROM_LITERAL);
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	261 return source;
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	262 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	263
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	264 /**
21270 a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	265 * Creates a source from literal text that can be retrieved by name, with no assumptions about
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	266 * the structure or meaning of the name. If the name is already in the index, the new instance
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	267 * will replace the previously existing instance in the index.
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	268 *
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	269 * @param chars textual source code
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	270 * @param name string to use for indexing/lookup
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	271 * @return a newly created, source representation
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	272 */
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	273 public static Source fromNamedText(CharSequence chars, String name) {
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	274 final Source source = new LiteralSource(name, chars.toString());
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	275 nameToSource.put(name, new WeakReference<>(source));
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	276 notifyNewSource(source).tagAs(Tags.FROM_LITERAL);
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	277 return source;
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	278 }
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	279
a43c7adc9d99 Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20906 diff changeset	280 /**
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	281 * Creates a source from literal text that is provided incrementally after creation and which
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	282 * can be retrieved by name, with no assumptions about the structure or meaning of the name. If
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	283 * the name is already in the index, the new instance will replace the previously existing
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	284 * instance in the index.
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	285 *
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	286 * @param name string to use for indexing/lookup
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	287 * @return a newly created, indexed, initially empty, appendable source representation
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	288 */
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	289 public static Source fromNamedAppendableText(String name) {
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	290 final Source source = new AppendableLiteralSource(name);
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	291 nameToSource.put(name, new WeakReference<>(source));
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	292 notifyNewSource(source).tagAs(Tags.FROM_LITERAL);
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	293 return source;
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	294 }
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	295
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	296 /**
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	297 * Creates a {@linkplain Source Source instance} that represents the contents of a sub-range of
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	298 * an existing {@link Source}.
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	299 *
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	300 * @param base an existing Source instance
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	301 * @param baseCharIndex 0-based index of the first character of the sub-range
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	302 * @param length the number of characters in the sub-range
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	303 * @return a new instance representing a sub-range of another Source
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	304 * @throws IllegalArgumentException if the specified sub-range is not contained in the base
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	305 */
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	306 public static Source subSource(Source base, int baseCharIndex, int length) {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	307 final SubSource subSource = SubSource.create(base, baseCharIndex, length);
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	308 return subSource;
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	309 }
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	310
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	311 /**
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	312 * Creates a {@linkplain Source Source instance} that represents the contents of a sub-range at
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	313 * the end of an existing {@link Source}.
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	314 *
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	315 * @param base an existing Source instance
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	316 * @param baseCharIndex 0-based index of the first character of the sub-range
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	317 * @return a new instance representing a sub-range at the end of another Source
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	318 * @throws IllegalArgumentException if the index is out of range
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	319 */
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	320 public static Source subSource(Source base, int baseCharIndex) {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	321 return subSource(base, baseCharIndex, base.getLength() - baseCharIndex);
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	322 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	323
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	324 /**
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	325 * 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	326 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	327 * @param url
18672 f17b2a0303db Truffle/Source: change signature of Source factory methods to take literal text as CharSequence instead of String. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	328 * @param description identifies the origin, possibly useful for debugging
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	329 * @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	330 * @throws IOException if reading fails
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	331 */
18672 f17b2a0303db Truffle/Source: change signature of Source factory methods to take literal text as CharSequence instead of String. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	332 public static Source fromURL(URL url, String description) throws IOException {
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	333 final URLSource source = URLSource.get(url, description);
20906 c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	334 notifyNewSource(source).tagAs(Tags.FROM_URL);
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	335 return source;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	336 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	337
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	338 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	339 * 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	340 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	341 * @param reader
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	342 * @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	343 * @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	344 * @throws IOException if reading fails
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 public static Source fromReader(Reader reader, String description) throws IOException {
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	347 final LiteralSource source = new LiteralSource(description, read(reader));
20906 c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	348 notifyNewSource(source).tagAs(Tags.FROM_READER);
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	349 return source;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	350 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	351
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	352 /**
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	353 * Creates a source from raw bytes. This can be used if the encoding of strings in your language
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	354 * is not compatible with Java strings, or if your parser returns byte indices instead of
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	355 * character indices. The returned source is then indexed by byte, not by character.
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	356 *
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	357 * @param bytes the raw bytes of the source
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	358 * @param description a note about the origin, possibly useful for debugging
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	359 * @param decoder how to decode the bytes into Java strings
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	360 * @return a newly created, non-indexed source representation
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	361 */
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	362 public static Source fromBytes(byte[] bytes, String description, BytesDecoder decoder) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	363 return fromBytes(bytes, 0, bytes.length, description, decoder);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	364 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	365
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	366 /**
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	367 * Creates a source from raw bytes. This can be used if the encoding of strings in your language
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	368 * is not compatible with Java strings, or if your parser returns byte indices instead of
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	369 * character indices. The returned source is then indexed by byte, not by character. Offsets are
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	370 * relative to byteIndex.
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	371 *
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	372 * @param bytes the raw bytes of the source
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	373 * @param byteIndex where the string starts in the byte array
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	374 * @param length the length of the string in the byte array
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	375 * @param description a note about the origin, possibly useful for debugging
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	376 * @param decoder how to decode the bytes into Java strings
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	377 * @return a newly created, non-indexed source representation
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	378 */
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	379 public static Source fromBytes(byte[] bytes, int byteIndex, int length, String description, BytesDecoder decoder) {
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	380 final BytesSource source = new BytesSource(description, bytes, byteIndex, length, decoder);
20906 c8b83aa6cc82 Truffle/Source: remove proposed standard SourceTags; migrate the tags related to Source provenance into thte Source class. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 20038 diff changeset	381 notifyNewSource(source).tagAs(Tags.FROM_BYTES);
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	382 return source;
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	383 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	384
16989 19faa7ca37c1 Truffle/Source: use a synchronized hash table Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16140 diff changeset	385 // TODO (mlvdv) enable per-file choice whether to cache?
16068 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 * 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	388 * 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	389 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	390 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	391 fileCacheEnabled = enabled;
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
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	394 /**
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	395 * Returns all {@link Source}s holding a particular {@link SyntaxTag}, or the whole collection
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	396 * of Sources if the specified tag is {@code null}.
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	397 *
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	398 * @return A collection of Sources containing the given tag.
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	399 */
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	400 public static Collection<Source> findSourcesTaggedAs(SourceTag tag) {
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	401 final List<Source> taggedSources = new ArrayList<>();
20022 eebf140fa6e4 syncronize the access to Source.allSources. Should fix random crashes we experienced before. Christian Wirth <christian.wirth@oracle.com> parents: 19697 diff changeset	402 synchronized (allSources) {
eebf140fa6e4 syncronize the access to Source.allSources. Should fix random crashes we experienced before. Christian Wirth <christian.wirth@oracle.com> parents: 19697 diff changeset	403 for (WeakReference<Source> ref : allSources) {
eebf140fa6e4 syncronize the access to Source.allSources. Should fix random crashes we experienced before. Christian Wirth <christian.wirth@oracle.com> parents: 19697 diff changeset	404 Source source = ref.get();
eebf140fa6e4 syncronize the access to Source.allSources. Should fix random crashes we experienced before. Christian Wirth <christian.wirth@oracle.com> parents: 19697 diff changeset	405 if (source != null) {
eebf140fa6e4 syncronize the access to Source.allSources. Should fix random crashes we experienced before. Christian Wirth <christian.wirth@oracle.com> parents: 19697 diff changeset	406 if (tag == null \|\| source.isTaggedAs(tag)) {
eebf140fa6e4 syncronize the access to Source.allSources. Should fix random crashes we experienced before. Christian Wirth <christian.wirth@oracle.com> parents: 19697 diff changeset	407 taggedSources.add(ref.get());
eebf140fa6e4 syncronize the access to Source.allSources. Should fix random crashes we experienced before. Christian Wirth <christian.wirth@oracle.com> parents: 19697 diff changeset	408 }
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	409 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	410 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	411 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	412 return taggedSources;
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	413 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	414
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	415 /**
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	416 * Adds a {@link SourceListener} to receive events.
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	417 */
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	418 public static void addSourceListener(SourceListener listener) {
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	419 assert listener != null;
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	420 sourceListeners.add(listener);
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	421 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	422
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	423 /**
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	424 * Removes a {@link SourceListener}. Ignored if listener not found.
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	425 */
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	426 public static void removeSourceListener(SourceListener listener) {
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	427 sourceListeners.remove(listener);
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	428 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	429
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	430 private static Source notifyNewSource(Source source) {
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	431 allSources.add(new WeakReference<>(source));
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	432 for (SourceListener listener : sourceListeners) {
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	433 listener.sourceCreated(source);
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	434 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	435 return source;
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	436 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	437
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	438 private static String read(Reader reader) throws IOException {
18672 f17b2a0303db Truffle/Source: change signature of Source factory methods to take literal text as CharSequence instead of String. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	439 final BufferedReader bufferedReader = new BufferedReader(reader);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	440 final StringBuilder builder = new StringBuilder();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	441 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	442
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	443 while (true) {
18672 f17b2a0303db Truffle/Source: change signature of Source factory methods to take literal text as CharSequence instead of String. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18485 diff changeset	444 final int n = bufferedReader.read(buffer);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	445 if (n == -1) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	446 break;
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 builder.append(buffer, 0, n);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	449 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	450
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	451 return builder.toString();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	452 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	453
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	454 private static final class SubSource extends Source {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	455 private final Source base;
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	456 private final int baseIndex;
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	457 private final int subLength;
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	458
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	459 private static SubSource create(Source base, int baseIndex, int length) {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	460 if (baseIndex < 0 \|\| length < 0 \|\| baseIndex + length > base.getLength()) {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	461 throw new IllegalArgumentException("text positions out of range");
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	462 }
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	463 return new SubSource(base, baseIndex, length);
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	464 }
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	465
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	466 private SubSource(Source base, int baseIndex, int length) {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	467 this.base = base;
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	468 this.baseIndex = baseIndex;
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	469 this.subLength = length;
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	470 }
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	471
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	472 @Override
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	473 protected void reset() {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	474 assert false;
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	475 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	476
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	477 @Override
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	478 public String getName() {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	479 return base.getName();
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	480 }
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	481
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	482 @Override
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	483 public String getShortName() {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	484 return base.getShortName();
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	485 }
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	486
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	487 @Override
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	488 public String getPath() {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	489 return base.getPath();
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	490 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	491
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	492 @Override
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	493 public URL getURL() {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	494 return null;
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	495 }
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	496
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	497 @Override
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	498 public Reader getReader() {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	499 assert false;
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	500 return null;
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	501 }
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	502
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	503 @Override
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	504 public String getCode() {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	505 return base.getCode(baseIndex, subLength);
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	506 }
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	507 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	508
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	509 private final ArrayList<SourceTag> tags = new ArrayList<>();
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	510
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	511 private Source() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	512 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	513
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	514 private TextMap textMap = null;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	515
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	516 protected abstract void reset();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	517
19697 191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	518 public final boolean isTaggedAs(SourceTag tag) {
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	519 assert tag != null;
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	520 return tags.contains(tag);
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	521 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	522
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	523 public final Collection<SourceTag> getSourceTags() {
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	524 return Collections.unmodifiableCollection(tags);
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	525 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	526
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	527 /**
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	528 * Adds a {@linkplain SourceTag tag} to the set of tags associated with this {@link Source};
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	529 * {@code no-op} if already in the set.
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	530 *
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	531 * @return this
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	532 */
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	533 public final Source tagAs(SourceTag tag) {
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	534 assert tag != null;
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	535 if (!tags.contains(tag)) {
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	536 tags.add(tag);
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	537 for (SourceListener listener : sourceListeners) {
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	538 listener.sourceTaggedAs(this, tag);
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	539 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	540 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	541 return this;
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	542 }
191c55f08ed2 Truffle: add the ability to "tag" Sources with any number of standard or private tags, for example so that Sources might be marked as "FROM_FILE", "LIBRARY", "BUILTIN", or any other distinction that matters to some tools. Those tags can be applied by the language runtime when sources are created, for example when loading builtins. Alternately, you can listen for newly created sources from outside the implementation, where you might tag sources based on pattern matching against file paths or any other meta-information in the Source. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19690 diff changeset	543
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	544 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	545 * 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	546 * 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	547 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	548 * @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	549 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	550 public abstract String getName();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	551
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	552 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	553 * 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	554 * 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	555 * full path.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	556 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	557 * @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	558 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	559 public abstract String getShortName();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	560
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	561 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	562 * 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	563 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	564 public abstract String getPath();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	565
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	566 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	567 * 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	568 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	569 public abstract URL getURL();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	570
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	571 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	572 * Access to the source contents.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	573 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	574 public abstract Reader getReader();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	575
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	576 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	577 * Access to the source contents.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	578 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	579 public final InputStream getInputStream() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	580 return new ByteArrayInputStream(getCode().getBytes());
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	581 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	582
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	583 /**
19690 c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	584 * Gets the number of characters in the source.
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	585 */
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	586 public final int getLength() {
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	587 return checkTextMap().length();
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	588 }
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	589
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	590 /**
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	591 * Returns the complete text of the code.
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	592 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	593 public abstract String getCode();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	594
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	595 /**
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	596 * Returns a subsection of the code test.
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	597 */
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	598 public String getCode(int charIndex, int charLength) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	599 return getCode().substring(charIndex, charIndex + charLength);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	600 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	601
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	602 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	603 * 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	604 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	605 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	606 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	607 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	608 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	609 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	610 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	611
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	612 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	613 * 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	614 * 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	615 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	616 public final int getLineCount() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	617 return checkTextMap().lineCount();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	618 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	619
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	620 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	621 * 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	622 * position.
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	623 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	624 * @throws IllegalArgumentException if the offset is outside the text contents
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	625 */
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	626 public final int getLineNumber(int offset) throws IllegalArgumentException {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	627 return checkTextMap().offsetToLine(offset);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	628 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	629
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	630 /**
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	631 * Given a 0-based character offset, return the 1-based number of the column at the position.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	632 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	633 * @throws IllegalArgumentException if the offset is outside the text contents
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	634 */
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	635 public final int getColumnNumber(int offset) throws IllegalArgumentException {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	636 return checkTextMap().offsetToCol(offset);
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	637 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	638
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	639 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	640 * Given a 1-based line number, return the 0-based offset of the first character in the line.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	641 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	642 * @throws IllegalArgumentException if there is no such line in the text
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	643 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	644 public final int getLineStartOffset(int lineNumber) throws IllegalArgumentException {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	645 return checkTextMap().lineStartOffset(lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	646 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	647
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	648 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	649 * 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	650 * numbered line.
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	651 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	652 * @throws IllegalArgumentException if there is no such line in the text
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	653 */
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	654 public final int getLineLength(int lineNumber) throws IllegalArgumentException {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	655 return checkTextMap().lineLength(lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	656 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	657
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	658 /**
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	659 * Append text to a Source explicitly created as <em>Appendable</em>.
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	660 *
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	661 * @param chars the text to append
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	662 * @throws UnsupportedOperationException by concrete subclasses that do not support appending
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	663 */
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	664 public void appendCode(CharSequence chars) {
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	665 throw new UnsupportedOperationException();
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	666 }
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	667
70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	668 /**
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	669 * 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	670 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	671 * 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	672 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	673 * 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	674 * {@link Source} representations are canonical.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	675 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	676 * @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	677 * @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	678 * @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	679 * @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	680 * @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	681 * @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	682 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	683 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	684 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	685 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	686
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	687 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	688 * 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	689 * {@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	690 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	691 * 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	692 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	693 * 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	694 * {@link Source} representations are canonical.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	695 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	696 * @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	697 * @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	698 * @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	699 * @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	700 * @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	701 * @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	702 * @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	703 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	704 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	705 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	706 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	707 if (startColumn > textMap.lineLength(startLine)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	708 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	709 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	710 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	711 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	712 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	713
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	714 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	715 * 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	716 * {@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	717 * the source.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	718 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	719 * 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	720 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	721 * 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	722 * {@link Source} representations are canonical.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	723 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	724 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	725 * @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	726 * @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	727 * @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	728 * @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	729 * @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	730 * source
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	731 * @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	732 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	733 public final SourceSection createSection(String identifier, int charIndex, int length) throws IllegalArgumentException {
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	734 checkRange(charIndex, length);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	735 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	736 final int startLine = getLineNumber(charIndex);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	737 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	738
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	739 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	740 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	741
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	742 protected void checkRange(int charIndex, int length) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	743 if (!(charIndex >= 0 && length >= 0 && charIndex + length <= getCode().length())) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	744 throw new IllegalArgumentException("text positions out of range");
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	745 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	746 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	747
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	748 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	749 * 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	750 * 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	751 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	752 * @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	753 * @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	754 * @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	755 * @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	756 * @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	757 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	758 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	759 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	760 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	761 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	762 return createSection(identifier, charIndex, length);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	763 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	764
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	765 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	766 * 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	767 * 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	768 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	769 * @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	770 * @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	771 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	772 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	773 return new LineLocationImpl(this, lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	774 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	775
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	776 /**
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	777 * An object suitable for using as a key into a hashtable that defines equivalence between
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	778 * different source types.
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	779 */
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	780 protected Object getHashKey() {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	781 return getName();
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	782 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	783
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	784 protected final TextMap checkTextMap() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	785 if (textMap == null) {
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	786 textMap = createTextMap();
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	787 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	788 return textMap;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	789 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	790
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	791 protected final void clearTextMap() {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	792 textMap = null;
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	793 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	794
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	795 protected TextMap createTextMap() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	796 final String code = getCode();
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	797 if (code == null) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	798 throw new RuntimeException("can't read file " + getName());
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	799 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	800 return TextMap.fromString(code);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	801 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	802
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	803 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	804
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	805 private final String description;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	806 private final String code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	807
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	808 public LiteralSource(String description, String code) {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	809 this.description = description;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	810 this.code = code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	811 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	812
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	813 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	814 public String getName() {
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	815 return description;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	816 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	817
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	818 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	819 public String getShortName() {
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	820 return description;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	821 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	822
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	823 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	824 public String getCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	825 return code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	826 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	827
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	828 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	829 public String getPath() {
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	830 return description;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	831 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	832
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	833 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	834 public URL getURL() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	835 return null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	836 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	837
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	838 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	839 public Reader getReader() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	840 return new StringReader(code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	841 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	842
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	843 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	844 protected void reset() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	845 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	846
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	847 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	848 public int hashCode() {
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	849 return description.hashCode();
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	850 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	851
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	852 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	853 public boolean equals(Object obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	854 if (this == obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	855 return true;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	856 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	857 if (obj == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	858 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	859 }
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	860 if (obj instanceof LiteralSource) {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	861 LiteralSource other = (LiteralSource) obj;
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	862 return description.equals(other.description);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	863 }
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	864 return false;
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	865 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	866 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	867
21291 70bbc530a2d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21271 diff changeset	868 private static final class AppendableLiteralSource extends Source {
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	869 private String description;
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	870 final List<CharSequence> codeList = new ArrayList<>();
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	871
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	872 public AppendableLiteralSource(String description) {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	873 this.description = description;
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	874 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	875
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	876 @Override
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	877 public String getName() {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	878 return description;
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	879 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	880
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	881 @Override
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	882 public String getShortName() {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	883 return description;
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	884 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	885
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	886 @Override
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	887 public String getCode() {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	888 return getCodeFromIndex(0);
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	889 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	890
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	891 @Override
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	892 public String getPath() {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	893 return description;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	894 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	895
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	896 @Override
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	897 public URL getURL() {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	898 return null;
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	899 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	900
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	901 @Override
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	902 public Reader getReader() {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	903 return new StringReader(getCode());
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	904 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	905
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	906 @Override
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	907 protected void reset() {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	908 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	909
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	910 private String getCodeFromIndex(int index) {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	911 StringBuilder sb = new StringBuilder();
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	912 for (int i = index; i < codeList.size(); i++) {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	913 CharSequence s = codeList.get(i);
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	914 sb.append(s);
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	915 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	916 return sb.toString();
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	917 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	918
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	919 @Override
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	920 public void appendCode(CharSequence chars) {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	921 codeList.add(chars);
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	922 clearTextMap();
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	923 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	924
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	925 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	926
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	927 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	928
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	929 private final File file;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	930 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	931 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	932
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	933 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	934 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	935
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	936 public FileSource(File file, String name, String path) {
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	937 this(file, name, path, null);
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	938 }
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	939
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	940 public FileSource(File file, String name, String path, CharSequence chars) {
18980 ae0eb836e6f4 store absolute file in FileSource Lukas Stadler <lukas.stadler@oracle.com> parents: 18979 diff changeset	941 this.file = file.getAbsoluteFile();
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	942 this.name = name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	943 this.path = path;
19687 787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	944 if (chars != null) {
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	945 this.code = chars.toString();
787b5aa53401 Truffle: new factory method for files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18980 diff changeset	946 }
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	947 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	948
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	949 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	950 public String getName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	951 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	952 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	953
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	954 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	955 public String getShortName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	956 return file.getName();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	957 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	958
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	959 @Override
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	960 protected Object getHashKey() {
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	961 return path;
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	962 }
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	963
1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	964 @Override
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	965 public String getCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	966 if (fileCacheEnabled) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	967 if (code == null \|\| timeStamp != file.lastModified()) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	968 try {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	969 code = read(getReader());
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	970 timeStamp = file.lastModified();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	971 } catch (IOException e) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	972 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	973 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	974 return code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	975 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	976 try {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	977 return read(new FileReader(file));
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	978 } catch (IOException e) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	979 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	980 return null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	981 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	982
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	983 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	984 public String getPath() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	985 return path;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	986 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	987
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	988 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	989 public URL getURL() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	990 return null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	991 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	992
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	993 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	994 public Reader getReader() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	995 if (code != null && timeStamp == file.lastModified()) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	996 return new StringReader(code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	997 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	998 try {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	999 return new FileReader(file);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1000 } catch (FileNotFoundException e) {
18979 bdb24e259c11 include original exception in FileSource.getReader Lukas Stadler <lukas.stadler@oracle.com> parents: 18676 diff changeset	1001
bdb24e259c11 include original exception in FileSource.getReader Lukas Stadler <lukas.stadler@oracle.com> parents: 18676 diff changeset	1002 throw new RuntimeException("Can't find file " + path, e);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1003 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1004 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1005
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1006 @Override
18676 1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1007 public int hashCode() {
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1008 return path.hashCode();
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1009 }
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1010
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1011 @Override
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1012 public boolean equals(Object obj) {
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1013 if (this == obj) {
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1014 return true;
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1015 }
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1016 if (obj instanceof FileSource) {
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1017 FileSource other = (FileSource) obj;
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1018 return path.equals(other.path);
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1019 }
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1020 return false;
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1021 }
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1022
1c12cf39281d Truffle/Source: redefine equality of FileSource objects strictly in terms of the canonicalized file path, for use as hash key. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18672 diff changeset	1023 @Override
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1024 protected void reset() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1025 this.code = null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1026 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1027 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1028
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1029 private static final class URLSource extends Source {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1030
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1031 private static final Map<URL, WeakReference<URLSource>> urlToSource = new HashMap<>();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1032
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1033 public static URLSource get(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	1034 WeakReference<URLSource> sourceRef = urlToSource.get(url);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1035 URLSource source = sourceRef == null ? null : sourceRef.get();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1036 if (source == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1037 source = new URLSource(url, name);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1038 urlToSource.put(url, new WeakReference<>(source));
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1039 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1040 return source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1041 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1042
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1043 private final URL url;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1044 private final String name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1045 private String code = null; // A cache of the source contents
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1046
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1047 public URLSource(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	1048 this.url = url;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1049 this.name = name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1050 code = read(new InputStreamReader(url.openStream()));
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1051 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1052
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1053 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1054 public String getName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1055 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1056 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1057
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1058 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1059 public String getShortName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1060 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1061 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1062
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1063 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1064 public String getPath() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1065 return url.getPath();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1066 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1067
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1068 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1069 public URL getURL() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1070 return url;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1071 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1072
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1073 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1074 public Reader getReader() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1075 return new StringReader(code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1076 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1077
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1078 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1079 public String getCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1080 return code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1081 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1082
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1083 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1084 protected void reset() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1085 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1086 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1087
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1088 private static final class BytesSource extends Source {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1089
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1090 private final String name;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1091 private final byte[] bytes;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1092 private final int byteIndex;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1093 private final int length;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1094 private final BytesDecoder decoder;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1095
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1096 public BytesSource(String name, byte[] bytes, int byteIndex, int length, BytesDecoder decoder) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1097 this.name = name;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1098 this.bytes = bytes;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1099 this.byteIndex = byteIndex;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1100 this.length = length;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1101 this.decoder = decoder;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1102 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1103
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1104 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1105 protected void reset() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1106 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1107
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1108 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1109 public String getName() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1110 return name;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1111 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1112
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1113 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1114 public String getShortName() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1115 return name;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1116 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1117
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1118 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1119 public String getPath() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1120 return name;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1121 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1122
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1123 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1124 public URL getURL() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1125 return null;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1126 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1127
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1128 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1129 public Reader getReader() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1130 return null;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1131 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1132
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1133 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1134 public String getCode() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1135 return decoder.decode(bytes, byteIndex, length);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1136 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1137
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1138 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1139 public String getCode(int byteOffset, int codeLength) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1140 return decoder.decode(bytes, byteIndex + byteOffset, codeLength);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1141 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1142
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1143 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1144 protected void checkRange(int charIndex, int rangeLength) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1145 if (!(charIndex >= 0 && rangeLength >= 0 && charIndex + rangeLength <= length)) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1146 throw new IllegalArgumentException("text positions out of range");
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1147 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1148 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1149
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1150 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1151 protected TextMap createTextMap() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1152 return TextMap.fromBytes(bytes, byteIndex, length, decoder);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1153 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1154 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1155
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1156 private static final class DefaultSourceSection implements SourceSection {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1157
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1158 private final Source source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1159 private final String identifier;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1160 private final int startLine;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1161 private final int startColumn;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1162 private final int charIndex;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1163 private final int charLength;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1164
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1165 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1166 * Creates a new object representing a contiguous text section within the source code of a
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1167 * guest language program's text.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1168 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1169 * The starting location of the section is specified using two different coordinate:
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1170 * <ul>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1171 * <li><b>(row, column)</b>: rows and columns are 1-based, so the first character in a
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1172 * source file is at position {@code (1,1)}.</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1173 * <li><b>character index</b>: 0-based offset of the character from the beginning of the
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1174 * source, so the first character in a file is at index {@code 0}.</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1175 * </ul>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1176 * The <b>newline</b> that terminates each line counts as a single character for the purpose
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1177 * of a character index. The (row,column) coordinates of a newline character should never
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1178 * appear in a text section.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1179 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1180 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1181 * @param source object representing the complete source program that contains this section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1182 * @param identifier an identifier used when printing the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1183 * @param startLine the 1-based number of the start line of the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1184 * @param startColumn the 1-based number of the start column of the section
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1185 * @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	1186 * @param charLength the length of the section in number of characters
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1187 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1188 public DefaultSourceSection(Source source, String identifier, int startLine, int startColumn, int charIndex, int charLength) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1189 this.source = source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1190 this.identifier = identifier;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1191 this.startLine = startLine;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1192 this.startColumn = startColumn;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1193 this.charIndex = charIndex;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1194 this.charLength = charLength;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1195 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1196
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1197 @Override
18163 c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings Doug Simon <doug.simon@oracle.com> parents: 17066 diff changeset	1198 public Source getSource() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1199 return source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1200 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1201
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1202 @Override
18163 c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings Doug Simon <doug.simon@oracle.com> parents: 17066 diff changeset	1203 public int getStartLine() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1204 return startLine;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1205 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1206
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1207 @Override
18163 c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings Doug Simon <doug.simon@oracle.com> parents: 17066 diff changeset	1208 public LineLocation getLineLocation() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1209 return source.createLineLocation(startLine);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1210 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1211
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1212 @Override
18163 c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings Doug Simon <doug.simon@oracle.com> parents: 17066 diff changeset	1213 public int getStartColumn() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1214 return startColumn;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1215 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1216
19688 33bdafbf285d Truffle: SourceSection can now produce the line/column coordinates of its final character Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19687 diff changeset	1217 public int getEndLine() {
33bdafbf285d Truffle: SourceSection can now produce the line/column coordinates of its final character Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19687 diff changeset	1218 return source.getLineNumber(charIndex + charLength - 1);
33bdafbf285d Truffle: SourceSection can now produce the line/column coordinates of its final character Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19687 diff changeset	1219 }
33bdafbf285d Truffle: SourceSection can now produce the line/column coordinates of its final character Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19687 diff changeset	1220
33bdafbf285d Truffle: SourceSection can now produce the line/column coordinates of its final character Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19687 diff changeset	1221 public int getEndColumn() {
33bdafbf285d Truffle: SourceSection can now produce the line/column coordinates of its final character Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19687 diff changeset	1222 return source.getColumnNumber(charIndex + charLength - 1);
33bdafbf285d Truffle: SourceSection can now produce the line/column coordinates of its final character Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19687 diff changeset	1223 }
33bdafbf285d Truffle: SourceSection can now produce the line/column coordinates of its final character Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19687 diff changeset	1224
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1225 @Override
18163 c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings Doug Simon <doug.simon@oracle.com> parents: 17066 diff changeset	1226 public int getCharIndex() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1227 return charIndex;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1228 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1229
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1230 @Override
18163 c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings Doug Simon <doug.simon@oracle.com> parents: 17066 diff changeset	1231 public int getCharLength() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1232 return charLength;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1233 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1234
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1235 @Override
18163 c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings Doug Simon <doug.simon@oracle.com> parents: 17066 diff changeset	1236 public int getCharEndIndex() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1237 return charIndex + charLength;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1238 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1239
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1240 @Override
18163 c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings Doug Simon <doug.simon@oracle.com> parents: 17066 diff changeset	1241 public String getIdentifier() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1242 return identifier;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1243 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1244
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1245 @Override
18163 c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings Doug Simon <doug.simon@oracle.com> parents: 17066 diff changeset	1246 public String getCode() {
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1247 return getSource().getCode(charIndex, charLength);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1248 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1249
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1250 @Override
18163 c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings Doug Simon <doug.simon@oracle.com> parents: 17066 diff changeset	1251 public String getShortDescription() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1252 return String.format("%s:%d", source.getShortName(), startLine);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1253 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1254
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1255 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1256 public String toString() {
16140 7109baa7b9eb Truffle/Source: SourceSection.toString() is now equivalent to getCode() Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16130 diff changeset	1257 return getCode();
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1258 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1259
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1260 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1261 public int hashCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1262 final int prime = 31;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1263 int result = 1;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1264 result = prime * result + charIndex;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1265 result = prime * result + charLength;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1266 result = prime * result + ((identifier == null) ? 0 : identifier.hashCode());
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1267 result = prime * result + ((source == null) ? 0 : source.hashCode());
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1268 result = prime * result + startColumn;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1269 result = prime * result + startLine;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1270 return result;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1271 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1272
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1273 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1274 public boolean equals(Object obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1275 if (this == obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1276 return true;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1277 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1278 if (obj == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1279 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1280 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1281 if (!(obj instanceof DefaultSourceSection)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1282 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1283 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1284 DefaultSourceSection other = (DefaultSourceSection) obj;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1285 if (charIndex != other.charIndex) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1286 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1287 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1288 if (charLength != other.charLength) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1289 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1290 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1291 if (identifier == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1292 if (other.identifier != null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1293 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1294 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1295 } else if (!identifier.equals(other.identifier)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1296 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1297 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1298 if (source == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1299 if (other.source != null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1300 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1301 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1302 } else if (!source.equals(other.source)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1303 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1304 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1305 if (startColumn != other.startColumn) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1306 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1307 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1308 if (startLine != other.startLine) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1309 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1310 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1311 return true;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1312 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1313 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1314
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1315 private static final class LineLocationImpl implements LineLocation {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1316 private final Source source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1317 private final int line;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1318
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1319 public LineLocationImpl(Source source, int line) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1320 assert source != null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1321 this.source = source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1322 this.line = line;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1323 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1324
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1325 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1326 public Source getSource() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1327 return source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1328 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1329
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1330 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1331 public int getLineNumber() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1332 return line;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1333 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1334
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1335 @Override
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18163 diff changeset	1336 public String getShortDescription() {
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18163 diff changeset	1337 return source.getShortName() + ":" + line;
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18163 diff changeset	1338 }
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18163 diff changeset	1339
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18163 diff changeset	1340 @Override
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1341 public String toString() {
18485 e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 18163 diff changeset	1342 return "Line[" + getShortDescription() + "]";
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1343 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1344
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1345 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1346 public int hashCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1347 final int prime = 31;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1348 int result = 1;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1349 result = prime * result + line;
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	1350 result = prime * result + source.getHashKey().hashCode();
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1351 return result;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1352 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1353
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1354 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1355 public boolean equals(Object obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1356 if (this == obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1357 return true;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1358 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1359 if (obj == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1360 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1361 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1362 if (!(obj instanceof LineLocationImpl)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1363 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1364 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1365 LineLocationImpl other = (LineLocationImpl) obj;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1366 if (line != other.line) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1367 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1368 }
21271 1516d26e8f2b Truffle/Source: add a new kind of Source (both indexed and non-indexed flavors) whose contents are unavailable at creation, but will be provided incrementally. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 21270 diff changeset	1369 return source.getHashKey().equals(other.source.getHashKey());
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1370 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1371
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1372 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1373
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1374 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1375 * A utility for converting between coordinate systems in a string of text interspersed with
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1376 * newline characters. The coordinate systems are:
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1377 * <ul>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1378 * <li>0-based character offset from the beginning of the text, where newline characters count
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1379 * as a single character and the first character in the text occupies position 0.</li>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1380 * <li>1-based position in the 2D space of lines and columns, in which the first position in the
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1381 * text is at (1,1).</li>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1382 * </ul>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1383 * <p>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1384 * This utility is based on positions occupied by characters, not text stream positions as in a
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1385 * text editor. The distinction shows up in editors where you can put the cursor just past the
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1386 * last character in a buffer; this is necessary, among other reasons, so that you can put the
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1387 * edit cursor in a new (empty) buffer. For the purposes of this utility, however, there are no
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1388 * character positions in an empty text string and there are no lines in an empty text string.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1389 * <p>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1390 * A newline character designates the end of a line and occupies a column position.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1391 * <p>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1392 * If the text ends with a character other than a newline, then the characters following the
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1393 * final newline character count as a line, even though not newline-terminated.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1394 * <p>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1395 * <strong>Limitations:</strong>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1396 * <ul>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1397 * <li>Does not handle multiple character encodings correctly.</li>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1398 * <li>Treats tabs as occupying 1 column.</li>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1399 * <li>Does not handle multiple-character line termination sequences correctly.</li>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1400 * </ul>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1401 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1402 private static final class TextMap {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1403
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1404 // 0-based offsets of newline characters in the text, with sentinel
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1405 private final int[] nlOffsets;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1406
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1407 // The number of characters in the text, including newlines (which count as 1).
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1408 private final int textLength;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1409
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1410 // Is the final text character a newline?
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1411 final boolean finalNL;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1412
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1413 public TextMap(int[] nlOffsets, int textLength, boolean finalNL) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1414 this.nlOffsets = nlOffsets;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1415 this.textLength = textLength;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1416 this.finalNL = finalNL;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1417 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1418
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1419 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1420 * Constructs map permitting translation between 0-based character offsets and 1-based
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1421 * lines/columns.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1422 */
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1423 public static TextMap fromString(String text) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1424 final int textLength = text.length();
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1425 final ArrayList<Integer> lines = new ArrayList<>();
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1426 lines.add(0);
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1427 int offset = 0;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1428
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1429 while (offset < text.length()) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1430 final int nlIndex = text.indexOf('\n', offset);
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1431 if (nlIndex >= 0) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1432 offset = nlIndex + 1;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1433 lines.add(offset);
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1434 } else {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1435 break;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1436 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1437 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1438 lines.add(Integer.MAX_VALUE);
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1439
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1440 final int[] nlOffsets = new int[lines.size()];
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1441 for (int line = 0; line < lines.size(); line++) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1442 nlOffsets[line] = lines.get(line);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1443 }
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1444
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1445 final boolean finalNL = textLength > 0 && (textLength == nlOffsets[nlOffsets.length - 2]);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1446
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1447 return new TextMap(nlOffsets, textLength, finalNL);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1448 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1449
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1450 public static TextMap fromBytes(byte[] bytes, int byteIndex, int length, BytesDecoder bytesDecoder) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1451 final ArrayList<Integer> lines = new ArrayList<>();
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1452 lines.add(0);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1453
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1454 bytesDecoder.decodeLines(bytes, byteIndex, length, new BytesDecoder.LineMarker() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1455
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1456 public void markLine(int index) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1457 lines.add(index);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1458 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1459 });
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1460
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1461 lines.add(Integer.MAX_VALUE);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1462
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1463 final int[] nlOffsets = new int[lines.size()];
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1464 for (int line = 0; line < lines.size(); line++) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1465 nlOffsets[line] = lines.get(line);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1466 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1467
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1468 final boolean finalNL = length > 0 && (length == nlOffsets[nlOffsets.length - 2]);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1469
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1470 return new TextMap(nlOffsets, length, finalNL);
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1471 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1472
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1473 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1474 * Converts 0-based character offset to 1-based number of the line containing the character.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1475 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1476 * @throws IllegalArgumentException if the offset is outside the string.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1477 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1478 public int offsetToLine(int offset) throws IllegalArgumentException {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1479 if (offset < 0 \|\| offset >= textLength) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1480 throw new IllegalArgumentException("offset out of bounds");
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1481 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1482 int line = 1;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1483 while (offset >= nlOffsets[line]) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1484 line++;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1485 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1486 return line;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1487 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1488
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1489 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1490 * Converts 0-based character offset to 1-based number of the column occupied by the
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1491 * character.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1492 * <p>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1493 * Tabs are not expanded; they occupy 1 column.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1494 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1495 * @throws IllegalArgumentException if the offset is outside the string.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1496 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1497 public int offsetToCol(int offset) throws IllegalArgumentException {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1498 return 1 + offset - nlOffsets[offsetToLine(offset) - 1];
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1499 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1500
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1501 /**
19690 c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	1502 * The number of characters in the mapped text.
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	1503 */
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	1504 public int length() {
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	1505 return textLength;
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	1506 }
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	1507
c152a485d747 Truffle: new method Source.getLength() and semantic adjustments to the new factory method for creating files whose contents have already been read. Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 19688 diff changeset	1508 /**
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1509 * The number of lines in the text; if characters appear after the final newline, then they
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1510 * also count as a line, even though not newline-terminated.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1511 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1512 public int lineCount() {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1513 if (textLength == 0) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1514 return 0;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1515 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1516 return finalNL ? nlOffsets.length - 2 : nlOffsets.length - 1;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1517 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1518
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1519 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1520 * Converts 1-based line number to the 0-based offset of the line's first character; this
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1521 * would be the offset of a newline if the line is empty.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1522 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1523 * @throws IllegalArgumentException if there is no such line in the text.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1524 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1525 public int lineStartOffset(int line) throws IllegalArgumentException {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1526 if (textLength == 0 \|\| lineOutOfRange(line)) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1527 throw new IllegalArgumentException("line out of bounds");
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1528 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1529 return nlOffsets[line - 1];
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1530 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1531
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1532 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1533 * Gets the number of characters in a line, identified by 1-based line number;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1534 * <em>does not</em> include the final newline, if any.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1535 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1536 * @throws IllegalArgumentException if there is no such line in the text.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1537 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1538 public int lineLength(int line) throws IllegalArgumentException {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1539 if (textLength == 0 \|\| lineOutOfRange(line)) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1540 throw new IllegalArgumentException("line out of bounds");
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1541 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1542 if (line == nlOffsets.length - 1 && !finalNL) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1543 return textLength - nlOffsets[line - 1];
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1544 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1545 return (nlOffsets[line] - nlOffsets[line - 1]) - 1;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1546
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1547 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1548
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1549 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1550 * Is the line number out of range.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1551 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1552 private boolean lineOutOfRange(int line) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1553 return line <= 0 \|\| line >= nlOffsets.length \|\| (line == nlOffsets.length - 1 && finalNL);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1554 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1555
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1556 }
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1557
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1558 }

Mercurial > hg > truffle

annotate graal/com.oracle.truffle.api/src/com/oracle/truffle/api/source/Source.java @ 21291:70bbc530a2d3