This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix =~ $str_overloaded (5.10 regression)
[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 => 5037;
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   my $c = 0;
961   package ov_int1;
962   use overload '""'    => sub { 3+shift->[0] },
963                '0+'    => sub { 10+shift->[0] },
964                'int'   => sub { 100+shift->[0] };
965   sub new {my $p = shift; bless [shift], $p}
966
967   package ov_int2;
968   use overload '""'    => sub { 5+shift->[0] },
969                '0+'    => sub { 30+shift->[0] },
970                'int'   => sub { 'ov_int1'->new(1000+shift->[0]) };
971   sub new {my $p = shift; bless [shift], $p}
972
973   package noov_int;
974   use overload '""'    => sub { 2+shift->[0] },
975                '0+'    => sub { 9+shift->[0] };
976   sub new {my $p = shift; bless [shift], $p}
977
978   package main;
979
980   my $x = new noov_int 11;
981   my $int_x = int $x;
982   main::is("$int_x", 20);
983   $x = new ov_int1 31;
984   $int_x = int $x;
985   main::is("$int_x", 131);
986   $x = new ov_int2 51;
987   $int_x = int $x;
988   main::is("$int_x", 1054);
989 }
990
991 # make sure that we don't infinitely recurse
992 {
993   my $c = 0;
994   package Recurse;
995   use overload '""'    => sub { shift },
996                '0+'    => sub { shift },
997                'bool'  => sub { shift },
998                fallback => 1;
999   my $x = bless([]);
1000   # For some reason beyond me these have to be oks rather than likes.
1001   main::ok("$x" =~ /Recurse=ARRAY/);
1002   main::ok($x);
1003   main::ok($x+0 =~ qr/Recurse=ARRAY/);
1004 }
1005
1006 # BugID 20010422.003
1007 package Foo;
1008
1009 use overload
1010   'bool' => sub { return !$_[0]->is_zero() || undef; }
1011 ;
1012  
1013 sub is_zero
1014   {
1015   my $self = shift;
1016   return $self->{var} == 0;
1017   }
1018
1019 sub new
1020   {
1021   my $class = shift;
1022   my $self =  {};
1023   $self->{var} = shift;
1024   bless $self,$class;
1025   }
1026
1027 package main;
1028
1029 use strict;
1030
1031 my $r = Foo->new(8);
1032 $r = Foo->new(0);
1033
1034 is(($r || 0), 0);
1035
1036 package utf8_o;
1037
1038 use overload 
1039   '""'  =>  sub { return $_[0]->{var}; }
1040   ;
1041   
1042 sub new
1043   {
1044     my $class = shift;
1045     my $self =  {};
1046     $self->{var} = shift;
1047     bless $self,$class;
1048   }
1049
1050 package main;
1051
1052
1053 my $utfvar = new utf8_o 200.2.1;
1054 is("$utfvar", 200.2.1); # 223 - stringify
1055 is("a$utfvar", "a".200.2.1); # 224 - overload via sv_2pv_flags
1056
1057 # 225..227 -- more %{} tests.  Hangs in 5.6.0, okay in later releases.
1058 # Basically this example implements strong encapsulation: if Hderef::import()
1059 # were to eval the overload code in the caller's namespace, the privatisation
1060 # would be quite transparent.
1061 package Hderef;
1062 use overload '%{}' => sub { (caller(0))[0] eq 'Foo' ? $_[0] : die "zap" };
1063 package Foo;
1064 @Foo::ISA = 'Hderef';
1065 sub new { bless {}, shift }
1066 sub xet { @_ == 2 ? $_[0]->{$_[1]} :
1067           @_ == 3 ? ($_[0]->{$_[1]} = $_[2]) : undef }
1068 package main;
1069 my $a = Foo->new;
1070 $a->xet('b', 42);
1071 is ($a->xet('b'), 42);
1072 ok (!defined eval { $a->{b} });
1073 like ($@, qr/zap/);
1074
1075 {
1076    package t229;
1077    use overload '='  => sub { 42 },
1078                 '++' => sub { my $x = ${$_[0]}; $_[0] };
1079    sub new { my $x = 42; bless \$x }
1080
1081    my $warn;
1082    {  
1083      local $SIG{__WARN__} = sub { $warn++ };
1084       my $x = t229->new;
1085       my $y = $x;
1086       eval { $y++ };
1087    }
1088    main::ok (!$warn);
1089 }
1090
1091 {
1092     my ($int, $out1, $out2);
1093     {
1094         BEGIN { $int = 0; overload::constant 'integer' => sub {$int++; 17}; }
1095         $out1 = 0;
1096         $out2 = 1;
1097     }
1098     is($int,  2,  "#24313");    # 230
1099     is($out1, 17, "#24313");    # 231
1100     is($out2, 17, "#24313");    # 232
1101 }
1102
1103 {
1104     package Numify;
1105     use overload (qw(0+ numify fallback 1));
1106
1107     sub new {
1108         my $val = $_[1];
1109         bless \$val, $_[0];
1110     }
1111
1112     sub numify { ${$_[0]} }
1113 }
1114
1115 {
1116     package perl31793;
1117     use overload cmp => sub { 0 };
1118     package perl31793_fb;
1119     use overload cmp => sub { 0 }, fallback => 1;
1120     package main;
1121     my $o  = bless [], 'perl31793';
1122     my $of = bless [], 'perl31793_fb';
1123     my $no = bless [], 'no_overload';
1124     like(overload::StrVal(\"scalar"), qr/^SCALAR\(0x[0-9a-f]+\)$/);
1125     like(overload::StrVal([]),        qr/^ARRAY\(0x[0-9a-f]+\)$/);
1126     like(overload::StrVal({}),        qr/^HASH\(0x[0-9a-f]+\)$/);
1127     like(overload::StrVal(sub{1}),    qr/^CODE\(0x[0-9a-f]+\)$/);
1128     like(overload::StrVal(\*GLOB),    qr/^GLOB\(0x[0-9a-f]+\)$/);
1129     like(overload::StrVal(\$o),       qr/^REF\(0x[0-9a-f]+\)$/);
1130     like(overload::StrVal(qr/a/),     qr/^Regexp=REGEXP\(0x[0-9a-f]+\)$/);
1131     like(overload::StrVal($o),        qr/^perl31793=ARRAY\(0x[0-9a-f]+\)$/);
1132     like(overload::StrVal($of),       qr/^perl31793_fb=ARRAY\(0x[0-9a-f]+\)$/);
1133     like(overload::StrVal($no),       qr/^no_overload=ARRAY\(0x[0-9a-f]+\)$/);
1134 }
1135
1136 # These are all check that overloaded values rather than reference addresses
1137 # are what is getting tested.
1138 my ($two, $one, $un, $deux) = map {new Numify $_} 2, 1, 1, 2;
1139 my ($ein, $zwei) = (1, 2);
1140
1141 my %map = (one => 1, un => 1, ein => 1, deux => 2, two => 2, zwei => 2);
1142 foreach my $op (qw(<=> == != < <= > >=)) {
1143     foreach my $l (keys %map) {
1144         foreach my $r (keys %map) {
1145             my $ocode = "\$$l $op \$$r";
1146             my $rcode = "$map{$l} $op $map{$r}";
1147
1148             my $got = eval $ocode;
1149             die if $@;
1150             my $expect = eval $rcode;
1151             die if $@;
1152             is ($got, $expect, $ocode) or print "# $rcode\n";
1153         }
1154     }
1155 }
1156 {
1157     # check that overloading works in regexes
1158     {
1159         package Foo493;
1160         use overload
1161             '""' => sub { "^$_[0][0]\$" },
1162             '.'  => sub { 
1163                     bless [
1164                              $_[2]
1165                             ? (ref $_[1] ? $_[1][0] : $_[1]) . ':' .$_[0][0] 
1166                             : $_[0][0] . ':' . (ref $_[1] ? $_[1][0] : $_[1])
1167                     ], 'Foo493'
1168                         };
1169     }
1170
1171     my $a = bless [ "a" ], 'Foo493';
1172     like('a', qr/$a/);
1173     like('x:a', qr/x$a/);
1174     like('x:a:=', qr/x$a=$/);
1175     like('x:a:a:=', qr/x$a$a=$/);
1176
1177 }
1178
1179 {
1180     {
1181         package QRonly;
1182         use overload qr => sub { qr/x/ }, fallback => 1;
1183     }
1184     {
1185         my $x = bless [], "QRonly";
1186
1187         # like tries to be too clever, and decides that $x-stringified
1188         # doesn't look like a regex
1189         ok("x" =~ $x, "qr-only matches");
1190         ok("y" !~ $x, "qr-only doesn't match what it shouldn't");
1191         ok("xx" =~ /x$x/, "qr-only matches with concat");
1192         like("$x", qr/^QRonly=ARRAY/, "qr-only doesn't have string overload");
1193
1194         my $qr = bless qr/y/, "QRonly";
1195         ok("x" =~ $qr, "qr with qr-overload uses overload");
1196         ok("y" !~ $qr, "qr with qr-overload uses overload");
1197         is("$qr", "".qr/y/, "qr with qr-overload stringify");
1198
1199         my $rx = $$qr;
1200         ok("y" =~ $rx, "bare rx with qr-overload doesn't overload match");
1201         ok("x" !~ $rx, "bare rx with qr-overload doesn't overload match");
1202         is("$rx", "".qr/y/, "bare rx with qr-overload stringify");
1203     }
1204     {
1205         package QRandSTR;
1206         use overload qr => sub { qr/x/ }, q/""/ => sub { "y" };
1207     }
1208     {
1209         my $x = bless [], "QRandSTR";
1210         ok("x" =~ $x, "qr+str uses qr for match");
1211         ok("y" !~ $x, "qr+str uses qr for match");
1212         ok("xx" =~ /x$x/, "qr+str uses qr for match with concat");
1213         is("$x", "y", "qr+str uses str for stringify");
1214
1215         my $qr = bless qr/z/, "QRandSTR";
1216         is("$qr", "y", "qr with qr+str uses str for stringify");
1217         ok("xx" =~ /x$x/, "qr with qr+str uses qr for match");
1218
1219         my $rx = $$qr;
1220         ok("z" =~ $rx, "bare rx with qr+str doesn't overload match");
1221         is("$rx", "".qr/z/, "bare rx with qr+str doesn't overload stringify");
1222     }
1223     {
1224         package QRany;
1225         use overload qr => sub { $_[0]->(@_) };
1226
1227         package QRself;
1228         use overload qr => sub { $_[0] };
1229     }
1230     {
1231         my $rx = bless sub { ${ qr/x/ } }, "QRany";
1232         ok("x" =~ $rx, "qr overload accepts a bare rx");
1233         ok("y" !~ $rx, "qr overload accepts a bare rx");
1234
1235         my $str = bless sub { "x" }, "QRany";
1236         ok(!eval { "x" =~ $str }, "qr overload doesn't accept a string");
1237         like($@, qr/^Overloaded qr did not return a REGEXP/, "correct error");
1238
1239         my $oqr = bless qr/z/, "QRandSTR";
1240         my $oqro = bless sub { $oqr }, "QRany";
1241         ok("z" =~ $oqro, "qr overload doesn't recurse");
1242
1243         my $qrs = bless qr/z/, "QRself";
1244         ok("z" =~ $qrs, "qr overload can return self");
1245     }
1246     {
1247         package STRonly;
1248         use overload q/""/ => sub { "x" };
1249
1250         package STRonlyFB;
1251         use overload q/""/ => sub { "x" }, fallback => 1;
1252     }
1253     {
1254         my $fb = bless [], "STRonlyFB";
1255         ok("x" =~ $fb, "qr falls back to \"\"");
1256         ok("y" !~ $fb, "qr falls back to \"\"");
1257
1258         my $nofb = bless [], "STRonly";
1259         ok("x" =~ $nofb, "qr falls back even without fallback");
1260         ok("y" !~ $nofb, "qr falls back even without fallback");
1261     }
1262 }
1263
1264 {
1265     my $twenty_three = 23;
1266     # Check that constant overloading propagates into evals
1267     BEGIN { overload::constant integer => sub { 23 } }
1268     is(eval "17", $twenty_three);
1269 }
1270
1271 {
1272     package Sklorsh;
1273     use overload
1274         bool     => sub { shift->is_cool };
1275
1276     sub is_cool {
1277         $_[0]->{name} eq 'cool';
1278     }
1279
1280     sub delete {
1281         undef %{$_[0]};
1282         bless $_[0], 'Brap';
1283         return 1;
1284     }
1285
1286     sub delete_with_self {
1287         my $self = shift;
1288         undef %$self;
1289         bless $self, 'Brap';
1290         return 1;
1291     }
1292
1293     package Brap;
1294
1295     1;
1296
1297     package main;
1298
1299     my $obj;
1300     $obj = bless {name => 'cool'}, 'Sklorsh';
1301     $obj->delete;
1302     ok(eval {if ($obj) {1}; 1}, $@ || 'reblessed into nonexistent namespace');
1303
1304     $obj = bless {name => 'cool'}, 'Sklorsh';
1305     $obj->delete_with_self;
1306     ok (eval {if ($obj) {1}; 1}, $@);
1307     
1308     my $a = $b = {name => 'hot'};
1309     bless $b, 'Sklorsh';
1310     is(ref $a, 'Sklorsh');
1311     is(ref $b, 'Sklorsh');
1312     ok(!$b, "Expect overloaded boolean");
1313     ok(!$a, "Expect overloaded boolean");
1314 }
1315
1316 {
1317     package Flrbbbbb;
1318     use overload
1319         bool     => sub { shift->{truth} eq 'yes' },
1320         '0+'     => sub { shift->{truth} eq 'yes' ? '1' : '0' },
1321         '!'      => sub { shift->{truth} eq 'no' },
1322         fallback => 1;
1323
1324     sub new { my $class = shift; bless { truth => shift }, $class }
1325
1326     package main;
1327
1328     my $yes = Flrbbbbb->new('yes');
1329     my $x;
1330     $x = 1 if $yes;                     is($x, 1);
1331     $x = 2 unless $yes;                 is($x, 1);
1332     $x = 3 if !$yes;                    is($x, 1);
1333     $x = 4 unless !$yes;                is($x, 4);
1334
1335     my $no = Flrbbbbb->new('no');
1336     $x = 0;
1337     $x = 1 if $no;                      is($x, 0);
1338     $x = 2 unless $no;                  is($x, 2);
1339     $x = 3 if !$no;                     is($x, 3);
1340     $x = 4 unless !$no;                 is($x, 3);
1341
1342     $x = 0;
1343     $x = 1 if !$no && $yes;             is($x, 1);
1344     $x = 2 unless !$no && $yes;         is($x, 1);
1345     $x = 3 if $no || !$yes;             is($x, 1);
1346     $x = 4 unless $no || !$yes;         is($x, 4);
1347
1348     $x = 0;
1349     $x = 1 if !$no || !$yes;            is($x, 1);
1350     $x = 2 unless !$no || !$yes;        is($x, 1);
1351     $x = 3 if !$no && !$yes;            is($x, 1);
1352     $x = 4 unless !$no && !$yes;        is($x, 4);
1353 }
1354
1355 {
1356     use Scalar::Util 'weaken';
1357
1358     package Shklitza;
1359     use overload '""' => sub {"CLiK KLAK"};
1360
1361     package Ksshfwoom;
1362
1363     package main;
1364
1365     my ($obj, $ref);
1366     $obj = bless do {my $a; \$a}, 'Shklitza';
1367     $ref = $obj;
1368
1369     is ("$obj", "CLiK KLAK");
1370     is ("$ref", "CLiK KLAK");
1371
1372     weaken $ref;
1373     is ("$ref", "CLiK KLAK");
1374
1375     bless $obj, 'Ksshfwoom';
1376
1377     like ($obj, qr/^Ksshfwoom=/);
1378     like ($ref, qr/^Ksshfwoom=/);
1379
1380     undef $obj;
1381     is ($ref, undef);
1382 }
1383
1384 {
1385     package bit;
1386     # bit operations have overloadable assignment variants too
1387
1388     sub new { bless \$_[1], $_[0] }
1389
1390     use overload
1391           "&=" => sub { bit->new($_[0]->val . ' & ' . $_[1]->val) }, 
1392           "^=" => sub { bit->new($_[0]->val . ' ^ ' . $_[1]->val) },
1393           "|"  => sub { bit->new($_[0]->val . ' | ' . $_[1]->val) }, # |= by fallback
1394           ;
1395
1396     sub val { ${$_[0]} }
1397
1398     package main;
1399
1400     my $a = bit->new(my $va = 'a');
1401     my $b = bit->new(my $vb = 'b');
1402
1403     $a &= $b;
1404     is($a->val, 'a & b', "overloaded &= works");
1405
1406     my $c = bit->new(my $vc = 'c');
1407
1408     $b ^= $c;
1409     is($b->val, 'b ^ c', "overloaded ^= works");
1410
1411     my $d = bit->new(my $vd = 'd');
1412
1413     $c |= $d;
1414     is($c->val, 'c | d', "overloaded |= (by fallback) works");
1415 }
1416
1417 {
1418     # comparison operators with nomethod (bug 41546)
1419     my $warning = "";
1420     my $method;
1421
1422     package nomethod_false;
1423     use overload nomethod => sub { $method = 'nomethod'; 0 };
1424
1425     package nomethod_true;
1426     use overload nomethod => sub { $method= 'nomethod'; 'true' };
1427
1428     package main;
1429     local $^W = 1;
1430     local $SIG{__WARN__} = sub { $warning = $_[0] };
1431
1432     my $f = bless [], 'nomethod_false';
1433     ($warning, $method) = ("", "");
1434     is($f eq 'whatever', 0, 'nomethod makes eq return 0');
1435     is($method, 'nomethod');
1436
1437     my $t = bless [], 'nomethod_true';
1438     ($warning, $method) = ("", "");
1439     is($t eq 'whatever', 'true', 'nomethod makes eq return "true"');
1440     is($method, 'nomethod');
1441     is($warning, "", 'nomethod eq need not return number');
1442
1443     eval q{ 
1444         package nomethod_false;
1445         use overload cmp => sub { $method = 'cmp'; 0 };
1446     };
1447     $f = bless [], 'nomethod_false';
1448     ($warning, $method) = ("", "");
1449     ok($f eq 'whatever', 'eq falls back to cmp (nomethod not called)');
1450     is($method, 'cmp');
1451
1452     eval q{
1453         package nomethod_true;
1454         use overload cmp => sub { $method = 'cmp'; 'true' };
1455     };
1456     $t = bless [], 'nomethod_true';
1457     ($warning, $method) = ("", "");
1458     ok($t eq 'whatever', 'eq falls back to cmp (nomethod not called)');
1459     is($method, 'cmp');
1460     like($warning, qr/isn't numeric/, 'cmp should return number');
1461
1462 }
1463
1464 {
1465     # nomethod called for '!' after attempted fallback
1466     my $nomethod_called = 0;
1467
1468     package nomethod_not;
1469     use overload nomethod => sub { $nomethod_called = 'yes'; };
1470
1471     package main;
1472     my $o = bless [], 'nomethod_not';
1473     my $res = ! $o;
1474
1475     is($nomethod_called, 'yes', "nomethod() is called for '!'");
1476     is($res, 'yes', "nomethod(..., '!') return value propagates");
1477 }
1478
1479 {
1480     # Subtle bug pre 5.10, as a side effect of the overloading flag being
1481     # stored on the reference rather than the referent. Despite the fact that
1482     # objects can only be accessed via references (even internally), the
1483     # referent actually knows that it's blessed, not the references. So taking
1484     # a new, unrelated, reference to it gives an object. However, the
1485     # overloading-or-not flag was on the reference prior to 5.10, and taking
1486     # a new reference didn't (use to) copy it.
1487
1488     package kayo;
1489
1490     use overload '""' => sub {${$_[0]}};
1491
1492     sub Pie {
1493         return "$_[0], $_[1]";
1494     }
1495
1496     package main;
1497
1498     my $class = 'kayo';
1499     my $string = 'bam';
1500     my $crunch_eth = bless \$string, $class;
1501
1502     is("$crunch_eth", $string);
1503     is ($crunch_eth->Pie("Meat"), "$string, Meat");
1504
1505     my $wham_eth = \$string;
1506
1507     is("$wham_eth", $string,
1508        'This reference did not have overloading in 5.8.8 and earlier');
1509     is ($crunch_eth->Pie("Apple"), "$string, Apple");
1510
1511     my $class = ref $wham_eth;
1512     $class =~ s/=.*//;
1513
1514     # Bless it back into its own class!
1515     bless $wham_eth, $class;
1516
1517     is("$wham_eth", $string);
1518     is ($crunch_eth->Pie("Blackbird"), "$string, Blackbird");
1519 }
1520
1521 {
1522     package numify_int;
1523     use overload "0+" => sub { $_[0][0] += 1; 42 };
1524     package numify_self;
1525     use overload "0+" => sub { $_[0][0]++; $_[0] };
1526     package numify_other;
1527     use overload "0+" => sub { $_[0][0]++; $_[0][1] = bless [], 'numify_int' };
1528     package numify_by_fallback;
1529     use overload fallback => 1;
1530
1531     package main;
1532     my $o = bless [], 'numify_int';
1533     is(int($o), 42, 'numifies to integer');
1534     is($o->[0], 1, 'int() numifies only once');
1535
1536     my $aref = [];
1537     my $num_val = int($aref);
1538     my $r = bless $aref, 'numify_self';
1539     is(int($r), $num_val, 'numifies to self');
1540     is($r->[0], 1, 'int() numifies once when returning self');
1541
1542     my $s = bless [], 'numify_other';
1543     is(int($s), 42, 'numifies to numification of other object');
1544     is($s->[0], 1, 'int() numifies once when returning other object');
1545     is($s->[1][0], 1, 'returned object numifies too');
1546
1547     my $m = bless $aref, 'numify_by_fallback';
1548     is(int($m), $num_val, 'numifies to usual reference value');
1549     is(abs($m), $num_val, 'numifies to usual reference value');
1550     is(-$m, -$num_val, 'numifies to usual reference value');
1551     is(0+$m, $num_val, 'numifies to usual reference value');
1552     is($m+0, $num_val, 'numifies to usual reference value');
1553     is($m+$m, 2*$num_val, 'numifies to usual reference value');
1554     is(0-$m, -$num_val, 'numifies to usual reference value');
1555     is(1*$m, $num_val, 'numifies to usual reference value');
1556     is(int($m/1), $num_val, 'numifies to usual reference value');
1557     is($m%100, $num_val%100, 'numifies to usual reference value');
1558     is($m**1, $num_val, 'numifies to usual reference value');
1559
1560     is(abs($aref), $num_val, 'abs() of ref');
1561     is(-$aref, -$num_val, 'negative of ref');
1562     is(0+$aref, $num_val, 'ref addition');
1563     is($aref+0, $num_val, 'ref addition');
1564     is($aref+$aref, 2*$num_val, 'ref addition');
1565     is(0-$aref, -$num_val, 'subtraction of ref');
1566     is(1*$aref, $num_val, 'multiplicaton of ref');
1567     is(int($aref/1), $num_val, 'division of ref');
1568     is($aref%100, $num_val%100, 'modulo of ref');
1569     is($aref**1, $num_val, 'exponentiation of ref');
1570 }
1571
1572 {
1573     package CopyConstructorFallback;
1574     use overload
1575         '++'        => sub { "$_[0]"; $_[0] },
1576         fallback    => 1;
1577     sub new { bless {} => shift }
1578
1579     package main;
1580
1581     my $o = CopyConstructorFallback->new;
1582     my $x = $o++; # would segfault
1583     my $y = ++$o;
1584     is($x, $o, "copy constructor falls back to assignment (postinc)");
1585     is($y, $o, "copy constructor falls back to assignment (preinc)");
1586 }
1587
1588 # only scalar 'x' should currently overload
1589
1590 {
1591     package REPEAT;
1592
1593     my ($x,$n, $nm);
1594
1595     use overload
1596         'x'        => sub { $x++; 1 },
1597         '0+'       => sub { $n++; 1 },
1598         'nomethod' => sub { $nm++; 1 },
1599         'fallback' => 0,
1600     ;
1601
1602     my $s = bless {};
1603
1604     package main;
1605
1606     my @a;
1607     my $count = 3;
1608
1609     ($x,$n,$nm) = (0,0,0);
1610     @a = ((1,2,$s) x $count);
1611     is("$x-$n-$nm", "0-0-0", 'repeat 1');
1612
1613     ($x,$n,$nm) = (0,0,0);
1614     @a = ((1,$s,3) x $count);
1615     is("$x-$n-$nm", "0-0-0", 'repeat 2');
1616
1617     ($x,$n,$nm) = (0,0,0);
1618     @a = ((1,2,3) x $s);
1619     is("$x-$n-$nm", "0-1-0", 'repeat 3');
1620 }
1621
1622
1623
1624 # RT #57012: magic items need to have mg_get() called before testing for
1625 # overload. Lack of this means that overloaded values returned by eg a
1626 # tied array didn't call overload methods.
1627 # We test here both a tied array and scalar, since the implementation of
1628 # tied  arrays (and hashes) is such that in rvalue context, mg_get is
1629 # called prior to executing the op, while it isn't for a tied scalar.
1630 # We also check that return values are correctly tainted.
1631 # We try against two overload packages; one has all expected methods, the
1632 # other uses only fallback methods.
1633
1634 {
1635
1636     # @tests holds a list of test cases. Each elem is an array ref with
1637     # the following entries:
1638     #
1639     #  * the value that the overload method should return
1640     #
1641     #  * the expression to be evaled. %s is replaced with the
1642     #       variable being tested ($ta[0], $ts, or $plain)
1643     #
1644     #  * a string listing what functions we expect to be called.
1645     #       Each method appends its name in parentheses, so "(=)(+)" means
1646     #       we expect the copy constructor and then the add method to be
1647     #       called.
1648     #
1649     #  * like above, but what should be called for the fallback-only test
1650     #      (in this case, nomethod() identifies itself as "(NM:*)" where *
1651     #      is the op).  If this value is undef, fallback tests are skipped.
1652     #
1653     #  * An array ref of expected counts of calls to FETCH/STORE.
1654     #      The first three values are:
1655     #         1. the expected number of FETCHs for a tied array
1656     #         2. the expected number of FETCHs for a tied scalar
1657     #         3. the expected number of STOREs
1658     #       If there are a further three elements present, then
1659     #       these represent the expected counts for the fallback
1660     #       version of the tests. If absent, they are assumed to
1661     #       be the same as for the full method test
1662     #
1663     #  * Under the taint version of the tests,  whether we expect
1664     #       the result to be tainted (for example comparison ops
1665     #       like '==' don't return a tainted value, even if their
1666     #       args are.
1667     my @tests;
1668
1669     my %subs;
1670     my $funcs;
1671     my $use_int;
1672
1673     BEGIN {
1674         # A note on what methods to expect to be called, and
1675         # how many times FETCH/STORE is called:
1676         #
1677         # Mutating ops (+=, ++ etc) trigger a copy ('='), since
1678         # the code can't distinguish between something that's been copied:
1679         #    $a = foo->new(0); $b = $a; refcnt($$b) == 2
1680         # and overloaded objects stored in ties which will have extra
1681         # refcounts due to the tied_obj magic and entries on the tmps
1682         # stack when returning from FETCH etc. So we always copy.
1683
1684         # This accounts for a '=', and an extra STORE.
1685         # We also have a FETCH returning the final value from the eval,
1686         # plus a FETCH in the overload subs themselves: ($_[0][0])
1687         # triggers one. However, tied aggregates have a mechanism to prevent
1688         # multiple fetches between STOREs, which means that the tied
1689         # hash skips doing a FETCH during '='.
1690
1691         for (qw(+ - * / % ** << >> & | ^)) {
1692             my $op = $_;
1693             $op = '%%' if $op eq '%';
1694             my $e = "%s $op= 3";
1695             $subs{"$_="} = $e;
1696             # ARRAY  FETCH: initial,        sub+=, eval-return,
1697             # SCALAR FETCH: initial, sub=,  sub+=, eval-return,
1698             # STORE:        copy, mutator
1699             push @tests, [ 18, $e, "(=)($_=)", "(=)(NM:$_=)", [ 3, 4, 2 ], 1 ];
1700
1701             $subs{$_} =
1702                 "do { my \$arg = %s; \$_[2] ? (3 $op \$arg) : (\$arg $op 3) }";
1703             # ARRAY  FETCH: initial
1704             # SCALAR FETCH: initial eval-return,
1705             push @tests, [ 18, "%s $op 3", "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
1706             push @tests, [ 18, "3 $op %s", "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
1707         }
1708
1709         # these use string fallback rather than nomethod
1710         for (qw(x .)) {
1711             my $op = $_;
1712             my $e = "%s $op= 3";
1713             $subs{"$_="} = $e;
1714             # For normal case:
1715             #   ARRAY  FETCH: initial,        sub+=, eval-return,
1716             #   SCALAR FETCH: initial, sub=,  sub+=, eval-return,
1717             #          STORE: copy, mutator
1718             # for fallback, we just stringify, so eval-return and copy skipped
1719
1720             push @tests, [ 18, $e, "(=)($_=)", '("")',
1721                             [ 3, 4, 2,     2, 3, 1 ], 1 ];
1722
1723             $subs{$_} =
1724                 "do { my \$arg = %s; \$_[2] ? (3 $op \$arg) : (\$arg $op 3) }";
1725             # ARRAY  FETCH: initial
1726             # SCALAR FETCH: initial eval-return,
1727             # with fallback, we just stringify, so eval-return skipped,
1728             #    but an extra FETCH happens in sub"", except for 'x',
1729             #    which passes a copy of the RV to sub"", avoiding the
1730             #    second FETCH
1731
1732             push @tests, [ 18, "%s $op 3", "($_)", '("")',
1733                             [ 1, 2, 0,     1, ($_ eq '.' ? 2 : 1), 0 ], 1 ];
1734             next if $_ eq 'x'; # repeat only overloads on LHS
1735             push @tests, [ 18, "3 $op %s", "($_)", '("")',
1736                             [ 1, 2, 0,     1, 2, 0 ], 1 ];
1737         }
1738
1739         for (qw(++ --)) {
1740             my $pre  = "$_%s";
1741             my $post = "%s$_";
1742             $subs{$_} = $pre;
1743             push @tests,
1744                 # ARRAY  FETCH: initial,        sub+=, eval-return,
1745                 # SCALAR FETCH: initial, sub=,  sub+=, eval-return,
1746                 # STORE:        copy, mutator
1747                 [ 18, $pre, "(=)($_)(\"\")", "(=)(NM:$_)(\"\")", [ 3, 4, 2 ], 1 ],
1748                 # ARRAY  FETCH: initial,        sub+=
1749                 # SCALAR FETCH: initial, sub=,  sub+=
1750                 # STORE:        copy, mutator
1751                 [ 18, $post, "(=)($_)(\"\")", "(=)(NM:$_)(\"\")", [ 2, 3, 2 ], 1 ];
1752         }
1753
1754         # For the non-mutator ops, we have a initial FETCH,
1755         # an extra FETCH within the sub itself for the scalar option,
1756         # and no STOREs
1757
1758         for (qw(< <= >  >= == != lt le gt ge eq ne)) {
1759             my $e = "%s $_ 3";
1760             $subs{$_} = $e;
1761             push @tests, [ 3, $e, "($_)", "(NM:$_)", [ 1, 2, 0 ], 0 ];
1762         }
1763         for (qw(<=> cmp)) {
1764             my $e = "%s $_ 3";
1765             $subs{$_} = $e;
1766             push @tests, [ 3, $e, "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
1767         }
1768         for (qw(atan2)) {
1769             my $e = "$_ %s, 3";
1770             $subs{$_} = $e;
1771             push @tests, [ 18, $e, "($_)", "(NM:$_)", [ 1, 2, 0 ], 1 ];
1772         }
1773         for (qw(cos sin exp abs log sqrt int ~)) {
1774             my $e = "$_(%s)";
1775             $subs{$_} = $e;
1776             push @tests, [ 1.23, $e, "($_)",
1777                     ($_ eq 'int' ? '(0+)' : "(NM:$_)") , [ 1, 2, 0 ], 1 ];
1778         }
1779         for (qw(!)) {
1780             my $e = "$_(%s)";
1781             $subs{$_} = $e;
1782             push @tests, [ 1.23, $e, "($_)", '(0+)', [ 1, 2, 0 ], 0 ];
1783         }
1784         for (qw(-)) {
1785             my $e = "$_(%s)";
1786             $subs{neg} = $e;
1787             push @tests, [ 18, $e, '(neg)', '(NM:neg)', [ 1, 2, 0 ], 1 ];
1788         }
1789         my $e = '(%s) ? 1 : 0';
1790         $subs{bool} = $e;
1791         push @tests, [ 18, $e, '(bool)', '(0+)', [ 1, 2, 0 ], 0 ];
1792
1793         # note: this is testing unary qr, not binary =~
1794         $subs{qr} = '(qr/%s/)';
1795         push @tests, [ "abc", '"abc" =~ (%s)', '(qr)', '("")', [ 1, 2, 0 ], 0 ];
1796         push @tests, [ chr 256, 'chr(256) =~ (%s)', '(qr)', '("")',
1797                                                           [ 1, 2, 0 ], 0 ];
1798
1799         $e = '"abc" ~~ (%s)';
1800         $subs{'~~'} = $e;
1801         push @tests, [ "abc", $e, '(~~)', '(NM:~~)', [ 1, 1, 0 ], 0 ];
1802
1803         $subs{'-X'} = 'do { my $f = (%s);'
1804                     . '$_[1] eq "r" ? (-r ($f)) :'
1805                     . '$_[1] eq "e" ? (-e ($f)) :'
1806                     . '$_[1] eq "f" ? (-f ($f)) :'
1807                     . '$_[1] eq "l" ? (-l ($f)) :'
1808                     . '$_[1] eq "t" ? (-t ($f)) :'
1809                     . '$_[1] eq "T" ? (-T ($f)) : 0;}';
1810         # Note - we don't care what these file tests return, as
1811         # long as the tied and untied versions return the same value.
1812         # The flags below are chosen to test all uses of tryAMAGICftest_MG
1813         for (qw(r e f l t T)) {
1814             push @tests, [ 'TEST', "-$_ (%s)", '(-X)', '("")', [ 1, 2, 0 ], 0 ];
1815         }
1816
1817         $subs{'${}'} = '%s';
1818         push @tests, [ do {my $s=99; \$s}, '${%s}', '(${})', undef, [ 1, 1, 0 ], 0 ];
1819
1820         # we skip testing '@{}' here because too much of this test
1821         # framework involves array dereferences!
1822
1823         $subs{'%{}'} = '%s';
1824         push @tests, [ {qw(a 1 b 2 c 3)}, 'join "", sort keys %%{%s}',
1825                         '(%{})', undef, [ 1, 1, 0 ], 0 ];
1826
1827         $subs{'&{}'} = '%s';
1828         push @tests, [ sub {99}, 'do {&{%s} for 1,2}',
1829                             '(&{})(&{})', undef, [ 2, 2, 0 ], 0 ];
1830
1831         our $RT57012A = 88;
1832         our $RT57012B;
1833         $subs{'*{}'} = '%s';
1834         push @tests, [ \*RT57012A, '*RT57012B = *{%s}; our $RT57012B',
1835                 '(*{})', undef, [ 1, 1, 0 ], 0 ];
1836
1837         my $iter_text = ("some random text\n" x 100) . $^X;
1838         open my $iter_fh, '<', \$iter_text
1839             or die "open of \$iter_text gave ($!)\n";
1840         $subs{'<>'} = '<$iter_fh>';
1841         push @tests, [ $iter_fh, '<%s>', '(<>)', undef, [ 1, 1, 0 ], 1 ];
1842
1843         # eval should do tie, overload on its arg before checking taint */
1844         push @tests, [ '1;', 'eval q(eval %s); $@ =~ /Insecure/',
1845                 '("")', '("")', [ 1, 2, 0 ], 0 ];
1846
1847
1848         for my $sub (keys %subs) {
1849             my $term = $subs{$sub};
1850             my $t = sprintf $term, '$_[0][0]';
1851             my $e ="sub { \$funcs .= '($sub)'; my \$r; if (\$use_int) {"
1852                 . "use integer; \$r = ($t) } else { \$r = ($t) } \$r }";
1853             $subs{$sub} = eval $e;
1854             die "Compiling sub gave error:\n<$e>\n<$@>\n" if $@;
1855         }
1856     }
1857
1858     my $fetches;
1859     my $stores;
1860
1861     package RT57012_OV;
1862
1863     use overload
1864         %subs,
1865         "="   => sub { $funcs .= '(=)';  bless [ $_[0][0] ] },
1866         '0+'  => sub { $funcs .= '(0+)'; 0 + $_[0][0] },
1867         '""'  => sub { $funcs .= '("")'; "$_[0][0]"   },
1868         ;
1869
1870     package RT57012_OV_FB; # only contains fallback conversion functions
1871
1872     use overload
1873         "="   => sub { $funcs .= '(=)';  bless [ $_[0][0] ] },
1874         '0+'  => sub { $funcs .= '(0+)'; 0 + $_[0][0] },
1875         '""'  => sub { $funcs .= '("")'; "$_[0][0]"   },
1876         "nomethod" => sub {
1877                         $funcs .= "(NM:$_[3])";
1878                         my $e = defined($_[1])
1879                                 ? $_[3] eq 'atan2'
1880                                     ? $_[2]
1881                                        ? "atan2(\$_[1],\$_[0][0])"
1882                                        : "atan2(\$_[0][0],\$_[1])"
1883                                     : $_[2]
1884                                         ? "\$_[1] $_[3] \$_[0][0]"
1885                                         : "\$_[0][0] $_[3] \$_[1]"
1886                                 : $_[3] eq 'neg'
1887                                     ? "-\$_[0][0]"
1888                                     : "$_[3](\$_[0][0])";
1889                         my $r;
1890                         if ($use_int) {
1891                             use integer; $r = eval $e;
1892                         }
1893                         else {
1894                             $r = eval $e;
1895                         }
1896                         ::diag("eval of nomethod <$e> gave <$@>") if $@;
1897                         $r;
1898                     }
1899
1900         ;
1901
1902     package RT57012_TIE_S;
1903
1904     my $tie_val;
1905     sub TIESCALAR { bless [ bless [ $tie_val ], $_[1] ] }
1906     sub FETCH     { $fetches++; $_[0][0] }
1907     sub STORE     { $stores++;  $_[0][0] = $_[1] }
1908
1909     package RT57012_TIE_A;
1910
1911     sub TIEARRAY  { bless [] }
1912     sub FETCH     { $fetches++; $_[0][0] }
1913     sub STORE     { $stores++;  $_[0][$_[1]] = $_[2] }
1914
1915     package main;
1916
1917     for my $test (@tests) {
1918         my ($val, $sub_term, $exp_funcs, $exp_fb_funcs,
1919             $exp_counts, $exp_taint) = @$test;
1920
1921         my $tainted_val;
1922         {
1923             # create tainted version of $val (unless its a ref)
1924             my $t = substr($^X,0,0);
1925             my $t0 = $t."0";
1926             my $val1 = $val; # use a copy to avoid stringifying original
1927             $tainted_val = ref($val1) ? $val :
1928                         ($val1 =~ /^[\d\.]+$/) ? $val+$t0 : $val.$t;
1929         }
1930         $tie_val = $tainted_val;
1931
1932         for my $int ('', 'use integer; ') {
1933             $use_int = ($int ne '');
1934             my $plain = $tainted_val;
1935             my $plain_term = $int . sprintf $sub_term, '$plain';
1936             my $exp = eval $plain_term;
1937             diag("eval of plain_term <$plain_term> gave <$@>") if $@;
1938             is(tainted($exp), $exp_taint,
1939                         "<$plain_term> taint of expected return");
1940
1941             for my $ov_pkg (qw(RT57012_OV RT57012_OV_FB)) {
1942                 next if $ov_pkg eq 'RT57012_OV_FB'
1943                         and  not defined $exp_fb_funcs;
1944                 my ($exp_fetch_a, $exp_fetch_s, $exp_store) =
1945                     ($ov_pkg eq 'RT57012_OV' || @$exp_counts < 4)
1946                         ? @$exp_counts[0,1,2]
1947                         : @$exp_counts[3,4,5];
1948
1949                 tie my $ts, 'RT57012_TIE_S', $ov_pkg;
1950                 tie my @ta, 'RT57012_TIE_A';
1951                 $ta[0]    = bless [ $tainted_val ], $ov_pkg;
1952                 my $oload = bless [ $tainted_val ], $ov_pkg;
1953
1954                 for my $var ('$ta[0]', '$ts', '$oload',
1955                             ($sub_term eq '<%s>' ? '${ts}' : ())
1956                 ) {
1957
1958                     $funcs = '';
1959                     $fetches = 0;
1960                     $stores = 0;
1961
1962                     my $res_term  = $int . sprintf $sub_term, $var;
1963                     my $desc =  "<$res_term> $ov_pkg" ;
1964                     my $res = eval $res_term;
1965                     diag("eval of res_term $desc gave <$@>") if $@;
1966                     # uniquely, the inc/dec ops return the original
1967                     # ref rather than a copy, so stringify it to
1968                     # find out if its tainted
1969                     $res = "$res" if $res_term =~ /\+\+|--/;
1970                     is(tainted($res), $exp_taint,
1971                             "$desc taint of result return");
1972                     is($res, $exp, "$desc return value");
1973                     my $fns =($ov_pkg eq 'RT57012_OV_FB')
1974                                 ? $exp_fb_funcs : $exp_funcs;
1975                     if ($var eq '$oload' && $res_term !~ /oload(\+\+|--)/) {
1976                         # non-tied overloading doesn't trigger a copy
1977                         # except for post inc/dec
1978                         $fns =~ s/^\(=\)//;
1979                     }
1980                     is($funcs, $fns, "$desc methods called");
1981                     next if $var eq '$oload';
1982                     my $exp_fetch = ($var eq '$ts') ?
1983                             $exp_fetch_s : $exp_fetch_a;
1984                     is($fetches, $exp_fetch, "$desc FETCH count");
1985                     is($stores, $exp_store, "$desc STORE count");
1986
1987                 }
1988
1989             }
1990         }
1991     }
1992 }
1993
1994 # Test overload from the main package
1995 fresh_perl_is
1996  '$^W = 1; use overload q\""\ => sub {"ning"}; print bless []',
1997  'ning',
1998   { switches => ['-wl'], stderr => 1 },
1999  'use overload from the main package'
2000 ;
2001
2002 {
2003     package blessed_methods;
2004     use overload '+' => sub {};
2005     bless overload::Method __PACKAGE__,'+';
2006     eval { overload::Method __PACKAGE__,'+' };
2007     ::is($@, '', 'overload::Method and blessed overload methods');
2008 }
2009
2010 {
2011     # fallback to 'cmp' and '<=>' with heterogeneous operands
2012     # [perl #71286]
2013     my $not_found = 'no method found';
2014     my $used = 0;
2015     package CmpBase;
2016     sub new {
2017         my $n = $_[1] || 0;
2018         bless \$n, ref $_[0] || $_[0];
2019     }
2020     sub cmp {
2021         $used = \$_[0];
2022         (${$_[0]} <=> ${$_[1]}) * ($_[2] ? -1 : 1);
2023     }
2024
2025     package NCmp;
2026     use base 'CmpBase';
2027     use overload '<=>' => 'cmp';
2028
2029     package SCmp;
2030     use base 'CmpBase';
2031     use overload 'cmp' => 'cmp';
2032
2033     package main;
2034     my $n = NCmp->new(5);
2035     my $s = SCmp->new(3);
2036     my $res;
2037
2038     eval { $res = $n > $s; };
2039     $res = $not_found if $@ =~ /$not_found/;
2040     is($res, 1, 'A>B using A<=> when B overloaded, no B<=>');
2041
2042     eval { $res = $s < $n; };
2043     $res = $not_found if $@ =~ /$not_found/;
2044     is($res, 1, 'A<B using B<=> when A overloaded, no A<=>');
2045
2046     eval { $res = $s lt $n; };
2047     $res = $not_found if $@ =~ /$not_found/;
2048     is($res, 1, 'A lt B using A:cmp when B overloaded, no B:cmp');
2049
2050     eval { $res = $n gt $s; };
2051     $res = $not_found if $@ =~ /$not_found/;
2052     is($res, 1, 'A gt B using B:cmp when A overloaded, no A:cmp');
2053
2054     my $o = NCmp->new(9);
2055     $res = $n < $o;
2056     is($used, \$n, 'A < B uses <=> from A in preference to B');
2057
2058     my $t = SCmp->new(7);
2059     $res = $s lt $t;
2060     is($used, \$s, 'A lt B uses cmp from A in preference to B');
2061 }
2062
2063 {
2064     # Combinatorial testing of 'fallback' and 'nomethod'
2065     # [perl #71286]
2066     package NuMB;
2067     use overload '0+' => sub { ${$_[0]}; },
2068         '""' => 'str';
2069     sub new {
2070         my $self = shift;
2071         my $n = @_ ? shift : 0;
2072         bless my $obj = \$n, ref $self || $self;
2073     }
2074     sub str {
2075         no strict qw/refs/;
2076         my $s = "(${$_[0]} ";
2077         $s .= "nomethod, " if defined ${ref($_[0]).'::(nomethod'};
2078         my $fb = ${ref($_[0]).'::()'};
2079         $s .= "fb=" . (defined $fb ? 0 + $fb : 'undef') . ")";
2080     }
2081     sub nomethod { "${$_[0]}.nomethod"; }
2082
2083     # create classes for tests
2084     package main;
2085     my @falls = (0, 'undef', 1);
2086     my @nomethods = ('', 'nomethod');
2087     my $not_found = 'no method found';
2088     for my $fall (@falls) {
2089         for my $nomethod (@nomethods) {
2090             my $nomethod_decl = $nomethod
2091                 ? $nomethod . "=>'nomethod'," : '';
2092             eval qq{
2093                     package NuMB$fall$nomethod;
2094                     use base qw/NuMB/;
2095                     use overload $nomethod_decl
2096                     fallback => $fall;
2097                 };
2098         }
2099     }
2100
2101     # operation and precedence of 'fallback' and 'nomethod'
2102     # for all combinations with 2 overloaded operands
2103     for my $nomethod2 (@nomethods) {
2104         for my $nomethod1 (@nomethods) {
2105             for my $fall2 (@falls) {
2106                 my $pack2 = "NuMB$fall2$nomethod2";
2107                 for my $fall1 (@falls) {
2108                     my $pack1 = "NuMB$fall1$nomethod1";
2109                     my ($test, $out, $exp);
2110                     eval qq{
2111                             my \$x = $pack1->new(2);
2112                             my \$y = $pack2->new(3);
2113                             \$test = "\$x" . ' * ' . "\$y";
2114                             \$out = \$x * \$y;
2115                         };
2116                     $out = $not_found if $@ =~ /$not_found/;
2117                     $exp = $nomethod1 ? '2.nomethod' :
2118                          $nomethod2 ? '3.nomethod' :
2119                          $fall1 eq '1' && $fall2 eq '1' ? 6
2120                          : $not_found;
2121                     is($out, $exp, "$test --> $exp");
2122                 }
2123             }
2124         }
2125     }
2126
2127     # operation of 'fallback' and 'nomethod'
2128     # where the other operand is not overloaded
2129     for my $nomethod (@nomethods) {
2130         for my $fall (@falls) {
2131             my ($test, $out, $exp);
2132             eval qq{
2133                     my \$x = NuMB$fall$nomethod->new(2);
2134                     \$test = "\$x" . ' * 3';
2135                     \$out = \$x * 3;
2136                 };
2137             $out = $not_found if $@ =~ /$not_found/;
2138             $exp = $nomethod ? '2.nomethod' :
2139                 $fall eq '1' ? 6
2140                 : $not_found;
2141             is($out, $exp, "$test --> $exp");
2142
2143             eval qq{
2144                     my \$x = NuMB$fall$nomethod->new(2);
2145                     \$test = '3 * ' . "\$x";
2146                     \$out = 3 * \$x;
2147                 };
2148             $out = $not_found if $@ =~ /$not_found/;
2149             is($out, $exp, "$test --> $exp");
2150         }
2151     }
2152 }
2153
2154 # since 5.6 overloaded <> was leaving an extra arg on the stack!
2155
2156 {
2157     package Iter1;
2158     use overload '<>' => sub { 11 };
2159     package main;
2160     my $a = bless [], 'Iter1';
2161     my $x;
2162     my @a = (10, ($x = <$a>), 12);
2163     is ($a[0], 10, 'Iter1: a[0]');
2164     is ($a[1], 11, 'Iter1: a[1]');
2165     is ($a[2], 12, 'Iter1: a[2]');
2166     @a = (10, ($x .= <$a>), 12);
2167     is ($a[0],   10, 'Iter1: a[0] concat');
2168     is ($a[1], 1111, 'Iter1: a[1] concat');
2169     is ($a[2],   12, 'Iter1: a[2] concat');
2170 }
2171
2172 # Some tests for error messages
2173 {
2174     package Justus;
2175     use overload '+' => 'justice';
2176     eval {bless[]};
2177     ::like $@, qr/^Can't resolve method "justice" overloading "\+" in p(?x:
2178                   )ackage "Justus" at /,
2179       'Error message when explicitly named overload method does not exist';
2180
2181     package JustUs;
2182     our @ISA = 'JustYou';
2183     package JustYou { use overload '+' => 'injustice'; }
2184     "JustUs"->${\"(+"};
2185     eval {bless []};
2186     ::like $@, qr/^Stub found while resolving method "\?{3}" overloadin(?x:
2187                   )g "\+" in package "JustUs" at /,
2188       'Error message when sub stub is encountered';
2189 }
2190
2191 { # undefining the overload stash -- KEEP THIS TEST LAST
2192     package ant;
2193     use overload '+' => 'onion';
2194     $_ = \&overload::nil;
2195     undef %overload::;
2196     bless[];
2197     ::ok(1, 'no crash when undefining %overload::');
2198 }
2199
2200 # EOF