This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
b2d0c4837ce03e9d6a8262fea1ff4f18332df351
[perl5.git] / t / op / sprintf2.t
1 #!./perl -w
2
3 # Tests for sprintf that do not fit the format of sprintf.t.
4
5 BEGIN {
6     chdir 't' if -d 't';
7     require './test.pl';
8     set_up_inc('../lib');
9 }   
10
11 # We'll run 12 extra tests (see below) if $Q is false.
12 eval { my $q = pack "q", 0 };
13 my $Q = $@ eq '';
14
15 my $doubledouble;
16
17 # %a and %A depend on the floating point config
18 # This totally doesn't test non-IEEE-754 float formats.
19 my @hexfloat;
20 print "# uvsize = $Config{uvsize}\n";
21 print "# nvsize = $Config{nvsize}\n";
22 print "# nv_preserves_uv_bits = $Config{nv_preserves_uv_bits}\n";
23 print "# d_quad = $Config{d_quad}\n";
24 print "# uselongdouble = " . ($Config{uselongdouble} // 'undef') . "\n";
25 if ($Config{nvsize} == 8 &&
26     (
27      # IEEE-754 64-bit ("double precision"), the most common out there
28      ($Config{uvsize} == 8 && $Config{nv_preserves_uv_bits} == 53)
29      ||
30      # If we have a quad we can still get the mantissa bits.
31      ($Config{uvsize} == 4 && $Config{d_quad})
32      )
33     ) {
34     @hexfloat = (
35         [ '%a',       '0',       '0x0p+0' ],
36         [ '%a',       '1',       '0x1p+0' ],
37         [ '%a',       '1.0',     '0x1p+0' ],
38         [ '%a',       '0.5',     '0x1p-1' ],
39         [ '%a',       '0.25',    '0x1p-2' ],
40         [ '%a',       '0.75',    '0x1.8p-1' ],
41         [ '%a',       '3.14',    '0x1.91eb851eb851fp+1' ],
42         [ '%a',       '-1.0',    '-0x1p+0' ],
43         [ '%a',       '-3.14',   '-0x1.91eb851eb851fp+1' ],
44         [ '%a',       '0.1',     '0x1.999999999999ap-4' ],
45         [ '%a',       '1/7',     '0x1.2492492492492p-3' ],
46         [ '%a',       'sqrt(2)', '0x1.6a09e667f3bcdp+0' ],
47         [ '%a',       'exp(1)',  '0x1.5bf0a8b145769p+1' ],
48         [ '%a',       '2**-10',  '0x1p-10' ],
49         [ '%a',       '2**10',   '0x1p+10' ],
50         [ '%a',       '1e-9',    '0x1.12e0be826d695p-30' ],
51         [ '%a',       '1e9',     '0x1.dcd65p+29' ],
52
53         [ '%#a',      '1',       '0x1.p+0' ],
54         [ '%+a',      '1',       '+0x1p+0' ],
55         [ '%+a',      '-1',      '-0x1p+0' ],
56         [ '% a',      ' 1',      ' 0x1p+0' ],
57         [ '% a',      '-1',      '-0x1p+0' ],
58
59         [ '%+ a',     '1',       '+0x1p+0' ],
60         [ '%+ a',     '-1',      '-0x1p+0' ],
61         [ '% +a',     ' 1',      '+0x1p+0' ],
62         [ '% +a',     '-1',      '-0x1p+0' ],
63
64         [ '%8a',      '3.14',   '0x1.91eb851eb851fp+1' ],
65         [ '%13a',     '3.14',   '0x1.91eb851eb851fp+1' ],
66         [ '%20a',     '3.14',   '0x1.91eb851eb851fp+1' ],
67         [ '%.4a',     '3.14',   '0x1.91ecp+1' ],
68         [ '%.5a',     '3.14',   '0x1.91eb8p+1' ],
69         [ '%.6a',     '3.14',   '0x1.91eb85p+1' ],
70         [ '%.20a',    '3.14',   '0x1.91eb851eb851f0000000p+1' ],
71         [ '%20.10a',  '3.14',   '   0x1.91eb851eb8p+1' ],
72         [ '%20.15a',  '3.14',   '0x1.91eb851eb851f00p+1' ],
73         [ '% 20.10a', '3.14',   '   0x1.91eb851eb8p+1' ],
74         [ '%020.10a', '3.14',   '0x0001.91eb851eb8p+1' ],
75
76         [ '%.13a',    '1',   '0x1.0000000000000p+0' ],
77         [ '%.13a',    '-1',  '-0x1.0000000000000p+0' ],
78         [ '%.13a',    '0',   '0x0.0000000000000p+0' ],
79
80         [ '%30a',  '3.14',   '          0x1.91eb851eb851fp+1' ],
81         [ '%-30a', '3.14',   '0x1.91eb851eb851fp+1          ' ],
82         [ '%030a',  '3.14',  '0x00000000001.91eb851eb851fp+1' ],
83         [ '%-030a', '3.14',  '0x1.91eb851eb851fp+1          ' ],
84
85         [ '%.40a',  '3.14',
86           '0x1.91eb851eb851f000000000000000000000000000p+1' ],
87
88         [ '%A',       '3.14',   '0X1.91EB851EB851FP+1' ],
89         );
90 } elsif (($Config{nvsize} == 16 || $Config{nvsize} == 12) &&
91          # 80-bit ("extended precision") long double, pack F is the NV
92          # cd cc cc cc cc cc cc cc fb bf 00 00 00 00 00 00
93          # cd cc cc cc cc cc cc cc fb bf 00 00
94          (pack("F", 0.1) =~ /^\xCD/ ||  # LE
95           pack("F", 0.1) =~ /\xCD$/)) { # BE (if this ever happens)
96     @hexfloat = (
97         [ '%a',       '0',       '0x0p+0' ],
98         [ '%a',       '1',       '0x8p-3' ],
99         [ '%a',       '1.0',     '0x8p-3' ],
100         [ '%a',       '0.5',     '0x8p-4' ],
101         [ '%a',       '0.25',    '0x8p-5' ],
102         [ '%a',       '0.75',    '0xcp-4' ],
103         [ '%a',       '3.14',    '0xc.8f5c28f5c28f5c3p-2' ],
104         [ '%a',       '-1.0',    '-0x8p-3' ],
105         [ '%a',       '-3.14',   '-0xc.8f5c28f5c28f5c3p-2' ],
106         [ '%a',       '0.1',     '0xc.ccccccccccccccdp-7' ],
107         [ '%a',       '1/7',     '0x9.249249249249249p-6' ],
108         [ '%a',       'sqrt(2)', '0xb.504f333f9de6484p-3' ],
109         [ '%a',       'exp(1)',  '0xa.df85458a2bb4a9bp-2' ],
110         [ '%a',       '2**-10',  '0x8p-13' ],
111         [ '%a',       '2**10',   '0x8p+7' ],
112         [ '%a',       '1e-9',    '0x8.9705f4136b4a597p-33' ],
113         [ '%a',       '1e9',     '0xe.e6b28p+26' ],
114
115         [ '%#a',      '1',       '0x8.p-3' ],
116         [ '%+a',      '1',       '+0x8p-3' ],
117         [ '%+a',      '-1',      '-0x8p-3' ],
118         [ '% a',      ' 1',      ' 0x8p-3' ],
119         [ '% a',      '-1',      '-0x8p-3' ],
120
121         [ '%+ a',     '1',       '+0x8p-3' ],
122         [ '%+ a',     '-1',      '-0x8p-3' ],
123         [ '% +a',     ' 1',      '+0x8p-3' ],
124         [ '% +a',     '-1',      '-0x8p-3' ],
125
126         [ '%8a',      '3.14',    '0xc.8f5c28f5c28f5c3p-2' ],
127         [ '%13a',     '3.14',    '0xc.8f5c28f5c28f5c3p-2' ],
128         [ '%20a',     '3.14',    '0xc.8f5c28f5c28f5c3p-2' ],
129         [ '%.4a',     '3.14',    '0xc.8f5cp-2' ],
130         [ '%.5a',     '3.14',    '0xc.8f5c3p-2' ],
131         [ '%.6a',     '3.14',    '0xc.8f5c29p-2' ],
132         [ '%.20a',    '3.14',    '0xc.8f5c28f5c28f5c300000p-2' ],
133         [ '%20.10a',  '3.14',    '   0xc.8f5c28f5c3p-2' ],
134         [ '%20.15a',  '3.14',    '0xc.8f5c28f5c28f5c3p-2' ],
135         [ '% 20.10a', '3.14',    '   0xc.8f5c28f5c3p-2' ],
136         [ '%020.10a', '3.14',    '0x000c.8f5c28f5c3p-2' ],
137
138         [ '%30a',  '3.14',   '        0xc.8f5c28f5c28f5c3p-2' ],
139         [ '%-30a', '3.14',   '0xc.8f5c28f5c28f5c3p-2        ' ],
140         [ '%030a',  '3.14',  '0x00000000c.8f5c28f5c28f5c3p-2' ],
141         [ '%-030a', '3.14',  '0xc.8f5c28f5c28f5c3p-2        ' ],
142
143         [ '%.40a',  '3.14',
144           '0xc.8f5c28f5c28f5c30000000000000000000000000p-2' ],
145
146         [ '%A',       '3.14',    '0XC.8F5C28F5C28F5C3P-2' ],
147         );
148 } elsif (
149     # IEEE 754 128-bit ("quadruple precision"), e.g. IA-64 (Itanium) in VMS
150     $Config{nvsize} == 16 &&
151     # 9a 99 99 99 99 99 99 99 99 99 99 99 99 99 fb 3f (LE), pack F is the NV
152     (pack("F", 0.1) =~ /^\x9A\x99{6}/ ||  # LE
153      pack("F", 0.1) =~ /\x99{6}\x9A$/)    # BE
154     ) {
155     @hexfloat = (
156         [ '%a', '0',       '0x0p+0' ],
157         [ '%a', '1',       '0x1p+0' ],
158         [ '%a', '1.0',     '0x1p+0' ],
159         [ '%a', '0.5',     '0x1p-1' ],
160         [ '%a', '0.25',    '0x1p-2' ],
161         [ '%a', '0.75',    '0x1.8p-1' ],
162         [ '%a', '3.14',    '0x1.91eb851eb851eb851eb851eb851fp+1' ],
163         [ '%a', '-1',      '-0x1p+0' ],
164         [ '%a', '-3.14',   '-0x1.91eb851eb851eb851eb851eb851fp+1' ],
165         [ '%a', '0.1',     '0x1.999999999999999999999999999ap-4' ],
166         [ '%a', '1/7',     '0x1.2492492492492492492492492492p-3' ],
167         [ '%a', 'sqrt(2)', '0x1.6a09e667f3bcc908b2fb1366ea95p+0' ],
168         [ '%a', 'exp(1)',  '0x1.5bf0a8b1457695355fb8ac404e7ap+1' ],
169         [ '%a', '2**-10',  '0x1p-10' ],
170         [ '%a', '2**10',   '0x1p+10' ],
171         [ '%a', '1e-09',   '0x1.12e0be826d694b2e62d01511f12ap-30' ],
172         [ '%a', '1e9',     '0x1.dcd65p+29' ],
173
174         [ '%#a', '1',      '0x1.p+0' ],
175         [ '%+a', '1',      '+0x1p+0' ],
176         [ '%+a', '-1',     '-0x1p+0' ],
177         [ '% a', '1',      ' 0x1p+0' ],
178         [ '% a', '-1',     '-0x1p+0' ],
179
180         [ '%+ a', '1',     '+0x1p+0' ],
181         [ '%+ a', '-1',    '-0x1p+0' ],
182         [ '% +a', ' 1',    '+0x1p+0' ],
183         [ '% +a', '-1',    '-0x1p+0' ],
184
185         [ '%8a',      '3.14', '0x1.91eb851eb851eb851eb851eb851fp+1' ],
186         [ '%13a',     '3.14', '0x1.91eb851eb851eb851eb851eb851fp+1' ],
187         [ '%20a',     '3.14', '0x1.91eb851eb851eb851eb851eb851fp+1' ],
188         [ '%.4a',     '3.14', '0x1.91ecp+1' ],
189         [ '%.5a',     '3.14', '0x1.91eb8p+1' ],
190         [ '%.6a',     '3.14', '0x1.91eb85p+1' ],
191         [ '%.20a',    '3.14', '0x1.91eb851eb851eb851eb8p+1' ],
192         [ '%20.10a',  '3.14', '   0x1.91eb851eb8p+1' ],
193         [ '%20.15a',  '3.14', '0x1.91eb851eb851eb8p+1' ],
194         [ '% 20.10a', '3.14', '   0x1.91eb851eb8p+1' ],
195         [ '%020.10a', '3.14', '0x0001.91eb851eb8p+1' ],
196
197         [ '%30a',     '3.14', '0x1.91eb851eb851eb851eb851eb851fp+1' ],
198         [ '%-30a',    '3.14', '0x1.91eb851eb851eb851eb851eb851fp+1' ],
199         [ '%030a',    '3.14', '0x1.91eb851eb851eb851eb851eb851fp+1' ],
200         [ '%-030a',   '3.14', '0x1.91eb851eb851eb851eb851eb851fp+1' ],
201
202         [ '%.40a',  '3.14',
203           '0x1.91eb851eb851eb851eb851eb851f000000000000p+1' ],
204
205         [ '%A',       '3.14', '0X1.91EB851EB851EB851EB851EB851FP+1' ],
206         );
207 } elsif (
208     # "double-double", two 64-bit doubles end to end
209     $Config{nvsize} == 16 &&
210     # bf b9 99 99 99 99 99 9a bc 59 99 99 99 99 99 9a (BE), pack F is the NV
211     (pack("F", 0.1) =~ /^\x9A\x99{5}\x59\xBC/ ||  # LE
212      pack("F", 0.1) =~ /\xBC\x59\x99{5}\x9A$/)    # BE
213     ) {
214     $doubledouble = 1;
215     @hexfloat = (
216         [ '%a', '0',       '0x0p+0' ],
217         [ '%a', '1',       '0x1p+0' ],
218         [ '%a', '1.0',     '0x1p+0' ],
219         [ '%a', '0.5',     '0x1p-1' ],
220         [ '%a', '0.25',    '0x1p-2' ],
221         [ '%a', '0.75',    '0x1.8p-1' ],
222         [ '%a', '3.14',    '0x1.91eb851eb851eb851eb851eb85p+1' ],
223         [ '%a', '-1',      '-0x1p+0' ],
224         [ '%a', '-3.14',   '-0x1.91eb851eb851eb851eb851eb85p+1' ],
225         [ '%a', '0.1',     '0x1.999999999999999999999999998p-4' ],
226         [ '%a', '1/7',     '0x1.249249249249249249249249248p-3' ],
227         [ '%a', 'sqrt(2)', '0x1.6a09e667f3bcc908b2fb1366ea8p+0' ],
228         [ '%a', 'exp(1)',  '0x1.5bf0a8b1457695355fb8ac404e8p+1' ],
229         [ '%a', '2**-10',  '0x1p-10' ],
230         [ '%a', '2**10',   '0x1p+10' ],
231         [ '%a', '1e-09',   '0x1.12e0be826d694b2e62d01511f14p-30' ],
232         [ '%a', '1e9',     '0x1.dcd65p+29' ],
233
234         [ '%#a', '1',      '0x1.p+0' ],
235         [ '%+a', '1',      '+0x1p+0' ],
236         [ '%+a', '-1',     '-0x1p+0' ],
237         [ '% a', '1',      ' 0x1p+0' ],
238         [ '% a', '-1',     '-0x1p+0' ],
239
240         [ '%8a',      '3.14', '0x1.91eb851eb851eb851eb851eb85p+1' ],
241         [ '%13a',     '3.14', '0x1.91eb851eb851eb851eb851eb85p+1' ],
242         [ '%20a',     '3.14', '0x1.91eb851eb851eb851eb851eb85p+1' ],
243         [ '%.4a',     '3.14', '0x1.91ecp+1' ],
244         [ '%.5a',     '3.14', '0x1.91eb8p+1' ],
245         [ '%.6a',     '3.14', '0x1.91eb85p+1' ],
246         [ '%.20a',    '3.14',   '0x1.91eb851eb851eb851eb8p+1' ],
247         [ '%20.10a',  '3.14', '   0x1.91eb851eb8p+1' ],
248         [ '%20.15a',  '3.14',   '0x1.91eb851eb851eb8p+1' ],
249         [ '% 20.10a', '3.14', '   0x1.91eb851eb8p+1' ],
250         [ '%020.10a', '3.14', '0x0001.91eb851eb8p+1' ],
251
252         [ '%30a',  '3.14',   '0x1.91eb851eb851eb851eb851eb85p+1' ],
253         [ '%-30a', '3.14',   '0x1.91eb851eb851eb851eb851eb85p+1' ],
254         [ '%030a',  '3.14',  '0x1.91eb851eb851eb851eb851eb85p+1' ],
255         [ '%-030a', '3.14',  '0x1.91eb851eb851eb851eb851eb85p+1' ],
256
257         [ '%.40a',  '3.14',
258           '0x1.91eb851eb851eb851eb851eb8500000000000000p+1' ],
259
260         [ '%A',       '3.14', '0X1.91EB851EB851EB851EB851EB85P+1' ],
261         );
262 } else {
263     print "# no hexfloat tests\n";
264 }
265
266 use strict;
267 use Config;
268
269 is(
270     sprintf("%.40g ",0.01),
271     sprintf("%.40g", 0.01)." ",
272     q(the sprintf "%.<number>g" optimization)
273 );
274 is(
275     sprintf("%.40f ",0.01),
276     sprintf("%.40f", 0.01)." ",
277     q(the sprintf "%.<number>f" optimization)
278 );
279
280 # cases of $i > 1 are against [perl #39126]
281 for my $i (1, 5, 10, 20, 50, 100) {
282     chop(my $utf8_format = "%-*s\x{100}");
283     my $string = "\xB4"x$i;        # latin1 ACUTE or ebcdic COPYRIGHT
284     my $expect = $string."  "x$i;  # followed by 2*$i spaces
285     is(sprintf($utf8_format, 3*$i, $string), $expect,
286        "width calculation under utf8 upgrade, length=$i");
287 }
288
289 # check simultaneous width & precision with wide characters
290 for my $i (1, 3, 5, 10) {
291     my $string = "\x{0410}"x($i+10);   # cyrillic capital A
292     my $expect = "\x{0410}"x$i;        # cut down to exactly $i characters
293     my $format = "%$i.${i}s";
294     is(sprintf($format, $string), $expect,
295        "width & precision interplay with utf8 strings, length=$i");
296 }
297
298 # check overflows
299 for (int(~0/2+1), ~0, "9999999999999999999") {
300     is(eval {sprintf "%${_}d", 0}, undef, "no sprintf result expected %${_}d");
301     like($@, qr/^Integer overflow in format string for sprintf /, "overflow in sprintf");
302     is(eval {printf "%${_}d\n", 0}, undef, "no printf result expected %${_}d");
303     like($@, qr/^Integer overflow in format string for printf /, "overflow in printf");
304 }
305
306 # check %NNN$ for range bounds
307 {
308     my ($warn, $bad) = (0,0);
309     local $SIG{__WARN__} = sub {
310         if ($_[0] =~ /missing argument/i) {
311             $warn++
312         }
313         else {
314             $bad++
315         }
316     };
317
318     my $fmt = join('', map("%$_\$s%" . ((1 << 31)-$_) . '$s', 1..20));
319     my $result = sprintf $fmt, qw(a b c d);
320     is($result, "abcd", "only four valid values in $fmt");
321     is($warn, 36, "expected warnings");
322     is($bad,   0, "unexpected warnings");
323 }
324
325 # Tests for "missing argument" and "redundant argument" warnings
326 {
327     my ($warn_missing, $warn_redundant, $warn_bad) = (0,0,0);
328     local $SIG{__WARN__} = sub {
329         if ($_[0] =~ /missing argument/i) {
330             $warn_missing++
331         }
332         elsif ($_[0] =~ /redundant argument/i) {
333             $warn_redundant++
334         }
335         else {
336             $warn_bad++
337         }
338     };
339
340     my @tests = (
341         # The "", "%s", and "%-p" formats have special-case handling
342         # in sv.c
343         {
344             fmt  => "",
345             args => [ qw( x ) ],
346             res  => "",
347             m    => 0,
348             r    => 1,
349         },
350         {
351             fmt  => "%s",
352             args => [ qw( x y ) ],
353             res  => "x",
354             m    => 0,
355             r    => 1,
356         },
357         {
358             fmt  => "%-p",
359             args => [ qw( x y ) ],
360             res  => qr/^[0-9a-f]+$/as,
361             m    => 0,
362             r    => 1,
363         },
364         # Other non-specialcased patterns
365         {
366             fmt  => "%s : %s",
367             args => [ qw( a b c ) ],
368             res  => "a : b",
369             m    => 0,
370             r    => 1,
371         },
372         {
373             fmt  => "%s : %s : %s",
374             args => [ qw( a b c d e ) ],
375             res  => "a : b : c",
376             m    => 0,
377             # Note how we'll only warn about redundant arguments once,
378             # even though both "d" and "e" are redundant...
379             r    => 1,
380         },
381         {
382             fmt  => "%s : %s : %s",
383             args => [ ],
384             res  => " :  : ",
385             # ...But when arguments are missing we'll warn about every
386             # missing argument. This difference between the two
387             # warnings is a feature.
388             m    => 3,
389             r    => 0,
390         },
391
392         # Tests for format parameter indexes.
393         #
394         # Deciding what to do about these is a bit tricky, and so is
395         # "correctly" warning about missing arguments on them.
396         #
397         # Should we warn if you supply 4 arguments but only use
398         # argument 1,3 & 4? Or only if you supply 5 arguments and your
399         # highest used argument is 4?
400         #
401         # For some uses of this printf feature (e.g. i18n systems)
402         # it's a always a logic error to not print out every provided
403         # argument, but for some other uses skipping some might be a
404         # feature (although you could argue that then printf should be
405         # called as e.g:
406         #
407         #     printf q[%1$s %3$s], x(), undef, z();
408         #
409         # Instead of:
410         #
411         #    printf q[%1$s %3$s], x(), y(), z();
412         #
413         # Since calling the (possibly expensive) y() function is
414         # completely redundant there.
415         #
416         # We deal with all these potential problems by not even
417         # trying. If the pattern contains any format parameter indexes
418         # whatsoever we'll never warn about redundant arguments.
419         {
420             fmt  => '%1$s : %2$s',
421             args => [ qw( x y z ) ],
422             res  => "x : y",
423             m    => 0,
424             r    => 0,
425         },
426         {
427             fmt  => '%2$s : %4$s : %5$s',
428             args => [ qw( a b c d )],
429             res  => "b : d : ",
430             m    => 1,
431             r    => 0,
432         },
433         {
434             fmt  => '%s : %1$s : %s',
435             args => [ qw( x y z ) ],
436             res  => "x : x : y",
437             m    => 0,
438             r    => 0,
439         },
440
441     );
442
443     for my $i (0..$#tests) {
444         my $test = $tests[$i];
445         my $result = sprintf $test->{fmt}, @{$test->{args}};
446
447         my $prefix = "For format '$test->{fmt}' and arguments/result '@{$test->{args}}'/'$result'";
448         if (ref $test->{res} eq 'Regexp') {
449             like($result, $test->{res}, "$prefix got the right result");
450         } else {
451             is($result, $test->{res}, "$prefix got the right result");
452         }
453         is($warn_missing, $test->{m}, "$prefix got '$test->{m}' 'missing argument' warnings");
454         is($warn_redundant, $test->{r}, "$prefix got '$test->{r}' 'redundant argument' warnings");
455         is($warn_bad, 0, "$prefix No unknown warnings");
456
457         ($warn_missing, $warn_redundant, $warn_bad) = (0,0,0);
458     }
459 }
460
461 {
462     foreach my $ord (0 .. 255) {
463         my $bad = 0;
464         local $SIG{__WARN__} = sub {
465             if ($_[0] !~ /^Invalid conversion in sprintf/) {
466                 warn $_[0];
467                 $bad++;
468             }
469         };
470         my $r = eval {sprintf '%v' . chr $ord};
471         is ($bad, 0, "pattern '%v' . chr $ord");
472     }
473 }
474
475 sub mysprintf_int_flags {
476     my ($fmt, $num) = @_;
477     die "wrong format $fmt" if $fmt !~ /^%([-+ 0]+)([1-9][0-9]*)d\z/;
478     my $flag  = $1;
479     my $width = $2;
480     my $sign  = $num < 0 ? '-' :
481                 $flag =~ /\+/ ? '+' :
482                 $flag =~ /\ / ? ' ' :
483                 '';
484     my $abs   = abs($num);
485     my $padlen = $width - length($sign.$abs);
486     return
487         $flag =~ /0/ && $flag !~ /-/ # do zero padding
488             ? $sign . '0' x $padlen . $abs
489             : $flag =~ /-/ # left or right
490                 ? $sign . $abs . ' ' x $padlen
491                 : ' ' x $padlen . $sign . $abs;
492 }
493
494 # Whole tests for "%4d" with 2 to 4 flags;
495 # total counts: 3 * (4**2 + 4**3 + 4**4) == 1008
496
497 my @flags = ("-", "+", " ", "0");
498 for my $num (0, -1, 1) {
499     for my $f1 (@flags) {
500         for my $f2 (@flags) {
501             for my $f3 ('', @flags) { # '' for doubled flags
502                 my $flag = $f1.$f2.$f3;
503                 my $width = 4;
504                 my $fmt   = '%'."${flag}${width}d";
505                 my $result = sprintf($fmt, $num);
506                 my $expect = mysprintf_int_flags($fmt, $num);
507                 is($result, $expect, qq/sprintf("$fmt",$num)/);
508
509                 next if $f3 eq '';
510
511                 for my $f4 (@flags) { # quadrupled flags
512                     my $flag = $f1.$f2.$f3.$f4;
513                     my $fmt   = '%'."${flag}${width}d";
514                     my $result = sprintf($fmt, $num);
515                     my $expect = mysprintf_int_flags($fmt, $num);
516                     is($result, $expect, qq/sprintf("$fmt",$num)/);
517                 }
518             }
519         }
520     }
521 }
522
523 SKIP: {
524     unless ($Config{d_double_has_inf} && $Config{d_double_has_nan}) { skip "no Inf or NaN in doublekind $Config{doublekind}", 3 }
525     # test that %f doesn't panic with +Inf, -Inf, NaN [perl #45383]
526     foreach my $n ('2**1e100', '-2**1e100', '2**1e100/2**1e100') { # +Inf, -Inf, NaN
527         eval { my $f = sprintf("%f", eval $n); };
528         is $@, "", "sprintf(\"%f\", $n)";
529     }
530 }
531
532 # test %ll formats with and without HAS_QUAD
533 my @tests = (
534   [ '%lld' => [qw( 4294967296 -100000000000000 )] ],
535   [ '%lli' => [qw( 4294967296 -100000000000000 )] ],
536   [ '%llu' => [qw( 4294967296  100000000000000 )] ],
537   [ '%Ld'  => [qw( 4294967296 -100000000000000 )] ],
538   [ '%Li'  => [qw( 4294967296 -100000000000000 )] ],
539   [ '%Lu'  => [qw( 4294967296  100000000000000 )] ],
540 );
541
542 for my $t (@tests) {
543   my($fmt, $nums) = @$t;
544   for my $num (@$nums) {
545     my $w = '';
546     local $SIG{__WARN__} = sub { $w .= shift };
547     my $sprintf_got = sprintf($fmt, $num);
548     if ($Q) {
549       is($sprintf_got, $num, "quad: $fmt -> $num");
550       is($w, '', "no warnings for: $fmt -> $num");
551     } else {
552       is($sprintf_got, $fmt, "quad unsupported: $fmt -> $fmt");
553       like($w, qr/Invalid conversion in sprintf: "$fmt"/, "got warning about invalid conversion from fmt : $fmt");
554       like($w, qr/Redundant argument in sprintf/, "got warning about redundant argument in sprintf from fmt : $fmt");
555     }
556   }
557 }
558
559 # Check unicode vs byte length
560 for my $width (1,2,3,4,5,6,7) {
561     for my $precis (1,2,3,4,5,6,7) {
562         my $v = "\x{20ac}\x{20ac}";
563         my $format = "%" . $width . "." . $precis . "s";
564         my $chars = ($precis > 2 ? 2 : $precis);
565         my $space = ($width < 2 ? 0 : $width - $chars);
566         fresh_perl_is(
567             'my $v = "\x{20ac}\x{20ac}"; my $x = sprintf "'.$format.'", $v; $x =~ /^(\s*)(\S*)$/; print "$_" for map {length} $1, $2',
568             "$space$chars",
569             {},
570             q(sprintf ").$format.q(", "\x{20ac}\x{20ac}"),
571         );
572     }
573 }
574
575 # Overload count
576 package o {
577     use overload
578         '""', sub { ++our $count; $_[0][0]; },
579         '0+', sub { ++our $numcount; $_[0][1]; }
580 }
581 my $o = bless ["\x{100}",42], o::;
582 () = sprintf "%1s", $o;
583 is $o::count, '1', 'sprinf %1s overload count';
584 $o::count = 0;
585 () = sprintf "%.1s", $o;
586 is $o::count, '1', 'sprinf %.1s overload count';
587 $o::count = 0;
588 () = sprintf "%d", $o;
589 is $o::count,    0, 'sprintf %d string overload count is 0';
590 is $o::numcount, 1, 'sprintf %d number overload count is 1';
591
592 SKIP: {  # hexfp
593     unless ($Config{d_double_style_ieee}) { skip "no IEEE, no hexfp", scalar @hexfloat }
594
595 my $ppc_linux = $Config{archname} =~ /^(?:ppc|power(?:pc)?)(?:64)?-linux/;
596 my $irix_ld   = $Config{archname} =~ /^IP\d+-irix-ld$/;
597
598 for my $t (@hexfloat) {
599     my ($format, $arg, $expected) = @$t;
600     $arg = eval $arg;
601     my $result = sprintf($format, $arg);
602     my $ok = $result eq $expected;
603     # For certain platforms (all of which are currently double-double,
604     # but different implementations, GNU vs vendor, two different archs
605     # (ppc and mips), and two different libm interfaces) we have some
606     # bits-in-the-last-hexdigit differences.
607     # Patch them up as TODOs instead of deadly errors.
608     if ($doubledouble && $ppc_linux && $arg =~ /^2.71828/) {
609         # gets  '0x1.5bf0a8b1457695355fb8ac404ecp+1'
610         # wants '0x1.5bf0a8b1457695355fb8ac404e8p+1'
611         local $::TODO = "$Config{archname} exp(1)";
612         ok($ok, "'$format' '$arg' -> '$result' cf '$expected'");
613         next;
614     }
615     if ($doubledouble && $irix_ld && $arg =~ /^1.41421/) {
616         # gets  '0x1.6a09e667f3bcc908b2fb1366eacp+0'
617         # wants '0x1.6a09e667f3bcc908b2fb1366ea8p+0'
618         local $::TODO = "$Config{archname} sqrt(2)";
619         ok($ok, "'$format' '$arg' -> '$result' cf '$expected'");
620         next;
621     }
622     if (!$ok && $result =~ /\./ && $expected =~ /\./) {
623         # It seems that there can be difference in the last bits:
624         # [perl #122578]
625         #      got "0x1.5bf0a8b14576ap+1"
626         # expected "0x1.5bf0a8b145769p+1"
627         # (Android on ARM)
628         #
629         # Exact cause unknown but suspecting different fp rounding modes,
630         # (towards zero? towards +inf? towards -inf?) about which Perl
631         # is blissfully unaware.
632         #
633         # Try extracting one (or sometimes two) last mantissa
634         # hexdigits, and see if they differ in value by one.
635         my ($rh, $eh) = ($result, $expected);
636         sub extract_prefix {
637             ($_[0] =~ s/(-?0x[0-9a-fA-F]+\.)//) && return $1;
638         }
639         my $rp = extract_prefix($rh);
640         my $ep = extract_prefix($eh);
641         print "# rp = $rp, ep = $ep (rh $rh, eh $eh)\n";
642         if ($rp eq $ep) { # If prefixes match.
643             sub extract_exponent {
644                 ($_[0] =~ s/([pP][+-]?\d+)//) && return $1;
645             }
646             my $re = extract_exponent($rh);
647             my $ee = extract_exponent($eh);
648             print "# re = $re, ee = $ee (rh $rh, eh $eh)\n";
649             if ($re eq $ee) { # If exponents match.
650                 # Remove the common prefix of the mantissa bits.
651                 my $la = length($rh);
652                 my $lb = length($eh);
653                 my $i;
654                 for ($i = 0; $i < $la && $i < $lb; $i++) {
655                     last if substr($rh, $i, 1) ne substr($eh, $i, 1);
656                 }
657                 $rh = substr($rh, $i);
658                 $eh = substr($eh, $i);
659                 print "# (rh $rh, eh $eh)\n";
660                 if ($rh ne $eh) {
661                     # If necessary, pad the shorter one on the right
662                     # with one zero (for example "...1f" vs "...2",
663                     # we want to compare "1f" to "20").
664                     if (length $rh < length $eh) {
665                         $rh .= '0';
666                     } elsif (length $eh < length $rh) {
667                         $eh .= '0';
668                     }
669                     print "# (rh $rh, eh $eh)\n";
670                     if (length $eh == length $rh) {
671                         if (abs(hex($eh) - hex($rh)) == 1) {
672                             $ok = 1;
673                         }
674                     }
675                 }
676             }
677         }
678     }
679     ok($ok, "'$format' '$arg' -> '$result' cf '$expected'");
680 }
681
682 } # SKIP: # hexfp
683
684 # double-double long double %a special testing.
685 SKIP: {
686     skip("uselongdouble=" . ($Config{uselongdouble} ? 'define' : 'undef')
687          . " longdblkind=$Config{longdblkind} os=$^O", 6)
688         unless ($Config{uselongdouble} &&
689                 ($Config{long_double_style_ieee_doubledouble})
690                 # Gating on 'linux' (ppc) here is due to the differing
691                 # double-double implementations: other (also big-endian)
692                 # double-double platforms (e.g. AIX on ppc or IRIX on mips)
693                 # do not behave similarly.
694                 && $^O eq 'linux'
695                 );
696     # [rt.perl.org 125633]
697     like(sprintf("%La\n", eval '(2**1020) + (2**-1072)'),
698          qr/^0x1.0{522}1p\+1020$/);
699     like(sprintf("%La\n", eval '(2**1021) + (2**-1072)'),
700          qr/^0x1.0{523}8p\+1021$/);
701     like(sprintf("%La\n", eval '(2**1022) + (2**-1072)'),
702          qr/^0x1.0{523}4p\+1022$/);
703     like(sprintf("%La\n", eval '(2**1023) + (2**-1072)'),
704          qr/^0x1.0{523}2p\+1023$/);
705     like(sprintf("%La\n", eval '(2**1023) + (2**-1073)'),
706          qr/^0x1.0{523}1p\+1023$/);
707     like(sprintf("%La\n", eval '(2**1023) + (2**-1074)'),
708          qr/^0x1.0{524}8p\+1023$/);
709 }
710
711 SKIP: {
712     skip("negative zero not available\n", 3)
713         unless sprintf('%+f', -0.0) =~ /^-0/;
714     is(sprintf("%a", -0.0), "-0x0p+0", "negative zero");
715     is(sprintf("%+a", -0.0), "-0x0p+0", "negative zero");
716     is(sprintf("%.13a", -0.0), "-0x0.0000000000000p+0", "negative zero");
717 }
718
719 SKIP: {
720     # [perl #127183] Non-canonical hexadecimal floats are parsed prematurely
721
722     # IEEE 754 64-bit
723     skip("nv_preserves_uv_bits is $Config{nv_preserves_uv_bits}, not 53", 3)
724         unless $Config{nv_preserves_uv_bits} == 53;
725
726     {
727         # The 0x0.b17217f7d1cf78p0 is the original LHS value
728         # from [perl #127183], its bits are 0x162e42fefa39ef << 3,
729         # resulting in a non-canonical form of hexfp, where the most
730         # significant bit is zero, instead of one.
731         is(sprintf("%a", 0x0.b17217f7d1cf78p0 - 0x1.62e42fefa39efp-1),
732            "0x0p+0",
733            "non-canonical form [perl #127183]");
734     }
735
736     {
737         no warnings 'overflow';  # Not the point here.
738
739         # The 0x058b90bfbe8e7bc is 0x162e42fefa39ef << 2,
740         # the 0x02c5c85fdf473de is 0x162e42fefa39ef << 1,
741         # see above.
742         is(sprintf("%a", 0x0.58b90bfbe8e7bcp1 - 0x1.62e42fefa39efp-1),
743            "0x0p+0",
744            "non-canonical form");
745
746         is(sprintf("%a", 0x0.2c5c85fdf473dep2 - 0x1.62e42fefa39efp-1),
747            "0x0p+0",
748            "non-canonical form");
749     }
750 }
751
752 # These are IEEE 754 64-bit subnormals (formerly known as denormals).
753 # Keep these as strings so that non-IEEE-754 don't trip over them.
754 my @subnormals = (
755     [ '1e-320', '%a', '0x1.fap-1064' ],
756     [ '1e-321', '%a', '0x1.94p-1067' ],
757     [ '1e-322', '%a', '0x1.4p-1070' ],
758     [ '1e-323', '%a', '0x1p-1073' ],
759     [ '1e-324', '%a', '0x0p+0' ],  # underflow
760     [ '3e-320', '%a', '0x1.7b8p-1062' ],
761     [ '3e-321', '%a', '0x1.2f8p-1065' ],
762     [ '3e-322', '%a', '0x1.e8p-1069' ],
763     [ '3e-323', '%a', '0x1.8p-1072' ],
764     [ '3e-324', '%a', '0x1p-1074' ], # the smallest possible value
765     [ '7e-320', '%a', '0x1.bacp-1061' ],
766     [ '7e-321', '%a', '0x1.624p-1064' ],
767     [ '7e-322', '%a', '0x1.1cp-1067' ],
768     [ '7e-323', '%a', '0x1.cp-1071' ],
769     [ '7e-324', '%a', '0x1p-1074' ], # the smallest possible value, again
770     [ '3e-320', '%.4a', '0x1.7b80p-1062' ],
771     [ '3e-321', '%.4a', '0x1.2f80p-1065' ],
772     [ '3e-322', '%.4a', '0x1.e800p-1069' ],
773     [ '3e-323', '%.4a', '0x1.8000p-1072' ],
774     [ '3e-324', '%.4a', '0x1.0000p-1074' ],
775     [ '3e-320', '%.1a', '0x1.8p-1062' ],
776     [ '3e-321', '%.1a', '0x1.3p-1065' ],
777     [ '3e-322', '%.1a', '0x1.ep-1069' ],
778     [ '3e-323', '%.1a', '0x1.8p-1072' ],
779     [ '3e-324', '%.1a', '0x1.0p-1074' ],
780     [ '0x1.fffffffffffffp-1022', '%a', '0x1.fffffffffffffp-1022' ],
781     [ '0x0.fffffffffffffp-1022', '%a', '0x1.ffffffffffffep-1023' ],
782     [ '0x0.7ffffffffffffp-1022', '%a', '0x1.ffffffffffffcp-1024' ],
783     [ '0x0.3ffffffffffffp-1022', '%a', '0x1.ffffffffffff8p-1025' ],
784     [ '0x0.1ffffffffffffp-1022', '%a', '0x1.ffffffffffffp-1026' ],
785     [ '0x0.0ffffffffffffp-1022', '%a', '0x1.fffffffffffep-1027' ],
786     );
787
788 SKIP: {
789     # [rt.perl.org #128843]
790     my $skip_count = scalar @subnormals + 34;
791     skip("non-IEEE-754-non-64-bit", $skip_count)
792         unless ($Config{nvsize} == 8 &&
793                 $Config{nv_preserves_uv_bits} == 53 &&
794                 ($Config{doublekind} == 3 ||
795                  $Config{doublekind} == 4));
796     if ($^O eq 'dec_osf') {
797         skip("$^O subnormals", $skip_count);
798     }
799
800     for my $t (@subnormals) {
801         # Note that "0x1p+2" is not considered numeric,
802         # since neither is "0x12", hence the eval.
803         my $s = sprintf($t->[1], eval $t->[0]);
804         is($s, $t->[2], "subnormal @$t got $s");
805     }
806
807     # [rt.perl.org #128888]
808     is(sprintf("%a", 1.03125),   "0x1.08p+0");
809     is(sprintf("%.1a", 1.03125), "0x1.0p+0");
810     is(sprintf("%.0a", 1.03125), "0x1p+0", "[rt.perl.org #128888]");
811
812     # [rt.perl.org #128889]
813     is(sprintf("%.*a", -1, 1.03125), "0x1.08p+0", "[rt.perl.org #128889]");
814
815     # [rt.perl.org #128890]
816     is(sprintf("%a", 0x1.18p+0), "0x1.18p+0");
817     is(sprintf("%.1a", 0x1.08p+0), "0x1.0p+0");
818     is(sprintf("%.1a", 0x1.18p+0), "0x1.2p+0", "[rt.perl.org #128890]");
819     is(sprintf("%.1a", 0x1.28p+0), "0x1.2p+0");
820     is(sprintf("%.1a", 0x1.38p+0), "0x1.4p+0");
821     is(sprintf("%.1a", 0x1.48p+0), "0x1.4p+0");
822     is(sprintf("%.1a", 0x1.58p+0), "0x1.6p+0");
823     is(sprintf("%.1a", 0x1.68p+0), "0x1.6p+0");
824     is(sprintf("%.1a", 0x1.78p+0), "0x1.8p+0");
825     is(sprintf("%.1a", 0x1.88p+0), "0x1.8p+0");
826     is(sprintf("%.1a", 0x1.98p+0), "0x1.ap+0");
827     is(sprintf("%.1a", 0x1.a8p+0), "0x1.ap+0");
828     is(sprintf("%.1a", 0x1.b8p+0), "0x1.cp+0");
829     is(sprintf("%.1a", 0x1.c8p+0), "0x1.cp+0");
830     is(sprintf("%.1a", 0x1.d8p+0), "0x1.ep+0");
831     is(sprintf("%.1a", 0x1.e8p+0), "0x1.ep+0");
832     is(sprintf("%.1a", 0x1.f8p+0), "0x2.0p+0");
833
834     is(sprintf("%.1a", 0x1.10p+0), "0x1.1p+0");
835     is(sprintf("%.1a", 0x1.17p+0), "0x1.1p+0");
836     is(sprintf("%.1a", 0x1.19p+0), "0x1.2p+0");
837     is(sprintf("%.1a", 0x1.1fp+0), "0x1.2p+0");
838
839     is(sprintf("%.2a", 0x1.fffp+0), "0x2.00p+0");
840     is(sprintf("%.2a", 0xf.fffp+0), "0x2.00p+3");
841
842     # [rt.perl.org #128893]
843     is(sprintf("%020a", 1.5), "0x0000000000001.8p+0");
844     is(sprintf("%020a", -1.5), "-0x000000000001.8p+0", "[rt.perl.org #128893]");
845     is(sprintf("%+020a", 1.5), "+0x000000000001.8p+0", "[rt.perl.org #128893]");
846     is(sprintf("% 020a", 1.5), " 0x000000000001.8p+0", "[rt.perl.org #128893]");
847     is(sprintf("%20a", -1.5), "           -0x1.8p+0");
848     is(sprintf("%+20a", 1.5), "           +0x1.8p+0");
849     is(sprintf("% 20a", 1.5), "            0x1.8p+0");
850 }
851
852 # x86 80-bit long-double tests for
853 # rt.perl.org #128843, #128888, #128889, #128890, #128893, #128909
854 SKIP: {
855     skip("non-80-bit-long-double", 17)
856         unless ($Config{uselongdouble} &&
857                 ($Config{nvsize} == 16 || $Config{nvsize} == 12) &&
858                 ($Config{long_double_style_ieee_extended}));
859
860     {
861         # The last normal for this format.
862         is(sprintf("%a", eval '0x1p-16382'), "0x8p-16385", "[rt.perl.org #128843]");
863
864         # The subnormals cause "exponent underflow" warnings,
865         # but that is not why we are here.
866         local $SIG{__WARN__} = sub {
867             die "$0: $_[0]" unless $_[0] =~ /exponent underflow/;
868         };
869
870         is(sprintf("%a", eval '0x1p-16383'), "0x4p-16382", "[rt.perl.org #128843]");
871         is(sprintf("%a", eval '0x1p-16384'), "0x2p-16382", "[rt.perl.org #128843]");
872         is(sprintf("%a", eval '0x1p-16385'), "0x1p-16382", "[rt.perl.org #128843]");
873         is(sprintf("%a", eval '0x1p-16386'), "0x8p-16386", "[rt.perl.org #128843]");
874         is(sprintf("%a", eval '0x1p-16387'), "0x4p-16386", "[rt.perl.org #128843]");
875     }
876     is(sprintf("%.0a", 1.03125), "0x8p-3", "[rt.perl.org #128888]");
877     is(sprintf("%.*a", -1, 1.03125), "0x8.4p-3", "[rt.perl.org #128889]");
878     is(sprintf("%.1a", 0x8.18p+0), "0x8.2p+0", "[rt.perl.org #128890]");
879     is(sprintf("%020a", -1.5), "-0x0000000000000cp-3", "[rt.perl.org #128893]");
880     is(sprintf("%+020a", 1.5), "+0x0000000000000cp-3", "[rt.perl.org #128893]");
881     is(sprintf("% 020a", 1.5), " 0x0000000000000cp-3", "[rt.perl.org #128893]");
882     is(sprintf("%a", 1.9999999999999999999), "0xf.fffffffffffffffp-3");
883     is(sprintf("%.3a", 1.9999999999999999999), "0x1.000p+1", "[rt.perl.org #128909]");
884     is(sprintf("%.2a", 1.9999999999999999999), "0x1.00p+1");
885     is(sprintf("%.1a", 1.9999999999999999999), "0x1.0p+1");
886     is(sprintf("%.0a", 1.9999999999999999999), "0x1p+1");
887 }
888
889 # quadmath tests for rt.perl.org #128843
890 SKIP: {
891     skip "need quadmath", 7, unless $Config{usequadmath};
892
893     is(sprintf("%a", eval '0x1p-16382'), '0x1p-16382');  # last normal
894
895     local $SIG{__WARN__} = sub {
896         die "$0: $_[0]" unless $_[0] =~ /exponent underflow/;
897     };
898
899     is(sprintf("%a", eval '0x1p-16383'), '0x1p-16383');
900     is(sprintf("%a", eval '0x1p-16384'), '0x1p-16384');
901
902     is(sprintf("%a", eval '0x1p-16491'), '0x1p-16491');
903     is(sprintf("%a", eval '0x1p-16492'), '0x1p-16492');
904     is(sprintf("%a", eval '0x1p-16493'), '0x1p-16493'); # last denormal
905
906     is(sprintf("%a", eval '0x1p-16494'), '0x1p-16494'); # underflow
907 }
908
909 # check all calls to croak_memory_wrap()
910 # RT #131260
911
912 {
913     my $s = 8 * $Config{sizesize};
914     my $i = 1;
915     my $max;
916     while ($s--) { $max |= $i; $i <<= 1; }
917
918     my @tests = (
919                   # format, arg
920                   ["%.${max}a",        1.1 ],
921                   ["%.${max}i",          1 ],
922                   ["%.${max}i",         -1 ],
923     );
924
925     for my $test (@tests) {
926         my ($fmt, $arg) = @$test;
927         eval { my $s = sprintf $fmt, $arg; };
928         like("$@", qr/panic: memory wrap/, qq{memory wrap: "$fmt", "$arg"});
929     }
930 }
931
932 {
933     # handle utf8 correctly when skipping invalid format
934     my $w_red   = 0;
935     my $w_inv   = 0;
936     my $w_other = 0;
937     local $SIG{__WARN__} = sub {
938         if ($_[0] =~ /^Invalid conversion/) {
939             $w_inv++;
940         }
941         elsif ($_[0] =~ /^Redundant argument/) {
942             $w_red++;
943         }
944         else {
945             $w_other++;
946         }
947     };
948
949     use warnings;
950     my $s = sprintf "%s%\xc4\x80%s", "\x{102}", "\xc4\x83";
951     is($s, "\x{102}%\xc4\x80\xc4\x83", "utf8 for invalid format");
952     is($w_inv,   1, "utf8 for invalid format: invalid warnings");
953     is($w_red,   0, "utf8 for invalid format: redundant warnings");
954     is($w_other, 0, "utf8 for invalid format: other warnings");
955 }
956
957 # it used to upgrade the result to utf8 if the 1st arg happened to be utf8
958
959 {
960     my $precis = "9";
961     utf8::upgrade($precis);
962     my $s = sprintf "%.*f\n", $precis, 1.1;
963     ok(!utf8::is_utf8($s), "first arg not special utf8-wise");
964 }
965
966 # sprintf("%n") used to croak "Modification of a read-only value"
967 # as it tried to set &PL_sv_no
968
969 {
970     eval { my $s = sprintf("%n"); };
971     like $@, qr/Missing argument for %n in sprintf/, "%n";
972 }
973
974 done_testing();