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 @ 21270:a43c7adc9d99

Truffle/Source: rename asPseudoFile() to fromNamedText(), which more accurately describes its use cases. Rework Javadoc for completeness and clarity.

author	Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date	Thu, 07 May 2015 17:51:55 -0700
parents	c8b83aa6cc82
children	1516d26e8f2b

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>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	63 * </ul>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	64 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	65 * <strong>File cache:</strong>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	66 * <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	67 * <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	68 * <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	69 * enabled) cached.</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	70 * <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	71 * {@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	72 * <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	73 * reload.</li>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	74 * </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	75 * <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	76 *
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	77 * @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	78 * @see SourceListener
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	79 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	80 public abstract class Source {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	81
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	82 // 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	83 // 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	84
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	85 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	86
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	87 /**
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	88 * 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	89 */
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	90 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	91
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	92 /**
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	93 * 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	94 */
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 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	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 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	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_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	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 * 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	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_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	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 * 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	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_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	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 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	113 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	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 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	116 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	117 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	118 }
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 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	121 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	122 }
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
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 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	125 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	126 }
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
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
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	130 /**
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	131 * 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	132 */
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	133 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	134
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	135 /**
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	136 * 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	137 */
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	138 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	139
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	140 private static boolean fileCacheEnabled = true;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	141
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	142 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	143
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 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 * 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	146 */
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 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	148 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	149 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	150 }
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	151
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	152 /**
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	153 * 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	154 * then cached.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	155 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	156 * @param fileName name
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	157 * @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	158 * @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	159 * @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	160 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	161 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	162
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	163 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	164 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	165 if (source == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	166 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	167 if (!file.canRead()) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	168 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	169 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	170 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	171 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	172 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	173 if (source == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	174 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	175 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	176 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	177 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	178 if (reset) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	179 source.reset();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	180 }
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	181 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	182 return source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	183 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	184
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	185 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	186 * 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	187 * then cached.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	188 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	189 * @param fileName name
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	190 * @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	191 * @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	192 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	193 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	194 return fromFileName(fileName, false);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	195 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	196
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	197 /**
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	198 * 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	199 * 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	200 * 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	201 * 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	202 *
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	203 * @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	204 * @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	205 * @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	206 * @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	207 */
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	208 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	209
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	210 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	211 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	212 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	213 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	214 // 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	215 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	216 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	217 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	218 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	219 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	220 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	221 }
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 }
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	223 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	224 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	225 }
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	226
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 /**
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	228 * 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	229 *
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	230 * @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	231 * @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	232 * @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	233 */
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	234 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	235 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	236 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	237 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	238 return source;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	239 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	240
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	241 /**
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	242 * 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	243 * 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	244 * 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	245 *
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	246 * @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	247 * @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	248 * @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	249 */
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	250 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	251 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	252 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	253 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	254 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	255 }
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	256
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	257 /**
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	258 * 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	259 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	260 * @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	261 * @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	262 * @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	263 * @throws IOException if reading fails
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	264 */
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	265 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	266 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	267 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	268 return source;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	269 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	270
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	271 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	272 * 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	273 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	274 * @param reader
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	275 * @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	276 * @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	277 * @throws IOException if reading fails
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	278 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	279 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	280 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	281 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	282 return source;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	283 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	284
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	285 /**
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	286 * 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	287 * 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	288 * 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	289 *
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	290 * @param bytes the raw bytes of the source
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	291 * @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	292 * @param decoder how to decode the bytes into Java strings
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	293 * @return a newly created, non-indexed source representation
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	294 */
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	295 public static Source fromBytes(byte[] bytes, String description, BytesDecoder decoder) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	296 return fromBytes(bytes, 0, bytes.length, description, decoder);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	297 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	298
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	299 /**
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	300 * 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	301 * 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	302 * 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	303 * relative to byteIndex.
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	304 *
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	305 * @param bytes the raw bytes of the source
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	306 * @param byteIndex where the string starts in the byte array
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	307 * @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	308 * @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	309 * @param decoder how to decode the bytes into Java strings
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	310 * @return a newly created, non-indexed source representation
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	311 */
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	312 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	313 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	314 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	315 return source;
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	316 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	317
16989 19faa7ca37c1 Truffle/Source: use a synchronized hash table Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16140 diff changeset	318 // 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	319 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	320 * 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	321 * 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	322 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	323 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	324 fileCacheEnabled = enabled;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	325 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	326
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	327 /**
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	328 * 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	329 * 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	330 *
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	331 * @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	332 */
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 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	334 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	335 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	336 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	337 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	338 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	339 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	340 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	341 }
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	342 }
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	343 }
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	344 }
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	345 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	346 }
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
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	348 /**
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 * 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	350 */
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	351 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	352 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	353 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	354 }
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	355
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	356 /**
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	357 * 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	358 */
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	359 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	360 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	361 }
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	362
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	363 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	364 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	365 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	366 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	367 }
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	368 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	369 }
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	370
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	371 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	372 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	373 final StringBuilder builder = new StringBuilder();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	374 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	375
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	376 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	377 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	378 if (n == -1) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	379 break;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	380 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	381 builder.append(buffer, 0, n);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	382 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	383
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	384 return builder.toString();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	385 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	386
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	387 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	388
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	389 Source() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	390 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	391
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	392 private TextMap textMap = null;
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	393
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	394 protected abstract void reset();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	395
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	396 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	397 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	398 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	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
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 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	402 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	403 }
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	404
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	405 /**
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	406 * 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	407 * {@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	408 *
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 * @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	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 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	412 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	413 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	414 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	415 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	416 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	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 }
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 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	420 }
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
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	422 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	423 * 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	424 * 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	425 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	426 * @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	427 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	428 public abstract String getName();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	429
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	430 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	431 * 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	432 * 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	433 * full path.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	434 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	435 * @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	436 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	437 public abstract String getShortName();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	438
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	439 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	440 * 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	441 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	442 public abstract String getPath();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	443
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	444 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	445 * 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	446 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	447 public abstract URL getURL();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	448
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	449 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	450 * Access to the source contents.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	451 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	452 public abstract Reader getReader();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	453
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	454 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	455 * Access to the source contents.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	456 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	457 public final InputStream getInputStream() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	458 return new ByteArrayInputStream(getCode().getBytes());
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	459 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	460
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	461 /**
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	462 * 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	463 */
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	464 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	465 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	466 }
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	467
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	468 /**
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	469 * 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	470 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	471 public abstract String getCode();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	472
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	473 /**
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	474 * 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	475 */
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	476 public String getCode(int charIndex, int charLength) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	477 return getCode().substring(charIndex, charIndex + charLength);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	478 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	479
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	480 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	481 * 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	482 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	483 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	484 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	485 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	486 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	487 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	488 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	489
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	490 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	491 * 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	492 * 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	493 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	494 public final int getLineCount() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	495 return checkTextMap().lineCount();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	496 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	497
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	498 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	499 * 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	500 * position.
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	501 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	502 * @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	503 */
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	504 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	505 return checkTextMap().offsetToLine(offset);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	506 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	507
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	508 /**
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	509 * 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	510 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	511 * @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	512 */
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	513 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	514 return checkTextMap().offsetToCol(offset);
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	515 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	516
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	517 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	518 * 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	519 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	520 * @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	521 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	522 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	523 return checkTextMap().lineStartOffset(lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	524 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	525
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	526 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	527 * 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	528 * numbered line.
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	529 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	530 * @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	531 */
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	532 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	533 return checkTextMap().lineLength(lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	534 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	535
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	536 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	537 * 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	538 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	539 * 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	540 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	541 * 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	542 * {@link Source} representations are canonical.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	543 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	544 * @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	545 * @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	546 * @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	547 * @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	548 * @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	549 * @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	550 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	551 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	552 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	553 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	554
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	555 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	556 * 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	557 * {@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	558 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	559 * 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	560 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	561 * 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	562 * {@link Source} representations are canonical.
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 * @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	565 * @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	566 * @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	567 * @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	568 * @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	569 * @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	570 * @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	571 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	572 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	573 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	574 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	575 if (startColumn > textMap.lineLength(startLine)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	576 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	577 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	578 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	579 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	580 }
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 * 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	584 * {@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	585 * the source.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	586 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	587 * 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	588 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	589 * 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	590 * {@link Source} representations are canonical.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	591 *
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 * @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	594 * @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	595 * @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	596 * @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	597 * @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	598 * source
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	599 * @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	600 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	601 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	602 checkRange(charIndex, length);
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	603 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	604 final int startLine = getLineNumber(charIndex);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	605 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	606
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	607 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	608 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	609
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	610 protected void checkRange(int charIndex, int length) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	611 if (!(charIndex >= 0 && length >= 0 && charIndex + length <= getCode().length())) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	612 throw new IllegalArgumentException("text positions out of range");
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	613 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	614 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	615
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	616 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	617 * 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	618 * 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	619 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	620 * @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	621 * @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	622 * @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	623 * @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	624 * @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	625 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	626 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	627 checkTextMap();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	628 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	629 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	630 return createSection(identifier, charIndex, length);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	631 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	632
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	633 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	634 * 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	635 * 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	636 *
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	637 * @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	638 * @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	639 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	640 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	641 return new LineLocationImpl(this, lineNumber);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	642 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	643
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	644 private TextMap checkTextMap() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	645 if (textMap == null) {
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	646 textMap = createTextMap();
16068 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 return textMap;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	649 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	650
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	651 protected TextMap createTextMap() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	652 final String code = getCode();
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	653 if (code == null) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	654 throw new RuntimeException("can't read file " + getName());
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	655 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	656 return TextMap.fromString(code);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	657 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	658
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	659 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	660
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	661 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	662 private final String code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	663
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	664 public LiteralSource(String name, String code) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	665 this.name = name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	666 this.code = code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	667 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	668
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	669 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	670 public String getName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	671 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	672 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	673
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	674 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	675 public String getShortName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	676 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	677 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	678
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	679 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	680 public String getCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	681 return code;
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
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	684 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	685 public String getPath() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	686 return name;
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
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	689 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	690 public URL getURL() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	691 return null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	692 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	693
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	694 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	695 public Reader getReader() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	696 return new StringReader(code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	697 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	698
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	699 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	700 protected void reset() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	701 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	702
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	703 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	704 public int hashCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	705 final int prime = 31;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	706 int result = 1;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	707 result = prime * result + name.hashCode();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	708 result = prime * result + (code == null ? 0 : code.hashCode());
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	709 return result;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	710 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	711
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	712 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	713 public boolean equals(Object obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	714 if (this == obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	715 return true;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	716 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	717 if (obj == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	718 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	719 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	720 if (!(obj instanceof LiteralSource)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	721 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	722 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	723 LiteralSource other = (LiteralSource) obj;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	724 return name.equals(other.name) && code.equals(other.code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	725 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	726
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	727 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	728
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	729 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	730
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	731 private final File file;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	732 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	733 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	734
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	735 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	736 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	737
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	738 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	739 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	740 }
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	741
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	742 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	743 this.file = file.getAbsoluteFile();
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	744 this.name = name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	745 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	746 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	747 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	748 }
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	749 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	750
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	751 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	752 public String getName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	753 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	754 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	755
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	756 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	757 public String getShortName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	758 return file.getName();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	759 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	760
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	761 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	762 public String getCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	763 if (fileCacheEnabled) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	764 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	765 try {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	766 code = read(getReader());
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	767 timeStamp = file.lastModified();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	768 } catch (IOException e) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	769 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	770 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	771 return code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	772 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	773 try {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	774 return read(new FileReader(file));
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	775 } catch (IOException e) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	776 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	777 return null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	778 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	779
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	780 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	781 public String getPath() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	782 return path;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	783 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	784
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	785 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	786 public URL getURL() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	787 return null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	788 }
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 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	791 public Reader getReader() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	792 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	793 return new StringReader(code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	794 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	795 try {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	796 return new FileReader(file);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	797 } catch (FileNotFoundException e) {
18979 bdb24e259c11 include original exception in FileSource.getReader Lukas Stadler <lukas.stadler@oracle.com> parents: 18676 diff changeset	798
bdb24e259c11 include original exception in FileSource.getReader Lukas Stadler <lukas.stadler@oracle.com> parents: 18676 diff changeset	799 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	800 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	801 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	802
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	803 @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	804 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	805 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	806 }
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	807
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	808 @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	809 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	810 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	811 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	812 }
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	813 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	814 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	815 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	816 }
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	817 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	818 }
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	819
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	820 @Override
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	821 protected void reset() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	822 this.code = null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	823 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	824
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	825 }
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 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	828
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	829 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	830
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	831 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	832 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	833 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	834 if (source == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	835 source = new URLSource(url, name);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	836 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	837 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	838 return source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	839 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	840
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	841 private final URL url;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	842 private final String name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	843 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	844
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	845 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	846 this.url = url;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	847 this.name = name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	848 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	849 }
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 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	852 public String getName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	853 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	854 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	855
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	856 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	857 public String getShortName() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	858 return name;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	859 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	860
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	861 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	862 public String getPath() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	863 return url.getPath();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	864 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	865
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	866 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	867 public URL getURL() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	868 return url;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	869 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	870
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	871 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	872 public Reader getReader() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	873 return new StringReader(code);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	874 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	875
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	876 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	877 public String getCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	878 return code;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	879 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	880
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	881 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	882 protected void reset() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	883 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	884
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	885 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	886
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	887 private static final class BytesSource extends Source {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	888
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	889 private final String name;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	890 private final byte[] bytes;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	891 private final int byteIndex;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	892 private final int length;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	893 private final BytesDecoder decoder;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	894
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	895 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	896 this.name = name;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	897 this.bytes = bytes;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	898 this.byteIndex = byteIndex;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	899 this.length = length;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	900 this.decoder = decoder;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	901 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	902
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	903 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	904 protected void reset() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	905 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	906
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	907 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	908 public String getName() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	909 return name;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	910 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	911
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	912 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	913 public String getShortName() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	914 return name;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	915 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	916
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	917 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	918 public String getPath() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	919 return name;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	920 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	921
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	922 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	923 public URL getURL() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	924 return null;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	925 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	926
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	927 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	928 public Reader getReader() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	929 return null;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	930 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	931
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	932 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	933 public String getCode() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	934 return decoder.decode(bytes, byteIndex, length);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	935 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	936
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	937 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	938 public String getCode(int byteOffset, int codeLength) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	939 return decoder.decode(bytes, byteIndex + byteOffset, codeLength);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	940 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	941
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	942 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	943 protected void checkRange(int charIndex, int rangeLength) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	944 if (!(charIndex >= 0 && rangeLength >= 0 && charIndex + rangeLength <= length)) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	945 throw new IllegalArgumentException("text positions out of range");
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	946 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	947 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	948
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	949 @Override
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	950 protected TextMap createTextMap() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	951 return TextMap.fromBytes(bytes, byteIndex, length, decoder);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	952 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	953 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	954
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	955 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	956
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	957 private final Source source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	958 private final String identifier;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	959 private final int startLine;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	960 private final int startColumn;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	961 private final int charIndex;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	962 private final int charLength;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	963
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	964 /**
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	965 * 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	966 * guest language program's text.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	967 * <p>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	968 * 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	969 * <ul>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	970 * <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	971 * 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	972 * <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	973 * 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	974 * </ul>
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	975 * 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	976 * 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	977 * appear in a text section.
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	978 * <p>
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 * @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	981 * @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	982 * @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	983 * @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	984 * @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	985 * @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	986 */
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	987 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	988 this.source = source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	989 this.identifier = identifier;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	990 this.startLine = startLine;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	991 this.startColumn = startColumn;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	992 this.charIndex = charIndex;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	993 this.charLength = charLength;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	994 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	995
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	996 @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	997 public Source getSource() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	998 return source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	999 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1000
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1001 @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	1002 public int getStartLine() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1003 return startLine;
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
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	1007 public LineLocation getLineLocation() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1008 return source.createLineLocation(startLine);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1009 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1010
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1011 @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	1012 public int getStartColumn() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1013 return startColumn;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1014 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1015
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	1016 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	1017 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	1018 }
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	1019
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	1020 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	1021 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	1022 }
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	1023
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1024 @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	1025 public int getCharIndex() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1026 return charIndex;
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 @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	1030 public int getCharLength() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1031 return charLength;
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
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1034 @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	1035 public int getCharEndIndex() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1036 return charIndex + charLength;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1037 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1038
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1039 @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	1040 public String getIdentifier() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1041 return identifier;
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
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1044 @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	1045 public String getCode() {
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1046 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	1047 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1048
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1049 @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	1050 public String getShortDescription() {
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1051 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	1052 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1053
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1054 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1055 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	1056 return getCode();
16068 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
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1059 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1060 public int hashCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1061 final int prime = 31;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1062 int result = 1;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1063 result = prime * result + charIndex;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1064 result = prime * result + charLength;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1065 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	1066 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	1067 result = prime * result + startColumn;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1068 result = prime * result + startLine;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1069 return result;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1070 }
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 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1073 public boolean equals(Object obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1074 if (this == obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1075 return true;
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 if (obj == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1078 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1079 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1080 if (!(obj instanceof DefaultSourceSection)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1081 return false;
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 DefaultSourceSection other = (DefaultSourceSection) obj;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1084 if (charIndex != other.charIndex) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1085 return false;
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 if (charLength != other.charLength) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1088 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1089 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1090 if (identifier == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1091 if (other.identifier != null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1092 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1093 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1094 } 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	1095 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1096 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1097 if (source == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1098 if (other.source != null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1099 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1100 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1101 } 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	1102 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1103 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1104 if (startColumn != other.startColumn) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1105 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1106 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1107 if (startLine != other.startLine) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1108 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1109 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1110 return true;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1111 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1112 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1113
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1114 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	1115 private final Source source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1116 private final int line;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1117
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1118 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	1119 assert source != null;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1120 this.source = source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1121 this.line = line;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1122 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1123
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1124 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1125 public Source getSource() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1126 return source;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1127 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1128
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1129 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1130 public int getLineNumber() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1131 return line;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1132 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1133
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1134 @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	1135 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	1136 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	1137 }
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	1138
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	1139 @Override
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1140 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	1141 return "Line[" + getShortDescription() + "]";
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1142 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1143
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1144 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1145 public int hashCode() {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1146 final int prime = 31;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1147 int result = 1;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1148 result = prime * result + line;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1149 result = prime * result + source.hashCode();
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1150 return result;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1151 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1152
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1153 @Override
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1154 public boolean equals(Object obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1155 if (this == obj) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1156 return true;
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 if (obj == null) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1159 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1160 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1161 if (!(obj instanceof LineLocationImpl)) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1162 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1163 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1164 LineLocationImpl other = (LineLocationImpl) obj;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1165 if (line != other.line) {
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1166 return false;
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1167 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1168 return source.equals(other.source);
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1169 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1170
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1171 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1172
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1173 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1174 * 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	1175 * newline characters. The coordinate systems are:
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1176 * <ul>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1177 * <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	1178 * 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	1179 * <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	1180 * text is at (1,1).</li>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1181 * </ul>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1182 * <p>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1183 * 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	1184 * 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	1185 * 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	1186 * 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	1187 * 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	1188 * <p>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1189 * 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	1190 * <p>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1191 * 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	1192 * 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	1193 * <p>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1194 * <strong>Limitations:</strong>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1195 * <ul>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1196 * <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	1197 * <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	1198 * <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	1199 * </ul>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1200 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1201 private static final class TextMap {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1202
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1203 // 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	1204 private final int[] nlOffsets;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1205
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1206 // 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	1207 private final int textLength;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1208
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1209 // Is the final text character a newline?
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1210 final boolean finalNL;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1211
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1212 public TextMap(int[] nlOffsets, int textLength, boolean finalNL) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1213 this.nlOffsets = nlOffsets;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1214 this.textLength = textLength;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1215 this.finalNL = finalNL;
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1216 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1217
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1218 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1219 * 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	1220 * lines/columns.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1221 */
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1222 public static TextMap fromString(String text) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1223 final int textLength = text.length();
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1224 final ArrayList<Integer> lines = new ArrayList<>();
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1225 lines.add(0);
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1226 int offset = 0;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1227
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1228 while (offset < text.length()) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1229 final int nlIndex = text.indexOf('\n', offset);
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1230 if (nlIndex >= 0) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1231 offset = nlIndex + 1;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1232 lines.add(offset);
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1233 } else {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1234 break;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1235 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1236 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1237 lines.add(Integer.MAX_VALUE);
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1238
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1239 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	1240 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	1241 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	1242 }
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1243
17066 0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1244 final boolean finalNL = textLength > 0 && (textLength == nlOffsets[nlOffsets.length - 2]);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1245
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1246 return new TextMap(nlOffsets, textLength, finalNL);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1247 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1248
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1249 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	1250 final ArrayList<Integer> lines = new ArrayList<>();
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1251 lines.add(0);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1252
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1253 bytesDecoder.decodeLines(bytes, byteIndex, length, new BytesDecoder.LineMarker() {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1254
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1255 public void markLine(int index) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1256 lines.add(index);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1257 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1258 });
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1259
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1260 lines.add(Integer.MAX_VALUE);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1261
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1262 final int[] nlOffsets = new int[lines.size()];
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1263 for (int line = 0; line < lines.size(); line++) {
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1264 nlOffsets[line] = lines.get(line);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1265 }
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1266
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1267 final boolean finalNL = length > 0 && (length == nlOffsets[nlOffsets.length - 2]);
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1268
0bcefb0f8488 Truffle: byte[] sources. Chris Seaton <chris.seaton@oracle.com> parents: 16989 diff changeset	1269 return new TextMap(nlOffsets, length, finalNL);
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1270 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1271
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1272 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1273 * 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	1274 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1275 * @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	1276 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1277 public int offsetToLine(int offset) throws IllegalArgumentException {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1278 if (offset < 0 \|\| offset >= textLength) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1279 throw new IllegalArgumentException("offset out of bounds");
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1280 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1281 int line = 1;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1282 while (offset >= nlOffsets[line]) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1283 line++;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1284 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1285 return line;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1286 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1287
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1288 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1289 * 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	1290 * character.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1291 * <p>
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1292 * 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	1293 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1294 * @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	1295 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1296 public int offsetToCol(int offset) throws IllegalArgumentException {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1297 return 1 + offset - nlOffsets[offsetToLine(offset) - 1];
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1298 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1299
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1300 /**
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	1301 * 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	1302 */
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	1303 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	1304 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	1305 }
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	1306
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	1307 /**
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1308 * 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	1309 * 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	1310 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1311 public int lineCount() {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1312 if (textLength == 0) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1313 return 0;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1314 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1315 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	1316 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1317
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1318 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1319 * 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	1320 * 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	1321 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1322 * @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	1323 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1324 public int lineStartOffset(int line) throws IllegalArgumentException {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1325 if (textLength == 0 \|\| lineOutOfRange(line)) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1326 throw new IllegalArgumentException("line out of bounds");
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1327 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1328 return nlOffsets[line - 1];
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1329 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1330
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1331 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1332 * 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	1333 * <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	1334 *
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1335 * @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	1336 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1337 public int lineLength(int line) throws IllegalArgumentException {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1338 if (textLength == 0 \|\| lineOutOfRange(line)) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1339 throw new IllegalArgumentException("line out of bounds");
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1340 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1341 if (line == nlOffsets.length - 1 && !finalNL) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1342 return textLength - nlOffsets[line - 1];
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1343 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1344 return (nlOffsets[line] - nlOffsets[line - 1]) - 1;
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1345
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1346 }
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1347
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1348 /**
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1349 * Is the line number out of range.
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1350 */
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1351 private boolean lineOutOfRange(int line) {
6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1352 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	1353 }
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1354
74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1355 }
16130 6f7d3f3703d3 Truffle/Source: Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: 16068 diff changeset	1356
16068 74e142bd2b12 Truffle/Source: major API revision Michael Van De Vanter <michael.van.de.vanter@oracle.com> parents: diff changeset	1357 }

Mercurial > hg > truffle

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