This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
The assert()ions in sv_chop() that the passed in pointer is within the
[perl5.git] / t / op / write.t
CommitLineData
a687059c
LW
1#!./perl
2
9ccde9ea
JH
3BEGIN {
4 chdir 't' if -d 't';
5 @INC = '../lib';
6108250c 6 require './test.pl';
9ccde9ea
JH
7}
8
90f67b00
NC
9use strict; # Amazed that this hackery can be made strict ...
10
a344b90b
DM
11# read in a file
12sub cat {
13 my $file = shift;
14 local $/;
15 open my $fh, $file or die "can't open '$file': $!";
16 my $data = <$fh>;
17 close $fh;
18 $data;
19}
20
a1b95068
LW
21#-- testing numeric fields in all variants (WL)
22
23sub swrite {
24 my $format = shift;
25 local $^A = ""; # don't litter, use a local bin
26 formline( $format, @_ );
27 return $^A;
28}
29
30my @NumTests = (
d1f6232e 31 # [ format, value1, expected1, value2, expected2, .... ]
9acd3e2c
DM
32 [ '@###', 0, ' 0', 1, ' 1', 9999.6, '####',
33 9999.4999, '9999', -999.6, '####', 1e+100, '####' ],
d1f6232e 34
9acd3e2c
DM
35 [ '@0##', 0, '0000', 1, '0001', 9999.6, '####',
36 -999.4999, '-999', -999.6, '####', 1e+100, '####' ],
d1f6232e
DM
37
38 [ '^###', 0, ' 0', undef, ' ' ],
39
40 [ '^0##', 0, '0000', undef, ' ' ],
41
9acd3e2c
DM
42 [ '@###.', 0, ' 0.', 1, ' 1.', 9999.6, '#####',
43 9999.4999, '9999.', -999.6, '#####' ],
d1f6232e 44
9acd3e2c 45 [ '@##.##', 0, ' 0.00', 1, ' 1.00', 999.996, '######',
d1f6232e
DM
46 999.99499, '999.99', -100, '######' ],
47
48 [ '@0#.##', 0, '000.00', 1, '001.00', 10, '010.00',
8975a8c2 49 -0.0001, qr/^[\-0]00\.00$/ ],
d1f6232e
DM
50
51);
52
a1b95068
LW
53
54my $num_tests = 0;
55for my $tref ( @NumTests ){
d1f6232e 56 $num_tests += (@$tref - 1)/2;
a1b95068
LW
57}
58#---------------------------------------------------------
59
60# number of tests in section 1
61my $bas_tests = 20;
62
63# number of tests in section 3
003d2c64 64my $bug_tests = 4 + 3 * 3 * 5 * 2;
a1b95068 65
f5b75c1c
NC
66# number of tests in section 4
67my $hmb_tests = 35;
68
69my $tests = $bas_tests + $num_tests + $bug_tests + $hmb_tests;
6108250c
NC
70
71plan $tests;
a687059c 72
a1b95068
LW
73############
74## Section 1
75############
76
90f67b00
NC
77use vars qw($fox $multiline $foo $good);
78
a687059c
LW
79format OUT =
80the quick brown @<<
81$fox
82jumped
83@*
84$multiline
85^<<<<<<<<<
86$foo
87^<<<<<<<<<
88$foo
89^<<<<<<...
90$foo
91now @<<the@>>>> for all@|||||men to come @<<<<
a0d0e21e
LW
92{
93 'i' . 's', "time\n", $good, 'to'
94}
a687059c
LW
95.
96
a0d0e21e 97open(OUT, '>Op_write.tmp') || die "Can't create Op_write.tmp";
19f4d710 98END { 1 while unlink 'Op_write.tmp' }
a687059c
LW
99
100$fox = 'foxiness';
101$good = 'good';
102$multiline = "forescore\nand\nseven years\n";
103$foo = 'when in the course of human events it becomes necessary';
104write(OUT);
d1e4d418 105close OUT or die "Could not close: $!";
a687059c 106
90f67b00 107my $right =
a687059c
LW
108"the quick brown fox
109jumped
110forescore
111and
112seven years
113when in
114the course
115of huma...
116now is the time for all good men to come to\n";
117
2027357e 118is cat('Op_write.tmp'), $right and do { 1 while unlink 'Op_write.tmp'; };
a687059c 119
748a9306
LW
120$fox = 'wolfishness';
121my $fox = 'foxiness'; # Test a lexical variable.
122
a687059c
LW
123format OUT2 =
124the quick brown @<<
125$fox
126jumped
127@*
128$multiline
129^<<<<<<<<< ~~
130$foo
131now @<<the@>>>> for all@|||||men to come @<<<<
132'i' . 's', "time\n", $good, 'to'
133.
134
a0d0e21e 135open OUT2, '>Op_write.tmp' or die "Can't create Op_write.tmp";
a687059c 136
a687059c
LW
137$good = 'good';
138$multiline = "forescore\nand\nseven years\n";
139$foo = 'when in the course of human events it becomes necessary';
140write(OUT2);
d1e4d418 141close OUT2 or die "Could not close: $!";
a687059c
LW
142
143$right =
144"the quick brown fox
145jumped
146forescore
147and
148seven years
149when in
150the course
151of human
152events it
153becomes
154necessary
155now is the time for all good men to come to\n";
156
2027357e 157is cat('Op_write.tmp'), $right and do { 1 while unlink 'Op_write.tmp'; };
a687059c 158
0f85fab0
LW
159eval <<'EOFORMAT';
160format OUT2 =
161the brown quick @<<
162$fox
163jumped
164@*
165$multiline
a0d0e21e 166and
0f85fab0
LW
167^<<<<<<<<< ~~
168$foo
169now @<<the@>>>> for all@|||||men to come @<<<<
170'i' . 's', "time\n", $good, 'to'
171.
172EOFORMAT
173
a0d0e21e 174open(OUT2, '>Op_write.tmp') || die "Can't create Op_write.tmp";
0f85fab0
LW
175
176$fox = 'foxiness';
177$good = 'good';
178$multiline = "forescore\nand\nseven years\n";
179$foo = 'when in the course of human events it becomes necessary';
180write(OUT2);
d1e4d418 181close OUT2 or die "Could not close: $!";
0f85fab0
LW
182
183$right =
184"the brown quick fox
185jumped
186forescore
187and
188seven years
a0d0e21e 189and
0f85fab0
LW
190when in
191the course
192of human
193events it
194becomes
195necessary
196now is the time for all good men to come to\n";
197
2027357e 198is cat('Op_write.tmp'), $right and do { 1 while unlink 'Op_write.tmp' };
0f85fab0 199
55497cff
PP
200# formline tests
201
90f67b00 202$right = <<EOT;
55497cff
PP
203@ a
204@> ab
205@>> abc
206@>>> abc
207@>>>> abc
208@>>>>> abc
209@>>>>>> abc
210@>>>>>>> abc
211@>>>>>>>> abc
212@>>>>>>>>> abc
213@>>>>>>>>>> abc
214EOT
215
90f67b00
NC
216my $was1 = my $was2 = '';
217use vars '$format2';
55497cff
PP
218for (0..10) {
219 # lexical picture
220 $^A = '';
221 my $format1 = '@' . '>' x $_;
222 formline $format1, 'abc';
223 $was1 .= "$format1 $^A\n";
224 # global
225 $^A = '';
226 local $format2 = '@' . '>' x $_;
227 formline $format2, 'abc';
228 $was2 .= "$format2 $^A\n";
229}
90f67b00
NC
230is $was1, $right;
231is $was2, $right;
55497cff 232
7056ecde
URCI
233$^A = '';
234
235# more test
236
237format OUT3 =
238^<<<<<<...
239$foo
240.
241
242open(OUT3, '>Op_write.tmp') || die "Can't create Op_write.tmp";
243
244$foo = 'fit ';
245write(OUT3);
d1e4d418 246close OUT3 or die "Could not close: $!";
7056ecde
URCI
247
248$right =
249"fit\n";
250
2027357e
NC
251is cat('Op_write.tmp'), $right and do { 1 while unlink 'Op_write.tmp' };
252
7056ecde 253
445b3f51
GS
254# test lexicals and globals
255{
2027357e 256 my $test = curr_test();
445b3f51 257 my $this = "ok";
2027357e 258 our $that = $test;
445b3f51
GS
259 format LEX =
260@<<@|
261$this,$that
262.
263 open(LEX, ">&STDOUT") or die;
264 write LEX;
2027357e 265 $that = ++$test;
445b3f51 266 write LEX;
d1e4d418 267 close LEX or die "Could not close: $!";
2027357e 268 curr_test($test + 1);
445b3f51 269}
c2e66d9e
GS
270# LEX_INTERPNORMAL test
271my %e = ( a => 1 );
272format OUT4 =
273@<<<<<<
274"$e{a}"
275.
276open OUT4, ">Op_write.tmp" or die "Can't create Op_write.tmp";
277write (OUT4);
d1e4d418 278close OUT4 or die "Could not close: $!";
2027357e 279is cat('Op_write.tmp'), "1\n" and do { 1 while unlink "Op_write.tmp" };
784707d5
JP
280
281eval <<'EOFORMAT';
282format OUT10 =
283@####.## @0###.##
284$test1, $test1
285.
286EOFORMAT
287
288open(OUT10, '>Op_write.tmp') || die "Can't create Op_write.tmp";
289
90f67b00 290use vars '$test1';
784707d5
JP
291$test1 = 12.95;
292write(OUT10);
d1e4d418 293close OUT10 or die "Could not close: $!";
784707d5
JP
294
295$right = " 12.95 00012.95\n";
2027357e 296is cat('Op_write.tmp'), $right and do { 1 while unlink 'Op_write.tmp' };
784707d5
JP
297
298eval <<'EOFORMAT';
299format OUT11 =
300@0###.##
301$test1
302@ 0#
303$test1
304@0 #
305$test1
306.
307EOFORMAT
308
309open(OUT11, '>Op_write.tmp') || die "Can't create Op_write.tmp";
310
311$test1 = 12.95;
312write(OUT11);
d1e4d418 313close OUT11 or die "Could not close: $!";
784707d5
JP
314
315$right =
316"00012.95
3171 0#
31810 #\n";
2027357e 319is cat('Op_write.tmp'), $right and do { 1 while unlink 'Op_write.tmp' };
9ccde9ea 320
31869a79 321{
2027357e 322 my $test = curr_test();
71f882da 323 my $el;
a1b95068 324 format OUT12 =
31869a79
AE
325ok ^<<<<<<<<<<<<<<~~ # sv_chop() naze
326$el
327.
2027357e 328 my %hash = ($test => 3);
a1b95068
LW
329 open(OUT12, '>Op_write.tmp') || die "Can't create Op_write.tmp";
330
31869a79 331 for $el (keys %hash) {
a1b95068 332 write(OUT12);
31869a79 333 }
a1b95068 334 close OUT12 or die "Could not close: $!";
a344b90b 335 print cat('Op_write.tmp');
2027357e 336 curr_test($test + 1);
31869a79
AE
337}
338
ea42cebc 339{
2027357e 340 my $test = curr_test();
ea42cebc
RGS
341 # Bug report and testcase by Alexey Tourbin
342 use Tie::Scalar;
343 my $v;
344 tie $v, 'Tie::StdScalar';
2027357e 345 $v = $test;
ea42cebc
RGS
346 format OUT13 =
347ok ^<<<<<<<<< ~~
348$v
349.
350 open(OUT13, '>Op_write.tmp') || die "Can't create Op_write.tmp";
351 write(OUT13);
352 close OUT13 or die "Could not close: $!";
a344b90b 353 print cat('Op_write.tmp');
2027357e 354 curr_test($test + 1);
ea42cebc
RGS
355}
356
a1b95068
LW
357{ # test 14
358 # Bug #24774 format without trailing \n failed assertion, but this
359 # must fail since we have a trailing ; in the eval'ed string (WL)
f5c235e7
DM
360 my @v = ('k');
361 eval "format OUT14 = \n@\n\@v";
2027357e 362 like $@, qr/Format not terminated/;
f5c235e7
DM
363}
364
a1b95068
LW
365{ # test 15
366 # text lost in ^<<< field with \r in value (WL)
367 my $txt = "line 1\rline 2";
368 format OUT15 =
369^<<<<<<<<<<<<<<<<<<
370$txt
371^<<<<<<<<<<<<<<<<<<
372$txt
373.
374 open(OUT15, '>Op_write.tmp') || die "Can't create Op_write.tmp";
375 write(OUT15);
376 close OUT15 or die "Could not close: $!";
a344b90b 377 my $res = cat('Op_write.tmp');
2027357e 378 is $res, "line 1\nline 2\n";
a1b95068
LW
379}
380
381{ # test 16: multiple use of a variable in same line with ^<
382 my $txt = "this_is_block_1 this_is_block_2 this_is_block_3 this_is_block_4";
383 format OUT16 =
384^<<<<<<<<<<<<<<<< ^<<<<<<<<<<<<<<<<
385$txt, $txt
386^<<<<<<<<<<<<<<<< ^<<<<<<<<<<<<<<<<
387$txt, $txt
388.
389 open(OUT16, '>Op_write.tmp') || die "Can't create Op_write.tmp";
390 write(OUT16);
391 close OUT16 or die "Could not close: $!";
a344b90b 392 my $res = cat('Op_write.tmp');
2027357e 393 is $res, <<EOD;
a1b95068
LW
394this_is_block_1 this_is_block_2
395this_is_block_3 this_is_block_4
396EOD
397}
398
399{ # test 17: @* "should be on a line of its own", but it should work
400 # cleanly with literals before and after. (WL)
401
402 my $txt = "This is line 1.\nThis is the second line.\nThird and last.\n";
403 format OUT17 =
404Here we go: @* That's all, folks!
405 $txt
406.
407 open(OUT17, '>Op_write.tmp') || die "Can't create Op_write.tmp";
408 write(OUT17);
409 close OUT17 or die "Could not close: $!";
a344b90b 410 my $res = cat('Op_write.tmp');
a1b95068
LW
411 chomp( $txt );
412 my $exp = <<EOD;
413Here we go: $txt That's all, folks!
414EOD
2027357e 415 is $res, $exp;
a1b95068
LW
416}
417
418{ # test 18: @# and ~~ would cause runaway format, but we now
419 # catch this while compiling (WL)
420
421 format OUT18 =
422@######## ~~
42310
424.
425 open(OUT18, '>Op_write.tmp') || die "Can't create Op_write.tmp";
426 eval { write(OUT18); };
2027357e 427 like $@, qr/Repeated format line will never terminate/;
a1b95068
LW
428 close OUT18 or die "Could not close: $!";
429}
430
431{ # test 19: \0 in an evel'ed format, doesn't cause empty lines (WL)
432 my $v = 'gaga';
433 eval "format OUT19 = \n" .
434 '@<<<' . "\0\n" .
435 '$v' . "\n" .
436 '@<<<' . "\0\n" .
437 '$v' . "\n.\n";
438 open(OUT19, '>Op_write.tmp') || die "Can't create Op_write.tmp";
439 write(OUT19);
a344b90b
DM
440 close OUT19 or die "Could not close: $!";
441 my $res = cat('Op_write.tmp');
2027357e 442 is $res, <<EOD;
a1b95068
LW
443gaga\0
444gaga\0
445EOD
446}
447
448{ # test 20: hash accesses; single '}' must not terminate format '}' (WL)
449 my %h = ( xkey => 'xval', ykey => 'yval' );
450 format OUT20 =
451@>>>> @<<<< ~~
452each %h
453@>>>> @<<<<
454$h{xkey}, $h{ykey}
455@>>>> @<<<<
456{ $h{xkey}, $h{ykey}
457}
458}
459.
460 my $exp = '';
461 while( my( $k, $v ) = each( %h ) ){
462 $exp .= sprintf( "%5s %s\n", $k, $v );
463 }
464 $exp .= sprintf( "%5s %s\n", $h{xkey}, $h{ykey} );
465 $exp .= sprintf( "%5s %s\n", $h{xkey}, $h{ykey} );
466 $exp .= "}\n";
467 open(OUT20, '>Op_write.tmp') || die "Can't create Op_write.tmp";
468 write(OUT20);
a344b90b
DM
469 close OUT20 or die "Could not close: $!";
470 my $res = cat('Op_write.tmp');
2027357e 471 is $res, $exp;
a1b95068
LW
472}
473
474
475#####################
476## Section 2
477## numeric formatting
478#####################
479
2027357e
NC
480curr_test($bas_tests + 1);
481
a1b95068
LW
482for my $tref ( @NumTests ){
483 my $writefmt = shift( @$tref );
d1f6232e
DM
484 while (@$tref) {
485 my $val = shift @$tref;
486 my $expected = shift @$tref;
a1b95068 487 my $writeres = swrite( $writefmt, $val );
2027357e
NC
488 if (ref $expected) {
489 like $writeres, $expected, $writefmt;
490 } else {
491 is $writeres, $expected, $writefmt;
492 }
a1b95068
LW
493 }
494}
495
496
497#####################################
498## Section 3
f5b75c1c 499## Easiest to add new tests just here
2027357e 500#####################################
9ccde9ea 501
30a1e583
DM
502# DAPM. Exercise a couple of error codepaths
503
504{
505 local $~ = '';
506 eval { write };
6108250c 507 like $@, qr/Not a format reference/, 'format reference';
30a1e583
DM
508
509 $~ = "NOSUCHFORMAT";
510 eval { write };
6108250c 511 like $@, qr/Undefined format/, 'no such format';
30a1e583
DM
512}
513
f3f2f1a3
NC
514{
515 my ($pound_utf8, $pm_utf8) = map { my $a = "$_\x{100}"; chop $a; $a}
516 my ($pound, $pm) = ("\xA3", "\xB1");
517
518 foreach my $first ('N', $pound, $pound_utf8) {
519 foreach my $base ('N', $pm, $pm_utf8) {
003d2c64
NC
520 foreach my $second ($base, "$base\n", "$base\nMoo!", "$base\nMoo!\n",
521 "$base\nMoo!\n",) {
522 foreach (['^*', qr/(.+)/], ['@*', qr/(.*?)$/s]) {
523 my ($format, $re) = @$_;
524 my $name = "$first, $second $format";
525 $name =~ s/\n/\\n/g;
526
527 my ($copy1, $copy2) = ($first, $second);
528 $first =~ /(.+)/ or die $first;
529 my $expect = "1${1}2";
530 $second =~ $re or die $second;
531 $expect .= " 3${1}4";
532
533 is swrite("1^*2 3${format}4", $copy1, $copy2), $expect, $name;
534 }
f3f2f1a3
NC
535 }
536 }
537 }
538}
9ccde9ea 539
d57f9278
MB
540format EMPTY =
541.
542
f5b75c1c 543my $test = curr_test();
6108250c 544
d57f9278
MB
545format Comment =
546ok @<<<<<
547$test
548.
549
d57f9278
MB
550
551# [ID 20020227.005] format bug with undefined _TOP
0bd0581c
DM
552
553open STDOUT_DUP, ">&STDOUT";
554my $oldfh = select STDOUT_DUP;
555$= = 10;
6108250c
NC
556{
557 local $~ = "Comment";
558 write;
559 curr_test($test + 1);
560 {
561 local $::TODO = '[ID 20020227.005] format bug with undefined _TOP';
562 is $-, 9;
563 }
564 is $^, "STDOUT_DUP_TOP";
0bd0581c
DM
565}
566select $oldfh;
68ba3c2c 567close STDOUT_DUP;
d57f9278 568
2027357e
NC
569#############################
570## Section 4
571## Add new tests *above* here
572#############################
573
f5b75c1c
NC
574# scary format testing from H.Merijn Brand
575
576# Just a complete test for format, including top-, left- and bottom marging
577# and format detection through glob entries
578
2027357e 579if ($^O eq 'VMS' || $^O eq 'MSWin32' || $^O eq 'dos' || $^O eq 'MacOS' ||
f5b75c1c
NC
580 ($^O eq 'os2' and not eval '$OS2::can_fork')) {
581 $test = curr_test();
582 SKIP: {
583 skip "'|-' and '-|' not supported", $tests - $test + 1;
584 }
585 exit(0);
586}
587
588
0bd0581c
DM
589$^ = "STDOUT_TOP";
590$= = 7; # Page length
591$- = 0; # Lines left
9ccde9ea
JH
592my $ps = $^L; $^L = ""; # Catch the page separator
593my $tm = 1; # Top margin (empty lines before first output)
594my $bm = 2; # Bottom marging (empty lines between last text and footer)
595my $lm = 4; # Left margin (indent in spaces)
596
68ba3c2c
DM
597# -----------------------------------------------------------------------
598#
599# execute the rest of the script in a child process. The parent reads the
600# output from the child and compares it with <DATA>.
601
602my @data = <DATA>;
603
604select ((select (STDOUT), $| = 1)[0]); # flush STDOUT
605
606my $opened = open FROM_CHILD, "-|";
607unless (defined $opened) {
6108250c
NC
608 fail "open gave $!";
609 exit 0;
68ba3c2c
DM
610}
611
612if ($opened) {
613 # in parent here
614
6108250c 615 pass 'open';
9ccde9ea 616 my $s = " " x $lm;
68ba3c2c
DM
617 while (<FROM_CHILD>) {
618 unless (@data) {
6108250c 619 fail 'too much output';
68ba3c2c
DM
620 exit;
621 }
9ccde9ea 622 s/^/$s/;
68ba3c2c 623 my $exp = shift @data;
6108250c 624 is $_, $exp;
9ccde9ea 625 }
68ba3c2c 626 close FROM_CHILD;
6108250c 627 is "@data", "", "correct length of output";
68ba3c2c
DM
628 exit;
629}
630
631# in child here
6108250c 632$::NO_ENDING = 1;
68ba3c2c
DM
633
634 select ((select (STDOUT), $| = 1)[0]);
9ccde9ea
JH
635$tm = "\n" x $tm;
636$= -= $bm + 1; # count one for the trailing "----"
637my $lastmin = 0;
638
639my @E;
640
641sub wryte
642{
643 $lastmin = $-;
644 write;
645 } # wryte;
646
647sub footer
648{
649 $% == 1 and return "";
650
651 $lastmin < $= and print "\n" x $lastmin;
652 print "\n" x $bm, "----\n", $ps;
653 $lastmin = $-;
654 "";
655 } # footer
656
657# Yes, this is sick ;-)
658format TOP =
659@* ~
660@{[footer]}
661@* ~
662$tm
663.
664
9ccde9ea
JH
665format ENTRY =
666@ @<<<<~~
667@{(shift @E)||["",""]}
668.
669
670format EOR =
671- -----
672.
673
674sub has_format ($)
675{
676 my $fmt = shift;
677 exists $::{$fmt} or return 0;
678 $^O eq "MSWin32" or return defined *{$::{$fmt}}{FORMAT};
679 open my $null, "> /dev/null" or die;
680 my $fh = select $null;
681 local $~ = $fmt;
682 eval "write";
683 select $fh;
684 $@?0:1;
685 } # has_format
686
d57f9278 687$^ = has_format ("TOP") ? "TOP" : "EMPTY";
9ccde9ea
JH
688has_format ("ENTRY") or die "No format defined for ENTRY";
689foreach my $e ( [ map { [ $_, "Test$_" ] } 1 .. 7 ],
690 [ map { [ $_, "${_}tseT" ] } 1 .. 5 ]) {
691 @E = @$e;
692 local $~ = "ENTRY";
693 wryte;
694 has_format ("EOR") or next;
695 local $~ = "EOR";
696 wryte;
697 }
698if (has_format ("EOF")) {
699 local $~ = "EOF";
700 wryte;
701 }
702
703close STDOUT;
704
ea42cebc 705# That was test 48.
9ccde9ea
JH
706
707__END__
708
709 1 Test1
710 2 Test2
711 3 Test3
712
713
714 ----
715 \f
716 4 Test4
717 5 Test5
718 6 Test6
719
720
721 ----
722 \f
723 7 Test7
724 - -----
725
726
727
728 ----
729 \f
730 1 1tseT
731 2 2tseT
732 3 3tseT
733
734
735 ----
736 \f
737 4 4tseT
738 5 5tseT
739 - -----