Extension point docs and minor adjustments

eclipse-jdt · Oct 18, 2024 · a0c21c6 · a0c21c6
1 parent 9332408
commit a0c21c6
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 20 deletions.
diff --git a/org.eclipse.jdt.ui/plugin.properties b/org.eclipse.jdt.ui/plugin.properties
@@ -39,6 +39,8 @@ javadocExportWizardPageExtensionPoint=Javadoc Export Wizard Page
 
 cleanUpExtensionPoint=Clean Ups
 
+semanticTokensExtensionPoint=Semantic Tokens
+
 queryParticipantsExtensionPoint=Java Query Participants
 
 defaultClasspathContainerPage=Default Classpath Container

diff --git a/org.eclipse.jdt.ui/plugin.xml b/org.eclipse.jdt.ui/plugin.xml
@@ -34,7 +34,7 @@
    <extension-point id="classpathAttributeConfiguration" name="%classpathAttributeConfiguration" schema="schema/classpathAttributeConfiguration.exsd"/>
    <extension-point id="javadocExportWizardPage" name="%javadocExportWizardPageExtensionPoint" schema="schema/javadocExportWizardPage.exsd"/>
    <extension-point id="cleanUps" name="%cleanUpExtensionPoint" schema="schema/cleanUps.exsd"/>
-   <extension-point id="semanticTokens" name="%semanticTokens" schema="schema/semanticTokens.exsd"/>
+   <extension-point id="semanticTokens" name="%semanticTokensExtensionPoint" schema="schema/semanticTokens.exsd"/>
 
 <extension
 	point="org.eclipse.ui.decorators">

diff --git a/org.eclipse.jdt.ui/schema/semanticTokens.exsd b/org.eclipse.jdt.ui/schema/semanticTokens.exsd
@@ -6,7 +6,7 @@
          <meta.schema plugin="org.eclipse.jdt.ui" id="semanticTokens" name="%semanticTokens"/>
       </appInfo>
       <documentation>
-         [Enter description of this extension point.]
+         Allows contributions of semantic tokens into Java source editor. Contributions are not sorted. This extension point is experimental.
       </documentation>
    </annotation>
 
@@ -15,6 +15,9 @@
          <appInfo>
             <meta.element />
          </appInfo>
+         <documentation>
+            Allows contributions of semantic tokens into Java source editor. Contributions are not sorted. This extension point is experimental.
+         </documentation>
       </annotation>
       <complexType>
          <sequence>
@@ -23,21 +26,21 @@
          <attribute name="point" type="string" use="required">
             <annotation>
                <documentation>
-
+                  a fully qualified identifier of the target extension point
                </documentation>
             </annotation>
          </attribute>
          <attribute name="id" type="string">
             <annotation>
                <documentation>
-
+                  an optional identifier of the extension instance
                </documentation>
             </annotation>
          </attribute>
          <attribute name="name" type="string">
             <annotation>
                <documentation>
-
+                  an optional name of the extension instance
                </documentation>
                <appInfo>
                   <meta.attribute translatable="true"/>
@@ -48,11 +51,16 @@
    </element>
 
    <element name="provider">
+      <annotation>
+         <documentation>
+            Contributed provider of semantic tokens
+         </documentation>
+      </annotation>
       <complexType>
          <attribute name="class" type="string" use="required">
             <annotation>
                <documentation>
-
+                  Instance of the class able to compute Semantic Tokens for a given Java source AST
                </documentation>
                <appInfo>
                   <meta.attribute kind="java" basedOn=":org.eclipse.jdt.ui.text.java.SemanticTokensProvider"/>
@@ -67,7 +75,7 @@
          <meta.section type="since"/>
       </appInfo>
       <documentation>
-         [Enter the first release in which this extension point appears.]
+         3.34
       </documentation>
    </annotation>
 
@@ -98,5 +106,17 @@
       </documentation>
    </annotation>
 
+   <annotation>
+      <appInfo>
+         <meta.section type="copyright"/>
+      </appInfo>
+      <documentation>
+         Copyright (c) 2024 Broadcom Inc. and others.&lt;br&gt;
+
+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 &lt;a href=&quot;https://www.eclipse.org/legal/epl-2.0&quot;&gt;https://www.eclipse.org/legal/epl-v20.html&lt;/a&gt;/
+
+SPDX-License-Identifier: EPL-2.0
+      </documentation>
+   </annotation>
 
 </schema>
diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/JavaPlugin.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/JavaPlugin.java
@@ -111,7 +111,7 @@
 import org.eclipse.jdt.ui.JavaUI;
 import org.eclipse.jdt.ui.PreferenceConstants;
 import org.eclipse.jdt.ui.text.JavaTextTools;
-import org.eclipse.jdt.ui.text.java.SemanticTokensProvider;
+import org.eclipse.jdt.ui.text.java.ISemanticTokensProvider;
 
 import org.eclipse.jdt.internal.ui.javaeditor.ASTProvider;
 import org.eclipse.jdt.internal.ui.javaeditor.ClassFileDocumentProvider;
@@ -279,7 +279,7 @@ protected boolean removeEldestEntry(java.util.Map.Entry<String, Long> eldest) {
 	private BundleContext fBundleContext;
 
 	private ServiceRegistration<DebugOptionsListener> fDebugRegistration;
-	private SemanticTokensProvider[] fSemanticTokensProviders;
+	private ISemanticTokensProvider[] fSemanticTokensProviders;
 
 	public static JavaPlugin getDefault() {
 		return fgJavaPlugin;
@@ -748,19 +748,19 @@ public IConfigurationElement getConfigurationElement(Object object) {
 		}
 	}
 
-	public SemanticTokensProvider[] getContributedSemanticTokensProviders() {
+	public ISemanticTokensProvider[] getContributedSemanticTokensProviders() {
 		if (fSemanticTokensProviders == null) {
 			synchronized(this) {
 				IExtensionRegistry registry= Platform.getExtensionRegistry();
 				IConfigurationElement[] elements= registry.getConfigurationElementsFor(JAVA_EDITOR_SEMANTIC_TOKENS_EXTENSION_POINT);
 				fSemanticTokensProviders = Arrays.stream(elements).map(ce -> {
 					try {
-						return (SemanticTokensProvider) ce.createExecutableExtension("class"); //$NON-NLS-1$
+						return (ISemanticTokensProvider) ce.createExecutableExtension("class"); //$NON-NLS-1$
 					} catch (Exception e) {
 						getLog().error("Cannot instatiate semantic tokens provider", e); //$NON-NLS-1$
 						return null;
 					}
-				}).filter(Objects::nonNull).toArray(SemanticTokensProvider[]::new);
+				}).filter(Objects::nonNull).toArray(ISemanticTokensProvider[]::new);
 			}
 		}
 		return fSemanticTokensProviders;

diff --git a/...ipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/SemanticHighlightingReconciler.java b/...ipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/SemanticHighlightingReconciler.java
@@ -54,7 +54,7 @@
 import org.eclipse.jdt.core.manipulation.SharedASTProviderCore;
 
 import org.eclipse.jdt.ui.PreferenceConstants;
-import org.eclipse.jdt.ui.text.java.SemanticTokensProvider;
+import org.eclipse.jdt.ui.text.java.ISemanticTokensProvider;
 
 import org.eclipse.jdt.internal.ui.JavaPlugin;
 import org.eclipse.jdt.internal.ui.javaeditor.SemanticHighlightingManager.HighlightedPosition;
@@ -394,9 +394,9 @@ public void aboutToBeReconciled() {
 		// Do nothing
 	}
 
-	private List<SemanticTokensProvider.SemanticToken> getContributedSemanticTokens(CompilationUnit ast) {
-		List<SemanticTokensProvider.SemanticToken> contributedTokens = new ArrayList<>();
-		for (SemanticTokensProvider provider : JavaPlugin.getDefault().getContributedSemanticTokensProviders()) {
+	private List<ISemanticTokensProvider.SemanticToken> getContributedSemanticTokens(CompilationUnit ast) {
+		List<ISemanticTokensProvider.SemanticToken> contributedTokens = new ArrayList<>();
+		for (ISemanticTokensProvider provider : JavaPlugin.getDefault().getContributedSemanticTokensProviders()) {
 			contributedTokens.addAll(provider.computeSemanticTokens(ast));
 		}
 		return contributedTokens;
@@ -491,13 +491,13 @@ private void startReconcilingPositions() {
 	 * @param subtrees the AST subtrees
 	 * @param contributedTokens contributed semantic tokens data
 	 */
-	private void reconcilePositions(ASTNode[] subtrees, List<SemanticTokensProvider.SemanticToken> contributedTokens) {
+	private void reconcilePositions(ASTNode[] subtrees, List<ISemanticTokensProvider.SemanticToken> contributedTokens) {
 		// FIXME: remove positions not covered by subtrees
 
 		for (ASTNode subtree : subtrees)
 			subtree.accept(fCollector);
 
-		for (SemanticTokensProvider.SemanticToken t : contributedTokens) {
+		for (ISemanticTokensProvider.SemanticToken t : contributedTokens) {
 			Highlighting h = fromSemanticTokenType(t.tokenType());
 			if (h == null) {
 				JavaPlugin.logErrorMessage("Cannot find semantic highlighting for %s".formatted(t)); //$NON-NLS-1$
@@ -514,7 +514,7 @@ private void reconcilePositions(ASTNode[] subtrees, List<SemanticTokensProvider.
 		fRemovedPositions= newPositions;
 	}
 
-	private Highlighting fromSemanticTokenType(SemanticTokensProvider.TokenType type) {
+	private Highlighting fromSemanticTokenType(ISemanticTokensProvider.TokenType type) {
 		if (type != null) {
 			switch (type) {
 				case OPERATOR:

diff --git a/.../ui/text/java/SemanticTokensProvider.java → ...ui/text/java/ISemanticTokensProvider.java b/.../ui/text/java/SemanticTokensProvider.java → ...ui/text/java/ISemanticTokensProvider.java
@@ -15,7 +15,7 @@
 
 import org.eclipse.jdt.core.dom.CompilationUnit;
 
-public interface SemanticTokensProvider {
+public interface ISemanticTokensProvider {
 
 	record SemanticToken(int ofset, int length, TokenType tokenType) {}