/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/HighlightingRuleSet.cs

 1// Copyright (c) 2014 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
19using System;
20using System.Collections.Generic;
21using ICSharpCode.AvalonEdit.Utils;
22
23namespace ICSharpCode.AvalonEdit.Highlighting
24{
25	/// <summary>
26	/// A highlighting rule set describes a set of spans that are valid at a given code location.
27	/// </summary>
28	[Serializable]
29	public class HighlightingRuleSet
30	{
31		/// <summary>
32		/// Creates a new RuleSet instance.
33		/// </summary>
34		public HighlightingRuleSet()
35		{
36			this.Spans = new NullSafeCollection<HighlightingSpan>();
37			this.Rules = new NullSafeCollection<HighlightingRule>();
38		}
39		
40		/// <summary>
41		/// Gets/Sets the name of the rule set.
42		/// </summary>
43		public string Name { get; set; }
44		
45		/// <summary>
46		/// Gets the list of spans.
47		/// </summary>
48		public IList<HighlightingSpan> Spans { get; private set; }
49		
50		/// <summary>
51		/// Gets the list of rules.
52		/// </summary>
53		public IList<HighlightingRule> Rules { get; private set; }
54		
55		/// <inheritdoc/>
56		public override string ToString()
57		{
58			return "[" + GetType().Name + " " + Name + "]";
59		}
60	}
61}