Integrate rust-analyzer

- add support for rust LSP implementation rust-analyzer
- align rust icons more with existing NB icons
- show hint if rust analyser is not configured

Author: matthiasblaesing

ide/lsp.client/licenseinfo.xml

@@ -21,6 +21,33 @@
 -->
 <licenseinfo>
     <fileset>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/attribute.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/class.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/color.gif</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/constant.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/constructor.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/empty.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/enummember.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/enum.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/event.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/field.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/file.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/folder.gif</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/function.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/interface.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/keyword.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/method.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/module.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/operator.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/property.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/reference.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/snippet.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/struct.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/text.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/typeparameter.gif</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/unit.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/value.png</file>
+        <file>src/org/netbeans/modules/lsp/client/bindings/icons/variable.gif</file>
         <file>src/org/netbeans/modules/lsp/client/resources/error_16.png</file>
         <file>src/org/netbeans/modules/lsp/client/resources/warning_16.png</file>
         <license ref="Apache-2.0-ASF" />

rust/rust.grammar/licenseinfo.xml

@@ -20,23 +20,14 @@
 
 -->
 <licenseinfo>
-    <!-- These are generated files by the antlr compiler.
     <fileset>
-        <file>src/org/netbeans/modules/rust/grammar/antlr4/RustLexer.interp</file>
-        <file>src/org/netbeans/modules/rust/grammar/antlr4/RustParser.interp</file>
-        <file>src/org/netbeans/modules/rust/grammar/antlr4/RustParser.tokens</file>
-        <file>src/org/netbeans/modules/rust/grammar/antlr4/RustLexer.tokens</file>
-        <license ref="Apache-2.0-ASF" />
-        <comment type="COMMENT_UNSUPPORTED" />
-    </fileset>
-    -->
-    <fileset>
-        <file>src/org/netbeans/modules/rust/grammar/structure/resources/structure-macro.png</file>
-        <file>src/org/netbeans/modules/rust/grammar/structure/resources/structure-enum.png</file>
-        <file>src/org/netbeans/modules/rust/grammar/structure/resources/structure-struct.png</file>
-        <file>src/org/netbeans/modules/rust/grammar/structure/resources/structure-impl.png</file>
-        <file>src/org/netbeans/modules/rust/grammar/structure/resources/structure-function.png</file>
-        <file>src/org/netbeans/modules/rust/grammar/structure/resources/structure-module.png</file>
+        <file>src/org/netbeans/modules/rust/grammar/structure/resources/enum.png</file>
+        <file>src/org/netbeans/modules/rust/grammar/structure/resources/function.png</file>
+        <file>src/org/netbeans/modules/rust/grammar/structure/resources/interface.png</file>
+        <file>src/org/netbeans/modules/rust/grammar/structure/resources/module.png</file>
+        <file>src/org/netbeans/modules/rust/grammar/structure/resources/snippet.png</file>
+        <file>src/org/netbeans/modules/rust/grammar/structure/resources/struct.png</file>
+        <file>src/org/netbeans/modules/rust/grammar/structure/resources/trait.png</file>
         <license ref="Apache-2.0-ASF" />
         <comment type="COMMENT_UNSUPPORTED" />
     </fileset>

rust/rust.grammar/nbproject/project.properties

@@ -15,6 +15,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-javac.source=1.8
+javac.release=21
 javac.compilerargs=-Xlint -Xlint:-serial
 build.generated.sources.dir=${build.dir}/generated-sources

rust/rust.grammar/nbproject/project.xml

@@ -61,6 +61,15 @@
                         <specification-version>1.20</specification-version>
                     </run-dependency>
                 </dependency>
+                <dependency>
+                    <code-name-base>org.netbeans.modules.editor</code-name-base>
+                    <build-prerequisite/>
+                    <compile-dependency/>
+                    <run-dependency>
+                        <release-version>3</release-version>
+                        <specification-version>1.119</specification-version>
+                    </run-dependency>
+                </dependency>
                 <dependency>
                     <code-name-base>org.netbeans.modules.editor.fold</code-name-base>
                     <build-prerequisite/>
@@ -70,6 +79,15 @@
                         <specification-version>1.65</specification-version>
                     </run-dependency>
                 </dependency>
+                <dependency>
+                    <code-name-base>org.netbeans.modules.editor.lib2</code-name-base>
+                    <build-prerequisite/>
+                    <compile-dependency/>
+                    <run-dependency>
+                        <release-version>1</release-version>
+                        <specification-version>2.52</specification-version>
+                    </run-dependency>
+                </dependency>
                 <dependency>
                     <code-name-base>org.netbeans.modules.editor.mimelookup</code-name-base>
                     <build-prerequisite/>
@@ -96,6 +114,24 @@
                         <specification-version>1.1</specification-version>
                     </run-dependency>
                 </dependency>
+                <dependency>
+                    <code-name-base>org.netbeans.modules.lsp.client</code-name-base>
+                    <build-prerequisite/>
+                    <compile-dependency/>
+                    <run-dependency>
+                        <release-version>0</release-version>
+                        <specification-version>1.24</specification-version>
+                    </run-dependency>
+                </dependency>
+                <dependency>
+                    <code-name-base>org.netbeans.modules.options.api</code-name-base>
+                    <build-prerequisite/>
+                    <compile-dependency/>
+                    <run-dependency>
+                        <release-version>1</release-version>
+                        <specification-version>1.77</specification-version>
+                    </run-dependency>
+                </dependency>
                 <dependency>
                     <code-name-base>org.netbeans.modules.parsing.api</code-name-base>
                     <build-prerequisite/>
@@ -105,6 +141,23 @@
                         <specification-version>9.27</specification-version>
                     </run-dependency>
                 </dependency>
+                <dependency>
+                    <code-name-base>org.netbeans.modules.rust.options</code-name-base>
+                    <build-prerequisite/>
+                    <compile-dependency/>
+                    <run-dependency>
+                        <specification-version>1.11</specification-version>
+                    </run-dependency>
+                </dependency>
+                <dependency>
+                    <code-name-base>org.netbeans.spi.editor.hints</code-name-base>
+                    <build-prerequisite/>
+                    <compile-dependency/>
+                    <run-dependency>
+                        <release-version>0</release-version>
+                        <specification-version>1.74</specification-version>
+                    </run-dependency>
+                </dependency>
                 <dependency>
                     <code-name-base>org.openide.filesystems</code-name-base>
                     <build-prerequisite/>
@@ -113,6 +166,14 @@
                         <specification-version>9.33</specification-version>
                     </run-dependency>
                 </dependency>
+                <dependency>
+                    <code-name-base>org.openide.modules</code-name-base>
+                    <build-prerequisite/>
+                    <compile-dependency/>
+                    <run-dependency>
+                        <specification-version>7.79</specification-version>
+                    </run-dependency>
+                </dependency>
                 <dependency>
                     <code-name-base>org.openide.util</code-name-base>
                     <build-prerequisite/>

rust/rust.grammar/src/org/netbeans/modules/rust/grammar/LayerProviderImpl.java

@@ -0,0 +1,67 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.netbeans.modules.rust.grammar;
+
+import java.net.URL;
+import java.util.Collection;
+import java.util.logging.Logger;
+import org.netbeans.modules.rust.options.api.RustAnalyzerOptions;
+import org.openide.filesystems.Repository.LayerProvider;
+import org.openide.util.lookup.ServiceProvider;
+
+/**
+ * The rust.grammer module can provide services directly or using rust-analyzer
+ * (the rust lsp). If the user configured rust-analyzer, that should get
+ * priority as it also can provide code completion and improved structure
+ * scanning.
+ *
+ * For this to work, the normal NetBeans behavior to generate layer entries from
+ * annotations (MimeRegistration of LSP, LanguageRegistration) has to be
+ * customized as the two options can't coexist completely.
+ *
+ * Therefore the layer entries from org.netbeans.modules.rust.grammar.RustLanguageConfig
+ * and org.netbeans.modules.rust.grammar.lsp.RustLSP are removed from the
+ * generated-layer.xml (build/classes/META-INF/generated-layer.xml), the
+ * annotations are commented out and the entries from the generated layer are
+ * checked whether they were created by one of the mentioned classes (see XML
+ * comments for reference) and are distributed into:
+ *
+ * - layer.xml holds everything that applies to both LSP and non-LSP mode
+ * - lsp-layer.xml holds everything specific to the LSP
+ * - non-lsp-layer.xml hold everything specific to the non-LSP run
+ *
+ * `layer.xml` is loaded by the module system unconditionally. The two variants
+ * `lsp-layer.xml` and `non-lsp-layer.xml` are loaded using this class.
+ */
+@ServiceProvider(service = LayerProvider.class)
+public class LayerProviderImpl extends LayerProvider {
+
+    private static final Logger LOG = Logger.getLogger(LayerProviderImpl.class.getName());
+
+    @Override
+    protected void registerLayers(Collection<? super URL> context) {
+        URL layerUrl;
+        if (RustAnalyzerOptions.getRustAnalyzerLocation(false, false) != null) {
+            layerUrl = LayerProviderImpl.class.getResource("lsp-layer.xml");
+        } else {
+            layerUrl = LayerProviderImpl.class.getResource("non-lsp-layer.xml");
+        }
+        context.add(layerUrl);
+    }
+}

rust/rust.grammar/src/org/netbeans/modules/rust/grammar/RustLanguageConfig.java

@@ -23,13 +23,13 @@
 import org.netbeans.modules.csl.api.DeclarationFinder;
 import org.netbeans.modules.csl.api.StructureScanner;
 import org.netbeans.modules.csl.spi.DefaultLanguageConfig;
-import org.netbeans.modules.csl.spi.LanguageRegistration;
 import org.netbeans.modules.parsing.spi.Parser;
+import org.netbeans.modules.rust.options.api.RustAnalyzerOptions;
 
-/**
- *
- */
-@LanguageRegistration(mimeType = "text/x-rust", useMultiview = true)
+// See LayerProviderImpl for information about layer handling and when this
+// needs to be uncommented
+//
+//@LanguageRegistration(mimeType = "text/x-rust", useMultiview = true)
 public class RustLanguageConfig extends DefaultLanguageConfig {
 
     private static final Language<RustTokenID> RUST_LANGUAGE = new RustLanguage().language();
@@ -46,12 +46,12 @@ public String getDisplayName() {
 
     @Override
     public StructureScanner getStructureScanner() {
-        return new RustStructureScanner();
+        return RustAnalyzerOptions.getRustAnalyzerLocation(false, false) == null ? new RustStructureScanner() : null;
     }
 
     @Override
     public boolean hasStructureScanner() {
-        return true;
+        return RustAnalyzerOptions.getRustAnalyzerLocation(false, false) == null;
     }
 
     @Override
@@ -66,7 +66,7 @@ public String getLineCommentPrefix() {
 
     @Override
     public DeclarationFinder getDeclarationFinder() {
-        return new RustDeclarationFinder();
+        return RustAnalyzerOptions.getRustAnalyzerLocation(false, false) == null ? new RustDeclarationFinder() : null;
     }
 
 }