Add Underline attribute in syntax highlighting

julodnik · dgrunwald · commit a81b6c234937 · 2014-08-23T14:14:03.000+02:00
diff --git a/data/resources/StringResources.resx b/data/resources/StringResources.resx
@@ -1729,6 +1729,9 @@ Examples: "120", "MainClass", "Main.cs, 120".</value>
   <data name="Dialog.HighlightingEditor.ColorDlg.Italic" xml:space="preserve">
     <value>Italic</value>
   </data>
+  <data name="Dialog.HighlightingEditor.ColorDlg.Underline" xml:space="preserve">
+    <value>Underlined</value>
+  </data>
   <data name="Dialog.HighlightingEditor.Export" xml:space="preserve">
     <value>Export highlighting colors</value>
   </data>
diff --git a/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/CustomizedHighlightingColor.cs b/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/CustomizedHighlightingColor.cs
@@ -43,6 +43,7 @@ public class CustomizedHighlightingColor
 		
 		public bool Bold { get; set; }
 		public bool Italic { get; set; }
+		public bool Underline { get; set; }
 		public Color? Foreground { get; set; }
 		public Color? Background { get; set; }
 		
diff --git a/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/Options/CustomizedHighlightingItem.cs b/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/Options/CustomizedHighlightingItem.cs
@@ -66,14 +66,15 @@ void AllPropertiesChanged()
 		{
 			OnPropertyChanged("Bold");
 			OnPropertyChanged("Italic");
+			OnPropertyChanged("Underline");
 			OnPropertyChanged("Foreground");
 			OnPropertyChanged("UseDefaultForeground");
 			OnPropertyChanged("Background");
 			OnPropertyChanged("UseDefaultBackground");
 			OnPropertyChanged("IsCustomized");
 		}
 		
-		void SetCustomization(bool? bold = null, bool? italic = null,
+		void SetCustomization(bool? bold = null, bool? italic = null, bool? underline = null,
 		                      Color? foreground = null, bool? useDefaultForeground = null,
 		                      Color? background = null, bool? useDefaultBackground = null)
 		{
@@ -82,6 +83,7 @@ void SetCustomization(bool? bold = null, bool? italic = null,
 			newColor.Name = this.Name;
 			newColor.Bold = bold ?? this.Bold;
 			newColor.Italic = italic ?? this.Italic;
+			newColor.Underline = underline ?? this.Underline;
 			
 			if (useDefaultBackground ?? this.UseDefaultBackground)
 				newColor.Background = null;
@@ -99,7 +101,7 @@ void SetCustomization(bool? bold = null, bool? italic = null,
 			else if (customization != null)
 				customizationList.Remove(customization);
 			
-			if (newColor.Bold == original.Bold && newColor.Italic == original.Italic &&
+			if (newColor.Bold == original.Bold && newColor.Italic == original.Italic && newColor.Underline == original.Underline &&
 			    (newColor.Background == null) == original.UseDefaultBackground &&
 			    (newColor.Background == null || newColor.Background == original.Background) &&
 			    (newColor.Foreground == null) == original.UseDefaultForeground &&
@@ -140,6 +142,15 @@ public bool Italic {
 			}
 		}
 		
+		public bool Underline {
+			get {
+				return (customization != null) ? customization.Underline : original.Underline;
+			}
+			set {
+				SetCustomization(underline: value);
+			}
+		}
+		
 		public Color Foreground {
 			get {
 				return (customization != null) ? (customization.Foreground ?? original.Foreground) : original.Foreground;
@@ -191,7 +202,7 @@ public bool IsCustomized {
 		public void Reset()
 		{
 			original.Reset();
-			SetCustomization(original.Bold, original.Italic, original.Foreground, original.UseDefaultForeground, original.Background, original.UseDefaultBackground);
+			SetCustomization(original.Bold, original.Italic, original.Underline, original.Foreground, original.UseDefaultForeground, original.Background, original.UseDefaultBackground);
 			AllPropertiesChanged();
 		}
 		
diff --git a/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/Options/HighlightingOptions.xaml b/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/Options/HighlightingOptions.xaml
@@ -44,6 +44,8 @@
 				          Content="{core:Localize Dialog.HighlightingEditor.ColorDlg.Bold}"/>
 				<CheckBox IsEnabled="{Binding CanSetFont}" IsChecked="{Binding Italic}"
 				          Content="{core:Localize Dialog.HighlightingEditor.ColorDlg.Italic}"/>
+				<CheckBox IsEnabled="{Binding CanSetFont}" IsChecked="{Binding Underline}"
+				          Content="{core:Localize Dialog.HighlightingEditor.ColorDlg.Underline}"/>
 				<Button Name="resetButton" IsEnabled="{Binding IsCustomized}" HorizontalAlignment="Left"
 				        Click="ResetButtonClick" Style="{x:Static core:GlobalStyles.ButtonStyle}" Margin="0,4"
 				        Content="Reset" />
diff --git a/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/Options/IHighlightingItem.cs b/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/Options/IHighlightingItem.cs
@@ -43,6 +43,11 @@ public interface IHighlightingItem : INotifyPropertyChanged
 		/// </summary>
 		bool Italic { get; set; }
 		
+		/// <summary>
+		/// Gets/Sets whether the element uses an underlined font.
+		/// </summary>
+		bool Underline { get; set; }
+		
 		Color Foreground { get; set; }
 		bool UseDefaultForeground { get; set; }
 		Color Background { get; set; }
diff --git a/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/Options/NamedColorHighlightingItem.cs b/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/Options/NamedColorHighlightingItem.cs
@@ -68,6 +68,15 @@ public bool Italic {
 			}
 		}
 		
+		public bool Underline {
+			get {
+				return color.Underline;
+			}
+			set {
+				throw new NotSupportedException();
+			}
+		}
+		
 		public Color Foreground {
 			get {
 				Color? c = color.Foreground != null ? color.Foreground.GetColor(null) : null;
@@ -161,7 +170,12 @@ public void ShowExample(TextArea exampleTextArea)
 							marker.ForegroundColor = item.Foreground;
 							marker.FontStyle = item.Italic ? FontStyles.Italic : FontStyles.Normal;
 							marker.FontWeight = item.Bold ? FontWeights.Bold : FontWeights.Normal;
-						});
+							if(item.Underline)
+							{
+								marker.MarkerColor = item.Foreground;
+								marker.MarkerTypes = TextMarkerTypes.NormalUnderline;
+							}
+					});
 				}
 			} else {
 				exampleTextArea.Document.Text = exampleText;
diff --git a/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/Options/SimpleHighlightingItem.cs b/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/Options/SimpleHighlightingItem.cs
@@ -40,6 +40,7 @@ public event PropertyChangedEventHandler PropertyChanged { add {} remove {} }
 		public string Name { get; private set; }
 		public bool Bold { get; set; }
 		public bool Italic { get; set; }
+		public bool Underline { get; set; }
 		
 		public Color Foreground { get; set; }
 		public bool UseDefaultForeground { get; set; }
diff --git a/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/SyntaxHighlighting/CustomizingHighlighter.cs b/src/AddIns/DisplayBindings/AvalonEdit.AddIn/Src/SyntaxHighlighting/CustomizingHighlighter.cs
@@ -267,7 +267,8 @@ internal static HighlightingColor CustomizeColor(string name, IEnumerable<Custom
 						Background = CreateBrush(customization.Background),
 						Foreground = CreateBrush(customization.Foreground),
 						FontWeight = customization.Bold ? FontWeights.Bold : FontWeights.Normal,
-						FontStyle = customization.Italic ? FontStyles.Italic : FontStyles.Normal
+						FontStyle = customization.Italic ? FontStyles.Italic : FontStyles.Normal,
+						Underline = customization.Underline
 					};
 				}
 			}
diff --git a/src/AddIns/DisplayBindings/HexEditor/Project/Src/View/HexEditOptionsPanel.xaml.cs b/src/AddIns/DisplayBindings/HexEditor/Project/Src/View/HexEditOptionsPanel.xaml.cs
@@ -103,6 +103,8 @@ void SetPreview(TextBlock preview, System.Drawing.Font font)
 				preview.FontWeight = FontWeights.Bold;
 			else
 				preview.FontWeight = FontWeights.Normal;
+			if (font.Underline)
+				preview.TextDecorations = TextDecorations.Underline;
 		}
 	}
 }
diff --git a/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/HighlightedInlineBuilder.cs b/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/HighlightedInlineBuilder.cs
@@ -113,7 +113,7 @@ public void SetHighlighting(int offset, int length, HighlightingColor color)
 		{
 			if (color == null)
 				throw new ArgumentNullException("color");
-			if (color.Foreground == null && color.Background == null && color.FontStyle == null && color.FontWeight == null) {
+			if (color.Foreground == null && color.Background == null && color.FontStyle == null && color.FontWeight == null && color.Underline == null) {
 				// Optimization: don't split the HighlightingState when we're not changing
 				// any property. For example, the "Punctuation" color in C# is
 				// empty by default.
diff --git a/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/HighlightingColor.cs b/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/HighlightingColor.cs
@@ -38,6 +38,7 @@ public class HighlightingColor : ISerializable, IFreezable, ICloneable, IEquatab
 		string name;
 		FontWeight? fontWeight;
 		FontStyle? fontStyle;
+		bool? underline;
 		HighlightingBrush foreground;
 		HighlightingBrush background;
 		bool frozen;
@@ -84,6 +85,20 @@ public FontStyle? FontStyle {
 			}
 		}
 		
+		/// <summary>
+      ///  Gets/sets the underline flag. Null if the underline status does not change the font style.
+      /// </summary>
+      public bool? Underline {
+      	get {
+				return underline;
+			}
+			set {
+				if (frozen)
+					throw new InvalidOperationException();
+				underline = value;
+			}
+      }    
+		
 		/// <summary>
 		/// Gets/sets the foreground color applied by the highlighting.
 		/// </summary>
diff --git a/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/HighlightingColorizer.cs b/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/HighlightingColorizer.cs
@@ -18,6 +18,7 @@
 
 using System;
 using System.Diagnostics;
+using System.Windows;
 using System.Windows.Media;
 using ICSharpCode.AvalonEdit.Document;
 using ICSharpCode.AvalonEdit.Rendering;
@@ -231,7 +232,8 @@ internal static bool IsEmptyColor(HighlightingColor color)
 			if (color == null)
 				return true;
 			return color.Background == null && color.Foreground == null
-				&& color.FontStyle == null && color.FontWeight == null;
+				&& color.FontStyle == null && color.FontWeight == null
+				&& color.Underline == null;
 		}
 		
 		/// <summary>
@@ -254,7 +256,7 @@ internal static void ApplyColorToElement(VisualLineElement element, Highlighting
 				if (b != null)
 					element.BackgroundBrush = b;
 			}
-			if (color.FontStyle != null || color.FontWeight != null) {
+			if (color.FontStyle != null || color.FontWeight != null || color.Underline != null) {
 				Typeface tf = element.TextRunProperties.Typeface;
 				element.TextRunProperties.SetTypeface(new Typeface(
 					tf.FontFamily,
@@ -263,6 +265,8 @@ internal static void ApplyColorToElement(VisualLineElement element, Highlighting
 					tf.Stretch
 				));
 			}
+			if(color.Underline ?? false)
+               element.TextRunProperties.SetTextDecorations(TextDecorations.Underline);           
 		}
 		
 		/// <summary>
diff --git a/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/Xshd/V2Loader.cs b/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/Xshd/V2Loader.cs
@@ -297,6 +297,7 @@ static XshdColor ParseColorAttributes(XmlReader reader)
 			color.Background = ParseColor(position, reader.GetAttribute("background"));
 			color.FontWeight = ParseFontWeight(reader.GetAttribute("fontWeight"));
 			color.FontStyle = ParseFontStyle(reader.GetAttribute("fontStyle"));
+			color.Underline = reader.GetAttribute("underline") == "true";
 			return color;
 		}
 		
diff --git a/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/Xshd/XmlHighlightingDefinition.cs b/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/Xshd/XmlHighlightingDefinition.cs
@@ -204,6 +204,7 @@ public object VisitColor(XshdColor color)
 				c.Name = color.Name;
 				c.Foreground = color.Foreground;
 				c.Background = color.Background;
+				c.Underline = color.Underline;
 				c.FontStyle = color.FontStyle;
 				c.FontWeight = color.FontWeight;
 				return c;
diff --git a/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/Xshd/XshdColor.cs b/src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Highlighting/Xshd/XshdColor.cs
@@ -49,6 +49,11 @@ public class XshdColor : XshdElement, ISerializable
 		/// </summary>
 		public FontWeight? FontWeight { get; set; }
 		
+		/// <summary>
+		/// Gets/sets the underline flag
+		/// </summary>
+		public bool Underline { get; set; }
+		
 		/// <summary>
 		/// Gets/sets the font style.
 		/// </summary>
@@ -81,6 +86,7 @@ protected XshdColor(SerializationInfo info, StreamingContext context)
 			if (info.GetBoolean("HasStyle"))
 				this.FontStyle = (FontStyle?)new FontStyleConverter().ConvertFromInvariantString(info.GetString("Style"));
 			this.ExampleText = info.GetString("ExampleText");
+			this.Underline = info.GetBoolean("Underline");
 		}
 		
 		/// <summary>
@@ -99,6 +105,8 @@ public virtual void GetObjectData(SerializationInfo info, StreamingContext conte
 			info.AddValue("Foreground", this.Foreground);
 			info.AddValue("Background", this.Background);
 			info.AddValue("HasWeight", this.FontWeight.HasValue);
+			if (this.Underline)
+            info.AddValue("Underline", this.Underline);			
 			if (this.FontWeight.HasValue)
 				info.AddValue("Weight", this.FontWeight.Value.ToOpenTypeWeight());
 			info.AddValue("HasStyle", this.FontStyle.HasValue);

Original file line number	Diff line number	Diff line change
`@@ -267,7 +267,8 @@ internal static HighlightingColor CustomizeColor(string name, IEnumerable<Custom`
`267`	`267`	`Background = CreateBrush(customization.Background),`
`268`	`268`	`Foreground = CreateBrush(customization.Foreground),`
`269`	`269`	`FontWeight = customization.Bold ? FontWeights.Bold : FontWeights.Normal,`
`270`		`- FontStyle = customization.Italic ? FontStyles.Italic : FontStyles.Normal`
	`270`	`+ FontStyle = customization.Italic ? FontStyles.Italic : FontStyles.Normal,`
	`271`	`+ Underline = customization.Underline`
`271`	`272`	`};`
`272`	`273`	`}`
`273`	`274`	`}`
Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,8 @@ void SetPreview(TextBlock preview, System.Drawing.Font font)`
`103`	`103`	`preview.FontWeight = FontWeights.Bold;`
`104`	`104`	`else`
`105`	`105`	`preview.FontWeight = FontWeights.Normal;`
	`106`	`+ if (font.Underline)`
	`107`	`+ preview.TextDecorations = TextDecorations.Underline;`
`106`	`108`	`}`
`107`	`109`	`}`
`108`	`110`	`}`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ public void SetHighlighting(int offset, int length, HighlightingColor color)`
`113`	`113`	`{`
`114`	`114`	`if (color == null)`
`115`	`115`	`throw new ArgumentNullException("color");`
`116`		`- if (color.Foreground == null && color.Background == null && color.FontStyle == null && color.FontWeight == null) {`
	`116`	`+ if (color.Foreground == null && color.Background == null && color.FontStyle == null && color.FontWeight == null && color.Underline == null) {`
`117`	`117`	`// Optimization: don't split the HighlightingState when we're not changing`
`118`	`118`	`// any property. For example, the "Punctuation" color in C# is`
`119`	`119`	`// empty by default.`