shell-includes/messages.sh at master · dracorp/shell-includes · GitHub

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
#===============================================================================
# NAME
#        message.sh - Function to print various messages
#
# SYNOPSIS
#        . messages.sh
#
# DESCRIPTION
#   Do not use for Ksh shell!
#
# BUGS
#        https://github.com/dracorp/shell-includes/issues
#
# COPYRIGHT AND LICENSE
#        Copyright (C) 2010-2013 Victor Engmark
#
#        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/>.
#
#===============================================================================

: ${USE_COLOR=y}
# check if messages are to be printed using color {{{
if [[ -t 2 && ! $USE_COLOR = "n" ]]; then
    : echo "Nop"
else
    unset ALL_OFF BOLD BLUE GREEN RED YELLOW
fi

plain() {
    (( QUIET )) && return
    typeset CR="\n"
    if [[ "$1" == '-n' ]]; then
        CR='';shift
    fi
    typeset mesg=$1; shift
    printf "${BOLD}%s${ALL_OFF} %s${CR}" "$mesg" "$*" >&1
}

msg() {
    (( QUIET )) && return
    typeset CR="\n"
    if [[ "$1" == '-n' ]]; then
        CR='';shift
    fi
    typeset mesg=$1; shift
    printf "${GREEN}${ALL_OFF}${BOLD}%s${ALL_OFF} %s${CR}" "$mesg" "$*" >&1
}

INFO() {
    msg "INFO: $@"
}

msg2() {
    (( QUIET )) && return
    typeset CR="\n"
    if [[ "$1" == '-n' ]]; then
        CR='';shift
    fi
    typeset mesg=$1; shift
    printf "${BLUE}   ->${ALL_OFF}${BOLD}%s${ALL_OFF} %s${CR}" "$mesg" "$*" >&1
}

warning() {
    typeset CR="\n"
    if [[ "$1" == '-n' ]]; then
        CR='';shift
    fi
    typeset mesg=$1; shift
    printf "${YELLOW}$(gettext "WARNING:")${ALL_OFF}${BOLD} %s${ALL_OFF} %s${CR}" "$mesg" "$*" >&2
}

WARN() {
    warning "$@"
}

error() {
    typeset CR="\n"
    if [[ "$1" == '-n' ]]; then
        CR='';shift
    fi
    typeset mesg=$1; shift
    printf "${RED}$(gettext "ERROR:")${ALL_OFF}${BOLD} %s${ALL_OFF} %s${CR}" "$mesg" "$*" >&2
}

ERROR() {
    error "$@"
}

FAIL() {
    error "$@"
}

LOGEXIT() {
    error "$@"
    exit 1
    if [ "${BASH_SOURCE[0]}" == "$0" ]; then
        # invoked as script
        exit 1
    else
        # sourced by . or source command
        return 0
    fi
}