8152360: deprecate javah
authorvromero
Wed, 25 May 2016 11:33:56 -0400
changeset 38605 72ca5671f3e6
parent 38604 b65bfa841446
child 38606 6b708cd90241
child 38611 b5a479aff686
child 39094 82f2c2e59689
8152360: deprecate javah Reviewed-by: jjg
langtools/src/jdk.compiler/share/classes/com/sun/tools/javah/JavahTask.java
langtools/src/jdk.compiler/share/classes/com/sun/tools/javah/resources/l10n.properties
langtools/test/tools/javac/T8152360/DeprecateJavahTest.java
langtools/test/tools/javah/T6893943.java
langtools/test/tools/javah/VersionTest.java
--- a/langtools/src/jdk.compiler/share/classes/com/sun/tools/javah/JavahTask.java	Wed May 25 19:30:55 2016 +0530
+++ b/langtools/src/jdk.compiler/share/classes/com/sun/tools/javah/JavahTask.java	Wed May 25 11:33:56 2016 -0400
@@ -429,6 +429,10 @@
 
     public boolean run() throws Util.Exit {
 
+        if (!javac_extras.contains("-XDsuppress-tool-removal-message")) {
+            log.println(getMessage("javah.misc.Deprecation"));
+        }
+
         Util util = new Util(log, diagnosticListener);
 
         if (noArgs || help) {
--- a/langtools/src/jdk.compiler/share/classes/com/sun/tools/javah/resources/l10n.properties	Wed May 25 19:30:55 2016 +0530
+++ b/langtools/src/jdk.compiler/share/classes/com/sun/tools/javah/resources/l10n.properties	Wed May 25 11:33:56 2016 -0400
@@ -164,3 +164,12 @@
 err.missing.arg=value missing for {0}
 err.no.classes.specified=no classes specified
 err.unknown.option=unknown option: {0}
+
+#
+# miscellaneous strings
+#
+javah.misc.Deprecation=\
+    \nWarning:\u0020The javah tool is planned to be removed in the next major\n\
+    JDK release. The tool has been superseded by the ''-h'' option added\n\
+    to javac in JDK 8. Users are recommended to migrate to using the\n\
+    javac ''-h'' option; see the javac man page for more information.\n
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/javac/T8152360/DeprecateJavahTest.java	Wed May 25 11:33:56 2016 -0400
@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2016, 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.
+ *
+ * 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.
+ */
+
+/*
+ * @test
+ * @bug 8152360
+ * @summary deprecate javah
+ * @library /tools/lib
+ * @modules jdk.compiler/com.sun.tools.javac.api
+ *          jdk.compiler/com.sun.tools.javac.main
+ *          jdk.compiler/com.sun.tools.javah
+ * @build toolbox.ToolBox toolbox.JavahTask
+ * @run main DeprecateJavahTest
+ */
+
+import toolbox.JavahTask;
+import toolbox.Task;
+import toolbox.ToolBox;
+
+public class DeprecateJavahTest {
+    public static void main(String... args) throws Exception {
+        new DeprecateJavahTest().run();
+    }
+
+    ToolBox tb = new ToolBox();
+
+    void printDeprecationWarning() throws Exception {
+        String output = new JavahTask(tb)
+                .options("-version")
+                .run()
+                .writeAll()
+                .getOutput(Task.OutputKind.DIRECT);
+
+        if (!output.contains(
+                "Warning: The javah tool is planned to be removed in the next major\n" +
+                "JDK release. The tool has been superseded by the '-h' option added\n" +
+                "to javac in JDK 8. Users are recommended to migrate to using the\n" +
+                "javac '-h' option; see the javac man page for more information.")) {
+            throw new Exception("test failed");
+        }
+    }
+
+    void dontPrintDeprecationWarning() throws Exception {
+        String output = new JavahTask(tb)
+                .options("-version", "-XDsuppress-tool-removal-message")
+                .run()
+                .writeAll()
+                .getOutput(Task.OutputKind.DIRECT);
+
+        if (!output.startsWith("javah version")) {
+            throw new Exception("test failed");
+        }
+    }
+
+    void run() throws Exception {
+        printDeprecationWarning();
+        dontPrintDeprecationWarning();
+    }
+}
--- a/langtools/test/tools/javah/T6893943.java	Wed May 25 19:30:55 2016 +0530
+++ b/langtools/test/tools/javah/T6893943.java	Wed May 25 11:33:56 2016 -0400
@@ -32,8 +32,8 @@
 import java.util.*;
 
 public class T6893943 {
-    static final String[] NO_ARGS = { };
-    static final String[] HELP = { "-help" };
+    static final String[] NO_ARGS = { "-XDsuppress-tool-removal-message" };
+    static final String[] SUPPRESS_WARNING_PLUS_HELP = { "-XDsuppress-tool-removal-message", "-help" };
     static final String NEWLINE = System.getProperty("line.separator");
 
     public static void main(String... args) throws Exception {
@@ -42,9 +42,9 @@
 
     void run() throws Exception {
         testSimpleAPI(NO_ARGS, 1);
-        testSimpleAPI(HELP, 0);
+        testSimpleAPI(SUPPRESS_WARNING_PLUS_HELP, 0);
         testCommand(NO_ARGS, 1);
-        testCommand(HELP, 0);
+        testCommand(SUPPRESS_WARNING_PLUS_HELP, 0);
     }
 
     void testSimpleAPI(String[] args, int expect_rc) throws Exception {
@@ -81,11 +81,6 @@
         if (out.isEmpty())
             throw new Exception("No output from javah");
 
-        if (!out.startsWith("Usage:")) {
-            System.err.println(out);
-            throw new Exception("Unexpected output from javah");
-        }
-
         if (actual_rc != expect_rc)
             throw new Exception(name + ": unexpected exit: " + actual_rc + ", expected: " + expect_rc);
     }
--- a/langtools/test/tools/javah/VersionTest.java	Wed May 25 19:30:55 2016 +0530
+++ b/langtools/test/tools/javah/VersionTest.java	Wed May 25 11:33:56 2016 -0400
@@ -37,8 +37,8 @@
         try {
             Locale.setDefault(Locale.ENGLISH);
             System.err.println(Locale.getDefault());
-            test("-version", "\\S+ version \"\\S+\"");
-            test("-fullversion", "\\S+ full version \"\\S+\"");
+            test("-version -XDsuppress-tool-removal-message", "\\S+ version \"\\S+\"");
+            test("-fullversion -XDsuppress-tool-removal-message", "\\S+ full version \"\\S+\"");
         } finally {
             Locale.setDefault(prev);
         }
@@ -47,7 +47,7 @@
     static void test(String option, String regex) {
         StringWriter sw = new StringWriter();
         PrintWriter pw = new PrintWriter(sw);
-        String[] args = { option };
+        String[] args = option.split(" ");
         int rc = com.sun.tools.javah.Main.run(args, pw);
         pw.close();
         if (rc != 0)