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
|
//
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
//
using Microsoft.VisualStudio.Text.Projection;
namespace Microsoft.VisualStudio.Text.Differencing
{
/// <summary>
/// A factory for creating <see cref="IDifferenceBuffer"/> instances.
/// </summary>
/// <remarks>
/// This is a MEF service and can be imported.
/// </remarks>
public interface IDifferenceBufferFactoryService
{
/// <summary>
/// Create an <see cref="IDifferenceBuffer"/> for the given left and right buffers.
/// </summary>
/// <param name="leftBaseBuffer">The left (old, before) buffer.</param>
/// <param name="rightBaseBuffer">The right (new, after) buffer.</param>
/// <remarks>This is equivalent to calling <c>CreateDifferenceBuffer(left, right, new StringDifferenceOptions());</c>.</remarks>
IDifferenceBuffer CreateDifferenceBuffer(ITextBuffer leftBaseBuffer, ITextBuffer rightBaseBuffer);
/// <summary>
/// Create an <see cref="IDifferenceBuffer"/> for the given left and right buffers and with the given difference options.
/// </summary>
/// <param name="leftBaseBuffer">The left (old, before) buffer.</param>
/// <param name="rightBaseBuffer">The right (new, after) buffer.</param>
/// <param name="options">The options to use in computing differences between the buffers.</param>
/// <param name="disableEditing">If true, disable editing in the right and inlines views.</param>
/// <param name="wrapLeftBuffer">If true, create a read-only projection of <paramref name="leftBaseBuffer"/> (which will prevent
/// that buffer from being modified through the difference buffers).</param>
/// <param name="wrapRightBuffer">If true and editing is disabled, create a read-only projection of <paramref name="rightBaseBuffer"/> (which will prevent
/// that buffer from being modified through the difference buffers).</param>
/// <remarks>
/// <para>If <paramref name="disableEditing"/> is false, then <paramref name="wrapRightBuffer"/> is ignored (and the right buffer will not be wrapped).</para>
/// <para>If <paramref name="wrapLeftBuffer"/> is false, then the caller of this method is responsible for making sure <paramref name="leftBaseBuffer"/> is read-only.</para>
/// <para>If <paramref name="disableEditing"/> is true and <paramref name="wrapRightBuffer"/> is false, then the caller of this method is responsible for making sure <paramref name="rightBaseBuffer"/> is read-only.</para>
/// <para>If <paramref name="wrapLeftBuffer"/> is true, then <paramref name="leftBaseBuffer"/> can be null.</para>
/// </remarks>
IDifferenceBuffer CreateDifferenceBuffer(ITextBuffer leftBaseBuffer, ITextBuffer rightBaseBuffer, StringDifferenceOptions options,
bool disableEditing = false, bool wrapLeftBuffer = true, bool wrapRightBuffer = true);
/// <summary>
/// If there is a <see cref="IDifferenceBuffer"/> for the given projection buffer, retrieve it.
/// </summary>
/// <returns>The difference buffer if one exists, <c>null</c> otherwise.</returns>
IDifferenceBuffer TryGetDifferenceBuffer(IProjectionBufferBase projectionBuffer);
}
}
|
