1 # SPDX-License-Identifier: GPL-2.0-or-later WITH LicenseRef-Autoconf-exception-macro
2 # SPDX-FileCopyrightText: 2019 Philippe Proulx <pproulx@efficios.com>
3 # Pretty printing macros.
5 # Author: Philippe Proulx <pproulx@efficios.com>
9 # PPRINT_INIT(): initializes the pretty printing system.
11 # Use this macro before using any other PPRINT_* macro.
12 AC_DEFUN([PPRINT_INIT], [
13 m4_define([PPRINT_CONFIG_TS], [50])
14 m4_define([PPRINT_CONFIG_INDENT], [2])
18 # find tput, which tells us if colors are supported and gives us color codes
19 AC_PATH_PROG([pprint_tput], [tput])
21 AS_IF([test -n "$pprint_tput"], [
22 AS_IF([test -n "$PS1" && test `"$pprint_tput" colors` -eq 256 && test -t 1], [
23 # interactive shell and colors supported and standard output
24 # file descriptor is opened on a terminal
25 PPRINT_COLOR_TXTBLK="`"$pprint_tput" setaf 0`"
26 PPRINT_COLOR_TXTBLU="`"$pprint_tput" setaf 4`"
27 PPRINT_COLOR_TXTGRN="`"$pprint_tput" setaf 2`"
28 PPRINT_COLOR_TXTCYN="`"$pprint_tput" setaf 6`"
29 PPRINT_COLOR_TXTRED="`"$pprint_tput" setaf 1`"
30 PPRINT_COLOR_TXTPUR="`"$pprint_tput" setaf 5`"
31 PPRINT_COLOR_TXTYLW="`"$pprint_tput" setaf 3`"
32 PPRINT_COLOR_TXTWHT="`"$pprint_tput" setaf 7`"
33 PPRINT_COLOR_BLD=`"$pprint_tput" bold`
34 PPRINT_COLOR_BLDBLK="$PPRINT_COLOR_BLD$PPRINT_COLOR_TXTBLK"
35 PPRINT_COLOR_BLDBLU="$PPRINT_COLOR_BLD$PPRINT_COLOR_TXTBLU"
36 PPRINT_COLOR_BLDGRN="$PPRINT_COLOR_BLD$PPRINT_COLOR_TXTGRN"
37 PPRINT_COLOR_BLDCYN="$PPRINT_COLOR_BLD$PPRINT_COLOR_TXTCYN"
38 PPRINT_COLOR_BLDRED="$PPRINT_COLOR_BLD$PPRINT_COLOR_TXTRED"
39 PPRINT_COLOR_BLDPUR="$PPRINT_COLOR_BLD$PPRINT_COLOR_TXTPUR"
40 PPRINT_COLOR_BLDYLW="$PPRINT_COLOR_BLD$PPRINT_COLOR_TXTYLW"
41 PPRINT_COLOR_BLDWHT="$PPRINT_COLOR_BLD$PPRINT_COLOR_TXTWHT"
42 PPRINT_COLOR_RST="`"$pprint_tput" sgr0`"
45 PPRINT_YES_MSG="$PPRINT_COLOR_BLDGRN$PPRINT_YES_MSG$PPRINT_COLOR_RST"
46 PPRINT_NO_MSG="$PPRINT_COLOR_BLDRED$PPRINT_NO_MSG$PPRINT_COLOR_RST"
49 PPRINT_COLOR_SUBTITLE="$PPRINT_COLOR_BLDCYN"
54 # PPRINT_SET_INDENT(indent): sets the current indentation.
56 # Use PPRINT_INIT() before using this macro.
57 AC_DEFUN([PPRINT_SET_INDENT], [
58 m4_define([PPRINT_CONFIG_INDENT], [$1])
61 # PPRINT_SET_TS(ts): sets the current tab stop.
63 # Use PPRINT_INIT() before using this macro.
64 AC_DEFUN([PPRINT_SET_TS], [
65 m4_define([PPRINT_CONFIG_TS], [$1])
68 # PPRINT_SUBTITLE(subtitle): pretty prints a subtitle.
70 # The subtitle is put as is in a double-quoted shell string so the user
73 # Use PPRINT_INIT() before using this macro.
74 AC_DEFUN([PPRINT_SUBTITLE], [
75 AS_ECHO(["${PPRINT_COLOR_SUBTITLE}$1$PPRINT_COLOR_RST"])
78 AC_DEFUN([_PPRINT_INDENT], [
79 m4_if(PPRINT_CONFIG_INDENT, 0, [
81 m4_for([pprint_i], [0], m4_eval(PPRINT_CONFIG_INDENT * 2 - 1), [1], [
87 # PPRINT_PROP_STRING(title, value, title_color?): pretty prints a
90 # The title is put as is in a double-quoted shell string so the user
93 # The $PPRINT_CONFIG_INDENT variable must be set to the desired indentation
96 # Use PPRINT_INIT() before using this macro.
97 AC_DEFUN([PPRINT_PROP_STRING], [
98 m4_pushdef([pprint_title], [$1])
99 m4_pushdef([pprint_value], [$2])
100 m4_pushdef([pprint_title_color], m4_default([$3], []))
101 m4_pushdef([pprint_title_len], m4_len(pprint_title))
102 m4_pushdef([pprint_spaces_cnt], m4_eval(PPRINT_CONFIG_TS - pprint_title_len - (PPRINT_CONFIG_INDENT * 2) - 1))
104 m4_if(m4_eval(pprint_spaces_cnt <= 0), [1], [
105 m4_define([pprint_spaces_cnt], [1])
108 m4_pushdef([pprint_spaces], [])
110 m4_for([pprint_i], 0, m4_eval(pprint_spaces_cnt - 1), [1], [
111 m4_append([pprint_spaces], [ ])
116 AS_ECHO_N(["pprint_title_color""pprint_title$PPRINT_COLOR_RST:pprint_spaces"])
117 AS_ECHO(["${PPRINT_COLOR_BLD}pprint_value$PPRINT_COLOR_RST"])
119 m4_popdef([pprint_spaces])
120 m4_popdef([pprint_spaces_cnt])
121 m4_popdef([pprint_title_len])
122 m4_popdef([pprint_title_color])
123 m4_popdef([pprint_value])
124 m4_popdef([pprint_title])
127 # PPRINT_PROP_BOOL(title, value, title_color?): pretty prints a boolean
130 # The title is put as is in a double-quoted shell string so the user
133 # The value is evaluated at shell runtime. Its evaluation must be
134 # 0 (false) or 1 (true).
136 # Uses the PPRINT_PROP_STRING() with the "yes" or "no" string.
138 # Use PPRINT_INIT() before using this macro.
139 AC_DEFUN([PPRINT_PROP_BOOL], [
140 m4_pushdef([pprint_title], [$1])
141 m4_pushdef([pprint_value], [$2])
143 test pprint_value -eq 0 && pprint_msg="$PPRINT_NO_MSG" || pprint_msg="$PPRINT_YES_MSG"
146 PPRINT_PROP_STRING(pprint_title, [$pprint_msg], $3)
148 PPRINT_PROP_STRING(pprint_title, [$pprint_msg])
151 m4_popdef([pprint_value])
152 m4_popdef([pprint_title])
155 # PPRINT_PROP_BOOL_CUSTOM(title, value, no_msg, title_color?): pretty prints a boolean
158 # The title is put as is in a double-quoted shell string so the user
161 # The value is evaluated at shell runtime. Its evaluation must be
162 # 0 (false) or 1 (true).
164 # Uses the PPRINT_PROP_STRING() with the "yes" or "no" string.
166 # Use PPRINT_INIT() before using this macro.
167 AC_DEFUN([PPRINT_PROP_BOOL_CUSTOM], [
168 m4_pushdef([pprint_title], [$1])
169 m4_pushdef([pprint_value], [$2])
170 m4_pushdef([pprint_value_no_msg], [$3])
172 test pprint_value -eq 0 && pprint_msg="$PPRINT_NO_MSG (pprint_value_no_msg)" || pprint_msg="$PPRINT_YES_MSG"
175 PPRINT_PROP_STRING(pprint_title, [$pprint_msg], $4)
177 PPRINT_PROP_STRING(pprint_title, [$pprint_msg])
180 m4_popdef([pprint_value_no_msg])
181 m4_popdef([pprint_value])
182 m4_popdef([pprint_title])
185 # PPRINT_WARN(msg): pretty prints a warning message.
187 # The message is put as is in a double-quoted shell string so the user
190 # Use PPRINT_INIT() before using this macro.
191 AC_DEFUN([PPRINT_WARN], [
192 m4_pushdef([pprint_msg], [$1])
195 AS_ECHO(["${PPRINT_COLOR_TXTYLW}WARNING:$PPRINT_COLOR_RST ${PPRINT_COLOR_BLDYLW}pprint_msg$PPRINT_COLOR_RST"])
197 m4_popdef([pprint_msg])
200 # PPRINT_ERROR(msg): pretty prints an error message and exits.
202 # The message is put as is in a double-quoted shell string so the user
205 # Use PPRINT_INIT() before using this macro.
206 AC_DEFUN([PPRINT_ERROR], [
207 m4_pushdef([pprint_msg], [$1])
209 AC_MSG_ERROR([${PPRINT_COLOR_BLDRED}pprint_msg$PPRINT_COLOR_RST])
211 m4_popdef([pprint_msg])