aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Scripting/Tango.Scripting.Editors/Xml/TrackedSegmentCollection.cs
blob: f8e516591038939fe124e41a0ec3e576cda442b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimit
// Copyright (c) AlphaSierraPapa for the SharpDevelop Team (for details please see \doc\copyright.txt)
// This code is distributed under the GNU LGPL (for details please see \doc\license.txt)

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;

using Tango.Scripting.Editors.Document;

namespace Tango.Scripting.Editors.Xml
{
	/// <summary>
	/// Holds all objects that need to keep offsets up to date.
	/// </summary>
	class TrackedSegmentCollection
	{
		/// <summary>
		/// Holds all types of objects in one collection.
		/// </summary>
		TextSegmentCollection<TextSegment> segments = new TextSegmentCollection<TextSegment>();
		
		/// <summary>
		/// Is used to identify what memory range was touched by object
		/// The default is (StartOffset, EndOffset + 1) which is not stored
		/// </summary>
		class TouchedRange: TextSegment
		{
			public AXmlObject TouchedByObject { get; set; }
		}
		
		public void UpdateOffsetsAndInvalidate(IEnumerable<DocumentChangeEventArgs> changes)
		{
			foreach(DocumentChangeEventArgs change in changes) {
				// Update offsets of all items
				segments.UpdateOffsets(change);
				
				// Remove any items affected by the change
				AXmlParser.Log("Changed {0}-{1}", change.Offset, change.Offset + change.InsertionLength);
				// Removing will cause one of the ends to be set to change.Offset
				// FindSegmentsContaining includes any segments touching
				// so that conviniently takes care of the +1 byte
				var segmentsContainingOffset = segments.FindOverlappingSegments(change.Offset, change.InsertionLength);
				foreach(AXmlObject obj in segmentsContainingOffset.OfType<AXmlObject>().Where(o => o.IsCached)) {
					InvalidateCache(obj, false);
				}
				foreach(TouchedRange range in segmentsContainingOffset.OfType<TouchedRange>()) {
					AXmlParser.Log("Found that {0} dependeds on ({1}-{2})", range.TouchedByObject, range.StartOffset, range.EndOffset);
					InvalidateCache(range.TouchedByObject, true);
					segments.Remove(range);
				}
			}
		}
		
		/// <summary>
		/// Invlidates all objects.  That is, the whole document has changed.
		/// </summary>
		/// <remarks> We still have to keep the items becuase they might be in the document </remarks>
		public void InvalidateAll()
		{
			AXmlParser.Log("Invalidating all objects");
			foreach(AXmlObject obj in segments.OfType<AXmlObject>()) {
				obj.IsCached = false;
			}
		}
		
		/// <summary> Add object to cache, optionally adding extra memory tracking </summary>
		public void AddParsedObject(AXmlObject obj, int? maxTouchedLocation)
		{
			if (!(obj.Length > 0 || obj is AXmlDocument))
				AXmlParser.Assert(false, string.Format(CultureInfo.InvariantCulture, "Invalid object {0}.  It has zero length.", obj));
//			// Expensive check
//			if (obj is AXmlContainer) {
//				int objStartOffset = obj.StartOffset;
//				int objEndOffset = obj.EndOffset;
//				foreach(AXmlObject child in ((AXmlContainer)obj).Children) {
//					AXmlParser.Assert(objStartOffset <= child.StartOffset && child.EndOffset <= objEndOffset, "Wrong nesting");
//				}
//			}
			segments.Add(obj);
			AddSyntaxErrorsOf(obj);
			obj.IsCached = true;
			if (maxTouchedLocation != null) {
				// location is assumed to be read so the range ends at (location + 1)
				// For example eg for "a_" it is (0-2)
				TouchedRange range = new TouchedRange() {
					StartOffset = obj.StartOffset,
					EndOffset = maxTouchedLocation.Value + 1,
					TouchedByObject = obj
				};
				segments.Add(range);
				AXmlParser.Log("{0} touched range ({1}-{2})", obj, range.StartOffset, range.EndOffset);
			}
		}
		
		/// <summary> Removes object with all of its non-cached children </summary>
		public void RemoveParsedObject(AXmlObject obj)
		{
			// Cached objects may be used in the future - do not remove them
			if (obj.IsCached) return;
			segments.Remove(obj);
			RemoveSyntaxErrorsOf(obj);
			AXmlParser.Log("Stopped tracking {0}", obj);
			
			AXmlContainer container = obj as AXmlContainer;
			if (container != null) {
				foreach (AXmlObject child in container.Children) {
					RemoveParsedObject(child);
				}
			}
		}
		
		public void AddSyntaxErrorsOf(AXmlObject obj)
		{
			foreach(SyntaxError syntaxError in obj.MySyntaxErrors) {
				segments.Add(syntaxError);
			}
		}
		
		public void RemoveSyntaxErrorsOf(AXmlObject obj)
		{
			foreach(SyntaxError syntaxError in obj.MySyntaxErrors) {
				segments.Remove(syntaxError);
			}
		}
		
		IEnumerable<AXmlObject> FindParents(AXmlObject child)
		{
			int childStartOffset = child.StartOffset;
			int childEndOffset = child.EndOffset;
			foreach(AXmlObject parent in segments.FindSegmentsContaining(child.StartOffset).OfType<AXmlObject>()) {
				// Parent is anyone wholy containg the child
				if (parent.StartOffset <= childStartOffset && childEndOffset <= parent.EndOffset && parent != child) {
					yield return parent;
				}
			}
		}
		
		/// <summary> Invalidates items, but keeps tracking them </summary>
		/// <remarks> Can be called redundantly (from range tacking) </remarks>
		void InvalidateCache(AXmlObject obj, bool includeParents)
		{
			if (includeParents) {
				foreach(AXmlObject parent in FindParents(obj)) {
					parent.IsCached = false;
					AXmlParser.Log("Invalidating cached item {0} (it is parent)", parent);
				}
			}
			obj.IsCached = false;
			AXmlParser.Log("Invalidating cached item {0}", obj);
		}
		
		public T GetCachedObject<T>(int offset, int lookaheadCount, Predicate<T> conditon) where T: AXmlObject, new()
		{
			TextSegment obj = segments.FindFirstSegmentWithStartAfter(offset);
			while(obj != null && offset <= obj.StartOffset && obj.StartOffset <= offset + lookaheadCount) {
				if (obj is T && ((AXmlObject)obj).IsCached && conditon((T)obj)) {
					return (T)obj;
				}
				obj = segments.GetNextSegment(obj);
			}
			return null;
		}
	}
}