src/EditorFeatures/TestUtilities/CommentSelection/AbstractToggleCommentTestBase.cs - main - githubmirror/roslyn

src/EditorFeatures/TestUtilities/CommentSelection/AbstractToggleCommentTestBase.cs
96 строк4 KB
Cyrus Najmabadi
Use file scoped namespaces. (#77854)
27 мар 2025, 09:55
27 мар 2025, 09:5598d41b8
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#nullable disable

using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CommentSelection;
using Microsoft.CodeAnalysis.Editor;
using Microsoft.CodeAnalysis.Editor.UnitTests;
using Microsoft.CodeAnalysis.Editor.UnitTests.Utilities;
using Microsoft.CodeAnalysis.Text;
using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Text.Editor;
using Roslyn.Test.Utilities;
using Roslyn.Utilities;
using Xunit;

namespace Microsoft.CodeAnalysis.Test.Utilities.CommentSelection;

public abstract class AbstractToggleCommentTestBase
{
    internal abstract AbstractCommentSelectionBase<ValueTuple> GetToggleCommentCommandHandler(EditorTestWorkspace workspace);

    internal abstract EditorTestWorkspace GetWorkspace(string markup, TestComposition composition);

    protected void ToggleComment(string markup, string expected)
        => ToggleCommentMultiple(markup, [expected]);

    protected void ToggleCommentMultiple(string markup, string[] expectedText)
    {
        using var workspace = GetWorkspace(markup, composition: EditorTestCompositions.EditorFeatures);
        var doc = workspace.Documents.First();
        SetupSelection(doc.GetTextView(), doc.SelectedSpans.Select(s => Span.FromBounds(s.Start, s.End)));

        var commandHandler = GetToggleCommentCommandHandler(workspace);
        var textView = doc.GetTextView();
        var textBuffer = doc.GetTextBuffer();

        for (var i = 0; i < expectedText.Length; i++)
        {
            commandHandler.ExecuteCommand(textView, textBuffer, ValueTuple.Create(), TestCommandExecutionContext.Create());
            AssertCommentResult(doc.GetTextBuffer(), textView, expectedText[i]);
        }
    }

    protected void ToggleCommentWithProjectionBuffer(string surfaceBufferMarkup, string subjectBufferMarkup, string entireExpectedMarkup)
    {
        using var workspace = GetWorkspace(subjectBufferMarkup, composition: EditorTestCompositions.EditorFeatures);
        var document = workspace.CreateProjectionBufferDocument(surfaceBufferMarkup, workspace.Documents);
        SetupSelection(document.GetTextView(), document.SelectedSpans.Select(s => Span.FromBounds(s.Start, s.End)));

        var commandHandler = GetToggleCommentCommandHandler(workspace);
        var textView = document.GetTextView();
        var originalSubjectBuffer = GetBufferForContentType(ContentTypeNames.CSharpContentType, textView);

        commandHandler.ExecuteCommand(textView, originalSubjectBuffer, ValueTuple.Create(), TestCommandExecutionContext.Create());
        AssertCommentResult(textView.TextBuffer, textView, entireExpectedMarkup);
    }

    private static ITextBuffer GetBufferForContentType(string contentTypeName, ITextView textView)
        => textView.BufferGraph.GetTextBuffers(b => b.ContentType.IsOfType(contentTypeName)).Single();

    private static void AssertCommentResult(ITextBuffer textBuffer, IWpfTextView textView, string expectedText)
    {
        MarkupTestFile.GetSpans(expectedText, out var actualExpectedText, out var expectedSpans);

        Assert.Equal(actualExpectedText, textBuffer.CurrentSnapshot.GetText());

        if (!expectedSpans.IsEmpty)
        {
            AssertEx.Equal(expectedSpans, textView.Selection.SelectedSpans.Select(snapshotSpan => TextSpan.FromBounds(snapshotSpan.Start, snapshotSpan.End)));
        }
    }

    private static void SetupSelection(IWpfTextView textView, IEnumerable<Span> spans)
    {
        var snapshot = textView.TextSnapshot;
        if (spans.Count() == 1)
        {
            textView.Selection.Select(new SnapshotSpan(snapshot, spans.Single()), isReversed: false);
            textView.Caret.MoveTo(new SnapshotPoint(snapshot, spans.Single().End));
        }
        else if (spans.Count() > 1)
        {
            textView.Selection.Mode = TextSelectionMode.Box;
            textView.Selection.Select(new VirtualSnapshotPoint(snapshot, spans.First().Start),
                                      new VirtualSnapshotPoint(snapshot, spans.Last().End));
            textView.Caret.MoveTo(new SnapshotPoint(snapshot, spans.Last().End));
        }
    }
}