﻿// 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.Collections.Generic;
using System.Collections.Immutable;
using Microsoft.CodeAnalysis.Text;

namespace Microsoft.CodeAnalysis.CommentSelection
{
    internal readonly struct CommentSelectionResult(IEnumerable<TextChange> textChanges, IEnumerable<CommentTrackingSpan> trackingSpans, Operation resultOperation)
    {
        /// <summary>
        /// Text changes to make for this operation.
        /// </summary>
        public ImmutableArray<TextChange> TextChanges { get; } = textChanges.ToImmutableArray();
        /// <summary>
        /// Tracking spans used to format and set the output selection after edits.
        /// </summary>
        public ImmutableArray<CommentTrackingSpan> TrackingSpans { get; } = trackingSpans.ToImmutableArray();
        /// <summary>
        /// The type of text changes being made.
        /// This is known beforehand in some cases (comment selection)
        /// and determined after as a result in others (toggle comment).
        /// </summary>
        public Operation ResultOperation { get; } = resultOperation;
    }
}
