add location information to stereotype nodes

Author: martinlippert

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/commands/ApplicationModulesStructureProvider.java

@@ -45,7 +45,7 @@ public Collection<StereotypeMethodElement> extractMethods(StereotypeClassElement
 
 	static class SimpleApplicationModulesStructureProvider extends ApplicationModulesStructureProvider implements SimpleStructureProvider<ApplicationModules, StereotypePackageElement, StereotypeClassElement, StereotypeMethodElement> {
 
-		SimpleApplicationModulesStructureProvider(IJavaProject project, SpringMetamodelIndex springIndex) {
+		SimpleApplicationModulesStructureProvider(IJavaProject project, CachedSpringMetamodelIndex springIndex) {
 			super(project, springIndex);
 		}
 

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/commands/JsonNodeHandler.java

@@ -16,6 +16,8 @@
 
 package org.springframework.ide.vscode.boot.java.commands;
 
+import java.net.URISyntaxException;
+import java.net.URL;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -27,6 +29,8 @@
 
 import org.eclipse.lsp4j.DocumentSymbol;
 import org.eclipse.lsp4j.Location;
+import org.eclipse.lsp4j.Position;
+import org.eclipse.lsp4j.Range;
 import org.jmolecules.stereotype.api.Stereotype;
 import org.jmolecules.stereotype.catalog.StereotypeCatalog;
 import org.jmolecules.stereotype.tooling.LabelProvider;
@@ -75,14 +79,38 @@ public JsonNodeHandler(LabelProvider<A, StereotypePackageElement, StereotypeClas
 	@Override
 	public void handleStereotype(Stereotype stereotype, NodeContext context) {
 
-		// var definition = catalog.getDefinition(stereotype);
-		// var sources = definition.getSources();
-
-		addChild(node -> node
-			.withAttribute(TEXT, labels.getStereotypeLabel(stereotype))
-			.withAttribute(ICON, StereotypeIcons.getIcon(stereotype))
-			.withAttribute(HOVER, "<stereotype catalog source coming soon...>")
-		);
+		if (stereotype.getIdentifier().equals("org.jmolecules.misc.Other")) {
+			addChild(node -> node
+					.withAttribute(TEXT, labels.getStereotypeLabel(stereotype))
+					.withAttribute(ICON, StereotypeIcons.getIcon(stereotype))
+				);
+		} else {
+			var definition = catalog.getDefinition(stereotype);
+			var sources = definition.getSources();
+			
+			Location location = null;
+			for (Object source : sources) {
+				if (source instanceof URL) {
+					try {
+						String uri = ((URL)source).toURI().toString();
+						location = new Location(uri, new Range(new Position(0, 0), new Position(0, 0)));
+					} catch (URISyntaxException e) {
+						// ignore
+					}
+				}
+				else if (source instanceof Location) {
+					location = ((Location) source);
+				}
+			}
+			
+			final Location finalLocation = location;
+			addChild(node -> node
+				.withAttribute(TEXT, labels.getStereotypeLabel(stereotype))
+				.withAttribute(ICON, StereotypeIcons.getIcon(stereotype))
+				.withAttribute(HOVER, "defined in: " + sources.toString())
+				.withAttribute(LOCATION, finalLocation)
+			);
+		}
 	}
 
 	@Override

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/stereotypes/IndexBasedStereotypeFactory.java

@@ -136,8 +136,9 @@ private void registerStereotype(StereotypeDefinitionElement element) {
 		var stereotype = element.createStereotype();
 		var type = element.getType();
 		var assignment = element.getAssignment();
-
-		catalog.getOrRegister(stereotype, Assignment.of(type, assignment), type).getStereotype();
+		var location = element.getLocation();
+		
+		catalog.getOrRegister(stereotype, Assignment.of(type, assignment), location).getStereotype();
 	}
 
 }

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/stereotypes/StereotypeDefinitionElement.java

@@ -10,6 +10,7 @@
  *******************************************************************************/
 package org.springframework.ide.vscode.boot.java.stereotypes;
 
+import org.eclipse.lsp4j.Location;
 import org.jmolecules.stereotype.api.Stereotype;
 import org.jmolecules.stereotype.catalog.StereotypeDefinition.Assignment.Type;
 import org.jmolecules.stereotype.support.StringBasedStereotype;
@@ -23,12 +24,16 @@ public class StereotypeDefinitionElement extends AbstractSpringIndexElement {
 	private final String[] groups;
 	private final Type assignment;
 
-	public StereotypeDefinitionElement(String type, int priority, String displayName, String[] groups, Type assignment) {
+	private final Location location;
+	
+	public StereotypeDefinitionElement(String type, int priority, String displayName, String[] groups, Type assignment,
+			Location location) {
 		this.type = type;
 		this.priority = priority;
 		this.displayName = displayName;
 		this.groups = groups;
 		this.assignment = assignment;
+		this.location = location;
 	}
 
 	public String getType() {
@@ -39,6 +44,10 @@ public Type getAssignment() {
 		return this.assignment;
 	}
 
+	public Location getLocation() {
+		return location;
+	}
+	
 	public Stereotype createStereotype() {
 		var stereotype = StringBasedStereotype.of(type, priority);
 
@@ -54,5 +63,5 @@ public Stereotype createStereotype() {
 
 		return stereotype;
 	}
-
+	
 }

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/stereotypes/StereotypesIndexer.java

@@ -62,18 +62,30 @@ public class StereotypesIndexer implements SymbolProvider {
 	public void addSymbols(Annotation node, ITypeBinding typeBinding, Collection<ITypeBinding> metaAnnotations, SpringIndexerJavaContext context, TextDocument doc) {
 		ASTNode parent = node.getParent();
 
-		if (parent instanceof AnnotationTypeDeclaration) {
-			AnnotationTypeDeclaration annotationType = (AnnotationTypeDeclaration) parent;
-			ITypeBinding annotationBinding = annotationType.resolveBinding();
-			
-			StereotypeDefinitionElement stereotypeDefinitionElement = createDefinitionElement(annotationBinding.getQualifiedName(), Type.IS_ANNOTATED, node, doc);
-			context.getBeans().add(new CachedBean(context.getDocURI(), stereotypeDefinitionElement));
+		try {
+			if (parent instanceof AnnotationTypeDeclaration) {
+				AnnotationTypeDeclaration annotationType = (AnnotationTypeDeclaration) parent;
+				ITypeBinding annotationBinding = annotationType.resolveBinding();
+				
+				StereotypeDefinitionElement stereotypeDefinitionElement = createDefinitionElement((AbstractTypeDeclaration) parent,
+						annotationBinding.getQualifiedName(), Type.IS_ANNOTATED, node, doc);
+	
+				context.getBeans().add(new CachedBean(context.getDocURI(), stereotypeDefinitionElement));
+			}
+			else if (parent instanceof TypeDeclaration && ((TypeDeclaration) parent).isInterface()) {
+				ITypeBinding interfaceType = ((TypeDeclaration) parent).resolveBinding();
+	
+				StereotypeDefinitionElement stereotypeDefinitionElement = createDefinitionElement((AbstractTypeDeclaration) parent,
+						interfaceType.getQualifiedName(), Type.IMPLEMENTS, node, doc);
+	
+				context.getBeans().add(new CachedBean(context.getDocURI(), stereotypeDefinitionElement));
+			}
 		}
-		else if (parent instanceof TypeDeclaration && ((TypeDeclaration) parent).isInterface()) {
-			ITypeBinding interfaceType = ((TypeDeclaration) parent).resolveBinding();
-
-			StereotypeDefinitionElement stereotypeDefinitionElement = createDefinitionElement(interfaceType.getQualifiedName(), Type.IMPLEMENTS, node, doc);
-			context.getBeans().add(new CachedBean(context.getDocURI(), stereotypeDefinitionElement));
+		catch (BadLocationException e) {
+			log.error("error identifying location of type declaration for: " + parent.toString(), e);
+		}
+		catch (NullPointerException e) {
+			log.error("error creating stereotype definition element for: " + parent.toString(), e);
 		}
 	}
 
@@ -226,7 +238,9 @@ private Collection<IAnnotationBinding> getMetaAnnotations(AnnotationHierarchies
 		return result;
 	}
 
-	private StereotypeDefinitionElement createDefinitionElement(String id, StereotypeDefinition.Assignment.Type assignment, Annotation additionalDetails, TextDocument doc) {
+	private StereotypeDefinitionElement createDefinitionElement(AbstractTypeDeclaration parent, String id, StereotypeDefinition.Assignment.Type assignment,
+			Annotation additionalDetails, TextDocument doc) throws BadLocationException, NullPointerException {
+
 		int priority = Stereotype.DEFAULT_PRIORITY;
 		Optional<Expression> attribute = ASTUtils.getAttribute(additionalDetails, "priority");
 		if (attribute.isPresent()) {
@@ -245,8 +259,11 @@ private StereotypeDefinitionElement createDefinitionElement(String id, Stereotyp
 		if (groupsAttribute.isPresent()) {
 			groups = ASTUtils.getExpressionValueAsArray(groupsAttribute.get(), (a) -> {});
 		}
+		
+		SimpleName typeName = parent.getName();
+		Location location = new Location(doc.getUri(), doc.toRange(typeName.getStartPosition(), typeName.getLength()));
 
-		return new StereotypeDefinitionElement(id, priority, displayName, groups, assignment);
+		return new StereotypeDefinitionElement(id, priority, displayName, groups, assignment, location);
 	}
 
 }