/usr/share/perl5/Template/Alloy/VMethod.pm is in libtemplate-alloy-perl 1.020-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 | package Template::Alloy::VMethod;
=head1 NAME
Template::Alloy::VMethod - VMethod role.
=cut
use strict;
use warnings;
use Template::Alloy;
use base qw(Exporter);
our @EXPORT_OK = qw(define_vmethod
$ITEM_OPS $ITEM_METHODS
$SCALAR_OPS
$LIST_OPS $LIST_METHODS
$HASH_OPS
$FILTER_OPS
$VOBJS);
sub new { die "This class is a role for use by packages such as Template::Alloy" }
###----------------------------------------------------------------###
our ($JSON, $JSONP);
sub json { $JSON ||= do { require JSON; JSON->new->utf8->allow_nonref->allow_unknown->allow_blessed->convert_blessed->canonical } }
sub jsonp { $JSONP ||= do { require JSON; JSON->new->utf8->allow_nonref->allow_unknown->allow_blessed->convert_blessed->canonical->pretty } }
our $SCALAR_OPS = our $ITEM_OPS = {
'0' => sub { $_[0] },
abs => sub { no warnings; abs shift },
atan2 => sub { no warnings; atan2($_[0], $_[1]) },
chunk => \&vmethod_chunk,
collapse => sub { local $_ = $_[0]; s/^\s+//; s/\s+$//; s/\s+/ /g; $_ },
cos => sub { no warnings; cos $_[0] },
defined => sub { defined $_[0] ? 1 : '' },
dquote => sub { local $_ = $_[0]; return if ! $_; s/([\"\\])/\\$1/g; s/\n/\\n/g; $_ },
exp => sub { no warnings; exp $_[0] },
fmt => \&vmethod_fmt_scalar,
'format' => \&vmethod_format,
hash => sub { {value => $_[0]} },
hex => sub { no warnings; hex $_[0] },
html => sub { local $_ = $_[0]; return $_ if ! $_; s/&/&/g; s/</</g; s/>/>/g; s/\"/"/g; $_ },
indent => \&vmethod_indent,
int => sub { no warnings; int $_[0] },
item => sub { $_[0] },
js => sub { local $_ = $_[0]; return if ! $_; s/\n/\\n/g; s/\r/\\r/g; s/(?<!\\)([\"\'])/\\$1/g; $_ },
json => sub { return json()->encode($_[0]) if ! $_[1]; my $j = jsonp()->encode($_[0]); chomp $j; $j },
lc => sub { lc $_[0] },
lcfirst => sub { lcfirst $_[0] },
length => sub { defined($_[0]) ? length($_[0]) : 0 },
list => sub { [$_[0]] },
log => sub { no warnings; log $_[0] },
lower => sub { lc $_[0] },
match => \&vmethod_match,
new => sub { defined $_[0] ? $_[0] : '' },
none => sub { $_[0] },
null => sub { '' },
oct => sub { no warnings; oct $_[0] },
print => sub { no warnings; "@_" },
rand => sub { no warnings; rand shift },
remove => sub { vmethod_replace(shift, shift, '', 1) },
repeat => \&vmethod_repeat,
replace => \&vmethod_replace,
'return' => \&vmethod_return,
search => sub { my ($str, $pat) = @_; return $str if ! defined $str || ! defined $pat; return $str =~ /$pat/ },
sin => sub { no warnings; sin $_[0] },
size => sub { 1 },
split => \&vmethod_split,
sprintf => sub { no warnings; my $pat = shift; sprintf($pat, @_) },
sqrt => sub { no warnings; sqrt $_[0] },
squote => sub { local $_ = $_[0]; return if ! $_; s/([\'\\])/\\$1/g; $_ },
srand => sub { no warnings; srand $_[0]; '' },
stderr => sub { print STDERR $_[0]; '' },
substr => \&vmethod_substr,
trim => sub { local $_ = $_[0]; s/^\s+//; s/\s+$//; $_ },
uc => sub { uc $_[0] },
ucfirst => sub { ucfirst $_[0] },
upper => sub { uc $_[0] },
uri => \&vmethod_uri,
url => \&vmethod_url,
xml => sub { local $_ = $_[0]; s/&/&/g; s/</</g; s/>/>/g; s/\"/"/g; s/\'/'/g; $_ },
};
our $ITEM_METHODS = {
eval => \&Template::Alloy::item_method_eval,
evaltt => \&Template::Alloy::item_method_eval,
file => \&item_method_redirect,
redirect => \&item_method_redirect,
block_exists => sub { defined($_[1]) && UNIVERSAL::isa($_[0], 'HASH') && $_[0]->{'BLOCKS'} && exists($_[0]->{'BLOCKS'}->{$_[1]}) || 0 },
};
our $FILTER_OPS = {}; # generally - non-dynamic filters belong in scalar ops
our $LIST_OPS = {
defined => sub { return 1 if @_ == 1; defined $_[0]->[ defined($_[1]) ? $_[1] : 0 ] },
first => sub { my ($ref, $i) = @_; return $ref->[0] if ! $i; return [@{$ref}[0 .. $i - 1]]},
fmt => \&vmethod_fmt_list,
grep => sub { no warnings; my ($ref, $pat) = @_; UNIVERSAL::isa($pat, 'CODE') ? [grep {$pat->($_)} @$ref] : [grep {/$pat/} @$ref] },
hash => sub { no warnings; my $list = shift; return {@$list} if ! @_; my $i = shift || 0; return {map {$i++ => $_} @$list} },
import => sub { my $ref = shift; push @$ref, grep {defined} map {ref eq 'ARRAY' ? @$_ : undef} @_; '' },
item => sub { $_[0]->[ $_[1] || 0 ] },
join => sub { my ($ref, $join) = @_; $join = ' ' if ! defined $join; no warnings; return join $join, @$ref },
json => sub { return json()->encode($_[0]) if ! $_[1]; my $j = jsonp()->encode($_[0]); chomp $j; $j },
last => sub { my ($ref, $i) = @_; return $ref->[-1] if ! $i; return [@{$ref}[-$i .. -1]]},
list => sub { $_[0] },
map => sub { no warnings; my ($ref, $code) = @_; UNIVERSAL::isa($code, 'CODE') ? [map {$code->($_)} @$ref] : [map {$code} @$ref] },
max => sub { no warnings; $#{ $_[0] } },
merge => sub { my $ref = shift; return [ @$ref, grep {defined} map {ref eq 'ARRAY' ? @$_ : undef} @_ ] },
new => sub { no warnings; return [@_] },
null => sub { '' },
nsort => \&vmethod_nsort,
pick => \&vmethod_pick,
pop => sub { pop @{ $_[0] } },
push => sub { my $ref = shift; push @$ref, @_; return '' },
'return' => \&vmethod_return,
reverse => sub { [ reverse @{ $_[0] } ] },
shift => sub { shift @{ $_[0] } },
size => sub { no warnings; scalar @{ $_[0] } },
slice => sub { my ($ref, $a, $b) = @_; $a ||= 0; $b = $#$ref if ! defined $b; return [@{$ref}[$a .. $b]] },
sort => \&vmethod_sort,
splice => \&vmethod_splice,
unique => sub { my %u; return [ grep { ! $u{$_}++ } @{ $_[0] } ] },
unshift => sub { my $ref = shift; unshift @$ref, @_; return '' },
};
our $LIST_METHODS = {
};
our $HASH_OPS = {
defined => sub { return 1 if @_ == 1; defined $_[0]->{ defined($_[1]) ? $_[1] : '' } },
delete => sub { my $h = shift; delete @{ $h }{map {defined($_) ? $_ : ''} @_}; '' },
each => sub { [%{ $_[0] }] },
exists => sub { exists $_[0]->{ defined($_[1]) ? $_[1] : '' } },
fmt => \&vmethod_fmt_hash,
hash => sub { $_[0] },
import => sub { my ($a, $b) = @_; @{$a}{keys %$b} = values %$b if ref($b) eq 'HASH'; '' },
item => sub { my ($h, $k) = @_; $k = '' if ! defined $k; $Template::Alloy::QR_PRIVATE && $k =~ $Template::Alloy::QR_PRIVATE ? undef : $h->{$k} },
items => sub { [ %{ $_[0] } ] },
json => sub { return json()->encode($_[0]) if ! $_[1]; my $j = jsonp()->encode($_[0]); chomp $j; $j },
keys => sub { [keys %{ $_[0] }] },
list => \&vmethod_list_hash,
new => sub { no warnings; return (@_ == 1 && ref $_[-1] eq 'HASH') ? $_[-1] : {@_} },
null => sub { '' },
nsort => sub { my $ref = shift; [sort { $ref->{$a} <=> $ref->{$b}} keys %$ref] },
pairs => sub { [map { {key => $_, value => $_[0]->{$_}} } sort keys %{ $_[0] } ] },
'return' => \&vmethod_return,
size => sub { scalar keys %{ $_[0] } },
sort => sub { my $ref = shift; [sort {lc $ref->{$a} cmp lc $ref->{$b}} keys %$ref] },
values => sub { [values %{ $_[0] }] },
};
our $VOBJS = {
Text => $SCALAR_OPS,
List => $LIST_OPS,
Hash => $HASH_OPS,
};
foreach (values %$VOBJS) {
$_->{'Text'} = $_->{'fmt'};
$_->{'Hash'} = $_->{'hash'};
$_->{'List'} = $_->{'list'};
}
###----------------------------------------------------------------###
### long virtual methods or filters
### many of these vmethods have used code from Template/Stash.pm to
### assure conformance with the TT spec.
sub define_vmethod {
my ($self, $type, $name, $sub) = @_;
if ( $type =~ /scalar|item|text/i) { $SCALAR_OPS->{$name} = $sub }
elsif ($type =~ /array|list/i ) { $LIST_OPS->{ $name} = $sub }
elsif ($type =~ /hash/i ) { $HASH_OPS->{ $name} = $sub }
elsif ($type =~ /filter/i ) { $FILTER_OPS->{$name} = $sub }
else { die "Invalid type vmethod type $type" }
return 1;
}
sub vmethod_fmt_scalar {
my $str = shift; $str = '' if ! defined $str;
my $pat = shift; $pat = '%s' if ! defined $pat;
no warnings;
return @_ ? sprintf($pat, $_[0], $str)
: sprintf($pat, $str);
}
sub vmethod_fmt_list {
my $ref = shift || return '';
my $pat = shift; $pat = '%s' if ! defined $pat;
my $sep = shift; $sep = ' ' if ! defined $sep;
no warnings;
return @_ ? join($sep, map {sprintf $pat, $_[0], $_} @$ref)
: join($sep, map {sprintf $pat, $_} @$ref);
}
sub vmethod_fmt_hash {
my $ref = shift || return '';
my $pat = shift; $pat = "%s\t%s" if ! defined $pat;
my $sep = shift; $sep = "\n" if ! defined $sep;
no warnings;
return ! @_ ? join($sep, map {sprintf $pat, $_, $ref->{$_}} sort keys %$ref)
: @_ == 1 ? join($sep, map {sprintf $pat, $_[0], $_, $ref->{$_}} sort keys %$ref) # don't get to pick - it applies to the key
: join($sep, map {sprintf $pat, $_[0], $_, $_[1], $ref->{$_}} sort keys %$ref);
}
sub vmethod_chunk {
my $str = shift;
my $size = shift || 1;
my @list;
if ($size < 0) { # chunk from the opposite end
$str = reverse $str;
$size = -$size;
unshift(@list, scalar reverse $1) while $str =~ /( .{$size} | .+ )/xg;
} else {
push(@list, $1) while $str =~ /( .{$size} | .+ )/xg;
}
return \@list;
}
sub vmethod_indent {
my $str = shift; $str = '' if ! defined $str;
my $pre = shift; $pre = 4 if ! defined $pre;
$pre = ' ' x $pre if $pre =~ /^\d+$/;
$str =~ s/^/$pre/mg;
return $str;
}
sub vmethod_format {
my $str = shift; $str = '' if ! defined $str;
my $pat = shift; $pat = '%s' if ! defined $pat;
if (@_) {
return join "\n", map{ sprintf $pat, $_[0], $_ } split(/\n/, $str);
} else {
return join "\n", map{ sprintf $pat, $_ } split(/\n/, $str);
}
}
sub vmethod_list_hash {
my ($hash, $what) = @_;
$what = 'pairs' if ! $what || $what !~ /^(keys|values|each|pairs)$/;
return $HASH_OPS->{$what}->($hash);
}
sub vmethod_match {
my ($str, $pat, $global) = @_;
return [] if ! defined $str || ! defined $pat;
my @res = $global ? ($str =~ /$pat/g) : ($str =~ /$pat/);
return @res ? \@res : '';
}
sub vmethod_nsort {
my ($list, $field) = @_;
return defined($field)
? [map {$_->[0]} sort {$a->[1] <=> $b->[1]} map {[$_, (ref $_ eq 'HASH' ? $_->{$field}
: UNIVERSAL::can($_, $field) ? $_->$field()
: $_)]} @$list ]
: [sort {$a <=> $b} @$list];
}
sub vmethod_pick {
my $ref = shift;
no warnings;
my $n = int(shift);
$n = 1 if $n < 1;
my @ind = map { $ref->[ rand @$ref ] } 1 .. $n;
return $n == 1 ? $ind[0] : \@ind;
}
sub vmethod_repeat {
my ($str, $n, $join) = @_;
return '' if ! defined $str || ! length $str;
$n = 1 if ! defined($n) || ! length $n;
$join = '' if ! defined $join;
return join $join, ($str) x $n;
}
### This method is a combination of my submissions along
### with work from Andy Wardley, Sergey Martynoff, Nik Clayton, and Josh Rosenbaum
sub vmethod_replace {
my ($text, $pattern, $replace, $global) = @_;
$text = '' unless defined $text;
$pattern = '' unless defined $pattern;
$replace = '' unless defined $replace;
$global = 1 unless defined $global;
my $expand = sub {
my ($chunk, $start, $end) = @_;
$chunk =~ s{ \\(\\|\$) | \$ (\d+) }{
$1 ? $1
: ($2 > $#$start || $2 == 0) ? ''
: substr($text, $start->[$2], $end->[$2] - $start->[$2]);
}exg;
$chunk;
};
if ($global) {
$text =~ s{$pattern}{ $expand->($replace, [@-], [@+]) }eg;
} else {
$text =~ s{$pattern}{ $expand->($replace, [@-], [@+]) }e;
}
return $text;
}
sub vmethod_return {
my $obj = shift;
Template::Alloy->throw('return', {return_val => $obj});
}
sub vmethod_sort {
my ($list, $field) = @_;
if (! defined $field) {
return [map {$_->[0]} sort {$a->[1] cmp $b->[1]} map {[$_, lc $_]} @$list ]; # case insensitive
} elsif (UNIVERSAL::isa($field, 'CODE')) {
return [sort {int($field->($a, $b))} @$list];
} else {
return [map {$_->[0]} sort {$a->[1] cmp $b->[1]} map {[$_, lc(ref $_ eq 'HASH' ? $_->{$field}
: UNIVERSAL::can($_, $field) ? $_->$field()
: $_)]} @$list ];
}
}
sub vmethod_splice {
my ($ref, $i, $len, @replace) = @_;
@replace = @{ $replace[0] } if @replace == 1 && ref $replace[0] eq 'ARRAY';
if (defined $len) {
return [splice @$ref, $i || 0, $len, @replace];
} elsif (defined $i) {
return [splice @$ref, $i];
} else {
return [splice @$ref];
}
}
sub vmethod_split {
my ($str, $pat, $lim) = @_;
$str = '' if ! defined $str;
if (defined $lim) { return defined $pat ? [split $pat, $str, $lim] : [split ' ', $str, $lim] }
else { return defined $pat ? [split $pat, $str ] : [split ' ', $str ] }
}
sub vmethod_substr {
my ($str, $i, $len, $replace) = @_;
$i ||= 0;
return '' if ! defined $str;
return substr($str, $i) if ! defined $len;
return substr($str, $i, $len) if ! defined $replace;
substr($str, $i, $len, $replace);
return $str;
}
sub vmethod_uri {
my $str = shift;
return '' if ! defined $str;
utf8::upgrade($str) if defined &utf8::upgrade;
$str =~ s/([^A-Za-z0-9\-_.!~*\'()])/sprintf('%%%02X', ord($1))/eg;
return $str;
}
sub vmethod_url {
my $str = shift;
return '' if ! defined $str;
utf8::upgrade($str) if defined &utf8::upgrade;
$str =~ s/([^;\/?:@&=+\$,A-Za-z0-9\-_.!~*\'()])/sprintf('%%%02X', ord($1))/eg;
return $str;
}
sub item_method_redirect {
my ($t, $text, $file, $options) = @_;
my $path = $t->{'OUTPUT_PATH'} || $t->throw('redirect', 'OUTPUT_PATH is not set');
$t->throw('redirect', 'Invalid filename - cannot include "/../"')
if $file =~ m{(^|/)\.\./};
if (! -d $path) {
require File::Path;
File::Path::mkpath($path) || $t->throw('redirect', "Couldn't mkpath \"$path\": $!");
}
open (my $fh, '>', "$path/$file") || $t->throw('redirect', "Couldn't open \"$file\": $!");
if (my $bm = (! $options) ? 0 : ref($options) ? $options->{'binmode'} : $options) {
if (+$bm == 1) { binmode $fh }
else { binmode $fh, $bm}
}
print $fh $text;
return '';
}
###----------------------------------------------------------------###
1;
__END__
=head1 DESCRIPTION
The Template::Alloy::VMethod role provides all of the extra vmethods,
filters, and virtual objects that add to the base feature set of
Template::Alloy. Most of the vmethods listed here are similar to
those provided by Template::Toolkit. We will try to keep
Template::Alloy's in sync. Template::Alloy also provides several
extra methods that are needed for HTML::Template::Expr support.
=head1 ROLE METHODS
=over 4
=item define_vmethod
Defines a vmethod. See L<Template::Alloy> for more details.
=item C<vmethod_*>
Methods by these names implement virtual methods that are more complex
than oneliners. These methods are not exposed via the role.
=item C<filter_*>
Methods by these names implement filters that are more complex than
one liners. These methods are not exposed via the role.
=back
=head1 VIRTUAL METHOD LIST
The following is the list of builtin virtual methods and filters that
can be called on each type of data.
In Template::Alloy, the "|" operator can be used to call virtual
methods just the same way that the "." operator can. The main
difference between the two is that on access to hashrefs or objects,
the "|" means to always call the virtual method or filter rather than
looking in the hashref for a key by that name, or trying to call that
method on the object. This is similar to how TT3 will function.
Virtual methods are also made available via Virtual Objects which
are discussed in a later section.
=head2 SCALAR VIRTUAL METHODS AND FILTERS
The following is the list of builtin virtual methods and filters that
can be called on scalar data types. In Alloy and TT3, filters and
virtual methods are more closely related than in TT2. In general
anywhere a virtual method can be used a filter can be used also - and
likewise all scalar virtual methods can be used as filters.
In addition to the filters listed below, Alloy will automatically load
Template::Filters and use them if Template::Toolkit is installed.
In addition to the scalar virtual methods, any scalar will be
automatically converted to a single item list if a list virtual method
is called on it.
Scalar virtual methods are also available through the "Text" virtual
object (except for true filters such as eval and redirect).
All scalar virtual methods are available as top level functions as well.
This is not true of TT2. In Template::Alloy the following are equivalent:
[% "abc".length %]
[% length("abc") %]
You may set VMETHOD_FUNCTIONS to 0 to disable this behavior.
=over 4
=item '0'
[% item = 'foo' %][% item.0 %] Returns foo.
Allows for scalars to mask as arrays (scalars already will, but this
allows for more direct access).
Not available in TT.
=item abs
[% -1.abs %] Returns the absolute value
=item atan2
[% pi = 4 * 1.atan2(1) %]
Returns the arctangent. The item itself represents Y, the passed argument represents X.
Not available in TT - available in HTML::Template::Expr.
=item chunk
[% item.chunk(60).join("\n") %] Split string up into a list of chunks of text 60 chars wide.
=item collapse
[% item.collapse %] Strip leading and trailing whitespace and collapse all other space to one space.
=item cos
[% item.cos %] Returns the cosine of the item.
Not available in TT - available in HTML::Template::Expr.
=item defined
[% item.defined %] Always true - because the undef sub translates all undefs to ''.
=item eval
[% item.eval %]
Process the string as though it was a template. This will start the
parsing engine and will use the same configuration as the current
process. Alloy is several times faster at doing this than TT is and
is considered acceptable.
This is a filter and is not available via the Text virtual object.
Template::Alloy has attempted to make the compile process painless and
fast. By default an MD5 sum of evaled is taken and used to cache the
AST. This behavior can be disabled using the CACHE_STR_REFS
configuration item.
Template::Alloy also allows for named parameters to be passed to the
eval filter.
[% '[% 1 + 2 %]'.eval %]
[% '${ 1 + 2 }'.eval(interpolate => 1) %]
[% "#get( 1 + 2)"|eval(syntax => 'velocity') %]
[% '<TMPL_VAR EXPR="1 + 2">'.eval(syntax => 'hte') %]
[% '<TMPL_VAR EXPR="1 + 2">'.eval(syntax => 'hte') %]
=item evaltt
Same as the eval filter.
=item exp
[% 1.exp %] Something like 2.71828182845905
Returns "e" to the power of the item.
=item file
Same as the redirect filter.
=item fmt
[% item.fmt('%d') %]
[% item.fmt('%6s') %]
[% item.fmt('%*s', 6) %]
Similar to format. Returns a string formatted with the passed
pattern. Default pattern is %s. Opposite from of the sprintf
vmethod.
=item format
[% item.format('%d') %]
[% item.format('%6s') %]
[% item.format('%*s', 6) %]
Print the string out in the specified format. It is similar to the
"fmt" virtual method, except that the item is split on newline and
each line is processed separately.
=item hash
[% item.hash %] Returns a one item hash with a key of "value" and a value of the item.
=item hex
[% "FF".hex %]
Returns the decimal value of the passed hex numbers. Note that you
may also just use [% 0xFF %].
Not available in TT - available in HTML::Template::Expr.
=item html
[% item.html %] Performs a very basic html encoding (swaps out &, <, > and " with the corresponding html entities)
Previously it also encoded the ' but this behavior did not match TT2's behavior. Use .xml to obtain that behavior.
=item indent
[% item.indent(3) %] Indent by that number of spaces if an integer is passed (default is 4).
[% item.indent("Foo: ") %] Add the string "Foo: " to the beginning of every line.
=item int
[% item.int %] Return the integer portion of the value (0 if none).
=item json
[% item.json %] Returns a JSON encoded representation.
[% item.json(1) %] Returns a pretty JSON encoded representation.
=item lc
Same as the lower vmethod. Returns the lowercased version of the item.
=item lcfirst
[% item.lcfirst %] Lowercase the leading letter.
=item length
[% item.length %] Return the length of the string.
=item list
[% item.list %] Returns a list (arrayref) with a single value of the item.
=item log
[% 8.exp.log %] Equal to 8.
Returns the natural log base "e" of the item.
Not available in TT - available in HTML::Template::Expr.
=item lower
[% item.lower %] Return the string lowercased.
=item match
[% item.match("(\w+) (\w+)") %] Return a list of items matching the pattern.
[% item.match("(\w+) (\w+)", 1) %] Same as before - but match globally.
In Template::Alloy and TT3 you can use regular expressions notation as well.
[% item.match( /(\w+) (\w+)/ ) %] Same as before.
[% item.match( m{(\w+) (\w+)} ) %] Same as before.
Note that you can't use the 'g' regex modifier - you must pass the second
argument to turn on global match.
=item none
Returns the item without modification. This was added as a compliment case
when the AUTO_FILTER configuration is specified. Note that it must be
called as a filter to bypass the application of the AUTO_FILTER.
[% item | none %] Returns the item without modification.
=item null
[% item.null %] Return nothing.
If the item contains a coderef it will still be executed, but the result would
be ignored.
=item oct
[% "377".oct %]
Returns the decimal value of the octal string. On recent versions of perl you
may also pass numbers starting with 0x which will be interpreted as hexadecimal,
and starting with 0b which will be interpreted as binary.
Not available in TT - available in HTML::Template::Expr.
=item rand
[% item = 10; item.rand %] Returns a number greater or equal to 0 but less than 10.
[% 1.rand %]
Note: This filter is not available as of TT2.15.
=item remove
[% item.remove("\s+") %] Same as replace - but is global and replaces with nothing.
=item redirect
[% item.redirect("output_file.html") %]
Writes the contents out to the specified file. The filename must be
relative to the OUTPUT_PATH configuration variable and the OUTPUT_PATH
variable must be set.
This is a filter and is not available via the Text virtual object.
=item repeat
[% item.repeat(3) %] Repeat the item 3 times
[% item.repeat(3, ' | ') %] Repeat the item 3 times separated with ' | '
=item replace
[% item.replace("\s+", " ") %] Globally replace all space with
[% item.replace("foo", "bar", 0) %] Replace only the first instance of foo with bar.
[% item.replace("(\w+)", "($1)") %] Surround all words with parenthesis.
In Template::Alloy and TT3 you may also use normal regular expression notation.
[% item.replace(/(\w+)/, "($1)") %] Same as before.
Note that you can't use the 'g' regex modifier - global match is on by default.
You must pass the third argument of false to turn off global match.
=item return
Returns the item from the inner most block, macro, or file. Similar to the
RETURN directive.
[% item.return %]
[% RETURN item %]
=item search
[% item.search("(\w+)") %] Tests if the given pattern is in the string.
In Template::Alloy and TT3 you may also use normal regular expression notation.
[% item.search(/(\w+)/) %] Same as before.
=item sin
[% item.sin %] Returns the sine of the item.
=item size
[% item.size %] Always returns 1.
=item split
[% item.split %] Returns an arrayref from the item split on " "
[% item.split("\s+") %] Returns an arrayref from the item split on /\s+/
[% item.split("\s+", 3) %] Returns an arrayref from the item split on /\s+/ splitting until 3 elements are found.
In Template::Alloy and TT3 you may also use normal regular expression notation.
[% item.split( /\s+/, 3 ) %] Same as before.
=item sprintf
[% item = "%d %d" %]
[% item.sprintf(7, 8) %]
Uses the pattern stored in self, and passes it to sprintf with the passed arguments.
Opposite from the fmt vmethod.
=item sqrt
[% item.sqrt %]
Returns the square root of the number.
=item srand
Calls the perl srand function to set the internal random seed. This
will affect future calls to the rand vmethod.
=item stderr
[% item.stderr %] Print the item to the current STDERR handle.
=item substr
[% item.substr(i) %] Returns a substring of item starting at i and going to the end of the string.
[% item.substr(i, n) %] Returns a substring of item starting at i and going n characters.
=item trim
[% item.trim %] Strips leading and trailing whitespace.
=item uc
Same as the upper command. Returns uppercased string.
=item ucfirst
[% item.ucfirst %] Uppercase the leading letter.
=item upper
[% item.upper %] Return the string uppercased.
=item uri
[% item.uri %] Perform a very basic URI encoding.
=item url
[% item.url %] Perform a URI encoding - but some characters such
as : and / are left intact.
=item xml
[% item.xml %] Performs a very basic xml encoding (swaps out &, <, >, ' and " with the corresponding xml entities)
=back
=head2 LIST VIRTUAL METHODS
The following methods can be called on an arrayref type data
structures (scalar types will automatically promote to a single
element list and call these methods if needed):
Additionally, list virtual methods can be accessed via the List
Virtual Object.
=over 4
=item fmt
[% mylist.fmt('%s', ', ') %]
[% mylist.fmt('%6s', ', ') %]
[% mylist.fmt('%*s', ', ', 6) %]
Passed a pattern and an string to join on. Returns a string of the
values of the list formatted with the passed pattern and joined with
the passed string. Default pattern is %s and the default join string
is a space.
=item first
[% mylist.first(3) %] Returns a list of the first 3 items in the list.
=item grep
[% mylist.grep("^\w+\.\w+$") %] Returns a list of all items matching the pattern.
In Template::Alloy and TT3 you may also use normal regular expression notation.
[% mylist.grep(/^\w+\.\w+$/) %] Same as before.
[% mylist.grep(->(a){ a.foo.bar }
=item hash
[% mylist.hash %] Returns a hashref with the array indexes as keys and the values as values.
=item join
[% mylist.join %] Joins on space.
[% mylist.join(", ") Joins on the passed argument.
=item json
[% mylist.json %] Returns a JSON encoded representation.
[% mylist.json(1) %] Returns a pretty JSON encoded representation.
=item last
[% mylist.last(3) %] Returns a list of the last 3 items in the list.
=item list
[% mylist.list %] Returns a reference to the list.
=item map (Not in TT2)
[% mylist.map(->{ this.upper }) %] Returns a list with the macro played on each item.
[% mylist.map(->(a){ a.upper }) %] Same thing
The RETURN directive or return list, item, and hash vmethods allow for
returning more interesting items.
[% [1..3].map(->(a){ [1..a].return }) %]
=item max
[% mylist.max %] Returns the last item in the array.
=item merge
[% mylist.merge(list2) %] Returns a new list with all defined items from list2 added.
=item nsort
[% mylist.nsort %] Returns the numerically sorted items of the list. If the items are
hashrefs, a key containing the field to sort on can be passed.
=item pop
[% mylist.pop %] Removes and returns the last element from the arrayref (the stash is modified).
=item push
[% mylist.push(23) %] Adds an element to the end of the arrayref (the stash is modified).
=item pick
[% mylist.pick %] Returns a random item from the list.
[% ['a' .. 'z'].pick %]
An additional numeric argument is how many items to return.
[% ['a' .. 'z'].pick(8).join('') %]
Note: This filter is not available as of TT2.15.
=item return
Returns the list from the inner most block, macro, or file. Similar to the
RETURN directive.
[% mylist.return %]
[% RETURN mylist %]
=item reverse
[% mylist.reverse %] Returns the list in reverse order.
=item shift
[% mylist.shift %] Removes and returns the first element of the arrayref (the stash is modified).
=item size
[% mylist.size %] Returns the number of elements in the array.
=item slice
[% mylist.slice(i, n) %] Returns a list from the arrayref beginning at index i and continuing for n items.
=item sort
[% mylist.sort %] Returns the alphabetically sorted items of the list. If the items are
hashrefs, a key containing the field to sort on can be passed.
=item splice
[% mylist.splice(i, n) %] Removes items from array beginning at i and continuing for n items.
[% mylist.splice(i, n, list2) %] Same as before, but replaces removed items with the items
from list2.
=item unique
[% mylist.unique %] Return a list of the unique items in the array.
=item unshift
[% mylist.unshift(23) %] Adds an item to the beginning of the arrayref.
=back
=head2 HASH VIRTUAL METHODS
The following methods can be called on hash type data structures:
Additionally, list virtual methods can be accessed via the Hash
Virtual Object.
=over 4
=item fmt
[% myhash.fmt('%s => %s', "\n") %]
[% myhash.fmt('%4s => %5s', "\n") %]
[% myhash.fmt('%*s => %*s', "\n", 4, 5) %]
Passed a pattern and an string to join on. Returns a string of the
key/value pairs of the hash formatted with the passed pattern and
joined with the passed string. Default pattern is "%s\t%s" and the
default join string is a newline.
=item defined
[% myhash.defined('a') %] Checks if a is defined in the hash.
=item delete
[% myhash.delete('a') %] Deletes the item from the hash.
Unlink Perl the value is not returned. Multiple values may be passed
and represent the keys to be deleted.
=item each
[% myhash.each.join(", ") %] Turns the contents of the hash into a list - subject
to change as TT is changing the operations of each and list.
=item exists
[% myhash.exists('a') %] Checks if a is in the hash.
=item hash
[% myhash.hash %] Returns a reference to the hash.
=item import
[% myhash.import(hash2) %] Overlays the keys of hash2 over the keys of myhash.
=item item
[% myhash.item(key) %] Returns the hashes value for that key.
=item items
[% myhash.items %] Returns a list of the key and values (flattened hash)
=item json
[% myhash.json %] Returns a JSON encoded representation.
[% myhash.json(1) %] Returns a pretty JSON encoded representation.
=item keys
[% myhash.keys.join(', ') %] Returns an arrayref of the keys of the hash.
=item list
[% myhash.list %] Returns an arrayref with the hash as a single value (subject to change).
=item pairs
[% myhash.pairs %] Returns an arrayref of hashrefs where each hash contains {key => $key, value => $value}
for each value of the hash.
=item nsort
[% myhash.nsort.join(", ") %] Returns a list of keys numerically sorted by the values.
=item return
Returns the hash from the inner most block, macro, or file. Similar to the
RETURN directive.
[% myhash.return %]
[% RETURN myhash %]
=item size
[% myhash.size %] Returns the number of key/value pairs in the hash.
=item sort
[% myhash.sort.join(", ") Returns a list of keys alphabetically sorted by the values.
=item values
[% myhash.values.join(', ') %] Returns an arrayref of the values of the hash.
=back
=head1 VIRTUAL OBJECTS
TT3 has a concept of Text, List, and Hash virtual objects which
provide direct access to the scalar, list, and hash virtual methods.
In the TT3 engine this will allow for more concise generated code.
Because Alloy does not generated perl code to be executed later, Alloy
provides for these virtual objects but does so as more of a namespace
(using the methods does not provide a speed optimization in your
template - just may help clarify things).
[% a = "foo"; a.length %] => 3
[% a = "foo"; Text.length(a) %] => 3
[% a = Text.new("foo"); a.length %] => 3
[% a = [1 .. 30]; a.size %] => 30
[% a = [1 .. 30]; List.size(a) %] => 30
[% a = List.new(1 .. 30); a.size %] => 30
[% a = {a => 1, b => 2}; a.size %] => 2
[% a = {a => 1, b => 2}; Hash.size(a) %] => 2
[% a = Hash.new({a => 1, b => 2}); a.size %] => 2
[% a = Hash.new(a => 1, b => 2); a.size %] => 2
[% a = Hash.new(a = 1, b = 2); a.size %] => 2
[% a = Hash.new('a', 1, 'b', 2); a.size %] => 2
One limitation is that if you pass a key named "Text",
"List", or "Hash" in your variable stash - the corresponding
virtual object will be hidden.
Additionally, you can use all of the Virtual object methods with
the pipe operator.
[% {a => 1, b => 2}
| Hash.keys
| List.join(", ") %] => a, b
Again, there aren't any speed optimizations to using the virtual
objects in Alloy, but it can help clarify the intent in some cases.
Note: these aren't really objects. All of the "virtual objects" are
references to the $SCALAR_OPS, $LIST_OPS, and $HASH_OPS hashes
found in the $VOBJS hash of Template::Alloy.
=head1 AUTHOR
Paul Seamons <paul@seamons.com>
=head1 LICENSE
This module may be distributed under the same terms as Perl itself.
=cut
|