Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 655d71b

Browse files
authored
Add navigation and highlighting of change-blocks in Text Diff (#616, #717) (#703)
* Corrected misspelled local variable nextHigh(t)light * Implemented change-block navigation * Modified behavior of the Prev/Next Change buttons in DiffView toolbar. * Well-defined change-blocks are pre-calculated and can be navigated between. * Current change-block is highlighted in the Diff panel(s). * Prev/next at start/end of range (re-)scrolls to first/last change-block (I.e when unset, or already at first/last change-block, or at the only one.) * Current change-block is unset in RefreshContent(). * Added safeguards for edge cases * Added indicator of current/total change-blocks in DiffView toolbar * Added new Icon and String (en-US) for Highlighted Diff Navigation * Added Preference and ToggleButton for diff navigation style
1 parent c062f27 commit 655d71b

File tree

11 files changed

+361
-47
lines changed

11 files changed

+361
-47
lines changed

‎src/Commands/Diff.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ public Models.DiffResult Result()
5151
_result.TextDiff.MaxLineNumber = Math.Max(_newLine, _oldLine);
5252
}
5353

54+
if (_result.TextDiff != null)
55+
_result.TextDiff.ProcessChangeBlocks();
56+
5457
return _result;
5558
}
5659

‎src/Models/DiffResult.cs

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
using System.Text;
33
using System.Text.RegularExpressions;
44

5+
using CommunityToolkit.Mvvm.ComponentModel;
6+
57
using Avalonia;
68
using Avalonia.Media.Imaging;
79

@@ -59,16 +61,70 @@ public bool IsInRange(int idx)
5961
}
6062
}
6163

62-
public partial class TextDiff
64+
public class TextDiffChangeBlock
65+
{
66+
public TextDiffChangeBlock(int startLine, int endLine)
67+
{
68+
StartLine = startLine;
69+
EndLine = endLine;
70+
}
71+
72+
public int StartLine { get; set; } = 0;
73+
public int EndLine { get; set; } = 0;
74+
75+
public bool IsInRange(int line)
76+
{
77+
return line >= StartLine && line <= EndLine;
78+
}
79+
}
80+
81+
public partial class TextDiff : ObservableObject
6382
{
6483
public string File { get; set; } = string.Empty;
6584
public List<TextDiffLine> Lines { get; set; } = new List<TextDiffLine>();
6685
public Vector ScrollOffset { get; set; } = Vector.Zero;
6786
public int MaxLineNumber = 0;
6887

88+
public int CurrentChangeBlockIdx
89+
{
90+
get => _currentChangeBlockIdx;
91+
set => SetProperty(ref _currentChangeBlockIdx, value);
92+
}
93+
6994
public string Repo { get; set; } = null;
7095
public DiffOption Option { get; set; } = null;
7196

97+
public List<TextDiffChangeBlock> ChangeBlocks { get; set; } = [];
98+
99+
public void ProcessChangeBlocks()
100+
{
101+
ChangeBlocks.Clear();
102+
int lineIdx = 0, blockStartIdx = 0;
103+
bool isNewBlock = true;
104+
foreach (var line in Lines)
105+
{
106+
lineIdx++;
107+
if (line.Type == Models.TextDiffLineType.Added ||
108+
line.Type == Models.TextDiffLineType.Deleted ||
109+
line.Type == Models.TextDiffLineType.None) // Empty
110+
{
111+
if (isNewBlock)
112+
{
113+
isNewBlock = false;
114+
blockStartIdx = lineIdx;
115+
}
116+
}
117+
else
118+
{
119+
if (!isNewBlock)
120+
{
121+
ChangeBlocks.Add(new TextDiffChangeBlock(blockStartIdx, lineIdx - 1));
122+
isNewBlock = true;
123+
}
124+
}
125+
}
126+
}
127+
72128
public TextDiffSelection MakeSelection(int startLine, int endLine, bool isCombined, bool isOldSide)
73129
{
74130
var rs = new TextDiffSelection();
@@ -626,6 +682,8 @@ private bool ProcessIndicatorForPatchSingleSide(StringBuilder builder, TextDiffL
626682
return true;
627683
}
628684

685+
private int _currentChangeBlockIdx = -1; // NOTE: Use -1 as "not set".
686+
629687
[GeneratedRegex(@"^@@ \-(\d+),?\d* \+(\d+),?\d* @@")]
630688
private static partial Regex REG_INDICATOR();
631689
}

‎src/Resources/Icons.axaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
<StreamGeometry x:Key="Icons.Grid">M30 271l241 0 0-241-241 0 0 241zM392 271l241 0 0-241-241 0 0 241zM753 30l0 241 241 0 0-241-241 0zM30 632l241 0 0-241-241 0 0 241zM392 632l241 0 0-241-241 0 0 241zM753 632l241 0 0-241-241 0 0 241zM30 994l241 0 0-241-241 0 0 241zM392 994l241 0 0-241-241 0 0 241zM753 994l241 0 0-241-241 0 0 241z</StreamGeometry>
5555
<StreamGeometry x:Key="Icons.Head">M0 512M1024 512M512 0M512 1024M955 323q0 23-16 39l-414 414-78 78q-16 16-39 16t-39-16l-78-78-207-207q-16-16-16-39t16-39l78-78q16-16 39-16t39 16l168 169 375-375q16-16 39-16t39 16l78 78q16 16 16 39z</StreamGeometry>
5656
<StreamGeometry x:Key="Icons.HiddenSymbol">M416 64H768v64h-64v704h64v64H448v-64h64V512H416a224 224 0 1 1 0-448zM576 832h64V128H576v704zM416 128H512v320H416a160 160 0 0 1 0-320z</StreamGeometry>
57+
<StreamGeometry x:Key="Icons.Highlight">M20.2585648,2.00438474 C20.6382605,2.00472706 20.9518016,2.28716326 21.0011348,2.65328337 L21.0078899,2.75506004 L21.0038407,7.25276883 C21.0009137,8.40908568 20.1270954,9.36072944 19.0029371,9.48671858 L19.0024932,11.7464847 C19.0024932,12.9373487 18.0773316,13.9121296 16.906542,13.9912939 L16.7524932,13.9964847 L16.501,13.9963847 L16.5017549,16.7881212 C16.5017549,17.6030744 16.0616895,18.349347 15.3600767,18.7462439 L15.2057929,18.8258433 L8.57108142,21.9321389 C8.10484975,22.1504232 7.57411944,21.8450614 7.50959937,21.3535767 L7.50306874,21.2528982 L7.503,13.9963847 L7.25,13.9964847 C6.05913601,13.9964847 5.08435508,13.0713231 5.00519081,11.9005335 L5,11.7464847 L5.00043957,9.4871861 C3.92882124,9.36893736 3.08392302,8.49812196 3.0058865,7.41488149 L3,7.25086975 L3,2.75438506 C3,2.3401715 3.33578644,2.00438474 3.75,2.00438474 C4.12969577,2.00438474 4.44349096,2.28653894 4.49315338,2.6526145 L4.5,2.75438506 L4.5,7.25086975 C4.5,7.63056552 4.78215388,7.94436071 5.14822944,7.99402313 L5.25,8.00086975 L18.7512697,8.00087075 C19.1315998,8.00025031 19.4461483,7.71759877 19.4967392,7.3518545 L19.5038434,7.25019537 L19.5078902,2.75371008 C19.508263,2.33949668 19.8443515,2.00401258 20.2585648,2.00438474 Z M15.001,13.9963847 L9.003,13.9963847 L9.00306874,20.0736262 L14.5697676,17.4673619 C14.8004131,17.3593763 14.9581692,17.1431606 14.9940044,16.89581 L15.0017549,16.7881212 L15.001,13.9963847 Z M17.502,9.50038474 L6.5,9.50038474 L6.5,11.7464847 C6.5,12.1261805 6.78215388,12.4399757 7.14822944,12.4896381 L7.25,12.4964847 L16.7524932,12.4964847 C17.1321889,12.4964847 17.4459841,12.2143308 17.4956465,11.8482552 L17.5024932,11.7464847 L17.502,9.50038474 Z</StreamGeometry>
5758
<StreamGeometry x:Key="Icons.Histories">M24 512A488 488 0 01512 24A488 488 0 011000 512A488 488 0 01512 1000A488 488 0 0124 512zm447-325v327L243 619l51 111 300-138V187H471z</StreamGeometry>
5859
<StreamGeometry x:Key="Icons.Home">M832 64h128v278l-128-146V64zm64 448L512 73 128 512H0L448 0h128l448 512h-128zm0 83V1024H640V704c0-35-29-64-64-64h-128a64 64 0 00-64 64v320H128V595l384-424 384 424z</StreamGeometry>
5960
<StreamGeometry x:Key="Icons.Hotkeys">M512 0C229 0 0 229 0 512c0 283 229 512 512 512s512-229 512-512c0-283-229-512-512-512zm0 958C266 958 66 758 66 512S266 66 512 66 958 266 958 512 758 958 512 958zM192 416h96a32 32 0 0032-32v-32a32 32 0 00-32-32H192a32 32 0 00-32 32v32a32 32 0 0032 32zM384 416h96a32 32 0 0032-32v-32a32 32 0 00-32-32h-96a32 32 0 00-32 32v32a32 32 0 0032 32zM576 416h96a32 32 0 0032-32v-32a32 32 0 00-32-32h-96a32 32 0 00-32 32v32a32 32 0 0032 32zM832 320h-64a32 32 0 00-32 32v128h-160a32 32 0 00-32 32v32a32 32 0 0032 32h256a32 32 0 0032-32v-192a32 32 0 00-32-32zM320 544v-32a32 32 0 00-32-32H192a32 32 0 00-32 32v32a32 32 0 0032 32h96a32 32 0 0032-32zM384 576h96a32 32 0 0032-32v-32a32 32 0 00-32-32h-96a32 32 0 00-32 32v32a32 32 0 0032 32zM800 640H256a32 32 0 00-32 32v32a32 32 0 0032 32h544a32 32 0 0032-32v-32a32 32 0 00-32-32z</StreamGeometry>

‎src/Resources/Locales/en_US.axaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,7 @@
233233
<x:String x:Key="Text.Diff.Binary.New" xml:space="preserve">NEW</x:String>
234234
<x:String x:Key="Text.Diff.Binary.Old" xml:space="preserve">OLD</x:String>
235235
<x:String x:Key="Text.Diff.Copy" xml:space="preserve">Copy</x:String>
236+
<x:String x:Key="Text.Diff.HighlightedDiffNavigation" xml:space="preserve">Highlighted Diff Navigation</x:String>
236237
<x:String x:Key="Text.Diff.FileModeChanged" xml:space="preserve">File Mode Changed</x:String>
237238
<x:String x:Key="Text.Diff.IgnoreWhitespace" xml:space="preserve">Ignore Whitespace Change</x:String>
238239
<x:String x:Key="Text.Diff.LFS" xml:space="preserve">LFS OBJECT CHANGE</x:String>

‎src/ViewModels/DiffContext.cs

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ public int UnifiedLines
5151
private set => SetProperty(ref _unifiedLines, value);
5252
}
5353

54+
public string ChangeBlockIndicator
55+
{
56+
get => _changeBlockIndicator;
57+
private set => SetProperty(ref _changeBlockIndicator, value);
58+
}
59+
5460
public DiffContext(string repo, Models.DiffOption option, DiffContext previous = null)
5561
{
5662
_repo = repo;
@@ -73,12 +79,68 @@ public DiffContext(string repo, Models.DiffOption option, DiffContext previous =
7379
LoadDiffContent();
7480
}
7581

82+
public void PrevChange()
83+
{
84+
if (_content is Models.TextDiff textDiff)
85+
{
86+
if (textDiff.CurrentChangeBlockIdx > 0)
87+
{
88+
textDiff.CurrentChangeBlockIdx--;
89+
}
90+
else if (textDiff.ChangeBlocks.Count > 0)
91+
{
92+
// Force property value change and (re-)jump to first change block
93+
textDiff.CurrentChangeBlockIdx = -1;
94+
textDiff.CurrentChangeBlockIdx = 0;
95+
}
96+
}
97+
RefreshChangeBlockIndicator();
98+
}
99+
100+
public void NextChange()
101+
{
102+
if (_content is Models.TextDiff textDiff)
103+
{
104+
if (textDiff.CurrentChangeBlockIdx < textDiff.ChangeBlocks.Count - 1)
105+
{
106+
textDiff.CurrentChangeBlockIdx++;
107+
}
108+
else if (textDiff.ChangeBlocks.Count > 0)
109+
{
110+
// Force property value change and (re-)jump to last change block
111+
textDiff.CurrentChangeBlockIdx = -1;
112+
textDiff.CurrentChangeBlockIdx = textDiff.ChangeBlocks.Count - 1;
113+
}
114+
RefreshChangeBlockIndicator();
115+
}
116+
}
117+
118+
public void RefreshChangeBlockIndicator()
119+
{
120+
string curr = "-", tot = "-";
121+
if (_content is Models.TextDiff textDiff)
122+
{
123+
if (textDiff.CurrentChangeBlockIdx >= 0)
124+
curr = (textDiff.CurrentChangeBlockIdx + 1).ToString();
125+
tot = (textDiff.ChangeBlocks.Count).ToString();
126+
}
127+
ChangeBlockIndicator = curr + "/" + tot;
128+
}
129+
76130
public void ToggleFullTextDiff()
77131
{
78132
Preference.Instance.UseFullTextDiff = !Preference.Instance.UseFullTextDiff;
79133
LoadDiffContent();
80134
}
81135

136+
public void ToggleHighlightedDiffNavigation()
137+
{
138+
Preference.Instance.EnableChangeBlocks = !Preference.Instance.EnableChangeBlocks;
139+
if (_content is Models.TextDiff textDiff)
140+
textDiff.CurrentChangeBlockIdx = -1;
141+
RefreshChangeBlockIndicator();
142+
}
143+
82144
public void IncrUnified()
83145
{
84146
UnifiedLines = _unifiedLines + 1;
@@ -91,6 +153,12 @@ public void DecrUnified()
91153
LoadDiffContent();
92154
}
93155

156+
public void ToggleTwoSideDiff()
157+
{
158+
Preference.Instance.UseSideBySideDiff = !Preference.Instance.UseSideBySideDiff;
159+
RefreshChangeBlockIndicator();
160+
}
161+
94162
public void OpenExternalMergeTool()
95163
{
96164
var toolType = Preference.Instance.ExternalMergeToolType;
@@ -217,7 +285,9 @@ private void LoadDiffContent()
217285
FileModeChange = latest.FileModeChange;
218286
Content = rs;
219287
IsTextDiff = rs is Models.TextDiff;
220-
});
288+
289+
RefreshChangeBlockIndicator();
290+
});
221291
});
222292
}
223293

@@ -281,6 +351,7 @@ public bool IsSame(Info other)
281351
private string _title;
282352
private string _fileModeChange = string.Empty;
283353
private int _unifiedLines = 4;
354+
private string _changeBlockIndicator = "-/-";
284355
private bool _isTextDiff = false;
285356
private bool _ignoreWhitespace = false;
286357
private object _content = null;

‎src/ViewModels/Preference.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,12 @@ public bool UseFullTextDiff
206206
set => SetProperty(ref _useFullTextDiff, value);
207207
}
208208

209+
public bool EnableChangeBlocks
210+
{
211+
get => _enableChangeBlocks;
212+
set => SetProperty(ref _enableChangeBlocks, value);
213+
}
214+
209215
public Models.ChangeViewMode UnstagedChangeViewMode
210216
{
211217
get => _unstagedChangeViewMode;
@@ -614,6 +620,7 @@ private bool RemoveInvalidRepositoriesRecursive(List<RepositoryNode> collection)
614620
private bool _enableDiffViewWordWrap = false;
615621
private bool _showHiddenSymbolsInDiffView = false;
616622
private bool _useFullTextDiff = false;
623+
private bool _enableChangeBlocks = false;
617624

618625
private Models.ChangeViewMode _unstagedChangeViewMode = Models.ChangeViewMode.List;
619626
private Models.ChangeViewMode _stagedChangeViewMode = Models.ChangeViewMode.List;

‎src/ViewModels/TwoSideTextDiff.cs

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,43 @@ public TwoSideTextDiff(Models.TextDiff diff, TwoSideTextDiff previous = null)
4545

4646
FillEmptyLines();
4747

48+
ProcessChangeBlocks();
49+
4850
if (previous != null && previous.File == File)
4951
_syncScrollOffset = previous._syncScrollOffset;
5052
}
5153

54+
public List<Models.TextDiffChangeBlock> ChangeBlocks { get; set; } = [];
55+
56+
public void ProcessChangeBlocks()
57+
{
58+
ChangeBlocks.Clear();
59+
int lineIdx = 0, blockStartIdx = 0;
60+
bool isNewBlock = true;
61+
foreach (var line in Old) // NOTE: Same block size in both Old and New lines.
62+
{
63+
lineIdx++;
64+
if (line.Type == Models.TextDiffLineType.Added ||
65+
line.Type == Models.TextDiffLineType.Deleted ||
66+
line.Type == Models.TextDiffLineType.None) // Empty
67+
{
68+
if (isNewBlock)
69+
{
70+
isNewBlock = false;
71+
blockStartIdx = lineIdx;
72+
}
73+
}
74+
else
75+
{
76+
if (!isNewBlock)
77+
{
78+
ChangeBlocks.Add(new Models.TextDiffChangeBlock(blockStartIdx, lineIdx - 1));
79+
isNewBlock = true;
80+
}
81+
}
82+
}
83+
}
84+
5285
public void ConvertsToCombinedRange(Models.TextDiff combined, ref int startLine, ref int endLine, bool isOldSide)
5386
{
5487
endLine = Math.Min(endLine, combined.Lines.Count - 1);

‎src/Views/DiffView.axaml

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,15 @@
3434

3535
<!-- Toolbar Buttons -->
3636
<StackPanel Grid.Column="3" Margin="8,0,0,0" Orientation="Horizontal" VerticalAlignment="Center">
37+
<ToggleButton Classes="line_path"
38+
Width="28"
39+
Command="{Binding ToggleHighlightedDiffNavigation}"
40+
IsChecked="{Binding Source={x:Static vm:Preference.Instance}, Path=EnableChangeBlocks, Mode=OneWay}"
41+
IsVisible="{Binding IsTextDiff}"
42+
ToolTip.Tip="{DynamicResource Text.Diff.HighlightedDiffNavigation}">
43+
<Path Width="13" Height="13" Data="{StaticResource Icons.Highlight}" Margin="0,3,0,0"/>
44+
</ToggleButton>
45+
3746
<Button Classes="icon_button"
3847
Width="28"
3948
Click="OnGotoPrevChange"
@@ -42,6 +51,18 @@
4251
<Path Width="12" Height="12" Stretch="Uniform" Margin="0,6,0,0" Data="{StaticResource Icons.Up}"/>
4352
</Button>
4453

54+
<TextBlock Classes="primary"
55+
Margin="0,0,0,0"
56+
Text="{Binding ChangeBlockIndicator}"
57+
FontSize="11">
58+
<TextBlock.IsVisible>
59+
<MultiBinding Converter="{x:Static BoolConverters.And}">
60+
<Binding Path="IsTextDiff"/>
61+
<Binding Source="{x:Static vm:Preference.Instance}" Path="EnableChangeBlocks" Mode="OneWay"/>
62+
</MultiBinding>
63+
</TextBlock.IsVisible>
64+
</TextBlock>
65+
4566
<Button Classes="icon_button"
4667
Width="28"
4768
Click="OnGotoNextChange"
@@ -124,7 +145,8 @@
124145

125146
<ToggleButton Classes="line_path"
126147
Width="28" Height="18"
127-
IsChecked="{Binding Source={x:Static vm:Preference.Instance}, Path=UseSideBySideDiff, Mode=TwoWay}"
148+
Command="{Binding ToggleTwoSideDiff}"
149+
IsChecked="{Binding Source={x:Static vm:Preference.Instance}, Path=UseSideBySideDiff, Mode=OneWay}"
128150
IsVisible="{Binding IsTextDiff}"
129151
ToolTip.Tip="{DynamicResource Text.Diff.SideBySide}">
130152
<Path Width="12" Height="12" Data="{StaticResource Icons.LayoutHorizontal}" Margin="0,2,0,0"/>
@@ -241,7 +263,8 @@
241263
<DataTemplate DataType="m:TextDiff">
242264
<v:TextDiffView
243265
UseSideBySideDiff="{Binding Source={x:Static vm:Preference.Instance}, Path=UseSideBySideDiff, Mode=OneWay}"
244-
UseFullTextDiff="{Binding Source={x:Static vm:Preference.Instance}, Path=UseFullTextDiff, Mode=OneWay}"/>
266+
UseFullTextDiff="{Binding Source={x:Static vm:Preference.Instance}, Path=UseFullTextDiff, Mode=OneWay}"
267+
CurrentChangeBlockIdx="{Binding CurrentChangeBlockIdx, Mode=OneWay}"/>
245268
</DataTemplate>
246269

247270
<!-- Empty or only EOL changes -->

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /