8314483: Optionally override copyright header in generated source

Reviewed-by: dholmes, iris

Author: erikj79

make/ToolsJdk.gmk

@@ -137,4 +137,7 @@ PANDOC_HTML_MANPAGE_FILTER := $(BUILDTOOLS_OUTPUTDIR)/manpages/pandoc-html-manpa
 
 ##########################################################################################
 
+# Hook to include the corresponding custom post file, if present.
+$(eval $(call IncludeCustomExtension, ToolsJdk-post.gmk))
+
 endif # _TOOLS_GMK

make/jdk/src/classes/build/tools/cldrconverter/CLDRConverter.java

@@ -114,6 +114,7 @@ public class CLDRConverter {
 
     private static Set<String> AVAILABLE_TZIDS;
     static int copyrightYear;
+    static String jdkHeaderTemplate;
     private static String zoneNameTempFile;
     private static String tzDataDir;
     private static final Map<String, String> canonicalTZMap = new HashMap<>();
@@ -229,6 +230,10 @@ public static void main(String[] args) throws Exception {
                         tzDataDir = args[++i];
                         break;
 
+                    case "-jdk-header-template":
+                        jdkHeaderTemplate = Files.readString(Paths.get(args[++i]));
+                        break;
+
                     case "-help":
                         usage();
                         System.exit(0);
@@ -304,7 +309,9 @@ private static void usage() {
                 + "\t-year year     copyright year in output%n"
                 + "\t-zntempfile    template file for java.time.format.ZoneName.java%n"
                 + "\t-tzdatadir     tzdata directory for java.time.format.ZoneName.java%n"
-                + "\t-utf8          use UTF-8 rather than \\uxxxx (for debug)%n");
+                + "\t-utf8          use UTF-8 rather than \\uxxxx (for debug)%n"
+                + "\t-jdk-header-template <file>%n"
+                + "\t\t       override default GPL header with contents of file%n");
     }
 
     static void info(String fmt, Object... args) {

make/jdk/src/classes/build/tools/cldrconverter/ResourceBundleGenerator.java

@@ -174,7 +174,7 @@ public void generateBundle(String packageName, String baseName, String localeID,
 
         try (PrintWriter out = new PrintWriter(file, encoding)) {
             // Output copyright headers
-            out.println(CopyrightHeaders.getOpenJDKCopyright(CLDRConverter.copyrightYear));
+            out.println(getOpenJDKCopyright());
             out.println(CopyrightHeaders.getUnicodeCopyright());
 
             if (useJava) {
@@ -294,7 +294,7 @@ public void generateMetaInfo(Map<String, SortedSet<String>> metaInfo) throws IOE
         CLDRConverter.info("Generating file " + file);
 
         try (PrintWriter out = new PrintWriter(file, "us-ascii")) {
-            out.printf(CopyrightHeaders.getOpenJDKCopyright(CLDRConverter.copyrightYear));
+            out.printf(getOpenJDKCopyright());
 
             out.printf("""
                 package sun.util.%s;
@@ -448,4 +448,12 @@ private static SortedSet<String> applyLanguageAliases(SortedSet<String> tags) {
         });
         return tags;
     }
+
+    private static String getOpenJDKCopyright() {
+        if (CLDRConverter.jdkHeaderTemplate != null) {
+            return String.format(CLDRConverter.jdkHeaderTemplate, CLDRConverter.copyrightYear);
+        } else {
+            return CopyrightHeaders.getOpenJDKCopyright(CLDRConverter.copyrightYear);
+        }
+    }
 }

make/jdk/src/classes/build/tools/generatelsrequivmaps/EquivMapsGenerator.java

@@ -53,21 +53,38 @@
 public class EquivMapsGenerator {
 
     public static void main(String[] args) throws Exception {
-        if (args.length != 3) {
+        int i = 0;
+        boolean valid = true;
+        if (args.length != 5 && args.length !=3) {
+            valid = false;
+        } else if (args.length == 5) {
+            if ("-jdk-header-template".equals(args[i])) {
+                jdkHeaderTemplate = Files.readString(Paths.get(args[++i]));
+                i++;
+            } else {
+                valid = false;
+            }
+        }
+        if (!valid) {
             System.err.println("Usage: java EquivMapsGenerator"
+                    + " [-jdk-header-template <file>]"
                     + " language-subtag-registry.txt LocaleEquivalentMaps.java copyrightYear");
             System.exit(1);
         }
-        copyrightYear = Integer.parseInt(args[2]);
-        readLSRfile(args[0]);
+        String lsrFile = args[i++];
+        String outputFile = args[i++];
+        copyrightYear = Integer.parseInt(args[i++]);
+
+        readLSRfile(lsrFile);
         // Builds the maps from the IANA data
         generateEquivalentMap();
         // Writes the maps out to LocaleEquivalentMaps.java
-        generateSourceCode(args[1]);
+        generateSourceCode(outputFile);
     }
 
     private static String LSRrevisionDate;
     private static int copyrightYear;
+    private static String jdkHeaderTemplate;
     private static Map<String, StringBuilder> initialLanguageMap =
         new TreeMap<>();
     private static Map<String, StringBuilder> initialRegionVariantMap =
@@ -225,6 +242,7 @@ private static void generateSourceCode(String fileName) {
         try (BufferedWriter writer = Files.newBufferedWriter(
                 Paths.get(fileName))) {
             writer.write(getOpenJDKCopyright());
+            writer.write("\n");
             writer.write(HEADER_TEXT);
             writer.write(getMapsText());
             writer.write(getLSRText());
@@ -241,7 +259,8 @@ private static void generateSourceCode(String fileName) {
     }
 
     private static String getOpenJDKCopyright() {
-        return String.format(Locale.US, COPYRIGHT, copyrightYear);
+        return String.format(Locale.US,
+                (jdkHeaderTemplate != null ? jdkHeaderTemplate : COPYRIGHT), copyrightYear);
     }
 
     private static final String COPYRIGHT =
@@ -270,7 +289,6 @@ private static String getOpenJDKCopyright() {
              * or visit www.oracle.com if you need additional information or have any
              * questions.
             */
-
             """;
 
     private static final String HEADER_TEXT =