LSP/Textmate: Implement multiview support for generic/textmate based …

…syntax support Closes: #5204
apache · Dec 20, 2024 · b3a786d · b3a786d
1 parent cd519cd
commit b3a786d
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 9 deletions.
diff --git a/ide/lsp.client/nbproject/project.xml b/ide/lsp.client/nbproject/project.xml
@@ -76,6 +76,15 @@
                         <specification-version>1.50</specification-version>
                     </run-dependency>
                 </dependency>
+                <dependency>
+                    <code-name-base>org.netbeans.core.multiview</code-name-base>
+                    <build-prerequisite/>
+                    <compile-dependency/>
+                    <run-dependency>
+                        <release-version>1</release-version>
+                        <specification-version>1.71</specification-version>
+                    </run-dependency>
+                </dependency>
                 <dependency>
                     <code-name-base>org.netbeans.libs.flexmark</code-name-base>
                     <build-prerequisite/>

diff --git a/ide/lsp.client/src/org/netbeans/modules/lsp/client/options/GenericDataObject.java b/ide/lsp.client/src/org/netbeans/modules/lsp/client/options/GenericDataObject.java
@@ -20,17 +20,15 @@
 
 import java.awt.Image;
 import java.beans.PropertyVetoException;
-import java.io.FileNotFoundException;
 import java.io.IOException;
-import java.io.InputStream;
 import java.lang.ref.Reference;
 import java.lang.ref.WeakReference;
 import java.lang.reflect.Method;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
-import javax.imageio.ImageIO;
+import org.netbeans.core.spi.multiview.text.MultiViewEditorElement;
 import org.openide.filesystems.FileObject;
 import org.openide.filesystems.FileUtil;
 import org.openide.loaders.DataLoaderPool;
@@ -41,7 +39,7 @@
 import org.openide.nodes.Children;
 import org.openide.nodes.Node;
 import org.openide.util.Exceptions;
-import org.openide.util.ImageUtilities;
+import org.openide.util.Lookup;
 
 /**
  *
@@ -57,7 +55,7 @@ public class GenericDataObject extends MultiDataObject {
     public GenericDataObject(FileObject pf, MultiFileLoader loader) throws DataObjectExistsException, IOException {
         super(pf, loader);
         this.mimeType = FileUtil.getMIMEType(pf);
-        registerEditor(mimeType, false);
+        registerEditor(mimeType, true);
         synchronized (REGISTRY) {
             REGISTRY.add(new WeakReference<>(this));
         }
@@ -144,5 +142,8 @@ public static Factory factory() {
             }
         };
     }
-}
 
+    public static MultiViewEditorElement createEditor(Lookup lkp) {
+        return new MultiViewEditorElement(lkp);
+    }
+}
diff --git a/ide/lsp.client/src/org/netbeans/modules/lsp/client/options/LanguageStorage.java b/ide/lsp.client/src/org/netbeans/modules/lsp/client/options/LanguageStorage.java
@@ -35,13 +35,15 @@
 import javax.swing.event.ChangeEvent;
 import org.eclipse.tm4e.core.internal.grammar.raw.RawGrammarReader;
 import org.eclipse.tm4e.core.registry.IGrammarSource;
+import org.netbeans.core.spi.multiview.MultiViewFactory;
 import org.netbeans.modules.textmate.lexer.TextmateTokenId;
 import org.netbeans.spi.navigator.NavigatorPanel;
 import org.openide.filesystems.FileObject;
 import org.openide.filesystems.FileUtil;
 import org.openide.loaders.DataLoaderPool;
 import org.openide.loaders.DataObject;
 import org.openide.util.Exceptions;
+import org.openide.util.NbBundle.Messages;
 import org.openide.util.NbPreferences;
 
 /**
@@ -57,6 +59,7 @@ static List<LanguageDescription> load() {
         return Arrays.stream(new Gson().fromJson(descriptions, LanguageDescription[].class)).collect(Collectors.toList());
     }
 
+    @Messages("Source=&Source")
     static void store(List<LanguageDescription> languages) {
         Set<String> originalMimeTypes = load().stream().map(ld -> ld.mimeType).collect(Collectors.toSet());
         Set<String> mimeTypesToClear = new HashSet<>(originalMimeTypes);
@@ -71,7 +74,7 @@ static void store(List<LanguageDescription> languages) {
                     Exceptions.printStackTrace(ex);
                 }
             }
-            
+
             for (FileObject children : mimeResolver.getChildren()) {
                 if ("synthetic".equals(children.getAttribute(LanguageServersPanel.class.getName()))) {
                     try {
@@ -130,6 +133,22 @@ static void store(List<LanguageDescription> languages) {
                     loader.setAttribute("dataObjectClass", GenericDataObject.class.getName());
                     loader.setAttribute("mimeType", description.mimeType);
 
+                    FileObject multiViewRegistration = FileUtil.getConfigFile("Editors/" + description.mimeType + "/MultiView/source.instance");
+                    if (multiViewRegistration != null) {
+                        multiViewRegistration.delete();
+                    }
+                    multiViewRegistration = FileUtil.createData(FileUtil.getConfigRoot(), "Editors/" + description.mimeType + "/MultiView/source.instance");
+                    Method createMultiViewDescription = MultiViewFactory.class.getDeclaredMethod("createMultiViewDescription", Map.class);
+                    multiViewRegistration.setAttribute("methodvalue:instanceCreate", createMultiViewDescription);
+                    multiViewRegistration.setAttribute("instanceClass", "org.netbeans.core.multiview.ContextAwareDescription");
+                    multiViewRegistration.setAttribute("class", GenericDataObject.class.getName());
+                    multiViewRegistration.setAttribute("mimeType", description.mimeType);
+                    multiViewRegistration.setAttribute("displayName", Bundle.Source());
+                    multiViewRegistration.setAttribute("preferredID", "lsp.source");
+                    multiViewRegistration.setAttribute("persistenceType", 1);
+                    multiViewRegistration.setAttribute("position", 100);
+                    multiViewRegistration.setAttribute("method", "createEditor");
+
                     FileObject icon = FileUtil.getConfigFile("Loaders/" + description.mimeType + "/Factories/icon.png");
                     if (icon != null) {
                         icon.delete();
@@ -143,16 +162,17 @@ static void store(List<LanguageDescription> languages) {
                         }
 
                         loader.setAttribute("iconBase", icon.getNameExt());
+                        multiViewRegistration.setAttribute("iconBase", icon.getNameExt());
                     }
-                    
+
                     if (description.languageServer != null && !description.languageServer.isEmpty()) {
                         FileObject langServer = FileUtil.createData(FileUtil.getConfigRoot(), "Editors/" + description.mimeType + "/org-netbeans-modules-lsp-client-options-GenericLanguageServer.instance");
                         langServer.setAttribute("command", description.languageServer.split(" "));
                         if (description.name != null) {
                             langServer.setAttribute("name", description.name);
                         }
                     }
-                    
+
                     mimeTypesToClear.remove(description.mimeType);
                 } catch (Exception ex) {
                     Exceptions.printStackTrace(ex);