langtools/make/gensrc/GensrcCommon.gmk
author mcimadamore
Thu, 08 Jan 2015 14:43:05 +0000
changeset 28334 1633de6070ae
parent 27579 d1a63c99cdd5
child 28458 f20c5dd05e34
permissions -rw-r--r--
8058542: Devise scheme for better diagnostic creation Summary: Add support for generating (at build-time) an enum-like class containing all javac diagnostics, which allows for safe diagnostic creation. Reviewed-by: jlahoda, jjg, vromero, erikj, jfranck
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
27579
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     1
#
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     2
# Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     3
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     4
#
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     5
# This code is free software; you can redistribute it and/or modify it
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     6
# under the terms of the GNU General Public License version 2 only, as
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     7
# published by the Free Software Foundation.  Oracle designates this
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     8
# particular file as subject to the "Classpath" exception as provided
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
     9
# by Oracle in the LICENSE file that accompanied this code.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    10
#
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    11
# This code is distributed in the hope that it will be useful, but WITHOUT
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    12
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    13
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    14
# version 2 for more details (a copy is included in the LICENSE file that
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    15
# accompanied this code).
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    16
#
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    17
# You should have received a copy of the GNU General Public License version
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    18
# 2 along with this work; if not, write to the Free Software Foundation,
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    19
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    20
#
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    21
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    22
# or visit www.oracle.com if you need additional information or have any
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    23
# questions.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    24
#
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    25
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    26
# This must be the first rule
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    27
default: all
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    28
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    29
include $(SPEC)
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    30
include MakeBase.gmk
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    31
include JavaCompilation.gmk
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    32
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    33
################################################################################
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    34
# The compileprops tools compiles a properties file into a resource bundle.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    35
TOOL_COMPILEPROPS_CMD := $(JAVA) -cp $(BUILDTOOLS_OUTPUTDIR)/langtools_tools_classes \
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    36
    compileproperties.CompileProperties -quiet
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    37
28334
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
    38
################################################################################
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
    39
# The compileprops tools compiles a properties file into an enum-like class.
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
    40
TOOL_PARSEPROPS_CMD := $(JAVA) -cp $(BUILDTOOLS_OUTPUTDIR)/langtools_tools_classes \
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
    41
    propertiesparser.PropertiesParser
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
    42
27579
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    43
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    44
################################################################################
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    45
# Sets up a rule that creates a version.properties file in the gensrc output
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    46
# directory.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    47
# Param 1 - Variable to add generated file name to
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    48
# Param 2 - Name of version.properties file including packages from the src
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    49
#           root.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    50
define SetupVersionProperties
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    51
  $(SUPPORT_OUTPUTDIR)/gensrc/$(MODULE)/$$(strip $2):
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    52
	$(MKDIR) -p $$(@D)
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    53
	$(PRINTF) "jdk=$(JDK_VERSION)\nfull=$(FULL_VERSION)\nrelease=$(RELEASE)\n" \
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    54
	    > $$@
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    55
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    56
  $$(strip $1) += $(SUPPORT_OUTPUTDIR)/gensrc/$(MODULE)/$$(strip $2)
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    57
endef
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    58
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    59
################################################################################
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    60
# Finds all properties files in the module source and creates a rule that runs
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    61
# CompileProperties on them into the gensrc dir.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    62
# Param 1 - Variable to add targets to
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    63
# Param 2 - Extra properties files to process
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    64
define SetupCompileProperties
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    65
  # Lookup the properties that need to be compiled into resource bundles.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    66
  PROPSOURCES := $2 $$(shell $(FIND) $(LANGTOOLS_TOPDIR)/src/$(MODULE)/share/classes -name "*.properties")
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    67
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    68
  # Convert .../src/<module>/share/classes/com/sun/tools/javac/resources/javac_zh_CN.properties
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    69
  # to .../langtools/gensrc/<module>/com/sun/tools/javac/resources/javac_zh_CN.java
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    70
  # Strip away prefix and suffix, leaving for example only: 
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    71
  # "<module>/share/classes/com/sun/tools/javac/resources/javac_zh_CN"
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    72
  PROPJAVAS := $$(patsubst $(LANGTOOLS_TOPDIR)/src/%, \
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    73
      $(SUPPORT_OUTPUTDIR)/gensrc/%, \
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    74
      $$(patsubst %.properties, %.java, \
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    75
      $$(subst /share/classes,, $$(PROPSOURCES))))
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    76
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    77
  # Generate the package dirs for the tobe generated java files. Sort to remove
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    78
  # duplicates.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    79
  PROPDIRS := $$(sort $$(dir $$(PROPJAVAS)))
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    80
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    81
  # Now generate a sequence of:
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    82
  # "-compile ...javac_zh_CN.properties ...javac_zh_CN.java java.util.ListResourceBundle"
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    83
  # suitable to be fed into the CompileProperties command.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    84
  PROPCMDLINE := $$(subst _SPACE_, $(SPACE), \
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    85
      $$(join $$(addprefix -compile_SPACE_, $$(PROPSOURCES)), \
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    86
      $$(addsuffix _SPACE_java.util.ListResourceBundle, \
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    87
      $$(addprefix _SPACE_, $$(PROPJAVAS)))))
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    88
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    89
  # Now setup the rule for the generation of the resource bundles.
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    90
  $(SUPPORT_OUTPUTDIR)/gensrc/$(MODULE)/_the_props: $$(PROPSOURCES)
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    91
	$(FIND) $$(@D) -name "*.java" $(FIND_DELETE)
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    92
	$(MKDIR) -p $$(@D) $$(PROPDIRS)
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    93
	$(ECHO) Compiling $$(words $$(PROPSOURCES)) properties into resource bundles for $(MODULE)
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    94
	$(TOOL_COMPILEPROPS_CMD) $$(PROPCMDLINE)
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    95
	$(TOUCH) $$@
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    96
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    97
  $$(strip $1) += $(SUPPORT_OUTPUTDIR)/gensrc/$(MODULE)/_the_props
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    98
endef
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
    99
d1a63c99cdd5 8049367: Modular Run-Time Images
chegar
parents:
diff changeset
   100
################################################################################
28334
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   101
# Parse property files in given location and generate a Java-like enum in the gensrc folder.
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   102
# Param 1 - Variable to add targets to
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   103
# Param 2 - Extra properties files to process
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   104
define SetupParseProperties
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   105
  #property file to generate
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   106
  PARSEPROPSOURCES := $$(foreach var,$2,$$(addsuffix $$(var),$(LANGTOOLS_TOPDIR)/src/$(MODULE)/share/classes/))  
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   107
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   108
  PARSEPROPALLDIRS := $$(patsubst $(LANGTOOLS_TOPDIR)/src/%, \
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   109
      $(SUPPORT_OUTPUTDIR)/gensrc/%, \
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   110
      $$(dir $$(PARSEPROPSOURCES)))
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   111
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   112
  PARSEPROPDIRS := $$(sort $$(PARSEPROPALLDIRS))
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   113
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   114
  PARSEPROPCMDLINE := $$(subst _SPACE_, $$(SPACE), \
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   115
    $$(join $$(foreach var,$$(PARSEPROPSOURCES),$$(addprefix -compile_SPACE_,$$(var))), \
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   116
    $$(addprefix _SPACE_, $$(PARSEPROPALLDIRS))))
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   117
  
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   118
  # Now setup the rule for the generation of the resource bundles.
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   119
  $(SUPPORT_OUTPUTDIR)/gensrc/$(MODULE)/_the_parsed_props: $(PARSEPROPSOURCES)
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   120
	$(CP) -r $(LANGTOOLS_TOPDIR)/make/tools/propertiesparser/resources $(BUILDTOOLS_OUTPUTDIR)/langtools_tools_classes/propertiesparser/resources
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   121
	$(MKDIR) -p $$(@D) $$(PARSEPROPDIRS)
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   122
	$(ECHO) Parsing $$(words $$(PARSEPROPSOURCES)) properties into enum-like class for $(MODULE)
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   123
	$(TOOL_PARSEPROPS_CMD) $$(PARSEPROPCMDLINE)
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   124
	$(TOUCH) $$@
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   125
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   126
  $$(strip $1) += $(SUPPORT_OUTPUTDIR)/gensrc/$(MODULE)/_the_parsed_props
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   127
endef
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   128
1633de6070ae 8058542: Devise scheme for better diagnostic creation
mcimadamore
parents: 27579
diff changeset
   129
################################################################################