source: branches/2708_ScopedAlgorithms/HeuristicLab.ExtLibs/HeuristicLab.AvalonEdit/5.0.1/AvalonEdit-5.0.1/Document/ILineTracker.cs @ 16752

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

namespace ICSharpCode.AvalonEdit.Document
{
  /// <summary>
  /// Allows for low-level line tracking.
  /// </summary>
  /// <remarks>
  /// The methods on this interface are called by the TextDocument's LineManager immediately after the document
  /// has changed, *while* the DocumentLineTree is updating.
  /// Thus, the DocumentLineTree may be in an invalid state when these methods are called.
  /// This interface should only be used to update per-line data structures like the HeightTree.
  /// Line trackers must not cause any events to be raised during an update to prevent other code from seeing
  /// the invalid state.
  /// Line trackers may be called while the TextDocument has taken a lock.
  /// You must be careful not to dead-lock inside ILineTracker callbacks.
  /// </remarks>
  public interface ILineTracker
  {
    /// <summary>
    /// Is called immediately before a document line is removed.
    /// </summary>
    void BeforeRemoveLine(DocumentLine line);
    
//    /// <summary>
//    /// Is called immediately after a document line is removed.
//    /// </summary>
//    void AfterRemoveLine(DocumentLine line);
    
    /// <summary>
    /// Is called immediately before a document line changes length.
    /// This method will be called whenever the line is changed, even when the length stays as it is.
    /// The method might be called multiple times for a single line because
    /// a replacement is internally handled as removal followed by insertion.
    /// </summary>
    void SetLineLength(DocumentLine line, int newTotalLength);
    
    /// <summary>
    /// Is called immediately after a line was inserted.
    /// </summary>
    /// <param name="newLine">The new line</param>
    /// <param name="insertionPos">The existing line before the new line</param>
    void LineInserted(DocumentLine insertionPos, DocumentLine newLine);
    
    /// <summary>
    /// Indicates that there were changes to the document that the line tracker was not notified of.
    /// The document is in a consistent state (but the line trackers aren't), and line trackers should
    /// throw away their data and rebuild the document.
    /// </summary>
    void RebuildDocument();
    
    /// <summary>
    /// Notifies the line tracker that a document change (a single change, not a change group) has completed.
    /// This method gets called after the change has been performed, but before the <see cref="TextDocument.Changed"/> event
    /// is raised.
    /// </summary>
    void ChangeComplete(DocumentChangeEventArgs e);
  }
}