//
//  EditingContext.swift
//  TextEditing
//
//  CotEditor
//  https://coteditor.com
//
//  Created by 1024jp on 2024-06-16.
//
//  ---------------------------------------------------------------------------
//
//  © 2024 1024jp
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//  https://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//

import struct Foundation.NSRange

public struct EditingContext: Equatable, Sendable {
    
    public var strings: [String]
    public var ranges: [NSRange]
    public var selectedRanges: [NSRange]?
    
    
    /// Creates abstracted context how to edit strings in a text editor.
    ///
    /// - Parameters:
    ///   - strings: The strings to replace with.
    ///   - ranges: The ranges where replace with `strings`.
    ///   - selectedRanges: The new selected ranges, or `nil` to let the editor set them.
    public init(strings: [String], ranges: [NSRange], selectedRanges: [NSRange]? = nil) {
        
        assert(strings.count == ranges.count)
        
        self.strings = strings
        self.ranges = ranges
        self.selectedRanges = selectedRanges
    }
}
