This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
190dcf24f5a01230ed790c0715126e2fe68c0ba0
[perl5.git] / lib / overload.t
1 #!./perl -T
2
3 BEGIN {
4     chdir 't' if -d 't';
5     @INC = '../lib';
6     require Config;
7     if (($Config::Config{'extensions'} !~ m!\bList/Util\b!) ){
8         print "1..0 # Skip -- Perl configured without List::Util module\n";
9         exit 0;
10     }
11 }
12
13 package Oscalar;
14 use 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
32 qw(
33 ""      stringify
34 0+      numify)                 # Order of arguments insignificant
35 );
36
37 sub new {
38   my $foo = $_[1];
39   bless \$foo, $_[0];
40 }
41
42 sub stringify { "${$_[0]}" }
43 sub numify { 0 + "${$_[0]}" }   # Not needed, additional overhead
44                                 # comparing to direct compilation based on
45                                 # stringify
46
47 package main;
48
49 $| = 1;
50 BEGIN { require './test.pl' }
51 plan tests => 5059;
52
53 use Scalar::Util qw(tainted);
54
55 $a = new Oscalar "087";
56 $b= "$a";
57
58 is($b, $a);
59 is($b, "087");
60 is(ref $a, "Oscalar");
61 is($a, $a);
62 is($a, "087");
63
64 $c = $a + 7;
65
66 is(ref $c, "Oscalar");
67 isnt($c, $a);
68 is($c, "94");
69
70 $b=$a;
71
72 is(ref $a, "Oscalar");
73
74 $b++;
75
76 is(ref $b, "Oscalar");
77 is($a, "087");
78 is($b, "88");
79 is(ref $a, "Oscalar");
80
81 $c=$b;
82 $c-=$a;
83
84 is(ref $c, "Oscalar");
85 is($a, "087");
86 is($c, "1");
87 is(ref $a, "Oscalar");
88
89 $b=1;
90 $b+=$a;
91
92 is(ref $b, "Oscalar");
93 is($a, "087");
94 is($b, "88");
95 is(ref $a, "Oscalar");
96
97 eval q[ package Oscalar; use overload ('++' => sub { $ {$_[0]}++;$_[0] } ) ];
98
99 $b=$a;
100
101 is(ref $a, "Oscalar");
102
103 $b++;
104
105 is(ref $b, "Oscalar");
106 is($a, "087");
107 is($b, "88");
108 is(ref $a, "Oscalar");
109
110 package Oscalar;
111 $dummy=bless \$dummy;           # Now cache of method should be reloaded
112 package main;
113
114 $b=$a;
115 $b++;                           
116
117 is(ref $b, "Oscalar");
118 is($a, "087");
119 is($b, "88");
120 is(ref $a, "Oscalar");
121
122 undef $b;                       # Destroying updates tables too...
123
124 eval q[package Oscalar; use overload ('++' => sub { $ {$_[0]} += 2; $_[0] } ) ];
125
126 $b=$a;
127
128 is(ref $a, "Oscalar");
129
130 $b++;
131
132 is(ref $b, "Oscalar");
133 is($a, "087");
134 is($b, "88");
135 is(ref $a, "Oscalar");
136
137 package Oscalar;
138 $dummy=bless \$dummy;           # Now cache of method should be reloaded
139 package main;
140
141 $b++;                           
142
143 is(ref $b, "Oscalar");
144 is($a, "087");
145 is($b, "90");
146 is(ref $a, "Oscalar");
147
148 $b=$a;
149 $b++;
150
151 is(ref $b, "Oscalar");
152 is($a, "087");
153 is($b, "89");
154 is(ref $a, "Oscalar");
155
156
157 ok($b? 1:0);
158
159 eval 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
166 is(ref $b, "Oscalar");
167 is($a, "087");
168 is($b, "087");
169 is(ref $a, "Oscalar");
170
171 $b++;
172
173 is(ref $b, "Oscalar");
174 is($a, "087");
175 is($b, "89");
176 is(ref $a, "Oscalar");
177 is($copies, undef);
178
179 $b+=1;
180
181 is(ref $b, "Oscalar");
182 is($a, "087");
183 is($b, "90");
184 is(ref $a, "Oscalar");
185 is($copies, undef);
186
187 $b=$a;
188 $b+=1;
189
190 is(ref $b, "Oscalar");
191 is($a, "087");
192 is($b, "88");
193 is(ref $a, "Oscalar");
194 is($copies, undef);
195
196 $b=$a;
197 $b++;
198
199 is(ref $b, "Oscalar");
200 is($a, "087");
201 is($b, "89");
202 is(ref $a, "Oscalar");
203 is($copies, 1);
204
205 eval q[package Oscalar; use overload ('+=' => sub {$ {$_[0]} += 3*$_[1];
206                                                    $_[0] } ) ];
207 $c=new Oscalar;                 # Cause rehash
208
209 $b=$a;
210 $b+=1;
211
212 is(ref $b, "Oscalar");
213 is($a, "087");
214 is($b, "90");
215 is(ref $a, "Oscalar");
216 is($copies, 2);
217
218 $b+=$b;
219
220 is(ref $b, "Oscalar");
221 is($b, "360");
222 is($copies, 2);
223 $b=-$b;
224
225 is(ref $b, "Oscalar");
226 is($b, "-360");
227 is($copies, 2);
228
229 $b=abs($b);
230
231 is(ref $b, "Oscalar");
232 is($b, "360");
233 is($copies, 2);
234
235 $b=abs($b);
236
237 is(ref $b, "Oscalar");
238 is($b, "360");
239 is($copies, 2);
240
241 eval 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;
247 is($a, "_.yy.__.yy.__.yy._");
248
249 eval q[package Oscalar; 
250        use overload ('.' => sub {new Oscalar ( $_[2] ? 
251                                               "_.$_[1].__.$ {$_[0]}._"
252                                               : "_.$ {$_[0]}.__.$_[1]._")}) ];
253
254 $a=new Oscalar "xx";
255
256 is("b${a}c", "_._.b.__.xx._.__.c._");
257
258 # Check inheritance of overloading;
259 {
260   package OscalarI;
261   @ISA = 'Oscalar';
262 }
263
264 $aI = new OscalarI "$a";
265 is(ref $aI, "OscalarI");
266 is("$aI", "xx");
267 is($aI, "xx");
268 is("b${aI}c", "_._.b.__.xx._.__.c._");
269
270 # Here we test blessing to a package updates hash
271
272 eval "package Oscalar; no overload '.'";
273
274 is("b${a}", "_.b.__.xx._");
275 $x="1";
276 bless \$x, Oscalar;
277 is("b${a}c", "bxxc");
278 new Oscalar 1;
279 is("b${a}c", "bxxc");
280
281 # Negative overloading:
282
283 $na = eval { ~$a };
284 like($@, qr/no method found/);
285
286 # Check AUTOLOADING:
287
288 *Oscalar::AUTOLOAD = 
289   sub { *{"Oscalar::$AUTOLOAD"} = sub {"_!_" . shift() . "_!_"} ;
290         goto &{"Oscalar::$AUTOLOAD"}};
291
292 eval "package Oscalar; sub comple; use overload '~' => 'comple'";
293
294 $na = eval { ~$a };             # Hash was not updated
295 like($@, qr/no method found/);
296
297 bless \$x, Oscalar;
298
299 $na = eval { ~$a };             # Hash updated
300 warn "'$na', $@" if $@;
301 ok !$@;
302 is($na, '_!_xx_!_');
303
304 $na = 0;
305
306 $na = eval { ~$aI };            # Hash was not updated
307 like($@, qr/no method found/);
308
309 bless \$x, OscalarI;
310
311 $na = eval { ~$aI };
312 print $@;
313
314 ok(!$@);
315 is($na, '_!_xx_!_');
316
317 eval "package Oscalar; sub rshft; use overload '>>' => 'rshft'";
318
319 $na = eval { $aI >> 1 };        # Hash was not updated
320 like($@, qr/no method found/);
321
322 bless \$x, OscalarI;
323
324 $na = 0;
325
326 $na = eval { $aI >> 1 };
327 print $@;
328
329 ok(!$@);
330 is($na, '_!_xx_!_');
331
332 # warn overload::Method($a, '0+'), "\n";
333 is(overload::Method($a, '0+'), \&Oscalar::numify);
334 is(overload::Method($aI,'0+'), \&Oscalar::numify);
335 ok(overload::Overloaded($aI));
336 ok(!overload::Overloaded('overload'));
337
338 ok(! defined overload::Method($aI, '<<'));
339 ok(! defined overload::Method($a, '<'));
340
341 like (overload::StrVal($aI), qr/^OscalarI=SCALAR\(0x[\da-fA-F]+\)$/);
342 is(overload::StrVal(\$aI), "@{[\$aI]}");
343
344 # Check overloading by methods (specified deep in the ISA tree).
345 {
346   package OscalarII;
347   @ISA = 'OscalarI';
348   sub Oscalar::lshft {"_<<_" . shift() . "_<<_"}
349   eval "package OscalarI; use overload '<<' => 'lshft', '|' => 'lshft'";
350 }
351
352 $aaII = "087";
353 $aII = \$aaII;
354 bless $aII, 'OscalarII';
355 bless \$fake, 'OscalarI';               # update the hash
356 is(($aI | 3), '_<<_xx_<<_');
357 # warn $aII << 3;
358 is(($aII << 3), '_<<_087_<<_');
359
360 {
361   BEGIN { $int = 7; overload::constant 'integer' => sub {$int++; shift}; }
362   $out = 2**10;
363 }
364 is($int, 9);
365 is($out, 1024);
366 is($int, 9);
367 {
368   BEGIN { overload::constant 'integer' => sub {$int++; shift()+1}; }
369   eval q{$out = 42};
370 }
371 is($int, 10);
372 is($out, 43);
373
374 $foo = 'foo';
375 $foo1 = 'f\'o\\o';
376 {
377   BEGIN { $q = $qr = 7; 
378           overload::constant 'q' => sub {$q++; push @q, shift, ($_[1] || 'none'); shift},
379                              'qr' => sub {$qr++; push @qr, shift, ($_[1] || 'none'); shift}; }
380   $out = 'foo';
381   $out1 = 'f\'o\\o';
382   $out2 = "a\a$foo,\,";
383   /b\b$foo.\./;
384 }
385
386 is($out, 'foo');
387 is($out, $foo);
388 is($out1, 'f\'o\\o');
389 is($out1, $foo1);
390 is($out2, "a\afoo,\,");
391 is("@q", "foo q f'o\\\\o q a\\a qq ,\\, qq");
392 is($q, 11);
393 is("@qr", "b\\b qq .\\. qq");
394 is($qr, 9);
395
396 {
397   $_ = '!<b>!foo!<-.>!';
398   BEGIN { overload::constant 'q' => sub {push @q1, shift, ($_[1] || 'none'); "_<" . (shift) . ">_"},
399                              'qr' => sub {push @qr1, shift, ($_[1] || 'none'); "!<" . (shift) . ">!"}; }
400   $out = 'foo';
401   $out1 = 'f\'o\\o';
402   $out2 = "a\a$foo,\,";
403   $res = /b\b$foo.\./;
404   $a = <<EOF;
405 oups
406 EOF
407   $b = <<'EOF';
408 oups1
409 EOF
410   $c = bareword;
411   m'try it';
412   s'first part'second part';
413   s/yet another/tail here/;
414   tr/A-Z/a-z/;
415 }
416
417 is($out, '_<foo>_');
418 is($out1, '_<f\'o\\o>_');
419 is($out2, "_<a\a>_foo_<,\,>_");
420 is("@q1", "foo q f'o\\\\o q a\\a qq ,\\, qq oups
421  qq oups1
422  q second part q tail here s A-Z tr a-z tr");
423 is("@qr1", "b\\b qq .\\. qq try it q first part q yet another qq");
424 is($res, 1);
425 is($a, "_<oups
426 >_");
427 is($b, "_<oups1
428 >_");
429 is($c, "bareword");
430
431 {
432   package symbolic;             # Primitive symbolic calculator
433   use overload nomethod => \&wrap, '""' => \&str, '0+' => \&num,
434       '=' => \&cpy, '++' => \&inc, '--' => \&dec;
435
436   sub new { shift; bless ['n', @_] }
437   sub cpy {
438     my $self = shift;
439     bless [@$self], ref $self;
440   }
441   sub inc { $_[0] = bless ['++', $_[0], 1]; }
442   sub dec { $_[0] = bless ['--', $_[0], 1]; }
443   sub wrap {
444     my ($obj, $other, $inv, $meth) = @_;
445     if ($meth eq '++' or $meth eq '--') {
446       @$obj = ($meth, (bless [@$obj]), 1); # Avoid circular reference
447       return $obj;
448     }
449     ($obj, $other) = ($other, $obj) if $inv;
450     bless [$meth, $obj, $other];
451   }
452   sub str {
453     my ($meth, $a, $b) = @{+shift};
454     $a = 'u' unless defined $a;
455     if (defined $b) {
456       "[$meth $a $b]";
457     } else {
458       "[$meth $a]";
459     }
460   } 
461   my %subr = ( 'n' => sub {$_[0]} );
462   foreach my $op (split " ", $overload::ops{with_assign}) {
463     $subr{$op} = $subr{"$op="} = eval "sub {shift() $op shift()}";
464   }
465   my @bins = qw(binary 3way_comparison num_comparison str_comparison);
466   foreach my $op (split " ", "@overload::ops{ @bins }") {
467     $subr{$op} = eval "sub {shift() $op shift()}";
468   }
469   foreach my $op (split " ", "@overload::ops{qw(unary func)}") {
470     $subr{$op} = eval "sub {$op shift()}";
471   }
472   $subr{'++'} = $subr{'+'};
473   $subr{'--'} = $subr{'-'};
474   
475   sub num {
476     my ($meth, $a, $b) = @{+shift};
477     my $subr = $subr{$meth} 
478       or die "Do not know how to ($meth) in symbolic";
479     $a = $a->num if ref $a eq __PACKAGE__;
480     $b = $b->num if ref $b eq __PACKAGE__;
481     $subr->($a,$b);
482   }
483   sub TIESCALAR { my $pack = shift; $pack->new(@_) }
484   sub FETCH { shift }
485   sub nop {  }          # Around a bug
486   sub vars { my $p = shift; tie($_, $p), $_->nop foreach @_; }
487   sub STORE { 
488     my $obj = shift; 
489     $#$obj = 1; 
490     $obj->[1] = shift;
491   }
492 }
493
494 {
495   my $foo = new symbolic 11;
496   my $baz = $foo++;
497   is((sprintf "%d", $foo), '12');
498   is((sprintf "%d", $baz), '11');
499   my $bar = $foo;
500   $baz = ++$foo;
501   is((sprintf "%d", $foo), '13');
502   is((sprintf "%d", $bar), '12');
503   is((sprintf "%d", $baz), '13');
504   my $ban = $foo;
505   $baz = ($foo += 1);
506   is((sprintf "%d", $foo), '14');
507   is((sprintf "%d", $bar), '12');
508   is((sprintf "%d", $baz), '14');
509   is((sprintf "%d", $ban), '13');
510   $baz = 0;
511   $baz = $foo++;
512   is((sprintf "%d", $foo), '15');
513   is((sprintf "%d", $baz), '14');
514   is("$foo", '[++ [+= [++ [++ [n 11] 1] 1] 1] 1]');
515 }
516
517 {
518   my $iter = new symbolic 2;
519   my $side = new symbolic 1;
520   my $cnt = $iter;
521   
522   while ($cnt) {
523     $cnt = $cnt - 1;            # The "simple" way
524     $side = (sqrt(1 + $side**2) - 1)/$side;
525   }
526   my $pi = $side*(2**($iter+2));
527   is("$side", '[/ [- [sqrt [+ 1 [** [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]] 2]]] 1] [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]]]');
528   is((sprintf "%f", $pi), '3.182598');
529 }
530
531 {
532   my $iter = new symbolic 2;
533   my $side = new symbolic 1;
534   my $cnt = $iter;
535   
536   while ($cnt--) {
537     $side = (sqrt(1 + $side**2) - 1)/$side;
538   }
539   my $pi = $side*(2**($iter+2));
540   is("$side", '[/ [- [sqrt [+ 1 [** [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]] 2]]] 1] [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]]]');
541   is((sprintf "%f", $pi), '3.182598');
542 }
543
544 {
545   my ($a, $b);
546   symbolic->vars($a, $b);
547   my $c = sqrt($a**2 + $b**2);
548   $a = 3; $b = 4;
549   is((sprintf "%d", $c), '5');
550   $a = 12; $b = 5;
551   is((sprintf "%d", $c), '13');
552 }
553
554 {
555   package symbolic1;            # Primitive symbolic calculator
556   # Mutator inc/dec
557   use overload nomethod => \&wrap, '""' => \&str, '0+' => \&num, '=' => \&cpy;
558
559   sub new { shift; bless ['n', @_] }
560   sub cpy {
561     my $self = shift;
562     bless [@$self], ref $self;
563   }
564   sub wrap {
565     my ($obj, $other, $inv, $meth) = @_;
566     if ($meth eq '++' or $meth eq '--') {
567       @$obj = ($meth, (bless [@$obj]), 1); # Avoid circular reference
568       return $obj;
569     }
570     ($obj, $other) = ($other, $obj) if $inv;
571     bless [$meth, $obj, $other];
572   }
573   sub str {
574     my ($meth, $a, $b) = @{+shift};
575     $a = 'u' unless defined $a;
576     if (defined $b) {
577       "[$meth $a $b]";
578     } else {
579       "[$meth $a]";
580     }
581   } 
582   my %subr = ( 'n' => sub {$_[0]} );
583   foreach my $op (split " ", $overload::ops{with_assign}) {
584     $subr{$op} = $subr{"$op="} = eval "sub {shift() $op shift()}";
585   }
586   my @bins = qw(binary 3way_comparison num_comparison str_comparison);
587   foreach my $op (split " ", "@overload::ops{ @bins }") {
588     $subr{$op} = eval "sub {shift() $op shift()}";
589   }
590   foreach my $op (split " ", "@overload::ops{qw(unary func)}") {
591     $subr{$op} = eval "sub {$op shift()}";
592   }
593   $subr{'++'} = $subr{'+'};
594   $subr{'--'} = $subr{'-'};
595   
596   sub num {
597     my ($meth, $a, $b) = @{+shift};
598     my $subr = $subr{$meth} 
599       or die "Do not know how to ($meth) in symbolic";
600     $a = $a->num if ref $a eq __PACKAGE__;
601     $b = $b->num if ref $b eq __PACKAGE__;
602     $subr->($a,$b);
603   }
604   sub TIESCALAR { my $pack = shift; $pack->new(@_) }
605   sub FETCH { shift }
606   sub vars { my $p = shift; tie($_, $p) foreach @_; }
607   sub STORE { 
608     my $obj = shift; 
609     $#$obj = 1; 
610     $obj->[1] = shift;
611   }
612 }
613
614 {
615   my $foo = new symbolic1 11;
616   my $baz = $foo++;
617   is((sprintf "%d", $foo), '12');
618   is((sprintf "%d", $baz), '11');
619   my $bar = $foo;
620   $baz = ++$foo;
621   is((sprintf "%d", $foo), '13');
622   is((sprintf "%d", $bar), '12');
623   is((sprintf "%d", $baz), '13');
624   my $ban = $foo;
625   $baz = ($foo += 1);
626   is((sprintf "%d", $foo), '14');
627   is((sprintf "%d", $bar), '12');
628   is((sprintf "%d", $baz), '14');
629   is((sprintf "%d", $ban), '13');
630   $baz = 0;
631   $baz = $foo++;
632   is((sprintf "%d", $foo), '15');
633   is((sprintf "%d", $baz), '14');
634   is("$foo", '[++ [+= [++ [++ [n 11] 1] 1] 1] 1]');
635 }
636
637 {
638   my $iter = new symbolic1 2;
639   my $side = new symbolic1 1;
640   my $cnt = $iter;
641   
642   while ($cnt) {
643     $cnt = $cnt - 1;            # The "simple" way
644     $side = (sqrt(1 + $side**2) - 1)/$side;
645   }
646   my $pi = $side*(2**($iter+2));
647   is("$side", '[/ [- [sqrt [+ 1 [** [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]] 2]]] 1] [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]]]');
648   is((sprintf "%f", $pi), '3.182598');
649 }
650
651 {
652   my $iter = new symbolic1 2;
653   my $side = new symbolic1 1;
654   my $cnt = $iter;
655   
656   while ($cnt--) {
657     $side = (sqrt(1 + $side**2) - 1)/$side;
658   }
659   my $pi = $side*(2**($iter+2));
660   is("$side", '[/ [- [sqrt [+ 1 [** [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]] 2]]] 1] [/ [- [sqrt [+ 1 [** [n 1] 2]]] 1] [n 1]]]');
661   is((sprintf "%f", $pi), '3.182598');
662 }
663
664 {
665   my ($a, $b);
666   symbolic1->vars($a, $b);
667   my $c = sqrt($a**2 + $b**2);
668   $a = 3; $b = 4;
669   is((sprintf "%d", $c), '5');
670   $a = 12; $b = 5;
671   is((sprintf "%d", $c), '13');
672 }
673
674 {
675   package two_face;             # Scalars with separate string and
676                                 # numeric values.
677   sub new { my $p = shift; bless [@_], $p }
678   use overload '""' => \&str, '0+' => \&num, fallback => 1;
679   sub num {shift->[1]}
680   sub str {shift->[0]}
681 }
682
683 {
684   my $seven = new two_face ("vii", 7);
685   is((sprintf "seven=$seven, seven=%d, eight=%d", $seven, $seven+1),
686         'seven=vii, seven=7, eight=8');
687   is(scalar ($seven =~ /i/), '1');
688 }
689
690 {
691   package sorting;
692   use overload 'cmp' => \&comp;
693   sub new { my ($p, $v) = @_; bless \$v, $p }
694   sub comp { my ($x,$y) = @_; ($$x * 3 % 10) <=> ($$y * 3 % 10) or $$x cmp $$y }
695 }
696 {
697   my @arr = map sorting->new($_), 0..12;
698   my @sorted1 = sort @arr;
699   my @sorted2 = map $$_, @sorted1;
700   is("@sorted2", '0 10 7 4 1 11 8 5 12 2 9 6 3');
701 }
702 {
703   package iterator;
704   use overload '<>' => \&iter;
705   sub new { my ($p, $v) = @_; bless \$v, $p }
706   sub iter { my ($x) = @_; return undef if $$x < 0; return $$x--; }
707 }
708
709 {
710   my $iter = iterator->new(5);
711   my $acc = '';
712   my $out;
713   $acc .= " $out" while $out = <${iter}>;
714   is($acc, ' 5 4 3 2 1 0');
715   $iter = iterator->new(5);
716   is(scalar <${iter}>, '5');
717   $acc = '';
718   $acc .= " $out" while $out = <$iter>;
719   is($acc, ' 4 3 2 1 0');
720 }
721 {
722   package deref;
723   use overload '%{}' => \&hderef, '&{}' => \&cderef, 
724     '*{}' => \&gderef, '${}' => \&sderef, '@{}' => \&aderef;
725   sub new { my ($p, $v) = @_; bless \$v, $p }
726   sub deref {
727     my ($self, $key) = (shift, shift);
728     my $class = ref $self;
729     bless $self, 'deref::dummy'; # Disable overloading of %{} 
730     my $out = $self->{$key};
731     bless $self, $class;        # Restore overloading
732     $out;
733   }
734   sub hderef {shift->deref('h')}
735   sub aderef {shift->deref('a')}
736   sub cderef {shift->deref('c')}
737   sub gderef {shift->deref('g')}
738   sub sderef {shift->deref('s')}
739 }
740 {
741   my $deref = bless { h => { foo => 5 , fake => 23 },
742                       c => sub {return shift() + 34},
743                       's' => \123,
744                       a => [11..13],
745                       g => \*srt,
746                     }, 'deref';
747   # Hash:
748   my @cont = sort %$deref;
749   if ("\t" eq "\011") { # ASCII
750       is("@cont", '23 5 fake foo');
751   } 
752   else {                # EBCDIC alpha-numeric sort order
753       is("@cont", 'fake foo 23 5');
754   }
755   my @keys = sort keys %$deref;
756   is("@keys", 'fake foo');
757   my @val = sort values %$deref;
758   is("@val", '23 5');
759   is($deref->{foo}, 5);
760   is(defined $deref->{bar}, '');
761   my $key;
762   @keys = ();
763   push @keys, $key while $key = each %$deref;
764   @keys = sort @keys;
765   is("@keys", 'fake foo');
766   is(exists $deref->{bar}, '');
767   is(exists $deref->{foo}, 1);
768   # Code:
769   is($deref->(5), 39);
770   is(&$deref(6), 40);
771   sub xxx_goto { goto &$deref }
772   is(xxx_goto(7), 41);
773   my $srt = bless { c => sub {$b <=> $a}
774                   }, 'deref';
775   *srt = \&$srt;
776   my @sorted = sort srt 11, 2, 5, 1, 22;
777   is("@sorted", '22 11 5 2 1');
778   # Scalar
779   is($$deref, 123);
780   # Code
781   @sorted = sort $srt 11, 2, 5, 1, 22;
782   is("@sorted", '22 11 5 2 1');
783   # Array
784   is("@$deref", '11 12 13');
785   is($#$deref, '2');
786   my $l = @$deref;
787   is($l, 3);
788   is($deref->[2], '13');
789   $l = pop @$deref;
790   is($l, 13);
791   $l = 1;
792   is($deref->[$l], '12');
793   # Repeated dereference
794   my $double = bless { h => $deref,
795                      }, 'deref';
796   is($double->{foo}, 5);
797 }
798
799 {
800   package two_refs;
801   use overload '%{}' => \&gethash, '@{}' => sub { ${shift()} };
802   sub new { 
803     my $p = shift; 
804     bless \ [@_], $p;
805   }
806   sub gethash {
807     my %h;
808     my $self = shift;
809     tie %h, ref $self, $self;
810     \%h;
811   }
812
813   sub TIEHASH { my $p = shift; bless \ shift, $p }
814   my %fields;
815   my $i = 0;
816   $fields{$_} = $i++ foreach qw{zero one two three};
817   sub STORE { 
818     my $self = ${shift()};
819     my $key = $fields{shift()};
820     defined $key or die "Out of band access";
821     $$self->[$key] = shift;
822   }
823   sub FETCH { 
824     my $self = ${shift()};
825     my $key = $fields{shift()};
826     defined $key or die "Out of band access";
827     $$self->[$key];
828   }
829 }
830
831 my $bar = new two_refs 3,4,5,6;
832 $bar->[2] = 11;
833 is($bar->{two}, 11);
834 $bar->{three} = 13;
835 is($bar->[3], 13);
836
837 {
838   package two_refs_o;
839   @ISA = ('two_refs');
840 }
841
842 $bar = new two_refs_o 3,4,5,6;
843 $bar->[2] = 11;
844 is($bar->{two}, 11);
845 $bar->{three} = 13;
846 is($bar->[3], 13);
847
848 {
849   package two_refs1;
850   use overload '%{}' => sub { ${shift()}->[1] },
851                '@{}' => sub { ${shift()}->[0] };
852   sub new { 
853     my $p = shift; 
854     my $a = [@_];
855     my %h;
856     tie %h, $p, $a;
857     bless \ [$a, \%h], $p;
858   }
859   sub gethash {
860     my %h;
861     my $self = shift;
862     tie %h, ref $self, $self;
863     \%h;
864   }
865
866   sub TIEHASH { my $p = shift; bless \ shift, $p }
867   my %fields;
868   my $i = 0;
869   $fields{$_} = $i++ foreach qw{zero one two three};
870   sub STORE { 
871     my $a = ${shift()};
872     my $key = $fields{shift()};
873     defined $key or die "Out of band access";
874     $a->[$key] = shift;
875   }
876   sub FETCH { 
877     my $a = ${shift()};
878     my $key = $fields{shift()};
879     defined $key or die "Out of band access";
880     $a->[$key];
881   }
882 }
883
884 $bar = new two_refs_o 3,4,5,6;
885 $bar->[2] = 11;
886 is($bar->{two}, 11);
887 $bar->{three} = 13;
888 is($bar->[3], 13);
889
890 {
891   package two_refs1_o;
892   @ISA = ('two_refs1');
893 }
894
895 $bar = new two_refs1_o 3,4,5,6;
896 $bar->[2] = 11;
897 is($bar->{two}, 11);
898 $bar->{three} = 13;
899 is($bar->[3], 13);
900
901 {
902   package B;
903   use overload bool => sub { ${+shift} };
904 }
905
906 my $aaa;
907 { my $bbbb = 0; $aaa = bless \$bbbb, B }
908
909 is !$aaa, 1;
910
911 unless ($aaa) {
912   pass();
913 } else {
914   fail();
915 }
916
917 # check that overload isn't done twice by join
918 { my $c = 0;
919   package Join;
920   use overload '""' => sub { $c++ };
921   my $x = join '', bless([]), 'pq', bless([]);
922   main::is $x, '0pq1';
923 };
924
925 # Test module-specific warning
926 {
927     # check the Odd number of arguments for overload::constant warning
928     my $a = "" ;
929     local $SIG{__WARN__} = sub {$a = $_[0]} ;
930     $x = eval ' overload::constant "integer" ; ' ;
931     is($a, "");
932     use warnings 'overload' ;
933     $x = eval ' overload::constant "integer" ; ' ;
934     like($a, qr/^Odd number of arguments for overload::constant at/);
935 }
936
937 {
938     # check the '$_[0]' is not an overloadable type warning
939     my $a = "" ;
940     local $SIG{__WARN__} = sub {$a = $_[0]} ;
941     $x = eval ' overload::constant "fred" => sub {} ; ' ;
942     is($a, "");
943     use warnings 'overload' ;
944     $x = eval ' overload::constant "fred" => sub {} ; ' ;
945     like($a, qr/^'fred' is not an overloadable type at/);
946 }
947
948 {
949     # check the '$_[1]' is not a code reference warning
950     my $a = "" ;
951     local $SIG{__WARN__} = sub {$a = $_[0]} ;
952     $x = eval ' overload::constant "integer" => 1; ' ;
953     is($a, "");
954     use warnings 'overload' ;
955     $x = eval ' overload::constant "integer" => 1; ' ;
956     like($a, qr/^'1' is not a code reference at/);
957 }
958
959 {
960     # check the invalid argument warning [perl #74098]
961     my $a = "" ;
962     local $SIG{__WARN__} = sub {$a = $_[0]} ;
963     $x = eval ' use overload "~|_|~" => sub{} ' ;
964     is($a, "");
965     use warnings 'overload' ;
966     $x = eval ' use overload "~|_|~" => sub{} ' ;
967     like($a, qr/^overload arg '~\|_\|~' is invalid at \(eval \d+\) line /,
968         'invalid arg warning');
969 }
970
971 {
972   my $c = 0;
973   package ov_int1;
974   use overload '""'    => sub { 3+shift->[0] },
975                '0+'    => sub { 10+shift->[0] },
976                'int'   => sub { 100+shift->[0] };
977   sub new {my $p = shift; bless [shift], $p}
978
979   package ov_int2;
980   use overload '""'    => sub { 5+shift->[0] },
981                '0+'    => sub { 30+shift->[0] },
982                'int'   => sub { 'ov_int1'->new(1000+shift->[0]) };
983   sub new {my $p = shift; bless [shift], $p}
984
985   package noov_int;
986   use overload '""'    => sub { 2+shift->[0] },
987                '0+'    => sub { 9+shift->[0] };
988   sub new {my $p = shift; bless [shift], $p}
989
990   package main;
991
992   my $x = new noov_int 11;
993   my $int_x = int $x;
994   main::is("$int_x", 20);
995   $x = new ov_int1 31;
996   $int_x = int $x;
997   main::is("$int_x", 131);
998   $x = new ov_int2 51;
999   $int_x = int $x;
1000   main::is("$int_x", 1054);
1001 }
1002
1003 # make sure that we don't infinitely recurse
1004 {
1005   my $c = 0;
1006   package Recurse;
1007   use overload '""'    => sub { shift },
1008                '0+'    => sub { shift },
1009                'bool'  => sub { shift },
1010                fallback => 1;
1011   my $x = bless([]);
1012   # For some reason beyond me these have to be oks rather than likes.
1013   main::ok("$x" =~ /Recurse=ARRAY/);
1014   main::ok($x);
1015   main::ok($x+0 =~ qr/Recurse=ARRAY/);
1016 }
1017
1018 # BugID 20010422.003
1019 package Foo;
1020
1021 use overload
1022   'bool' => sub { return !$_[0]->is_zero() || undef; }
1023 ;
1024  
1025 sub is_zero
1026   {
1027   my $self = shift;
1028   return $self->{var} == 0;
1029   }
1030
1031 sub new
1032   {
1033   my $class = shift;
1034   my $self =  {};
1035   $self->{var} = shift;
1036   bless $self,$class;
1037   }
1038
1039 package main;
1040
1041 use strict;
1042
1043 my $r = Foo->new(8);
1044 $r = Foo->new(0);
1045
1046 is(($r || 0), 0);
1047
1048 package utf8_o;
1049
1050 use overload 
1051   '""'  =>  sub { return $_[0]->{var}; }
1052   ;
1053   
1054 sub new
1055   {
1056     my $class = shift;
1057     my $self =  {};
1058     $self->{var} = shift;
1059     bless $self,$class;
1060   }
1061
1062 package main;
1063
1064
1065 my $utfvar = new utf8_o 200.2.1;
1066 is("$utfvar", 200.2.1); # 223 - stringify
1067 is("a$utfvar", "a".200.2.1); # 224 - overload via sv_2pv_flags
1068
1069 # 225..227 -- more %{} tests.  Hangs in 5.6.0, okay in later releases.
1070 # Basically this example implements strong encapsulation: if Hderef::import()
1071 # were to eval the overload code in the caller's namespace, the privatisation
1072 # would be quite transparent.
1073 package Hderef;
1074 use overload '%{}' => sub { (caller(0))[0] eq 'Foo' ? $_[0] : die "zap" };
1075 package Foo;
1076 @Foo::ISA = 'Hderef';
1077 sub new { bless {}, shift }
1078 sub xet { @_ == 2 ? $_[0]->{$_[1]} :
1079           @_ == 3 ? ($_[0]->{$_[1]} = $_[2]) : undef }
1080 package main;
1081 my $a = Foo->new;
1082 $a->xet('b', 42);
1083 is ($a->xet('b'), 42);
1084 ok (!defined eval { $a->{b} });
1085 like ($@, qr/zap/);
1086
1087 {
1088    package t229;
1089    use overload '='  => sub { 42 },
1090                 '++' => sub { my $x = ${$_[0]}; $_[0] };
1091    sub new { my $x = 42; bless \$x }
1092
1093    my $warn;
1094    {  
1095      local $SIG{__WARN__} = sub { $warn++ };
1096       my $x = t229->new;
1097       my $y = $x;
1098       eval { $y++ };
1099    }
1100    main::ok (!$warn);
1101 }
1102
1103 {
1104     my ($int, $out1, $out2);
1105     {
1106         BEGIN { $int = 0; overload::constant 'integer' => sub {$int++; 17}; }
1107         $out1 = 0;
1108         $out2 = 1;
1109     }
1110     is($int,  2,  "#24313");    # 230
1111     is($out1, 17, "#24313");    # 231
1112     is($out2, 17, "#24313");    # 232
1113 }
1114
1115 {
1116     package Numify;
1117     use overload (qw(0+ numify fallback 1));
1118
1119     sub new {
1120         my $val = $_[1];
1121         bless \$val, $_[0];
1122     }
1123
1124     sub numify { ${$_[0]} }
1125 }
1126
1127 {
1128     package perl31793;
1129     use overload cmp => sub { 0 };
1130     package perl31793_fb;
1131     use overload cmp => sub { 0 }, fallback => 1;
1132     package main;
1133     my $o  = bless [], 'perl31793';
1134     my $of = bless [], 'perl31793_fb';
1135     my $no = bless [], 'no_overload';
1136     like(overload::StrVal(\"scalar"), qr/^SCALAR\(0x[0-9a-f]+\)$/);
1137     like(overload::StrVal([]),        qr/^ARRAY\(0x[0-9a-f]+\)$/);
1138     like(overload::StrVal({}),        qr/^HASH\(0x[0-9a-f]+\)$/);
1139     like(overload::StrVal(sub{1}),    qr/^CODE\(0x[0-9a-f]+\)$/);
1140     like(overload::StrVal(\*GLOB),    qr/^GLOB\(0x[0-9a-f]+\)$/);
1141     like(overload::StrVal(\$o),       qr/^REF\(0x[0-9a-f]+\)$/);
1142     like(overload::StrVal(qr/a/),     qr/^Regexp=REGEXP\(0x[0-9a-f]+\)$/);
1143     like(overload::StrVal($o),        qr/^perl31793=ARRAY\(0x[0-9a-f]+\)$/);
1144     like(overload::StrVal($of),       qr/^perl31793_fb=ARRAY\(0x[0-9a-f]+\)$/);
1145     like(overload::StrVal($no),       qr/^no_overload=ARRAY\(0x[0-9a-f]+\)$/);
1146 }
1147
1148 # These are all check that overloaded values rather than reference addresses
1149 # are what is getting tested.
1150 my ($two, $one, $un, $deux) = map {new Numify $_} 2, 1, 1, 2;
1151 my ($ein, $zwei) = (1, 2);
1152
1153 my %map = (one => 1, un => 1, ein => 1, deux => 2, two => 2, zwei => 2);
1154 foreach my $op (qw(<=> == != < <= > >=)) {
1155     foreach my $l (keys %map) {
1156         foreach my $r (keys %map) {
1157             my $ocode = "\$$l $op \$$r";
1158             my $rcode = "$map{$l} $op $map{$r}";
1159
1160             my $got = eval $ocode;
1161             die if $@;
1162             my $expect = eval $rcode;
1163             die if $@;
1164             is ($got, $expect, $ocode) or print "# $rcode\n";
1165         }
1166     }
1167 }
1168 {
1169     # check that overloading works in regexes
1170     {
1171         package Foo493;
1172         use overload
1173             '""' => sub { "^$_[0][0]\$" },
1174             '.'  => sub { 
1175                     bless [
1176                              $_[2]
1177                             ? (ref $_[1] ? $_[1][0] : $_[1]) . ':' .$_[0][0] 
1178                             : $_[0][0] . ':' . (ref $_[1] ? $_[1][0] : $_[1])
1179                     ], 'Foo493'
1180                         };
1181     }
1182
1183     my $a = bless [ "a" ], 'Foo493';
1184     like('a', qr/$a/);
1185     like('x:a', qr/x$a/);
1186     like('x:a:=', qr/x$a=$/);
1187     like('x:a:a:=', qr/x$a$a=$/);
1188
1189 }
1190
1191 {
1192     {
1193         package QRonly;
1194         use overload qr => sub { qr/x/ }, fallback => 1;
1195     }
1196     {
1197         my $x = bless [], "QRonly";
1198
1199         # like tries to be too clever, and decides that $x-stringified
1200         # doesn't look like a regex
1201         ok("x" =~ $x, "qr-only matches");
1202         ok("y" !~ $x, "qr-only doesn't match what it shouldn't");
1203         ok("x" =~ /^(??{$x})$/, "qr-only with ?? matches");
1204         ok("y" !~ /^(??{$x})$/, "qr-only with ?? doesn't match what it shouldn't");
1205         ok("xx" =~ /x$x/, "qr-only matches with concat");
1206         like("$x", qr/^QRonly=ARRAY/, "qr-only doesn't have string overload");
1207
1208         my $qr = bless qr/y/, "QRonly";
1209         ok("x" =~ $qr, "qr with qr-overload uses overload");
1210         ok("y" !~ $qr, "qr with qr-overload uses overload");
1211         ok("x" =~ /^(??{$qr})$/, "qr with qr-overload with ?? uses overload");
1212         ok("y" !~ /^(??{$qr})$/, "qr with qr-overload with ?? uses overload");
1213         is("$qr", "".qr/y/, "qr with qr-overload stringify");
1214
1215         my $rx = $$qr;
1216         ok("y" =~ $rx, "bare rx with qr-overload doesn't overload match");
1217         ok("x" !~ $rx, "bare rx with qr-overload doesn't overload match");
1218         ok("y" =~ /^(??{$rx})$/, "bare rx with qr-overload with ?? doesn't overload match");
1219         ok("x" !~ /^(??{$rx})$/, "bare rx with qr-overload with ?? doesn't overload match");
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");
1229         ok("y" !~ $x, "qr+str uses qr for match");
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";
1250         ok("x" =~ $rx, "qr overload accepts a bare rx");
1251         ok("y" !~ $rx, "qr overload accepts a bare rx");
1252
1253         my $str = bless sub { "x" }, "QRany";
1254         ok(!eval { "x" =~ $str }, "qr overload doesn't accept a string");
1255         like($@, qr/^Overloaded qr did not return a REGEXP/, "correct error");
1256
1257         my $oqr = bless qr/z/, "QRandSTR";
1258         my $oqro = bless sub { $oqr }, "QRany";
1259         ok("z" =~ $oqro, "qr overload doesn't recurse");
1260
1261         my $qrs = bless qr/z/, "QRself";
1262         ok("z" =~ $qrs, "qr overload can return self");
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";
1273         ok("x" =~ $fb, "qr falls back to \"\"");
1274         ok("y" !~ $fb, "qr falls back to \"\"");
1275
1276         my $nofb = bless [], "STRonly";
1277         ok("x" =~ $nofb, "qr falls back even without fallback");
1278         ok("y" !~ $nofb, "qr falls back even without fallback");
1279     }
1280 }
1281
1282 {
1283     my $twenty_three = 23;
1284     # Check that constant overloading propagates into evals
1285     BEGIN { overload::constant integer => sub { 23 } }
1286     is(eval "17", $twenty_three);
1287 }
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;
1320     ok(eval {if ($obj) {1}; 1}, $@ || 'reblessed into nonexistent namespace');
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 }
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
1373 {
1374     use Scalar::Util 'weaken';
1375
1376     package Shklitza;
1377     use overload '""' => sub {"CLiK KLAK"};
1378
1379     package Ksshfwoom;
1380
1381     package main;
1382
1383     my ($obj, $ref);
1384     $obj = bless do {my $a; \$a}, 'Shklitza';
1385     $ref = $obj;
1386
1387     is ("$obj", "CLiK KLAK");
1388     is ("$ref", "CLiK KLAK");
1389
1390     weaken $ref;
1391     is ("$ref", "CLiK KLAK");
1392
1393     bless $obj, 'Ksshfwoom';
1394
1395     like ($obj, qr/^Ksshfwoom=/);
1396     like ($ref, qr/^Ksshfwoom=/);
1397
1398     undef $obj;
1399     is ($ref, undef);
1400 }
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 }
1434
1435 {
1436     # comparison operators with nomethod (bug 41546)
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 }
1481
1482 {
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 {
1498     # Subtle bug pre 5.10, as a side effect of the overloading flag being
1499     # stored on the reference rather than the referent. Despite the fact that
1500     # objects can only be accessed via references (even internally), the
1501     # referent actually knows that it's blessed, not the references. So taking
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 }
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' };
1546     package numify_by_fallback;
1547     use overload fallback => 1;
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 = [];
1555     my $num_val = int($aref);
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');
1564
1565     my $m = bless $aref, 'numify_by_fallback';
1566     is(int($m), $num_val, 'numifies to usual reference value');
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');
1574     is(int($m/1), $num_val, 'numifies to usual reference value');
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');
1585     is(int($aref/1), $num_val, 'division of ref');
1586     is($aref%100, $num_val%100, 'modulo of ref');
1587     is($aref**1, $num_val, 'exponentiation of ref');
1588 }
1589
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
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.
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.
1651
1652 {
1653
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
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
1696         # the code can't distinguish between something that's been copied:
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])
1705         # triggers one. However, tied aggregates have a mechanism to prevent
1706         # multiple fetches between STOREs, which means that the tied
1707         # hash skips doing a FETCH during '='.
1708
1709         for (qw(+ - * / % ** << >> & | ^)) {
1710             my $op = $_;
1711             $op = '%%' if $op eq '%';
1712             my $e = "%s $op= 3";
1713             $subs{"$_="} = $e;
1714             # ARRAY  FETCH: initial,        sub+=, eval-return,
1715             # SCALAR FETCH: initial, sub=,  sub+=, eval-return,
1716             # STORE:        copy, mutator
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) }";
1721             # ARRAY  FETCH: initial
1722             # SCALAR FETCH: initial eval-return,
1723             push @tests, [ 18, "%s $op 3", "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
1724             push @tests, [ 18, "3 $op %s", "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
1725         }
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
1737
1738             push @tests, [ 18, $e, "(=)($_=)", '("")',
1739                             [ 3, 4, 2,     2, 3, 1 ], 1 ];
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,
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 ];
1755         }
1756
1757         for (qw(++ --)) {
1758             my $pre  = "$_%s";
1759             my $post = "%s$_";
1760             $subs{$_} = $pre;
1761             push @tests,
1762                 # ARRAY  FETCH: initial,        sub+=, eval-return,
1763                 # SCALAR FETCH: initial, sub=,  sub+=, eval-return,
1764                 # STORE:        copy, mutator
1765                 [ 18, $pre, "(=)($_)(\"\")", "(=)(NM:$_)(\"\")", [ 3, 4, 2 ], 1 ],
1766                 # ARRAY  FETCH: initial,        sub+=
1767                 # SCALAR FETCH: initial, sub=,  sub+=
1768                 # STORE:        copy, mutator
1769                 [ 18, $post, "(=)($_)(\"\")", "(=)(NM:$_)(\"\")", [ 2, 3, 2 ], 1 ];
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
1776         for (qw(< <= >  >= == != lt le gt ge eq ne)) {
1777             my $e = "%s $_ 3";
1778             $subs{$_} = $e;
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 ];
1785         }
1786         for (qw(atan2)) {
1787             my $e = "$_ %s, 3";
1788             $subs{$_} = $e;
1789             push @tests, [ 18, $e, "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
1790         }
1791         for (qw(cos sin exp abs log sqrt int ~)) {
1792             my $e = "$_(%s)";
1793             $subs{$_} = $e;
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 ];
1801         }
1802         for (qw(-)) {
1803             my $e = "$_(%s)";
1804             $subs{neg} = $e;
1805             push @tests, [ 18, $e, '(neg)', '(NM:neg)', [ 1, 2, 0 ], 1 ];
1806         }
1807         my $e = '(%s) ? 1 : 0';
1808         $subs{bool} = $e;
1809         push @tests, [ 18, $e, '(bool)', '(0+)', [ 1, 2, 0 ], 0 ];
1810
1811         # note: this is testing unary qr, not binary =~
1812         $subs{qr} = '(qr/%s/)';
1813         push @tests, [ "abc", '"abc" =~ (%s)', '(qr)', '("")', [ 1, 2, 0 ], 0 ];
1814         push @tests, [ chr 256, 'chr(256) =~ (%s)', '(qr)', '("")',
1815                                                           [ 1, 2, 0 ], 0 ];
1816
1817         $e = '"abc" ~~ (%s)';
1818         $subs{'~~'} = $e;
1819         push @tests, [ "abc", $e, '(~~)', '(NM:~~)', [ 1, 1, 0 ], 0 ];
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;}';
1828         # Note - we don't care what these file tests return, as
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)) {
1832             push @tests, [ 'TEST', "-$_ (%s)", '(-X)', '("")', [ 1, 2, 0 ], 0 ];
1833         }
1834
1835         $subs{'${}'} = '%s';
1836         push @tests, [ do {my $s=99; \$s}, '${%s}', '(${})', undef, [ 1, 1, 0 ], 0 ];
1837
1838         # we skip testing '@{}' here because too much of this test
1839         # framework involves array dereferences!
1840
1841         $subs{'%{}'} = '%s';
1842         push @tests, [ {qw(a 1 b 2 c 3)}, 'join "", sort keys %%{%s}',
1843                         '(%{})', undef, [ 1, 1, 0 ], 0 ];
1844
1845         $subs{'&{}'} = '%s';
1846         push @tests, [ sub {99}, 'do {&{%s} for 1,2}',
1847                             '(&{})(&{})', undef, [ 2, 2, 0 ], 0 ];
1848
1849         our $RT57012A = 88;
1850         our $RT57012B;
1851         $subs{'*{}'} = '%s';
1852         push @tests, [ \*RT57012A, '*RT57012B = *{%s}; our $RT57012B',
1853                 '(*{})', undef, [ 1, 1, 0 ], 0 ];
1854
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 ];
1860
1861         # eval should do tie, overload on its arg before checking taint */
1862         push @tests, [ '1;', 'eval q(eval %s); $@ =~ /Insecure/',
1863                 '("")', '("")', [ 1, 2, 0 ], 0 ];
1864
1865
1866         for my $sub (keys %subs) {
1867             my $term = $subs{$sub};
1868             my $t = sprintf $term, '$_[0][0]';
1869             my $e ="sub { \$funcs .= '($sub)'; my \$r; if (\$use_int) {"
1870                 . "use integer; \$r = ($t) } else { \$r = ($t) } \$r }";
1871             $subs{$sub} = eval $e;
1872             die "Compiling sub gave error:\n<$e>\n<$@>\n" if $@;
1873         }
1874     }
1875
1876     my $fetches;
1877     my $stores;
1878
1879     package RT57012_OV;
1880
1881     use overload
1882         %subs,
1883         "="   => sub { $funcs .= '(=)';  bless [ $_[0][0] ] },
1884         '0+'  => sub { $funcs .= '(0+)'; 0 + $_[0][0] },
1885         '""'  => sub { $funcs .= '("")'; "$_[0][0]"   },
1886         ;
1887
1888     package RT57012_OV_FB; # only contains fallback conversion functions
1889
1890     use overload
1891         "="   => sub { $funcs .= '(=)';  bless [ $_[0][0] ] },
1892         '0+'  => sub { $funcs .= '(0+)'; 0 + $_[0][0] },
1893         '""'  => sub { $funcs .= '("")'; "$_[0][0]"   },
1894         "nomethod" => sub {
1895                         $funcs .= "(NM:$_[3])";
1896                         my $e = defined($_[1])
1897                                 ? $_[3] eq 'atan2'
1898                                     ? $_[2]
1899                                        ? "atan2(\$_[1],\$_[0][0])"
1900                                        : "atan2(\$_[0][0],\$_[1])"
1901                                     : $_[2]
1902                                         ? "\$_[1] $_[3] \$_[0][0]"
1903                                         : "\$_[0][0] $_[3] \$_[1]"
1904                                 : $_[3] eq 'neg'
1905                                     ? "-\$_[0][0]"
1906                                     : "$_[3](\$_[0][0])";
1907                         my $r;
1908                         if ($use_int) {
1909                             use integer; $r = eval $e;
1910                         }
1911                         else {
1912                             $r = eval $e;
1913                         }
1914                         ::diag("eval of nomethod <$e> gave <$@>") if $@;
1915                         $r;
1916                     }
1917
1918         ;
1919
1920     package RT57012_TIE_S;
1921
1922     my $tie_val;
1923     sub TIESCALAR { bless [ bless [ $tie_val ], $_[1] ] }
1924     sub FETCH     { $fetches++; $_[0][0] }
1925     sub STORE     { $stores++;  $_[0][0] = $_[1] }
1926
1927     package RT57012_TIE_A;
1928
1929     sub TIEARRAY  { bless [] }
1930     sub FETCH     { $fetches++; $_[0][0] }
1931     sub STORE     { $stores++;  $_[0][$_[1]] = $_[2] }
1932
1933     package main;
1934
1935     for my $test (@tests) {
1936         my ($val, $sub_term, $exp_funcs, $exp_fb_funcs,
1937             $exp_counts, $exp_taint) = @$test;
1938
1939         my $tainted_val;
1940         {
1941             # create tainted version of $val (unless its a ref)
1942             my $t = substr($^X,0,0);
1943             my $t0 = $t."0";
1944             my $val1 = $val; # use a copy to avoid stringifying original
1945             $tainted_val = ref($val1) ? $val :
1946                         ($val1 =~ /^[\d\.]+$/) ? $val+$t0 : $val.$t;
1947         }
1948         $tie_val = $tainted_val;
1949
1950         for my $int ('', 'use integer; ') {
1951             $use_int = ($int ne '');
1952             my $plain = $tainted_val;
1953             my $plain_term = $int . sprintf $sub_term, '$plain';
1954             my $exp = eval $plain_term;
1955             diag("eval of plain_term <$plain_term> gave <$@>") if $@;
1956             is(tainted($exp), $exp_taint,
1957                         "<$plain_term> taint of expected return");
1958
1959             for my $ov_pkg (qw(RT57012_OV RT57012_OV_FB)) {
1960                 next if $ov_pkg eq 'RT57012_OV_FB'
1961                         and  not defined $exp_fb_funcs;
1962                 my ($exp_fetch_a, $exp_fetch_s, $exp_store) =
1963                     ($ov_pkg eq 'RT57012_OV' || @$exp_counts < 4)
1964                         ? @$exp_counts[0,1,2]
1965                         : @$exp_counts[3,4,5];
1966
1967                 tie my $ts, 'RT57012_TIE_S', $ov_pkg;
1968                 tie my @ta, 'RT57012_TIE_A';
1969                 $ta[0]    = bless [ $tainted_val ], $ov_pkg;
1970                 my $oload = bless [ $tainted_val ], $ov_pkg;
1971
1972                 for my $var ('$ta[0]', '$ts', '$oload',
1973                             ($sub_term eq '<%s>' ? '${ts}' : ())
1974                 ) {
1975
1976                     $funcs = '';
1977                     $fetches = 0;
1978                     $stores = 0;
1979
1980                     my $res_term  = $int . sprintf $sub_term, $var;
1981                     my $desc =  "<$res_term> $ov_pkg" ;
1982                     my $res = eval $res_term;
1983                     diag("eval of res_term $desc gave <$@>") if $@;
1984                     # uniquely, the inc/dec ops return the original
1985                     # ref rather than a copy, so stringify it to
1986                     # find out if its tainted
1987                     $res = "$res" if $res_term =~ /\+\+|--/;
1988                     is(tainted($res), $exp_taint,
1989                             "$desc taint of result return");
1990                     is($res, $exp, "$desc return value");
1991                     my $fns =($ov_pkg eq 'RT57012_OV_FB')
1992                                 ? $exp_fb_funcs : $exp_funcs;
1993                     if ($var eq '$oload' && $res_term !~ /oload(\+\+|--)/) {
1994                         # non-tied overloading doesn't trigger a copy
1995                         # except for post inc/dec
1996                         $fns =~ s/^\(=\)//;
1997                     }
1998                     is($funcs, $fns, "$desc methods called");
1999                     next if $var eq '$oload';
2000                     my $exp_fetch = ($var eq '$ts') ?
2001                             $exp_fetch_s : $exp_fetch_a;
2002                     is($fetches, $exp_fetch, "$desc FETCH count");
2003                     is($stores, $exp_store, "$desc STORE count");
2004
2005                 }
2006
2007             }
2008         }
2009     }
2010 }
2011
2012 # Test overload from the main package
2013 fresh_perl_is
2014  '$^W = 1; use overload q\""\ => sub {"ning"}; print bless []',
2015  'ning',
2016   { switches => ['-wl'], stderr => 1 },
2017  'use overload from the main package'
2018 ;
2019
2020 {
2021     package blessed_methods;
2022     use overload '+' => sub {};
2023     bless overload::Method __PACKAGE__,'+';
2024     eval { overload::Method __PACKAGE__,'+' };
2025     ::is($@, '', 'overload::Method and blessed overload methods');
2026 }
2027
2028 {
2029     # fallback to 'cmp' and '<=>' with heterogeneous operands
2030     # [perl #71286]
2031     my $not_found = 'no method found';
2032     my $used = 0;
2033     package CmpBase;
2034     sub new {
2035         my $n = $_[1] || 0;
2036         bless \$n, ref $_[0] || $_[0];
2037     }
2038     sub cmp {
2039         $used = \$_[0];
2040         (${$_[0]} <=> ${$_[1]}) * ($_[2] ? -1 : 1);
2041     }
2042
2043     package NCmp;
2044     use base 'CmpBase';
2045     use overload '<=>' => 'cmp';
2046
2047     package SCmp;
2048     use base 'CmpBase';
2049     use overload 'cmp' => 'cmp';
2050
2051     package main;
2052     my $n = NCmp->new(5);
2053     my $s = SCmp->new(3);
2054     my $res;
2055
2056     eval { $res = $n > $s; };
2057     $res = $not_found if $@ =~ /$not_found/;
2058     is($res, 1, 'A>B using A<=> when B overloaded, no B<=>');
2059
2060     eval { $res = $s < $n; };
2061     $res = $not_found if $@ =~ /$not_found/;
2062     is($res, 1, 'A<B using B<=> when A overloaded, no A<=>');
2063
2064     eval { $res = $s lt $n; };
2065     $res = $not_found if $@ =~ /$not_found/;
2066     is($res, 1, 'A lt B using A:cmp when B overloaded, no B:cmp');
2067
2068     eval { $res = $n gt $s; };
2069     $res = $not_found if $@ =~ /$not_found/;
2070     is($res, 1, 'A gt B using B:cmp when A overloaded, no A:cmp');
2071
2072     my $o = NCmp->new(9);
2073     $res = $n < $o;
2074     is($used, \$n, 'A < B uses <=> from A in preference to B');
2075
2076     my $t = SCmp->new(7);
2077     $res = $s lt $t;
2078     is($used, \$s, 'A lt B uses cmp from A in preference to B');
2079 }
2080
2081 {
2082     # Combinatorial testing of 'fallback' and 'nomethod'
2083     # [perl #71286]
2084     package NuMB;
2085     use overload '0+' => sub { ${$_[0]}; },
2086         '""' => 'str';
2087     sub new {
2088         my $self = shift;
2089         my $n = @_ ? shift : 0;
2090         bless my $obj = \$n, ref $self || $self;
2091     }
2092     sub str {
2093         no strict qw/refs/;
2094         my $s = "(${$_[0]} ";
2095         $s .= "nomethod, " if defined ${ref($_[0]).'::(nomethod'};
2096         my $fb = ${ref($_[0]).'::()'};
2097         $s .= "fb=" . (defined $fb ? 0 + $fb : 'undef') . ")";
2098     }
2099     sub nomethod { "${$_[0]}.nomethod"; }
2100
2101     # create classes for tests
2102     package main;
2103     my @falls = (0, 'undef', 1);
2104     my @nomethods = ('', 'nomethod');
2105     my $not_found = 'no method found';
2106     for my $fall (@falls) {
2107         for my $nomethod (@nomethods) {
2108             my $nomethod_decl = $nomethod
2109                 ? $nomethod . "=>'nomethod'," : '';
2110             eval qq{
2111                     package NuMB$fall$nomethod;
2112                     use base qw/NuMB/;
2113                     use overload $nomethod_decl
2114                     fallback => $fall;
2115                 };
2116         }
2117     }
2118
2119     # operation and precedence of 'fallback' and 'nomethod'
2120     # for all combinations with 2 overloaded operands
2121     for my $nomethod2 (@nomethods) {
2122         for my $nomethod1 (@nomethods) {
2123             for my $fall2 (@falls) {
2124                 my $pack2 = "NuMB$fall2$nomethod2";
2125                 for my $fall1 (@falls) {
2126                     my $pack1 = "NuMB$fall1$nomethod1";
2127                     my ($test, $out, $exp);
2128                     eval qq{
2129                             my \$x = $pack1->new(2);
2130                             my \$y = $pack2->new(3);
2131                             \$test = "\$x" . ' * ' . "\$y";
2132                             \$out = \$x * \$y;
2133                         };
2134                     $out = $not_found if $@ =~ /$not_found/;
2135                     $exp = $nomethod1 ? '2.nomethod' :
2136                          $nomethod2 ? '3.nomethod' :
2137                          $fall1 eq '1' && $fall2 eq '1' ? 6
2138                          : $not_found;
2139                     is($out, $exp, "$test --> $exp");
2140                 }
2141             }
2142         }
2143     }
2144
2145     # operation of 'fallback' and 'nomethod'
2146     # where the other operand is not overloaded
2147     for my $nomethod (@nomethods) {
2148         for my $fall (@falls) {
2149             my ($test, $out, $exp);
2150             eval qq{
2151                     my \$x = NuMB$fall$nomethod->new(2);
2152                     \$test = "\$x" . ' * 3';
2153                     \$out = \$x * 3;
2154                 };
2155             $out = $not_found if $@ =~ /$not_found/;
2156             $exp = $nomethod ? '2.nomethod' :
2157                 $fall eq '1' ? 6
2158                 : $not_found;
2159             is($out, $exp, "$test --> $exp");
2160
2161             eval qq{
2162                     my \$x = NuMB$fall$nomethod->new(2);
2163                     \$test = '3 * ' . "\$x";
2164                     \$out = 3 * \$x;
2165                 };
2166             $out = $not_found if $@ =~ /$not_found/;
2167             is($out, $exp, "$test --> $exp");
2168         }
2169     }
2170 }
2171
2172 # since 5.6 overloaded <> was leaving an extra arg on the stack!
2173
2174 {
2175     package Iter1;
2176     use overload '<>' => sub { 11 };
2177     package main;
2178     my $a = bless [], 'Iter1';
2179     my $x;
2180     my @a = (10, ($x = <$a>), 12);
2181     is ($a[0], 10, 'Iter1: a[0]');
2182     is ($a[1], 11, 'Iter1: a[1]');
2183     is ($a[2], 12, 'Iter1: a[2]');
2184     @a = (10, ($x .= <$a>), 12);
2185     is ($a[0],   10, 'Iter1: a[0] concat');
2186     is ($a[1], 1111, 'Iter1: a[1] concat');
2187     is ($a[2],   12, 'Iter1: a[2] concat');
2188 }
2189
2190 # Some tests for error messages
2191 {
2192     package Justus;
2193     use overload '+' => 'justice';
2194     eval {bless[]};
2195     ::like $@, qr/^Can't resolve method "justice" overloading "\+" in p(?x:
2196                   )ackage "Justus" at /,
2197       'Error message when explicitly named overload method does not exist';
2198
2199     package JustUs;
2200     our @ISA = 'JustYou';
2201     package JustYou { use overload '+' => 'injustice'; }
2202     "JustUs"->${\"(+"};
2203     eval {bless []};
2204     ::like $@, qr/^Stub found while resolving method "\?{3}" overloadin(?x:
2205                   )g "\+" in package "JustUs" at /,
2206       'Error message when sub stub is encountered';
2207 }
2208
2209 {
2210     # check that the right number of stringifications
2211     # and the correct un-utf8-ifying happen on regex compile
2212     package utf8_match;
2213     my $c;
2214     use overload '""' => sub { $c++; $_[0][0] ? "^\x{100}\$" : "^A\$"; };
2215     my $o = bless [0], 'utf8_match';
2216
2217     $o->[0] = 0;
2218     $c = 0;
2219     ::ok("A" =~  "^A\$",        "regex stringify utf8=0 ol=0 bytes=0");
2220     ::ok("A" =~ $o,             "regex stringify utf8=0 ol=1 bytes=0");
2221     ::is($c, 1,                 "regex stringify utf8=0 ol=1 bytes=0 count");
2222
2223     $o->[0] = 1;
2224     $c = 0;
2225     ::ok("\x{100}" =~ "^\x{100}\$",
2226                                 "regex stringify utf8=1 ol=0 bytes=0");
2227     ::ok("\x{100}" =~ $o,       "regex stringify utf8=1 ol=1 bytes=0");
2228     ::is($c, 1,                 "regex stringify utf8=1 ol=1 bytes=0 count");
2229
2230     use bytes;
2231
2232     $o->[0] = 0;
2233     $c = 0;
2234     ::ok("A" =~  "^A\$",        "regex stringify utf8=0 ol=0 bytes=1");
2235     ::ok("A" =~ $o,             "regex stringify utf8=0 ol=1 bytes=1");
2236     ::is($c, 1,                 "regex stringify utf8=0 ol=1 bytes=1 count");
2237
2238     $o->[0] = 1;
2239     $c = 0;
2240     ::ok("\xc4\x80" =~ "^\x{100}\$",
2241                                 "regex stringify utf8=1 ol=0 bytes=1");
2242     ::ok("\xc4\x80" =~ $o,      "regex stringify utf8=1 ol=1 bytes=1");
2243     ::is($c, 1,                 "regex stringify utf8=1 ol=1 bytes=1 count");
2244
2245
2246 }
2247
2248 { # undefining the overload stash -- KEEP THIS TEST LAST
2249     package ant;
2250     use overload '+' => 'onion';
2251     $_ = \&overload::nil;
2252     undef %overload::;
2253     bless[];
2254     ::ok(1, 'no crash when undefining %overload::');
2255 }
2256
2257 # [perl #40333]
2258 # overload::Overloaded should not use a ->can designed for autoloading.
2259 # This example attempts to be as realistic as possible.  The o class has a
2260 # default singleton object, but can have instances, too.  The proxy class
2261 # represents proxies for o objects, but class methods delegate to the
2262 # singleton.
2263 # overload::Overloaded used to return incorrect results for proxy objects.
2264 package proxy {
2265     sub new { bless [$_[1]], $_[0] }
2266     sub AUTOLOAD {
2267        our $AUTOLOAD =~ s/.*:://;
2268        &_self->$AUTOLOAD;
2269     }
2270     sub can      { SUPER::can{@_} || &_self->can($_[1]) }
2271     sub _self { ref $_[0] ? $_[0][0] : $o::singleton }
2272 }
2273 package o     { use overload '""' => sub { 'keck' };
2274                 sub new { bless[], $_[0] }
2275                 our $singleton = o->new; }
2276 ok !overload::Overloaded(new proxy new o),
2277  'overload::Overloaded does not incorrectly return true for proxy classes';
2278
2279 # Another test, based on the type of explosive test class for which
2280 # perl #40333 was filed.
2281 {
2282     package broken_can;
2283     sub can {}
2284     use overload '""' => sub {"Ahoy!"};
2285
2286     package main;
2287     my $obj = bless [], 'broken_can';
2288     ok(overload::Overloaded($obj));
2289 }
2290
2291
2292 # EOF