src/jdk.jlink/share/classes/jdk/tools/jlink/internal/plugins/ExcludeJmodSectionPlugin.java
author jiefu
Tue, 29 Oct 2019 10:13:27 -0700
changeset 58843 63994dedec49
parent 47216 71c04702a3d5
permissions -rw-r--r--
8232864: Classes generated at link time by GenerateJLIClassesPlugin are not reproducible Reviewed-by: redestad, mchung
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
41561
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
     1
/*
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
     2
 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
     4
 *
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    10
 *
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    15
 * accompanied this code).
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    16
 *
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    20
 *
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    23
 * questions.
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    24
 */
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    25
package jdk.tools.jlink.internal.plugins;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    26
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    27
import java.util.HashSet;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    28
import java.util.Map;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    29
import java.util.Set;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    30
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    31
import jdk.tools.jlink.plugin.Plugin;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    32
import jdk.tools.jlink.plugin.PluginException;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    33
import jdk.tools.jlink.plugin.ResourcePool;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    34
import jdk.tools.jlink.plugin.ResourcePoolBuilder;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    35
import jdk.tools.jlink.plugin.ResourcePoolEntry.Type;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    36
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    37
/**
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    38
 *
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    39
 * A plugin to exclude a JMOD section such as man pages or header files
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    40
 */
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    41
public final class ExcludeJmodSectionPlugin implements Plugin {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    42
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    43
    public static final String NAME = "exclude-jmod-section";
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    44
    public static final String MAN_PAGES = "man";
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    45
    public static final String INCLUDE_HEADER_FILES = "headers";
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    46
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    47
    private final Set<Type> filters = new HashSet<>();
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    48
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    49
    @Override
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    50
    public String getName() {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    51
        return NAME;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    52
    }
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    53
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    54
    @Override
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    55
    public void configure(Map<String, String> config) {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    56
        String arg = config.get(NAME);
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    57
        if (arg.isEmpty()) {
42330
bd999576b78d 8160359: Improve jlink logging for cases when a plugin throws exception
sundar
parents: 41561
diff changeset
    58
            throw new IllegalArgumentException("Section name must be specified");
41561
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    59
        }
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    60
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    61
        switch (arg) {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    62
            case MAN_PAGES:
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    63
                filters.add(Type.MAN_PAGE);
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    64
                break;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    65
            case INCLUDE_HEADER_FILES:
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    66
                filters.add(Type.HEADER_FILE);
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    67
                break;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    68
            default:
42330
bd999576b78d 8160359: Improve jlink logging for cases when a plugin throws exception
sundar
parents: 41561
diff changeset
    69
                throw new IllegalArgumentException("Invalid section name: " + arg);
41561
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    70
        }
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    71
    }
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    72
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    73
    @Override
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    74
    public ResourcePool transform(ResourcePool in, ResourcePoolBuilder out) {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    75
        in.transformAndCopy(entry -> {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    76
            // filter entries whose type corresponds to the specified JMOD section
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    77
            if (filters.contains(entry.type())) {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    78
                entry = null;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    79
            }
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    80
            return entry;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    81
        }, out);
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    82
        return out.build();
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    83
    }
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    84
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    85
    @Override
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    86
    public Category getType() {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    87
        return Category.FILTER;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    88
    }
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    89
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    90
    @Override
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    91
    public String getDescription() {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    92
        return PluginsResourceBundle.getDescription(NAME);
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    93
    }
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    94
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    95
    @Override
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    96
    public boolean hasArguments() {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    97
        return true;
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    98
    }
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
    99
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
   100
    @Override
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
   101
    public String getArgumentsDescription() {
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
   102
       return PluginsResourceBundle.getArgument(NAME);
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
   103
    }
0c6942d13f2e 8167558: Add new JMOD section for header files and man pages
mchung
parents:
diff changeset
   104
}