1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver[The "BSD licence"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverCopyright (c) 2005-2007 Kunle Odutola 4324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverAll rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 6324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverRedistribution and use in source and binary forms, with or without 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermodification, are permitted provided that the following conditions 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverare met: 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver1. Redistributions of source code MUST RETAIN the above copyright 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer. 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver2. Redistributions in binary form MUST REPRODUCE the above copyright 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer in 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver the documentation and/or other materials provided with the 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver distribution. 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver3. The name of the author may not be used to endorse or promote products 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver derived from this software without specific prior WRITTEN permission. 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver4. Unless explicitly state otherwise, any contribution intentionally 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver submitted for inclusion in this work to the copyright owner or licensor 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver shall be under the terms and conditions of this license, without any 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver additional terms or conditions. 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 22324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverTHIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverIMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverOF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverIN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverINCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverTHIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver*/ 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvernamespace Antlr.Runtime 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using System; 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using StreamReader = System.IO.StreamReader; 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using FileInfo = System.IO.FileInfo; 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using Encoding = System.Text.Encoding; 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <summary> 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// A character stream - an <see cref="ICharStream"/> - that loads 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// and caches the contents of it's underlying file fully during 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// object construction 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// </summary> 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <remarks> 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// This looks very much like an ANTLReaderStream or an ANTLRInputStream 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// but, it is a special case. Since we know the exact size of the file to 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// load, we can avoid lots of data copying and buffer resizing. 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// </remarks> 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public class ANTLRFileStream : ANTLRStringStream 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #region Constructors 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <summary> 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Initializes a new instance of the ANTLRFileStream class 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// </summary> 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected ANTLRFileStream() 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <summary> 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Initializes a new instance of the ANTLRFileStream class for the 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// specified file name 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// </summary> 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ANTLRFileStream(string fileName) : 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this(fileName, Encoding.Default) 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <summary> 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Initializes a new instance of the ANTLRFileStream class for the 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// specified file name and encoding 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// </summary> 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ANTLRFileStream(string fileName, Encoding encoding) 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.fileName = fileName; 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Load(fileName, encoding); 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <summary> 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Gets the file name of this ANTLRFileStream underlying file 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// </summary> 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver override public string SourceName 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get { return fileName; } 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #endregion 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #region Public API 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <summary> 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// Loads and buffers the specified file to be used as this 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// ANTLRFileStream's source 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// </summary> 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <param name="fileName">File to load</param> 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <param name="encoding">Encoding to apply to file</param> 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual void Load(string fileName, Encoding encoding) 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (fileName == null) 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return; 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver StreamReader fr = null; 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver try 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver FileInfo f = new FileInfo(fileName); 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int filelen = (int)GetFileLength(f); 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver data = new char[filelen]; 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (encoding != null) 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver fr = new StreamReader(fileName, encoding); 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver else 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver fr = new StreamReader(fileName, Encoding.Default); 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver n = fr.Read((Char[])data, 0, data.Length); 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver finally 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (fr != null) 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver fr.Close(); 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #endregion 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #region Data Members 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /// <summary>Fully qualified name of the stream's underlying file</summary> 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected string fileName; 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #endregion 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #region Private Members 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver private long GetFileLength(FileInfo file) 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (file.Exists) 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return file.Length; 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver else 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return 0; 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #endregion 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}