summaryrefslogtreecommitdiff
path: root/src/lib/librexgettext
blob: 27a701dc5be6a8188b8e4e1eb247ec57ab8b9095 (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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
#!/usr/bin/env bash
# Copyright (C) 2013-2017 Luke Shumaker <lukeshu@sbcglobal.net>
#
# License: GNU GPLv2+
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

# NB: During normal operation (i.e. not printing `usage()`) text, we
# don't use librelib.  This is important as we need to be able to run
# this program statically in-place when building libretools.

export TEXTDOMAIN='librelib'
export TEXTDOMAINDIR='/usr/share/locale'

default_simple=(
	--keyword={eval_,}{gettext,'ngettext:1,2'}
	--keyword={_,print,term_title}
	--keyword={msg,msg2,warning,error,stat_busy,die}
	--keyword={lock,slock}:3
)
default_prose=(--keyword={prose,bullet})

readonly default_simple default_prose

if ! type gettext &>/dev/null; then
	gettext() { echo "$@"; }
fi

errusage() {
	if [[ $# -gt 0 ]]; then
		fmt="$(gettext "$1")"; shift
		printf "${0##*/}: $fmt\n" "$@" >&2
	fi
	usage >&2
}

usage() {
	. "$(librelib messages)"
	print 'Usage: %s [OPTIONS] FILES...' "${0##*/}"
	print 'Generates .pot files for programs using libremessages'
	echo
	prose 'In librexgettext, there are 2 types of keywords:'
	bullet 'simple: Simple keywords are just like normal xgettext'
	bullet 'prose: Prose keywords are similar, but the text is
	        word-wrapped'
	prose 'The keyword format is the same as in GNU xgettext.'
	echo
	prose 'The libremessages `flag` command is also handled
	       specially, and is not configurable as a keyword.'
	echo
	prose 'The default simple keywords are: %s' "${default_simple[*]#--keyword=}"
	echo
	prose 'The default prose keywords are: %s' "${default_prose[*]#--keyword=}"
	echo
	print 'Options:'
	flag \
	    '--simple=KEYWORD' 'Look for KEYWORD as an additional simple keyword' \
	    '--prose=KEYWORD' 'Look for KEYWORD as an additional prose keyword' \
	    '-k' 'Disable using the default keywords' \
	    '-h, --help' 'Show this text'
}

xgettext-sh() {
	xgettext --omit-header --from-code=UTF-8 -L shell -k -o - "$@"
}

xgettext-flag() {
	local file="$1"
	{
		# Stage 1: Generate
		#
		# Get all of the arguments to `flag`.  Because `flag`
		# takes an arbitrary number of arguments, just iterate
		# through arg1, arg2, ... argN; until we've come up
		# empty 3 times.  Why 3?  Because each flag takes 2
		# arguments, and because we don't keep track of which
		# one of those we're on, waiting for 3 empties ensures
		# us that we've had a complete "round" with nothing.
		#
		# Why can't I just do i+=2, and not have to keep track
		# of empties?  Because, we also allow for arguments
		# ending in a colon to be headings, which changes the
		# offsets.
		declare -i empties=0
		declare -i i
		for (( i=1; empties < 3; i++ )); do
			local out
			out="$(xgettext-sh --keyword="flag:$i,\"$i\"" -- "$file")"
			if [[ -n $out ]]; then
				printf -- '%s\n' "$out"
				empties=0
			else
				empties+=1
			fi
		done
	} | whitespace-collapse | sed '/^\#, sh-format/d' | {
		# Stage 2: Parse
		#
		# Read in the lines, and group them into an array of
		# (multi-line) msgs.  This just makes working with
		# them easier.
		local msgs=()
		declare -i i=-1
		local re='^#\. ([0-9]+)$'
		IFS=''
		local line
		while read -r line; do
			if [[ $line =~ $re ]]; then
				i+=1
			fi
			msgs[$i]+="$line"$'\n'
		done
		# Stage 3: Sort
		#
		# Now, we have the `msgs` array, and it is
		# sorted such that it is all of the arg1's to `flag`,
		# then all of the arg2's, then all of the arg3's, and
		# so on.  We want to re-order them such that it's all
		# of the args for the first invocation then all of the
		# args for the second; and so on.
		#
		# We do this by simply sorting them by the location
		# that they appear in the file.  Then, when we see the
		# argument number go back down, we know that a new
		# invocation has started!
		local locations=()
		readarray -t locations < <(
			local i
			for i in "${!msgs[@]}"; do
				local lines=()
				readarray -t lines < <(printf '%s' "${msgs[$i]}")

				declare -i arg row
				arg=${lines[0]#'#. '}
				row=${lines[1]##*:}

				printf '%d %d %d\n' "$row" "$arg" "$i"
			done | sort -k 1n -k 2n
		)
		# Stage 4: Output
		#
		# Now, we prune out the arguments that aren't
		# localizable.  Also, remove the "#." comment lines.
		# As explained above (in stage 3), when we see $arg go
		# down, that's the beginning of a new invocation.
		local expectflag=true
		local prev_arg=0
		local prev_row=0 # for better error messages only; no real logic
		local location
		for location in "${locations[@]}"; do
			IFS=' '
			local row arg i
			read -r row arg i <<<"$location"
			local msg="${msgs[$i]#*$'\n'}"

			# See if we need to fiddle with $expectflag
			# (and do some sanity checking).
			if [[ $arg != "$((prev_arg+1))" ]]; then
				if ! $expectflag; then
					local pos
					if [[ $row != "$prev_row" ]]; then
						printf -v pos "%s:%d-%d" "$file" "$prev_row" "$row"
					else
						printf -v pos "%s:%d" "$file" "$prev_row"
					fi
					>&2 printf "%s: $(gettext "flag error: Missing expected flag meaning at argument %d")\n" \
					    "$pos" "$((prev_arg+1))"
					exit 1 # $EXIT_FAILURE
				elif [[ $arg == "$((prev_arg+2))" ]]; then
					# skipped flag argument
					expectflag=false
				elif [[ "$arg" == 1 ]]; then
					# started new invocation
					expectflag=true
				elif [[ $arg == 2 ]]; then
					# started new invocation and skipped flag argument
					expectflag=false
				else
					local pos
					if [[ $row != "$prev_row" ]]; then
						printf -v pos "%s:%d-%d" "$file" "$prev_row" "$row"
					else
						printf -v pos "%s:%d" "$file" "$prev_row"
					fi
					>&2 printf "%s: $(gettext "flag error: Jumped from argument %d to %d")\n" \
					    "$pos" "$prev_arg" "$arg"
					exit 1 # $EXIT_FAILURE
				fi
			fi
			prev_arg=$arg
			prev_row=$row

			# Now we operate based on $row, $arg, $msg,
			# and $expectflag.
			if $expectflag; then
				IFS=$'\n'
				local lines=(${msg})
				if [[ ${lines[1]} == *':"' ]]; then
					# We expected a flag, but got
					# a heading
					printf -- '%s\n' "$msg"
				else
					# We expected a flag, and got
					# one!
					expectflag=false
				fi
			else
				printf -- '%s\n' "$msg"
				expectflag=true
			fi
		done
		if ! $expectflag; then
			>&2 printf "%s:%d: $(gettext "flag error: Missing expected flag meaning at argument %d")\n" \
			    "$file" "$prev_row" \
			    "$((prev_arg+1))"
			exit 1 # $EXIT_FAILURE
		fi
	}
}

whitespace-collapse() {
	tr '\n' '\r' | sed 's/"\r\s*"//g' | tr '\r' '\n' | # This removes the awkward word-wrapping done by xgettext
	    sed -r -e 's/(\\n|\\t|\t)/ /g' -e 's/(^|[^.!? ]) +/\1 /g' -e 's/([.!?])  +/\1  /g' # This collapses whitespace
}

main() {
	set -euE -o pipefail
	local simple=()
	local prose=()
	local files=()
	local use_defaults=true
	local error=false

	declare -i i
	for (( i=1; i <= $#; i++ )); do
		case "${!i}" in
			--simple) i+=1; simple+=(--keyword="${!i}");;
			--simple=*)     simple+=(--keyword="${!i#*=}");;
			--prose) i+=1; prose+=(--keyword="${!i}");;
			--prose=*)     prose+=(--keyword="${!i#*=}");;
			-k) use_defaults=false;;
			--help|-h) usage; return 0;; # $EXIT_SUCCESS
			--) i+=1; break;;
			-*) errusage "unrecognized option: %s" "${!i}"; error=true;;
			*) files+=("${!i}");;
		esac
	done
	files+=("${@:$i}")
	if [[ ${#files[@]} -lt 1 ]]; then
		errusage "no input file given"
		error=true
	fi
	if "$error"; then
		return 1 # $EXIT_FAILURE
	fi
	if "$use_defaults"; then
		simple+=("${default_simple[@]}")
		prose+=("${default_prose[@]}")
	fi

	# Main code
	{
		xgettext-sh "${simple[@]}" -- "${files[@]}"
		xgettext-sh "${prose[@]}" -- "${files[@]}" | whitespace-collapse
		for file in "${files[@]}"; do
			xgettext-flag "$file"
		done
	} | sed '/^\#, sh-format/d' | msguniq -Fi --to-code=UTF-8
}

main "$@"