This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
1de85c2055b94f2d00ef6e7088b5e8f489125423
[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     @INC = '../lib';
8     require './test.pl';
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 # %a and %A depend on the floating point config
16 # This totally doesn't test non-IEEE-754 float formats.
17 my @hexfloat;
18 print "# uvsize = $Config{uvsize}\n";
19 print "# nvsize = $Config{nvsize}\n";
20 print "# nv_preserves_uv_bits = $Config{nv_preserves_uv_bits}\n";
21 print "# d_quad = $Config{d_quad}\n";
22 if ($Config{nvsize} == 8 &&
23     (
24      # IEEE-754, we hope, the most common out there.
25      ($Config{uvsize} == 8 && $Config{nv_preserves_uv_bits} == 53)
26      ||
27      # If we have a quad we can still get the mantissa bits.
28      ($Config{uvsize} == 4 && $Config{d_quad})
29      )
30     ) {
31     @hexfloat =  (
32         [ '%a',       '0',       '0x0p+0' ],
33         [ '%a',       '1',       '0x1p+0' ],
34         [ '%a',       '1.0',     '0x1p+0' ],
35         [ '%a',       '0.5',     '0x1p-1' ],
36         [ '%a',       '0.25',    '0x1p-2' ],
37         [ '%a',       '0.75',    '0x1.8p-1' ],
38         [ '%a',       '3.14',    '0x1.91eb851eb851fp+1' ],
39         [ '%a',       '-1.0',    '-0x1p+0' ],
40         [ '%a',       '-3.14',   '-0x1.91eb851eb851fp+1' ],
41         [ '%a',       '0.1',     '0x1.999999999999ap-4' ],
42         [ '%a',       '1/7',     '0x1.2492492492492p-3' ],
43         [ '%a',       'sqrt(2)', '0x1.6a09e667f3bcdp+0' ],
44         [ '%a',       'exp(1)',  '0x1.5bf0a8b145769p+1' ],
45         [ '%a',       '2**-10',  '0x1p-10' ],
46         [ '%a',       '2**10',   '0x1p+10' ],
47         [ '%a',       '1e-9',    '0x1.12e0be826d695p-30' ],
48         [ '%a',       '1e9',     '0x1.dcd65p+29' ],
49
50         [ '%#a',      '1',       '0x1.p+0' ],
51         [ '%+a',      '1',       '+0x1p+0' ],
52         [ '%+a',      '-1',      '-0x1p+0' ],
53         [ '% a',      ' 1',      ' 0x1p+0' ],
54         [ '% a',      '-1',      '-0x1p+0' ],
55
56         [ '%8a',      '3.14',   '0x1.91eb851eb851fp+1' ],
57         [ '%13a',     '3.14',   '0x1.91eb851eb851fp+1' ],
58         [ '%20a',     '3.14',   '0x1.91eb851eb851fp+1' ],
59         [ '%.4a',     '3.14',   '0x1.91ecp+1' ],
60         [ '%.5a',     '3.14',   '0x1.91eb8p+1' ],
61         [ '%.6a',     '3.14',   '0x1.91eb85p+1' ],
62         [ '%.20a',    '3.14',   '0x1.91eb851eb851f0000000p+1' ],
63         [ '%20.10a',  '3.14',   '   0x1.91eb851eb8p+1' ],
64         [ '%20.15a',  '3.14',   '0x1.91eb851eb851f00p+1' ],
65         [ '% 20.10a', '3.14',   '   0x1.91eb851eb8p+1' ],
66         [ '%020.10a', '3.14',   '0x0001.91eb851eb8p+1' ],
67
68         [ '%30a',  '3.14',   '          0x1.91eb851eb851fp+1' ],
69         [ '%-30a', '3.14',   '0x1.91eb851eb851fp+1          ' ],
70         [ '%030a',  '3.14',  '0x00000000001.91eb851eb851fp+1' ],
71         [ '%-030a', '3.14',  '0x1.91eb851eb851fp+1          ' ],
72
73         [ '%A',       '3.14',   '0X1.91EB851EB851FP+1' ],
74         );
75 } elsif (($Config{nvsize} == 16 || $Config{nvsize} == 12) &&
76          # 80-bit long double, pack F is the NV
77          (pack("F", 0.1) =~ /^\xCD/ ||  # LE
78           pack("F", 0.1) =~ /\xCD$/)) { # BE (if this ever happens)
79     @hexfloat =  (
80         [ '%a',       '0',       '0x0p+0' ],
81         [ '%a',       '1',       '0x8p-3' ],
82         [ '%a',       '1.0',     '0x8p-3' ],
83         [ '%a',       '0.5',     '0x8p-4' ],
84         [ '%a',       '0.25',    '0x8p-5' ],
85         [ '%a',       '0.75',    '0xcp-4' ],
86         [ '%a',       '3.14',    '0xc.8f5c28f5c28f5c3p-2' ],
87         [ '%a',       '-1.0',    '-0x8p-3' ],
88         [ '%a',       '-3.14',   '-0xc.8f5c28f5c28f5c3p-2' ],
89         [ '%a',       '0.1',     '0xc.ccccccccccccccdp-7' ],
90         [ '%a',       '1/7',     '0x9.249249249249249p-6' ],
91         [ '%a',       'sqrt(2)', '0xb.504f333f9de6484p-3' ],
92         [ '%a',       'exp(1)',  '0xa.df85458a2bb4a9bp-2' ],
93         [ '%a',       '2**-10',  '0x8p-13' ],
94         [ '%a',       '2**10',   '0x8p+7' ],
95         [ '%a',       '1e-9',    '0x8.9705f4136b4a597p-33' ],
96         [ '%a',       '1e9',     '0xe.e6b28p+26' ],
97
98         [ '%#a',      '1',       '0x8.p-3' ],
99         [ '%+a',      '1',       '+0x8p-3' ],
100         [ '%+a',      '-1',      '-0x8p-3' ],
101         [ '% a',      ' 1',      ' 0x8p-3' ],
102         [ '% a',      '-1',      '-0x8p-3' ],
103
104         [ '%8a',      '3.14',    '0xc.8f5c28f5c28f5c3p-2' ],
105         [ '%13a',     '3.14',    '0xc.8f5c28f5c28f5c3p-2' ],
106         [ '%20a',     '3.14',    '0xc.8f5c28f5c28f5c3p-2' ],
107         [ '%.4a',     '3.14',    '0xc.8f5cp-2' ],
108         [ '%.5a',     '3.14',    '0xc.8f5c3p-2' ],
109         [ '%.6a',     '3.14',    '0xc.8f5c29p-2' ],
110         [ '%.20a',    '3.14',    '0xc.8f5c28f5c28f5c300000p-2' ],
111         [ '%20.10a',  '3.14',    '   0xc.8f5c28f5c3p-2' ],
112         [ '%20.15a',  '3.14',    '0xc.8f5c28f5c28f5c3p-2' ],
113         [ '% 20.10a', '3.14',    '   0xc.8f5c28f5c3p-2' ],
114         [ '%020.10a', '3.14',    '0x000c.8f5c28f5c3p-2' ],
115
116         [ '%30a',  '3.14',   '        0xc.8f5c28f5c28f5c3p-2' ],
117         [ '%-30a', '3.14',   '0xc.8f5c28f5c28f5c3p-2        ' ],
118         [ '%030a',  '3.14',  '0x00000000c.8f5c28f5c28f5c3p-2' ],
119         [ '%-030a', '3.14',  '0xc.8f5c28f5c28f5c3p-2        ' ],
120
121         [ '%A',       '3.14',    '0XC.8F5C28F5C28F5C3P-2' ],
122         );
123 } else {
124     print "# no hexfloat tests\n";
125 }
126
127 plan tests => 1406 + ($Q ? 0 : 12) + @hexfloat;
128
129 use strict;
130 use Config;
131
132 is(
133     sprintf("%.40g ",0.01),
134     sprintf("%.40g", 0.01)." ",
135     q(the sprintf "%.<number>g" optimization)
136 );
137 is(
138     sprintf("%.40f ",0.01),
139     sprintf("%.40f", 0.01)." ",
140     q(the sprintf "%.<number>f" optimization)
141 );
142
143 # cases of $i > 1 are against [perl #39126]
144 for my $i (1, 5, 10, 20, 50, 100) {
145     chop(my $utf8_format = "%-*s\x{100}");
146     my $string = "\xB4"x$i;        # latin1 ACUTE or ebcdic COPYRIGHT
147     my $expect = $string."  "x$i;  # followed by 2*$i spaces
148     is(sprintf($utf8_format, 3*$i, $string), $expect,
149        "width calculation under utf8 upgrade, length=$i");
150 }
151
152 # check simultaneous width & precision with wide characters
153 for my $i (1, 3, 5, 10) {
154     my $string = "\x{0410}"x($i+10);   # cyrillic capital A
155     my $expect = "\x{0410}"x$i;        # cut down to exactly $i characters
156     my $format = "%$i.${i}s";
157     is(sprintf($format, $string), $expect,
158        "width & precision interplay with utf8 strings, length=$i");
159 }
160
161 # Used to mangle PL_sv_undef
162 fresh_perl_like(
163     'print sprintf "xxx%n\n"; print undef',
164     qr/Modification of a read-only value attempted at - line 1\./,
165     { switches => [ '-w' ] },
166     q(%n should not be able to modify read-only constants),
167 );
168
169 # check overflows
170 for (int(~0/2+1), ~0, "9999999999999999999") {
171     is(eval {sprintf "%${_}d", 0}, undef, "no sprintf result expected %${_}d");
172     like($@, qr/^Integer overflow in format string for sprintf /, "overflow in sprintf");
173     is(eval {printf "%${_}d\n", 0}, undef, "no printf result expected %${_}d");
174     like($@, qr/^Integer overflow in format string for printf /, "overflow in printf");
175 }
176
177 # check %NNN$ for range bounds
178 {
179     my ($warn, $bad) = (0,0);
180     local $SIG{__WARN__} = sub {
181         if ($_[0] =~ /missing argument/i) {
182             $warn++
183         }
184         else {
185             $bad++
186         }
187     };
188
189     my $fmt = join('', map("%$_\$s%" . ((1 << 31)-$_) . '$s', 1..20));
190     my $result = sprintf $fmt, qw(a b c d);
191     is($result, "abcd", "only four valid values in $fmt");
192     is($warn, 36, "expected warnings");
193     is($bad,   0, "unexpected warnings");
194 }
195
196 # Tests for "missing argument" and "redundant argument" warnings
197 {
198     my ($warn_missing, $warn_redundant, $warn_bad) = (0,0,0);
199     local $SIG{__WARN__} = sub {
200         if ($_[0] =~ /missing argument/i) {
201             $warn_missing++
202         }
203         elsif ($_[0] =~ /redundant argument/i) {
204             $warn_redundant++
205         }
206         else {
207             $warn_bad++
208         }
209     };
210
211     my @tests = (
212         # The "", "%s", and "%-p" formats have special-case handling
213         # in sv.c
214         {
215             fmt  => "",
216             args => [ qw( x ) ],
217             res  => "",
218             m    => 0,
219             r    => 1,
220         },
221         {
222             fmt  => "%s",
223             args => [ qw( x y ) ],
224             res  => "x",
225             m    => 0,
226             r    => 1,
227         },
228         {
229             fmt  => "%-p",
230             args => [ qw( x y ) ],
231             res  => qr/^[0-9a-f]+$/as,
232             m    => 0,
233             r    => 1,
234         },
235         # Other non-specialcased patterns
236         {
237             fmt  => "%s : %s",
238             args => [ qw( a b c ) ],
239             res  => "a : b",
240             m    => 0,
241             r    => 1,
242         },
243         {
244             fmt  => "%s : %s : %s",
245             args => [ qw( a b c d e ) ],
246             res  => "a : b : c",
247             m    => 0,
248             # Note how we'll only warn about redundant arguments once,
249             # even though both "d" and "e" are redundant...
250             r    => 1,
251         },
252         {
253             fmt  => "%s : %s : %s",
254             args => [ ],
255             res  => " :  : ",
256             # ...But when arguments are missing we'll warn about every
257             # missing argument. This difference between the two
258             # warnings is a feature.
259             m    => 3,
260             r    => 0,
261         },
262
263         # Tests for format parameter indexes.
264         #
265         # Deciding what to do about these is a bit tricky, and so is
266         # "correctly" warning about missing arguments on them.
267         #
268         # Should we warn if you supply 4 arguments but only use
269         # argument 1,3 & 4? Or only if you supply 5 arguments and your
270         # highest used argument is 4?
271         #
272         # For some uses of this printf feature (e.g. i18n systems)
273         # it's a always a logic error to not print out every provided
274         # argument, but for some other uses skipping some might be a
275         # feature (although you could argue that then printf should be
276         # called as e.g:
277         #
278         #     printf q[%1$s %3$s], x(), undef, z();
279         #
280         # Instead of:
281         #
282         #    printf q[%1$s %3$s], x(), y(), z();
283         #
284         # Since calling the (possibly expensive) y() function is
285         # completely redundant there.
286         #
287         # We deal with all these potential problems by not even
288         # trying. If the pattern contains any format parameter indexes
289         # whatsoever we'll never warn about redundant arguments.
290         {
291             fmt  => '%1$s : %2$s',
292             args => [ qw( x y z ) ],
293             res  => "x : y",
294             m    => 0,
295             r    => 0,
296         },
297         {
298             fmt  => '%2$s : %4$s : %5$s',
299             args => [ qw( a b c d )],
300             res  => "b : d : ",
301             m    => 1,
302             r    => 0,
303         },
304         {
305             fmt  => '%s : %1$s : %s',
306             args => [ qw( x y z ) ],
307             res  => "x : x : y",
308             m    => 0,
309             r    => 0,
310         },
311
312     );
313
314     for my $i (0..$#tests) {
315         my $test = $tests[$i];
316         my $result = sprintf $test->{fmt}, @{$test->{args}};
317
318         my $prefix = "For format '$test->{fmt}' and arguments/result '@{$test->{args}}'/'$result'";
319         if (ref $test->{res} eq 'Regexp') {
320             like($result, $test->{res}, "$prefix got the right result");
321         } else {
322             is($result, $test->{res}, "$prefix got the right result");
323         }
324         is($warn_missing, $test->{m}, "$prefix got '$test->{m}' 'missing argument' warnings");
325         is($warn_redundant, $test->{r}, "$prefix got '$test->{r}' 'redundant argument' warnings");
326         is($warn_bad, 0, "$prefix No unknown warnings");
327
328         ($warn_missing, $warn_redundant, $warn_bad) = (0,0,0);
329     }
330 }
331
332 {
333     foreach my $ord (0 .. 255) {
334         my $bad = 0;
335         local $SIG{__WARN__} = sub {
336             if ($_[0] !~ /^Invalid conversion in sprintf/) {
337                 warn $_[0];
338                 $bad++;
339             }
340         };
341         my $r = eval {sprintf '%v' . chr $ord};
342         is ($bad, 0, "pattern '%v' . chr $ord");
343     }
344 }
345
346 sub mysprintf_int_flags {
347     my ($fmt, $num) = @_;
348     die "wrong format $fmt" if $fmt !~ /^%([-+ 0]+)([1-9][0-9]*)d\z/;
349     my $flag  = $1;
350     my $width = $2;
351     my $sign  = $num < 0 ? '-' :
352                 $flag =~ /\+/ ? '+' :
353                 $flag =~ /\ / ? ' ' :
354                 '';
355     my $abs   = abs($num);
356     my $padlen = $width - length($sign.$abs);
357     return
358         $flag =~ /0/ && $flag !~ /-/ # do zero padding
359             ? $sign . '0' x $padlen . $abs
360             : $flag =~ /-/ # left or right
361                 ? $sign . $abs . ' ' x $padlen
362                 : ' ' x $padlen . $sign . $abs;
363 }
364
365 # Whole tests for "%4d" with 2 to 4 flags;
366 # total counts: 3 * (4**2 + 4**3 + 4**4) == 1008
367
368 my @flags = ("-", "+", " ", "0");
369 for my $num (0, -1, 1) {
370     for my $f1 (@flags) {
371         for my $f2 (@flags) {
372             for my $f3 ('', @flags) { # '' for doubled flags
373                 my $flag = $f1.$f2.$f3;
374                 my $width = 4;
375                 my $fmt   = '%'."${flag}${width}d";
376                 my $result = sprintf($fmt, $num);
377                 my $expect = mysprintf_int_flags($fmt, $num);
378                 is($result, $expect, qq/sprintf("$fmt",$num)/);
379
380                 next if $f3 eq '';
381
382                 for my $f4 (@flags) { # quadrupled flags
383                     my $flag = $f1.$f2.$f3.$f4;
384                     my $fmt   = '%'."${flag}${width}d";
385                     my $result = sprintf($fmt, $num);
386                     my $expect = mysprintf_int_flags($fmt, $num);
387                     is($result, $expect, qq/sprintf("$fmt",$num)/);
388                 }
389             }
390         }
391     }
392 }
393
394 # test that %f doesn't panic with +Inf, -Inf, NaN [perl #45383]
395 foreach my $n (2**1e100, -2**1e100, 2**1e100/2**1e100) { # +Inf, -Inf, NaN
396     eval { my $f = sprintf("%f", $n); };
397     is $@, "", "sprintf(\"%f\", $n)";
398 }
399
400 # test %ll formats with and without HAS_QUAD
401 my @tests = (
402   [ '%lld' => [qw( 4294967296 -100000000000000 )] ],
403   [ '%lli' => [qw( 4294967296 -100000000000000 )] ],
404   [ '%llu' => [qw( 4294967296  100000000000000 )] ],
405   [ '%Ld'  => [qw( 4294967296 -100000000000000 )] ],
406   [ '%Li'  => [qw( 4294967296 -100000000000000 )] ],
407   [ '%Lu'  => [qw( 4294967296  100000000000000 )] ],
408 );
409
410 for my $t (@tests) {
411   my($fmt, $nums) = @$t;
412   for my $num (@$nums) {
413     my $w = '';
414     local $SIG{__WARN__} = sub { $w .= shift };
415     my $sprintf_got = sprintf($fmt, $num);
416     if ($Q) {
417       is($sprintf_got, $num, "quad: $fmt -> $num");
418       is($w, '', "no warnings for: $fmt -> $num");
419     } else {
420       is($sprintf_got, $fmt, "quad unsupported: $fmt -> $fmt");
421       like($w, qr/Invalid conversion in sprintf: "$fmt"/, "got warning about invalid conversion from fmt : $fmt");
422       like($w, qr/Redundant argument in sprintf/, "got warning about redundant argument in sprintf from fmt : $fmt");
423     }
424   }
425 }
426
427 # Check unicode vs byte length
428 for my $width (1,2,3,4,5,6,7) {
429     for my $precis (1,2,3,4,5,6,7) {
430         my $v = "\x{20ac}\x{20ac}";
431         my $format = "%" . $width . "." . $precis . "s";
432         my $chars = ($precis > 2 ? 2 : $precis);
433         my $space = ($width < 2 ? 0 : $width - $chars);
434         fresh_perl_is(
435             'my $v = "\x{20ac}\x{20ac}"; my $x = sprintf "'.$format.'", $v; $x =~ /^(\s*)(\S*)$/; print "$_" for map {length} $1, $2',
436             "$space$chars",
437             {},
438             q(sprintf ").$format.q(", "\x{20ac}\x{20ac}"),
439         );
440     }
441 }
442
443 # Overload count
444 package o { use overload '""', sub { ++our $count; $_[0][0]; } }
445 my $o = bless ["\x{100}"], o::;
446 () = sprintf "%1s", $o;
447 is $o::count, '1', 'sprinf %1s overload count';
448 $o::count = 0;
449 () = sprintf "%.1s", $o;
450 is $o::count, '1', 'sprinf %.1s overload count';
451
452 for my $t (@hexfloat) {
453     my ($format, $arg, $expected) = @$t;
454     $arg = eval $arg;
455     my $result = sprintf($format, $arg);
456     is($result, $expected, "'$format' '$arg' -> '$result' cf '$expected'");
457 }