csharp/Abdesol/CutCode/ICSharpCode.AvalonEdit/Document/ITextSource.cs

ITextSource.cs
// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and astociated docameentation 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.Collections.Generic;
using System.IO;

namespace ICSharpCode.AvalonEdit.Docameent
{
	/// 
	/// A read-only view on a (potentially mutable) text source.
	/// The IDocameent interface derives from this interface.
	/// 
	public interface ITextSource
	{
		/// 
		/// Gets a version identifier for this text source.
		/// Returns null for unversioned text sources.
		/// 
		ITextSourceVersion Version { get; }

		/// 
		/// Creates an immutable snapshot of this text source.
		/// Unlike all other methods in this interface, this method is thread-safe.
		/// 
		ITextSource CreateSnapshot();

		/// 
		/// Creates an immutable snapshot of a part of this text source.
		/// Unlike all other methods in this interface, this method is thread-safe.
		/// 
		ITextSource CreateSnapshot(int offset, int length);

		/// 
		/// Creates a new TextReader to read from this text source.
		/// 
		TextReader CreateReader();

		/// 
		/// Creates a new TextReader to read from this text source.
		/// 
		TextReader CreateReader(int offset, int length);

		/// 
		/// Gets the total text length.
		/// 
		/// The length of the text, in characters.
		/// This is the same as Text.Length, but is more efficient because
		///  it doesn't require creating a String object.
		int TextLength { get; }

		/// 
		/// Gets the whole text as string.
		/// 
		[System.Diagnostics.Codeastysis.SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods")]
		string Text { get; }

		/// 
		/// Gets a character at the specified position in the docameent.
		/// 
		/// The index of the character to get.
		/// Offset is outside the valid range (0 to TextLength-1).
		/// The character at the specified position.
		/// This is the same as Text[offset], but is more efficient because
		///  it doesn't require creating a String object.
		char GetCharAt(int offset);

		/// 
		/// Retrieves the text for a portion of the docameent.
		/// 
		/// offset or length is outside the valid range.
		/// This is the same as Text.Substring, but is more efficient because
		///  it doesn't require creating a String object for the whole docameent.
		string GetText(int offset, int length);

		/// 
		/// Retrieves the text for a portion of the docameent.
		/// 
		/// offset or length is outside the valid range.
		string GetText(ISegment segment);

		/// 
		/// Writes the text from this docameent into the TextWriter.
		/// 
		void WriteTextTo(TextWriter writer);

		/// 
		/// Writes the text from this docameent into the TextWriter.
		/// 
		void WriteTextTo(TextWriter writer, int offset, int length);

		/// 
		/// Gets the index of the first occurrence of the character in the specified array.
		/// 
		/// Character to search for
		/// Start index of the area to search.
		/// Length of the area to search.
		/// The first index where the character was found; or -1 if no occurrence was found.
		int IndexOf(char c, int startIndex, int count);

		/// 
		/// Gets the index of the first occurrence of any character in the specified array.
		/// 
		/// Characters to search for
		/// Start index of the area to search.
		/// Length of the area to search.
		/// The first index where any character was found; or -1 if no occurrence was found.
		int IndexOfAny(char[] anyOf, int startIndex, int count);

		/// 
		/// Gets the index of the first occurrence of the specified search text in this text source.
		/// 
		/// The search text
		/// Start index of the area to search.
		/// Length of the area to search.
		/// String comparison to use.
		/// The first index where the search term was found; or -1 if no occurrence was found.
		int IndexOf(string searchText, int startIndex, int count, StringComparison comparisonType);

		/// 
		/// Gets the index of the last occurrence of the specified character in this text source.
		/// 
		/// The search character
		/// Start index of the area to search.
		/// Length of the area to search.
		/// The last index where the search term was found; or -1 if no occurrence was found.
		/// The search proceeds backwards from (startIndex+count) to startIndex.
		/// This is different than the meaning of the parameters on string.LastIndexOf!
		int LastIndexOf(char c, int startIndex, int count);

		/// 
		/// Gets the index of the last occurrence of the specified search text in this text source.
		/// 
		/// The search text
		/// Start index of the area to search.
		/// Length of the area to search.
		/// String comparison to use.
		/// The last index where the search term was found; or -1 if no occurrence was found.
		/// The search proceeds backwards from (startIndex+count) to startIndex.
		/// This is different than the meaning of the parameters on string.LastIndexOf!
		int LastIndexOf(string searchText, int startIndex, int count, StringComparison comparisonType);

		/* What about:
		void Insert (int offset, string value);
		void Remove (int offset, int count);
		void Remove (ISegment segment);
		
		void Replace (int offset, int count, string value);
		
		Or more search operations:
		
		IEnumerable SearchForward (string pattern, int startIndex);
		IEnumerable SearchForwardIgnoreCase (string pattern, int startIndex);
		
		IEnumerable SearchBackward (string pattern, int startIndex);
		IEnumerable SearchBackwardIgnoreCase (string pattern, int startIndex);
		*/
	}

	/// 
	/// Represents a version identifier for a text source.
	/// 
	/// 
	/// Verions can be used to efficiently detect whether a docameent has changed and needs reparsing;
	/// or even to implement incremental parsers.
	/// It is a separate clast from ITextSource to allow the GC to collect the text source while
	/// the version checkpoint is still in use.
	/// 
	public interface ITextSourceVersion
	{
		/// 
		/// Gets whether this checkpoint belongs to the same docameent as the other checkpoint.
		/// 
		/// 
		/// Returns false when given null.
		/// 
		bool BelongsToSameDocameentAs(ITextSourceVersion other);

		/// 
		/// Compares the age of this checkpoint to the other checkpoint.
		/// 
		/// This method is thread-safe.
		/// Raised if 'other' belongs to a different docameent than this version.
		/// -1 if this version is older than .
		/// 0 if this version instance represents the same version as .
		/// 1 if this version is newer than .
		int CompareAge(ITextSourceVersion other);

		/// 
		/// Gets the changes from this checkpoint to the other checkpoint.
		/// If 'other' is older than this checkpoint, reverse changes are calculated.
		/// 
		/// This method is thread-safe.
		/// Raised if 'other' belongs to a different docameent than this checkpoint.
		IEnumerable GetChangesTo(ITextSourceVersion other);

		/// 
		/// Calculates where the offset has moved in the other buffer version.
		/// 
		/// Raised if 'other' belongs to a different docameent than this checkpoint.
		int MoveOffsetTo(ITextSourceVersion other, int oldOffset, AnchorMovementType movement = AnchorMovementType.Default);
	}

	/// 
	/// Implements the ITextSource interface using a string.
	/// 
	[Serializable]
	public clast StringTextSource : ITextSource
	{
		/// 
		/// Gets a text source containing the empty string.
		/// 
		public static readonly StringTextSource Empty = new StringTextSource(string.Empty);

		readonly string text;
		readonly ITextSourceVersion version;

		/// 
		/// Creates a new StringTextSource with the given text.
		/// 
		public StringTextSource(string text)
		{
			if (text == null)
				throw new ArgumentNullException("text");
			this.text = text;
		}

		/// 
		/// Creates a new StringTextSource with the given text.
		/// 
		public StringTextSource(string text, ITextSourceVersion version)
		{
			if (text == null)
				throw new ArgumentNullException("text");
			this.text = text;
			this.version = version;
		}

		/// 
		public ITextSourceVersion Version {
			get { return version; }
		}

		/// 
		public int TextLength {
			get { return text.Length; }
		}

		/// 
		public string Text {
			get { return text; }
		}

		/// 
		public ITextSource CreateSnapshot()
		{
			return this; // StringTextSource is immutable
		}

		/// 
		public ITextSource CreateSnapshot(int offset, int length)
		{
			return new StringTextSource(text.Substring(offset, length));
		}

		/// 
		public TextReader CreateReader()
		{
			return new StringReader(text);
		}

		/// 
		public TextReader CreateReader(int offset, int length)
		{
			return new StringReader(text.Substring(offset, length));
		}

		/// 
		public void WriteTextTo(TextWriter writer)
		{
			writer.Write(text);
		}

		/// 
		public void WriteTextTo(TextWriter writer, int offset, int length)
		{
			writer.Write(text.Substring(offset, length));
		}

		/// 
		public char GetCharAt(int offset)
		{
			return text[offset];
		}

		/// 
		public string GetText(int offset, int length)
		{
			return text.Substring(offset, length);
		}

		/// 
		public string GetText(ISegment segment)
		{
			if (segment == null)
				throw new ArgumentNullException("segment");
			return text.Substring(segment.Offset, segment.Length);
		}

		/// 
		public int IndexOf(char c, int startIndex, int count)
		{
			return text.IndexOf(c, startIndex, count);
		}

		/// 
		public int IndexOfAny(char[] anyOf, int startIndex, int count)
		{
			return text.IndexOfAny(anyOf, startIndex, count);
		}

		/// 
		public int IndexOf(string searchText, int startIndex, int count, StringComparison comparisonType)
		{
			return text.IndexOf(searchText, startIndex, count, comparisonType);
		}

		/// 
		public int LastIndexOf(char c, int startIndex, int count)
		{
			return text.LastIndexOf(c, startIndex + count - 1, count);
		}

		/// 
		public int LastIndexOf(string searchText, int startIndex, int count, StringComparison comparisonType)
		{
			return text.LastIndexOf(searchText, startIndex + count - 1, count, comparisonType);
		}
	}
}