// 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>

/// A line inside a <see cref="IDocument"/>.

/// </summary>

public interface IDocumentLine : ISegment

{

/// <summary>

/// Gets the length of this line, including the line delimiter.

/// </summary>

int TotalLength { get; }

/// <summary>

/// Gets the length of the line terminator.

/// Returns 1 or 2; or 0 at the end of the document.

/// </summary>

int DelimiterLength { get; }

/// <summary>

/// Gets the number of this line.

/// The first line has the number 1.

/// </summary>

int LineNumber { get; }

/// <summary>

/// Gets the previous line. Returns null if this is the first line in the document.

/// </summary>

IDocumentLine PreviousLine { get; }

/// <summary>

/// Gets the next line. Returns null if this is the last line in the document.

/// </summary>

IDocumentLine NextLine { get; }

/// <summary>

/// Gets whether the line was deleted.

/// </summary>

bool IsDeleted { get; }

}

}