Skip to content

Add dedicated overview-ruler annotation types for unified diff #3004

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

Add dedicated overview-ruler annotation types for unified diff #3004

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
9 changes: 9 additions & 0 deletions team/bundles/org.eclipse.compare/compare/org/eclipse/compare/internal/CompareMessages.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,15 @@ private CompareMessages() {
public static String UnifiedDiff_showUnchangedLines;
public static String UnifiedDiff_hideUnchangedLine;
public static String UnifiedDiff_hideUnchangedLines;
public static String UnifiedDiff_addition;
public static String UnifiedDiff_deletion;
public static String UnifiedDiff_additionAtLine;
public static String UnifiedDiff_additionFromLineToLine;
public static String UnifiedDiff_deletionAtLine;
public static String UnifiedDiff_deletionFromLineToLine;
public static String UnifiedDiff_replacement;
public static String UnifiedDiff_replacementAtLine;
public static String UnifiedDiff_replacementFromLineToLine;

static {
NLS.initializeMessages(BUNDLE_NAME, CompareMessages.class);
Expand Down
9 changes: 9 additions & 0 deletions ...ndles/org.eclipse.compare/compare/org/eclipse/compare/internal/CompareMessages.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,3 +156,12 @@ UnifiedDiff_showUnchangedLine=Show 1 unchanged line
UnifiedDiff_showUnchangedLines=Show {0} unchanged lines
UnifiedDiff_hideUnchangedLine=Hide 1 unchanged line
UnifiedDiff_hideUnchangedLines=Hide {0} unchanged lines
UnifiedDiff_addition=Addition
UnifiedDiff_deletion=Deletion
UnifiedDiff_additionAtLine=Addition at line {0}
UnifiedDiff_additionFromLineToLine=Addition from line {0} to {1}
UnifiedDiff_deletionAtLine=Deletion at line {0}
UnifiedDiff_deletionFromLineToLine=Deletion from line {0} to {1}
UnifiedDiff_replacement=Replacement
UnifiedDiff_replacementAtLine=Replacement at line {0}
UnifiedDiff_replacementFromLineToLine=Replacement from line {0} to {1}
127 changes: 127 additions & 0 deletions ....eclipse.compare/compare/org/eclipse/compare/unifieddiff/internal/UnifiedDiffManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@
import org.eclipse.jface.text.source.projection.ProjectionAnnotation;
import org.eclipse.jface.text.source.projection.ProjectionAnnotationModel;
import org.eclipse.jface.text.source.projection.ProjectionViewer;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.events.ControlEvent;
Expand Down Expand Up @@ -121,6 +122,8 @@ public class UnifiedDiffManager {
private static final String UNIFIED_DIFF_SHADOWED_FOLDS_KEY = "UNIFIED_DIFF_SHADOWED_FOLDS_KEY"; //$NON-NLS-1$
private static final String ADDITION_ANNO_TYPE = "org.eclipse.compare.unifieddiff.internal.addition"; //$NON-NLS-1$
private static final String DELETION_ANNO_TYPE = "org.eclipse.compare.unifieddiff.internal.deletion"; //$NON-NLS-1$
private static final String ADDITION_RULER_ANNO_TYPE = "org.eclipse.compare.unifieddiff.internal.addition.ruler"; //$NON-NLS-1$
private static final String DELETION_RULER_ANNO_TYPE = "org.eclipse.compare.unifieddiff.internal.deletion.ruler"; //$NON-NLS-1$
private static final String DETAILED_ADDITION_ANNO_TYPE = "org.eclipse.compare.unifieddiff.internal.detailedAddition"; //$NON-NLS-1$
private static final String DETAILED_DELETION_ANNO_TYPE = "org.eclipse.compare.unifieddiff.internal.detailedDeletion"; //$NON-NLS-1$
private static final String TOOLBAR_COMPOSITE_FOR_ONE_DIFF_KEY = "TOOLBAR_COMPOSITE_FOR_ONE_DIFF_KEY"; //$NON-NLS-1$
Expand Down Expand Up @@ -276,6 +279,13 @@ public static IStatus open(ITextViewer viewer, IDocument leftDocument, IAnnotati
Annotation myAnnotation = new UnifiedDiffAnnotation(mode, unifiedDiff);
Position position = new Position(unifiedDiff.leftStart, unifiedDiff.rightLength);
addOrStage.accept(myAnnotation, position);
AnnotationTypeAndText annoTypeAndText = createRulerAnnotationTypeAndText(mode, unifiedDiff);
Annotation rulerAnnotation = new UnifiedDiffRulerAnnotation(unifiedDiff, annoTypeAndText);
// A fresh Position is required: the annotation model registers each
// Position in the document's position category and shifts it on every
// document change. Sharing one instance would shift it twice and corrupt
// the offsets.
addOrStage.accept(rulerAnnotation, new Position(unifiedDiff.leftStart, unifiedDiff.rightLength));
for (var detailedDiff : unifiedDiff.detailedDiffs) {
if (detailedDiff.rightStr.trim().length() == 0) {
continue;
Expand All @@ -286,6 +296,7 @@ public static IStatus open(ITextViewer viewer, IDocument leftDocument, IAnnotati
addOrStage.accept(detailedAnno, detailedPos);
}
diffByAnno.put(myAnnotation, unifiedDiff);
diffByAnno.put(rulerAnnotation, unifiedDiff);
} catch (BadLocationException e) {
error(e);
}
Expand All @@ -295,6 +306,11 @@ public static IStatus open(ITextViewer viewer, IDocument leftDocument, IAnnotati
Annotation myAnnotation = new UnifiedDiffAnnotation(mode, unifiedDiff);
Position position = new Position(unifiedDiff.leftStart, unifiedDiff.leftLength);
addOrStage.accept(myAnnotation, position);
AnnotationTypeAndText annoTypeAndText = createRulerAnnotationTypeAndText(mode, unifiedDiff);
Annotation rulerAnnotation = new UnifiedDiffRulerAnnotation(unifiedDiff, annoTypeAndText);
// A fresh Position is required: see the comment in the REPLACE_MODE branch
// above.
addOrStage.accept(rulerAnnotation, new Position(unifiedDiff.leftStart, unifiedDiff.leftLength));
for (var detailedDiff : unifiedDiff.detailedDiffs) {
if (detailedDiff.leftStr.trim().length() == 0) {
continue;
Expand All @@ -305,6 +321,7 @@ public static IStatus open(ITextViewer viewer, IDocument leftDocument, IAnnotati
addOrStage.accept(detailedAnno, detailedPos);
}
diffByAnno.put(myAnnotation, unifiedDiff);
diffByAnno.put(rulerAnnotation, unifiedDiff);
}
}
if (annotationsToAdd != null) {
Expand Down Expand Up @@ -336,6 +353,14 @@ public static IStatus open(ITextViewer viewer, IDocument leftDocument, IAnnotati
return Status.OK_STATUS;
}

private static AnnotationTypeAndText createRulerAnnotationTypeAndText(UnifiedDiffMode mode,
UnifiedDiff unifiedDiff) {
DiffKind kind = diffKind(mode, unifiedDiff);
String annoType = kind == DiffKind.DELETION ? DELETION_RULER_ANNO_TYPE : ADDITION_RULER_ANNO_TYPE;
String text = createAnnotationText(mode, unifiedDiff, kind);
return new AnnotationTypeAndText(annoType, text);
}

/**
* Marker for the projection annotations added to collapse unchanged regions so
* they can be told apart from the editor's own (e.g. structural) folds.
Expand Down Expand Up @@ -988,6 +1013,22 @@ public UnifiedDiff getUnifiedDiff() {
}
}

private record AnnotationTypeAndText(String type, String text) {
}

private static final class UnifiedDiffRulerAnnotation extends Annotation {
private final UnifiedDiff unifiedDiff;

public UnifiedDiffRulerAnnotation(UnifiedDiff unifiedDiff, AnnotationTypeAndText annotationTypeAndText) {
super(annotationTypeAndText.type, false, annotationTypeAndText.text);
this.unifiedDiff = unifiedDiff;
}

public UnifiedDiff getUnifiedDiff() {
return unifiedDiff;
}
}

private static final class DetailedDiffAnnotation extends Annotation {
private final UnifiedDiff unifiedDiff;

Expand All @@ -1003,6 +1044,88 @@ public UnifiedDiff getUnifiedDiff() {
}
}

private static String createAnnotationText(UnifiedDiffMode mode, UnifiedDiff unifiedDiff, DiffKind kind) {
IDocument doc = unifiedDiff.left;
if (doc == null) {
return kind.text();
}
int offset = unifiedDiff.leftStart;
int length = UnifiedDiffMode.REPLACE_MODE.equals(mode) ? unifiedDiff.rightLength : unifiedDiff.leftLength;
try {
int docLength = doc.getLength();
int startOffset = Math.max(0, Math.min(offset, docLength));
int startLine = doc.getLineOfOffset(startOffset) + 1;
int endLine;
if (length > 0) {
int endOffset = Math.max(0, Math.min(offset + length - 1, docLength));
endLine = doc.getLineOfOffset(endOffset) + 1;
} else {
endLine = startLine;
}
endLine = Math.max(startLine, endLine);
if (startLine == endLine) {
return NLS.bind(kind.atLineText(), Integer.valueOf(startLine));
}
return NLS.bind(kind.fromLineToLineText(), Integer.valueOf(startLine), Integer.valueOf(endLine));
} catch (BadLocationException e) {
error(e);
return kind.text();
}
}

/**
* Classifies a diff as an addition, deletion, or replacement so the ruler tick
* gets the matching type, color, and tooltip wording (see
* {@link #createRulerAnnotationTypeAndText}). The classification is relative to
* the current document and the direction of the mode, not to the color the tick
* ends up with: in REPLACE_MODE and REVERT_MODE the current document is on the
* left, so an empty right side means the left has extra content and the diff is
* an addition; in OVERLAY_MODE the perspective is reversed and the non-empty
* right side is the addition.
*/
private static DiffKind diffKind(UnifiedDiffMode mode, UnifiedDiff unifiedDiff) {
boolean leftStringIsEmpty = unifiedDiff.leftStr == null || unifiedDiff.leftStr.trim().isEmpty();
boolean rightStringIsEmpty = unifiedDiff.rightStr == null || unifiedDiff.rightStr.trim().isEmpty();
if (!leftStringIsEmpty && !rightStringIsEmpty) {
return DiffKind.REPLACEMENT;
}
boolean addition = UnifiedDiffMode.REPLACE_MODE.equals(mode) || UnifiedDiffMode.REVERT_MODE.equals(mode)
? rightStringIsEmpty
: !rightStringIsEmpty;
return addition ? DiffKind.ADDITION : DiffKind.DELETION;
}

private enum DiffKind {
ADDITION(CompareMessages.UnifiedDiff_addition, CompareMessages.UnifiedDiff_additionAtLine,
CompareMessages.UnifiedDiff_additionFromLineToLine),
DELETION(CompareMessages.UnifiedDiff_deletion, CompareMessages.UnifiedDiff_deletionAtLine,
CompareMessages.UnifiedDiff_deletionFromLineToLine),
REPLACEMENT(CompareMessages.UnifiedDiff_replacement, CompareMessages.UnifiedDiff_replacementAtLine,
CompareMessages.UnifiedDiff_replacementFromLineToLine);

private final String text;
private final String atLineText;
private final String fromLineToLineText;

DiffKind(String text, String atLineText, String fromLineToLineText) {
this.text = text;
this.atLineText = atLineText;
this.fromLineToLineText = fromLineToLineText;
}

String text() {
return text;
}

String atLineText() {
return atLineText;
}

String fromLineToLineText() {
return fromLineToLineText;
}
}

private static void drawToolBarForAllDiffs(ITextViewer tv, IAnnotationModel model, List<Action> additionalActions,
UnifiedDiffMode mode, ToolbarActionPresentations presentations) {
StyledText tw = tv.getTextWidget();
Expand Down Expand Up @@ -1405,6 +1528,8 @@ private static UnifiedDiff getUnifiedDiffForAnno(Annotation anno) {
return da.getUnifiedDiff();
} else if (anno instanceof UnifiedDiffAnnotation a) {
return a.getUnifiedDiff();
} else if (anno instanceof UnifiedDiffRulerAnnotation ra) {
return ra.getUnifiedDiff();
} else if (anno instanceof AbstractInlinedAnnotation inlineAnno) {
List<ICodeMining> minings = inlineAnno.getMinings();
if (minings.size() == 1 && minings.get(0) instanceof UnifiedDiffLineHeaderCodeMining idlhcm) {
Expand Down Expand Up @@ -1701,6 +1826,8 @@ private static Annotation getUnifiedDiffAnnotationFromIterator(Iterator<Annotati
doit = true;
}
} else if (ADDITION_ANNO_TYPE.equals(anno.getType()) || DELETION_ANNO_TYPE.equals(anno.getType())
|| ADDITION_RULER_ANNO_TYPE.equals(anno.getType())
|| DELETION_RULER_ANNO_TYPE.equals(anno.getType())
|| DETAILED_ADDITION_ANNO_TYPE.equals(anno.getType())
|| DETAILED_DELETION_ANNO_TYPE.equals(anno.getType())) {
doit = true;
Expand Down
58 changes: 54 additions & 4 deletions team/bundles/org.eclipse.compare/plugin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,12 @@
markerType="org.eclipse.core.resources.problemmarker"
markerSeverity="0">
</type>
<type
name="org.eclipse.compare.unifieddiff.internal.addition.ruler">
</type>
<type
name="org.eclipse.compare.unifieddiff.internal.deletion.ruler">
</type>
<type
name="org.eclipse.compare.unifieddiff.internal.detailedAddition"
markerType="org.eclipse.core.resources.problemmarker"
Expand Down Expand Up @@ -498,7 +504,6 @@
presentationLayer="1"
showInNextPrevDropdownToolbarAction="false"
showInNextPrevDropdownToolbarActionKey="showInlineDiffInNextPrevDropdownToolbarAction"
symbolicIcon="info"
textPreferenceKey="inlineDiffIndication"
textPreferenceValue="true"
textStylePreferenceKey="inlineDiffTextStyle"
Expand All @@ -523,14 +528,61 @@
presentationLayer="1"
showInNextPrevDropdownToolbarAction="false"
showInNextPrevDropdownToolbarActionKey="showDeletionInlineDiffInNextPrevDropdownToolbarAction"
symbolicIcon="info"
textPreferenceKey="deletionInlineDiffIndication"
textPreferenceValue="true"
textStylePreferenceKey="deletionInlineDiffTextStyle"
textStylePreferenceValue="NONE"
verticalRulerPreferenceKey="deletionInlineDiffIndicationInVerticalRuler"
verticalRulerPreferenceValue="false">
</specification>
<specification
annotationType="org.eclipse.compare.unifieddiff.internal.addition.ruler"
colorPreferenceKey="inlineDiffRulerColor"
colorPreferenceValue="40,140,40"
contributesToHeader="false"
highlightPreferenceKey="inlineDiffRulerIndicationHighlighting"
highlightPreferenceValue="false"
isGoToNextNavigationTarget="false"
isGoToNextNavigationTargetKey="inlineDiffRulerGoToNextNavigationTarget"
isGoToPreviousNavigationTarget="false"
isGoToPreviousNavigationTargetKey="inlineDiffRulerGoToPreviousNavigationTarget"
label="Inline Diff Addition (Overview Ruler)"
overviewRulerPreferenceKey="inlineDiffRulerIndicationInOverviewRuler"
overviewRulerPreferenceValue="true"
presentationLayer="1"
showInNextPrevDropdownToolbarAction="false"
showInNextPrevDropdownToolbarActionKey="showInlineDiffRulerInNextPrevDropdownToolbarAction"
textPreferenceKey="inlineDiffRulerIndication"
textPreferenceValue="false"
textStylePreferenceKey="inlineDiffRulerTextStyle"
textStylePreferenceValue="NONE"
verticalRulerPreferenceKey="inlineDiffRulerIndicationInVerticalRuler"
verticalRulerPreferenceValue="false">
</specification>
<specification
annotationType="org.eclipse.compare.unifieddiff.internal.deletion.ruler"
colorPreferenceKey="deletionInlineDiffRulerColor"
colorPreferenceValue="220,50,50"
contributesToHeader="false"
highlightPreferenceKey="deletionInlineDiffRulerIndicationHighlighting"
highlightPreferenceValue="false"
isGoToNextNavigationTarget="false"
isGoToNextNavigationTargetKey="deletionInlineDiffRulerGoToNextNavigationTarget"
isGoToPreviousNavigationTarget="false"
isGoToPreviousNavigationTargetKey="deletionInlineDiffRulerGoToPreviousNavigationTarget"
label="Inline Diff Deletion (Overview Ruler)"
overviewRulerPreferenceKey="deletionInlineDiffRulerIndicationInOverviewRuler"
overviewRulerPreferenceValue="true"
presentationLayer="1"
showInNextPrevDropdownToolbarAction="false"
showInNextPrevDropdownToolbarActionKey="showDeletionInlineDiffRulerInNextPrevDropdownToolbarAction"
textPreferenceKey="deletionInlineDiffRulerIndication"
textPreferenceValue="false"
textStylePreferenceKey="deletionInlineDiffRulerTextStyle"
textStylePreferenceValue="NONE"
verticalRulerPreferenceKey="deletionInlineDiffRulerIndicationInVerticalRuler"
verticalRulerPreferenceValue="false">
</specification>
<specification
annotationType="org.eclipse.compare.unifieddiff.internal.detailedAddition"
colorPreferenceKey="detailedInlineDiffColor"
Expand All @@ -548,7 +600,6 @@
presentationLayer="2"
showInNextPrevDropdownToolbarAction="false"
showInNextPrevDropdownToolbarActionKey="showDetailedInlineDiffInNextPrevDropdownToolbarAction"
symbolicIcon="info"
textPreferenceKey="detailedInlineDiffIndication"
textPreferenceValue="true"
textStylePreferenceKey="detailedInlineDiffTextStyle"
Expand All @@ -573,7 +624,6 @@
presentationLayer="2"
showInNextPrevDropdownToolbarAction="false"
showInNextPrevDropdownToolbarActionKey="showDetailedDeletionInlineDiffInNextPrevDropdownToolbarAction"
symbolicIcon="info"
textPreferenceKey="detailedDeletionInlineDiffIndication"
textPreferenceValue="true"
textStylePreferenceKey="detailedDeletionInlineDiffTextStyle"
Expand Down
Loading
Loading