source: branches/2915-AbsoluteSymbol/HeuristicLab.ExtLibs/HeuristicLab.AvalonEdit/5.0.1/AvalonEdit-5.0.1/Document/LineNode.cs @ 16300

// 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
{
  using LineNode = DocumentLine;
  
  // A tree node in the document line tree.
  // For the purpose of the invariants, "children", "descendents", "siblings" etc. include the DocumentLine object,
  // it is treated as a third child node between left and right.
  
  // Originally, this was a separate class, with a reference to the documentLine. The documentLine had a reference
  // back to the node. To save memory, the same object is used for both the documentLine and the line node.
  // This saves 16 bytes per line (8 byte object overhead + two pointers).
//  sealed class LineNode
//  {
//    internal readonly DocumentLine documentLine;
  partial class DocumentLine
  {
    internal DocumentLine left, right, parent;
    internal bool color;
    // optimization note: I tried packing color and isDeleted into a single byte field, but that
    // actually increased the memory requirements. The JIT packs two bools and a byte (delimiterSize)
    // into a single DWORD, but two bytes get each their own DWORD. Three bytes end up in the same DWORD, so
    // apparently the JIT only optimizes for memory when there are at least three small fields.
    // Currently, DocumentLine takes 36 bytes on x86 (8 byte object overhead, 3 pointers, 3 ints, and another DWORD
    // for the small fields).
    // TODO: a possible optimization would be to combine 'totalLength' and the small fields into a single uint.
    // delimiterSize takes only two bits, the two bools take another two bits; so there's still 
    // 28 bits left for totalLength. 268435455 characters per line should be enough for everyone :)
    
    /// <summary>
    /// Resets the line to enable its reuse after a document rebuild.
    /// </summary>
    internal void ResetLine()
    {
      totalLength = delimiterLength = 0;
      isDeleted = color = false;
      left = right = parent = null;
    }
    
    internal LineNode InitLineNode()
    {
      this.nodeTotalCount = 1;
      this.nodeTotalLength = this.TotalLength;
      return this;
    }
    
    internal LineNode LeftMost {
      get {
        LineNode node = this;
        while (node.left != null)
          node = node.left;
        return node;
      }
    }
    
    internal LineNode RightMost {
      get {
        LineNode node = this;
        while (node.right != null)
          node = node.right;
        return node;
      }
    }
    
    /// <summary>
    /// The number of lines in this node and its child nodes.
    /// Invariant:
    ///   nodeTotalCount = 1 + left.nodeTotalCount + right.nodeTotalCount
    /// </summary>
    internal int nodeTotalCount;
    
    /// <summary>
    /// The total text length of this node and its child nodes.
    /// Invariant:
    ///   nodeTotalLength = left.nodeTotalLength + documentLine.TotalLength + right.nodeTotalLength
    /// </summary>
    internal int nodeTotalLength;
  }
}