← Back to branch summary

~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to contrib/ICSharpCode.NRefactory/Editor/ISegment.cs

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
contrib/ICSharpCode.NRefactory/Editor/ISegment.cs
1
 
// Copyright (c) AlphaSierraPapa for the SharpDevelop Team
2
 
// 
3
 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
4
 
// software and associated documentation files (the "Software"), to deal in the Software
5
 
// without restriction, including without limitation the rights to use, copy, modify, merge,
6
 
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
7
 
// to whom the Software is furnished to do so, subject to the following conditions:
8
 
// 
9
 
// The above copyright notice and this permission notice shall be included in all copies or
10
 
// substantial portions of the Software.
11
 
// 
12
 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
13
 
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
14
 
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
15
 
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
16
 
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
17
 
// DEALINGS IN THE SOFTWARE.
18
 
 
19
 
using System;
20
 
 
21
 
namespace ICSharpCode.NRefactory.Editor
22
 
{
23
 
        /// <summary>
24
 
        /// An (Offset,Length)-pair.
25
 
        /// </summary>
26
 
        public interface ISegment
27
 
        {
28
 
                /// <summary>
29
 
                /// Gets the start offset of the segment.
30
 
                /// </summary>
31
 
                int Offset { get; }
32
 
                
33
 
                /// <summary>
34
 
                /// Gets the length of the segment.
35
 
                /// </summary>
36
 
                /// <remarks>For line segments (IDocumentLine), the length does not include the line delimeter.</remarks>
37
 
                int Length { get; }
38
 
                
39
 
                /// <summary>
40
 
                /// Gets the end offset of the segment.
41
 
                /// </summary>
42
 
                /// <remarks>EndOffset = Offset + Length;</remarks>
43
 
                int EndOffset { get; }
44
 
        }
45
 
        
46
 
        /// <summary>
47
 
        /// Extension methods for <see cref="ISegment"/>.
48
 
        /// </summary>
49
 
        public static class ISegmentExtensions
50
 
        {
51
 
                /// <summary>
52
 
                /// Gets whether <paramref name="segment"/> fully contains the specified segment.
53
 
                /// </summary>
54
 
                /// <remarks>
55
 
                /// Use <c>segment.Contains(offset, 0)</c> to detect whether a segment (end inclusive) contains offset;
56
 
                /// use <c>segment.Contains(offset, 1)</c> to detect whether a segment (end exclusive) contains offset.
57
 
                /// </remarks>
58
 
                public static bool Contains (this ISegment segment, int offset, int length)
59
 
                {
60
 
                        return segment.Offset <= offset && offset + length <= segment.EndOffset;
61
 
                }
62
 
                
63
 
                /// <summary>
64
 
                /// Gets whether <paramref name="thisSegment"/> fully contains the specified segment.
65
 
                /// </summary>
66
 
                public static bool Contains (this ISegment thisSegment, ISegment segment)
67
 
                {
68
 
                        return segment != null && thisSegment.Offset <= segment.Offset && segment.EndOffset <= thisSegment.EndOffset;
69
 
                }
70
 
        }
71
 
}