introduce DocumentFooterCodeMining to draw minings at the document end

Author: tobias-melcher

bundles/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/codemining/CodeMiningDocumentFooterAnnotation.java

@@ -0,0 +1,36 @@
+/*******************************************************************************
+* Copyright (c) 2025 SAP SE
+*
+* This program and the accompanying materials
+* are made available under the terms of the Eclipse Public License 2.0
+* which accompanies this distribution, and is available at
+* https://www.eclipse.org/legal/epl-2.0/
+*
+* SPDX-License-Identifier: EPL-2.0
+******************************************************************************/
+package org.eclipse.jface.internal.text.codemining;
+
+import java.util.function.Consumer;
+
+import org.eclipse.swt.events.MouseEvent;
+
+import org.eclipse.jface.text.Position;
+import org.eclipse.jface.text.source.ISourceViewer;
+
+public class CodeMiningDocumentFooterAnnotation extends CodeMiningMultilineAnnotation {
+
+	/**
+	 * Code mining annotation constructor.
+	 *
+	 * @param position the position
+	 * @param viewer the viewer
+	 * @param onMouseHover the consumer to be called on mouse hover. If set, the implementor needs
+	 *            to take care of setting the cursor if wanted.
+	 * @param onMouseOut the consumer to be called on mouse out. If set, the implementor needs to
+	 *            take care of resetting the cursor.
+	 * @param onMouseMove the consumer to be called on mouse move
+	 */
+	public CodeMiningDocumentFooterAnnotation(Position position, ISourceViewer viewer, Consumer<MouseEvent> onMouseHover, Consumer<MouseEvent> onMouseOut, Consumer<MouseEvent> onMouseMove) {
+		super(position, viewer, onMouseHover, onMouseOut, onMouseMove);
+	}
+}

bundles/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/codemining/CodeMiningLineHeaderAnnotation.java

@@ -13,54 +13,19 @@
  */
 package org.eclipse.jface.internal.text.codemining;
 
-import java.util.ArrayList;
-import java.util.List;
 import java.util.function.Consumer;
-import java.util.stream.Stream;
 
-import org.eclipse.swt.custom.StyledText;
 import org.eclipse.swt.events.MouseEvent;
-import org.eclipse.swt.graphics.Color;
-import org.eclipse.swt.graphics.GC;
-import org.eclipse.swt.graphics.Point;
-import org.eclipse.swt.graphics.Rectangle;
-
-import org.eclipse.core.runtime.IProgressMonitor;
 
 import org.eclipse.jface.text.Position;
-import org.eclipse.jface.text.codemining.ICodeMining;
 import org.eclipse.jface.text.source.ISourceViewer;
-import org.eclipse.jface.text.source.inlined.LineHeaderAnnotation;
 
 /**
  * Code Mining annotation in line header.
  *
  * @since 3.13
  */
-public class CodeMiningLineHeaderAnnotation extends LineHeaderAnnotation implements ICodeMiningAnnotation {
-
-	private static final String SEPARATOR= " | "; //$NON-NLS-1$
-
-	/**
-	 * List of resolved minings which contains current resolved minings and last resolved minings
-	 * and null if mining is not resolved.
-	 */
-	private ICodeMining[] fResolvedMinings;
-
-	/**
-	 * List of current resolved/unresolved minings
-	 */
-	private final List<ICodeMining> fMinings;
-
-	/**
-	 * List of bounds minings
-	 */
-	private final List<Rectangle> fBounds;
-
-	/**
-	 * The current progress monitor
-	 */
-	private IProgressMonitor fMonitor;
+public class CodeMiningLineHeaderAnnotation extends CodeMiningMultilineAnnotation {
 
 	/**
 	 * Code mining annotation constructor.
@@ -85,204 +50,5 @@ public CodeMiningLineHeaderAnnotation(Position position, ISourceViewer viewer) {
 	 */
 	public CodeMiningLineHeaderAnnotation(Position position, ISourceViewer viewer, Consumer<MouseEvent> onMouseHover, Consumer<MouseEvent> onMouseOut, Consumer<MouseEvent> onMouseMove) {
 		super(position, viewer, onMouseHover, onMouseOut, onMouseMove);
-		fResolvedMinings= null;
-		fMinings= new ArrayList<>();
-		fBounds= new ArrayList<>();
-	}
-
-	@Override
-	public int getHeight() {
-		return hasAtLeastOneResolvedMiningNotEmpty() ? getMultilineHeight(null) : 0;
-	}
-
-	public int getHeight(GC gc) {
-		return hasAtLeastOneResolvedMiningNotEmpty() ? getMultilineHeight(gc) : 0;
-	}
-
-	private int getMultilineHeight(GC gc) {
-		int numLinesOfAllMinings= 0;
-		StyledText styledText= super.getTextWidget();
-		boolean ignoreFirstLine= false;
-		int sumLineHeight= 0;
-		for (int i= 0; i < fMinings.size(); i++) {
-			ICodeMining mining= fMinings.get(i);
-			String label= mining.getLabel();
-			if (label == null) {
-				continue;
-			}
-			String[] splitted= label.split("\\r?\\n|\\r"); //$NON-NLS-1$
-			int numLines= splitted.length;
-			if (ignoreFirstLine) {
-				numLines--;
-			}
-			numLinesOfAllMinings+= numLines;
-			if (gc != null) {
-				sumLineHeight= calculateLineHeight(gc, styledText, ignoreFirstLine, sumLineHeight, i, splitted);
-			}
-			ignoreFirstLine= true;
-		}
-		if (sumLineHeight == 0) {
-			return super.getHeight();
-		}
-		if (gc != null) {
-			return sumLineHeight;
-		} else {
-			int lineHeight= styledText.getLineHeight();
-			int result= numLinesOfAllMinings * (lineHeight + styledText.getLineSpacing());
-			return result;
-		}
-	}
-
-	private int calculateLineHeight(GC gc, StyledText styledText, boolean ignoreFirstLine, int sumLineHeight, int miningIndex, String[] splitted) {
-		for (int j= 0; j < splitted.length; j++) {
-			String line= splitted[j];
-			if (j == 0 && ignoreFirstLine) {
-				continue;
-			}
-			if (j == splitted.length - 1 && miningIndex + 1 < fMinings.size()) { // last line, take first line from next mining
-				String nextLabel= fMinings.get(miningIndex + 1).getLabel();
-				if (nextLabel != null) {
-					String firstFromNext= nextLabel.split("\\r?\\n|\\r")[0]; //$NON-NLS-1$
-					line+= firstFromNext;
-				}
-			}
-			Point ext= gc.textExtent(line);
-			sumLineHeight+= ext.y + styledText.getLineSpacing();
-		}
-		return sumLineHeight;
-	}
-
-	/**
-	 * Returns <code>true</code> if the annotation has at least one resolved mining which have a
-	 * label and <code>false</code> otherwise.
-	 *
-	 * @return <code>true</code> if the annotation has at least one resolved mining which have a
-	 *         label and <code>false</code> otherwise.
-	 */
-	private boolean hasAtLeastOneResolvedMiningNotEmpty() {
-		if (fMinings.stream().anyMatch(m -> m.getLabel() != null && !m.getLabel().isEmpty())) {
-			return true; // will have a resolved mining.
-		}
-
-		if (fResolvedMinings == null || fResolvedMinings.length == 0) {
-			return false;
-		}
-		return Stream.of(fResolvedMinings).anyMatch(CodeMiningManager::isValidMining);
-	}
-
-	@Override
-	public void update(List<ICodeMining> minings, IProgressMonitor monitor) {
-		if (fResolvedMinings == null || (fResolvedMinings.length != minings.size())) {
-			// size of resolved minings are different from size of minings to update, initialize it with size of minings to update
-			fResolvedMinings= new ICodeMining[minings.size()];
-		}
-		// fill valid resolved minings with old minings.
-		int length= Math.min(fMinings.size(), minings.size());
-		for (int i= 0; i < length; i++) {
-			ICodeMining mining= fMinings.get(i);
-			if (mining.getLabel() != null) {
-				fResolvedMinings[i]= mining;
-			}
-		}
-		disposeMinings();
-		fMonitor= monitor;
-		fMinings.addAll(minings);
-	}
-
-	@Override
-	public void markDeleted(boolean deleted) {
-		super.markDeleted(deleted);
-		if (deleted) {
-			disposeMinings();
-			fResolvedMinings= null;
-		}
-	}
-
-	private void disposeMinings() {
-		fMinings.stream().forEach(ICodeMining::dispose);
-		fMinings.clear();
-	}
-
-	@Override
-	public void draw(GC gc, StyledText textWidget, int offset, int length, Color color, int x, int y) {
-		List<ICodeMining> minings= new ArrayList<>(fMinings);
-		int nbDraw= 0;
-		int separatorWidth= -1;
-		boolean redrawn= false;
-		fBounds.clear();
-		int singleLineHeight= super.getHeight();
-		int lineSpacing= textWidget.getLineSpacing();
-		for (int i= 0; i < minings.size(); i++) {
-			ICodeMining mining= minings.get(i);
-			// try to get the last resolved mining.
-			ICodeMining lastResolvedMining= (fResolvedMinings != null && fResolvedMinings.length > i) ? fResolvedMinings[i] : null;
-			if (mining.getLabel() != null) {
-				// mining is resolved without error, update the resolved mining list
-				fResolvedMinings[i]= mining;
-			} else if (!mining.isResolved()) {
-				// the mining is not resolved, draw the last resolved mining
-				mining= lastResolvedMining;
-				if (!redrawn) {
-					// redraw the annotation when mining is resolved.
-					redraw();
-					redrawn= true;
-				}
-			} else {
-				// the mining is resolved with error, draw the last resolved mining
-				mining= lastResolvedMining;
-			}
-			if (!CodeMiningManager.isValidMining(mining)) {
-				// ignore the draw of mining
-				continue;
-			}
-			// draw the mining
-			if (nbDraw > 0) {
-				gc.drawText(SEPARATOR, x, y);
-				if (separatorWidth == -1) {
-					separatorWidth= gc.stringExtent(SEPARATOR).x;
-				}
-				x+= separatorWidth;
-			}
-			Point loc= null;
-			if (mining != null) {
-				loc= mining.draw(gc, textWidget, color, x, y);
-			}
-			if (loc != null) {
-				fBounds.add(new Rectangle(x, y, loc.x, loc.y));
-				x+= loc.x;
-				if (loc.y > singleLineHeight) {
-					y+= loc.y + lineSpacing - singleLineHeight;
-				}
-			}
-			nbDraw++;
-		}
-	}
-
-	@Override
-	public void redraw() {
-		// redraw codemining annotation is done only if all current minings are resolved.
-		List<ICodeMining> minings= new ArrayList<>(fMinings);
-		for (ICodeMining mining : minings) {
-			if (!mining.isResolved()) {
-				// one of mining is not resolved, resolve it and then redraw the annotation.
-				mining.resolve(getViewer(), fMonitor).thenRunAsync(() -> {
-					this.redraw();
-				});
-				return;
-			}
-		}
-		// all minings are resolved, redraw the annotation
-		super.redraw();
-	}
-
-	@Override
-	public Consumer<MouseEvent> getAction(MouseEvent e) {
-		ICodeMining mining= CodeMiningManager.getValidCodeMiningAtLocation(fResolvedMinings, fBounds, e.x, e.y);
-		return mining != null ? mining.getAction() : null;
-	}
-
-	@Override
-	public boolean isInVisibleLines() {
-		return super.isInVisibleLines();
 	}
 }

bundles/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/codemining/CodeMiningManager.java

@@ -42,6 +42,7 @@
 import org.eclipse.jface.text.IDocument;
 import org.eclipse.jface.text.ITextViewer;
 import org.eclipse.jface.text.Position;
+import org.eclipse.jface.text.codemining.DocumentFooterCodeMining;
 import org.eclipse.jface.text.codemining.ICodeMining;
 import org.eclipse.jface.text.codemining.ICodeMiningProvider;
 import org.eclipse.jface.text.codemining.LineContentCodeMining;
@@ -256,6 +257,7 @@ private void renderCodeMinings(Map<Position, List<ICodeMining>> groups, ISourceV
 			List<ICodeMining> minings= g.getValue();
 			ICodeMining first= minings.get(0);
 			boolean inLineHeader= !minings.isEmpty() ? (first instanceof LineHeaderCodeMining) : true;
+			boolean inFooter= !minings.isEmpty() ? (first instanceof DocumentFooterCodeMining) : false;
 			// Try to find existing annotation
 			AbstractInlinedAnnotation ann= fInlinedAnnotationSupport.findExistingAnnotation(pos);
 			if (ann == null) {
@@ -272,9 +274,13 @@ private void renderCodeMinings(Map<Position, List<ICodeMining>> groups, ISourceV
 					mouseOut= first.getMouseOut();
 					mouseMove= first.getMouseMove();
 				}
-				ann= inLineHeader
-						? new CodeMiningLineHeaderAnnotation(pos, viewer, mouseHover, mouseOut, mouseMove)
-						: new CodeMiningLineContentAnnotation(pos, viewer, afterPosition, mouseHover, mouseOut, mouseMove);
+				if (inFooter) {
+					ann= new CodeMiningDocumentFooterAnnotation(pos, viewer, mouseHover, mouseOut, mouseMove);
+				} else {
+					ann= inLineHeader
+							? new CodeMiningLineHeaderAnnotation(pos, viewer, mouseHover, mouseOut, mouseMove)
+							: new CodeMiningLineContentAnnotation(pos, viewer, afterPosition, mouseHover, mouseOut, mouseMove);
+				}
 			} else if (ann instanceof ICodeMiningAnnotation && ((ICodeMiningAnnotation) ann).isInVisibleLines()) {
 				// annotation is in visible lines
 				annotationsToRedraw.add((ICodeMiningAnnotation) ann);