source: trunk/HeuristicLab.ExtLibs/HeuristicLab.NRefactory/5.5.0/NRefactory-5.5.0/Editor/ISegment.cs @ 16752

// Copyright (c) 2010-2013 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;

namespace ICSharpCode.NRefactory.Editor
{
  /// <summary>
  /// An (Offset,Length)-pair.
  /// </summary>
  public interface ISegment
  {
    /// <summary>
    /// Gets the start offset of the segment.
    /// </summary>
    int Offset { get; }
    
    /// <summary>
    /// Gets the length of the segment.
    /// </summary>
    /// <remarks>For line segments (IDocumentLine), the length does not include the line delimeter.</remarks>
    int Length { get; }
    
    /// <summary>
    /// Gets the end offset of the segment.
    /// </summary>
    /// <remarks>EndOffset = Offset + Length;</remarks>
    int EndOffset { get; }
  }
  
  /// <summary>
  /// Extension methods for <see cref="ISegment"/>.
  /// </summary>
  public static class ISegmentExtensions
  {
    /// <summary>
    /// Gets whether <paramref name="segment"/> fully contains the specified segment.
    /// </summary>
    /// <remarks>
    /// Use <c>segment.Contains(offset, 0)</c> to detect whether a segment (end inclusive) contains offset;
    /// use <c>segment.Contains(offset, 1)</c> to detect whether a segment (end exclusive) contains offset.
    /// </remarks>
    public static bool Contains (this ISegment segment, int offset, int length)
    {
      return segment.Offset <= offset && offset + length <= segment.EndOffset;
    }
    
    /// <summary>
    /// Gets whether <paramref name="thisSegment"/> fully contains the specified segment.
    /// </summary>
    public static bool Contains (this ISegment thisSegment, ISegment segment)
    {
      return segment != null && thisSegment.Offset <= segment.Offset && segment.EndOffset <= thisSegment.EndOffset;
    }
  }
}