/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/Xshd/XshdSpan.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;
20
21namespace ICSharpCode.AvalonEdit.Highlighting.Xshd
22{
23	/// <summary>
24	/// Specifies the type of the regex.
25	/// </summary>
26	public enum XshdRegexType
27	{
28		/// <summary>
29		/// Normal regex. Used when the regex was specified as attribute.
30		/// </summary>
31		Default,
32		/// <summary>
33		/// Ignore pattern whitespace / allow regex comments. Used when the regex was specified as text element.
34		/// </summary>
35		[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1702:CompoundWordsShouldBeCasedCorrectly",
36		                                                 Justification = "Using the same case as the RegexOption")]
37		IgnorePatternWhitespace
38	}
39	
40	/// <summary>
41	/// &lt;Span&gt; element.
42	/// </summary>
43	[Serializable]
44	public class XshdSpan : XshdElement
45	{
46		/// <summary>
47		/// Gets/sets the begin regex.
48		/// </summary>
49		public string BeginRegex { get; set; }
50		
51		/// <summary>
52		/// Gets/sets the begin regex type.
53		/// </summary>
54		public XshdRegexType BeginRegexType { get; set; }
55		
56		/// <summary>
57		/// Gets/sets the end regex.
58		/// </summary>
59		public string EndRegex { get; set; }
60		
61		/// <summary>
62		/// Gets/sets the end regex type.
63		/// </summary>
64		public XshdRegexType EndRegexType { get; set; }
65		
66		/// <summary>
67		/// Gets/sets whether the span is multiline.
68		/// </summary>
69		public bool Multiline { get; set; }
70		
71		/// <summary>
72		/// Gets/sets the rule set reference.
73		/// </summary>
74		public XshdReference<XshdRuleSet> RuleSetReference { get; set; }
75		
76		/// <summary>
77		/// Gets/sets the span color.
78		/// </summary>
79		public XshdReference<XshdColor> SpanColorReference { get; set; }
80		
81		/// <summary>
82		/// Gets/sets the span begin color.
83		/// </summary>
84		public XshdReference<XshdColor> BeginColorReference { get; set; }
85		
86		/// <summary>
87		/// Gets/sets the span end color.
88		/// </summary>
89		public XshdReference<XshdColor> EndColorReference { get; set; }
90		
91		/// <inheritdoc/>
92		public override object AcceptVisitor(IXshdVisitor visitor)
93		{
94			return visitor.VisitSpan(this);
95		}
96	}
97}