Skip to content

Trim detailed-diff highlight ending in trailing spaces #2981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tobiasmelcher wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Trim detailed-diff highlight ending in trailing spaces #2981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions ...mpare/compare/org/eclipse/compare/unifieddiff/internal/UnifiedDiffCodeMiningProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -739,7 +739,7 @@ private int measure(GC gc, Font font, String label, int from, int to) {
}
}

static List<StyleRange> createDetailedDiffBackgroundRanges(UnifiedDiff diff, int tabWidth, Color detailedDiffColor) {
public static List<StyleRange> createDetailedDiffBackgroundRanges(UnifiedDiff diff, int tabWidth, Color detailedDiffColor) {
List<StyleRange> ranges = new ArrayList<>();
String diffStr = diff.mode.equals(UnifiedDiffMode.REPLACE_MODE) ? diff.leftStr : diff.rightStr;
String trimmedDiffStr = removeTrailingNewLines(diffStr);
Expand Down Expand Up @@ -767,7 +767,8 @@ static List<StyleRange> createDetailedDiffBackgroundRanges(UnifiedDiff diff, int
int expandedStart = mapOffsetToTabExpanded(diffStr, detailedDiffStart, tabWidth);
int expandedEnd = mapOffsetToTabExpanded(diffStr, detailedDiffStart + detailedDiffLength, tabWidth);
int expandedLength = expandedEnd - expandedStart;
if (expandedStart >= 0 && expandedLength > 0 && expandedStart + expandedLength <= labelLength) {
expandedLength = clampDetailedDiffLength(expandedStart, expandedLength, labelLength);
if (expandedStart >= 0 && expandedLength > 0) {
StyleRange bgRange = new StyleRange();
bgRange.start = expandedStart;
bgRange.length = expandedLength;
Expand Down
34 changes: 34 additions & 0 deletions .../tests/org.eclipse.team.tests.core/src/org/eclipse/team/tests/ui/UnifiedDiffTextTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,12 @@
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.eclipse.compare.unifieddiff.UnifiedDiffMode;
import org.eclipse.compare.unifieddiff.internal.UnifiedDiffCodeMiningProvider;
import org.eclipse.compare.unifieddiff.internal.UnifiedDiffCodeMiningProvider.UnifiedDiffLineHeaderCodeMining;
import org.eclipse.compare.unifieddiff.internal.UnifiedDiffCodeMiningProvider.UnifiedDiffLineHeaderCodeMining.RangeInfo;
import org.eclipse.compare.unifieddiff.internal.UnifiedDiffManager.UnifiedDiff;
Expand Down Expand Up @@ -283,6 +286,22 @@ public void testClampDetailedDiffLengthNoOvershoot() {
assertEquals(3, clampDetailedDiffLength(5, 3, 20));
}

// --------------------------------- createDetailedDiffBackgroundRanges

/** A detailed diff reaching into trailing spaces is trimmed to the visible label, not dropped. */
@Test
public void testDetailedDiffRunningIntoTrailingSpacesIsTrimmedNotDropped() {
String diffStr = "foo bar ";
UnifiedDiff diff = replaceDiff(diffStr, detailedDiff(diffStr, 4, 6));

List<StyleRange> ranges = UnifiedDiffCodeMiningProvider.createDetailedDiffBackgroundRanges(diff, 4,
BACKGROUND_1);

assertEquals(1, ranges.size(), "the highlight must survive, trimmed to the visible label");
assertEquals(4, ranges.get(0).start, "highlight starts at 'bar'");
assertEquals(3, ranges.get(0).length, "highlight is trimmed to 'bar', dropping the trailing spaces");
}

// ------------------------------------------- getPositionForOffset

@Test
Expand Down Expand Up @@ -312,6 +331,21 @@ public void testGetPositionForOffsetResetsXAfterNewlineAtRangeStart() throws Exc

// ------------------------------------------------------------------ helpers

private static UnifiedDiff replaceDiff(String diffStr, UnifiedDiff... detailedDiffs) {
Document doc = new Document(diffStr);
UnifiedDiff diff = new UnifiedDiff(doc, 0, diffStr.length(), diffStr, doc, 0, diffStr.length(), diffStr,
new ArrayList<>(), UnifiedDiffMode.REPLACE_MODE);
Collections.addAll(diff.detailedDiffs, detailedDiffs);
return diff;
}

private static UnifiedDiff detailedDiff(String diffStr, int start, int length) {
Document doc = new Document(diffStr);
String sub = diffStr.substring(start, start + length);
return new UnifiedDiff(doc, start, start + length, sub, doc, start, start + length, sub, List.of(),
UnifiedDiffMode.REPLACE_MODE);
}

/**
* The merged ranges are handed to {@code StyledText#setStyleRanges}, which
* rejects overlapping ranges. They must therefore tile the foregrounds exactly:
Expand Down
Loading