Spring/spring-tools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Range highlights and CodeLenses

Browse Source
This commit is contained in:
BoykoAlex
2018-08-28 23:51:14 -04:00
parent dc8550f706
commit 51d1cf96cd
7 changed files with 192 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/plugin.xml
View File

@@ -13,16 +13,16 @@
contributesToHeader="false"
highlightPreferenceKey="STS4BootMarkerHighlighting"
highlightPreferenceValue="true"
icon="icons/boot-icon.png"
label="Boot Dynamic Info"
overviewRulerPreferenceKey="STS4BootMarkerIndicationInOverviewRuler"
overviewRulerPreferenceValue="true"
overviewRulerPreferenceValue="false"
presentationLayer="4"
showInNextPrevDropdownToolbarAction="false"
textPreferenceKey="STS4BootMarkerIndication"
textPreferenceValue="true"
textStylePreferenceKey="STS4BootMarkerTextStyle"
textPreferenceValue="false"
verticalRulerPreferenceKey="STS4BootMarkerIndicationInVerticalRuler"
verticalRulerPreferenceValue="true">
verticalRulerPreferenceValue="false">
</specification>
</extension>
<extension

53
eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/LanguageServerCommonsActivator.java
View File

@@ -17,15 +17,22 @@ import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.preference.PreferenceConverter;
import org.eclipse.jface.resource.ColorRegistry;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.RGB;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.internal.editors.text.EditorsPlugin;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.springframework.tooling.ls.eclipse.commons.STS4LanguageClientImpl.UpdateHighlights;
import org.springframework.tooling.ls.eclipse.commons.preferences.PreferenceConstants;
@SuppressWarnings("restriction")
public class LanguageServerCommonsActivator extends AbstractUIPlugin {
public static final String PLUGIN_ID = "org.springframework.tooling.ls.eclipse.commons";
@@ -34,17 +41,46 @@ public class LanguageServerCommonsActivator extends AbstractUIPlugin {
private static LanguageServerCommonsActivator instance;
private static final IPropertyChangeListener PROPERTY_LISTENER = new IPropertyChangeListener() {
private ColorRegistry colorRegistry;
private final IPropertyChangeListener PROPERTY_LISTENER = new IPropertyChangeListener() {
@Override
public void propertyChange(PropertyChangeEvent event) {
if (PreferenceConstants.HIGHLIGHT_CODELENS_PREFS.equals(event.getProperty())) {
switch (event.getProperty()) {
case PreferenceConstants.HIGHLIGHT_RANGE_COLOR_PREFS:
RGB prefsColor = PreferenceConverter
.getColor(EditorsPlugin.getDefault().getPreferenceStore(), PreferenceConstants.HIGHLIGHT_RANGE_COLOR_PREFS);
// Convert color to without alpha with background
RGB derivedColor = convertRGBtoNonTransparent(prefsColor);
colorRegistry.put(PreferenceConstants.HIGHLIGHT_RANGE_COLOR_PREFS, derivedColor);
// No break - need to update highlights for the new color to take effect
case PreferenceConstants.HIGHLIGHT_CODELENS_PREFS:
new UpdateHighlights(null);
break;
default:
}
}
};
private static int convertColorToNonTransparent(int color, int bg, double alpha) {
int x = (int) Math.round((color - (1 - alpha) * bg) / alpha);
x = Math.max(0, x);
x = Math.min(x, 0xFF);
return x;
}
private static RGB convertRGBtoNonTransparent(RGB rgb) {
double alpha = 0.25;
RGB bg = new RGB(0xFF, 0xFF, 0xFF); // white
return new RGB(
convertColorToNonTransparent(rgb.red, bg.red, alpha),
convertColorToNonTransparent(rgb.green, bg.green, alpha),
convertColorToNonTransparent(rgb.blue, bg.blue, alpha)
);
}
public LanguageServerCommonsActivator() {
}
@@ -53,7 +89,19 @@ public class LanguageServerCommonsActivator extends AbstractUIPlugin {
instance = this;
super.start(context);
getImageRegistry().put(BOOT_KEY, getImageDescriptor("icons/boot.png"));
colorRegistry = new ColorRegistry(PlatformUI.getWorkbench().getDisplay(), true);
RGB prefsColor = PreferenceConverter.getColor(EditorsPlugin.getDefault().getPreferenceStore(), PreferenceConstants.HIGHLIGHT_RANGE_COLOR_PREFS);
colorRegistry.put(PreferenceConstants.HIGHLIGHT_RANGE_COLOR_PREFS, convertRGBtoNonTransparent(prefsColor));
getPreferenceStore().addPropertyChangeListener(PROPERTY_LISTENER);
EditorsPlugin.getDefault().getPreferenceStore().addPropertyChangeListener(PROPERTY_LISTENER);
}
public Color getBootHighlightRangeColor() {
return colorRegistry.get(PreferenceConstants.HIGHLIGHT_RANGE_COLOR_PREFS);
}
public final static ImageDescriptor getImageDescriptor(String path) {
@@ -71,6 +119,7 @@ public class LanguageServerCommonsActivator extends AbstractUIPlugin {
@Override
public void stop(BundleContext context) throws Exception {
EditorsPlugin.getDefault().getPreferenceStore().removePropertyChangeListener(PROPERTY_LISTENER);
getPreferenceStore().removePropertyChangeListener(PROPERTY_LISTENER);
super.stop(context);
}

159
eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/STS4LanguageClientImpl.java
View File

@@ -10,6 +10,7 @@
*******************************************************************************/
package org.springframework.tooling.ls.eclipse.commons;
import java.lang.reflect.Field;
import java.net.URI;
import java.util.List;
import java.util.Map;
@@ -23,8 +24,11 @@ import org.eclipse.jface.action.IStatusLineManager;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.source.Annotation;
import org.eclipse.jface.text.source.AnnotationPainter;
import org.eclipse.jface.text.source.AnnotationPainter.IDrawingStrategy;
import org.eclipse.jface.text.source.IAnnotationModel;
import org.eclipse.jface.text.source.IAnnotationModelExtension;
import org.eclipse.jface.text.source.ISourceViewer;
@@ -32,8 +36,17 @@ import org.eclipse.jface.text.source.ISourceViewerExtension5;
import org.eclipse.lsp4e.LSPEclipseUtils;
import org.eclipse.lsp4e.LanguageClientImpl;
import org.eclipse.lsp4j.CodeLens;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.progress.UIJob;
import org.eclipse.ui.texteditor.AbstractDecoratedTextEditor;
import org.eclipse.ui.texteditor.SourceViewerDecorationSupport;
import org.springframework.tooling.jdt.ls.commons.Logger;
import org.springframework.tooling.jdt.ls.commons.classpath.ReusableClasspathListenerHandler;
import org.springframework.tooling.jdt.ls.commons.javadoc.JavadocResponse;
@@ -53,11 +66,49 @@ public class STS4LanguageClientImpl extends LanguageClientImpl implements STS4La
() -> new ProjectSorter()
);
public STS4LanguageClientImpl() {
}
private static final String ANNOTION_TYPE_ID = "org.springframework.tooling.bootinfo";
private static final String ALT_ANNOTATION_DRAWING_STRATEGY_ID = "boot.hint.strategy";
private static final String ALT_ANNOTATION_TYPE_ID = "org.springframework.tooling.bootinfoCodeLens";
/**
* Latest highlight request params. It is sufficient to only remember the last request per uri, because
* each new request is expected to replace the previous highlights.
*/
static final Map<String, HighlightParams> currentHighlights = new ConcurrentHashMap<>();
/**
* Current markers... indexed per document uri, needed sp we to be removed upon next update.
*/
private static Map<String, Annotation[]> currentAnnotations = new ConcurrentHashMap<>();
private static final IDrawingStrategy BOOT_RANGE_HIGHLIGHT_DRAWING_STRATEGY = new IDrawingStrategy() {
@Override
public void draw(Annotation annotation, GC gc, StyledText textWidget, int offset, int length, Color color) {
if (gc == null) {
textWidget.redrawRange(offset, length, true);
} else {
int oldAlpha = gc.getAlpha();
Font oldFont = gc.getFont();
Point left= textWidget.getLocationAtOffset(offset);
Point right = textWidget.getLocationAtOffset(offset + length);
gc.setFont(textWidget.getFont());
int fontHeight = gc.getFontMetrics().getHeight();
Rectangle r = new Rectangle(left.x, left.y + textWidget.getLineHeight(offset) - fontHeight, right.x - left.x, fontHeight);
gc.setAlpha(0x40);
gc.setBackground(color);
gc.fillRectangle(r);
gc.setAlpha(oldAlpha);
gc.setFont(oldFont);
}
}
};
static class UpdateHighlights extends UIJob {
private String target;
@@ -71,51 +122,77 @@ public class STS4LanguageClientImpl extends LanguageClientImpl implements STS4La
@Override
public IStatus runInUIThread(IProgressMonitor monitor) {
Utils.getActiveSourceViewers().forEach(this::updateSourceViewer);
Utils.getActiveEditors().forEach(this::updateSourceViewer);
return Status.OK_STATUS;
}
protected void updateSourceViewer(ISourceViewer sourceViewer) {
IAnnotationModel annotationModel = sourceViewer.getAnnotationModel();
if (annotationModel != null) {
IDocument doc = sourceViewer.getDocument();
if (doc != null && sourceViewer != null) {
if (target != null) {
HighlightParams highlightParams = currentHighlights.get(target);
if (Utils.isProperDocumentIdFor(doc, highlightParams.getDoc())) {
if (annotationModel instanceof IAnnotationModelExtension) {
updateAnnotations(target, sourceViewer, (IAnnotationModelExtension) annotationModel);
protected void updateSourceViewer(IEditorPart editor) {
ITextViewer viewer = editor.getAdapter(ITextViewer.class);
if (viewer instanceof ISourceViewer) {
ISourceViewer sourceViewer = (ISourceViewer) viewer;
IAnnotationModel annotationModel = sourceViewer.getAnnotationModel();
if (annotationModel != null) {
IDocument doc = sourceViewer.getDocument();
if (doc != null && sourceViewer != null) {
if (target != null) {
HighlightParams highlightParams = currentHighlights.get(target);
if (Utils.isProperDocumentIdFor(doc, highlightParams.getDoc())) {
updateHighlightAnnotations(editor, sourceViewer, annotationModel, target);
}
if (sourceViewer instanceof ISourceViewerExtension5) {
((ISourceViewerExtension5) sourceViewer).updateCodeMinings();
}
}
} else {
URI uri = Utils.findDocUri(doc);
if (uri != null) {
if (annotationModel instanceof IAnnotationModelExtension) {
updateAnnotations(uri.toString(), sourceViewer, (IAnnotationModelExtension) annotationModel);
}
if (sourceViewer instanceof ISourceViewerExtension5) {
((ISourceViewerExtension5) sourceViewer).updateCodeMinings();
} else {
URI uri = Utils.findDocUri(doc);
if (uri != null) {
updateHighlightAnnotations(editor, sourceViewer, annotationModel, uri.toString());
}
}
}
}
}
}
};
/**
* Latest highlight request params. It is sufficient to only remember the last request per uri, because
* each new request is expected to replace the previous highlights.
*/
static final Map<String, HighlightParams> currentHighlights = new ConcurrentHashMap<>();
private static void updateHighlightAnnotations(IEditorPart editor, ISourceViewer sourceViewer,
IAnnotationModel annotationModel, String docUri) {
if (annotationModel instanceof IAnnotationModelExtension) {
if (isCodeLensHighlightOn()) {
addBootRangeHighlightSupport(editor, sourceViewer);
}
updateAnnotations(docUri, sourceViewer, (IAnnotationModelExtension) annotationModel);
}
if (sourceViewer instanceof ISourceViewerExtension5) {
((ISourceViewerExtension5) sourceViewer).updateCodeMinings();
}
}
/**
* Current markers... indexed per document uri, needed sp we to be removed upon next update.
*/
private static Map<String, Annotation[]> currentAnnotations = new ConcurrentHashMap<>();
@SuppressWarnings("unchecked")
private static void addBootRangeHighlightSupport(IEditorPart editor, ISourceViewer sourceViewer) {
try {
Field f = AbstractDecoratedTextEditor.class.getDeclaredField("fSourceViewerDecorationSupport");
f.setAccessible(true);
SourceViewerDecorationSupport support = (SourceViewerDecorationSupport) f.get(editor);
f = SourceViewerDecorationSupport.class.getDeclaredField("fAnnotationPainter");
f.setAccessible(true);
AnnotationPainter painter = (AnnotationPainter) f.get(support);
f = AnnotationPainter.class.getDeclaredField("fAnnotationType2Color");
f.setAccessible(true);
if (((Map<Object, Color>)f.get(painter)).get(ALT_ANNOTATION_TYPE_ID) != LanguageServerCommonsActivator.getInstance().getBootHighlightRangeColor()) {
painter.setAnnotationTypeColor(ALT_ANNOTATION_TYPE_ID, LanguageServerCommonsActivator.getInstance().getBootHighlightRangeColor());
painter.addDrawingStrategy(ALT_ANNOTATION_DRAWING_STRATEGY_ID, BOOT_RANGE_HIGHLIGHT_DRAWING_STRATEGY);
painter.addAnnotationType(ALT_ANNOTATION_TYPE_ID, ALT_ANNOTATION_DRAWING_STRATEGY_ID);
}
} catch (Exception e) {
LanguageServerCommonsActivator.logError(e,
"Failed to contribute alternative range highlight annotation. Switch off highlight CodeLense under STS Language Server preferences!");
}
}
private static boolean isCodeLensHighlightOn() {
IPreferenceStore store = LanguageServerCommonsActivator.getInstance().getPreferenceStore();
return store.getBoolean(PreferenceConstants.HIGHLIGHT_CODELENS_PREFS);
}
static synchronized void updateAnnotations(String target, ISourceViewer sourceViewer,
IAnnotationModelExtension annotationModel) {
@@ -124,24 +201,24 @@ public class STS4LanguageClientImpl extends LanguageClientImpl implements STS4La
toRemove = new Annotation[0];
}
HighlightParams highlightParams = currentHighlights.get(target);
IPreferenceStore store = LanguageServerCommonsActivator.getInstance().getPreferenceStore();
List<CodeLens> highlights = store.getBoolean(PreferenceConstants.HIGHLIGHT_CODELENS_PREFS) || highlightParams == null ? null : highlightParams.getCodeLenses();
Map<Annotation, Position> newAnnotations = createAnnotations(sourceViewer.getDocument(), highlights);
List<CodeLens> highlights = highlightParams == null ? null : highlightParams.getCodeLenses();
String annotationType = isCodeLensHighlightOn() ? ALT_ANNOTATION_TYPE_ID : ANNOTION_TYPE_ID;
Map<Annotation, Position> newAnnotations = createAnnotations(sourceViewer.getDocument(), highlights, annotationType);
annotationModel.replaceAnnotations(toRemove, newAnnotations);
currentAnnotations.put(target, newAnnotations.keySet().toArray(new Annotation[newAnnotations.size()]));
}
private static Map<Annotation, Position> createAnnotations(IDocument doc, List<CodeLens> highlights) {
private static Map<Annotation, Position> createAnnotations(IDocument doc, List<CodeLens> highlights, String annotationType) {
ImmutableMap.Builder<Annotation, Position> annotations = ImmutableMap.builder();
if (highlights==null) {
highlights = ImmutableList.of();
}
highlights.stream().map(CodeLens::getRange).forEach(rng -> {
highlights.stream().map(CodeLens::getRange).distinct().forEach(rng -> {
try {
int start = LSPEclipseUtils.toOffset(rng.getStart(), doc);
int end = LSPEclipseUtils.toOffset(rng.getEnd(), doc);
Position e_rng = new Position(start, Math.max(0, end-start));
annotations.put(new Annotation(ANNOTION_TYPE_ID, false, null), e_rng);
annotations.put(new Annotation(annotationType, false, null), e_rng);
} catch (BadLocationException e) {
//ignore invalid highlights
}

21
eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/Utils.java
View File

@@ -21,24 +21,29 @@ import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.lsp4e.LanguageServiceAccessor;
import org.eclipse.lsp4e.LanguageServiceAccessor.LSPDocumentInfo;
import org.eclipse.lsp4j.VersionedTextDocumentIdentifier;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.PlatformUI;
@SuppressWarnings("restriction")
public class Utils {
public static Stream<ITextViewer> getActiveTextViewers() {
return Arrays.stream(PlatformUI.getWorkbench().getWorkbenchWindows())
.filter(Objects::nonNull)
.flatMap(ww -> Arrays.stream(ww.getPages()))
.filter(Objects::nonNull)
.flatMap(page -> Arrays.stream(page.getEditorReferences()))
.filter(Objects::nonNull)
.map(ref -> ref.getEditor(false))
.filter(Objects::nonNull)
return getActiveEditors()
.map(editorPart -> editorPart.getAdapter(ITextViewer.class))
.filter(Objects::nonNull);
}
public static Stream<IEditorPart> getActiveEditors() {
return Arrays.stream(PlatformUI.getWorkbench().getWorkbenchWindows())
.filter(Objects::nonNull)
.flatMap(ww -> Arrays.stream(ww.getPages()))
.filter(Objects::nonNull)
.flatMap(page -> Arrays.stream(page.getEditorReferences()))
.filter(Objects::nonNull)
.map(ref -> ref.getEditor(false))
.filter(Objects::nonNull);
}
public static Stream<ISourceViewer> getActiveSourceViewers() {
return getActiveTextViewers()
.filter(viewer -> viewer instanceof ISourceViewer)

2
eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/preferences/LanguageServerConsolesPreferencesPage.java
View File

@@ -47,7 +47,7 @@ public class LanguageServerConsolesPreferencesPage extends FieldEditorPreference
SWTFactory.createLabel(parent, "Settings for Spring Languare Server extensions:", 2);
addField(new BooleanFieldEditor(PreferenceConstants.HIGHLIGHT_CODELENS_PREFS, "Highlights CodeLens", parent));
addField(new BooleanFieldEditor(PreferenceConstants.HIGHLIGHT_CODELENS_PREFS, "Highlights CodeLens (Experimental)", parent));
}
}

2
eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/preferences/PreferenceConstants.java
View File

@@ -14,4 +14,6 @@ public class PreferenceConstants {
public static final String HIGHLIGHT_CODELENS_PREFS = "highlight.codelens";
public static final String HIGHLIGHT_RANGE_COLOR_PREFS = "STS4BootMarkerIndicationColor";
}

5
eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/preferences/PrefsInitializer.java
View File

@@ -10,7 +10,8 @@
*******************************************************************************/
package org.springframework.tooling.ls.eclipse.commons.preferences;
import static org.springframework.tooling.ls.eclipse.commons.preferences.LanguageServerConsolePreferenceConstants.*;
import static org.springframework.tooling.ls.eclipse.commons.preferences.LanguageServerConsolePreferenceConstants.ALL_SERVERS;
import static org.springframework.tooling.ls.eclipse.commons.preferences.LanguageServerConsolePreferenceConstants.ENABLE_BY_DEFAULT;
import org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer;
import org.eclipse.jface.preference.IPreferenceStore;
@@ -23,6 +24,6 @@ public class PrefsInitializer extends AbstractPreferenceInitializer {
for (ServerInfo s : ALL_SERVERS) {
store.setDefault(s.preferenceKey, ENABLE_BY_DEFAULT);
}
store.setDefault(PreferenceConstants.HIGHLIGHT_CODELENS_PREFS, true);
store.setDefault(PreferenceConstants.HIGHLIGHT_CODELENS_PREFS, false);
}
}