Enso Integration with Ideal Graph Visualizer

.github/workflows/enso4igv.yml

@@ -0,0 +1,34 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+
+name: Enso Language Support for IGV
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        java: [ '8' ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Java
+      uses: actions/setup-java@v2
+      with:
+        distribution: 'zulu'
+        java-version: ${{ matrix.java }}        
+        cache: maven
+    - name: Build with Maven
+      run: mvn -B package --file tools/enso4igv/pom.xml
+    - name: Archive NBM file
+      uses: actions/upload-artifact@v3
+      with:
+        name: Enso IGV Plugin
+        path: tools/enso4igv/target/*.nbm

tools/enso4igv/README.md

@@ -0,0 +1,33 @@
+# Enso Language Support for NetBeans & Ideal Graph Visualizer
+
+[![Enso Language Support for IGV](https://github.com/enso-org/enso/actions/workflows/enso4igv.yml/badge.svg)](https://github.com/enso-org/enso/actions/workflows/enso4igv.yml)
+
+[Enso language](http://enso.org) runtime engine is built on top of
+[GraalVM](http://graalvm.org) and its _Truffle framework_. Enso,
+as a good citizen of the GraalVM ecosystem, benefits from polyglot
+capabilities of GraalVM as well as its rich tooling offering. One
+of such tools is _IGV_ - the _Ideal Graph Visualizer_ - an excellent
+tool to get insights into behavior of Graal compiler.
+
+This document shows how to use _IGV_ with the _Enso language_.
+
+## Installation
+
+Visit [GraalVM.org](http://graalvm.org) download page and continue 
+towards _enterprise edition_ option. There is an _Ideal Graph Visualizer_
+option. After clicking thru the confirmation dialogs you should get a ZIP -
+I've just got `idealgraphvisualizer-22.1.0.zip` and then:
+
+```bash
+$ unzip idealgraphvisualizer-22.1.0.zip
+$ ./idealgraphvisualizer/bin/idealgraphvisualizer --userdir /tmp/emptyuserdir
+```
+
+launches the _IGV_ application. One doesn't have to use the `--userdir` option,
+but doing so ensures the newly running _IGV_ process is isolated from any settings
+left around by previous usage of _IGV_.
+
+Now download [Enso Language Support module](https://github.com/enso-org/enso/actions/workflows/enso4igv.yml)
+ZIP file. Unzip it and get `enso*.nbm` file. This file can be installed into
+_IGV_ (or any other [NetBeans](http://netbeans.apache.org) based application).
+Go to _Tools_/_Plugins_/_Downloaded_ and install the NBM file.

tools/enso4igv/pom.xml

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>org.enso.tools</groupId>
+    <artifactId>enso4igv</artifactId>
+    <packaging>nbm</packaging>
+    <name>Enso Language Support for NetBeans &amp; Ideal Graph Visualizer</name>
+    <version>1.0-SNAPSHOT</version>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.netbeans.utilities</groupId>
+                <artifactId>nbm-maven-plugin</artifactId>
+                <extensions>true</extensions>
+                <version>4.7</version>
+                <configuration>
+                    <useOSGiDependencies>true</useOSGiDependencies>
+                    <author>Enso.org</author>
+                    <licenseName>Apache 2.0</licenseName>
+                    <licenseFile>../../LICENSE</licenseFile>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>3.2.2</version>
+                <configuration>
+                    <archive>
+                        <manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile>
+                    </archive>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+    <dependencies>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-netbeans-api-annotations-common</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-netbeans-modules-textmate-lexer</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-netbeans-api-templates</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-openide-filesystems</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-openide-loaders</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-openide-nodes</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-openide-util</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-openide-util-lookup</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-openide-util-ui</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-openide-windows</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-openide-text</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-netbeans-core-multiview</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-openide-awt</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-openide-dialogs</artifactId>
+            <version>${netbeans.version}</version>
+        </dependency>
+    </dependencies>
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <netbeans.version>RELEASE113</netbeans.version>
+    </properties>
+</project>

tools/enso4igv/src/main/java/org/enso/tools/enso4igv/EnsoDataObject.java

@@ -0,0 +1,112 @@
+package org.enso.tools.enso4igv;
+
+import java.io.IOException;
+import org.netbeans.core.spi.multiview.MultiViewElement;
+import org.netbeans.core.spi.multiview.text.MultiViewEditorElement;
+import org.netbeans.modules.textmate.lexer.api.GrammarRegistration;
+import org.openide.awt.ActionID;
+import org.openide.awt.ActionReference;
+import org.openide.awt.ActionReferences;
+import org.openide.filesystems.FileObject;
+import org.openide.filesystems.MIMEResolver;
+import org.openide.loaders.DataObject;
+import org.openide.loaders.DataObjectExistsException;
+import org.openide.loaders.MultiDataObject;
+import org.openide.loaders.MultiFileLoader;
+import org.openide.util.Lookup;
+import org.openide.util.NbBundle.Messages;
+import org.openide.windows.TopComponent;
+
+@Messages({
+    "LBL_Enso_LOADER=Files of Enso"
+})
+@MIMEResolver.ExtensionRegistration(
+        displayName = "#LBL_Enso_LOADER",
+        mimeType = "application/x-enso",
+        extension = {"enso"}
+)
+@GrammarRegistration(mimeType = "application/x-enso", grammar = "enso.tmLanguage.json")
+@DataObject.Registration(
+        mimeType = "application/x-enso",
+        iconBase = "org/enso/tools/enso4igv/enso.png",
+        displayName = "#LBL_Enso_LOADER",
+        position = 300
+)
+@ActionReferences({
+    @ActionReference(
+            path = "Loaders/application/x-enso/Actions",
+            id = @ActionID(category = "System", id = "org.openide.actions.OpenAction"),
+            position = 100,
+            separatorAfter = 200
+    ),
+    @ActionReference(
+            path = "Loaders/application/x-enso/Actions",
+            id = @ActionID(category = "Edit", id = "org.openide.actions.CutAction"),
+            position = 300
+    ),
+    @ActionReference(
+            path = "Loaders/application/x-enso/Actions",
+            id = @ActionID(category = "Edit", id = "org.openide.actions.CopyAction"),
+            position = 400,
+            separatorAfter = 500
+    ),
+    @ActionReference(
+            path = "Loaders/application/x-enso/Actions",
+            id = @ActionID(category = "Edit", id = "org.openide.actions.DeleteAction"),
+            position = 600
+    ),
+    @ActionReference(
+            path = "Loaders/application/x-enso/Actions",
+            id = @ActionID(category = "System", id = "org.openide.actions.RenameAction"),
+            position = 700,
+            separatorAfter = 800
+    ),
+    @ActionReference(
+            path = "Loaders/application/x-enso/Actions",
+            id = @ActionID(category = "System", id = "org.openide.actions.SaveAsTemplateAction"),
+            position = 900,
+            separatorAfter = 1000
+    ),
+    @ActionReference(
+            path = "Loaders/application/x-enso/Actions",
+            id = @ActionID(category = "System", id = "org.openide.actions.FileSystemAction"),
+            position = 1100,
+            separatorAfter = 1200
+    ),
+    @ActionReference(
+            path = "Loaders/application/x-enso/Actions",
+            id = @ActionID(category = "System", id = "org.openide.actions.ToolsAction"),
+            position = 1300
+    ),
+    @ActionReference(
+            path = "Loaders/application/x-enso/Actions",
+            id = @ActionID(category = "System", id = "org.openide.actions.PropertiesAction"),
+            position = 1400
+    )
+})
+public class EnsoDataObject extends MultiDataObject {
+
+    public EnsoDataObject(FileObject pf, MultiFileLoader loader) throws DataObjectExistsException, IOException {
+        super(pf, loader);
+        registerEditor("application/x-enso", true);
+    }
+
+    @Override
+    protected int associateLookup() {
+        return 1;
+    }
+
+    @MultiViewElement.Registration(
+            displayName = "#LBL_Enso_EDITOR",
+            iconBase = "org/enso/tools/enso4igv/enso.png",
+            mimeType = "application/x-enso",
+            persistenceType = TopComponent.PERSISTENCE_ONLY_OPENED,
+            preferredID = "Enso",
+            position = 1000
+    )
+    @Messages("LBL_Enso_EDITOR=Source")
+    public static MultiViewEditorElement createEditor(Lookup lkp) {
+        return new MultiViewEditorElement(lkp);
+    }
+
+}

tools/enso4igv/src/main/java/org/enso/tools/enso4igv/package-info.java

@@ -0,0 +1,4 @@
+@TemplateRegistration(folder = "Other", content = "EnsoTemplate.enso")
+package org.enso.tools.enso4igv;
+
+import org.netbeans.api.templates.TemplateRegistration;

tools/enso4igv/src/main/nbm/manifest.mf

@@ -0,0 +1,4 @@
+Manifest-Version: 1.0
+OpenIDE-Module-Layer: org/enso/tools/enso4igv/layer.xml
+OpenIDE-Module-Localizing-Bundle: org/enso/tools/enso4igv/Bundle.properties
+

tools/enso4igv/src/main/resources/org/enso/tools/enso4igv/Bundle.properties

@@ -0,0 +1,7 @@
+#Localized module labels. Defaults taken from POM (<name>, <description>, <groupId>) if unset.
+#OpenIDE-Module-Name=
+#OpenIDE-Module-Short-Description=
+#OpenIDE-Module-Long-Description=
+#OpenIDE-Module-Display-Category=
+#Thu May 12 10:04:24 CEST 2022
+EnsoLanguage=Enso

tools/enso4igv/src/main/resources/org/enso/tools/enso4igv/EnsoTemplate.enso

@@ -0,0 +1,10 @@
+from Standard.Base import all
+
+fac : Number -> Number
+fac n =
+    facacc : Number -> Number -> Number
+    facacc n v = if n <= 1 then v else @Tail_Call facacc n-1 n*v
+
+    facacc n 1
+
+main = IO.println (here.fac 6)