8155237: jlink plugin to order resources should take a class list as input
authorjlaskey
Wed, 11 May 2016 11:26:02 -0300
changeset 37888 c34e01b87292
parent 37887 436193142463
child 37889 c2dd6099a757
8155237: jlink plugin to order resources should take a class list as input Reviewed-by: redestad
jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/PluginOrderingGraph.java
jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/Utils.java
jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/plugins/OrderResourcesPlugin.java
jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/plugins/SortResourcesPlugin.java
jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/resources/plugins.properties
jdk/src/jdk.jlink/share/classes/module-info.java
--- a/jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/PluginOrderingGraph.java	Wed May 11 11:04:47 2016 +0200
+++ b/jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/PluginOrderingGraph.java	Wed May 11 11:26:02 2016 -0300
@@ -35,10 +35,6 @@
 import jdk.tools.jlink.plugin.Plugin;
 import jdk.tools.jlink.plugin.PluginException;
 
-/**
- *
- * @author jdenise
- */
 public class PluginOrderingGraph {
 
     static class Node {
--- a/jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/Utils.java	Wed May 11 11:04:47 2016 +0200
+++ b/jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/Utils.java	Wed May 11 11:26:02 2016 -0300
@@ -32,10 +32,6 @@
 import jdk.tools.jlink.plugin.Plugin;
 import jdk.tools.jlink.plugin.Plugin.PluginType;
 
-/**
- *
- * @author jdenise
- */
 public class Utils {
 
     private Utils() {}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/plugins/OrderResourcesPlugin.java	Wed May 11 11:26:02 2016 -0300
@@ -0,0 +1,214 @@
+/*
+ * Copyright (c) 2015, 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 jdk.tools.jlink.internal.plugins;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.function.ToIntFunction;
+import jdk.tools.jlink.plugin.PluginException;
+import jdk.tools.jlink.plugin.Pool;
+import jdk.tools.jlink.plugin.Pool.ModuleData;
+import jdk.tools.jlink.plugin.Pool.ModuleDataType;
+import jdk.tools.jlink.plugin.TransformerPlugin;
+import jdk.tools.jlink.internal.Utils;
+
+/**
+ *
+ * Order Resources plugin
+ */
+public final class OrderResourcesPlugin implements TransformerPlugin {
+    public static final String NAME = "order-resources";
+    private final List<ToIntFunction<String>> filters;
+    private final Map<String, Integer> orderedPaths;
+
+    public OrderResourcesPlugin() {
+        this.filters = new ArrayList<>();
+        this.orderedPaths = new HashMap<>();
+    }
+
+    @Override
+    public String getName() {
+        return NAME;
+    }
+
+    static class SortWrapper {
+        private final ModuleData resource;
+        private final int ordinal;
+
+        SortWrapper(ModuleData resource, int ordinal) {
+            this.resource = resource;
+            this.ordinal = ordinal;
+        }
+
+        ModuleData getResource() {
+            return resource;
+        }
+
+        String getPath() {
+            return resource.getPath();
+        }
+
+        int getOrdinal() {
+            return ordinal;
+        }
+    }
+
+    private String stripModule(String path) {
+        if (path.startsWith("/")) {
+            int index = path.indexOf('/', 1);
+
+            if (index != -1) {
+                return path.substring(index + 1);
+            }
+        }
+
+        return path;
+    }
+
+    private int getOrdinal(ModuleData resource) {
+        String path = resource.getPath();
+
+        Integer value = orderedPaths.get(stripModule(path));
+
+        if (value != null) {
+            return value;
+        }
+
+        for (ToIntFunction<String> function : filters) {
+            int ordinal = function.applyAsInt(path);
+
+            if (ordinal != Integer.MAX_VALUE) {
+                return ordinal;
+            }
+        }
+
+        return Integer.MAX_VALUE;
+    }
+
+    private static int compare(SortWrapper wrapper1, SortWrapper wrapper2) {
+        int compare = wrapper1.getOrdinal() - wrapper2.getOrdinal();
+
+        if (compare != 0) {
+            return compare;
+        }
+
+        return wrapper1.getPath().compareTo(wrapper2.getPath());
+    }
+
+    @Override
+    public void visit(Pool in, Pool out) {
+        in.getContent().stream()
+                .filter(resource -> resource.getType()
+                        .equals(ModuleDataType.CLASS_OR_RESOURCE))
+                .map((resource) -> new SortWrapper(resource, getOrdinal(resource)))
+                .sorted(OrderResourcesPlugin::compare)
+                .forEach((wrapper) -> out.add(wrapper.getResource()));
+        in.getContent().stream()
+                .filter(other -> !other.getType()
+                        .equals(ModuleDataType.CLASS_OR_RESOURCE))
+                .forEach((other) -> out.add(other));
+    }
+
+    @Override
+    public Set<PluginType> getType() {
+        Set<PluginType> set = new HashSet<>();
+        set.add(CATEGORY.SORTER);
+
+        return Collections.unmodifiableSet(set);
+    }
+
+    @Override
+    public String getDescription() {
+        return PluginsResourceBundle.getDescription(NAME);
+    }
+
+    @Override
+    public boolean hasArguments() {
+        return true;
+    }
+
+    @Override
+    public String getArgumentsDescription() {
+       return PluginsResourceBundle.getArgument(NAME);
+    }
+
+    @Override
+    public void configure(Map<String, String> config) {
+        String val = config.get(NAME);
+        String[] patterns = Utils.listParser.apply(val);
+        int ordinal = 0;
+
+        for (String pattern : patterns) {
+            if (pattern.startsWith("@")) {
+                File file = new File(pattern.substring(1));
+
+                if (file.exists()) {
+                    List<String> lines;
+
+                    try {
+                        lines = Files.readAllLines(file.toPath());
+                    } catch (IOException ex) {
+                        throw new PluginException(ex);
+                    }
+
+                    for (String line : lines) {
+                        if (!line.startsWith("#")) {
+                            orderedPaths.put(line + ".class", ordinal++);
+                        }
+                    }
+                }
+            } else {
+                boolean endsWith = pattern.startsWith("*");
+                boolean startsWith = pattern.endsWith("*");
+                ToIntFunction<String> function;
+                final int result = ordinal++;
+
+                if (startsWith && endsWith) {
+                    final String string = pattern.substring(1, pattern.length() - 1);
+                    function = (path)-> path.contains(string) ? result : Integer.MAX_VALUE;
+                } else if (startsWith) {
+                    final String string = pattern.substring(0, pattern.length() - 1);
+                    function = (path)-> path.startsWith(string) ? result : Integer.MAX_VALUE;
+                } else if (endsWith) {
+                    final String string = pattern.substring(1);
+                    function = (path)-> path.endsWith(string) ? result : Integer.MAX_VALUE;
+                } else {
+                    final String string = pattern;
+                    function = (path)-> path.equals(string) ? result : Integer.MAX_VALUE;
+                }
+
+                filters.add(function);
+            }
+        }
+    }
+}
--- a/jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/plugins/SortResourcesPlugin.java	Wed May 11 11:04:47 2016 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,201 +0,0 @@
-/*
- * Copyright (c) 2015, 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 jdk.tools.jlink.internal.plugins;
-
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-import java.util.stream.Collectors;
-import jdk.tools.jlink.plugin.PluginException;
-import jdk.tools.jlink.plugin.Pool;
-import jdk.tools.jlink.plugin.Pool.ModuleData;
-import jdk.tools.jlink.plugin.Pool.ModuleDataType;
-import jdk.tools.jlink.plugin.TransformerPlugin;
-import jdk.tools.jlink.internal.Utils;
-
-/**
- *
- * Sort Resources plugin
- */
-public final class SortResourcesPlugin implements TransformerPlugin {
-
-    public static final String NAME = "sort-resources";
-    private final List<Pattern> filters = new ArrayList<>();
-    private List<String> orderedPaths;
-    private boolean isFile;
-
-    @Override
-    public String getName() {
-        return NAME;
-    }
-
-    static class SortWrapper {
-
-        private final ModuleData resource;
-        private final int ordinal;
-
-        SortWrapper(ModuleData resource, int ordinal) {
-            this.resource = resource;
-            this.ordinal = ordinal;
-        }
-
-        ModuleData getResource() {
-            return resource;
-        }
-
-        String getPath() {
-            return resource.getPath();
-        }
-
-        int getOrdinal() {
-            return ordinal;
-        }
-    }
-
-    private int getPatternOrdinal(String path) {
-        int ordinal = -1;
-        for (int i = 0; i < filters.size(); i++) {
-            Matcher m = filters.get(i).matcher(path);
-            if (m.matches()) {
-                ordinal = i;
-                break;
-            }
-        }
-        return ordinal;
-    }
-
-    private int getFileOrdinal(String path) {
-        return orderedPaths.indexOf(path);
-    }
-
-    @Override
-    public void visit(Pool in, Pool out) {
-        in.getContent().stream()
-                .filter(w -> w.getType().equals(ModuleDataType.CLASS_OR_RESOURCE))
-                .map((r) -> new SortWrapper(r, isFile
-                        ? getFileOrdinal(r.getPath())
-                        : getPatternOrdinal(r.getPath())))
-                .sorted((sw1, sw2) -> {
-                    int ordinal1 = sw1.getOrdinal();
-                    int ordinal2 = sw2.getOrdinal();
-
-                    if (ordinal1 >= 0) {
-                        if (ordinal2 >= 0) {
-                            return ordinal1 - ordinal2;
-                        } else {
-                            return -1;
-                        }
-                    } else if (ordinal2 >= 0) {
-                        return 1;
-                    }
-
-                    return sw1.getPath().compareTo(sw2.getPath());
-                }).forEach((sw) -> {
-            try {
-                out.add(sw.getResource());
-            } catch (Exception ex) {
-                throw new RuntimeException(ex);
-            }
-        });
-        in.getContent().stream()
-                .filter(m -> !m.getType().equals(ModuleDataType.CLASS_OR_RESOURCE))
-                .forEach((m) -> {
-                    try {
-                        out.add(m);
-                    } catch (Exception ex) {
-                        throw new RuntimeException(ex);
-                    }
-                });
-    }
-
-    @Override
-    public Set<PluginType> getType() {
-        Set<PluginType> set = new HashSet<>();
-        set.add(CATEGORY.SORTER);
-        return Collections.unmodifiableSet(set);
-    }
-
-    @Override
-    public String getDescription() {
-        return PluginsResourceBundle.getDescription(NAME);
-    }
-
-    @Override
-    public boolean hasArguments() {
-        return true;
-    }
-
-    @Override
-    public String getArgumentsDescription() {
-       return PluginsResourceBundle.getArgument(NAME);
-    }
-
-    @Override
-    public void configure(Map<String, String> config) {
-        String val = config.get(NAME);
-        try {
-            String[] patterns = Utils.listParser.apply(val);
-            boolean isf = false;
-            List<String> paths = null;
-            if (patterns != null) {
-                if (patterns.length == 1) {
-                    String filePath = patterns[0];
-                    File f = new File(filePath);
-                    if (f.exists()) {
-                        isf = true;
-                        try (FileInputStream fis = new FileInputStream(f);
-                                InputStreamReader ins
-                                = new InputStreamReader(fis, StandardCharsets.UTF_8);
-                                BufferedReader reader = new BufferedReader(ins)) {
-                            paths = reader.lines().collect(Collectors.toList());
-                        }
-                    }
-                }
-                if (!isf) {
-                    for (String p : patterns) {
-                        p = p.replaceAll(" ", "");
-                        Pattern pattern = Pattern.compile(ResourceFilter.escape(p));
-                        filters.add(pattern);
-                    }
-                }
-            }
-            orderedPaths = paths;
-            isFile = isf;
-        } catch (IOException ex) {
-            throw new PluginException(ex);
-        }
-    }
-}
--- a/jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/resources/plugins.properties	Wed May 11 11:04:47 2016 +0200
+++ b/jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/resources/plugins.properties	Wed May 11 11:26:02 2016 -0300
@@ -53,10 +53,10 @@
 
 onoff.argument=<on|off>
 
-sort-resources.argument=<paths in priority order | file with resource paths>
+order-resources.argument=<paths in priority order | file with resource paths>
 
-sort-resources.description=\
-Sort resources. e.g.: */modules-info.class,/java-base/java/lang/*
+order-resources.description=\
+Order resources. e.g.: */module-info.class,/java.base/java/lang/*
 
 strip-debug.description=\
 Strip debug information from the output image
@@ -68,7 +68,7 @@
 
 vm.description=\
 Select the HotSpot VM in the output image.  Default is all
- 
+
 zip.argument=[comma separated list of resource paths]
 
 zip.description=ZIP Compression
@@ -160,7 +160,7 @@
 
 err.no.plugins.path=No plugins path argument.
 
-err.dir.already.exits=directory already exists: {0} 
+err.dir.already.exits=directory already exists: {0}
 
 err.invalid.index=invalid index for option {0}
 
--- a/jdk/src/jdk.jlink/share/classes/module-info.java	Wed May 11 11:04:47 2016 +0200
+++ b/jdk/src/jdk.jlink/share/classes/module-info.java	Wed May 11 11:26:02 2016 -0300
@@ -40,7 +40,7 @@
     provides jdk.tools.jlink.plugin.TransformerPlugin with jdk.tools.jlink.internal.plugins.ExcludeFilesPlugin;
     provides jdk.tools.jlink.plugin.TransformerPlugin with jdk.tools.jlink.internal.plugins.SystemModuleDescriptorPlugin;
     provides jdk.tools.jlink.plugin.TransformerPlugin with jdk.tools.jlink.internal.plugins.StripNativeCommandsPlugin;
-    provides jdk.tools.jlink.plugin.TransformerPlugin with jdk.tools.jlink.internal.plugins.SortResourcesPlugin;
+    provides jdk.tools.jlink.plugin.TransformerPlugin with jdk.tools.jlink.internal.plugins.OrderResourcesPlugin;
     provides jdk.tools.jlink.plugin.TransformerPlugin with jdk.tools.jlink.internal.plugins.DefaultCompressPlugin;
     provides jdk.tools.jlink.plugin.TransformerPlugin with jdk.tools.jlink.internal.plugins.OptimizationPlugin;
     provides jdk.tools.jlink.plugin.TransformerPlugin with jdk.tools.jlink.internal.plugins.ExcludeVMPlugin;