This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update List-Util to CPAN version 1.25
[perl5.git] / lib / overload.t
CommitLineData
3340ac37 1#!./perl -T
8ebc5c01
PP
2
3BEGIN {
4 chdir 't' if -d 't';
20822f61 5 @INC = '../lib';
78cd8b71 6 require Config;
98641f60 7 if (($Config::Config{'extensions'} !~ m!\bList/Util\b!) ){
78cd8b71
NC
8 print "1..0 # Skip -- Perl configured without List::Util module\n";
9 exit 0;
10 }
8ebc5c01
PP
11}
12
8ebc5c01
PP
13package Oscalar;
14use overload (
15 # Anonymous subroutines:
16'+' => sub {new Oscalar $ {$_[0]}+$_[1]},
17'-' => sub {new Oscalar
18 $_[2]? $_[1]-${$_[0]} : ${$_[0]}-$_[1]},
19'<=>' => sub {new Oscalar
20 $_[2]? $_[1]-${$_[0]} : ${$_[0]}-$_[1]},
21'cmp' => sub {new Oscalar
22 $_[2]? ($_[1] cmp ${$_[0]}) : (${$_[0]} cmp $_[1])},
23'*' => sub {new Oscalar ${$_[0]}*$_[1]},
24'/' => sub {new Oscalar
25 $_[2]? $_[1]/${$_[0]} :
26 ${$_[0]}/$_[1]},
27'%' => sub {new Oscalar
28 $_[2]? $_[1]%${$_[0]} : ${$_[0]}%$_[1]},
29'**' => sub {new Oscalar
30 $_[2]? $_[1]**${$_[0]} : ${$_[0]}-$_[1]},
31
32qw(
33"" stringify
b0bf6df7 340+ numify) # Order of arguments insignificant
8ebc5c01
PP
35);
36
37sub new {
38 my $foo = $_[1];
39 bless \$foo, $_[0];
40}
41
42sub stringify { "${$_[0]}" }
43sub numify { 0 + "${$_[0]}" } # Not needed, additional overhead
44 # comparing to direct compilation based on
45 # stringify
46
47package main;
48
8ebc5c01 49$| = 1;
25222ff9 50BEGIN { require './test.pl' }
3866ea3b 51plan tests => 5082;
b1fbf5c3 52
a02ec77a 53use Scalar::Util qw(tainted);
8ebc5c01
PP
54
55$a = new Oscalar "087";
56$b= "$a";
57
b1fbf5c3
NC
58is($b, $a);
59is($b, "087");
60is(ref $a, "Oscalar");
61is($a, $a);
62is($a, "087");
8ebc5c01
PP
63
64$c = $a + 7;
65
b1fbf5c3
NC
66is(ref $c, "Oscalar");
67isnt($c, $a);
68is($c, "94");
8ebc5c01
PP
69
70$b=$a;
71
b1fbf5c3 72is(ref $a, "Oscalar");
8ebc5c01
PP
73
74$b++;
75
b1fbf5c3
NC
76is(ref $b, "Oscalar");
77is($a, "087");
78is($b, "88");
79is(ref $a, "Oscalar");
8ebc5c01
PP
80
81$c=$b;
82$c-=$a;
83
b1fbf5c3
NC
84is(ref $c, "Oscalar");
85is($a, "087");
86is($c, "1");
87is(ref $a, "Oscalar");
8ebc5c01
PP
88
89$b=1;
90$b+=$a;
91
b1fbf5c3
NC
92is(ref $b, "Oscalar");
93is($a, "087");
94is($b, "88");
95is(ref $a, "Oscalar");
8ebc5c01
PP
96
97eval q[ package Oscalar; use overload ('++' => sub { $ {$_[0]}++;$_[0] } ) ];
98
99$b=$a;
100
b1fbf5c3 101is(ref $a, "Oscalar");
8ebc5c01
PP
102
103$b++;
104
b1fbf5c3
NC
105is(ref $b, "Oscalar");
106is($a, "087");
107is($b, "88");
108is(ref $a, "Oscalar");
8ebc5c01
PP
109
110package Oscalar;
111$dummy=bless \$dummy; # Now cache of method should be reloaded
112package main;
113
114$b=$a;
115$b++;
116
b1fbf5c3
NC
117is(ref $b, "Oscalar");
118is($a, "087");
119is($b, "88");
120is(ref $a, "Oscalar");
8ebc5c01 121
32251b26 122undef $b; # Destroying updates tables too...
8ebc5c01
PP
123
124eval q[package Oscalar; use overload ('++' => sub { $ {$_[0]} += 2; $_[0] } ) ];
125
126$b=$a;
127
b1fbf5c3 128is(ref $a, "Oscalar");
8ebc5c01
PP
129
130$b++;
131
b1fbf5c3
NC
132is(ref $b, "Oscalar");
133is($a, "087");
0a2c84ab 134is($b, "89");
b1fbf5c3 135is(ref $a, "Oscalar");
8ebc5c01
PP
136
137package Oscalar;
138$dummy=bless \$dummy; # Now cache of method should be reloaded
139package main;
140
141$b++;
142
b1fbf5c3
NC
143is(ref $b, "Oscalar");
144is($a, "087");
0a2c84ab 145is($b, "91");
b1fbf5c3 146is(ref $a, "Oscalar");
8ebc5c01
PP
147
148$b=$a;
149$b++;
150
b1fbf5c3
NC
151is(ref $b, "Oscalar");
152is($a, "087");
153is($b, "89");
154is(ref $a, "Oscalar");
8ebc5c01
PP
155
156
b1fbf5c3 157ok($b? 1:0);
8ebc5c01
PP
158
159eval q[ package Oscalar; use overload ('=' => sub {$main::copies++;
160 package Oscalar;
161 local $new=$ {$_[0]};
162 bless \$new } ) ];
163
164$b=new Oscalar "$a";
165
b1fbf5c3
NC
166is(ref $b, "Oscalar");
167is($a, "087");
168is($b, "087");
169is(ref $a, "Oscalar");
8ebc5c01
PP
170
171$b++;
172
b1fbf5c3
NC
173is(ref $b, "Oscalar");
174is($a, "087");
175is($b, "89");
176is(ref $a, "Oscalar");
177is($copies, undef);
8ebc5c01
PP
178
179$b+=1;
180
b1fbf5c3
NC
181is(ref $b, "Oscalar");
182is($a, "087");
183is($b, "90");
184is(ref $a, "Oscalar");
185is($copies, undef);
8ebc5c01
PP
186
187$b=$a;
188$b+=1;
189
b1fbf5c3
NC
190is(ref $b, "Oscalar");
191is($a, "087");
192is($b, "88");
193is(ref $a, "Oscalar");
194is($copies, undef);
8ebc5c01
PP
195
196$b=$a;
197$b++;
198
b1fbf5c3
NC
199is(ref $b, "Oscalar");
200is($a, "087");
201is($b, "89");
202is(ref $a, "Oscalar");
203is($copies, 1);
8ebc5c01 204
f041cf0f 205eval q[package Oscalar; use overload ('+=' => sub {$ {$_[0]} += 3*"$_[1]";
8ebc5c01
PP
206 $_[0] } ) ];
207$c=new Oscalar; # Cause rehash
208
209$b=$a;
210$b+=1;
211
b1fbf5c3
NC
212is(ref $b, "Oscalar");
213is($a, "087");
214is($b, "90");
215is(ref $a, "Oscalar");
216is($copies, 2);
8ebc5c01
PP
217
218$b+=$b;
219
b1fbf5c3
NC
220is(ref $b, "Oscalar");
221is($b, "360");
222is($copies, 2);
8ebc5c01
PP
223$b=-$b;
224
b1fbf5c3
NC
225is(ref $b, "Oscalar");
226is($b, "-360");
227is($copies, 2);
8ebc5c01
PP
228
229$b=abs($b);
230
b1fbf5c3
NC
231is(ref $b, "Oscalar");
232is($b, "360");
233is($copies, 2);
8ebc5c01
PP
234
235$b=abs($b);
236
b1fbf5c3
NC
237is(ref $b, "Oscalar");
238is($b, "360");
239is($copies, 2);
8ebc5c01
PP
240
241eval q[package Oscalar;
242 use overload ('x' => sub {new Oscalar ( $_[2] ? "_.$_[1]._" x $ {$_[0]}
243 : "_.${$_[0]}._" x $_[1])}) ];
244
245$a=new Oscalar "yy";
246$a x= 3;
b1fbf5c3 247is($a, "_.yy.__.yy.__.yy._");
8ebc5c01
PP
248
249eval q[package Oscalar;
250 use overload ('.' => sub {new Oscalar ( $_[2] ?
251 "_.$_[1].__.$ {$_[0]}._"
252 : "_.$ {$_[0]}.__.$_[1]._")}) ];
253
254$a=new Oscalar "xx";
255
b1fbf5c3 256is("b${a}c", "_._.b.__.xx._.__.c._");
8ebc5c01
PP
257
258# Check inheritance of overloading;
259{
260 package OscalarI;
261 @ISA = 'Oscalar';
262}
263
264$aI = new OscalarI "$a";
b1fbf5c3
NC
265is(ref $aI, "OscalarI");
266is("$aI", "xx");
267is($aI, "xx");
268is("b${aI}c", "_._.b.__.xx._.__.c._");
8ebc5c01 269
053bd1f6 270# Here we test that both "no overload" and
0a2c84ab 271# blessing to a package update hash
8ebc5c01
PP
272
273eval "package Oscalar; no overload '.'";
274
0a2c84ab 275is("b${a}", "bxx");
8ebc5c01
PP
276$x="1";
277bless \$x, Oscalar;
b1fbf5c3 278is("b${a}c", "bxxc");
8ebc5c01 279new Oscalar 1;
b1fbf5c3 280is("b${a}c", "bxxc");
8ebc5c01
PP
281
282# Negative overloading:
283
284$na = eval { ~$a };
b1fbf5c3 285like($@, qr/no method found/);
8ebc5c01
PP
286
287# Check AUTOLOADING:
288
289*Oscalar::AUTOLOAD =
290 sub { *{"Oscalar::$AUTOLOAD"} = sub {"_!_" . shift() . "_!_"} ;
291 goto &{"Oscalar::$AUTOLOAD"}};
292
44a8e56a 293eval "package Oscalar; sub comple; use overload '~' => 'comple'";
8ebc5c01 294
0a2c84ab
FC
295$na = eval { ~$a };
296is($@, '');
8ebc5c01
PP
297
298bless \$x, Oscalar;
299
300$na = eval { ~$a }; # Hash updated
1f874cb6 301warn "'$na', $@" if $@;
b1fbf5c3
NC
302ok !$@;
303is($na, '_!_xx_!_');
8ebc5c01
PP
304
305$na = 0;
306
0a2c84ab
FC
307$na = eval { ~$aI };
308like($@, '');
8ebc5c01
PP
309
310bless \$x, OscalarI;
311
312$na = eval { ~$aI };
313print $@;
314
fdb7e2a2
NC
315ok(!$@);
316is($na, '_!_xx_!_');
8ebc5c01 317
44a8e56a 318eval "package Oscalar; sub rshft; use overload '>>' => 'rshft'";
8ebc5c01 319
0a2c84ab
FC
320$na = eval { $aI >> 1 };
321is($@, '');
8ebc5c01
PP
322
323bless \$x, OscalarI;
324
325$na = 0;
326
327$na = eval { $aI >> 1 };
328print $@;
329
fdb7e2a2
NC
330ok(!$@);
331is($na, '_!_xx_!_');
8ebc5c01 332
44a8e56a 333# warn overload::Method($a, '0+'), "\n";
fdb7e2a2
NC
334is(overload::Method($a, '0+'), \&Oscalar::numify);
335is(overload::Method($aI,'0+'), \&Oscalar::numify);
336ok(overload::Overloaded($aI));
337ok(!overload::Overloaded('overload'));
8ebc5c01 338
fdb7e2a2
NC
339ok(! defined overload::Method($aI, '<<'));
340ok(! defined overload::Method($a, '<'));
8ebc5c01 341
fdb7e2a2
NC
342like (overload::StrVal($aI), qr/^OscalarI=SCALAR\(0x[\da-fA-F]+\)$/);
343is(overload::StrVal(\$aI), "@{[\$aI]}");
8ebc5c01 344
44a8e56a
PP
345# Check overloading by methods (specified deep in the ISA tree).
346{
347 package OscalarII;
348 @ISA = 'OscalarI';
349 sub Oscalar::lshft {"_<<_" . shift() . "_<<_"}
350 eval "package OscalarI; use overload '<<' => 'lshft', '|' => 'lshft'";
351}
352
353$aaII = "087";
354$aII = \$aaII;
355bless $aII, 'OscalarII';
356bless \$fake, 'OscalarI'; # update the hash
fdb7e2a2 357is(($aI | 3), '_<<_xx_<<_');
44a8e56a 358# warn $aII << 3;
fdb7e2a2 359is(($aII << 3), '_<<_087_<<_');
44a8e56a 360
b3ac6de7
IZ
361{
362 BEGIN { $int = 7; overload::constant 'integer' => sub {$int++; shift}; }
363 $out = 2**10;
364}
fdb7e2a2
NC
365is($int, 9);
366is($out, 1024);
7898bf0b
RGS
367is($int, 9);
368{
369 BEGIN { overload::constant 'integer' => sub {$int++; shift()+1}; }
370 eval q{$out = 42};
371}
372is($int, 10);
373is($out, 43);
b3ac6de7
IZ
374
375$foo = 'foo';
376$foo1 = 'f\'o\\o';
377{
378 BEGIN { $q = $qr = 7;
379 overload::constant 'q' => sub {$q++; push @q, shift, ($_[1] || 'none'); shift},
380 'qr' => sub {$qr++; push @qr, shift, ($_[1] || 'none'); shift}; }
381 $out = 'foo';
382 $out1 = 'f\'o\\o';
383 $out2 = "a\a$foo,\,";
384 /b\b$foo.\./;
385}
386
fdb7e2a2
NC
387is($out, 'foo');
388is($out, $foo);
389is($out1, 'f\'o\\o');
390is($out1, $foo1);
391is($out2, "a\afoo,\,");
392is("@q", "foo q f'o\\\\o q a\\a qq ,\\, qq");
393is($q, 11);
394is("@qr", "b\\b qq .\\. qq");
395is($qr, 9);
b3ac6de7
IZ
396
397{
398 $_ = '!<b>!foo!<-.>!';
399 BEGIN { overload::constant 'q' => sub {push @q1, shift, ($_[1] || 'none'); "_<" . (shift) . ">_"},
400 'qr' => sub {push @qr1, shift, ($_[1] || 'none'); "!<" . (shift) . ">!"}; }
401 $out = 'foo';
402 $out1 = 'f\'o\\o';
403 $out2 = "a\a$foo,\,";
404 $res = /b\b$foo.\./;
405 $a = <<EOF;
406oups
407EOF
408 $b = <<'EOF';
409oups1
410EOF
411 $c = bareword;
412 m'try it';
413 s'first part'second part';
414 s/yet another/tail here/;
c2e66d9e 415 tr/A-Z/a-z/;
b3ac6de7
IZ
416}
417
fdb7e2a2
NC
418is($out, '_<foo>_');
419is($out1, '_<f\'o\\o>_');
420is($out2, "_<a\a>_foo_<,\,>_");
421is("@q1", "foo q f'o\\\\o q a\\a qq ,\\, qq oups
b3ac6de7 422 qq oups1
fdb7e2a2
NC
423 q second part q tail here s A-Z tr a-z tr");
424is("@qr1", "b\\b qq .\\. qq try it q first part q yet another qq");
425is($res, 1);
426is($a, "_<oups
427>_");
428is($b, "_<oups1
429>_");
430is($c, "bareword");
b3ac6de7 431
ee239bfe
IZ
432{
433 package symbolic; # Primitive symbolic calculator
434 use overload nomethod => \&wrap, '""' => \&str, '0+' => \&num,
435 '=' => \&cpy, '++' => \&inc, '--' => \&dec;
436
437 sub new { shift; bless ['n', @_] }
438 sub cpy {
439 my $self = shift;
440 bless [@$self], ref $self;
441 }
442 sub inc { $_[0] = bless ['++', $_[0], 1]; }
443 sub dec { $_[0] = bless ['--', $_[0], 1]; }
444 sub wrap {
445 my ($obj, $other, $inv, $meth) = @_;
446 if ($meth eq '++' or $meth eq '--') {
447 @$obj = ($meth, (bless [@$obj]), 1); # Avoid circular reference
448 return $obj;
449 }
450 ($obj, $other) = ($other, $obj) if $inv;
451 bless [$meth, $obj, $other];
452 }
453 sub str {
454 my ($meth, $a, $b) = @{+shift};
455 $a = 'u' unless defined $a;
456 if (defined $b) {
457 "[$meth $a $b]";
458 } else {
459 "[$meth $a]";
460 }
461 }
462 my %subr = ( 'n' => sub {$_[0]} );
463 foreach my $op (split " ", $overload::ops{with_assign}) {
464 $subr{$op} = $subr{"$op="} = eval "sub {shift() $op shift()}";
465 }
466 my @bins = qw(binary 3way_comparison num_comparison str_comparison);
467 foreach my $op (split " ", "@overload::ops{ @bins }") {
468 $subr{$op} = eval "sub {shift() $op shift()}";
469 }
470 foreach my $op (split " ", "@overload::ops{qw(unary func)}") {
471 $subr{$op} = eval "sub {$op shift()}";
472 }
473 $subr{'++'} = $subr{'+'};
474 $subr{'--'} = $subr{'-'};
475
476 sub num {
477 my ($meth, $a, $b) = @{+shift};
478 my $subr = $subr{$meth}
479 or die "Do not know how to ($meth) in symbolic";
480 $a = $a->num if ref $a eq __PACKAGE__;
481 $b = $b->num if ref $b eq __PACKAGE__;
482 $subr->($a,$b);
483 }
484 sub TIESCALAR { my $pack = shift; $pack->new(@_) }
485 sub FETCH { shift }
486 sub nop { } # Around a bug
487 sub vars { my $p = shift; tie($_, $p), $_->nop foreach @_; }
488 sub STORE {
489 my $obj = shift;
490 $#$obj = 1;
a1063b2d 491 $obj->[1] = shift;
ee239bfe
IZ
492 }
493}
494
495{
496 my $foo = new symbolic 11;
497 my $baz = $foo++;
fdb7e2a2
NC
498 is((sprintf "%d", $foo), '12');
499 is((sprintf "%d", $baz), '11');
ee239bfe
IZ
500 my $bar = $foo;
501 $baz = ++$foo;
fdb7e2a2
NC
502 is((sprintf "%d", $foo), '13');
503 is((sprintf "%d", $bar), '12');
504 is((sprintf "%d", $baz), '13');
ee239bfe
IZ
505 my $ban = $foo;
506 $baz = ($foo += 1);
fdb7e2a2
NC
507 is((sprintf "%d", $foo), '14');
508 is((sprintf "%d", $bar), '12');
509 is((sprintf "%d", $baz), '14');
510 is((sprintf "%d", $ban), '13');
ee239bfe
IZ
511 $baz = 0;
512 $baz = $foo++;
fdb7e2a2
NC
513 is((sprintf "%d", $foo), '15');
514 is((sprintf "%d", $baz), '14');
515 is("$foo", '[++ [+= [++ [++ [n 11] 1] 1] 1] 1]');
ee239bfe
IZ
516}
517
518{
519 my $iter = new symbolic 2;
520 my $side = new symbolic 1;
521 my $cnt = $iter;
522
523 while ($cnt) {
524 $cnt = $cnt - 1; # The "simple" way
525 $side = (sqrt(1 + $side**2) - 1)/$side;
526 }
527 my $pi = $side*(2**($iter+2));
fdb7e2a2
NC
528 is("$side", '[/ [- [sqrt [+ 1 [** [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]] 2]]] 1] [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]]]');
529 is((sprintf "%f", $pi), '3.182598');
ee239bfe
IZ
530}
531
532{
533 my $iter = new symbolic 2;
534 my $side = new symbolic 1;
535 my $cnt = $iter;
536
537 while ($cnt--) {
538 $side = (sqrt(1 + $side**2) - 1)/$side;
539 }
540 my $pi = $side*(2**($iter+2));
fdb7e2a2
NC
541 is("$side", '[/ [- [sqrt [+ 1 [** [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]] 2]]] 1] [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]]]');
542 is((sprintf "%f", $pi), '3.182598');
ee239bfe
IZ
543}
544
545{
546 my ($a, $b);
547 symbolic->vars($a, $b);
548 my $c = sqrt($a**2 + $b**2);
549 $a = 3; $b = 4;
fdb7e2a2 550 is((sprintf "%d", $c), '5');
ee239bfe 551 $a = 12; $b = 5;
fdb7e2a2 552 is((sprintf "%d", $c), '13');
ee239bfe
IZ
553}
554
555{
556 package symbolic1; # Primitive symbolic calculator
557 # Mutator inc/dec
558 use overload nomethod => \&wrap, '""' => \&str, '0+' => \&num, '=' => \&cpy;
559
560 sub new { shift; bless ['n', @_] }
561 sub cpy {
562 my $self = shift;
563 bless [@$self], ref $self;
564 }
565 sub wrap {
566 my ($obj, $other, $inv, $meth) = @_;
567 if ($meth eq '++' or $meth eq '--') {
568 @$obj = ($meth, (bless [@$obj]), 1); # Avoid circular reference
569 return $obj;
570 }
571 ($obj, $other) = ($other, $obj) if $inv;
572 bless [$meth, $obj, $other];
573 }
574 sub str {
575 my ($meth, $a, $b) = @{+shift};
576 $a = 'u' unless defined $a;
577 if (defined $b) {
578 "[$meth $a $b]";
579 } else {
580 "[$meth $a]";
581 }
582 }
583 my %subr = ( 'n' => sub {$_[0]} );
584 foreach my $op (split " ", $overload::ops{with_assign}) {
585 $subr{$op} = $subr{"$op="} = eval "sub {shift() $op shift()}";
586 }
587 my @bins = qw(binary 3way_comparison num_comparison str_comparison);
588 foreach my $op (split " ", "@overload::ops{ @bins }") {
589 $subr{$op} = eval "sub {shift() $op shift()}";
590 }
591 foreach my $op (split " ", "@overload::ops{qw(unary func)}") {
592 $subr{$op} = eval "sub {$op shift()}";
593 }
594 $subr{'++'} = $subr{'+'};
595 $subr{'--'} = $subr{'-'};
596
597 sub num {
598 my ($meth, $a, $b) = @{+shift};
599 my $subr = $subr{$meth}
600 or die "Do not know how to ($meth) in symbolic";
601 $a = $a->num if ref $a eq __PACKAGE__;
602 $b = $b->num if ref $b eq __PACKAGE__;
603 $subr->($a,$b);
604 }
605 sub TIESCALAR { my $pack = shift; $pack->new(@_) }
606 sub FETCH { shift }
7dbf2beb 607 sub vars { my $p = shift; tie($_, $p) foreach @_; }
ee239bfe
IZ
608 sub STORE {
609 my $obj = shift;
610 $#$obj = 1;
a1063b2d 611 $obj->[1] = shift;
ee239bfe
IZ
612 }
613}
614
615{
616 my $foo = new symbolic1 11;
617 my $baz = $foo++;
fdb7e2a2
NC
618 is((sprintf "%d", $foo), '12');
619 is((sprintf "%d", $baz), '11');
ee239bfe
IZ
620 my $bar = $foo;
621 $baz = ++$foo;
fdb7e2a2
NC
622 is((sprintf "%d", $foo), '13');
623 is((sprintf "%d", $bar), '12');
624 is((sprintf "%d", $baz), '13');
ee239bfe
IZ
625 my $ban = $foo;
626 $baz = ($foo += 1);
fdb7e2a2
NC
627 is((sprintf "%d", $foo), '14');
628 is((sprintf "%d", $bar), '12');
629 is((sprintf "%d", $baz), '14');
630 is((sprintf "%d", $ban), '13');
ee239bfe
IZ
631 $baz = 0;
632 $baz = $foo++;
fdb7e2a2
NC
633 is((sprintf "%d", $foo), '15');
634 is((sprintf "%d", $baz), '14');
635 is("$foo", '[++ [+= [++ [++ [n 11] 1] 1] 1] 1]');
ee239bfe
IZ
636}
637
638{
639 my $iter = new symbolic1 2;
640 my $side = new symbolic1 1;
641 my $cnt = $iter;
642
643 while ($cnt) {
644 $cnt = $cnt - 1; # The "simple" way
645 $side = (sqrt(1 + $side**2) - 1)/$side;
646 }
647 my $pi = $side*(2**($iter+2));
fdb7e2a2
NC
648 is("$side", '[/ [- [sqrt [+ 1 [** [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]] 2]]] 1] [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]]]');
649 is((sprintf "%f", $pi), '3.182598');
ee239bfe
IZ
650}
651
652{
653 my $iter = new symbolic1 2;
654 my $side = new symbolic1 1;
655 my $cnt = $iter;
656
657 while ($cnt--) {
658 $side = (sqrt(1 + $side**2) - 1)/$side;
659 }
660 my $pi = $side*(2**($iter+2));
fdb7e2a2
NC
661 is("$side", '[/ [- [sqrt [+ 1 [** [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]] 2]]] 1] [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]]]');
662 is((sprintf "%f", $pi), '3.182598');
ee239bfe
IZ
663}
664
665{
666 my ($a, $b);
667 symbolic1->vars($a, $b);
668 my $c = sqrt($a**2 + $b**2);
669 $a = 3; $b = 4;
fdb7e2a2 670 is((sprintf "%d", $c), '5');
ee239bfe 671 $a = 12; $b = 5;
fdb7e2a2 672 is((sprintf "%d", $c), '13');
ee239bfe
IZ
673}
674
675{
676 package two_face; # Scalars with separate string and
677 # numeric values.
678 sub new { my $p = shift; bless [@_], $p }
679 use overload '""' => \&str, '0+' => \&num, fallback => 1;
680 sub num {shift->[1]}
681 sub str {shift->[0]}
682}
683
684{
685 my $seven = new two_face ("vii", 7);
fdb7e2a2 686 is((sprintf "seven=$seven, seven=%d, eight=%d", $seven, $seven+1),
ee239bfe 687 'seven=vii, seven=7, eight=8');
fdb7e2a2 688 is(scalar ($seven =~ /i/), '1');
ee239bfe 689}
b3ac6de7 690
d0ecd44c
IZ
691{
692 package sorting;
693 use overload 'cmp' => \&comp;
694 sub new { my ($p, $v) = @_; bless \$v, $p }
695 sub comp { my ($x,$y) = @_; ($$x * 3 % 10) <=> ($$y * 3 % 10) or $$x cmp $$y }
696}
697{
698 my @arr = map sorting->new($_), 0..12;
699 my @sorted1 = sort @arr;
700 my @sorted2 = map $$_, @sorted1;
7bf00c86 701 is("@sorted2", '0 10 7 4 1 11 8 5 12 2 9 6 3');
d0ecd44c 702}
f5284f61
IZ
703{
704 package iterator;
705 use overload '<>' => \&iter;
706 sub new { my ($p, $v) = @_; bless \$v, $p }
707 sub iter { my ($x) = @_; return undef if $$x < 0; return $$x--; }
708}
72b16652 709
9426e1a5 710{
f5284f61
IZ
711 my $iter = iterator->new(5);
712 my $acc = '';
713 my $out;
714 $acc .= " $out" while $out = <${iter}>;
7bf00c86 715 is($acc, ' 5 4 3 2 1 0');
f5284f61 716 $iter = iterator->new(5);
7bf00c86 717 is(scalar <${iter}>, '5');
f5284f61 718 $acc = '';
b04ef359 719 $acc .= " $out" while $out = <$iter>;
7bf00c86 720 is($acc, ' 4 3 2 1 0');
f5284f61
IZ
721}
722{
723 package deref;
724 use overload '%{}' => \&hderef, '&{}' => \&cderef,
725 '*{}' => \&gderef, '${}' => \&sderef, '@{}' => \&aderef;
726 sub new { my ($p, $v) = @_; bless \$v, $p }
727 sub deref {
728 my ($self, $key) = (shift, shift);
729 my $class = ref $self;
730 bless $self, 'deref::dummy'; # Disable overloading of %{}
731 my $out = $self->{$key};
732 bless $self, $class; # Restore overloading
733 $out;
734 }
735 sub hderef {shift->deref('h')}
736 sub aderef {shift->deref('a')}
737 sub cderef {shift->deref('c')}
738 sub gderef {shift->deref('g')}
739 sub sderef {shift->deref('s')}
740}
741{
742 my $deref = bless { h => { foo => 5 , fake => 23 },
743 c => sub {return shift() + 34},
744 's' => \123,
745 a => [11..13],
746 g => \*srt,
747 }, 'deref';
748 # Hash:
749 my @cont = sort %$deref;
b0bf6df7 750 if ("\t" eq "\011") { # ASCII
7bf00c86 751 is("@cont", '23 5 fake foo');
f70c35af 752 }
b0bf6df7 753 else { # EBCDIC alpha-numeric sort order
7bf00c86 754 is("@cont", 'fake foo 23 5');
f70c35af 755 }
f5284f61 756 my @keys = sort keys %$deref;
7bf00c86 757 is("@keys", 'fake foo');
f5284f61 758 my @val = sort values %$deref;
7bf00c86
NC
759 is("@val", '23 5');
760 is($deref->{foo}, 5);
761 is(defined $deref->{bar}, '');
f5284f61
IZ
762 my $key;
763 @keys = ();
764 push @keys, $key while $key = each %$deref;
765 @keys = sort @keys;
7bf00c86
NC
766 is("@keys", 'fake foo');
767 is(exists $deref->{bar}, '');
768 is(exists $deref->{foo}, 1);
f5284f61 769 # Code:
7bf00c86
NC
770 is($deref->(5), 39);
771 is(&$deref(6), 40);
f5284f61 772 sub xxx_goto { goto &$deref }
7bf00c86 773 is(xxx_goto(7), 41);
f5284f61
IZ
774 my $srt = bless { c => sub {$b <=> $a}
775 }, 'deref';
776 *srt = \&$srt;
777 my @sorted = sort srt 11, 2, 5, 1, 22;
7bf00c86 778 is("@sorted", '22 11 5 2 1');
f5284f61 779 # Scalar
7bf00c86 780 is($$deref, 123);
c6e96bcb
GS
781 # Code
782 @sorted = sort $srt 11, 2, 5, 1, 22;
7bf00c86 783 is("@sorted", '22 11 5 2 1');
f5284f61 784 # Array
7bf00c86
NC
785 is("@$deref", '11 12 13');
786 is($#$deref, '2');
f5284f61 787 my $l = @$deref;
7bf00c86
NC
788 is($l, 3);
789 is($deref->[2], '13');
f5284f61 790 $l = pop @$deref;
7bf00c86 791 is($l, 13);
f5284f61 792 $l = 1;
7bf00c86 793 is($deref->[$l], '12');
f5284f61
IZ
794 # Repeated dereference
795 my $double = bless { h => $deref,
796 }, 'deref';
7bf00c86 797 is($double->{foo}, 5);
f5284f61
IZ
798}
799
800{
801 package two_refs;
802 use overload '%{}' => \&gethash, '@{}' => sub { ${shift()} };
803 sub new {
804 my $p = shift;
805 bless \ [@_], $p;
806 }
807 sub gethash {
808 my %h;
809 my $self = shift;
810 tie %h, ref $self, $self;
811 \%h;
812 }
813
814 sub TIEHASH { my $p = shift; bless \ shift, $p }
815 my %fields;
816 my $i = 0;
817 $fields{$_} = $i++ foreach qw{zero one two three};
818 sub STORE {
819 my $self = ${shift()};
820 my $key = $fields{shift()};
821 defined $key or die "Out of band access";
822 $$self->[$key] = shift;
823 }
824 sub FETCH {
825 my $self = ${shift()};
826 my $key = $fields{shift()};
827 defined $key or die "Out of band access";
828 $$self->[$key];
829 }
830}
831
832my $bar = new two_refs 3,4,5,6;
833$bar->[2] = 11;
7bf00c86 834is($bar->{two}, 11);
f5284f61 835$bar->{three} = 13;
7bf00c86 836is($bar->[3], 13);
f5284f61
IZ
837
838{
839 package two_refs_o;
840 @ISA = ('two_refs');
841}
842
843$bar = new two_refs_o 3,4,5,6;
844$bar->[2] = 11;
7bf00c86 845is($bar->{two}, 11);
f5284f61 846$bar->{three} = 13;
7bf00c86 847is($bar->[3], 13);
f5284f61
IZ
848
849{
850 package two_refs1;
851 use overload '%{}' => sub { ${shift()}->[1] },
852 '@{}' => sub { ${shift()}->[0] };
853 sub new {
854 my $p = shift;
855 my $a = [@_];
856 my %h;
857 tie %h, $p, $a;
858 bless \ [$a, \%h], $p;
859 }
860 sub gethash {
861 my %h;
862 my $self = shift;
863 tie %h, ref $self, $self;
864 \%h;
865 }
866
867 sub TIEHASH { my $p = shift; bless \ shift, $p }
868 my %fields;
869 my $i = 0;
870 $fields{$_} = $i++ foreach qw{zero one two three};
871 sub STORE {
872 my $a = ${shift()};
873 my $key = $fields{shift()};
874 defined $key or die "Out of band access";
875 $a->[$key] = shift;
876 }
877 sub FETCH {
878 my $a = ${shift()};
879 my $key = $fields{shift()};
880 defined $key or die "Out of band access";
881 $a->[$key];
882 }
883}
884
885$bar = new two_refs_o 3,4,5,6;
886$bar->[2] = 11;
7bf00c86 887is($bar->{two}, 11);
f5284f61 888$bar->{three} = 13;
7bf00c86 889is($bar->[3], 13);
f5284f61
IZ
890
891{
892 package two_refs1_o;
893 @ISA = ('two_refs1');
894}
895
896$bar = new two_refs1_o 3,4,5,6;
897$bar->[2] = 11;
7bf00c86 898is($bar->{two}, 11);
f5284f61 899$bar->{three} = 13;
7bf00c86 900is($bar->[3], 13);
f5284f61 901
fe7ac86a
IZ
902{
903 package B;
904 use overload bool => sub { ${+shift} };
905}
906
907my $aaa;
908{ my $bbbb = 0; $aaa = bless \$bbbb, B }
909
7bf00c86 910is !$aaa, 1;
fe7ac86a
IZ
911
912unless ($aaa) {
7bf00c86 913 pass();
fe7ac86a 914} else {
7bf00c86 915 fail();
fe7ac86a
IZ
916}
917
1426bbf4
MG
918# check that overload isn't done twice by join
919{ my $c = 0;
920 package Join;
921 use overload '""' => sub { $c++ };
922 my $x = join '', bless([]), 'pq', bless([]);
7bf00c86 923 main::is $x, '0pq1';
1426bbf4 924};
fe7ac86a 925
4498a751
PM
926# Test module-specific warning
927{
928 # check the Odd number of arguments for overload::constant warning
929 my $a = "" ;
0a911d86 930 local $SIG{__WARN__} = sub {$a = $_[0]} ;
4498a751 931 $x = eval ' overload::constant "integer" ; ' ;
7bf00c86 932 is($a, "");
4498a751
PM
933 use warnings 'overload' ;
934 $x = eval ' overload::constant "integer" ; ' ;
7bf00c86 935 like($a, qr/^Odd number of arguments for overload::constant at/);
4498a751
PM
936}
937
938{
1f874cb6 939 # check the '$_[0]' is not an overloadable type warning
4498a751 940 my $a = "" ;
0a911d86 941 local $SIG{__WARN__} = sub {$a = $_[0]} ;
4498a751 942 $x = eval ' overload::constant "fred" => sub {} ; ' ;
7bf00c86 943 is($a, "");
4498a751
PM
944 use warnings 'overload' ;
945 $x = eval ' overload::constant "fred" => sub {} ; ' ;
1f874cb6 946 like($a, qr/^'fred' is not an overloadable type at/);
4498a751
PM
947}
948
949{
1f874cb6 950 # check the '$_[1]' is not a code reference warning
4498a751 951 my $a = "" ;
0a911d86 952 local $SIG{__WARN__} = sub {$a = $_[0]} ;
4498a751 953 $x = eval ' overload::constant "integer" => 1; ' ;
7bf00c86 954 is($a, "");
4498a751
PM
955 use warnings 'overload' ;
956 $x = eval ' overload::constant "integer" => 1; ' ;
1f874cb6 957 like($a, qr/^'1' is not a code reference at/);
4498a751
PM
958}
959
78f67eb5 960{
9f39352c
FC
961 # check the invalid argument warning [perl #74098]
962 my $a = "" ;
963 local $SIG{__WARN__} = sub {$a = $_[0]} ;
964 $x = eval ' use overload "~|_|~" => sub{} ' ;
65f57195 965 eval ' no overload "~|_|~" ' ;
9f39352c
FC
966 is($a, "");
967 use warnings 'overload' ;
968 $x = eval ' use overload "~|_|~" => sub{} ' ;
969 like($a, qr/^overload arg '~\|_\|~' is invalid at \(eval \d+\) line /,
970 'invalid arg warning');
65f57195
FC
971 undef $a;
972 eval ' no overload "~|_|~" ' ;
973 like($a, qr/^overload arg '~\|_\|~' is invalid at \(eval \d+\) line /,
974 'invalid arg warning');
9f39352c
FC
975}
976
977{
78f67eb5
JH
978 my $c = 0;
979 package ov_int1;
980 use overload '""' => sub { 3+shift->[0] },
981 '0+' => sub { 10+shift->[0] },
982 'int' => sub { 100+shift->[0] };
983 sub new {my $p = shift; bless [shift], $p}
984
985 package ov_int2;
986 use overload '""' => sub { 5+shift->[0] },
987 '0+' => sub { 30+shift->[0] },
988 'int' => sub { 'ov_int1'->new(1000+shift->[0]) };
989 sub new {my $p = shift; bless [shift], $p}
990
991 package noov_int;
992 use overload '""' => sub { 2+shift->[0] },
993 '0+' => sub { 9+shift->[0] };
994 sub new {my $p = shift; bless [shift], $p}
995
996 package main;
997
998 my $x = new noov_int 11;
999 my $int_x = int $x;
7bf00c86 1000 main::is("$int_x", 20);
78f67eb5
JH
1001 $x = new ov_int1 31;
1002 $int_x = int $x;
7bf00c86 1003 main::is("$int_x", 131);
78f67eb5
JH
1004 $x = new ov_int2 51;
1005 $int_x = int $x;
7bf00c86 1006 main::is("$int_x", 1054);
78f67eb5
JH
1007}
1008
b0bf6df7 1009# make sure that we don't infinitely recurse
1554e226
DC
1010{
1011 my $c = 0;
1012 package Recurse;
1013 use overload '""' => sub { shift },
1014 '0+' => sub { shift },
1015 'bool' => sub { shift },
1016 fallback => 1;
1017 my $x = bless([]);
7bf00c86
NC
1018 # For some reason beyond me these have to be oks rather than likes.
1019 main::ok("$x" =~ /Recurse=ARRAY/);
1020 main::ok($x);
1021 main::ok($x+0 =~ qr/Recurse=ARRAY/);
11e3e2e4 1022}
78f67eb5 1023
1dc13c17
SC
1024# BugID 20010422.003
1025package Foo;
1026
1027use overload
1028 'bool' => sub { return !$_[0]->is_zero() || undef; }
1029;
1030
1031sub is_zero
1032 {
1033 my $self = shift;
1034 return $self->{var} == 0;
1035 }
1036
1037sub new
1038 {
1039 my $class = shift;
1040 my $self = {};
1041 $self->{var} = shift;
1042 bless $self,$class;
1043 }
1044
1045package main;
1046
1047use strict;
1048
1049my $r = Foo->new(8);
1050$r = Foo->new(0);
78f67eb5 1051
11e3e2e4 1052is(($r || 0), 0);
1554e226 1053
6050d10e
JP
1054package utf8_o;
1055
1056use overload
1057 '""' => sub { return $_[0]->{var}; }
1058 ;
1059
1060sub new
1061 {
1062 my $class = shift;
1063 my $self = {};
1064 $self->{var} = shift;
1065 bless $self,$class;
1066 }
1067
1068package main;
1069
1070
1071my $utfvar = new utf8_o 200.2.1;
11e3e2e4
NC
1072is("$utfvar", 200.2.1); # 223 - stringify
1073is("a$utfvar", "a".200.2.1); # 224 - overload via sv_2pv_flags
6050d10e 1074
446eaa42 1075# 225..227 -- more %{} tests. Hangs in 5.6.0, okay in later releases.
41cb1005
JH
1076# Basically this example implements strong encapsulation: if Hderef::import()
1077# were to eval the overload code in the caller's namespace, the privatisation
1078# would be quite transparent.
1079package Hderef;
1080use overload '%{}' => sub { (caller(0))[0] eq 'Foo' ? $_[0] : die "zap" };
1081package Foo;
1082@Foo::ISA = 'Hderef';
1083sub new { bless {}, shift }
1084sub xet { @_ == 2 ? $_[0]->{$_[1]} :
1085 @_ == 3 ? ($_[0]->{$_[1]} = $_[2]) : undef }
1086package main;
1087my $a = Foo->new;
1088$a->xet('b', 42);
11e3e2e4
NC
1089is ($a->xet('b'), 42);
1090ok (!defined eval { $a->{b} });
1091like ($@, qr/zap/);
41cb1005 1092
29ddfe35
RD
1093{
1094 package t229;
1095 use overload '=' => sub { 42 },
1096 '++' => sub { my $x = ${$_[0]}; $_[0] };
1097 sub new { my $x = 42; bless \$x }
1098
1099 my $warn;
1100 {
1101 local $SIG{__WARN__} = sub { $warn++ };
1102 my $x = t229->new;
1103 my $y = $x;
1104 eval { $y++ };
1105 }
11e3e2e4 1106 main::ok (!$warn);
61f33854
RGS
1107}
1108
1109{
1110 my ($int, $out1, $out2);
1111 {
1112 BEGIN { $int = 0; overload::constant 'integer' => sub {$int++; 17}; }
1113 $out1 = 0;
1114 $out2 = 1;
1115 }
11e3e2e4
NC
1116 is($int, 2, "#24313"); # 230
1117 is($out1, 17, "#24313"); # 231
1118 is($out2, 17, "#24313"); # 232
29ddfe35
RD
1119}
1120
0bdaccee 1121{
d411a6a9 1122 package perl31793;
1b1d102f
RD
1123 use overload cmp => sub { 0 };
1124 package perl31793_fb;
76c43448 1125 use overload cmp => sub { 0 }, fallback => 1;
d411a6a9
RD
1126 package main;
1127 my $o = bless [], 'perl31793';
1b1d102f 1128 my $of = bless [], 'perl31793_fb';
d411a6a9 1129 my $no = bless [], 'no_overload';
11e3e2e4
NC
1130 like(overload::StrVal(\"scalar"), qr/^SCALAR\(0x[0-9a-f]+\)$/);
1131 like(overload::StrVal([]), qr/^ARRAY\(0x[0-9a-f]+\)$/);
1132 like(overload::StrVal({}), qr/^HASH\(0x[0-9a-f]+\)$/);
1133 like(overload::StrVal(sub{1}), qr/^CODE\(0x[0-9a-f]+\)$/);
1134 like(overload::StrVal(\*GLOB), qr/^GLOB\(0x[0-9a-f]+\)$/);
1135 like(overload::StrVal(\$o), qr/^REF\(0x[0-9a-f]+\)$/);
0fc92fc6 1136 like(overload::StrVal(qr/a/), qr/^Regexp=REGEXP\(0x[0-9a-f]+\)$/);
11e3e2e4
NC
1137 like(overload::StrVal($o), qr/^perl31793=ARRAY\(0x[0-9a-f]+\)$/);
1138 like(overload::StrVal($of), qr/^perl31793_fb=ARRAY\(0x[0-9a-f]+\)$/);
1139 like(overload::StrVal($no), qr/^no_overload=ARRAY\(0x[0-9a-f]+\)$/);
d411a6a9
RD
1140}
1141
fdd52a68
FC
1142{
1143 package Numify;
1144 use overload (qw(0+ numify fallback 1));
1145
1146 sub new {
1147 my $val = $_[1];
1148 bless \$val, $_[0];
1149 }
1150
1151 sub numify { ${$_[0]} }
1152}
1153
341b4158
FC
1154# These all check that overloaded values, rather than reference addresses,
1155# are what are getting tested.
0bdaccee
NC
1156my ($two, $one, $un, $deux) = map {new Numify $_} 2, 1, 1, 2;
1157my ($ein, $zwei) = (1, 2);
1158
1159my %map = (one => 1, un => 1, ein => 1, deux => 2, two => 2, zwei => 2);
1160foreach my $op (qw(<=> == != < <= > >=)) {
1161 foreach my $l (keys %map) {
1162 foreach my $r (keys %map) {
1163 my $ocode = "\$$l $op \$$r";
1164 my $rcode = "$map{$l} $op $map{$r}";
1165
1166 my $got = eval $ocode;
1167 die if $@;
1168 my $expect = eval $rcode;
1169 die if $@;
11e3e2e4 1170 is ($got, $expect, $ocode) or print "# $rcode\n";
0bdaccee
NC
1171 }
1172 }
1173}
131b3ad0
DM
1174{
1175 # check that overloading works in regexes
1176 {
1177 package Foo493;
1178 use overload
1179 '""' => sub { "^$_[0][0]\$" },
1180 '.' => sub {
1181 bless [
1182 $_[2]
1183 ? (ref $_[1] ? $_[1][0] : $_[1]) . ':' .$_[0][0]
1184 : $_[0][0] . ':' . (ref $_[1] ? $_[1][0] : $_[1])
1185 ], 'Foo493'
1186 };
1187 }
1188
1189 my $a = bless [ "a" ], 'Foo493';
11e3e2e4
NC
1190 like('a', qr/$a/);
1191 like('x:a', qr/x$a/);
1192 like('x:a:=', qr/x$a=$/);
1193 like('x:a:a:=', qr/x$a$a=$/);
131b3ad0
DM
1194
1195}
1196
705c898c 1197{
d4b87e75
BM
1198 {
1199 package QRonly;
1200 use overload qr => sub { qr/x/ }, fallback => 1;
1201 }
1202 {
1203 my $x = bless [], "QRonly";
1204
1205 # like tries to be too clever, and decides that $x-stringified
1206 # doesn't look like a regex
1207 ok("x" =~ $x, "qr-only matches");
e4eea578 1208 ok("y" !~ $x, "qr-only doesn't match what it shouldn't");
d4b87e75 1209 ok("xx" =~ /x$x/, "qr-only matches with concat");
e4eea578 1210 like("$x", qr/^QRonly=ARRAY/, "qr-only doesn't have string overload");
d4b87e75
BM
1211
1212 my $qr = bless qr/y/, "QRonly";
1213 ok("x" =~ $qr, "qr with qr-overload uses overload");
e4eea578 1214 ok("y" !~ $qr, "qr with qr-overload uses overload");
d4b87e75
BM
1215 is("$qr", "".qr/y/, "qr with qr-overload stringify");
1216
1217 my $rx = $$qr;
1218 ok("y" =~ $rx, "bare rx with qr-overload doesn't overload match");
e4eea578 1219 ok("x" !~ $rx, "bare rx with qr-overload doesn't overload match");
d4b87e75
BM
1220 is("$rx", "".qr/y/, "bare rx with qr-overload stringify");
1221 }
1222 {
1223 package QRandSTR;
1224 use overload qr => sub { qr/x/ }, q/""/ => sub { "y" };
1225 }
1226 {
1227 my $x = bless [], "QRandSTR";
1228 ok("x" =~ $x, "qr+str uses qr for match");
e4eea578 1229 ok("y" !~ $x, "qr+str uses qr for match");
d4b87e75
BM
1230 ok("xx" =~ /x$x/, "qr+str uses qr for match with concat");
1231 is("$x", "y", "qr+str uses str for stringify");
1232
1233 my $qr = bless qr/z/, "QRandSTR";
1234 is("$qr", "y", "qr with qr+str uses str for stringify");
1235 ok("xx" =~ /x$x/, "qr with qr+str uses qr for match");
1236
1237 my $rx = $$qr;
1238 ok("z" =~ $rx, "bare rx with qr+str doesn't overload match");
1239 is("$rx", "".qr/z/, "bare rx with qr+str doesn't overload stringify");
1240 }
1241 {
1242 package QRany;
1243 use overload qr => sub { $_[0]->(@_) };
1244
1245 package QRself;
1246 use overload qr => sub { $_[0] };
1247 }
1248 {
1249 my $rx = bless sub { ${ qr/x/ } }, "QRany";
e4eea578
RGS
1250 ok("x" =~ $rx, "qr overload accepts a bare rx");
1251 ok("y" !~ $rx, "qr overload accepts a bare rx");
d4b87e75
BM
1252
1253 my $str = bless sub { "x" }, "QRany";
1254 ok(!eval { "x" =~ $str }, "qr overload doesn't accept a string");
e4eea578 1255 like($@, qr/^Overloaded qr did not return a REGEXP/, "correct error");
d4b87e75
BM
1256
1257 my $oqr = bless qr/z/, "QRandSTR";
1258 my $oqro = bless sub { $oqr }, "QRany";
e4eea578 1259 ok("z" =~ $oqro, "qr overload doesn't recurse");
d4b87e75
BM
1260
1261 my $qrs = bless qr/z/, "QRself";
e4eea578 1262 ok("z" =~ $qrs, "qr overload can return self");
d4b87e75
BM
1263 }
1264 {
1265 package STRonly;
1266 use overload q/""/ => sub { "x" };
1267
1268 package STRonlyFB;
1269 use overload q/""/ => sub { "x" }, fallback => 1;
1270 }
1271 {
1272 my $fb = bless [], "STRonlyFB";
e4eea578
RGS
1273 ok("x" =~ $fb, "qr falls back to \"\"");
1274 ok("y" !~ $fb, "qr falls back to \"\"");
d4b87e75
BM
1275
1276 my $nofb = bless [], "STRonly";
e4eea578
RGS
1277 ok("x" =~ $nofb, "qr falls back even without fallback");
1278 ok("y" !~ $nofb, "qr falls back even without fallback");
d4b87e75
BM
1279 }
1280}
1281
1282{
705c898c
RH
1283 my $twenty_three = 23;
1284 # Check that constant overloading propagates into evals
1285 BEGIN { overload::constant integer => sub { 23 } }
11e3e2e4 1286 is(eval "17", $twenty_three);
705c898c 1287}
dd2eae66
NC
1288
1289{
1290 package Sklorsh;
1291 use overload
1292 bool => sub { shift->is_cool };
1293
1294 sub is_cool {
1295 $_[0]->{name} eq 'cool';
1296 }
1297
1298 sub delete {
1299 undef %{$_[0]};
1300 bless $_[0], 'Brap';
1301 return 1;
1302 }
1303
1304 sub delete_with_self {
1305 my $self = shift;
1306 undef %$self;
1307 bless $self, 'Brap';
1308 return 1;
1309 }
1310
1311 package Brap;
1312
1313 1;
1314
1315 package main;
1316
1317 my $obj;
1318 $obj = bless {name => 'cool'}, 'Sklorsh';
1319 $obj->delete;
b0bf6df7 1320 ok(eval {if ($obj) {1}; 1}, $@ || 'reblessed into nonexistent namespace');
dd2eae66
NC
1321
1322 $obj = bless {name => 'cool'}, 'Sklorsh';
1323 $obj->delete_with_self;
1324 ok (eval {if ($obj) {1}; 1}, $@);
1325
1326 my $a = $b = {name => 'hot'};
1327 bless $b, 'Sklorsh';
1328 is(ref $a, 'Sklorsh');
1329 is(ref $b, 'Sklorsh');
1330 ok(!$b, "Expect overloaded boolean");
1331 ok(!$a, "Expect overloaded boolean");
1332}
edbe35ea
VP
1333
1334{
1335 package Flrbbbbb;
1336 use overload
1337 bool => sub { shift->{truth} eq 'yes' },
1338 '0+' => sub { shift->{truth} eq 'yes' ? '1' : '0' },
1339 '!' => sub { shift->{truth} eq 'no' },
1340 fallback => 1;
1341
1342 sub new { my $class = shift; bless { truth => shift }, $class }
1343
1344 package main;
1345
1346 my $yes = Flrbbbbb->new('yes');
1347 my $x;
1348 $x = 1 if $yes; is($x, 1);
1349 $x = 2 unless $yes; is($x, 1);
1350 $x = 3 if !$yes; is($x, 1);
1351 $x = 4 unless !$yes; is($x, 4);
1352
1353 my $no = Flrbbbbb->new('no');
1354 $x = 0;
1355 $x = 1 if $no; is($x, 0);
1356 $x = 2 unless $no; is($x, 2);
1357 $x = 3 if !$no; is($x, 3);
1358 $x = 4 unless !$no; is($x, 3);
1359
1360 $x = 0;
1361 $x = 1 if !$no && $yes; is($x, 1);
1362 $x = 2 unless !$no && $yes; is($x, 1);
1363 $x = 3 if $no || !$yes; is($x, 1);
1364 $x = 4 unless $no || !$yes; is($x, 4);
1365
1366 $x = 0;
1367 $x = 1 if !$no || !$yes; is($x, 1);
1368 $x = 2 unless !$no || !$yes; is($x, 1);
1369 $x = 3 if !$no && !$yes; is($x, 1);
1370 $x = 4 unless !$no && !$yes; is($x, 4);
1371}
1372
ea940d6b 1373{
2372186a
NC
1374 use Scalar::Util 'weaken';
1375
1376 package Shklitza;
1377 use overload '""' => sub {"CLiK KLAK"};
1378
1379 package Ksshfwoom;
2372186a
NC
1380
1381 package main;
1382
1383 my ($obj, $ref);
1384 $obj = bless do {my $a; \$a}, 'Shklitza';
1385 $ref = $obj;
1386
ea940d6b
CBW
1387 is ("$obj", "CLiK KLAK");
1388 is ("$ref", "CLiK KLAK");
2372186a
NC
1389
1390 weaken $ref;
ea940d6b 1391 is ("$ref", "CLiK KLAK");
2372186a
NC
1392
1393 bless $obj, 'Ksshfwoom';
1394
cd75d542
NC
1395 like ($obj, qr/^Ksshfwoom=/);
1396 like ($ref, qr/^Ksshfwoom=/);
2372186a
NC
1397
1398 undef $obj;
1399 is ($ref, undef);
1400}
6dd85743
AF
1401
1402{
1403 package bit;
1404 # bit operations have overloadable assignment variants too
1405
1406 sub new { bless \$_[1], $_[0] }
1407
1408 use overload
1409 "&=" => sub { bit->new($_[0]->val . ' & ' . $_[1]->val) },
1410 "^=" => sub { bit->new($_[0]->val . ' ^ ' . $_[1]->val) },
1411 "|" => sub { bit->new($_[0]->val . ' | ' . $_[1]->val) }, # |= by fallback
1412 ;
1413
1414 sub val { ${$_[0]} }
1415
1416 package main;
1417
1418 my $a = bit->new(my $va = 'a');
1419 my $b = bit->new(my $vb = 'b');
1420
1421 $a &= $b;
1422 is($a->val, 'a & b', "overloaded &= works");
1423
1424 my $c = bit->new(my $vc = 'c');
1425
1426 $b ^= $c;
1427 is($b->val, 'b ^ c', "overloaded ^= works");
1428
1429 my $d = bit->new(my $vd = 'd');
1430
1431 $c |= $d;
1432 is($c->val, 'c | d', "overloaded |= (by fallback) works");
1433}
d11ee47c
RD
1434
1435{
2ab54efd 1436 # comparison operators with nomethod (bug 41546)
d11ee47c
RD
1437 my $warning = "";
1438 my $method;
1439
1440 package nomethod_false;
1441 use overload nomethod => sub { $method = 'nomethod'; 0 };
1442
1443 package nomethod_true;
1444 use overload nomethod => sub { $method= 'nomethod'; 'true' };
1445
1446 package main;
1447 local $^W = 1;
1448 local $SIG{__WARN__} = sub { $warning = $_[0] };
1449
1450 my $f = bless [], 'nomethod_false';
1451 ($warning, $method) = ("", "");
1452 is($f eq 'whatever', 0, 'nomethod makes eq return 0');
1453 is($method, 'nomethod');
1454
1455 my $t = bless [], 'nomethod_true';
1456 ($warning, $method) = ("", "");
1457 is($t eq 'whatever', 'true', 'nomethod makes eq return "true"');
1458 is($method, 'nomethod');
1459 is($warning, "", 'nomethod eq need not return number');
1460
1461 eval q{
1462 package nomethod_false;
1463 use overload cmp => sub { $method = 'cmp'; 0 };
1464 };
1465 $f = bless [], 'nomethod_false';
1466 ($warning, $method) = ("", "");
1467 ok($f eq 'whatever', 'eq falls back to cmp (nomethod not called)');
1468 is($method, 'cmp');
1469
1470 eval q{
1471 package nomethod_true;
1472 use overload cmp => sub { $method = 'cmp'; 'true' };
1473 };
1474 $t = bless [], 'nomethod_true';
1475 ($warning, $method) = ("", "");
1476 ok($t eq 'whatever', 'eq falls back to cmp (nomethod not called)');
1477 is($method, 'cmp');
1478 like($warning, qr/isn't numeric/, 'cmp should return number');
1479
1480}
2c615c57
NC
1481
1482{
2ab54efd
MB
1483 # nomethod called for '!' after attempted fallback
1484 my $nomethod_called = 0;
1485
1486 package nomethod_not;
1487 use overload nomethod => sub { $nomethod_called = 'yes'; };
1488
1489 package main;
1490 my $o = bless [], 'nomethod_not';
1491 my $res = ! $o;
1492
1493 is($nomethod_called, 'yes', "nomethod() is called for '!'");
1494 is($res, 'yes', "nomethod(..., '!') return value propagates");
1495}
1496
1497{
2c615c57 1498 # Subtle bug pre 5.10, as a side effect of the overloading flag being
b0bf6df7 1499 # stored on the reference rather than the referent. Despite the fact that
2c615c57 1500 # objects can only be accessed via references (even internally), the
b0bf6df7 1501 # referent actually knows that it's blessed, not the references. So taking
2c615c57
NC
1502 # a new, unrelated, reference to it gives an object. However, the
1503 # overloading-or-not flag was on the reference prior to 5.10, and taking
1504 # a new reference didn't (use to) copy it.
1505
1506 package kayo;
1507
1508 use overload '""' => sub {${$_[0]}};
1509
1510 sub Pie {
1511 return "$_[0], $_[1]";
1512 }
1513
1514 package main;
1515
1516 my $class = 'kayo';
1517 my $string = 'bam';
1518 my $crunch_eth = bless \$string, $class;
1519
1520 is("$crunch_eth", $string);
1521 is ($crunch_eth->Pie("Meat"), "$string, Meat");
1522
1523 my $wham_eth = \$string;
1524
1525 is("$wham_eth", $string,
1526 'This reference did not have overloading in 5.8.8 and earlier');
1527 is ($crunch_eth->Pie("Apple"), "$string, Apple");
1528
1529 my $class = ref $wham_eth;
1530 $class =~ s/=.*//;
1531
1532 # Bless it back into its own class!
1533 bless $wham_eth, $class;
1534
1535 is("$wham_eth", $string);
1536 is ($crunch_eth->Pie("Blackbird"), "$string, Blackbird");
1537}
c781a409
RD
1538
1539{
1540 package numify_int;
1541 use overload "0+" => sub { $_[0][0] += 1; 42 };
1542 package numify_self;
1543 use overload "0+" => sub { $_[0][0]++; $_[0] };
1544 package numify_other;
1545 use overload "0+" => sub { $_[0][0]++; $_[0][1] = bless [], 'numify_int' };
e28bb1d5 1546 package numify_by_fallback;
800401ee 1547 use overload fallback => 1;
c781a409
RD
1548
1549 package main;
1550 my $o = bless [], 'numify_int';
1551 is(int($o), 42, 'numifies to integer');
1552 is($o->[0], 1, 'int() numifies only once');
1553
1554 my $aref = [];
93521010 1555 my $num_val = int($aref);
c781a409
RD
1556 my $r = bless $aref, 'numify_self';
1557 is(int($r), $num_val, 'numifies to self');
1558 is($r->[0], 1, 'int() numifies once when returning self');
1559
1560 my $s = bless [], 'numify_other';
1561 is(int($s), 42, 'numifies to numification of other object');
1562 is($s->[0], 1, 'int() numifies once when returning other object');
1563 is($s->[1][0], 1, 'returned object numifies too');
e28bb1d5
RD
1564
1565 my $m = bless $aref, 'numify_by_fallback';
1566 is(int($m), $num_val, 'numifies to usual reference value');
800401ee
JH
1567 is(abs($m), $num_val, 'numifies to usual reference value');
1568 is(-$m, -$num_val, 'numifies to usual reference value');
1569 is(0+$m, $num_val, 'numifies to usual reference value');
1570 is($m+0, $num_val, 'numifies to usual reference value');
1571 is($m+$m, 2*$num_val, 'numifies to usual reference value');
1572 is(0-$m, -$num_val, 'numifies to usual reference value');
1573 is(1*$m, $num_val, 'numifies to usual reference value');
9fa8ecf2 1574 is(int($m/1), $num_val, 'numifies to usual reference value');
800401ee
JH
1575 is($m%100, $num_val%100, 'numifies to usual reference value');
1576 is($m**1, $num_val, 'numifies to usual reference value');
1577
1578 is(abs($aref), $num_val, 'abs() of ref');
1579 is(-$aref, -$num_val, 'negative of ref');
1580 is(0+$aref, $num_val, 'ref addition');
1581 is($aref+0, $num_val, 'ref addition');
1582 is($aref+$aref, 2*$num_val, 'ref addition');
1583 is(0-$aref, -$num_val, 'subtraction of ref');
1584 is(1*$aref, $num_val, 'multiplicaton of ref');
9fa8ecf2 1585 is(int($aref/1), $num_val, 'division of ref');
800401ee
JH
1586 is($aref%100, $num_val%100, 'modulo of ref');
1587 is($aref**1, $num_val, 'exponentiation of ref');
c781a409 1588}
800401ee 1589
49c95d58
RD
1590{
1591 package CopyConstructorFallback;
1592 use overload
1593 '++' => sub { "$_[0]"; $_[0] },
1594 fallback => 1;
1595 sub new { bless {} => shift }
1596
1597 package main;
1598
1599 my $o = CopyConstructorFallback->new;
1600 my $x = $o++; # would segfault
1601 my $y = ++$o;
1602 is($x, $o, "copy constructor falls back to assignment (postinc)");
1603 is($y, $o, "copy constructor falls back to assignment (preinc)");
1604}
1605
6f1401dc
DM
1606# only scalar 'x' should currently overload
1607
1608{
1609 package REPEAT;
1610
1611 my ($x,$n, $nm);
1612
1613 use overload
1614 'x' => sub { $x++; 1 },
1615 '0+' => sub { $n++; 1 },
1616 'nomethod' => sub { $nm++; 1 },
1617 'fallback' => 0,
1618 ;
1619
1620 my $s = bless {};
1621
1622 package main;
1623
1624 my @a;
1625 my $count = 3;
1626
1627 ($x,$n,$nm) = (0,0,0);
1628 @a = ((1,2,$s) x $count);
1629 is("$x-$n-$nm", "0-0-0", 'repeat 1');
1630
1631 ($x,$n,$nm) = (0,0,0);
1632 @a = ((1,$s,3) x $count);
1633 is("$x-$n-$nm", "0-0-0", 'repeat 2');
1634
1635 ($x,$n,$nm) = (0,0,0);
1636 @a = ((1,2,3) x $s);
1637 is("$x-$n-$nm", "0-1-0", 'repeat 3');
1638}
1639
1640
1641
1642# RT #57012: magic items need to have mg_get() called before testing for
1643# overload. Lack of this means that overloaded values returned by eg a
1644# tied array didn't call overload methods.
1645# We test here both a tied array and scalar, since the implementation of
1646# tied arrays (and hashes) is such that in rvalue context, mg_get is
1647# called prior to executing the op, while it isn't for a tied scalar.
a02ec77a
DM
1648# We also check that return values are correctly tainted.
1649# We try against two overload packages; one has all expected methods, the
1650# other uses only fallback methods.
6f1401dc
DM
1651
1652{
1653
a02ec77a
DM
1654 # @tests holds a list of test cases. Each elem is an array ref with
1655 # the following entries:
1656 #
1657 # * the value that the overload method should return
1658 #
1659 # * the expression to be evaled. %s is replaced with the
1660 # variable being tested ($ta[0], $ts, or $plain)
1661 #
1662 # * a string listing what functions we expect to be called.
1663 # Each method appends its name in parentheses, so "(=)(+)" means
1664 # we expect the copy constructor and then the add method to be
1665 # called.
1666 #
1667 # * like above, but what should be called for the fallback-only test
1668 # (in this case, nomethod() identifies itself as "(NM:*)" where *
1669 # is the op). If this value is undef, fallback tests are skipped.
1670 #
1671 # * An array ref of expected counts of calls to FETCH/STORE.
1672 # The first three values are:
1673 # 1. the expected number of FETCHs for a tied array
1674 # 2. the expected number of FETCHs for a tied scalar
1675 # 3. the expected number of STOREs
1676 # If there are a further three elements present, then
1677 # these represent the expected counts for the fallback
1678 # version of the tests. If absent, they are assumed to
1679 # be the same as for the full method test
1680 #
1681 # * Under the taint version of the tests, whether we expect
1682 # the result to be tainted (for example comparison ops
1683 # like '==' don't return a tainted value, even if their
1684 # args are.
1685 my @tests;
1686
6f1401dc
DM
1687 my %subs;
1688 my $funcs;
1689 my $use_int;
1690
1691 BEGIN {
1692 # A note on what methods to expect to be called, and
1693 # how many times FETCH/STORE is called:
1694 #
1695 # Mutating ops (+=, ++ etc) trigger a copy ('='), since
7f1e438c 1696 # the code can't distinguish between something that's been copied:
6f1401dc
DM
1697 # $a = foo->new(0); $b = $a; refcnt($$b) == 2
1698 # and overloaded objects stored in ties which will have extra
1699 # refcounts due to the tied_obj magic and entries on the tmps
1700 # stack when returning from FETCH etc. So we always copy.
1701
1702 # This accounts for a '=', and an extra STORE.
1703 # We also have a FETCH returning the final value from the eval,
1704 # plus a FETCH in the overload subs themselves: ($_[0][0])
7f1e438c 1705 # triggers one. However, tied aggregates have a mechanism to prevent
6f1401dc
DM
1706 # multiple fetches between STOREs, which means that the tied
1707 # hash skips doing a FETCH during '='.
1708
a02ec77a
DM
1709 for (qw(+ - * / % ** << >> & | ^)) {
1710 my $op = $_;
1711 $op = '%%' if $op eq '%';
1712 my $e = "%s $op= 3";
6f1401dc
DM
1713 $subs{"$_="} = $e;
1714 # ARRAY FETCH: initial, sub+=, eval-return,
1715 # SCALAR FETCH: initial, sub=, sub+=, eval-return,
1716 # STORE: copy, mutator
a02ec77a
DM
1717 push @tests, [ 18, $e, "(=)($_=)", "(=)(NM:$_=)", [ 3, 4, 2 ], 1 ];
1718
1719 $subs{$_} =
1720 "do { my \$arg = %s; \$_[2] ? (3 $op \$arg) : (\$arg $op 3) }";
6f1401dc
DM
1721 # ARRAY FETCH: initial
1722 # SCALAR FETCH: initial eval-return,
a02ec77a
DM
1723 push @tests, [ 18, "%s $op 3", "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
1724 push @tests, [ 18, "3 $op %s", "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
6f1401dc 1725 }
a02ec77a
DM
1726
1727 # these use string fallback rather than nomethod
1728 for (qw(x .)) {
1729 my $op = $_;
1730 my $e = "%s $op= 3";
1731 $subs{"$_="} = $e;
1732 # For normal case:
1733 # ARRAY FETCH: initial, sub+=, eval-return,
1734 # SCALAR FETCH: initial, sub=, sub+=, eval-return,
1735 # STORE: copy, mutator
1736 # for fallback, we just stringify, so eval-return and copy skipped
c5aa2872
DM
1737
1738 push @tests, [ 18, $e, "(=)($_=)", '("")',
1739 [ 3, 4, 2, 2, 3, 1 ], 1 ];
a02ec77a
DM
1740
1741 $subs{$_} =
1742 "do { my \$arg = %s; \$_[2] ? (3 $op \$arg) : (\$arg $op 3) }";
1743 # ARRAY FETCH: initial
1744 # SCALAR FETCH: initial eval-return,
3bc4ee4c
DM
1745 # with fallback, we just stringify, so eval-return skipped,
1746 # but an extra FETCH happens in sub"", except for 'x',
1747 # which passes a copy of the RV to sub"", avoiding the
1748 # second FETCH
1749
1750 push @tests, [ 18, "%s $op 3", "($_)", '("")',
1751 [ 1, 2, 0, 1, ($_ eq '.' ? 2 : 1), 0 ], 1 ];
1752 next if $_ eq 'x'; # repeat only overloads on LHS
1753 push @tests, [ 18, "3 $op %s", "($_)", '("")',
1754 [ 1, 2, 0, 1, 2, 0 ], 1 ];
a02ec77a
DM
1755 }
1756
6f1401dc
DM
1757 for (qw(++ --)) {
1758 my $pre = "$_%s";
1759 my $post = "%s$_";
1760 $subs{$_} = $pre;
a02ec77a 1761 push @tests,
6f1401dc
DM
1762 # ARRAY FETCH: initial, sub+=, eval-return,
1763 # SCALAR FETCH: initial, sub=, sub+=, eval-return,
1764 # STORE: copy, mutator
a02ec77a 1765 [ 18, $pre, "(=)($_)(\"\")", "(=)(NM:$_)(\"\")", [ 3, 4, 2 ], 1 ],
6f1401dc
DM
1766 # ARRAY FETCH: initial, sub+=
1767 # SCALAR FETCH: initial, sub=, sub+=
1768 # STORE: copy, mutator
a02ec77a 1769 [ 18, $post, "(=)($_)(\"\")", "(=)(NM:$_)(\"\")", [ 2, 3, 2 ], 1 ];
6f1401dc
DM
1770 }
1771
1772 # For the non-mutator ops, we have a initial FETCH,
1773 # an extra FETCH within the sub itself for the scalar option,
1774 # and no STOREs
1775
a02ec77a 1776 for (qw(< <= > >= == != lt le gt ge eq ne)) {
6f1401dc
DM
1777 my $e = "%s $_ 3";
1778 $subs{$_} = $e;
a02ec77a
DM
1779 push @tests, [ 3, $e, "($_)", "(NM:$_)", [ 1, 2, 0 ], 0 ];
1780 }
1781 for (qw(<=> cmp)) {
1782 my $e = "%s $_ 3";
1783 $subs{$_} = $e;
1784 push @tests, [ 3, $e, "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
6f1401dc
DM
1785 }
1786 for (qw(atan2)) {
1787 my $e = "$_ %s, 3";
1788 $subs{$_} = $e;
a02ec77a 1789 push @tests, [ 18, $e, "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
6f1401dc 1790 }
a02ec77a 1791 for (qw(cos sin exp abs log sqrt int ~)) {
6f1401dc
DM
1792 my $e = "$_(%s)";
1793 $subs{$_} = $e;
a02ec77a
DM
1794 push @tests, [ 1.23, $e, "($_)",
1795 ($_ eq 'int' ? '(0+)' : "(NM:$_)") , [ 1, 2, 0 ], 1 ];
1796 }
1797 for (qw(!)) {
1798 my $e = "$_(%s)";
1799 $subs{$_} = $e;
1800 push @tests, [ 1.23, $e, "($_)", '(0+)', [ 1, 2, 0 ], 0 ];
6f1401dc
DM
1801 }
1802 for (qw(-)) {
1803 my $e = "$_(%s)";
1804 $subs{neg} = $e;
a02ec77a 1805 push @tests, [ 18, $e, '(neg)', '(NM:neg)', [ 1, 2, 0 ], 1 ];
6f1401dc
DM
1806 }
1807 my $e = '(%s) ? 1 : 0';
1808 $subs{bool} = $e;
a02ec77a 1809 push @tests, [ 18, $e, '(bool)', '(0+)', [ 1, 2, 0 ], 0 ];
6f1401dc
DM
1810
1811 # note: this is testing unary qr, not binary =~
a02ec77a 1812 $subs{qr} = '(qr/%s/)';
f3ec07c7 1813 push @tests, [ "abc", '"abc" =~ (%s)', '(qr)', '("")', [ 1, 2, 0 ], 0 ];
15d9c083
FC
1814 push @tests, [ chr 256, 'chr(256) =~ (%s)', '(qr)', '("")',
1815 [ 1, 2, 0 ], 0 ];
6f1401dc
DM
1816
1817 $e = '"abc" ~~ (%s)';
1818 $subs{'~~'} = $e;
a02ec77a 1819 push @tests, [ "abc", $e, '(~~)', '(NM:~~)', [ 1, 1, 0 ], 0 ];
6f1401dc
DM
1820
1821 $subs{'-X'} = 'do { my $f = (%s);'
1822 . '$_[1] eq "r" ? (-r ($f)) :'
1823 . '$_[1] eq "e" ? (-e ($f)) :'
1824 . '$_[1] eq "f" ? (-f ($f)) :'
1825 . '$_[1] eq "l" ? (-l ($f)) :'
1826 . '$_[1] eq "t" ? (-t ($f)) :'
1827 . '$_[1] eq "T" ? (-T ($f)) : 0;}';
7f1e438c 1828 # Note - we don't care what these file tests return, as
6f1401dc
DM
1829 # long as the tied and untied versions return the same value.
1830 # The flags below are chosen to test all uses of tryAMAGICftest_MG
1831 for (qw(r e f l t T)) {
40c852de 1832 push @tests, [ 'TEST', "-$_ (%s)", '(-X)', '("")', [ 1, 2, 0 ], 0 ];
6f1401dc
DM
1833 }
1834
1835 $subs{'${}'} = '%s';
a02ec77a 1836 push @tests, [ do {my $s=99; \$s}, '${%s}', '(${})', undef, [ 1, 1, 0 ], 0 ];
6f1401dc
DM
1837
1838 # we skip testing '@{}' here because too much of this test
a02ec77a 1839 # framework involves array dereferences!
6f1401dc
DM
1840
1841 $subs{'%{}'} = '%s';
a02ec77a 1842 push @tests, [ {qw(a 1 b 2 c 3)}, 'join "", sort keys %%{%s}',
9026059d 1843 '(%{})', undef, [ 1, 1, 0 ], 0 ];
6f1401dc
DM
1844
1845 $subs{'&{}'} = '%s';
a02ec77a
DM
1846 push @tests, [ sub {99}, 'do {&{%s} for 1,2}',
1847 '(&{})(&{})', undef, [ 2, 2, 0 ], 0 ];
6f1401dc
DM
1848
1849 our $RT57012A = 88;
1850 our $RT57012B;
1851 $subs{'*{}'} = '%s';
a02ec77a
DM
1852 push @tests, [ \*RT57012A, '*RT57012B = *{%s}; our $RT57012B',
1853 '(*{})', undef, [ 1, 1, 0 ], 0 ];
6f1401dc 1854
9426e1a5
DM
1855 my $iter_text = ("some random text\n" x 100) . $^X;
1856 open my $iter_fh, '<', \$iter_text
1857 or die "open of \$iter_text gave ($!)\n";
1858 $subs{'<>'} = '<$iter_fh>';
1859 push @tests, [ $iter_fh, '<%s>', '(<>)', undef, [ 1, 1, 0 ], 1 ];
3dd32f56
FC
1860 push @tests, [ $iter_fh,
1861 'local *CORE::GLOBAL::glob = sub {}; eval q|<%s>|',
1862 '(<>)', undef, [ 1, 1, 0 ], 1 ];
6f1401dc 1863
895b760f
DM
1864 # eval should do tie, overload on its arg before checking taint */
1865 push @tests, [ '1;', 'eval q(eval %s); $@ =~ /Insecure/',
1866 '("")', '("")', [ 1, 2, 0 ], 0 ];
1867
1868
6f1401dc
DM
1869 for my $sub (keys %subs) {
1870 my $term = $subs{$sub};
1871 my $t = sprintf $term, '$_[0][0]';
a02ec77a 1872 my $e ="sub { \$funcs .= '($sub)'; my \$r; if (\$use_int) {"
6f1401dc 1873 . "use integer; \$r = ($t) } else { \$r = ($t) } \$r }";
a02ec77a
DM
1874 $subs{$sub} = eval $e;
1875 die "Compiling sub gave error:\n<$e>\n<$@>\n" if $@;
6f1401dc
DM
1876 }
1877 }
1878
1879 my $fetches;
1880 my $stores;
1881
1882 package RT57012_OV;
1883
6f1401dc
DM
1884 use overload
1885 %subs,
a02ec77a
DM
1886 "=" => sub { $funcs .= '(=)'; bless [ $_[0][0] ] },
1887 '0+' => sub { $funcs .= '(0+)'; 0 + $_[0][0] },
1888 '""' => sub { $funcs .= '("")'; "$_[0][0]" },
1889 ;
1890
1891 package RT57012_OV_FB; # only contains fallback conversion functions
1892
1893 use overload
1894 "=" => sub { $funcs .= '(=)'; bless [ $_[0][0] ] },
1895 '0+' => sub { $funcs .= '(0+)'; 0 + $_[0][0] },
1896 '""' => sub { $funcs .= '("")'; "$_[0][0]" },
1897 "nomethod" => sub {
1898 $funcs .= "(NM:$_[3])";
1899 my $e = defined($_[1])
1900 ? $_[3] eq 'atan2'
1901 ? $_[2]
1902 ? "atan2(\$_[1],\$_[0][0])"
1903 : "atan2(\$_[0][0],\$_[1])"
1904 : $_[2]
1905 ? "\$_[1] $_[3] \$_[0][0]"
1906 : "\$_[0][0] $_[3] \$_[1]"
1907 : $_[3] eq 'neg'
1908 ? "-\$_[0][0]"
1909 : "$_[3](\$_[0][0])";
1910 my $r;
1911 if ($use_int) {
1912 use integer; $r = eval $e;
1913 }
1914 else {
1915 $r = eval $e;
1916 }
1917 ::diag("eval of nomethod <$e> gave <$@>") if $@;
1918 $r;
1919 }
1920
6f1401dc
DM
1921 ;
1922
1923 package RT57012_TIE_S;
1924
1925 my $tie_val;
a02ec77a 1926 sub TIESCALAR { bless [ bless [ $tie_val ], $_[1] ] }
6f1401dc
DM
1927 sub FETCH { $fetches++; $_[0][0] }
1928 sub STORE { $stores++; $_[0][0] = $_[1] }
1929
1930 package RT57012_TIE_A;
1931
1932 sub TIEARRAY { bless [] }
1933 sub FETCH { $fetches++; $_[0][0] }
1934 sub STORE { $stores++; $_[0][$_[1]] = $_[2] }
1935
1936 package main;
1937
a02ec77a
DM
1938 for my $test (@tests) {
1939 my ($val, $sub_term, $exp_funcs, $exp_fb_funcs,
1940 $exp_counts, $exp_taint) = @$test;
1941
1942 my $tainted_val;
1943 {
1944 # create tainted version of $val (unless its a ref)
1945 my $t = substr($^X,0,0);
1946 my $t0 = $t."0";
1947 my $val1 = $val; # use a copy to avoid stringifying original
1948 $tainted_val = ref($val1) ? $val :
1949 ($val1 =~ /^[\d\.]+$/) ? $val+$t0 : $val.$t;
1950 }
1951 $tie_val = $tainted_val;
6f1401dc 1952
6f1401dc
DM
1953 for my $int ('', 'use integer; ') {
1954 $use_int = ($int ne '');
a02ec77a
DM
1955 my $plain = $tainted_val;
1956 my $plain_term = $int . sprintf $sub_term, '$plain';
1957 my $exp = eval $plain_term;
1958 diag("eval of plain_term <$plain_term> gave <$@>") if $@;
1959 is(tainted($exp), $exp_taint,
1960 "<$plain_term> taint of expected return");
1961
1962 for my $ov_pkg (qw(RT57012_OV RT57012_OV_FB)) {
a02ec77a
DM
1963 next if $ov_pkg eq 'RT57012_OV_FB'
1964 and not defined $exp_fb_funcs;
1965 my ($exp_fetch_a, $exp_fetch_s, $exp_store) =
1966 ($ov_pkg eq 'RT57012_OV' || @$exp_counts < 4)
1967 ? @$exp_counts[0,1,2]
1968 : @$exp_counts[3,4,5];
1969
1970 tie my $ts, 'RT57012_TIE_S', $ov_pkg;
6f1401dc 1971 tie my @ta, 'RT57012_TIE_A';
a02ec77a
DM
1972 $ta[0] = bless [ $tainted_val ], $ov_pkg;
1973 my $oload = bless [ $tainted_val ], $ov_pkg;
1974
9426e1a5
DM
1975 for my $var ('$ta[0]', '$ts', '$oload',
1976 ($sub_term eq '<%s>' ? '${ts}' : ())
1977 ) {
a02ec77a
DM
1978
1979 $funcs = '';
1980 $fetches = 0;
1981 $stores = 0;
1982
1983 my $res_term = $int . sprintf $sub_term, $var;
1984 my $desc = "<$res_term> $ov_pkg" ;
1985 my $res = eval $res_term;
1986 diag("eval of res_term $desc gave <$@>") if $@;
7f1e438c 1987 # uniquely, the inc/dec ops return the original
a02ec77a
DM
1988 # ref rather than a copy, so stringify it to
1989 # find out if its tainted
1990 $res = "$res" if $res_term =~ /\+\+|--/;
1991 is(tainted($res), $exp_taint,
1992 "$desc taint of result return");
a02ec77a
DM
1993 is($res, $exp, "$desc return value");
1994 my $fns =($ov_pkg eq 'RT57012_OV_FB')
1995 ? $exp_fb_funcs : $exp_funcs;
1996 if ($var eq '$oload' && $res_term !~ /oload(\+\+|--)/) {
1997 # non-tied overloading doesn't trigger a copy
1998 # except for post inc/dec
1999 $fns =~ s/^\(=\)//;
2000 }
2001 is($funcs, $fns, "$desc methods called");
2002 next if $var eq '$oload';
2003 my $exp_fetch = ($var eq '$ts') ?
2004 $exp_fetch_s : $exp_fetch_a;
2005 is($fetches, $exp_fetch, "$desc FETCH count");
2006 is($stores, $exp_store, "$desc STORE count");
2007
2008 }
2009
6f1401dc
DM
2010 }
2011 }
2012 }
2013}
2014
25222ff9
FC
2015# Test overload from the main package
2016fresh_perl_is
2017 '$^W = 1; use overload q\""\ => sub {"ning"}; print bless []',
2018 'ning',
2019 { switches => ['-wl'], stderr => 1 },
2020 'use overload from the main package'
2021;
2022
56f08af2
FC
2023{
2024 package blessed_methods;
2025 use overload '+' => sub {};
2026 bless overload::Method __PACKAGE__,'+';
2027 eval { overload::Method __PACKAGE__,'+' };
2028 ::is($@, '', 'overload::Method and blessed overload methods');
2029}
2030
bf5522a1
MB
2031{
2032 # fallback to 'cmp' and '<=>' with heterogeneous operands
2033 # [perl #71286]
2034 my $not_found = 'no method found';
2035 my $used = 0;
2036 package CmpBase;
2037 sub new {
2038 my $n = $_[1] || 0;
2039 bless \$n, ref $_[0] || $_[0];
2040 }
2041 sub cmp {
2042 $used = \$_[0];
2043 (${$_[0]} <=> ${$_[1]}) * ($_[2] ? -1 : 1);
2044 }
2045
2046 package NCmp;
2047 use base 'CmpBase';
2048 use overload '<=>' => 'cmp';
2049
2050 package SCmp;
2051 use base 'CmpBase';
2052 use overload 'cmp' => 'cmp';
2053
2054 package main;
2055 my $n = NCmp->new(5);
2056 my $s = SCmp->new(3);
2057 my $res;
2058
2059 eval { $res = $n > $s; };
2060 $res = $not_found if $@ =~ /$not_found/;
2061 is($res, 1, 'A>B using A<=> when B overloaded, no B<=>');
2062
2063 eval { $res = $s < $n; };
2064 $res = $not_found if $@ =~ /$not_found/;
2065 is($res, 1, 'A<B using B<=> when A overloaded, no A<=>');
2066
2067 eval { $res = $s lt $n; };
2068 $res = $not_found if $@ =~ /$not_found/;
2069 is($res, 1, 'A lt B using A:cmp when B overloaded, no B:cmp');
2070
2071 eval { $res = $n gt $s; };
2072 $res = $not_found if $@ =~ /$not_found/;
2073 is($res, 1, 'A gt B using B:cmp when A overloaded, no A:cmp');
2074
2075 my $o = NCmp->new(9);
2076 $res = $n < $o;
2077 is($used, \$n, 'A < B uses <=> from A in preference to B');
2078
2079 my $t = SCmp->new(7);
2080 $res = $s lt $t;
2081 is($used, \$s, 'A lt B uses cmp from A in preference to B');
2082}
2083
2084{
2085 # Combinatorial testing of 'fallback' and 'nomethod'
2086 # [perl #71286]
2087 package NuMB;
2088 use overload '0+' => sub { ${$_[0]}; },
2089 '""' => 'str';
2090 sub new {
2091 my $self = shift;
2092 my $n = @_ ? shift : 0;
2093 bless my $obj = \$n, ref $self || $self;
2094 }
2095 sub str {
2096 no strict qw/refs/;
2097 my $s = "(${$_[0]} ";
2098 $s .= "nomethod, " if defined ${ref($_[0]).'::(nomethod'};
2099 my $fb = ${ref($_[0]).'::()'};
2100 $s .= "fb=" . (defined $fb ? 0 + $fb : 'undef') . ")";
2101 }
2102 sub nomethod { "${$_[0]}.nomethod"; }
2103
2104 # create classes for tests
2105 package main;
2106 my @falls = (0, 'undef', 1);
2107 my @nomethods = ('', 'nomethod');
2108 my $not_found = 'no method found';
2109 for my $fall (@falls) {
2110 for my $nomethod (@nomethods) {
2111 my $nomethod_decl = $nomethod
2112 ? $nomethod . "=>'nomethod'," : '';
2113 eval qq{
2114 package NuMB$fall$nomethod;
2115 use base qw/NuMB/;
2116 use overload $nomethod_decl
2117 fallback => $fall;
2118 };
2119 }
2120 }
2121
2122 # operation and precedence of 'fallback' and 'nomethod'
2123 # for all combinations with 2 overloaded operands
2124 for my $nomethod2 (@nomethods) {
2125 for my $nomethod1 (@nomethods) {
2126 for my $fall2 (@falls) {
2127 my $pack2 = "NuMB$fall2$nomethod2";
2128 for my $fall1 (@falls) {
2129 my $pack1 = "NuMB$fall1$nomethod1";
2130 my ($test, $out, $exp);
2131 eval qq{
2132 my \$x = $pack1->new(2);
2133 my \$y = $pack2->new(3);
2134 \$test = "\$x" . ' * ' . "\$y";
2135 \$out = \$x * \$y;
2136 };
2137 $out = $not_found if $@ =~ /$not_found/;
2138 $exp = $nomethod1 ? '2.nomethod' :
2139 $nomethod2 ? '3.nomethod' :
2140 $fall1 eq '1' && $fall2 eq '1' ? 6
2141 : $not_found;
2142 is($out, $exp, "$test --> $exp");
2143 }
2144 }
2145 }
2146 }
2147
2148 # operation of 'fallback' and 'nomethod'
2149 # where the other operand is not overloaded
2150 for my $nomethod (@nomethods) {
2151 for my $fall (@falls) {
2152 my ($test, $out, $exp);
2153 eval qq{
2154 my \$x = NuMB$fall$nomethod->new(2);
2155 \$test = "\$x" . ' * 3';
2156 \$out = \$x * 3;
2157 };
2158 $out = $not_found if $@ =~ /$not_found/;
2159 $exp = $nomethod ? '2.nomethod' :
2160 $fall eq '1' ? 6
2161 : $not_found;
2162 is($out, $exp, "$test --> $exp");
2163
2164 eval qq{
2165 my \$x = NuMB$fall$nomethod->new(2);
2166 \$test = '3 * ' . "\$x";
2167 \$out = 3 * \$x;
2168 };
2169 $out = $not_found if $@ =~ /$not_found/;
2170 is($out, $exp, "$test --> $exp");
2171 }
2172 }
2173}
2174
bff33ce0
DM
2175# since 5.6 overloaded <> was leaving an extra arg on the stack!
2176
2177{
2178 package Iter1;
2179 use overload '<>' => sub { 11 };
2180 package main;
2181 my $a = bless [], 'Iter1';
2182 my $x;
2183 my @a = (10, ($x = <$a>), 12);
2184 is ($a[0], 10, 'Iter1: a[0]');
2185 is ($a[1], 11, 'Iter1: a[1]');
2186 is ($a[2], 12, 'Iter1: a[2]');
2187 @a = (10, ($x .= <$a>), 12);
2188 is ($a[0], 10, 'Iter1: a[0] concat');
2189 is ($a[1], 1111, 'Iter1: a[1] concat');
2190 is ($a[2], 12, 'Iter1: a[2] concat');
2191}
bf5522a1 2192
5e2699c2
FC
2193# Some tests for error messages
2194{
2195 package Justus;
2196 use overload '+' => 'justice';
bee7c574 2197 eval {"".bless[]};
5e2699c2 2198 ::like $@, qr/^Can't resolve method "justice" overloading "\+" in p(?x:
f0e9f182 2199 )ackage "Justus" at /,
5e2699c2
FC
2200 'Error message when explicitly named overload method does not exist';
2201
2202 package JustUs;
2203 our @ISA = 'JustYou';
2204 package JustYou { use overload '+' => 'injustice'; }
2205 "JustUs"->${\"(+"};
bee7c574 2206 eval {"".bless []};
5e2699c2 2207 ::like $@, qr/^Stub found while resolving method "\?{3}" overloadin(?x:
f0e9f182 2208 )g "\+" in package "JustUs" at /,
5e2699c2
FC
2209 'Error message when sub stub is encountered';
2210}
bf5522a1 2211
e6bb0a40
FC
2212# [perl #40333]
2213# overload::Overloaded should not use a ->can designed for autoloading.
2214# This example attempts to be as realistic as possible. The o class has a
2215# default singleton object, but can have instances, too. The proxy class
2216# represents proxies for o objects, but class methods delegate to the
2217# singleton.
2218# overload::Overloaded used to return incorrect results for proxy objects.
2219package proxy {
2220 sub new { bless [$_[1]], $_[0] }
2221 sub AUTOLOAD {
2222 our $AUTOLOAD =~ s/.*:://;
2223 &_self->$AUTOLOAD;
2224 }
2225 sub can { SUPER::can{@_} || &_self->can($_[1]) }
2226 sub _self { ref $_[0] ? $_[0][0] : $o::singleton }
2227}
2228package o { use overload '""' => sub { 'keck' };
2229 sub new { bless[], $_[0] }
2230 our $singleton = o->new; }
2231ok !overload::Overloaded(new proxy new o),
2232 'overload::Overloaded does not incorrectly return true for proxy classes';
2233
2537c17b
JJ
2234# Another test, based on the type of explosive test class for which
2235# perl #40333 was filed.
2236{
2237 package broken_can;
2238 sub can {}
2239 use overload '""' => sub {"Ahoy!"};
2240
2241 package main;
2242 my $obj = bless [], 'broken_can';
2243 ok(overload::Overloaded($obj));
2244}
2245
929e9994
FC
2246sub eleventative::cos { 'eleven' }
2247sub twelvetative::abs { 'twelve' }
2248sub thirteentative::abs { 'thirteen' }
2249sub fourteentative::abs { 'fourteen' }
2250@eleventative::ISA = twelvetative::;
2251{
2252 my $o = bless [], 'eleventative';
2253 eval 'package eleventative; use overload map +($_)x2, cos=>abs=>';
2254 is cos $o, 'eleven', 'overloading applies to object blessed before';
2255 bless [], 'eleventative';
2256 is cos $o, 'eleven',
2257 'ovrld applies to previously-blessed obj after other obj is blessed';
2258 $o = bless [], 'eleventative';
2259 *eleventative::cos = sub { 'ten' };
2260 is cos $o, 'ten', 'method changes affect overloading';
2261 @eleventative::ISA = thirteentative::;
2262 is abs $o, 'thirteen', 'isa changes affect overloading';
2263 bless $o, 'fourteentative';
2264 @fourteentative::ISA = 'eleventative';
929e9994
FC
2265 is abs $o, 'fourteen', 'isa changes can turn overloading on';
2266}
2267
27b36e73
FC
2268# no overload "fallback";
2269{ package phake;
2270 use overload fallback => 1, '""' => sub { 'arakas' };
2271 no overload 'fallback';
2272}
2273$a = bless [], 'phake';
2274is "$a", "arakas",
2275 'no overload "fallback" does not stop overload from working';
2276ok !eval { () = $a eq 'mpizeli'; 1 },
2277 'no overload "fallback" resets fallback to undef on overloaded class';
50853fa9
FC
2278{ package ent; use overload fallback => 0, abs => sub{};
2279 our@ISA = 'huorn';
2280 package huorn;
2281 use overload fallback => 1;
2282 package ent;
2283 no overload "fallback"; # disable previous declaration
2284}
2285$a = bless [], ent::;
2286is eval {"$a"}, overload::StrVal($a),
2287 'no overload undoes fallback declaration completetly'
2288 or diag $@;
2289
2290# inherited fallback
2291{
2292 package pervyy;
2293 our @ISA = 'vtoryy';
2294 use overload "abs" =>=> sub {};
2295 package vtoryy;
2296 use overload fallback => 1, 'sin' =>=> sub{}
2297}
2298$a = bless [], pervyy::;
2299is eval {"$a"}, overload::StrVal($a),
2300 'fallback is inherited by classes that have their own overloading'
2301 or diag $@;
27b36e73 2302
1d6df9f8
FC
2303# package separators in method names
2304{
2305 package mane;
2306 use overload q\""\ => "bear::strength";
2307 use overload bool => "bear'bouillon";
2308}
2309@bear::ISA = 'food';
2310sub food::strength { 'twine' }
2311sub food::bouillon { 0 }
2312$a = bless[], mane::;
2313is eval { "$a" }, 'twine', ':: in method name' or diag $@;
2314is eval { !$a }, 1, "' in method name" or diag $@;
2315
3866ea3b
FC
2316# [perl #113050] Half of CPAN assumes fallback is under "()"
2317{
2318 package dodo;
2319 use overload '+' => sub {};
2320 no strict;
2321 *{"dodo::()"} = sub{};
2322 ${"dodo::()"} = 1;
2323}
2324$a = bless [],'dodo';
2325is eval {"$a"}, overload::StrVal($a), 'fallback is stored under "()"';
2326
1d6df9f8 2327
929e9994
FC
2328{ # undefining the overload stash -- KEEP THIS TEST LAST
2329 package ant;
2330 use overload '+' => 'onion';
2331 $_ = \&overload::nil;
2332 undef %overload::;
88650ec4 2333 ()=0+bless[];
929e9994
FC
2334 ::ok(1, 'no crash when undefining %overload::');
2335}
2336
e6bb0a40 2337
800401ee 2338# EOF