/**
* Copyright (c) 2017 Angelo ZERR.
*
* 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
*
* Contributors:
* Angelo Zerr <angelo.zerr@gmail.com> - [CodeMining] Provide inline annotations support - Bug 527675
*/
package org.eclipse.jface.text.source.inlined;
import org.eclipse.swt.custom.StyleRange;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.GlyphMetrics;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.source.Annotation;
import org.eclipse.jface.text.source.AnnotationPainter.IDrawingStrategy;
/**
* {@link IDrawingStrategy} implementation to render {@link AbstractInlinedAnnotation}.
*
* @since 3.13
*/
class InlinedAnnotationDrawingStrategy implements IDrawingStrategy {
@Override
public void draw(Annotation annotation, GC gc, StyledText textWidget, int offset, int length, Color color) {
if (!(annotation instanceof AbstractInlinedAnnotation)) {
return;
}
if (!((AbstractInlinedAnnotation) annotation).isInVisibleLines()) {
// The annotation is not in visible lines, don't draw it.
return;
}
InlinedAnnotationDrawingStrategy.draw((AbstractInlinedAnnotation) annotation, gc, textWidget, offset, length,
color);
}
/**
* Draw the inlined annotation.
*
* @param annotation the annotation to be drawn
* @param gc the graphics context, <code>null</code> when in clearing mode
* @param textWidget the text widget to draw on
* @param offset the offset of the line
* @param length the length of the line
* @param color the color of the line
*/
public static void draw(AbstractInlinedAnnotation annotation, GC gc, StyledText textWidget, int offset, int length,
Color color) {
if (annotation instanceof LineHeaderAnnotation) {
draw((LineHeaderAnnotation) annotation, gc, textWidget, offset, length, color);
} else {
draw((LineContentAnnotation) annotation, gc, textWidget, offset, length, color);
}
}
/**
* Draw the line header annotation in the line spacing of the previous line.
*
* @param annotation the annotation to be drawn
* @param gc the graphics context, <code>null</code> when in clearing mode
* @param textWidget the text widget to draw on
* @param offset the offset of the line
* @param length the length of the line
* @param color the color of the line
*/
private static void draw(LineHeaderAnnotation annotation, GC gc, StyledText textWidget, int offset, int length,
Color color) {
StyleRange style= null;
try {
style= textWidget.getStyleRangeAtOffset(offset);
} catch (Exception e) {
return;
}
if (isDeleted(annotation)) {
// When annotation is deleted, update metrics to null to remove extra spaces of the line header annotation.
if (style != null && style.metrics != null) {
style.metrics= null;
textWidget.setStyleRange(style);
}
return;
}
if (gc != null) {
// Compute the location of the annotation
Rectangle bounds= textWidget.getTextBounds(offset, offset);
int x= bounds.x;
int y= bounds.y;
gc.setBackground(textWidget.getBackground());
// Draw the line header annotation
annotation.setLocation(x, y);
annotation.draw(gc, textWidget, offset, length, color, x, y);
int height= annotation.getHeight();
if (height != 0) {
// The inline annotation replaces one character by taking a place width
// GlyphMetrics
// Here we need to redraw this first character because GlyphMetrics clip this
// character.
// FIXME: remove this code when we need not redraw the character (see https://bugs.eclipse.org/bugs/show_bug.cgi?id=531769)
// START TO REMOVE
String s= textWidget.getText(offset, offset);
Point charBounds= gc.stringExtent(s);
int charWidth= charBounds.x;
int charHeight= charBounds.y;
annotation.setRedrawnCharacterWidth(charWidth);
annotation.setRedrawnCharacterHeight(charHeight);
// END TO REMOVE
StyleRange newStyle= updateStyle(annotation, style);
if (newStyle != null) {
textWidget.setStyleRange(newStyle);
return;
}
// FIXME: remove this code when we need not redraw the character (see https://bugs.eclipse.org/bugs/show_bug.cgi?id=531769)
// START TO REMOVE
int charX= x + bounds.width - charWidth;
int charY= y + bounds.height - textWidget.getLineHeight();
if (style != null) {
if (style.background != null) {
gc.setBackground(style.background);
gc.fillRectangle(charX, charY, charWidth + 1, bounds.height);
}
if (style.foreground != null) {
gc.setForeground(style.foreground);
} else {
gc.setForeground(textWidget.getForeground());
}
gc.setFont(annotation.getFont(style.fontStyle));
}
gc.drawString(s, charX, charY, true);
// END TO REMOVE
} else if (style != null && style.metrics != null && style.metrics.ascent != 0) {
// line header annotation had an height, reset it
style.metrics= null;
textWidget.setStyleRange(style);
}
} else {
if (style != null && style.metrics != null) {
// Here GlyphMetrics ascent is done, the redraw of the full line width is done to avoid annotation clipping
Rectangle bounds= textWidget.getTextBounds(offset, offset);
Rectangle client= textWidget.getClientArea();
textWidget.redraw(0, bounds.y, client.width, bounds.height, false);
} else {
textWidget.redrawRange(offset, length, true);
}
}
}
/**
* Returns the style to apply with GlyphMetrics ascent only if needed.
*
* @param annotation the line header annotation
* @param style the current style and null otherwise.
* @return the style to apply with GlyphMetrics ascent only if needed.
*/
static StyleRange updateStyle(LineHeaderAnnotation annotation, StyleRange style) {
int width= annotation.getRedrawnCharacterWidth();
if (width == 0) {
// Update GlyphMetrics only when mining was already drawn
return null;
}
int height= annotation.getHeight();
if (height == 0) {
return null;
}
int fullHeight= height + annotation.getRedrawnCharacterHeight();
if (style == null) {
style= new StyleRange();
Position position= annotation.getPosition();
style.start= position.getOffset();
style.length= 1;
}
GlyphMetrics metrics= style.metrics;
if (!annotation.isMarkedDeleted()) {
if (metrics == null) {
metrics= new GlyphMetrics(fullHeight, 0, width);
} else {
if (metrics.ascent == fullHeight) {
return null;
}
/**
* We must create a new GlyphMetrics instance because comparison with similarTo used
* later in StyledText#setStyleRange will compare the same (modified) and won't
* realize an update happened.
*/
metrics= new GlyphMetrics(fullHeight, 0, width);
}
} else {
metrics= null;
}
style.metrics= metrics;
return style;
}
/**
* Draw the line content annotation inside line in the empty area computed by
* {@link GlyphMetrics}.
*
* @param annotation the annotation to be drawn
* @param gc the graphics context, <code>null</code> when in clearing mode
* @param textWidget the text widget to draw on
* @param offset the offset of the line
* @param length the length of the line
* @param color the color of the line
*/
private static void draw(LineContentAnnotation annotation, GC gc, StyledText textWidget, int offset, int length,
Color color) {
StyleRange style= null;
try {
style= textWidget.getStyleRangeAtOffset(offset);
} catch (Exception e) {
return;
}
if (isDeleted(annotation)) {
// When annotation is deleted, update metrics to null to remove extra spaces of the line content annotation.
if (style != null && style.metrics != null) {
style.metrics= null;
textWidget.setStyleRange(style);
}
return;
}
if (gc != null) {
// Compute the location of the annotation
Rectangle bounds= textWidget.getTextBounds(offset, offset);
int x= bounds.x;
int y= bounds.y;
// Get size of the character where GlyphMetrics width is added
String s= textWidget.getText(offset, offset);
Point charBounds= gc.stringExtent(s);
int charWidth= charBounds.x;
// When line text has line header annotation, there is a space on the top, adjust the y by using char height
y+= bounds.height - textWidget.getLineHeight();
// Draw the line content annotation
annotation.setLocation(x, y);
annotation.draw(gc, textWidget, offset, length, color, x, y);
int width= annotation.getWidth();
if (width != 0) {
// FIXME: remove this code when we need not redraw the character (see https://bugs.eclipse.org/bugs/show_bug.cgi?id=531769)
// START TO REMOVE
annotation.setRedrawnCharacterWidth(charWidth);
// END TO REMOVE
// Annotation takes place, add GlyphMetrics width to the style
StyleRange newStyle= updateStyle(annotation, style);
if (newStyle != null) {
textWidget.setStyleRange(newStyle);
return;
}
// FIXME: remove this code when we need not redraw the character (see https://bugs.eclipse.org/bugs/show_bug.cgi?id=531769)
// START TO REMOVE
// The inline annotation replaces one character by taking a place width
// GlyphMetrics
// Here we need to redraw this first character (if it's not a line delimiter) because GlyphMetrics clip this
// character.
if (!("\r".equals(s) || "\n".equals(s))) { //$NON-NLS-1$ //$NON-NLS-2$
int charX= x + bounds.width - charWidth;
int charY= y;
if (style != null) {
if (style.background != null) {
gc.setBackground(style.background);
gc.fillRectangle(charX, charY, charWidth + 1, bounds.height);
}
if (style.foreground != null) {
gc.setForeground(style.foreground);
} else {
gc.setForeground(textWidget.getForeground());
}
gc.setFont(annotation.getFont(style.fontStyle));
}
gc.drawString(s, charX, charY, true);
}
// END TO REMOVE
} else if (style != null && style.metrics != null && style.metrics.width != 0) {
// line content annotation had an , reset it
style.metrics= null;
textWidget.setStyleRange(style);
}
} else {
textWidget.redrawRange(offset, length, true);
}
}
/**
* Returns the style to apply with GlyphMetrics width only if needed.
*
* @param annotation the line content annotation
* @param style the current style and null otherwise.
* @return the style to apply with GlyphMetrics width only if needed.
*/
static StyleRange updateStyle(LineContentAnnotation annotation, StyleRange style) {
int width= annotation.getWidth();
if (width == 0) {
return null;
}
int fullWidth= width + annotation.getRedrawnCharacterWidth();
if (style == null) {
style= new StyleRange();
Position position= annotation.getPosition();
style.start= position.getOffset();
style.length= 1;
}
GlyphMetrics metrics= style.metrics;
if (!annotation.isMarkedDeleted()) {
if (metrics == null) {
metrics= new GlyphMetrics(0, 0, fullWidth);
} else {
if (metrics.width == fullWidth) {
return null;
}
/**
* We must create a new GlyphMetrics instance because comparison with similarTo used
* later in StyledText#setStyleRange will compare the same (modified) and won't
* realize an update happened.
*/
metrics= new GlyphMetrics(0, 0, fullWidth);
}
} else {
metrics= null;
}
style.metrics= metrics;
return style;
}
/**
* Returns <code>true</code> if inlined annotation is deleted and <code>false</code> otherwise.
*
* @param annotation the inlined annotation to check
* @return <code>true</code> if inlined annotation is deleted and <code>false</code> otherwise.
*/
private static boolean isDeleted(AbstractInlinedAnnotation annotation) {
return annotation.isMarkedDeleted() || annotation.getPosition().isDeleted() || annotation.getPosition().getLength() == 0;
}
}
