GH-228 - --source-config argument to setup source roots and source viewer using a configuration file

Author: jisedlac

plugins/sources/manifest.mf

@@ -3,5 +3,5 @@ AutoUpdate-Show-In-Client: true
 AutoUpdate-Essential-Module: false
 OpenIDE-Module: org.graalvm.visualvm.sources/1
 OpenIDE-Module-Localizing-Bundle: org/graalvm/visualvm/sources/resources/Bundle.properties
-OpenIDE-Module-Specification-Version: 1.0
+OpenIDE-Module-Specification-Version: 1.1
 

plugins/sources/src/META-INF/services/org.netbeans.spi.sendopts.OptionProcessor

@@ -25,3 +25,4 @@
 
 Argument_SourceViewer_ShortDescr=set the source viewer command to be executed by Go To Source
 Argument_SourceRoots_ShortDescr=set the source roots to be searched by Go To Source
+Argument_SourceConfig_ShortDescr=set the path to sources configuration file containing source roots and viewer definition

plugins/sources/src/org/graalvm/visualvm/sources/arguments/Bundle.properties

@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package org.graalvm.visualvm.sources.arguments;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.Set;
+import org.netbeans.api.sendopts.CommandException;
+import org.netbeans.spi.sendopts.Env;
+import org.netbeans.spi.sendopts.Option;
+import org.netbeans.spi.sendopts.OptionGroups;
+import org.netbeans.spi.sendopts.OptionProcessor;
+import org.openide.util.lookup.ServiceProvider;
+
+/**
+ *
+ * @author Jiri Sedlacek
+ */
+@ServiceProvider(service=OptionProcessor.class)
+public final class SourceArguments extends OptionProcessor {
+    
+    @Override
+    protected Set<Option> getOptions() {
+        return Collections.singleton(OptionGroups.anyOf(SourceRootsArgument.ARGUMENT, SourceViewerArgument.ARGUMENT, SourceConfigArgument.ARGUMENT));
+    }
+    
+    @Override
+    protected void process(Env env, Map<Option, String[]> maps) throws CommandException {
+        String[] sourceRoots = maps.get(SourceRootsArgument.ARGUMENT);
+        String[] sourceViewer = maps.get(SourceViewerArgument.ARGUMENT);
+        String[] sourceConfig = maps.get(SourceConfigArgument.ARGUMENT);
+        
+        if (sourceConfig != null) SourceConfigArgument.process(sourceConfig, sourceRoots, sourceViewer);
+        if (sourceRoots != null) SourceRootsArgument.process(sourceRoots);
+        if (sourceViewer != null) SourceViewerArgument.process(sourceViewer);
+    }
+    
+}

plugins/sources/src/org/graalvm/visualvm/sources/arguments/SourceArguments.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package org.graalvm.visualvm.sources.arguments;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.util.Properties;
+import org.netbeans.api.sendopts.CommandException;
+import org.netbeans.spi.sendopts.Option;
+
+/**
+ * Implementation of the --source-config argument
+ *
+ * @author Jiri Sedlacek
+ */
+class SourceConfigArgument {
+    
+    static final String LONG_NAME = "source-config";                            // NOI18N
+    
+    static final Option ARGUMENT = Option.shortDescription(Option.requiredArgument(Option.NO_SHORT_NAME, LONG_NAME), "org.graalvm.visualvm.sources.arguments.Bundle", "Argument_SourceConfig_ShortDescr"); // NOI18N
+    
+    
+    static void process(String[] values, String[] rootsValues, String[] viewerValues) throws CommandException {
+        if (rootsValues != null || viewerValues != null)
+            throw new CommandException(0, "--" + LONG_NAME +                    // NOI18N
+                    " not allowed with --" + SourceRootsArgument.LONG_NAME +    // NOI18N
+                    " or --" + SourceViewerArgument.LONG_NAME);                 // NOI18N
+        
+        if (values.length == 1) setValue(values[0]);
+        else throw new CommandException(0, "--" + LONG_NAME + " requires exactly one value"); // NOI18N
+    }
+    
+    
+    private static final void setValue(String value) throws CommandException {
+        try (InputStreamReader isr = new InputStreamReader(new FileInputStream(value), "UTF-8")) { // NOI18N
+            Properties props = new Properties();
+            props.load(isr);
+            
+            String sourceRoots = props.getProperty(SourceRootsArgument.LONG_NAME);
+            if (sourceRoots != null) SourceRootsArgument.setValue(sourceRoots);
+            
+            String sourceViewer = props.getProperty(SourceViewerArgument.LONG_NAME);
+            if (sourceViewer != null) SourceViewerArgument.setValue(sourceViewer);
+        } catch (IOException e) {
+            throw new CommandException(0, "--" + LONG_NAME + " failed to read config " + value + ": " + e.getMessage()); // NOI18N
+        }
+    }
+    
+}

plugins/sources/src/org/graalvm/visualvm/sources/arguments/SourceConfigArgument.java

@@ -25,42 +25,29 @@
 package org.graalvm.visualvm.sources.arguments;
 
 import java.io.File;
-import java.util.Collections;
-import java.util.Map;
-import java.util.Set;
 import org.graalvm.visualvm.sources.impl.SourceRoots;
 import org.netbeans.api.sendopts.CommandException;
-import org.netbeans.spi.sendopts.Env;
 import org.netbeans.spi.sendopts.Option;
-import org.netbeans.spi.sendopts.OptionProcessor;
 
 /**
  * Implementation of the --source-roots argument
  *
  * @author Jiri Sedlacek
  */
-public final class SourceRootsArgument extends OptionProcessor {
+final class SourceRootsArgument {
 
-    private static final String ARGUMENT_LONG_NAME = "source-roots";            // NOI18N
+    static final String LONG_NAME = "source-roots";                             // NOI18N
 
+    static final Option ARGUMENT = Option.shortDescription(Option.requiredArgument(Option.NO_SHORT_NAME, LONG_NAME), "org.graalvm.visualvm.sources.arguments.Bundle", "Argument_SourceRoots_ShortDescr"); // NOI18N
 
-    private final Option argument = Option.shortDescription(Option.requiredArgument(Option.NO_SHORT_NAME, ARGUMENT_LONG_NAME), "org.graalvm.visualvm.sources.arguments.Bundle", "Argument_SourceRoots_ShortDescr"); // NOI18N
-    
-
-    @Override
-    protected Set<Option> getOptions() {
-        return Collections.singleton(argument);
-    }
 
-    @Override
-    protected void process(Env env, Map<Option, String[]> maps) throws CommandException {
-        String[] values = maps.get(argument);
+    static void process(String[] values) throws CommandException {
         if (values.length == 1) setValue(values[0]);
-        else throw new CommandException(0, "--" + ARGUMENT_LONG_NAME + " requires exactly one value"); // NOI18N
+        else throw new CommandException(0, "--" + LONG_NAME + " requires exactly one value"); // NOI18N
     }
 
 
-    private static final void setValue(String value) {
+    static final void setValue(String value) {
         if (value != null) value = value.trim();
         if (value == null || value.isEmpty()) SourceRoots.forceRoots(null);
         else SourceRoots.forceRoots(value.split(File.pathSeparator));

plugins/sources/src/org/graalvm/visualvm/sources/arguments/SourceRootsArgument.java

@@ -24,42 +24,29 @@
  */
 package org.graalvm.visualvm.sources.arguments;
 
-import java.util.Collections;
-import java.util.Map;
-import java.util.Set;
 import org.graalvm.visualvm.sources.impl.SourceViewers;
 import org.netbeans.api.sendopts.CommandException;
-import org.netbeans.spi.sendopts.Env;
 import org.netbeans.spi.sendopts.Option;
-import org.netbeans.spi.sendopts.OptionProcessor;
 
 /**
  * Implementation of the --external-viewer argument
  *
  * @author Jiri Sedlacek
  */
-public final class SourceViewerArgument extends OptionProcessor {
+final class SourceViewerArgument {
 
-    private static final String ARGUMENT_LONG_NAME = "source-viewer";           // NOI18N
+    static final String LONG_NAME = "source-viewer";                            // NOI18N
 
+    static final Option ARGUMENT = Option.shortDescription(Option.requiredArgument(Option.NO_SHORT_NAME, LONG_NAME), "org.graalvm.visualvm.sources.arguments.Bundle", "Argument_SourceViewer_ShortDescr"); // NOI18N
 
-    private final Option argument = Option.shortDescription(Option.requiredArgument(Option.NO_SHORT_NAME, ARGUMENT_LONG_NAME), "org.graalvm.visualvm.sources.arguments.Bundle", "Argument_SourceViewer_ShortDescr"); // NOI18N
 
-    
-    @Override
-    protected Set<Option> getOptions() {
-        return Collections.singleton(argument);
-    }
-
-    @Override
-    protected void process(Env env, Map<Option, String[]> maps) throws CommandException {
-        String[] values = maps.get(argument);
+    static void process(String[] values) throws CommandException {
         if (values.length == 1) setValue(values[0]);
-        else throw new CommandException(0, "--" + ARGUMENT_LONG_NAME + " requires exactly one value"); // NOI18N
+        else throw new CommandException(0, "--" + LONG_NAME + " requires exactly one value"); // NOI18N
     }
 
 
-    private static final void setValue(String value) {
+    static final void setValue(String value) {
         if (value != null) value = value.trim();
         SourceViewers.forceExternalViewer(value);
     }