1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
|
use 5.008;
use strict;
use warnings;
package Sub::HandlesVia::HandlerLibrary::Array;
our $AUTHORITY = 'cpan:TOBYINK';
our $VERSION = '0.052000';
use Exporter::Tiny;
use Sub::HandlesVia::HandlerLibrary;
our @ISA = qw(
Exporter::Tiny
Sub::HandlesVia::HandlerLibrary
);
use Sub::HandlesVia::Handler qw( handler );
use Types::Standard qw( ArrayRef Optional Str CodeRef Int Item Any Ref Defined FileHandle );
sub HandleQueue () { 1 }
sub HandleStack () { 2 }
our @EXPORT = qw(
HandleQueue
HandleStack
);
sub expand_shortcut {
require Carp;
my ( $class, $target, $attrname, $spec, $shortcut ) = @_;
my %handlers;
if ( HandleQueue & $shortcut ) {
$handlers{"$attrname\_is_empty"} = 'is_empty';
$handlers{"$attrname\_size"} = 'count';
$handlers{"$attrname\_enqueue"} = 'push...';
$handlers{"$attrname\_dequeue"} = 'shift';
$handlers{"$attrname\_peek"} = [ get => 0 ];
}
if ( HandleStack & $shortcut ) {
$handlers{"$attrname\_is_empty"} = 'is_empty';
$handlers{"$attrname\_size"} = 'count';
$handlers{"$attrname\_push"} = 'push...';
$handlers{"$attrname\_pop"} = 'pop';
$handlers{"$attrname\_peek"} = [ get => -1 ];
}
return \%handlers;
}
our @METHODS = qw( count is_empty all elements flatten get pop push shift
unshift clear first first_index reduce set accessor natatime any
shallow_clone map grep sort reverse sort_in_place splice shuffle
shuffle_in_place uniq uniq_in_place delete insert flatten flatten_deep
join print head tail apply pick_random for_each for_each_pair
all_true not_all_true min minstr max maxstr sum product indexed
reductions sample uniqnum uniqnum_in_place uniqstr uniqstr_in_place
pairs pairkeys pairvalues pairgrep pairfirst pairmap reset );
sub _type_inspector {
my ($me, $type) = @_;
if ($type == ArrayRef or $type == Defined or $type == Ref) {
return {
trust_mutated => 'always',
};
}
if ($type->is_parameterized
and $type->parent->name eq 'ArrayRef'
and $type->parent->library eq 'Types::Standard'
and 1==@{$type->parameters}) {
return {
trust_mutated => 'maybe',
value_type => $type->type_parameter,
};
}
return $me->SUPER::_type_inspector($type);
}
my $additional_validation_for_push_and_unshift = sub {
my $self = CORE::shift;
my ($sig_was_checked, $gen) = @_;
my $ti = __PACKAGE__->_type_inspector($gen->isa);
if ($ti and $ti->{trust_mutated} eq 'always') {
return { code => '1;', env => {} };
}
if ($ti and $ti->{trust_mutated} eq 'maybe') {
my $coercion = ( $gen->coerce and $ti->{value_type}->has_coercion );
if ( $coercion ) {
my $env = {};
my $code = sprintf(
'my @shv_values = map { my $shv_value = $_; %s } %s;',
$gen->generate_type_assertion( $env, $ti->{value_type}, '$shv_value' ),
$gen->generate_args,
);
return {
code => $code,
env => $env,
arg => sub { "\$shv_values[($_[0])-1]" },
args => sub { '@shv_values' },
argc => sub { 'scalar(@shv_values)' },
};
}
else {
my $env = {};
my $code = sprintf(
'for my $shv_value (%s) { %s }',
$gen->generate_args,
$gen->generate_type_assertion( $env, $ti->{value_type}, '$shv_value' ),
);
return {
code => $code,
env => $env,
};
}
}
return;
};
my $additional_validation_for_set_and_insert = sub {
my $self = CORE::shift;
my ($sig_was_checked, $gen) = @_;
my $ti = __PACKAGE__->_type_inspector($gen->isa);
if ($ti and $ti->{trust_mutated} eq 'always') {
return { code => '1;', env => {} };
}
my ( $arg, $code, $env );
$env = {};
if ($ti and $ti->{trust_mutated} eq 'maybe') {
$arg = sub {
my $gen = CORE::shift;
return '$shv_index' if $_[0]=='1';
return '$shv_value' if $_[0]=='2';
$gen->generate_arg( @_ );
};
if ( $sig_was_checked ) {
$code = sprintf(
'my($shv_index,$shv_value)=%s; %s;',
$gen->generate_args,
$gen->generate_type_assertion( $env, $ti->{value_type}, '$shv_value' ),
);
}
else {
$code = sprintf(
'my($shv_index,$shv_value)=%s; %s; %s;',
$gen->generate_args,
$gen->generate_type_assertion( $env, Int, '$shv_index' ),
$gen->generate_type_assertion( $env, $ti->{value_type}, '$shv_value' ),
);
}
}
return {
code => $code,
env => $env,
arg => $arg,
};
};
sub count {
handler
name => 'Array:count',
args => 0,
template => 'scalar(@{$GET})',
documentation => 'The number of elements in the referenced array.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar' ] );\n",
" say \$object->$method; ## ==> 2\n",
"\n";
},
}
sub is_empty {
handler
name => 'Array:is_empty',
args => 0,
template => '!scalar(@{$GET})',
documentation => 'Boolean indicating if the referenced array is empty.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar' ] );\n",
" say \$object->$method; ## ==> false\n",
" \$object->_set_$attr( [] );\n",
" say \$object->$method; ## ==> true\n",
"\n";
},
}
sub all {
handler
name => 'Array:all',
args => 0,
template => '@{$GET}',
documentation => 'All elements in the array, in list context.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar' ] );\n",
" my \@list = \$object->$method;\n",
" say Dumper( \\\@list ); ## ==> [ 'foo', 'bar' ]\n",
"\n";
},
}
sub elements {
handler
name => 'Array:elements',
args => 0,
template => '@{$GET}',
documentation => 'All elements in the array, in list context. (Essentially the same as C<all>.)',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar' ] );\n",
" my \@list = \$object->$method;\n",
" say Dumper( \\\@list ); ## ==> [ 'foo', 'bar' ]\n",
"\n";
},
}
sub flatten {
handler
name => 'Array:flatten',
args => 0,
template => '@{$GET}',
documentation => 'All elements in the array, in list context. (Essentially the same as C<all>.)',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar' ] );\n",
" my \@list = \$object->$method;\n",
" say Dumper( \\\@list ); ## ==> [ 'foo', 'bar' ]\n",
"\n";
},
}
sub get {
handler
name => 'Array:get',
args => 1,
signature => [Int],
usage => '$index',
template => '($GET)->[$ARG]',
documentation => 'Returns a single element from the array by index.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" say \$object->$method( 0 ); ## ==> 'foo'\n",
" say \$object->$method( 1 ); ## ==> 'bar'\n",
" say \$object->$method( -1 ); ## ==> 'baz'\n",
"\n";
},
}
sub pop {
my $me = CORE::shift;
handler
name => 'Array:pop',
args => 0,
template => 'my @shv_tmp = @{$GET}; my $shv_return = pop @shv_tmp; «\\@shv_tmp»; $shv_return',
lvalue_template => 'pop(@{$GET})',
additional_validation => 'no incoming values',
documentation => 'Removes the last element from the array and returns it.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" say \$object->$method; ## ==> 'baz'\n",
" say \$object->$method; ## ==> 'bar'\n",
" say Dumper( \$object->$attr ); ## ==> [ 'foo' ]\n",
"\n";
},
}
sub push {
my $me = CORE::shift;
handler
name => 'Array:push',
usage => '@values',
template => 'my @shv_tmp = @{$GET}; my $shv_return = push(@shv_tmp, @ARG); «\\@shv_tmp»; $shv_return',
lvalue_template => 'push(@{$GET}, @ARG)',
prefer_shift_self => 1,
additional_validation => $additional_validation_for_push_and_unshift,
documentation => 'Adds elements to the end of the array.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo' ] );\n",
" \$object->$method( 'bar', 'baz' );\n",
" say Dumper( \$object->$attr ); ## ==> [ 'foo', 'bar', 'baz' ]\n",
"\n";
},
}
sub shift {
my $me = CORE::shift;
handler
name => 'Array:shift',
args => 0,
template => 'my @shv_tmp = @{$GET}; my $shv_return = shift @shv_tmp; «\\@shv_tmp»; $shv_return',
lvalue_template => 'shift(@{$GET})',
additional_validation => 'no incoming values',
documentation => 'Removes an element from the start of the array and returns it.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" say \$object->$method; ## ==> 'foo'\n",
" say \$object->$method; ## ==> 'bar'\n",
" say Dumper( \$object->$attr ); ## ==> [ 'baz' ]\n",
"\n";
},
}
sub unshift {
my $me = CORE::shift;
handler
name => 'Array:unshift',
usage => '@values',
template => 'my @shv_tmp = @{$GET}; my $shv_return = unshift(@shv_tmp, @ARG); «\\@shv_tmp»; $shv_return',
lvalue_template => 'unshift(@{$GET}, @ARG)',
prefer_shift_self => 1,
additional_validation => $additional_validation_for_push_and_unshift,
documentation => 'Adds an element to the start of the array.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo' ] );\n",
" \$object->$method( 'bar', 'baz' );\n",
" say Dumper( \$object->$attr ); ## ==> [ 'bar', 'baz', 'foo' ]\n",
"\n";
},
}
sub clear {
my $me = CORE::shift;
handler
name => 'Array:clear',
args => 0,
template => '«[]»',
lvalue_template => '@{$GET} = ()',
additional_validation => 'no incoming values',
documentation => 'Empties the array.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo' ] );\n",
" \$object->$method;\n",
" say Dumper( \$object->$attr ); ## ==> []\n",
"\n";
},
}
sub first {
require List::Util;
handler
name => 'Array:first',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => '&List::Util::first($ARG, @{$GET})',
documentation => 'Like C<< List::Util::first() >>.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" my \$found = \$object->$method( sub { /a/ } );\n",
" say \$found; ## ==> 'bar'\n",
"\n";
},
}
sub any {
require List::Util;
handler
name => 'Array:any',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => '&List::Util::any($ARG, @{$GET})',
documentation => 'Like C<< List::Util::any() >>.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" my \$truth = \$object->$method( sub { /a/ } );\n",
" say \$truth; ## ==> true\n",
"\n";
},
}
sub first_index {
my $me = __PACKAGE__;
handler
name => 'Array:first_index',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'for my $i ( 0 .. $#{$GET} ) { local *_ = \$GET->[$i]; return $i if $ARG->($_) }; return -1;',
documentation => 'Like C<< List::MoreUtils::first_index() >>.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" my \$found = \$object->$method( sub { /z\$/ } );\n",
" say \$found; ## ==> 2\n",
"\n";
},
}
sub reduce {
require List::Util;
handler
name => 'Array:reduce',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'my $shv_callback = $ARG; List::Util::reduce { $shv_callback->($a,$b) } @{$GET}',
documentation => 'Like C<< List::Util::reduce() >>.',
}
sub set {
my $me = CORE::shift;
handler
name => 'Array:set',
args => 2,
signature => [Int, Any],
usage => '$index, $value',
template => 'my @shv_tmp = @{$GET}; $shv_tmp[$ARG[1]] = $ARG[2]; «\\@shv_tmp»; $ARG[2]',
lvalue_template => '($GET)->[ $ARG[1] ] = $ARG[2]',
additional_validation => $additional_validation_for_set_and_insert,
documentation => 'Sets the element with the given index to the supplied value.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" \$object->$method( 1, 'quux' );\n",
" say Dumper( \$object->$attr ); ## ==> [ 'foo', 'quux', 'baz' ]\n",
"\n";
},
}
sub accessor {
handler
name => 'Array:accessor',
min_args => 1,
max_args => 2,
signature => [Int, Optional[Any]],
usage => '$index, $value?',
template => 'if (#ARG == 1) { ($GET)->[ $ARG[1] ] } else { my @shv_tmp = @{$GET}; $shv_tmp[$ARG[1]] = $ARG[2]; «\\@shv_tmp»; $ARG[2] }',
lvalue_template => '(#ARG == 1) ? ($GET)->[ $ARG[1] ] : (($GET)->[ $ARG[1] ] = $ARG[2])',
additional_validation => sub {
my $self = CORE::shift;
my ($sig_was_checked, $gen) = @_;
my $ti = __PACKAGE__->_type_inspector($gen->isa);
if ($ti and $ti->{trust_mutated} eq 'always') {
return { code => '1;', env => {} };
}
my ( $code, $env, $arg );
$env = {};
if ($ti and $ti->{trust_mutated} eq 'maybe') {
$arg = sub {
my $gen = CORE::shift;
return '$shv_index' if $_[0]=='1';
return '$shv_value' if $_[0]=='2';
$gen->generate_arg( @_ );
};
if ( $sig_was_checked ) {
$code = sprintf(
'my($shv_index,$shv_value)=%s; if (%s>1) { %s };',
$gen->generate_args,
$gen->generate_argc,
$gen->generate_type_assertion( $env, $ti->{value_type}, '$shv_value' ),
);
}
else {
$code = sprintf(
'my($shv_index,$shv_value)=%s; %s; if (%s>1) { %s };',
$gen->generate_args,
$gen->generate_type_assertion( $env, Int, '$shv_index' ),
$gen->generate_argc,
$gen->generate_type_assertion( $env, $ti->{value_type}, '$shv_value' ),
);
}
}
return {
code => $code,
env => $env,
arg => $arg,
};
},
documentation => 'Acts like C<get> if given just an index, or C<set> if given an index and value.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" \$object->$method( 1, 'quux' );\n",
" say Dumper( \$object->$attr ); ## ==> [ 'foo', 'quux', 'baz' ]\n",
" say \$object->$method( 2 ); ## ==> 'baz'\n",
"\n";
},
}
sub natatime {
my $me = __PACKAGE__;
handler
name => 'Array:natatime',
min_args => 1,
max_args => 2,
signature => [Int, Optional[CodeRef]],
usage => '$n, $callback?',
template => 'my @shv_remaining = @{$GET}; my $shv_n = $ARG[1]; my $shv_iterator = sub { CORE::splice @shv_remaining, 0, $shv_n }; if ($ARG[2]) { while (my @shv_values = $shv_iterator->()) { $ARG[2]->(@shv_values) } } else { $shv_iterator }',
documentation => 'Given just a number, returns an iterator which reads that many elements from the array at a time. If also given a callback, calls the callback repeatedly with those values.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" my \$iter = \$object->$method( 2 );\n",
" say Dumper( [ \$iter->() ] ); ## ==> [ 'foo', 'bar' ]\n",
" say Dumper( [ \$iter->() ] ); ## ==> [ 'baz' ]\n",
"\n";
},
}
sub shallow_clone {
handler
name => 'Array:shallow_clone',
args => 0,
template => '[@{$GET}]',
documentation => 'Creates a new arrayref with the same elements as the original.',
}
sub map {
handler
name => 'Array:map',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'map($ARG->($_), @{$GET})',
documentation => 'Like C<map> from L<perlfunc>.',
}
sub grep {
handler
name => 'Array:grep',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'grep($ARG->($_), @{$GET})',
documentation => 'Like C<grep> from L<perlfunc>.',
}
sub sort {
handler
name => 'Array:sort',
min_args => 0,
max_args => 1,
signature => [Optional[CodeRef]],
usage => '$coderef?',
template => 'my @shv_return = $ARG ? (sort {$ARG->($a,$b)} @{$GET}) : (sort @{$GET})',
documentation => 'Like C<sort> from L<perlfunc>.',
}
sub reverse {
handler
name => 'Array:reverse',
args => 0,
template => 'reverse @{$GET}',
documentation => 'Returns the reversed array in list context.',
}
sub sort_in_place {
handler
name => 'Array:sort_in_place',
min_args => 0,
max_args => 1,
signature => [Optional[CodeRef]],
usage => '$coderef?',
template => 'my @shv_return = $ARG ? (sort {$ARG->($a,$b)} @{$GET}) : (sort @{$GET}); «\@shv_return»',
additional_validation => 'no incoming values',
documentation => 'Like C<sort> from L<perlfunc>, but changes the attribute to point to the newly sorted array.',
}
sub shuffle {
require List::Util;
handler
name => 'Array:shuffle',
args => 0,
template => 'my @shv_return = List::Util::shuffle(@{$GET}); wantarray ? @shv_return : \@shv_return',
documentation => 'Returns the array in a random order; can be called in list context or scalar context and will return an arrayref in the latter case.',
}
sub shuffle_in_place {
require List::Util;
handler
name => 'Array:shuffle_in_place',
args => 0,
template => 'my @shv_return = List::Util::shuffle(@{$GET}); «\@shv_return»',
additional_validation => 'no incoming values',
documentation => 'Rearranges the array in a random order, and changes the attribute to point to the new order.',
}
sub uniq {
require List::Util;
handler
name => 'Array:uniq',
args => 0,
template => 'my @shv_return = List::Util::uniq(@{$GET}); wantarray ? @shv_return : \@shv_return',
documentation => 'Returns the array filtered to remove duplicates; can be called in list context or scalar context and will return an arrayref in the latter case.',
}
sub uniq_in_place {
require List::Util;
handler
name => 'Array:uniq_in_place',
args => 0,
template => 'my @shv_return = List::Util::uniq(@{$GET}); «\@shv_return»',
additional_validation => 'no incoming values',
documentation => 'Filters the array to remove duplicates, and changes the attribute to point to the filtered array.',
}
sub uniqnum {
require List::Util;
handler
name => 'Array:uniqnum',
args => 0,
template => 'my @shv_return = List::Util::uniqnum(@{$GET}); wantarray ? @shv_return : \@shv_return',
documentation => 'Returns the array filtered to remove duplicates numerically; can be called in list context or scalar context and will return an arrayref in the latter case.',
}
sub uniqnum_in_place {
require List::Util;
handler
name => 'Array:uniqnum_in_place',
args => 0,
template => 'my @shv_return = List::Util::uniqnum(@{$GET}); «\@shv_return»',
additional_validation => 'no incoming values',
documentation => 'Filters the array to remove duplicates numerically, and changes the attribute to point to the filtered array.',
}
sub uniqstr {
require List::Util;
handler
name => 'Array:uniqstr',
args => 0,
template => 'my @shv_return = List::Util::uniqstr(@{$GET}); wantarray ? @shv_return : \@shv_return',
documentation => 'Returns the array filtered to remove duplicates stringwise; can be called in list context or scalar context and will return an arrayref in the latter case.',
}
sub uniqstr_in_place {
require List::Util;
handler
name => 'Array:uniqstr_in_place',
args => 0,
template => 'my @shv_return = List::Util::uniqstr(@{$GET}); «\@shv_return»',
additional_validation => 'no incoming values',
documentation => 'Filters the array to remove duplicates stringwise, and changes the attribute to point to the filtered array.',
}
sub splice {
handler
name => 'Array:splice',
min_args => 1,
usage => '$index, $length, @values',
template => 'my @shv_tmp = @{$GET}; my ($shv_index, $shv_length, @shv_values) = @ARG;defined($shv_index) or $shv_index=0; defined($shv_length) or $shv_length=0; my @shv_return = splice(@shv_tmp, $shv_index, $shv_length, @shv_values); «\\@shv_tmp»; wantarray ? @shv_return : $shv_return[-1]',
lvalue_template => 'my ($shv_index, $shv_length, @shv_values) = @ARG;splice(@{$GET}, $shv_index, $shv_length, @shv_values)',
additional_validation => sub {
my $self = CORE::shift;
my ($sig_was_checked, $gen) = @_;
my $env = {};
my $code = sprintf 'if (%s >= 1) { %s }; if (%s >= 2) { %s };',
$gen->generate_argc,
$gen->generate_type_assertion( $env, Int, $gen->generate_arg( 1 ) ),
$gen->generate_argc,
$gen->generate_type_assertion( $env, Int, $gen->generate_arg( 2 ) );
my $ti = __PACKAGE__->_type_inspector($gen->isa);
if ($ti and $ti->{trust_mutated} eq 'always') {
return { code => $code, env => $env };
}
if ($ti and $ti->{trust_mutated} eq 'maybe') {
my $coercion = ( $gen->coerce and $ti->{value_type}->has_coercion );
if ( $coercion ) {
$code .= sprintf(
'my @shv_unprocessed=%s;my @shv_processed=splice(@shv_unprocessed,0,2); push @shv_processed, map { my $shv_value = $_; %s } @shv_unprocessed;',
$gen->generate_args,
$gen->generate_type_assertion( $env, $ti->{value_type}, '$shv_value' ),
);
}
else {
$code .= sprintf(
'my @shv_unprocessed=%s;my @shv_processed=splice(@shv_unprocessed,0,2);for my $shv_value (@shv_unprocessed) { %s };push @shv_processed, @shv_unprocessed;',
$gen->generate_args,
$gen->generate_type_assertion( $env, $ti->{value_type}, '$shv_value' ),
);
}
return {
code => $code,
env => $env,
arg => sub { "\$shv_processed[($_[0])-1]" },
args => sub { '@shv_processed' },
argc => sub { 'scalar(@shv_processed)' },
};
}
return { code => $code, env => $env, final_type_check_needed => !!1 };
},
documentation => 'Like C<splice> from L<perlfunc>.',
}
sub delete {
handler
name => 'Array:delete',
args => 1,
signature => [Int],
usage => '$index',
template => 'my @shv_tmp = @{$GET}; my ($shv_return) = splice(@shv_tmp, $ARG, 1); «\\@shv_tmp»; $shv_return',
lvalue_template => 'splice(@{$GET}, $ARG, 1)',
additional_validation => 'no incoming values',
documentation => 'Removes the indexed element from the array and returns it. Elements after it will be "moved up".',
}
sub insert {
my $me = CORE::shift;
handler
name => 'Array:insert',
args => 2,
signature => [Int, Any],
usage => '$index, $value',
template => 'my @shv_tmp = @{$GET}; my ($shv_return) = splice(@shv_tmp, $ARG[1], 0, $ARG[2]); «\\@shv_tmp»;',
lvalue_template => 'splice(@{$GET}, $ARG[1], 0, $ARG[2])',
additional_validation => $additional_validation_for_set_and_insert,
documentation => 'Inserts a value into the array with the given index. Elements after it will be "moved down".',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" \$object->$method( 1, 'quux' );\n",
" say Dumper( \$object->$attr ); ## ==> [ 'foo', 'quux', 'bar', 'baz' ]\n",
"\n";
},
}
sub flatten_deep {
my $me = __PACKAGE__;
handler
name => 'Array:flatten_deep',
min_args => 0,
max_args => 1,
signature => [Optional[Int]],
usage => '$depth?',
template => 'my $shv_fd; $shv_fd = sub { my $d=pop; --$d if defined $d; map ref() eq "ARRAY" ? (defined $d && $d < 0) ? $_ : $shv_fd->(@$_, $d) : $_, @_ }; $shv_fd->(@{$GET}, $ARG)',
documentation => 'Flattens the arrayref into a list, including any nested arrayrefs. (Has the potential to loop infinitely.)',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', [ 'bar', [ 'baz' ] ] ] );\n",
" say Dumper( [ \$object->$method ] ); ## ==> [ 'foo', 'bar', 'baz' ]\n",
"\n",
" my \$object2 = $class\->new( $attr => [ 'foo', [ 'bar', [ 'baz' ] ] ] );\n",
" say Dumper( [ \$object->$method(1) ] ); ## ==> [ 'foo', 'bar', [ 'baz' ] ]\n",
"\n";
},
}
sub join {
handler
name => 'Array:join',
min_args => 0,
max_args => 1,
signature => [Optional[Str]],
usage => '$with?',
template => 'my $shv_param_with = #ARG ? $ARG : q[,]; join($shv_param_with, @{$GET})',
documentation => 'Returns a string joining all the elements in the array; if C<< $with >> is omitted, defaults to a comma.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" say \$object->$method; ## ==> 'foo,bar,baz'\n",
" say \$object->$method( '|' ); ## ==> 'foo|bar|baz'\n",
"\n";
},
}
sub print {
handler
name => 'Array:print',
min_args => 0,
max_args => 2,
signature => [Optional[FileHandle], Optional[Str]],
usage => '$fh?, $with?',
template => 'my $shv_param_with = (#ARG>1) ? $ARG[2] : q[,]; print {$ARG[1]||*STDOUT} join($shv_param_with, @{$GET})',
documentation => 'Prints a string joining all the elements in the array; if C<< $fh >> is omitted, defaults to STDOUT; if C<< $with >> is omitted, defaults to a comma.',
}
sub head {
handler
name => 'Array:head',
args => 1,
signature => [Int],
usage => '$count',
template => 'my $shv_count=$ARG; $shv_count=@{$GET} if $shv_count>@{$GET}; $shv_count=@{$GET}+$shv_count if $shv_count<0; (@{$GET})[0..($shv_count-1)]',
documentation => 'Returns the first C<< $count >> elements of the array in list context.',
}
sub tail {
handler
name => 'Array:tail',
args => 1,
signature => [Int],
usage => '$count',
template => 'my $shv_count=$ARG; $shv_count=@{$GET} if $shv_count>@{$GET}; $shv_count=@{$GET}+$shv_count if $shv_count<0; my $shv_start = scalar(@{$GET})-$shv_count; my $shv_end = scalar(@{$GET})-1; (@{$GET})[$shv_start..$shv_end]',
documentation => 'Returns the last C<< $count >> elements of the array in list context.',
}
sub apply {
handler
name => 'Array:apply',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'my @shv_tmp = @{$GET}; &{$ARG} foreach @shv_tmp; wantarray ? @shv_tmp : $shv_tmp[-1]',
documentation => 'Executes the coderef (which should modify C<< $_ >>) against each element of the array; returns the resulting array in list context.',
}
sub pick_random {
require List::Util;
handler
name => 'Array:pick_random',
min_args => 0,
max_args => 1,
signature => [Optional[Int]],
usage => '$count',
template => 'my @shv_tmp = List::Util::shuffle(@{$GET}); my $shv_count = $ARG; $shv_count=@{$GET} if $shv_count > @{$GET}; $shv_count=@{$GET}+$shv_count if $shv_count<0; if (wantarray and #ARG) { @shv_tmp[0..$shv_count-1] } elsif (#ARG) { [@shv_tmp[0..$shv_count-1]] } else { $shv_tmp[0] }',
documentation => 'If no C<< $count >> is given, returns one element of the array at random. If C<< $count >> is given, creates a new array with that many random elements from the original array (or fewer if the original array is not long enough) and returns that as an arrayref or list depending on context',
}
sub for_each {
handler
name => 'Array:for_each',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'my $shv_tmp = $GET; { local $_; foreach my $shv_index (0 .. $#{$shv_tmp}) { &{$ARG}($_ = $shv_tmp->[$shv_index], $shv_index) }; } $SELF',
documentation => 'Chainable method which executes the coderef on each element of the array. The coderef will be passed two values: the element and its index. The element will also be available as C<< $_ >>.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" \$object->$method( sub { say \"Item \$_[1] is \$_[0].\" } );\n",
"\n";
},
}
sub for_each_pair {
handler
name => 'Array:for_each_pair',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'for (my $shv_index=0; $shv_index<@{$GET}; $shv_index+=2) { &{$ARG}(($GET)->[$shv_index], ($GET)->[$shv_index+1]) }; $SELF',
documentation => 'Chainable method which executes the coderef on each pair of elements in the array. The coderef will be passed the two elements.',
}
sub all_true {
require List::Util;
handler
name => 'Array:all_true',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => '&List::Util::all($ARG, @{$GET})',
documentation => 'Like C<< List::Util::all() >>.',
}
sub not_all_true {
require List::Util;
handler
name => 'Array:not_all_true',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => '&List::Util::notall($ARG, @{$GET})',
documentation => 'Like C<< List::Util::notall() >>.',
}
sub min {
require List::Util;
handler
name => 'Array:min',
args => 0,
template => '&List::Util::min(@{$GET})',
documentation => 'Like C<< List::Util::min() >>.',
}
sub max {
require List::Util;
handler
name => 'Array:max',
args => 0,
template => '&List::Util::max(@{$GET})',
documentation => 'Like C<< List::Util::max() >>.',
}
sub minstr {
require List::Util;
handler
name => 'Array:minstr',
args => 0,
template => '&List::Util::minstr(@{$GET})',
documentation => 'Like C<< List::Util::minstr() >>.',
}
sub maxstr {
require List::Util;
handler
name => 'Array:maxstr',
args => 0,
template => '&List::Util::maxstr(@{$GET})',
documentation => 'Like C<< List::Util::maxstr() >>.',
}
sub sum {
require List::Util;
handler
name => 'Array:sum',
args => 0,
template => '&List::Util::sum(0, @{$GET})',
documentation => 'Like C<< List::Util::sum0() >>.',
}
sub product {
require List::Util;
handler
name => 'Array:product',
args => 0,
template => '&List::Util::product(1, @{$GET})',
documentation => 'Like C<< List::Util::product() >>.',
}
sub sample {
require List::Util;
handler
name => 'Array:sample',
args => 1,
signature => [Int],
usage => '$count',
template => '&List::Util::sample($ARG, @{$GET})',
documentation => 'Like C<< List::Util::sample() >>.',
}
sub reductions {
require List::Util;
handler
name => 'Array:reductions',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'my $shv_callback = $ARG; List::Util::reductions { $shv_callback->($a,$b) } @{$GET}',
documentation => 'Like C<< List::Util::reductions() >>.',
}
sub pairs {
require List::Util;
handler
name => 'Array:pairs',
args => 0,
template => '&List::Util::pairs(@{$GET})',
documentation => 'Like C<< List::Util::pairs() >>.',
}
sub pairkeys {
require List::Util;
handler
name => 'Array:pairkeys',
args => 0,
template => '&List::Util::pairkeys(@{$GET})',
documentation => 'Like C<< List::Util::pairkeys() >>.',
}
sub pairvalues {
require List::Util;
handler
name => 'Array:pairvalues',
args => 0,
template => '&List::Util::pairvalues(@{$GET})',
documentation => 'Like C<< List::Util::pairvalues() >>.',
}
sub pairgrep {
require List::Util;
handler
name => 'Array:pairgrep',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'List::Util::pairgrep { $ARG->($_) } @{$GET}',
documentation => 'Like C<< List::Util::pairgrep() >>.',
}
sub pairfirst {
require List::Util;
handler
name => 'Array:pairfirst',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'List::Util::pairfirst { $ARG->($_) } @{$GET}',
documentation => 'Like C<< List::Util::pairfirst() >>.',
}
sub pairmap {
require List::Util;
handler
name => 'Array:pairmap',
args => 1,
signature => [CodeRef],
usage => '$coderef',
template => 'List::Util::pairmap { $ARG->($_) } @{$GET}',
documentation => 'Like C<< List::Util::pairmap() >>.',
}
sub reset {
handler
name => 'Array:reset',
args => 0,
template => '« $DEFAULT »',
default_for_reset => sub { '[]' },
documentation => 'Resets the attribute to its default value, or an empty arrayref if it has no default.',
_examples => sub {
my ( $class, $attr, $method ) = @_;
return CORE::join "",
" my \$object = $class\->new( $attr => [ 'foo', 'bar', 'baz' ] );\n",
" \$object->$method;\n",
" say Dumper( \$object->$attr ); ## ==> []\n",
"\n";
},
}
sub indexed {
handler
name => 'Array:indexed',
args => 0,
template => 'my $shv_ix = 0; map +($shv_ix++, $_), @{$GET}',
documentation => 'Like C<indexed> from L<builtin>.',
}
1;
|