summaryrefslogtreecommitdiff
path: root/src/lib/libremessages
blob: 46a45fbc3abf7a93d3c1fe8b0d59db2285d6258d (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
#!/bin/bash -euE
#!/bin/bash
#   Copyright (c) 2002-2006 by Judd Vinet <jvinet@zeroflux.org>
#   Copyright (c) 2006-2010 Pacman Development Team <pacman-dev@archlinux.org>
#   Copyright (c) 2005 by Aurelien Foret <orelien@chez.com>
#   Copyright (c) 2005 by Christian Hamar <krics@linuxforum.hu>
#   Copyright (c) 2006 by Alex Smith <alex@alex-smith.me.uk>
#   Copyright (c) 2006 by Andras Voroskoi <voroskoi@frugalware.org>
#   Copyright (c) 2006 by Miklos Vajna <vmiklos@frugalware.org>
#   Copyright (c) 2011 by Joshua Haase <hahj87@gmail.com>
#   Copyright (c) 2012-2013 by Luke Shumaker <lukeshu@sbcglobal.net>
#
#   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 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 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/>.

################################################################################
# Inherit most functions from devtools                                         #
################################################################################

. $(librelib common.sh)

################################################################################
# Own functions                                                                #
################################################################################

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() {
	[[ $# -ge 1 ]] || panic
	local mesg="$(_ "$1")"
	shift
	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\\';;
		xterm*|rxvt*) fmt='\e]0;%s\a';;
	esac
	printf "$fmt" "$*"
}

################################################################################
# Run one of the defined functions if invoked directly                         #
################################################################################

if [[ "${0##*/}" == libremessages ]]; then
	_libremessages_cmd=$1
	shift
	"$_libremessages_cmd" "$@"
fi