summaryrefslogtreecommitdiff
path: root/build-aux/Makefile.once.head/00-quote.mk
blob: 4c954b1040e3596552d0d3ec76cedcfa8edef615 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# Copyright (C) 2016  Luke Shumaker
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

mod.quote.description = Macros to quote tricky strings
define mod.quote.doc
# Inputs:
#   (none)
# Outputs:
#   - Global variable: `quote.var`       : GNU Make variables
#   - Global variable: `quote.pattern`   : GNU Make patterns
#   - Global variable: `quote.ere`       : POSIX Extended Regular Expressions
#   - Global variable: `quote.bre`       : POSIX Basic Regular Expressions
#   - Global variable: `quote.shell`     : POSIX sh(1) strings
#   - Global variable: `quote.shell-each`: POSIX sh(1) strings
#
# Escaping/quoting things is hard!  This module provides a number of
# functions to escape/quote strings for various contexts.
#
# `quote.shell-each` quotes each list-item separately (munging
# whitespace), while `quote.shell` keeps them as one string (preserving
# whitespace).
endef

_quote.backslash = $(if $1,$(call _quote.backslash,$(wordlist 2,$(words $1),$1),$(subst $(firstword $1),\$(firstword $1),$2)),$2)

quote.var     = $(subst $(at.nl),\$(at.nl),$(subst $$,$$$$,$1))
quote.pattern = $(call _quote.backslash, \ % ,$1)
quote.ere     = $(call _quote.backslash, \ ^ . [ $$ ( ) | * + ? { ,$1)
quote.bre     = $(call _quote.backslash, \ ^ . [ $$       *       ,$1)

quote.shell-each = $(foreach _quote.tmp,$1,$(call quote.shell,$(_quote.tmp)))

# I put this as the last line in the file because it confuses Emacs
# syntax highlighting and makes the remainder of the file difficult to
# edit.
quote.shell = $(subst $(at.nl),'$$'\n'','$(subst ','\'',$1)')