// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
// 
// 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.Collections.Generic;
using System;

namespace Rubberduck.UI.Services.Abstract;

public interface ITextMarkerService
{
    /// <summary>
    /// Creates a new text marker. The text marker will be invisible at first,
    /// you need to set one of the Color properties to make it visible.
    /// </summary>
    ITextMarker Create(int startOffset, int length);

    /// <summary>
    /// Gets the list of text markers.
    /// </summary>
    IEnumerable<ITextMarker> TextMarkers { get; }

    /// <summary>
    /// Removes the specified text marker.
    /// </summary>
    void Remove(ITextMarker marker);

    /// <summary>
    /// Removes all text markers that match the condition.
    /// </summary>
    void RemoveAll(Predicate<ITextMarker> predicate);

    /// <summary>
    /// Finds all text markers at the specified offset.
    /// </summary>
    IEnumerable<ITextMarker> GetMarkersAtOffset(int offset);
}
