1 #
   2 # Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.
   3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 #
   5 # This code is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License version 2 only, as
   7 # published by the Free Software Foundation.  Oracle designates this
   8 # particular file as subject to the "Classpath" exception as provided
   9 # by Oracle in the LICENSE file that accompanied this code.
  10 #
  11 # This code is distributed in the hope that it will be useful, but WITHOUT
  12 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 # version 2 for more details (a copy is included in the LICENSE file that
  15 # accompanied this code).
  16 #
  17 # You should have received a copy of the GNU General Public License version
  18 # 2 along with this work; if not, write to the Free Software Foundation,
  19 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20 #
  21 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22 # or visit www.oracle.com if you need additional information or have any
  23 # questions.
  24 #
  25 
  26 ifeq (,$(_MAKEBASE_GMK))
  27   $(error You must include MakeBase.gmk prior to including TextFileProcessing.gmk)
  28 endif
  29 
  30 # Helper function for SetupTextFileProcessing; adds a rule for a single file
  31 # to be processed.
  32 # param 1 = The namespace argument, e.g. BUILD_VERSION_FILE
  33 # param 2 = the source file name (full path)
  34 # param 3 = the target base directory
  35 # param 4 = the target file name (possibly with a partial path)
  36 define SetupSingleTextFileForProcessing
  37   $(strip $3)/$(strip $4): $2 $$($1_VARDEPS_FILE)
  38         $$(call LogInfo, Processing $(strip $4))
  39         $$(call MakeDir, $$(@D))
  40         $(RM) '$$@' '$$@.includes.tmp' '$$@.replacements.tmp' ; \
  41         $$($1_INCLUDES_COMMAND_LINE) < '$$<' > '$$@.includes.tmp' ; \
  42         $$($1_REPLACEMENTS_COMMAND_LINE) < '$$@.includes.tmp' > '$$@.replacements.tmp' ; \
  43         $(RM) '$$@.includes.tmp' ; \
  44         $(MV) '$$@.replacements.tmp' '$$@'
  45 
  46   $1 += $(strip $3)/$(strip $4)
  47 endef
  48 
  49 # Setup make rules for processing one or more text files, in which specified
  50 # markers are replaced with a given text, or with the contents of a given file.
  51 #
  52 # Parameter 1 is the name of the rule. This name is used as variable prefix,
  53 # and the targets generated are listed in a variable by that name.
  54 #
  55 # Remaining parameters are named arguments. These include:
  56 #   SOURCE_DIRS one or more directory roots to search for files to process
  57 #   SOURCE_FILES complete paths to one or more files to process
  58 #   OUTPUT_DIR the directory where we store the processed files.
  59 #   OUTPUT_FILE the name of the resulting file. Only allowed if processing a
  60 #       single file.
  61 #   SOURCE_BASE_DIR a common root to all SOURCE_DIRS or SOURCE_FILES.
  62 #       If specified, files will keep the path relative to the base in the
  63 #       OUTPUT_DIR. Otherwise, the hierarchy will be flattened into the OUTPUT_DIR.
  64 #   INCLUDE_FILES only include files matching these patterns (used only with
  65 #       SOURCE_DIRS)
  66 #   EXCLUDE_FILES exclude files matching these patterns (used only with
  67 #       SOURCE_DIRS)
  68 #   INCLUDES replace the occurances of a pattern with the contents of a file;
  69 #       one or more such include pattern, using the syntax:
  70 #       PLACEHOLDER => FILE_TO_INCLUDE ; ...
  71 #       Each PLACEHOLDER must be on a single, otherwise empty line (whitespace
  72 #       padding is allowed).
  73 #   REPLACEMENTS one or more text replacement patterns, using the syntax:
  74 #       PATTERN => REPLACEMENT_TEXT ; ...
  75 #
  76 #   If both INCLUDES or REPLACEMENTS are present, then the includes will be
  77 #   processed first, and replacements will be done on the included fragments as well.
  78 #   If neither is present, the files will just be copied without modifications.
  79 #
  80 SetupTextFileProcessing = $(NamedParamsMacroTemplate)
  81 define SetupTextFileProcessingBody
  82 
  83   ifneq ($$($1_SOURCE_FILES),)
  84     ifneq ($$($1_SOURCE_DIRS),)
  85       $$(error Cannot use both SOURCE_FILES and SOURCE_DIRS (in $1))
  86     endif
  87     ifneq ($$($1_EXCLUDE_FILES)$$($1_INCLUDE_FILES),)
  88       $$(error Cannot INCLUDE/EXCLUDE_FILES with SOURCE_FILES (in $1))
  89     endif
  90   else
  91     ifeq ($$($1_SOURCE_DIRS),)
  92       $$(error Must specify either SOURCE_FILES or SOURCE_DIRS (in $1))
  93     endif
  94     # Find all files in the source trees. Sort to remove duplicates.
  95     $$(foreach src, $$($1_SOURCE_DIRS), $$(if $$(wildcard $$(src)), , \
  96         $$(error SOURCE_DIRS contains missing directory $$(src) (in $1))))
  97     ifneq ($$($1_SOURCE_BASE_DIR),)
  98       $$(foreach src, $$($1_SOURCE_DIRS), \
  99           $$(if $$(findstring $$($1_SOURCE_BASE_DIR), $$(src)), , \
 100           $$(error SOURCE_DIRS contains directory $$(src) outside \
 101               SOURCE_BASE_DIR $$($1_SOURCE_BASE_DIR) (in $1))))
 102     endif
 103     $1_SOURCE_FILES := $$(sort $$(call FindFiles,$$($1_SOURCE_DIRS)))
 104     $1_EXCLUDE_FILES:=$$(foreach i,$$($1_SOURCE_DIRS),$$(addprefix $$i/,$$($1_EXCLUDE_FILES)))
 105     $1_INCLUDE_FILES:=$$(foreach i,$$($1_SOURCE_DIRS),$$(addprefix $$i/,$$($1_INCLUDE_FILES)))
 106     $1_SOURCE_FILES := $$(filter-out $$($1_EXCLUDE_FILES),$$($1_SOURCE_FILES))
 107     ifneq (,$$(strip $$($1_INCLUDE_FILES)))
 108       $1_SOURCE_FILES := $$(filter $$($1_INCLUDE_FILES),$$($1_SOURCE_FILES))
 109     endif
 110     ifeq (,$$($1_SOURCE_FILES))
 111       $$(info No sources found for $1 when looking inside the dirs $$($1_SRC))
 112     endif
 113   endif
 114 
 115   ifneq ($$($1_REPLACEMENTS),)
 116     # We have a replacement request, prepare it for the recipe
 117     ifneq ($$(findstring /,$$($1_REPLACEMENTS)),)
 118       # Cannot use / as separator
 119       ifneq ($$(findstring @,$$($1_REPLACEMENTS)),)
 120         # Cannot use @ as separator
 121         ifneq ($$(findstring |,$$($1_REPLACEMENTS)),)
 122           # Cannot use | as separator
 123           ifneq ($$(findstring !,$$($1_REPLACEMENTS)),)
 124             # Cannot use ! as separator. Give up.
 125             $$(error No suitable sed separator can be found for $1. Tested /, @, | and !)
 126           else
 127             $1_SEP := !
 128           endif
 129         else
 130           $1_SEP := |
 131         endif
 132       else
 133         $1_SEP := @
 134       endif
 135     else
 136       $1_SEP := /
 137     endif
 138 
 139     # If we have a trailing "=>" (i.e. last rule replaces with empty, and is not
 140     # terminated by a ;), add a trailing ; to minimize the number of corner
 141     # cases in the hairy subst expression..
 142     ifeq ($$(lastword $$($1_REPLACEMENTS)), =>)
 143       $1_REPLACEMENTS += ;
 144     endif
 145 
 146     # If we have a trailing ";", add a dummy replacement, since there is no easy
 147     # way to delete the last word in make.
 148     ifeq ($$(lastword $$($1_REPLACEMENTS)), ;)
 149       $1_REPLACEMENTS += DUMMY_REPLACEMENT => DUMMY_REPLACEMENT
 150     endif
 151 
 152     # Convert the REPLACEMENTS syntax ( A => B ; C => D ; ...) to a sed command
 153     # line (-e "s/A/B/g" -e "s/C/D/g" ...), basically by replacing '=>' with '/'
 154     # and ';' with '/g" -e "s/', and adjusting for edge cases.
 155     # '&' has special meaning in sed so needs to be escaped.
 156     $1_REPLACEMENTS_COMMAND_LINE := $(SED) -e 's$$($1_SEP)$$(subst $$(SPACE);$$(SPACE),$$($1_SEP)g' \
 157         -e 's$$($1_SEP),$$(subst $$(SPACE)=>$$(SPACE),$$($1_SEP),$$(subst $$(SPACE)=>$$(SPACE);$$(SPACE),$$($1_SEP)$$($1_SEP)g' \
 158         -e 's$$($1_SEP),$$(subst &,\&,$$(strip $$($1_REPLACEMENTS))))))$$($1_SEP)g'
 159   else
 160     # We don't have any replacements, just pipe the file through cat.
 161     $1_REPLACEMENTS_COMMAND_LINE := $(CAT)
 162   endif
 163 
 164   ifneq ($$($1_INCLUDES),)
 165     # We have a include request, prepare it for the recipe.
 166     # Convert an INCLUDE like this PATTERN_1 => file1 ; PATTERN_2 => file2 ;
 167     # into an awk script fragment like this:
 168     # {
 169     #   if (matches("PATTERN_1")) { include("file1") } else
 170     #   if (matches("PATTERN_2")) { include("file2") } else
 171     #   print
 172     # }
 173 
 174     $1_INCLUDES_HEADER_AWK := \
 175         function matches(pattern) { return ($$$$0 ~ "^[ \t]*" pattern "[ \t]*$$$$") } \
 176         function include(filename) { while ((getline < filename) == 1) print ; close(filename) }
 177     $1_INCLUDES_PARTIAL_AWK := $$(subst $$(SPACE);,,$$(subst $$(SPACE)=>$$(SPACE),"$$(RIGHT_PAREN)$$(RIGHT_PAREN) \
 178         { include$$(LEFT_PAREN)",$$(subst $$(SPACE);$$(SPACE),"$$(RIGHT_PAREN) } \
 179         else if $$(LEFT_PAREN)matches$$(LEFT_PAREN)",$$(strip $$($1_INCLUDES)))))
 180     $1_INCLUDES_COMMAND_LINE := $(NAWK) '$$($1_INCLUDES_HEADER_AWK) \
 181         { if (matches("$$($1_INCLUDES_PARTIAL_AWK)") } else print }'
 182   else
 183     # We don't have any includes, just pipe the file through cat.
 184     $1_INCLUDES_COMMAND_LINE := $(CAT)
 185   endif
 186 
 187   $1_VARDEPS := $$($1_INCLUDES_COMMAND_LINE) $$($1_REPLACEMENTS_COMMAND_LINE)
 188   $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS)
 189 
 190   # Reset target list before populating it
 191   $1 :=
 192 
 193   ifneq ($$($1_OUTPUT_FILE),)
 194     ifneq ($$(words $$($1_SOURCE_FILES)), 1)
 195       $$(error Cannot use OUTPUT_FILE for more than one source file (in $1))
 196     endif
 197 
 198     # Note that $1 is space sensitive and must disobey whitespace rules
 199     $$(eval $$(call SetupSingleTextFileForProcessing,$1, $$($1_SOURCE_FILES), \
 200         $$(patsubst %/, %, $$(dir $$($1_OUTPUT_FILE))), $$(notdir $$($1_OUTPUT_FILE))))
 201   else
 202     ifeq ($$($1_OUTPUT_DIR),)
 203       $$(error Neither OUTPUT_FILE nor OUTPUT_DIR was specified (in $1))
 204     endif
 205 
 206     # Now call add_native_source for each source file we are going to process.
 207     ifeq ($$($1_SOURCE_BASE_DIR),)
 208       # With no base dir specified, put all files in target dir, flattening any
 209       # hierarchies. Note that $1 is space sensitive and must disobey whitespace
 210       # rules.
 211       $$(foreach src, $$($1_SOURCE_FILES), \
 212           $$(eval $$(call SetupSingleTextFileForProcessing,$1, $$(src), \
 213               $$(patsubst %/, %, $$($1_OUTPUT_DIR)), $$(notdir $$(src)))))
 214     else
 215       # With a base dir, extract the relative portion of the path. Note that $1
 216       # is space sensitive and must disobey whitespace rules, and so is the
 217       # arguments to patsubst.
 218       $$(foreach src, $$($1_SOURCE_FILES), \
 219           $$(eval $$(call SetupSingleTextFileForProcessing,$1, $$(src), \
 220               $$(patsubst %/, %, $$($1_OUTPUT_DIR)), \
 221               $$(patsubst $$($1_SOURCE_BASE_DIR)/%,%,$$(src)))))
 222     endif
 223   endif
 224 endef