langtools/test/tools/lib/toolbox/JavahTask.java
author jjg
Thu, 31 Mar 2016 15:20:50 -0700
changeset 36778 e04318f39f92
permissions -rw-r--r--
8152897: refactor ToolBox to allow reduced documented dependencies Reviewed-by: vromero
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36778
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     1
/*
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     2
 * Copyright (c) 2013, 2016, Oracle and/or its affiliates. All rights reserved.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     4
 *
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     8
 *
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    13
 * accompanied this code).
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    14
 *
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    18
 *
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    21
 * questions.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    22
 */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    23
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    24
package toolbox;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    25
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    26
import java.util.ArrayList;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    27
import java.util.Arrays;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    28
import java.util.HashMap;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    29
import java.util.List;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    30
import java.util.Map;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    31
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    32
/**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    33
 * A task to configure and run the native header tool, javah.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    34
 */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    35
public class JavahTask extends AbstractTask<JavahTask> {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    36
    private String classpath;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    37
    private List<String> options;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    38
    private List<String> classes;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    39
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    40
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    41
     * Create a task to execute {@code javah} using {@code CMDLINE} mode.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    42
     * @param toolBox the {@code ToolBox} to use
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    43
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    44
    public JavahTask(ToolBox toolBox) {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    45
        super(toolBox, Task.Mode.CMDLINE);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    46
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    47
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    48
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    49
     * Sets the classpath.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    50
     * @param classpath the classpath
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    51
     * @return this task object
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    52
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    53
    public JavahTask classpath(String classpath) {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    54
        this.classpath = classpath;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    55
        return this;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    56
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    57
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    58
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    59
     * Sets the options.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    60
     * @param options the options
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    61
     * @return this task object
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    62
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    63
    public JavahTask options(String... options) {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    64
        this.options = Arrays.asList(options);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    65
        return this;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    66
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    67
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    68
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    69
     * Sets the classes to be analyzed.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    70
     * @param classes the classes
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    71
     * @return this task object
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    72
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    73
    public JavahTask classes(String... classes) {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    74
        this.classes = Arrays.asList(classes);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    75
        return this;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    76
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    77
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    78
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    79
     * {@inheritDoc}
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    80
     * @return the name "javah"
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    81
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    82
    @Override
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    83
    public String name() {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    84
        return "javah";
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    85
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    86
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    87
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    88
     * Calls the javah tool with the arguments as currently configured.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    89
     * @return a Result object indicating the outcome of the task
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    90
     * and the content of any output written to stdout, stderr, or the
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    91
     * main stream provided to the task.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    92
     * @throws TaskError if the outcome of the task is not as expected.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    93
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    94
    @Override
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    95
    public Task.Result run() {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    96
        List<String> args = new ArrayList<>();
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    97
        if (options != null)
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    98
            args.addAll(options);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    99
        if (classpath != null) {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   100
            args.add("-classpath");
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   101
            args.add(classpath);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   102
        }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   103
        if (classes != null)
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   104
            args.addAll(classes);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   105
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   106
        AbstractTask.WriterOutput direct = new AbstractTask.WriterOutput();
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   107
        // These are to catch output to System.out and System.err,
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   108
        // in case these are used instead of the primary streams
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   109
        AbstractTask.StreamOutput sysOut = new AbstractTask.StreamOutput(System.out, System::setOut);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   110
        AbstractTask.StreamOutput sysErr = new AbstractTask.StreamOutput(System.err, System::setErr);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   111
        int rc;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   112
        Map<Task.OutputKind, String> outputMap = new HashMap<>();
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   113
        try {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   114
            rc = com.sun.tools.javah.Main.run(args.toArray(new String[args.size()]), direct.pw);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   115
        } finally {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   116
            outputMap.put(Task.OutputKind.STDOUT, sysOut.close());
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   117
            outputMap.put(Task.OutputKind.STDERR, sysErr.close());
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   118
            outputMap.put(Task.OutputKind.DIRECT, direct.close());
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   119
        }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   120
        return checkExit(new Task.Result(toolBox, this, rc, outputMap));
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   121
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
   122
}