summaryrefslogtreecommitdiffstats
path: root/src/preproc/tbl/tests/format-time-diagnostics-work.sh
blob: 9d422bd051243740d615a152d9e4c867a8e90bef (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
#!/bin/sh
#
# Copyright (C) 2022 Free Software Foundation, Inc.
#
# This file is part of groff.
#
# groff 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.
#
# groff 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/>.
#

groff="${abs_top_builddir:-.}/test-groff"

set -e

# Ensure we get diagnostics when we expect to, and not when we don't.
#
# Do NOT pattern-match the text of the diagnostic messages; those should
# be left flexible.  (Some day they might even be localized.)

# As of this writing, there are 5 distinct format-time diagnostic
# messages that tbl writes roff code to generate, one of which can be
# produced two different ways.

# Diagnostic #1: a row overruns the page bottom
input='.pl 2v
.TS
;
L.
T{
.nf
1
2
3
T}
.TE
'

echo "checking for diagnostic when row with text box overruns page" \
    "bottom"
output=$(printf "%s" "$input" | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

echo "checking 'nowarn' suppression of  diagnostic when row with text" \
    "box overruns page bottom"
input_nowarn=$(printf "%s" "$input" | sed 's/;/nowarn;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 0

echo "checking 'nokeep' suppression of diagnostic when row with text" \
    "box overruns page bottom"
input_nowarn=$(printf "%s" "$input" | sed 's/;/nokeep;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 0

# The other way to get "diagnostic #1" is to have a row that is too
# tall _without_ involving a text block, for instance by having a font
# or vertical spacing that is too high.
input='.pl 2v
.vs 3v
.TS
;
L.
1
.TE
'

echo "checking for diagnostic when row with large vertical spacing" \
    "overruns page bottom"
output=$(printf "%s" "$input" | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

echo "checking 'nowarn' suppression of diagnostic when row with large" \
    "vertical spacing overruns page bottom"
input_nowarn=$(printf "%s" "$input" | sed 's/;/nowarn;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 0

echo "checking 'nokeep' suppression of diagnostic when row with large" \
    "vertical spacing overruns page bottom"
input_nowarn=$(printf "%s" "$input" | sed 's/;/nokeep;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 0

# Diagnostic #2: a boxed table won't fit on a page

input='.pl 2v
.vs 3v
.TS
box;
L.
1
.TE
'

echo "checking for diagnostic when boxed table won't fit on page"
output=$(printf "%s" "$input" | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

# The above is an error, so the "nowarn" region option won't shut it up.
#
# However, "nokeep" does--but arguably shouldn't.  See
# <https://savannah.gnu.org/bugs/?61878>.  If that gets fixed, we should
# test that we still get a diagnostic even with the option given.

# Diagnostic #3: unexpanded columns overrun the line length
#
# Case 1: no 'x' column modifiers used

input='.pl 2v
.ll 10n
.TS
;
L.
12345678901
.TE
'

echo "checking for diagnostic when unexpanded columns overrun line" \
    "length (1)"
output=$(printf "%s" "$input" | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

echo "checking 'nowarn' suppression of diagnostic when unexpanded" \
    "columns overrun line length (1)"
input_nowarn=$(printf "%s" "$input" | sed 's/;/nowarn;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 0

# Avoiding keeps won't get you out of this one.
echo "checking 'nokeep' NON-suppression of diagnostic when unexpanded" \
    "columns overrun line length (1)"
input_nowarn=$(printf "%s" "$input" | sed 's/;/nokeep;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

# Case 2: 'x' column modifier used
#
# This worked as a "get out of jail (warning) free" card in groff 1.22.4
# and earlier; i.e., it incorrectly suppressed the warning.  See
# Savannah #61854.

input='.pl 2v
.ll 10n
.TS
;
Lx.
12345678901
.TE
'

echo "checking for diagnostic when unexpanded columns overrun line" \
    "length (2)"
output=$(printf "%s" "$input" | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

echo "checking 'nowarn' suppression of diagnostic when unexpanded" \
    "columns overrun line length (2)"
input_nowarn=$(printf "%s" "$input" | sed 's/;/nowarn;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 0

# Avoiding keeps won't get you out of this one.
echo "checking 'nokeep' NON-suppression of diagnostic when unexpanded" \
    "columns overrun line length (2)"
input_nowarn=$(printf "%s" "$input" | sed 's/;/nokeep;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

# Diagnostic #4: expanded table gets all column separation squashed out

input='.pl 3v
.ll 10n
.TS
tab(;) expand;
L L.
abcde;fghij
.TE
'

echo "checking for diagnostic when region-expanded table has column" \
    "separation eliminated"
output=$(printf "%s" "$input" | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

echo "checking 'nowarn' suppression of diagnostic when" \
    "region-expanded table has column separation eliminated"
input_nowarn=$(printf "%s" "$input" | sed 's/;$/ nowarn;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 0

# Avoiding keeps won't get you out of this one.
echo "checking 'nokeep' NON-suppression of diagnostic when" \
    "region-expanded table has column separation eliminated"
input_nowarn=$(printf "%s" "$input" | sed 's/;$/ nokeep;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

# Diagnostic #5: expanded table gets column separation reduced

input='.pl 3v
.ll 10n
.TS
tab(;) expand;
L L.
abcd;efgh
.TE
'

echo "checking for diagnostic when region-expanded table has column" \
    "separation reduced"
output=$(printf "%s" "$input" | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

echo "checking 'nowarn' suppression of diagnostic when" \
    "region-expanded table has column separation reduced"
input_nowarn=$(printf "%s" "$input" | sed 's/;$/ nowarn;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 0

# Avoiding keeps won't get you out of this one.
echo "checking 'nokeep' NON-suppression of diagnostic when" \
    "region-expanded table has column separation reduced"
input_nowarn=$(printf "%s" "$input" | sed 's/;$/ nokeep;/')
output=$(printf "%s" "$input_nowarn" \
    | "$groff" -Tascii -t 2>&1 >/dev/null)
nlines=$(echo "$output" | grep . | wc -l)
test $nlines -eq 1

# vim:set ai et sw=4 ts=4 tw=72: