1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
//
// ITextSource.cs
//
// Author:
// Mike Krüger <mkrueger@xamarin.com>
//
// Copyright (c) 2014 Xamarin Inc. (http://xamarin.com)
//
// 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.IO;
using System.Text;
namespace MonoDevelop.Core.Text
{
/// <summary>
/// A read-only view on a (potentially mutable) text source.
/// The IDocument interface derives from this interface.
/// </summary>
public interface ITextSource
{
/// <summary>
/// Gets a version identifier for this text source.
/// Returns null for unversioned text sources.
/// </summary>
ITextSourceVersion Version { get; }
/// <summary>
/// Determines if a byte order mark was read or is going to be written.
/// </summary>
bool UseBOM { get; }
/// <summary>
/// Encoding of the text that was read from or is going to be saved to.
/// </summary>
Encoding Encoding { get; }
/// <summary>
/// Gets the total text length.
/// </summary>
/// <returns>The length of the text, in characters.</returns>
/// <remarks>This is the same as Text.Length, but is more efficient because
/// it doesn't require creating a String object.</remarks>
int Length { get; }
/// <summary>
/// Gets the whole text as string.
/// </summary>
[System.Diagnostics.CodeAnalysis.SuppressMessage ("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods")]
string Text { get; }
/// <summary>
/// Gets a character at the specified position in the document.
/// </summary>
/// <paramref name="offset">The index of the character to get.</paramref>
/// <exception cref="ArgumentOutOfRangeException">Offset is outside the valid range (0 to TextLength-1).</exception>
/// <returns>The character at the specified position.</returns>
/// <remarks>This is the same as Text[offset], but is more efficient because
/// it doesn't require creating a String object.</remarks>
char this [int offset] { get; }
/// <summary>
/// Gets a character at the specified position in the document.
/// </summary>
/// <paramref name="offset">The index of the character to get.</paramref>
/// <exception cref="ArgumentOutOfRangeException">Offset is outside the valid range (0 to TextLength-1).</exception>
/// <returns>The character at the specified position.</returns>
/// <remarks>This is the same as Text[offset], but is more efficient because
/// it doesn't require creating a String object.</remarks>
char GetCharAt (int offset);
/// <summary>
/// Retrieves the text for a portion of the document.
/// </summary>
/// <exception cref="ArgumentOutOfRangeException">offset or length is outside the valid range.</exception>
/// <remarks>This is the same as Text.Substring, but is more efficient because
/// it doesn't require creating a String object for the whole document.</remarks>
string GetTextAt (int offset, int length);
/// <summary>
/// Creates a new TextReader to read from this text source.
/// </summary>
TextReader CreateReader ();
/// <summary>
/// Creates a new TextReader to read from this text source.
/// </summary>
TextReader CreateReader (int offset, int length);
/// <summary>
/// Writes the text from this document into the TextWriter.
/// </summary>
void WriteTextTo (TextWriter writer);
/// <summary>
/// Writes the text from this document into the TextWriter.
/// </summary>
void WriteTextTo (TextWriter writer, int offset, int length);
/// <summary>
/// Creates an immutable snapshot of this text source.
/// Unlike all other methods in this interface, this method is thread-safe.
/// </summary>
ITextSource CreateSnapshot ();
/// <summary>
/// Creates an immutable snapshot of a part of this text source.
/// Unlike all other methods in this interface, this method is thread-safe.
/// </summary>
ITextSource CreateSnapshot (int offset, int length);
}
public static class TextSourceExtension
{
/// <summary>
/// Retrieves the text for a portion of the document.
/// </summary>
/// <exception cref="ArgumentOutOfRangeException">offset or length is outside the valid range.</exception>
public static string GetTextAt (this ITextSource source, ISegment segment)
{
if (source == null)
throw new ArgumentNullException ("source");
return source.GetTextAt (segment.Offset, segment.Length);
}
public static string GetTextBetween (this ITextSource source, int startOffset, int endOffset)
{
if (source == null)
throw new ArgumentNullException ("source");
if (startOffset < 0 || startOffset > source.Length)
throw new ArgumentNullException ("startOffset");
if (endOffset < 0 || endOffset > source.Length)
throw new ArgumentNullException ("endOffset");
if (startOffset > endOffset)
throw new InvalidOperationException ();
return source.GetTextAt (startOffset, endOffset - startOffset);
}
/// <summary>
/// Writes the text from this document into a file.
/// </summary>
public static void WriteTextTo (this ITextSource source, string fileName)
{
if (source == null)
throw new ArgumentNullException ("source");
TextFileUtility.WriteText (fileName, source.Text, source.Encoding, source.UseBOM);
}
/// <summary>
/// Writes the text from this document into the TextWriter.
/// </summary>
public static void WriteTextTo (this ITextSource source, TextWriter writer, ISegment segment)
{
if (source == null)
throw new ArgumentNullException ("source");
if (writer == null)
throw new ArgumentNullException ("writer");
if (segment == null)
throw new ArgumentNullException ("segment");
source.WriteTextTo (writer, segment.Offset, segment.Length);
}
/// <summary>
/// Creates a new TextReader to read from this text source.
/// </summary>
public static TextReader CreateReader (this ITextSource source, ISegment segment)
{
if (source == null)
throw new ArgumentNullException ("source");
if (segment == null)
throw new ArgumentNullException ("segment");
return source.CreateReader (segment.Offset, segment.Length);
}
/// <summary>
/// Creates an immutable snapshot of a part of this text source.
/// Unlike all other methods in this interface, this method is thread-safe.
/// </summary>
public static ITextSource CreateSnapshot (this ITextSource source, ISegment segment)
{
if (source == null)
throw new ArgumentNullException ("source");
if (segment == null)
throw new ArgumentNullException ("segment");
return source.CreateSnapshot (segment.Offset, segment.Length);
}
}
}
|
