// Copyright (c) 2026 AlphaSierraPapa for the SharpDevelop Team // // Permission is hereby granted, free of charge, to any person obtaining a copy of this // software and associated documentation files (the "Software"), to deal in the Software // without restriction, including without limitation the rights to use, copy, modify, merge, // publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons // to whom the Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in all copies or // substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, // INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE // FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. using System.Linq; using System.Threading.Tasks; using Avalonia; using Avalonia.Headless; using Avalonia.Headless.NUnit; using Avalonia.Input; using Avalonia.Interactivity; using Avalonia.Threading; using AvaloniaEdit.Rendering; using AwesomeAssertions; using ICSharpCode.ILSpy; using ICSharpCode.ILSpy.AppEnv; using ICSharpCode.ILSpy.Bookmarks; using ICSharpCode.ILSpy.Properties; using ICSharpCode.ILSpy.TextView; using ICSharpCode.ILSpy.TreeNodes; using NUnit.Framework; namespace ICSharpCode.ILSpy.Tests.Bookmarks; [TestFixture] public class BookmarkGutterTests { [AvaloniaTest] public async Task Clicking_Bookmark_Gutter_Toggles_The_Visible_Line() { var (window, vm) = await TestHarness.BootAsync(3); var manager = AppComposition.Current.GetExport(); manager.Clear(); var coreLibName = typeof(object).Assembly.GetName().Name!; var typeNode = vm.AssemblyTreeModel.FindNode(coreLibName, "System", "System.Object"); vm.AssemblyTreeModel.SelectNode(typeNode); await vm.DockWorkspace.WaitForDecompiledTextAsync(); var view = await window.WaitForComponent(); for (int i = 0; i < 8; i++) { Dispatcher.UIThread.RunJobs(); await Task.Delay(25); } window.UpdateLayout(); var margin = view.Editor.TextArea.LeftMargins.OfType().Single(); margin.Bounds.Width.Should().BeGreaterThan(0, "the bookmark gutter must reserve hit-testable space"); var textView = view.Editor.TextArea.TextView; textView.EnsureVisualLines(); var visualLine = textView.VisualLines.First(line => view.CanToggleBookmarkAtLine(line.FirstDocumentLine.LineNumber)); int documentLine = visualLine.FirstDocumentLine.LineNumber; double y = visualLine.GetTextLineVisualYPosition(visualLine.TextLines[0], VisualYPosition.LineMiddle) - textView.VerticalOffset; y.Should().BeInRange(0, margin.Bounds.Height, "the selected visual line must be inside the gutter bounds"); var point = margin.TranslatePoint(new Point(margin.Bounds.Width / 2, y), window); point.Should().NotBeNull("the gutter line coordinate must map into the test window"); int pressed = 0; margin.AddHandler(InputElement.PointerPressedEvent, (_, _) => pressed++, RoutingStrategies.Tunnel | RoutingStrategies.Bubble); window.MouseDown(point!.Value, MouseButton.Left); window.MouseUp(point.Value, MouseButton.Left); Dispatcher.UIThread.RunJobs(); pressed.Should().BeGreaterThan(0, "the real pointer event must hit the bookmark gutter"); manager.Bookmarks.Should().ContainSingle(); view.GetLineForBookmark(manager.Bookmarks[0]).Should().Be(documentLine); window.MouseDown(point.Value, MouseButton.Left); window.MouseUp(point.Value, MouseButton.Left); Dispatcher.UIThread.RunJobs(); manager.Bookmarks.Should().BeEmpty(); } [AvaloniaTest] public async Task RightClicking_Bookmark_Gutter_Does_Not_Toggle() { var (window, vm) = await TestHarness.BootAsync(3); var manager = AppComposition.Current.GetExport(); manager.Clear(); var coreLibName = typeof(object).Assembly.GetName().Name!; var typeNode = vm.AssemblyTreeModel.FindNode(coreLibName, "System", "System.Object"); vm.AssemblyTreeModel.SelectNode(typeNode); await vm.DockWorkspace.WaitForDecompiledTextAsync(); var view = await window.WaitForComponent(); for (int i = 0; i < 8; i++) { Dispatcher.UIThread.RunJobs(); await Task.Delay(25); } window.UpdateLayout(); var margin = view.Editor.TextArea.LeftMargins.OfType().Single(); var textView = view.Editor.TextArea.TextView; textView.EnsureVisualLines(); var visualLine = textView.VisualLines.First(line => view.CanToggleBookmarkAtLine(line.FirstDocumentLine.LineNumber)); double y = visualLine.GetTextLineVisualYPosition(visualLine.TextLines[0], VisualYPosition.LineMiddle) - textView.VerticalOffset; var point = margin.TranslatePoint(new Point(margin.Bounds.Width / 2, y), window); point.Should().NotBeNull("the gutter line coordinate must map into the test window"); window.MouseDown(point!.Value, MouseButton.Right); window.MouseUp(point.Value, MouseButton.Right); Dispatcher.UIThread.RunJobs(); manager.Bookmarks.Should().BeEmpty("a right-click in the gutter must not toggle a bookmark"); // The same coordinate still toggles on a left-click, proving the gesture is button-gated // rather than disabled at that line. window.MouseDown(point.Value, MouseButton.Left); window.MouseUp(point.Value, MouseButton.Left); Dispatcher.UIThread.RunJobs(); manager.Bookmarks.Should().ContainSingle("a left-click at the same coordinate still toggles"); } [AvaloniaTest] public async Task Removing_A_Bookmark_From_The_Gutter_Hides_Its_Hover_Preview_Until_The_Pointer_Leaves_The_Line() { var (window, vm) = await TestHarness.BootAsync(3); var manager = AppComposition.Current.GetExport(); manager.Clear(); var coreLibName = typeof(object).Assembly.GetName().Name!; var typeNode = vm.AssemblyTreeModel.FindNode(coreLibName, "System", "System.Object"); vm.AssemblyTreeModel.SelectNode(typeNode); await vm.DockWorkspace.WaitForDecompiledTextAsync(); var view = await window.WaitForComponent(); for (int i = 0; i < 8; i++) { Dispatcher.UIThread.RunJobs(); await Task.Delay(25); } window.UpdateLayout(); var margin = view.Editor.TextArea.LeftMargins.OfType().Single(); var textView = view.Editor.TextArea.TextView; textView.EnsureVisualLines(); var bookmarkable = textView.VisualLines .Where(line => view.CanToggleBookmarkAtLine(line.FirstDocumentLine.LineNumber)) .Take(2) .ToArray(); bookmarkable.Should().HaveCount(2, "two bookmarkable lines are needed to leave and re-enter the removed line"); Point GutterPoint(VisualLine line) { double y = line.GetTextLineVisualYPosition(line.TextLines[0], VisualYPosition.LineMiddle) - textView.VerticalOffset; var p = margin.TranslatePoint(new Point(margin.Bounds.Width / 2, y), window); p.Should().NotBeNull("the gutter line coordinate must map into the test window"); return p!.Value; } int line0 = bookmarkable[0].FirstDocumentLine.LineNumber; int line1 = bookmarkable[1].FirstDocumentLine.LineNumber; Point point0 = GutterPoint(bookmarkable[0]); Point point1 = GutterPoint(bookmarkable[1]); // Hovering an empty bookmarkable line previews a ghost glyph. window.MouseMove(point0); Dispatcher.UIThread.RunJobs(); margin.HoverPreviewLine.Should().Be(line0, "hovering a bookmarkable line previews its glyph"); // Click adds the bookmark; the pointer stays on the line. window.MouseDown(point0, MouseButton.Left); window.MouseUp(point0, MouseButton.Left); Dispatcher.UIThread.RunJobs(); manager.Bookmarks.Should().ContainSingle(); // Clicking again removes it: the line must visibly empty rather than redraw a ghost. window.MouseDown(point0, MouseButton.Left); window.MouseUp(point0, MouseButton.Left); Dispatcher.UIThread.RunJobs(); manager.Bookmarks.Should().BeEmpty(); margin.HoverPreviewLine.Should().Be(-1, "removing via the gutter hides the preview"); // A jitter that stays on the just-removed line must NOT bring the preview back. window.MouseMove(new Point(point0.X + 1, point0.Y)); Dispatcher.UIThread.RunJobs(); margin.HoverPreviewLine.Should().Be(-1, "moving within the same line keeps the removed line's preview hidden"); // Moving onto a different line resumes normal hover. window.MouseMove(point1); Dispatcher.UIThread.RunJobs(); margin.HoverPreviewLine.Should().Be(line1, "a different line hovers normally"); // Returning to the original line now shows its preview again. window.MouseMove(point0); Dispatcher.UIThread.RunJobs(); margin.HoverPreviewLine.Should().Be(line0, "leaving and re-entering the line restores its preview"); } // Regression: the editor reuses one TextDocument and only swaps its text on navigation, so the // gutter's cached glyph map must rebuild off the document's content (DebugInfo/References), not off // the document reference -- otherwise switching nodes leaves the gutter showing the previous (or no) // document's bookmarks. [AvaloniaTest] public async Task Gutter_Glyph_Map_Rebuilds_When_The_Displayed_Document_Changes() { var (window, vm) = await TestHarness.BootAsync(3); var manager = AppComposition.Current.GetExport(); manager.Clear(); var coreLibName = typeof(object).Assembly.GetName().Name!; async Task Show(string typeName) { var node = vm.AssemblyTreeModel.FindNode(coreLibName, "System", typeName); vm.AssemblyTreeModel.SelectNode(node); await vm.DockWorkspace.WaitForDecompiledTextAsync(); var shown = await window.WaitForComponent(); for (int i = 0; i < 8; i++) { Dispatcher.UIThread.RunJobs(); await Task.Delay(25); } return shown; } var view = await Show("System.Object"); var margin = view.Editor.TextArea.LeftMargins.OfType().Single(); var toggle = AppComposition.Current.GetExport().GetEntry(nameof(Resources.BookmarkToggle)); // A body (IL-offset) anchor, so it only resolves inside System.Object -- a token/line anchor on // the type would also resolve in System.String, which merely references System.Object. Bookmark? bookmark = null; foreach (int candidate in Enumerable.Range(1, view.Editor.Document.LineCount).Where(view.CanToggleBookmarkAtLine)) { int candidateOffset = view.Editor.Document.GetLineByNumber(candidate).Offset; view.Editor.TextArea.Caret.Offset = candidateOffset; toggle.Execute(new TextViewContext { TextView = view, TextLocation = candidateOffset }); Dispatcher.UIThread.RunJobs(); var candidateBookmark = manager.Bookmarks.Single(); if (candidateBookmark.Kind == BookmarkKind.Body) { bookmark = candidateBookmark; break; } manager.Clear(); } bookmark.Should().NotBeNull("System.Object has a method-body line to anchor to"); int objectLine = view.GetLineForBookmark(bookmark!)!.Value; margin.GlyphLinesForTest().Keys.Should().Contain(objectLine, "the gutter shows the bookmark on its own document"); // Navigate to another type. The preview tab reuses the same view (and gutter), only swapping the // document text, so the gutter must drop the stale glyph: System.Object's bookmark is not here. var stringView = await Show("System.String"); stringView.Should().BeSameAs(view, "the preview tab reuses the view, so this exercises the stale cache"); margin.GlyphLinesForTest().Should().BeEmpty("the gutter must rebuild for System.String, where the bookmark does not resolve"); // Returning to the bookmarked document must surface its glyph again. await Show("System.Object"); margin.GlyphLinesForTest().Keys.Should().Contain(view.GetLineForBookmark(bookmark!)!.Value, "returning to the bookmarked document must show its glyph again"); } }