From 4b9f4323abfaa0f4030cc29aed97e0716f9c5852 Mon Sep 17 00:00:00 2001
From: Luke Shumaker <LukeShu@sbcglobal.net>
Date: Wed, 11 Sep 2013 10:18:04 -0400
Subject: libremessages: add a few more message routines, and make them
 gettext-aware.

 - Don't set LANG=C in common.sh
 - Move TEXTDOMAIN stuff into common.sh; so devtools stuff will use it.
 - Add _(): Basically an alias for `gettext`, but falls back if gettext is
   not available.
 - Add panic(): First showed up in `distcc-tool`, does what it sounds like.
 - Add prose(), bullet(), and flag(): they do word wrapping and such to
   make it easy to internationalize `--help` text.
 - Teach common.mk how to make .pot files based on these routines.
---
 src/lib/Makefile         | 11 +++----
 src/lib/common.sh.bottom |  1 +
 src/lib/common.sh.top    | 12 ++++++++
 src/lib/libremessages    | 78 +++++++++++++++++++++++++++++++++++++++++-------
 4 files changed, 87 insertions(+), 15 deletions(-)
 create mode 100644 src/lib/common.sh.bottom

(limited to 'src')

diff --git a/src/lib/Makefile b/src/lib/Makefile
index d7b4049..255bc05 100644
--- a/src/lib/Makefile
+++ b/src/lib/Makefile
@@ -10,8 +10,9 @@ include ../../common.mk
 common.sh: %: %.in %.top Makefile
 	@echo "GEN $@"
 	@{ \
-	cat "$*.top" && \
-	echo 'if [[ -z $${_INCLUDE_COMMON_SH:-} ]]; then' && \
-	echo '_INCLUDE_COMMON_SH=true' && \
-	cat "$*.in" && \
-	echo 'fi'; } > "$@"
+	cat '$*.top' && \
+	echo && \
+	sed -r -e '/encoding problem/d;/LANG=/d' -e 's/mesg=\$$(.)/mesg="$$(_ "$$\1")"/' '$*.in' && \
+	echo && \
+	cat '$*.bottom' && \
+	:; } > '$@'
diff --git a/src/lib/common.sh.bottom b/src/lib/common.sh.bottom
new file mode 100644
index 0000000..e133fad
--- /dev/null
+++ b/src/lib/common.sh.bottom
@@ -0,0 +1 @@
+fi
diff --git a/src/lib/common.sh.top b/src/lib/common.sh.top
index d59268d..c335956 100644
--- a/src/lib/common.sh.top
+++ b/src/lib/common.sh.top
@@ -11,3 +11,15 @@
 # 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.
+
+if [[ -z ${_INCLUDE_COMMON_SH:-} ]]; then
+_INCLUDE_COMMON_SH=true
+
+export TEXTDOMAIN='libretools'
+export TEXTDOMAINDIR='/usr/share/locale'
+
+if type gettext &>/dev/null; then
+	_() { gettext "$@"; }
+else
+	_() { echo "$@"; }
+fi
diff --git a/src/lib/libremessages b/src/lib/libremessages
index c9b6b83..46a45fb 100755
--- a/src/lib/libremessages
+++ b/src/lib/libremessages
@@ -29,28 +29,86 @@
 
 . $(librelib common.sh)
 
-################################################################################
-# gettext initialization                                                       #
-################################################################################
-
-export TEXTDOMAIN='libretools'
-export TEXTDOMAINDIR='/usr/share/locale'
-
 ################################################################################
 # Own functions                                                                #
 ################################################################################
 
-# Usage: print fmt arg1 arg2...
+panic() {
+	echo "$(_ 'panic: malformed call to internal function')" >&2
+	exit 1
+}
+
+# Usage: print MESG ARG1 ARG2...
 # Like printf, but gettext-aware, and prints a trailing newline
 print() {
-	local fmt=$1
+	[[ $# -ge 1 ]] || panic
+	local mesg="$(_ "$1")"
 	shift
-	printf -- "$(gettext "$fmt")\n" "$@"
+	printf -- "$mesg\n" "$@"
+}
+
+# Do HTML-style whitespace collapsing on standard IO.  It considers newline,
+# tab, and space to be whitespace.
+_html_whitespace_collapse() {
+	[[ $# == 0 ]] || panic
+	tr '\n' ' ' | sed -r -e 's/\t/ /g' -e 's/  +/ /g'
+}
+
+
+# Usage: prose MESG
+# Do HTML-style whitespace collapsing on the first argument, translate it
+# (gettext), then word-wrap it to 75 columns.
+# This is useful for printing a paragraph of prose in --help text.
+prose() {
+	[[ $# -ge 1 ]] || panic
+	local mesg="$(_ "$(_html_whitespace_collapse <<<"$1")")"; shift
+	printf -- "$mesg" "$@" | fmt -u
+}
+
+# Usage: bullet MESG
+# Like prose, but print a bullet "-" before the first line, and indent the
+# remaining lines.
+bullet() {
+	[[ $# -ge 1 ]] || panic
+	local mesg="$(_ "$(_html_whitespace_collapse <<<"$1")")"; shift
+	# Wrap the text to 71 columns; 75 (the default) minus a 4 column indent
+	printf -- "$mesg" "$@" | fmt -u -w 71 | sed -e '1s/^/  - /' -e '2,$s/^/    /'
+}
+
+# Usage: flag FLAG DESCRIPTION
+# Print a flag and description formatted for --help text.
+#   ex: flag '-C <FILE>' 'Use this file instead of pacman.conf'
+# The description is fed through gettext, the flag is not, so if part of the
+# flag needs to be translated, you must do that yourself:
+#   ex: flag "-C <$(_ FILE)>" 'Use this file instead of pacman.conf'
+# If you want to line-break the description in the source, so it isn't
+# crazy-long, feel free, it is reflowed/wrapped the same way as prose and
+# bullet.
+flag() {
+	[[ $# == 2 ]] || panic
+	local n='
+'
+	local flag=$1
+	local desc="$(_ "$(_html_whitespace_collapse <<<"$2")")"
+
+	declare -i indent=13
+	while [[ $indent -le ${#flag} ]]; do
+		indent=$((indent+8))
+	done
+
+	local lines
+	IFS=$n lines=($(fmt -u -w $((73-indent)) <<<"$desc"))
+	local line
+	for line in "${lines[@]}"; do
+		printf "  %-${indent}s %s\n" "$flag" "$line"
+		flag=''
+	done
 }
 
 # Usage: term_title This will be the term title
 # Sets the terminal title
 term_title() {
+	[[ $# -ge 1 ]] || panic
 	local fmt=''
 	case "$TERM" in
 		screen|tmux) fmt='\ek%s\e\\';;
-- 
cgit v1.2.2