This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
badd684ab03a594a4aefbbecb45039371d97dc4a
[perl5.git] / t / op / sort.t
1 #!./perl
2 $|=1;
3
4 BEGIN {
5     chdir 't' if -d 't';
6     require './test.pl';
7     set_up_inc('../lib');
8 }
9 use warnings;
10 plan(tests => 195);
11
12 # these shouldn't hang
13 {
14     no warnings;
15     sort { for ($_ = 0;; $_++) {} } @a;
16     sort { while(1) {}            } @a;
17     sort { while(1) { last; }     } @a;
18     sort { while(0) { last; }     } @a;
19
20     # Change 26011: Re: A surprising segfault
21     map scalar(sort(+())), ('')x68;
22 }
23
24 sub Backwards { $a lt $b ? 1 : $a gt $b ? -1 : 0 }
25 sub Backwards_stacked($$) { my($a,$b) = @_; $a lt $b ? 1 : $a gt $b ? -1 : 0 }
26 sub Backwards_other { $a lt $b ? 1 : $a gt $b ? -1 : 0 }
27
28 my $upperfirst = 'A' lt 'a';
29
30 # Beware: in future this may become hairier because of possible
31 # collation complications: qw(A a B b) can be sorted at least as
32 # any of the following
33 #
34 #       A a B b
35 #       A B a b
36 #       a b A B
37 #       a A b B
38 #
39 # All the above orders make sense.
40 #
41 # That said, EBCDIC sorts all small letters first, as opposed
42 # to ASCII which sorts all big letters first.
43
44 @harry = ('dog','cat','x','Cain','Abel');
45 @george = ('gone','chased','yz','punished','Axed');
46
47 $x = join('', sort @harry);
48 $expected = $upperfirst ? 'AbelCaincatdogx' : 'catdogxAbelCain';
49
50 cmp_ok($x,'eq',$expected,'upper first 1');
51
52 $x = join('', sort( Backwards @harry));
53 $expected = $upperfirst ? 'xdogcatCainAbel' : 'CainAbelxdogcat';
54
55 cmp_ok($x,'eq',$expected,'upper first 2');
56
57 $x = join('', sort( Backwards_stacked @harry));
58 $expected = $upperfirst ? 'xdogcatCainAbel' : 'CainAbelxdogcat';
59
60 cmp_ok($x,'eq',$expected,'upper first 3');
61
62 $x = join('', sort @george, 'to', @harry);
63 $expected = $upperfirst ?
64     'AbelAxedCaincatchaseddoggonepunishedtoxyz' :
65     'catchaseddoggonepunishedtoxyzAbelAxedCain' ;
66
67 my @initially_sorted = ( 0 .. 260,
68                          0x3FF, 0x400, 0x401,
69                          0x7FF, 0x800, 0x801,
70                          0x3FFF, 0x4000, 0x4001,
71                          0xFFFF, 0x10000, 0x10001,
72                        );
73 # It makes things easier below if there are an even number of elements in the
74 # array.
75 if (scalar(@initially_sorted) % 2 == 1) {
76     push @initially_sorted, $initially_sorted[-1] + 1;
77 }
78
79 # We convert to a chr(), but prepend a constant string to make sure things can
80 # work on more than a single character.
81 my $prefix = "a\xb6";
82 my $prefix_len = length $prefix;
83
84 my @chr_initially_sorted = @initially_sorted;
85 $_ = $prefix . chr($_) for @chr_initially_sorted;
86
87 # Create a very unsorted version by reversing it, and then pushing the same
88 # code points again, but pair-wise reversed.
89 my @initially_unsorted = reverse @chr_initially_sorted;
90 for (my $i = 0; $i < @chr_initially_sorted - 1; $i += 2) {
91     push @initially_unsorted, $chr_initially_sorted[$i+1],
92                               $chr_initially_sorted[$i];
93 }
94
95 # And, an all-UTF-8 version
96 my @utf8_initialy_unsorted = @initially_unsorted;
97 utf8::upgrade($_) for @utf8_initialy_unsorted;
98
99 # Sort the non-UTF-8 version
100 my @non_utf8_result = sort @initially_unsorted;
101 my @wrongly_utf8;
102 my $ordered_correctly = 1;
103 for my $i (0 .. @chr_initially_sorted -1) {
104     if (   $chr_initially_sorted[$i] ne $non_utf8_result[2*$i]
105         || $chr_initially_sorted[$i] ne $non_utf8_result[2*$i+1])
106     {
107         $ordered_correctly = 0;
108         last;
109     }
110     push @wrongly_utf8, $i if $i < 256 && utf8::is_utf8($non_utf8_result[$i]);
111 }
112 if (! ok($ordered_correctly, "sort of non-utf8 list worked")) {
113     diag ("This should be in numeric order (with 2 instances of every code point):\n"
114         . join " ", map { sprintf "%02x", ord substr $_, $prefix_len, 1 } @non_utf8_result);
115 }
116 if (! is(@wrongly_utf8, 0,
117                       "No elements were wrongly converted to utf8 in sorting"))
118 {
119     diag "For code points " . join " ", @wrongly_utf8;
120 }
121
122 # And then the UTF-8 one
123 my @wrongly_non_utf8;
124 $ordered_correctly = 1;
125 my @utf8_result = sort @utf8_initialy_unsorted;
126 for my $i (0 .. @chr_initially_sorted -1) {
127     if (   $chr_initially_sorted[$i] ne $utf8_result[2*$i]
128         || $chr_initially_sorted[$i] ne $utf8_result[2*$i+1])
129     {
130         $ordered_correctly = 0;
131         last;
132     }
133     push @wrongly_non_utf8, $i unless utf8::is_utf8($utf8_result[$i]);
134 }
135 if (! ok($ordered_correctly, "sort of utf8 list worked")) {
136     diag ("This should be in numeric order (with 2 instances of every code point):\n"
137         . join " ", map { sprintf "%02x", ord substr $_, $prefix_len, 1 } @utf8_result);
138 }
139 if (! is(@wrongly_non_utf8, 0,
140                       "No elements were wrongly converted from utf8 in sorting"))
141 {
142     diag "For code points " . join " ", @wrongly_non_utf8;
143 }
144
145 cmp_ok($x,'eq',$expected,'upper first 4');
146 $" = ' ';
147 @a = ();
148 @b = reverse @a;
149 cmp_ok("@b",'eq',"",'reverse 1');
150
151 @a = (1);
152 @b = reverse @a;
153 cmp_ok("@b",'eq',"1",'reverse 2');
154
155 @a = (1,2);
156 @b = reverse @a;
157 cmp_ok("@b",'eq',"2 1",'reverse 3');
158
159 @a = (1,2,3);
160 @b = reverse @a;
161 cmp_ok("@b",'eq',"3 2 1",'reverse 4');
162
163 @a = (1,2,3,4);
164 @b = reverse @a;
165 cmp_ok("@b",'eq',"4 3 2 1",'reverse 5');
166
167 @a = (10,2,3,4);
168 @b = sort {$a <=> $b;} @a;
169 cmp_ok("@b",'eq',"2 3 4 10",'sort numeric');
170
171 $sub = 'Backwards';
172 $x = join('', sort $sub @harry);
173 $expected = $upperfirst ? 'xdogcatCainAbel' : 'CainAbelxdogcat';
174
175 cmp_ok($x,'eq',$expected,'sorter sub name in var 1');
176
177 $sub = 'Backwards_stacked';
178 $x = join('', sort $sub @harry);
179 $expected = $upperfirst ? 'xdogcatCainAbel' : 'CainAbelxdogcat';
180
181 cmp_ok($x,'eq',$expected,'sorter sub name in var 2');
182
183 # literals, combinations
184
185 @b = sort (4,1,3,2);
186 cmp_ok("@b",'eq','1 2 3 4','just sort');
187
188
189 @b = sort grep { $_ } (4,1,3,2);
190 cmp_ok("@b",'eq','1 2 3 4','grep then sort');
191
192
193 @b = sort map { $_ } (4,1,3,2);
194 cmp_ok("@b",'eq','1 2 3 4','map then sort');
195
196
197 @b = sort reverse (4,1,3,2);
198 cmp_ok("@b",'eq','1 2 3 4','reverse then sort');
199
200
201 @b = sort CORE::reverse (4,1,3,2);
202 cmp_ok("@b",'eq','1 2 3 4','CORE::reverse then sort');
203
204 eval  { @b = sort CORE::revers (4,1,3,2); };
205 like($@, qr/^Undefined sort subroutine "CORE::revers" called at /);
206
207
208 sub twoface { no warnings 'redefine'; *twoface = sub { $a <=> $b }; &twoface }
209 eval { @b = sort twoface 4,1,3,2 };
210 cmp_ok("@b",'eq','1 2 3 4','redefine sort sub inside the sort sub');
211
212
213 eval { no warnings 'redefine'; *twoface = sub { &Backwards } };
214 ok(!$@,"redefining sort subs outside the sort \$@=[$@]");
215
216 eval { @b = sort twoface 4,1,3,2 };
217 cmp_ok("@b",'eq','4 3 2 1','twoface redefinition');
218
219 {
220   no warnings 'redefine';
221   *twoface = sub { *twoface = *Backwards_other; $a <=> $b };
222 }
223
224 eval { @b = sort twoface 4,1,9,5 };
225 ok(($@ eq "" && "@b" eq "1 4 5 9"),'redefinition should not take effect during the sort');
226
227 {
228   no warnings 'redefine';
229   *twoface = sub {
230                  eval 'sub twoface { $a <=> $b }';
231                  die($@ eq "" ? "good\n" : "bad\n");
232                  $a <=> $b;
233                };
234 }
235 eval { @b = sort twoface 4,1 };
236 cmp_ok(substr($@,0,4), 'eq', 'good', 'twoface eval');
237
238 eval <<'CODE';
239     my @result = sort main'Backwards 'one', 'two';
240 CODE
241 cmp_ok($@,'eq','',q(old skool package));
242
243 eval <<'CODE';
244     # "sort 'one', 'two'" should not try to parse "'one" as a sort sub
245     my @result = sort 'one', 'two';
246 CODE
247 cmp_ok($@,'eq','',q(one is not a sub));
248
249 {
250   my $sortsub = \&Backwards;
251   my $sortglob = *Backwards;
252   my $sortglobr = \*Backwards;
253   my $sortname = 'Backwards';
254   @b = sort $sortsub 4,1,3,2;
255   cmp_ok("@b",'eq','4 3 2 1','sortname 1');
256   @b = sort $sortglob 4,1,3,2;
257   cmp_ok("@b",'eq','4 3 2 1','sortname 2');
258   @b = sort $sortname 4,1,3,2;
259   cmp_ok("@b",'eq','4 3 2 1','sortname 3');
260   @b = sort $sortglobr 4,1,3,2;
261   cmp_ok("@b",'eq','4 3 2 1','sortname 4');
262 }
263
264 {
265   my $sortsub = \&Backwards_stacked;
266   my $sortglob = *Backwards_stacked;
267   my $sortglobr = \*Backwards_stacked;
268   my $sortname = 'Backwards_stacked';
269   @b = sort $sortsub 4,1,3,2;
270   cmp_ok("@b",'eq','4 3 2 1','sortname 5');
271   @b = sort $sortglob 4,1,3,2;
272   cmp_ok("@b",'eq','4 3 2 1','sortname 6');
273   @b = sort $sortname 4,1,3,2;
274   cmp_ok("@b",'eq','4 3 2 1','sortname 7');
275   @b = sort $sortglobr 4,1,3,2;
276   cmp_ok("@b",'eq','4 3 2 1','sortname 8');
277 }
278
279 {
280   local $sortsub = \&Backwards;
281   local $sortglob = *Backwards;
282   local $sortglobr = \*Backwards;
283   local $sortname = 'Backwards';
284   @b = sort $sortsub 4,1,3,2;
285   cmp_ok("@b",'eq','4 3 2 1','sortname local 1');
286   @b = sort $sortglob 4,1,3,2;
287   cmp_ok("@b",'eq','4 3 2 1','sortname local 2');
288   @b = sort $sortname 4,1,3,2;
289   cmp_ok("@b",'eq','4 3 2 1','sortname local 3');
290   @b = sort $sortglobr 4,1,3,2;
291   cmp_ok("@b",'eq','4 3 2 1','sortname local 4');
292 }
293
294 {
295   local $sortsub = \&Backwards_stacked;
296   local $sortglob = *Backwards_stacked;
297   local $sortglobr = \*Backwards_stacked;
298   local $sortname = 'Backwards_stacked';
299   @b = sort $sortsub 4,1,3,2;
300   cmp_ok("@b",'eq','4 3 2 1','sortname local 5');
301   @b = sort $sortglob 4,1,3,2;
302   cmp_ok("@b",'eq','4 3 2 1','sortname local 6');
303   @b = sort $sortname 4,1,3,2;
304   cmp_ok("@b",'eq','4 3 2 1','sortname local 7');
305   @b = sort $sortglobr 4,1,3,2;
306   cmp_ok("@b",'eq','4 3 2 1','sortname local 8');
307 }
308
309 ## exercise sort builtins... ($a <=> $b already tested)
310 @a = ( 5, 19, 1996, 255, 90 );
311 @b = sort {
312     my $dummy;          # force blockness
313     return $b <=> $a
314 } @a;
315 cmp_ok("@b",'eq','1996 255 90 19 5','force blockness');
316
317 $x = join('', sort { $a cmp $b } @harry);
318 $expected = $upperfirst ? 'AbelCaincatdogx' : 'catdogxAbelCain';
319 cmp_ok($x,'eq',$expected,'a cmp b');
320
321 $x = join('', sort { $b cmp $a } @harry);
322 $expected = $upperfirst ? 'xdogcatCainAbel' : 'CainAbelxdogcat';
323 cmp_ok($x,'eq',$expected,'b cmp a');
324
325 {
326     use integer;
327     @b = sort { $a <=> $b } @a;
328     cmp_ok("@b",'eq','5 19 90 255 1996','integer a <=> b');
329
330     @b = sort { $b <=> $a } @a;
331     cmp_ok("@b",'eq','1996 255 90 19 5','integer b <=> a');
332
333     $x = join('', sort { $a cmp $b } @harry);
334     $expected = $upperfirst ? 'AbelCaincatdogx' : 'catdogxAbelCain';
335     cmp_ok($x,'eq',$expected,'integer a cmp b');
336
337     $x = join('', sort { $b cmp $a } @harry);
338     $expected = $upperfirst ? 'xdogcatCainAbel' : 'CainAbelxdogcat';
339     cmp_ok($x,'eq',$expected,'integer b cmp a');
340
341 }
342
343
344
345 $x = join('', sort { $a <=> $b } 3, 1, 2);
346 cmp_ok($x,'eq','123',q(optimized-away comparison block doesn't take any other arguments away with it));
347
348 # test sorting in non-main package
349 {
350     package Foo;
351     @a = ( 5, 19, 1996, 255, 90 );
352     @b = sort { $b <=> $a } @a;
353     ::cmp_ok("@b",'eq','1996 255 90 19 5','not in main:: 1');
354
355     @b = sort ::Backwards_stacked @a;
356     ::cmp_ok("@b",'eq','90 5 255 1996 19','not in main:: 2');
357
358     # check if context for sort arguments is handled right
359     sub test_if_list {
360         my $gimme = wantarray;
361         ::is($gimme,1,'wantarray 1');
362     }
363     my $m = sub { $a <=> $b };
364
365     sub cxt_one { sort $m test_if_list() }
366     cxt_one();
367     sub cxt_two { sort { $a <=> $b } test_if_list() }
368     cxt_two();
369     sub cxt_three { sort &test_if_list() }
370     cxt_three();
371     sub cxt_three_anna_half { sort 0, test_if_list() }
372     cxt_three_anna_half();
373
374     sub test_if_scalar {
375         my $gimme = wantarray;
376         ::is(!($gimme or !defined($gimme)),1,'wantarray 2');
377     }
378
379     $m = \&test_if_scalar;
380     sub cxt_four { sort $m 1,2 }
381     @x = cxt_four();
382     sub cxt_five { sort { test_if_scalar($a,$b); } 1,2 }
383     @x = cxt_five();
384     sub cxt_six { sort test_if_scalar 1,2 }
385     @x = cxt_six();
386 }
387
388
389 # test against a reentrancy bug
390 {
391     package Bar;
392     sub compare { $a cmp $b }
393     sub reenter { my @force = sort compare qw/a b/ }
394 }
395 {
396     my($def, $init) = (0, 0);
397     @b = sort {
398         $def = 1 if defined $Bar::a;
399         Bar::reenter() unless $init++;
400         $a <=> $b
401     } qw/4 3 1 2/;
402     cmp_ok("@b",'eq','1 2 3 4','reenter 1');
403
404     ok(!$def,'reenter 2');
405 }
406
407
408 {
409     sub routine { "one", "two" };
410     @a = sort(routine(1));
411     cmp_ok("@a",'eq',"one two",'bug id 19991001.003 (#1549)');
412 }
413
414
415 # check for in-place optimisation of @a = sort @a
416 {
417     my ($r1,$r2,@a);
418     our @g;
419     @g = (3,2,1); $r1 = \$g[2]; @g = sort @g; $r2 = \$g[0];
420     is "$r1-@g", "$r2-1 2 3", "inplace sort of global";
421
422     @a = qw(b a c); $r1 = \$a[1]; @a = sort @a; $r2 = \$a[0];
423     is "$r1-@a", "$r2-a b c", "inplace sort of lexical";
424
425     @g = (2,3,1); $r1 = \$g[1]; @g = sort { $b <=> $a } @g; $r2 = \$g[0];
426     is "$r1-@g", "$r2-3 2 1", "inplace reversed sort of global";
427
428     @g = (2,3,1);
429     $r1 = \$g[1]; @g = sort { $a<$b?1:$a>$b?-1:0 } @g; $r2 = \$g[0];
430     is "$r1-@g", "$r2-3 2 1", "inplace custom sort of global";
431
432     sub mysort { $b cmp $a };
433     @a = qw(b c a); $r1 = \$a[1]; @a = sort mysort @a; $r2 = \$a[0];
434     is "$r1-@a", "$r2-c b a", "inplace sort with function of lexical";
435
436     use Tie::Array;
437     my @t;
438     tie @t, 'Tie::StdArray';
439
440     @t = qw(b c a); @t = sort @t;
441     is "@t", "a b c", "inplace sort of tied array";
442
443     @t = qw(b c a); @t = sort mysort @t;
444     is "@t", "c b a", "inplace sort of tied array with function";
445
446     #  [perl #29790] don't optimise @a = ('a', sort @a) !
447
448     @g = (3,2,1); @g = ('0', sort @g);
449     is "@g", "0 1 2 3", "un-inplace sort of global";
450     @g = (3,2,1); @g = (sort(@g),'4');
451     is "@g", "1 2 3 4", "un-inplace sort of global 2";
452
453     @a = qw(b a c); @a = ('x', sort @a);
454     is "@a", "x a b c", "un-inplace sort of lexical";
455     @a = qw(b a c); @a = ((sort @a), 'x');
456     is "@a", "a b c x", "un-inplace sort of lexical 2";
457
458     @g = (2,3,1); @g = ('0', sort { $b <=> $a } @g);
459     is "@g", "0 3 2 1", "un-inplace reversed sort of global";
460     @g = (2,3,1); @g = ((sort { $b <=> $a } @g),'4');
461     is "@g", "3 2 1 4", "un-inplace reversed sort of global 2";
462
463     @g = (2,3,1); @g = ('0', sort { $a<$b?1:$a>$b?-1:0 } @g);
464     is "@g", "0 3 2 1", "un-inplace custom sort of global";
465     @g = (2,3,1); @g = ((sort { $a<$b?1:$a>$b?-1:0 } @g),'4');
466     is "@g", "3 2 1 4", "un-inplace custom sort of global 2";
467
468     @a = qw(b c a); @a = ('x', sort mysort @a);
469     is "@a", "x c b a", "un-inplace sort with function of lexical";
470     @a = qw(b c a); @a = ((sort mysort @a),'x');
471     is "@a", "c b a x", "un-inplace sort with function of lexical 2";
472
473     # RT#54758. Git 62b40d2474e7487e6909e1872b6bccdf812c6818
474     no warnings 'void';
475     my @m; push @m, 0 for 1 .. 1024; $#m; @m = sort @m;
476     ::pass("in-place sorting segfault");
477 }
478
479 # Test optimisations of reversed sorts. As we now guarantee stability by
480 # default, # optimisations which do not provide this are bogus.
481
482 {
483     package Oscalar;
484     use overload (qw("" stringify 0+ numify fallback 1));
485
486     sub new {
487         bless [$_[1], $_[2]], $_[0];
488     }
489
490     sub stringify { $_[0]->[0] }
491
492     sub numify { $_[0]->[1] }
493 }
494
495 sub generate {
496     my $count = 0;
497     map {new Oscalar $_, $count++} qw(A A A B B B C C C);
498 }
499
500 my @input = &generate;
501 my @output = sort @input;
502 is join(" ", map {0+$_} @output), "0 1 2 3 4 5 6 7 8", "Simple stable sort";
503
504 @input = &generate;
505 @input = sort @input;
506 is join(" ", map {0+$_} @input), "0 1 2 3 4 5 6 7 8",
507     "Simple stable in place sort";
508
509 # This won't be very interesting
510 @input = &generate;
511 @output = sort {$a <=> $b} @input;
512 is "@output", "A A A B B B C C C", 'stable $a <=> $b sort';
513
514 @input = &generate;
515 @output = sort {$a cmp $b} @input;
516 is join(" ", map {0+$_} @output), "0 1 2 3 4 5 6 7 8", 'stable $a cmp $b sort';
517
518 @input = &generate;
519 @input = sort {$a cmp $b} @input;
520 is join(" ", map {0+$_} @input), "0 1 2 3 4 5 6 7 8",
521     'stable $a cmp $b in place sort';
522
523 @input = &generate;
524 @output = sort {$b cmp $a} @input;
525 is join(" ", map {0+$_} @output), "6 7 8 3 4 5 0 1 2", 'stable $b cmp $a sort';
526
527 @input = &generate;
528 @input = sort {$b cmp $a} @input;
529 is join(" ", map {0+$_} @input), "6 7 8 3 4 5 0 1 2",
530     'stable $b cmp $a in place sort';
531
532 @input = &generate;
533 @output = reverse sort @input;
534 is join(" ", map {0+$_} @output), "8 7 6 5 4 3 2 1 0", "Reversed stable sort";
535
536 @input = &generate;
537 @input = reverse sort @input;
538 is join(" ", map {0+$_} @input), "8 7 6 5 4 3 2 1 0",
539     "Reversed stable in place sort";
540
541 @input = &generate;
542 my $output = reverse sort @input;
543 is $output, "CCCBBBAAA", "Reversed stable sort in scalar context";
544
545
546 @input = &generate;
547 @output = reverse sort {$a cmp $b} @input;
548 is join(" ", map {0+$_} @output), "8 7 6 5 4 3 2 1 0",
549     'reversed stable $a cmp $b sort';
550
551 @input = &generate;
552 @input = reverse sort {$a cmp $b} @input;
553 is join(" ", map {0+$_} @input), "8 7 6 5 4 3 2 1 0",
554     'revesed stable $a cmp $b in place sort';
555
556 @input = &generate;
557 $output = reverse sort {$a cmp $b} @input;
558 is $output, "CCCBBBAAA", 'Reversed stable $a cmp $b sort in scalar context';
559
560 @input = &generate;
561 @output = reverse sort {$b cmp $a} @input;
562 is join(" ", map {0+$_} @output), "2 1 0 5 4 3 8 7 6",
563     'reversed stable $b cmp $a sort';
564
565 @input = &generate;
566 @input = reverse sort {$b cmp $a} @input;
567 is join(" ", map {0+$_} @input), "2 1 0 5 4 3 8 7 6",
568     'revesed stable $b cmp $a in place sort';
569
570 @input = &generate;
571 $output = reverse sort {$b cmp $a} @input;
572 is $output, "AAABBBCCC", 'Reversed stable $b cmp $a sort in scalar context';
573
574 sub stuff {
575     # Something complex enough to defeat any constant folding optimiser
576     $$ - $$;
577 }
578
579 @input = &generate;
580 @output = reverse sort {stuff || $a cmp $b} @input;
581 is join(" ", map {0+$_} @output), "8 7 6 5 4 3 2 1 0",
582     'reversed stable complex sort';
583
584 @input = &generate;
585 @input = reverse sort {stuff || $a cmp $b} @input;
586 is join(" ", map {0+$_} @input), "8 7 6 5 4 3 2 1 0",
587     'revesed stable complex in place sort';
588
589 @input = &generate;
590 $output = reverse sort {stuff || $a cmp $b } @input;
591 is $output, "CCCBBBAAA", 'Reversed stable complex sort in scalar context';
592
593 sub sortr {
594     reverse sort @_;
595 }
596
597 @output = sortr &generate;
598 is join(" ", map {0+$_} @output), "8 7 6 5 4 3 2 1 0",
599     'reversed stable sort return list context';
600 $output = sortr &generate;
601 is $output, "CCCBBBAAA",
602     'reversed stable sort return scalar context';
603
604 sub sortcmpr {
605     reverse sort {$a cmp $b} @_;
606 }
607
608 @output = sortcmpr &generate;
609 is join(" ", map {0+$_} @output), "8 7 6 5 4 3 2 1 0",
610     'reversed stable $a cmp $b sort return list context';
611 $output = sortcmpr &generate;
612 is $output, "CCCBBBAAA",
613     'reversed stable $a cmp $b sort return scalar context';
614
615 sub sortcmprba {
616     reverse sort {$b cmp $a} @_;
617 }
618
619 @output = sortcmprba &generate;
620 is join(" ", map {0+$_} @output), "2 1 0 5 4 3 8 7 6",
621     'reversed stable $b cmp $a sort return list context';
622 $output = sortcmprba &generate;
623 is $output, "AAABBBCCC",
624 'reversed stable $b cmp $a sort return scalar context';
625
626 sub sortcmprq {
627     reverse sort {stuff || $a cmp $b} @_;
628 }
629
630 @output = sortcmpr &generate;
631 is join(" ", map {0+$_} @output), "8 7 6 5 4 3 2 1 0",
632     'reversed stable complex sort return list context';
633 $output = sortcmpr &generate;
634 is $output, "CCCBBBAAA",
635     'reversed stable complex sort return scalar context';
636
637 # And now with numbers
638
639 sub generate1 {
640     my $count = 'A';
641     map {new Oscalar $count++, $_} 0, 0, 0, 1, 1, 1, 2, 2, 2;
642 }
643
644 # This won't be very interesting
645 @input = &generate1;
646 @output = sort {$a cmp $b} @input;
647 is "@output", "A B C D E F G H I", 'stable $a cmp $b sort';
648
649 @input = &generate1;
650 @output = sort {$a <=> $b} @input;
651 is "@output", "A B C D E F G H I", 'stable $a <=> $b sort';
652
653 @input = &generate1;
654 @input = sort {$a <=> $b} @input;
655 is "@input", "A B C D E F G H I", 'stable $a <=> $b in place sort';
656
657 @input = &generate1;
658 @output = sort {$b <=> $a} @input;
659 is "@output", "G H I D E F A B C", 'stable $b <=> $a sort';
660
661 @input = &generate1;
662 @input = sort {$b <=> $a} @input;
663 is "@input", "G H I D E F A B C", 'stable $b <=> $a in place sort';
664
665 # test that optimized {$b cmp $a} and {$b <=> $a} remain stable
666 # (new in 5.9) without overloading
667 { no warnings;
668 @b = sort { $b <=> $a } @input = qw/5first 6first 5second 6second/;
669 is "@b" , "6first 6second 5first 5second", "optimized {$b <=> $a} without overloading" ;
670 @input = sort {$b <=> $a} @input;
671 is "@input" , "6first 6second 5first 5second","inline optimized {$b <=> $a} without overloading" ;
672 };
673
674 # These two are actually doing string cmp on 0 1 and 2
675 @input = &generate1;
676 @output = reverse sort @input;
677 is "@output", "I H G F E D C B A", "Reversed stable sort";
678
679 @input = &generate1;
680 @input = reverse sort @input;
681 is "@input", "I H G F E D C B A", "Reversed stable in place sort";
682
683 @input = &generate1;
684 $output = reverse sort @input;
685 is $output, "IHGFEDCBA", "Reversed stable sort in scalar context";
686
687 @input = &generate1;
688 @output = reverse sort {$a <=> $b} @input;
689 is "@output", "I H G F E D C B A", 'reversed stable $a <=> $b sort';
690
691 @input = &generate1;
692 @input = reverse sort {$a <=> $b} @input;
693 is "@input", "I H G F E D C B A", 'revesed stable $a <=> $b in place sort';
694
695 @input = &generate1;
696 $output = reverse sort {$a <=> $b} @input;
697 is $output, "IHGFEDCBA", 'reversed stable $a <=> $b sort in scalar context';
698
699 @input = &generate1;
700 @output = reverse sort {$b <=> $a} @input;
701 is "@output", "C B A F E D I H G", 'reversed stable $b <=> $a sort';
702
703 @input = &generate1;
704 @input = reverse sort {$b <=> $a} @input;
705 is "@input", "C B A F E D I H G", 'revesed stable $b <=> $a in place sort';
706
707 @input = &generate1;
708 $output = reverse sort {$b <=> $a} @input;
709 is $output, "CBAFEDIHG", 'reversed stable $b <=> $a sort in scalar context';
710
711 @input = &generate1;
712 @output = reverse sort {stuff || $a <=> $b} @input;
713 is "@output", "I H G F E D C B A", 'reversed stable complex sort';
714
715 @input = &generate1;
716 @input = reverse sort {stuff || $a <=> $b} @input;
717 is "@input", "I H G F E D C B A", 'revesed stable complex in place sort';
718
719 @input = &generate1;
720 $output = reverse sort {stuff || $a <=> $b} @input;
721 is $output, "IHGFEDCBA", 'reversed stable complex sort in scalar context';
722
723 sub sortnumr {
724     reverse sort {$a <=> $b} @_;
725 }
726
727 @output = sortnumr &generate1;
728 is "@output", "I H G F E D C B A",
729     'reversed stable $a <=> $b sort return list context';
730 $output = sortnumr &generate1;
731 is $output, "IHGFEDCBA", 'reversed stable $a <=> $b sort return scalar context';
732
733 sub sortnumrba {
734     reverse sort {$b <=> $a} @_;
735 }
736
737 @output = sortnumrba &generate1;
738 is "@output", "C B A F E D I H G",
739     'reversed stable $b <=> $a sort return list context';
740 $output = sortnumrba &generate1;
741 is $output, "CBAFEDIHG", 'reversed stable $b <=> $a sort return scalar context';
742
743 sub sortnumrq {
744     reverse sort {stuff || $a <=> $b} @_;
745 }
746
747 @output = sortnumrq &generate1;
748 is "@output", "I H G F E D C B A",
749     'reversed stable complex sort return list context';
750 $output = sortnumrq &generate1;
751 is $output, "IHGFEDCBA", 'reversed stable complex sort return scalar context';
752
753 @output = reverse (sort(qw(C A B)), 0);
754 is "@output", "0 C B A", 'reversed sort with trailing argument';
755
756 @output = reverse (0, sort(qw(C A B)));
757 is "@output", "C B A 0", 'reversed sort with leading argument';
758
759 eval { @output = sort {goto sub {}} 1,2; };
760 $fail_msg = q(Can't goto subroutine outside a subroutine);
761 cmp_ok(substr($@,0,length($fail_msg)),'eq',$fail_msg,'goto subr outside subr');
762
763
764
765 sub goto_sub {goto sub{}}
766 eval { @output = sort goto_sub 1,2; };
767 $fail_msg = q(Can't goto subroutine from a sort sub);
768 cmp_ok(substr($@,0,length($fail_msg)),'eq',$fail_msg,'goto subr from a sort sub');
769
770
771
772 eval { @output = sort {goto label} 1,2; };
773 $fail_msg = q(Can't "goto" out of a pseudo block);
774 cmp_ok(substr($@,0,length($fail_msg)),'eq',$fail_msg,'goto out of a pseudo block 1');
775
776
777
778 sub goto_label {goto label}
779 label: eval { @output = sort goto_label 1,2; };
780 $fail_msg = q(Can't "goto" out of a pseudo block);
781 cmp_ok(substr($@,0,length($fail_msg)),'eq',$fail_msg,'goto out of a pseudo block 2');
782
783
784
785 sub self_immolate {undef &self_immolate; $a<=>$b}
786 eval { @output = sort self_immolate 1,2,3 };
787 $fail_msg = q(Can't undef active subroutine);
788 cmp_ok(substr($@,0,length($fail_msg)),'eq',$fail_msg,'undef active subr');
789
790
791 for(1,2) # We run this twice, to make sure sort does not lower the ref
792 {        # count. See bug 71076.
793     my $failed = 0;
794
795     sub rec {
796         my $n = shift;
797         if (!defined($n)) {  # No arg means we're being called by sort()
798             return 1;
799         }
800         if ($n<5) { rec($n+1); }
801         else { () = sort rec 1,2; }
802
803         $failed = 1 if !defined $n;
804     }
805
806     rec(1);
807     ok(!$failed, "sort from active sub");
808 }
809
810 # $a and $b are set in the package the sort() is called from,
811 # *not* the package the sort sub is in. This is longstanding
812 # de facto behaviour that shouldn't be broken.
813 my $answer = "good";
814 () = sort OtherPack::foo 1,2,3,4;
815
816 {
817     package OtherPack;
818     no warnings 'once';
819     sub foo {
820         $answer = "something was unexpectedly defined or undefined" if
821         defined($a) || defined($b) || !defined($main::a) || !defined($main::b);
822         $main::a <=> $main::b;
823     }
824 }
825
826 cmp_ok($answer,'eq','good','sort subr called from other package');
827
828
829 # Bug 36430 - sort called in package2 while a
830 # sort in package1 is active should set $package2::a/b.
831 {
832     my $answer = "good";
833     my @list = sort { A::min(@$a) <=> A::min(@$b) }
834       [3, 1, 5], [2, 4], [0];
835
836     cmp_ok($answer,'eq','good','bug 36430');
837
838     package A;
839     sub min {
840         my @list = sort {
841             $answer = '$a and/or $b are not defined ' if !defined($a) || !defined($b);
842             $a <=> $b;
843         } @_;
844         $list[0];
845     }
846 }
847
848
849 # Bug 7567 - an array shouldn't be modifiable while it's being
850 # sorted in-place.
851 {
852     eval { @a=(1..8); @a = sort { @a = (0) } @a; };
853
854     $fail_msg = q(Modification of a read-only value attempted);
855     cmp_ok(substr($@,0,length($fail_msg)),'eq',$fail_msg,'bug 7567');
856     eval { @a=1..3 };
857     is $@, "", 'abrupt scope exit turns off readonliness';
858 }
859
860 # I commented out this TODO test because messing with FREEd scalars on the
861 # stack can have all sorts of strange side-effects, not made safe by eval
862 # - DAPM.
863 #
864 #{
865 #    local $TODO = "sort should make sure elements are not freed in the sort block";
866 #    eval { @nomodify_x=(1..8);
867 #          our @copy = sort { undef @nomodify_x; 1 } (@nomodify_x, 3); };
868 #    is($@, "");
869 #}
870
871
872 # Sorting shouldn't increase the refcount of a sub
873 {
874     sub sportello {(1+$a) <=> (1+$b)}
875     my $refcnt = &Internals::SvREFCNT(\&sportello);
876     @output = sort sportello 3,7,9;
877
878     {
879         package Doc;
880         ::is($refcnt, &Internals::SvREFCNT(\&::sportello), "sort sub refcnt");
881         $fail_msg = q(Modification of a read-only value attempted);
882         # Sorting a read-only array in-place shouldn't be allowed
883         my @readonly = (1..10);
884         Internals::SvREADONLY(@readonly, 1);
885         eval { @readonly = sort @readonly; };
886         ::cmp_ok(substr($@,0,length($fail_msg)),'eq',$fail_msg,'in-place sort of read-only array');
887     }
888 }
889
890
891 # Using return() should be okay even in a deeper context
892 @b = sort {while (1) {return ($a <=> $b)} } 1..10;
893 is("@b", "1 2 3 4 5 6 7 8 9 10", "return within loop");
894
895 # Using return() should be okay even if there are other items
896 # on the stack at the time.
897 @b = sort {$_ = ($a<=>$b) + do{return $b<=> $a}} 1..10;
898 is("@b", "10 9 8 7 6 5 4 3 2 1", "return with SVs on stack");
899
900 # As above, but with a sort sub rather than a sort block.
901 sub ret_with_stacked { $_ = ($a<=>$b) + do {return $b <=> $a} }
902 @b = sort ret_with_stacked 1..10;
903 is("@b", "10 9 8 7 6 5 4 3 2 1", "return with SVs on stack");
904
905 # Comparison code should be able to give result in non-integer representation.
906 sub cmp_as_string($$) { $_[0] < $_[1] ? "-1" : $_[0] == $_[1] ? "0" : "+1" }
907 @b = sort { cmp_as_string($a, $b) } (1,5,4,7,3,2,3);
908 is("@b", "1 2 3 3 4 5 7", "comparison result as string");
909 @b = sort cmp_as_string (1,5,4,7,3,2,3);
910 is("@b", "1 2 3 3 4 5 7", "comparison result as string");
911
912 # RT #34604: sort didn't honour overloading if the overloaded elements
913 # were retrieved via tie
914
915 {
916     package RT34604;
917
918     sub TIEHASH { bless {
919                         p => bless({ val => 2 }),
920                         q => bless({ val => 1 }),
921                     }
922                 }
923     sub FETCH { $_[0]{$_[1] } }
924
925     my $cc = 0;
926     sub compare { $cc++; $_[0]{val} cmp $_[1]{val} }
927     my $cs = 0;
928     sub str { $cs++; $_[0]{val} }
929
930     use overload 'cmp' => \&compare, '""' => \&str;
931
932     package main;
933
934     tie my %h, 'RT34604';
935     my @sorted = sort @h{qw(p q)};
936     is($cc, 1, 'overload compare called once');
937     is("@sorted","1 2", 'overload sort result');
938     is($cs, 2, 'overload string called twice');
939 }
940
941 fresh_perl_is('sub w ($$) {my ($l, $r) = @_; my $v = \@_; undef @_; $l <=> $r}; print join q{ }, sort w 3, 1, 2, 0',
942              '0 1 2 3',
943              {stderr => 1, switches => ['-w']},
944              'RT #72334');
945
946 fresh_perl_is('sub w ($$) {my ($l, $r) = @_; my $v = \@_; undef @_; @_ = 0..2; $l <=> $r}; print join q{ }, sort w 3, 1, 2, 0',
947              '0 1 2 3',
948              {stderr => 1, switches => ['-w']},
949              'RT #72334');
950
951 {
952     my $count = 0;
953     {
954         package Counter;
955
956         sub new {
957             ++$count;
958             bless [];
959         }
960
961         sub DESTROY {
962             --$count;
963         }
964     }
965
966     sub sorter ($$) {
967         my ($l, $r) = @_;
968         my $q = \@_;
969         $l <=> $r;
970     }
971
972     is($count, 0, 'None before we start');
973     my @a = map { Counter->new() } 0..1;
974     is($count, 2, '2 here');
975
976     my @b = sort sorter @a;
977
978     is(scalar @b, 2);
979     cmp_ok($b[0], '<', $b[1], 'sorted!');
980
981     is($count, 2, 'still the same 2 here');
982
983     @a = (); @b = ();
984
985     is($count, 0, 'all gone');
986 }
987
988 # [perl #77930] The context stack may be reallocated during a sort, as a
989 #               result of deeply-nested (or not-so-deeply-nested) calls
990 #               from a custom sort subroutine.
991 fresh_perl_is
992  '
993    $sub = sub {
994     local $count = $count+1;
995     ()->$sub if $count < 1000;
996     $a cmp $b
997    };
998    () = sort $sub qw<a b c d e f g>;
999    print "ok"
1000  ',
1001  'ok',
1002   {},
1003  '[perl #77930] cx_stack reallocation during sort'
1004 ;
1005
1006 # [perl #76026]
1007 # Match vars should not leak from one sort sub call to the next
1008 {
1009   my $output = '';
1010   sub soarter {
1011     $output .= $1;
1012     "Leakage" =~ /(.*)/;
1013     1
1014   }
1015   sub soarterdd($$) {
1016     $output .= $1;
1017     "Leakage" =~ /(.*)/;
1018     1
1019   }
1020
1021   "Win" =~ /(.*)/;
1022   my @b = sort soarter 0..2;
1023
1024   like $output, qr/^(?:Win)+\z/,
1025    "Match vars do not leak from one plain sort sub to the next";
1026
1027   $output = '';
1028
1029   "Win" =~ /(.*)/;
1030   @b = sort soarterdd 0..2;
1031
1032   like $output, qr/^(?:Win)+\z/,
1033    'Match vars do not leak from one $$ sort sub to the next';
1034 }
1035
1036 # [perl #30661] autoloading
1037 AUTOLOAD { $b <=> $a }
1038 sub stubbedsub;
1039 is join("", sort stubbedsub split//, '04381091'), '98431100',
1040     'stubborn AUTOLOAD';
1041 is join("", sort hopefullynonexistent split//, '04381091'), '98431100',
1042     'AUTOLOAD without stub';
1043 my $stubref = \&givemeastub;
1044 is join("", sort $stubref split//, '04381091'), '98431100',
1045     'AUTOLOAD with stubref';
1046
1047 # [perl #90030] sort without arguments
1048 eval '@x = (sort); 1';
1049 is $@, '', '(sort) does not die';
1050 is @x, 0, '(sort) returns empty list';
1051 eval '@x = sort; 1';
1052 is $@, '', 'sort; does not die';
1053 is @x, 0, 'sort; returns empty list';
1054 eval '{@x = sort} 1';
1055 is $@, '', '{sort} does not die';
1056 is @x, 0, '{sort} returns empty list';
1057
1058 # this happened while the padrange op was being added. Sort blocks
1059 # are executed in void context, and the padrange op was skipping pushing
1060 # the item in void cx. The net result was that the return value was
1061 # whatever was on the stack last.
1062
1063 {
1064     my @a = sort {
1065         my $r = $a <=> $b;
1066         if ($r) {
1067             undef; # this got returned by mistake
1068             return $r
1069         }
1070         return 0;
1071     } 5,1,3,6,0;
1072     is "@a", "0 1 3 5 6", "padrange and void context";
1073 }
1074
1075 # Fatal warnings an sort sub returning a non-number
1076 # We need two evals, because the panic used to happen on scope exit.
1077 eval { eval { use warnings FATAL => 'all'; () = sort { undef } 1,2 } };
1078 is $@, "",
1079   'no panic/crash with fatal warnings when sort sub returns undef';
1080 eval { eval { use warnings FATAL => 'all'; () = sort { "no thin" } 1,2 } };
1081 is $@, "",
1082   'no panic/crash with fatal warnings when sort sub returns string';
1083 sub notdef($$) { undef }
1084 eval { eval { use warnings FATAL => 'all'; () = sort notdef 1,2 } };
1085 is $@, "",
1086   'no panic/crash with fatal warnings when sort sub($$) returns undef';
1087 sub yarn($$) { "no thinking aloud" }
1088 eval { eval { use warnings FATAL => 'all'; () = sort yarn 1,2 } };
1089 is $@, "",
1090   'no panic/crash with fatal warnings when sort sub($$) returns string';
1091
1092 $#a = -1;
1093 () = [sort { $a = 10; $b = 10; 0 } $#a, $#a];
1094 is $#a, 10, 'sort block modifying $a and $b';
1095
1096 () = sort {
1097     is \$a, \$a, '[perl #78194] op return values passed to sort'; 0
1098 } "${\''}", "${\''}";
1099
1100 package deletions {
1101     @_=sort { delete $deletions::{a}; delete $deletions::{b}; 3 } 1..3;
1102 }
1103 pass "no crash when sort block deletes *a and *b";
1104
1105 # make sure return args are always evaluated in scalar context
1106
1107 {
1108     package Ret;
1109     no warnings 'void';
1110     sub f0 { }
1111     sub f1 { $b <=> $a, $a <=> $b }
1112     sub f2 { return ($b <=> $a, $a <=> $b) }
1113     sub f3 { for ($b <=> $a) { return ($b <=> $a, $a <=> $b) } }
1114
1115     {
1116         no warnings 'uninitialized';
1117         ::is (join('-', sort { () } 3,1,2,4), '3-1-2-4', "Ret: null blk");
1118     }
1119     ::is (join('-', sort { $b <=> $a, $a <=> $b } 3,1,2,4), '1-2-3-4', "Ret: blk");
1120     ::is (join('-', sort { for($b <=> $a) { return ($b <=> $a, $a <=> $b) } }
1121                             3,1,2,4), '1-2-3-4', "Ret: blk ret");
1122     {
1123         no warnings 'uninitialized';
1124         ::is (join('-', sort f0 3,1,2,4), '3-1-2-4', "Ret: f0");
1125     }
1126     ::is (join('-', sort f1 3,1,2,4), '1-2-3-4', "Ret: f1");
1127     ::is (join('-', sort f2 3,1,2,4), '1-2-3-4', "Ret: f2");
1128     ::is (join('-', sort f3 3,1,2,4), '1-2-3-4', "Ret: f3");
1129 }
1130
1131 {
1132     @a = sort{ *a=0; 1} 0..1;
1133     pass "No crash when GP deleted out from under us [perl 124097]";
1134
1135     no warnings 'redefine';
1136     # some alternative non-solutions localized modifications to *a and *b
1137     sub a { 0 };
1138     @a = sort { *a = sub { 1 }; $a <=> $b } 0 .. 1;
1139     ok(a(), "*a wasn't localized inadvertantly");
1140 }