mono/mcs/class/corlib/System.IO/StringReader.cs

//
// System.IO.StringReader
//
// Authors:
//   Marcin Szczepanski ([email protected])
//   Marek Safar ([email protected])
//
// Copyright (C) 2004 Novell, Inc (http://www.novell.com)
// Copyright 2011 Xamarin Inc.
//
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

using System;
using System.Globalization;
using System.Runtime.InteropServices;
#if NET_4_5
using System.Threading.Tasks;
#endif

namespace System.IO {
	[Serializable]
	[ComVisible (true)]
	public class StringReader : TextReader {

		string source;
		int nextChar;
		int sourceLength;
		static char[] cr_lf;

		public StringReader (string s)
		{
			if (s == null) 
				throw new ArgumentNullException ("s");

			this.source = s;
			nextChar = 0;
			sourceLength = s.Length;
		}

		public override void Close ()
		{
			Dispose (true);
		}

		protected override void Dispose (bool disposing)
		{
			source = null;
			base.Dispose (disposing);
		}

		public override int Peek ()
		{
			if (source == null)
				ObjectDisposedException ();

			if (nextChar >= sourceLength) 
				return -1;
			return (int)source [nextChar];
		}

		public override int Read ()
		{
			if (source == null)
				ObjectDisposedException ();

			if (nextChar >= sourceLength)
				return -1;
			return (int)source [nextChar++];
		}

		// The method will read up to count characters from the StringReader
		// into the buffer character array starting at position index. Returns
		// the actual number of characters read, or zero if the end of the string
		// has been reached and no characters are read.

		public override int Read ([In, Out] char[] buffer, int index, int count)
		{
			if (source == null)
				ObjectDisposedException ();

			if (buffer == null)
				throw new ArgumentNullException ("buffer");
			if (buffer.Length - index < count)
				throw new ArgumentException ();
			if (index < 0 || count < 0)
				throw new ArgumentOutOfRangeException ();

			int charsToRead;

			// reordered to avoir possible integer overflow
			if (nextChar > sourceLength - count)
				charsToRead = sourceLength - nextChar;
			else
				charsToRead = count;
			
			source.CopyTo (nextChar, buffer, index, charsToRead);

			nextChar += charsToRead;

			return charsToRead;
		}

		public override string ReadLine ()
		{
			// Reads until next \r or \n or \r\n, otherwise return null

			if (source == null)
				ObjectDisposedException ();

			if (nextChar >= source.Length)
				return null;

			if (cr_lf == null)
				cr_lf = new char [] { '\n', '\r' };
			
			int readto = source.IndexOfAny (cr_lf, nextChar);
			
			if (readto == -1)
				return ReadToEnd ();

			bool consecutive = source[readto] == '\r'
				&& readto + 1 < source.Length
				&& source[readto + 1] == '\n';

			string nextLine = source.Substring (nextChar, readto - nextChar);
			nextChar = readto + ((consecutive) ? 2 : 1);
			return nextLine;
		}

		public override string ReadToEnd ()
		{
			if (source == null)
				ObjectDisposedException ();
			string toEnd = source.Substring (nextChar, sourceLength - nextChar);
			nextChar = sourceLength;
			return toEnd;
		}

#if NET_4_5
		//
		// All async methods return finished task with a result as it's faster
		// than setting up async call
		//
		public override Task<int> ReadAsync (char[] buffer, int index, int count)
		{
			return Task.FromResult (Read (buffer, index, count));
		}

		public override Task<int> ReadBlockAsync (char[] buffer, int index, int count)
		{
			return Task.FromResult (ReadBlock (buffer, index, count));
		}

		public override Task<string> ReadLineAsync ()
		{
			return Task.FromResult (ReadLine ());
		}

		public override Task<string> ReadToEndAsync ()
		{
			return Task.FromResult (ReadToEnd ());
		}
#endif

		static void ObjectDisposedException ()
		{
			throw new ObjectDisposedException ("StringReader", 
							   Locale.GetText ("Cannot read from a closed StringReader"));
		}
	}
}