1 # Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved. 2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3 # 4 # This code is free software; you can redistribute it and/or modify it 5 # under the terms of the GNU General Public License version 2 only, as 6 # published by the Free Software Foundation. Oracle designates this 7 # particular file as subject to the "Classpath" exception as provided 8 # by Oracle in the LICENSE file that accompanied this code. 9 # 10 # This code is distributed in the hope that it will be useful, but WITHOUT 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 # version 2 for more details (a copy is included in the LICENSE file that 14 # accompanied this code). 15 # 16 # You should have received a copy of the GNU General Public License version 17 # 2 along with this work; if not, write to the Free Software Foundation, 18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 19 # 20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 21 # or visit www.oracle.com if you need additional information or have any 22 # questions. 23 # 24 25 ifeq (,$(_MAKEBASE_GMK)) 26 $(error You must include MakeBase.gmk prior to including ProcessMarkdown.gmk) 27 endif 28 29 # Helper function for SetupProcessMarkdown 30 # $1: The $1 from SetupProcessMarkdown 31 # $2: The name of the current source file, relative to $1_SRC 32 define ProcessMarkdown 33 $1_$2_OUTPUT_FILE := $$($1_DEST)/$$(basename $2).html 34 $1_$2_TARGET_DIR := $$(dir $$($1_$2_OUTPUT_FILE)) 35 ifneq ($$($1_CSS), ) 36 ifneq ($$(findstring http:/, $$($1_CSS)), ) 37 $1_$2_CSS_OPTION := --css '$$($1_CSS)' 38 else 39 $1_$2_CSS := $$(strip $$(call RelativePath, $$($1_CSS), $$($1_$2_TARGET_DIR))) 40 $1_$2_CSS_OPTION := --css '$$($1_$2_CSS)' 41 endif 42 endif 43 $1_$2_OPTIONS = $$(shell $$(GREP) _pandoc-options_: $$($1_SRC)/$2 | $$(CUT) -d : -f 2-) 44 $1_$2_MARKER := $$(subst /,_,$1_$2) 45 46 $1_$2_VARDEPS := $$($1_OPTIONS) $$($1_CSS) 47 $1_$2_VARDEPS_FILE := $$(call DependOnVariable, $1_$2_VARDEPS, \ 48 $$(SUPPORT_OUTPUTDIR)/markdown/$$($1_$2_MARKER).vardeps) 49 50 $$($1_$2_OUTPUT_FILE): $$($1_SRC)/$2 $$($1_$2_VARDEPS_FILE) 51 $$(call LogInfo, Converting $2 to html) 52 $$(call MakeDir, $$($1_$2_TARGET_DIR) $$(SUPPORT_OUTPUTDIR)/markdown) 53 $$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/markdown/$$($1_$2_MARKER), \ 54 $$(PANDOC) $$($1_OPTIONS) -f markdown -t html5 --standalone \ 55 $$($1_$2_CSS_OPTION) $$($1_$2_OPTIONS) '$$<' -o '$$@') 56 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),) 57 TOO_LONG_LINES=`$$(GREP) -E -e '^.{80}.+$$$$' $$<` || true ; \ 58 if [ "x$$$$TOO_LONG_LINES" != x ]; then \ 59 $$(ECHO) "Warning: Unsuitable markdown in $$<:" ; \ 60 $$(ECHO) "The following lines are longer than 80 characters:" ; \ 61 $$(GREP) -E -n -e '^.{80}.+$$$$' $$< || true ; \ 62 fi 63 endif 64 65 $1 += $$($1_$2_OUTPUT_FILE) 66 endef 67 68 ################################################################################ 69 # Setup make rules for converting a markdown file to html. 70 # 71 # Parameter 1 is the name of the rule. This name is used as variable prefix, 72 # and the targets generated are listed in a variable by that name. 73 # 74 # Remaining parameters are named arguments. These include: 75 # SRC : Source root dir (defaults to dir of first file) 76 # DEST : Dest root dir 77 # FILES : List of files to copy with absolute paths, or path relative to SRC. 78 # Must be in SRC. 79 # OPTIONS : Additional options to pandoc 80 # 81 SetupProcessMarkdown = $(NamedParamsMacroTemplate) 82 define SetupProcessMarkdownBody 83 ifeq ($$($1_FILES), ) 84 $$(error FILES is missing in SetupProcessMarkdown $1) 85 endif 86 87 ifeq ($$($1_DEST), ) 88 $$(error DEST is missing in SetupProcessMarkdown $1) 89 endif 90 91 # Default SRC to the dir of the first file. 92 ifeq ($$($1_SRC), ) 93 $1_SRC := $$(dir $$(firstword $$($1_FILES))) 94 endif 95 96 # Remove any trailing slash from SRC and DEST 97 $1_SRC := $$(patsubst %/,%,$$($1_SRC)) 98 $1_DEST := $$(patsubst %/,%,$$($1_DEST)) 99 100 $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \ 101 $$(eval $$(call ProcessMarkdown,$1,$$f)) \ 102 ) 103 endef | 1 # Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved. 2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3 # 4 # This code is free software; you can redistribute it and/or modify it 5 # under the terms of the GNU General Public License version 2 only, as 6 # published by the Free Software Foundation. Oracle designates this 7 # particular file as subject to the "Classpath" exception as provided 8 # by Oracle in the LICENSE file that accompanied this code. 9 # 10 # This code is distributed in the hope that it will be useful, but WITHOUT 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 # version 2 for more details (a copy is included in the LICENSE file that 14 # accompanied this code). 15 # 16 # You should have received a copy of the GNU General Public License version 17 # 2 along with this work; if not, write to the Free Software Foundation, 18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 19 # 20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 21 # or visit www.oracle.com if you need additional information or have any 22 # questions. 23 # 24 25 ifeq (,$(_MAKEBASE_GMK)) 26 $(error You must include MakeBase.gmk prior to including ProcessMarkdown.gmk) 27 endif 28 29 include TextFileProcessing.gmk 30 31 # Helper function for SetupProcessMarkdown 32 # $1: The $1 from SetupProcessMarkdown 33 # $2: The name of the current source file, relative to the dir given in $3 34 # $3: The directory of the current source file 35 define ProcessMarkdown 36 $1_$2_OUTPUT_FILE := $$($1_DEST)/$$(basename $2)$$($1_FILE_EXT) 37 $1_$2_TARGET_DIR := $$(dir $$($1_$2_OUTPUT_FILE)) 38 $1_$2_INPUT_FILE := $3/$2 39 $1_$2_MARKER := $$(subst /,_,$1_$2) 40 41 ifneq ($$($1_REPLACEMENTS), ) 42 $1_$2_PANDOC_INPUT := $$(SUPPORT_OUTPUTDIR)/markdown/$$($1_$2_MARKER)_pre.tmp 43 44 $$(eval $$(call SetupTextFileProcessing, $1_$2_PREPROCESSED, \ 45 SOURCE_FILES := $$($1_$2_INPUT_FILE), \ 46 OUTPUT_FILE := $$($1_$2_PANDOC_INPUT), \ 47 REPLACEMENTS := $$($1_REPLACEMENTS), \ 48 )) 49 else 50 $1_$2_PANDOC_INPUT := $$($1_$2_INPUT_FILE) 51 endif 52 53 ifneq ($$($1_POST_PROCESS), ) 54 $1_$2_PANDOC_OUTPUT := $$(SUPPORT_OUTPUTDIR)/markdown/$$($1_$2_MARKER)_post.tmp 55 else 56 $1_$2_PANDOC_OUTPUT := $$($1_$2_OUTPUT_FILE) 57 endif 58 59 ifneq ($$($1_CSS), ) 60 ifneq ($$(findstring http:/, $$($1_CSS)), ) 61 $1_$2_CSS_OPTION := --css '$$($1_CSS)' 62 else 63 $1_$2_CSS := $$(strip $$(call RelativePath, $$($1_CSS), $$($1_$2_TARGET_DIR))) 64 $1_$2_CSS_OPTION := --css '$$($1_$2_CSS)' 65 endif 66 endif 67 68 $1_$2_OPTIONS := $$(shell $$(GREP) _pandoc-options_: $3/$2 | $$(CUT) -d : -f 2-) 69 70 ifneq ($$($1_FILTER), ) 71 $1_$2_OPTIONS += --filter $$($1_FILTER) 72 endif 73 74 $1_$2_VARDEPS := $$($1_OPTIONS) $$($1_$2_OPTIONS) $$($1_CSS) \ 75 $$($1_REPLACEMENTS) $$($1_POST_PROCESS) 76 $1_$2_VARDEPS_FILE := $$(call DependOnVariable, $1_$2_VARDEPS, \ 77 $$(SUPPORT_OUTPUTDIR)/markdown/$$($1_$2_MARKER).vardeps) 78 79 $$($1_$2_PANDOC_OUTPUT): $$($1_$2_PANDOC_INPUT) $$($1_$2_VARDEPS_FILE) $$($1_EXTRA_DEPS) 80 $$(call LogInfo, Converting $2 to $$($1_FORMAT)) 81 $$(call MakeDir, $$(SUPPORT_OUTPUTDIR)/markdown $$(dir $$($1_$2_PANDOC_OUTPUT))) 82 $$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/markdown/$$($1_$2_MARKER), \ 83 $$(PANDOC) $$($1_OPTIONS) -f markdown -t $$($1_FORMAT) --standalone \ 84 $$($1_$2_CSS_OPTION) $$($1_$2_OPTIONS) '$$($1_$2_PANDOC_INPUT)' \ 85 -o '$$($1_$2_PANDOC_OUTPUT)') 86 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),) 87 TOO_LONG_LINES=`$$(GREP) -E -e '^.{80}.+$$$$' $$<` || true ; \ 88 if [ "x$$$$TOO_LONG_LINES" != x ]; then \ 89 $$(ECHO) "Warning: Unsuitable markdown in $$<:" ; \ 90 $$(ECHO) "The following lines are longer than 80 characters:" ; \ 91 $$(GREP) -E -n -e '^.{80}.+$$$$' $$< || true ; \ 92 fi 93 endif 94 95 # If we have no post processing, PANDOC_OUTPUT is set to OUTPUT_FILE. Otherwise 96 # PANDOC_OUTPUT is a temporary file, and we must now create the real OUTPUT_FILE. 97 ifneq ($$($1_POST_PROCESS), ) 98 $$($1_$2_OUTPUT_FILE): $$($1_$2_PANDOC_OUTPUT) 99 $$(call LogInfo, Post-processing markdown file $2) 100 $$(call MakeDir, $$(SUPPORT_OUTPUTDIR)/markdown $$($1_$2_TARGET_DIR)) 101 $$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/markdown/$$($1_$2_MARKER)_post, \ 102 $$($1_POST_PROCESS) < $$($1_$2_PANDOC_OUTPUT) > $$($1_$2_OUTPUT_FILE)) 103 endif 104 105 $1 += $$($1_$2_OUTPUT_FILE) 106 endef 107 108 ################################################################################ 109 # Setup make rules for converting a markdown file to html. 110 # 111 # Parameter 1 is the name of the rule. This name is used as variable prefix, 112 # and the targets generated are listed in a variable by that name. 113 # 114 # Remaining parameters are named arguments. These include: 115 # DEST : Destination root dir 116 # FILES : List of files to copy with absolute paths, or path relative to SRC. 117 # SRC : Source root dir; if given keep input files hierarchy relative to 118 # SRC in DEST, otherwise flatten structure into DEST. 119 # FORMAT : The target format (defaults to html5) 120 # FILE_EXT : The file extension to replace .md with (defaults to .html) 121 # OPTIONS : Additional options to pandoc 122 # EXTRA_DEPS : Additional dependencies to add to each pandoc call 123 # FILTER : Optional pandoc filter command 124 # POST_PROCESS : Optional command-line to post-process generated markdown 125 # REPLACEMENTS : Text replacements to perform on input file before processing 126 # 127 SetupProcessMarkdown = $(NamedParamsMacroTemplate) 128 define SetupProcessMarkdownBody 129 ifeq ($$($1_FILES), ) 130 $$(error FILES is missing in SetupProcessMarkdown $1) 131 endif 132 133 ifeq ($$($1_DEST), ) 134 $$(error DEST is missing in SetupProcessMarkdown $1) 135 endif 136 137 # If no target format is specified, default to html5. 138 ifeq ($$($1_FORMAT), ) 139 $1_FORMAT := html5 140 endif 141 142 ifeq ($$($1_FORMAT), man) 143 # If no file extension is specified, default to '.1'. 144 ifeq ($$($1_FILE_EXT), ) 145 $1_FILE_EXT := .1 146 endif 147 else ifeq ($$($1_FORMAT), html5) 148 ifeq ($$($1_FILE_EXT), ) 149 $1_FILE_EXT := .html 150 endif 151 else ifeq ($$($1_FORMAT), html) 152 ifeq ($$($1_FILE_EXT), ) 153 $1_FILE_EXT := .html 154 endif 155 endif 156 157 # Remove any trailing slash 158 $1_DEST := $$(patsubst %/,%,$$($1_DEST)) 159 160 ifeq ($$($1_SRC), ) 161 # No SRC given, assume we're flattening all files into output dir. 162 $$(foreach f, $$($1_FILES), \ 163 $$(eval $$(call ProcessMarkdown,$1,$$(notdir $$f),$$(patsubst %/,%,$$(dir $$f)))) \ 164 ) 165 else 166 # Remove any trailing slash 167 $1_SRC := $$(patsubst %/,%,$$($1_SRC)) 168 169 $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \ 170 $$(eval $$(call ProcessMarkdown,$1,$$f,$$($1_SRC))) \ 171 ) 172 endif 173 endef |