From 508d23465a738c9f82fc173ccdd57ca4afd99489 Mon Sep 17 00:00:00 2001
From: Sour <mesenemu@gmail.com>
Date: Sat, 15 Jun 2024 22:47:58 +0900
Subject: [PATCH] Debugger: Add separators in some tooltips to group related
 values

---
 UI/Debugger/Controls/DynamicTooltip.axaml     | 10 +++---
 UI/Debugger/Controls/DynamicTooltip.axaml.cs  | 34 +++++++++++++++++++
 .../ViewModels/SpriteViewerViewModel.cs       |  8 +++++
 .../ViewModels/TilemapViewerViewModel.cs      | 12 +++++++
 .../Windows/EventViewerWindow.axaml.cs        |  8 +++++
 5 files changed, 68 insertions(+), 4 deletions(-)

diff --git a/UI/Debugger/Controls/DynamicTooltip.axaml b/UI/Debugger/Controls/DynamicTooltip.axaml
index ba371c64b..98bdf2443 100644
--- a/UI/Debugger/Controls/DynamicTooltip.axaml
+++ b/UI/Debugger/Controls/DynamicTooltip.axaml
@@ -11,9 +11,6 @@
 	x:Class="Mesen.Debugger.Controls.DynamicTooltip"
 >
 	<UserControl.Styles>
-		<Style Selector="TextBlock">
-			<Setter Property="VerticalAlignment" Value="Top" />
-		</Style>
 		<Style Selector="TextBox">
 			<Setter Property="Background" Value="Transparent" />
 			<Setter Property="VerticalAlignment" Value="Top" />
@@ -29,6 +26,10 @@
 	</UserControl.Styles>
 
 	<UserControl.DataTemplates>
+		<DataTemplate DataType="dc:TooltipSeparator">
+			<Rectangle Height="1" Fill="{StaticResource MesenGrayBorderColor}" Margin="5 3" />
+		</DataTemplate>
+		
 		<DataTemplate DataType="dc:CustomTooltipEntry">
 			<ContentControl Content="{Binding Value}" />
 		</DataTemplate>
@@ -42,6 +43,7 @@
 				<TextBlock
 					Name="Header"
 					Text="{Binding Name}"
+					VerticalAlignment="{Binding VerticalAlignment}"
 					MinWidth="{Binding FirstColumnWidth, ElementName=root}"
 					IsVisible="{Binding Name.Length}"
 					Margin="0 0 10 2"
@@ -64,7 +66,7 @@
 							/>
 						</DataTemplate>
 						<DataTemplate DataType="x:Boolean">
-							<CheckBox IsChecked="{Binding}" IsEnabled="False" />
+							<CheckBox IsChecked="{Binding}" IsEnabled="False" Margin="-3 -3 0 0" />
 						</DataTemplate>
 						<DataTemplate DataType="dc:TooltipPictureEntry">
 							<Border BorderBrush="Gray" Background="#666" BorderThickness="1">
diff --git a/UI/Debugger/Controls/DynamicTooltip.axaml.cs b/UI/Debugger/Controls/DynamicTooltip.axaml.cs
index c4e01b2e7..804493114 100644
--- a/UI/Debugger/Controls/DynamicTooltip.axaml.cs
+++ b/UI/Debugger/Controls/DynamicTooltip.axaml.cs
@@ -2,6 +2,7 @@
 using Avalonia.Controls;
 using Avalonia.Input;
 using Avalonia.Interactivity;
+using Avalonia.Layout;
 using Avalonia.Markup.Xaml;
 using Avalonia.Media;
 using Mesen.Config;
@@ -57,6 +58,10 @@ private void ComputeColumnWidth()
 				int maxWidth = 0;
 				Typeface typeface = new Typeface(mesenFont, FontStyle.Normal, FontWeight.Bold);
 				foreach(var item in Items) {
+					if(item is TooltipSeparator || item is CustomTooltipEntry) {
+						continue;
+					}
+
 					var text = new FormattedText(item.Name, CultureInfo.CurrentCulture, FlowDirection.LeftToRight, typeface, fontSize, null);
 					maxWidth = Math.Max(maxWidth, (int)text.Width + 5);
 				}
@@ -92,6 +97,8 @@ public class TooltipEntry : ReactiveObject
 		[Reactive] public object Value { get; set; } = "";
 		[Reactive] public bool UseMonoFont { get; set; } = false;
 
+		public virtual VerticalAlignment VerticalAlignment => Value is bool ? VerticalAlignment.Center : VerticalAlignment.Top;
+
 		public TooltipEntry(string name, object value, bool useMonoFont = false)
 		{
 			Name = name;
@@ -107,6 +114,13 @@ public CustomTooltipEntry(string name, object value, bool useMonoFont = false) :
 		}
 	}
 
+	public class TooltipSeparator : TooltipEntry
+	{
+		public TooltipSeparator(string name) : base(name, false, false)
+		{
+		}
+	}
+
 	public class TooltipEntries : List<TooltipEntry>, INotifyCollectionChanged
 	{
 		private Dictionary<string, TooltipEntry> _entries = new();
@@ -160,6 +174,22 @@ public void AddCustomEntry(string name, Control value)
 			}
 		}
 
+		public void AddSeparator(string name)
+		{
+			if(this.Count > _updatedKeys.Count - 1 && this[_updatedKeys.Count - 1] is TooltipSeparator) {
+				return;
+			}
+
+			_updatedKeys.Add(name);
+
+			if(!_entries.TryGetValue(name, out _)) {
+				TooltipEntry? entry = new TooltipSeparator(name);
+				_entries[name] = entry;
+				base.Insert(_updatedKeys.Count - 1, new TooltipSeparator(name));
+				CollectionChanged?.Invoke(this, new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Reset));
+			}
+		}
+
 		public void AddEntry(string name, NullableBoolean value)
 		{
 			if(value != NullableBoolean.Undefined) {
@@ -201,6 +231,10 @@ public void EndUpdate()
 				}
 			}
 
+			while(this.Count > 0 && this[^1] is TooltipSeparator) {
+				RemoveAt(this.Count - 1);
+			}
+
 			if(updated) {
 				CollectionChanged?.Invoke(this, new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Reset));
 			}
diff --git a/UI/Debugger/ViewModels/SpriteViewerViewModel.cs b/UI/Debugger/ViewModels/SpriteViewerViewModel.cs
index 63f4aca60..877956c75 100644
--- a/UI/Debugger/ViewModels/SpriteViewerViewModel.cs
+++ b/UI/Debugger/ViewModels/SpriteViewerViewModel.cs
@@ -310,6 +310,8 @@ private void Config_PropertyChanged(object? sender, PropertyChangedEventArgs e)
 			);
 			entries.AddEntry("Size", sprite.Width + "x" + sprite.Height);
 
+			entries.AddSeparator("TileSeparator");
+
 			entries.AddEntry("Tile index", "$" + sprite.TileIndex.ToString("X2"));
 
 			MemoryType memType = CpuType.GetVramMemoryType(sprite.UseExtendedVram);
@@ -323,10 +325,16 @@ private void Config_PropertyChanged(object? sender, PropertyChangedEventArgs e)
 			} else {
 				entries.AddEntry("Tile address", FormatAddress(sprite.TileAddress, memType));
 			}
+
+			entries.AddSeparator("PaletteSeparator");
+
 			entries.AddEntry("Palette index", sprite.Palette.ToString());
 			if(sprite.PaletteAddress >= 0) {
 				entries.AddEntry("Palette address", "$" + sprite.PaletteAddress.ToString("X2"));
 			}
+
+			entries.AddSeparator("MiscSeparator");
+
 			entries.AddEntry("Visibility", ResourceHelper.GetEnumText(sprite.Visibility));
 			entries.AddEntry("Horizontal mirror", sprite.HorizontalMirror);
 			entries.AddEntry("Vertical mirror", sprite.VerticalMirror);
diff --git a/UI/Debugger/ViewModels/TilemapViewerViewModel.cs b/UI/Debugger/ViewModels/TilemapViewerViewModel.cs
index 270a49906..490ec71d9 100644
--- a/UI/Debugger/ViewModels/TilemapViewerViewModel.cs
+++ b/UI/Debugger/ViewModels/TilemapViewerViewModel.cs
@@ -589,6 +589,9 @@ private void UpdateTilemapInfo()
 			if(tileInfo.TileMapAddress >= 0) {
 				entries.AddEntry("Tilemap address", FormatAddress(tileInfo.TileMapAddress));
 			}
+
+			entries.AddSeparator("TileSeparator");
+
 			if(tileInfo.TileIndex >= 0) {
 				entries.AddEntry("Tile index", "$" + tileInfo.TileIndex.ToString("X2"));
 			}
@@ -605,6 +608,9 @@ private void UpdateTilemapInfo()
 					entries.AddEntry("Tile address", FormatAddress(tileInfo.TileAddress));
 				}
 			}
+
+			entries.AddSeparator("PaletteSeparator");
+
 			if(tileInfo.PaletteIndex >= 0) {
 				if(tileInfo.BasePaletteIndex >= 0) {
 					entries.AddEntry("Palette index", $"{tileInfo.BasePaletteIndex} ({tileInfo.PaletteIndex})");
@@ -615,12 +621,18 @@ private void UpdateTilemapInfo()
 			if(tileInfo.PaletteAddress >= 0) {
 				entries.AddEntry("Palette address", "$" + tileInfo.PaletteAddress.ToString("X2"));
 			}
+
+			entries.AddSeparator("AttributeSeparator");
+
 			if(tileInfo.AttributeAddress >= 0) {
 				entries.AddEntry("Attribute address", "$" + tileInfo.AttributeAddress.ToString("X4"));
 			}
 			if(tileInfo.AttributeData >= 0) {
 				entries.AddEntry("Attribute data", "$" + tileInfo.AttributeData.ToString("X2"));
 			}
+
+			entries.AddSeparator("MiscSeparator");
+
 			if(tileInfo.PixelData >= 0) {
 				entries.AddEntry("Pixel data", "$" + tileInfo.PixelData.ToString("X2"));
 			}
diff --git a/UI/Debugger/Windows/EventViewerWindow.axaml.cs b/UI/Debugger/Windows/EventViewerWindow.axaml.cs
index b7c424cf4..83ceb75d6 100644
--- a/UI/Debugger/Windows/EventViewerWindow.axaml.cs
+++ b/UI/Debugger/Windows/EventViewerWindow.axaml.cs
@@ -124,10 +124,15 @@ private TooltipEntries GetTooltipData(DebugEventInfo evt)
 		{
 			TooltipEntries entries = new();
 			entries.AddEntry("Type", ResourceHelper.GetEnumText(evt.Type));
+			
+			entries.AddSeparator("LocationSeparator");
+
 			entries.AddEntry("Scanline", evt.Scanline.ToString());
 			entries.AddEntry(_model.CpuType == CpuType.Snes ? "H-Clock" : "Cycle", evt.Cycle.ToString());
 			entries.AddEntry("PC", "$" + evt.ProgramCounter.ToString("X" + _model.CpuType.GetAddressSize()));
 
+			entries.AddSeparator("AddressValueSeparator");
+
 			switch(evt.Type) {
 				case DebugEventType.Register:
 					bool isWrite = evt.Operation.Type == MemoryOperationType.Write || evt.Operation.Type == MemoryOperationType.DmaWrite;
@@ -149,9 +154,12 @@ private TooltipEntries GetTooltipData(DebugEventInfo evt)
 
 			string details = EventViewerViewModel.GetEventDetails(_model.CpuType, evt, false);
 			if(details.Length > 0) {
+				entries.AddSeparator("DetailsSeparator");
 				entries.AddEntry("Details", details);
 			}
 
+			entries.EndUpdate();
+
 			return entries;
 		}