ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.222 by root, Sat Jul 7 07:00:17 2012 UTC vs.
Revision 1.230 by root, Sat Apr 26 20:51:12 2014 UTC

1=encoding utf8 1=encoding utf8
2 2
3=head1 NAME 3=head1 NAME
4 4
5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter 5urxvtperl - rxvt-unicode's embedded perl interpreter
6 6
7=head1 SYNOPSIS 7=head1 SYNOPSIS
8 8
9 # create a file grab_test in $HOME: 9 # create a file grab_test in $HOME:
10 10
11 sub on_sel_grab { 11 sub on_sel_grab {
12 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
13 () 13 ()
14 } 14 }
15 15
16 # start a @@RXVT_NAME@@ using it: 16 # start a urxvt using it:
17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 urxvt --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Every time a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in urxvtd, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext" 31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string. 32and "perl-ext-common" resources to the empty string.
33 33
34=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
35 35
36A number of extensions are delivered with this release. You can find them 36A number of extensions are delivered with this release. You can find them
37in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed 37in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38using F<< man urxvt-<EXTENSIONNAME> >>. 38F<< man urxvt-<EXTENSIONNAME> >>.
39 39
40You can activate them like this: 40You can activate them like this:
41 41
42 @@RXVT_NAME@@ -pe <extensionname> 42 urxvt -pe <extensionname>
43 43
44Or by adding them to the resource for extensions loaded by default: 44Or by adding them to the resource for extensions loaded by default:
45 45
46 URxvt.perl-ext-common: default,selection-autotransform 46 URxvt.perl-ext-common: default,selection-autotransform
47 47
281 281
282=item on_refresh_end $term 282=item on_refresh_end $term
283 283
284Called just after the screen gets redrawn. See C<on_refresh_begin>. 284Called just after the screen gets redrawn. See C<on_refresh_begin>.
285 285
286=item on_user_command $term, $string 286=item on_user_command $term, $string *DEPRECATED*
287 287
288Called whenever a user-configured event is being activated (e.g. via 288Called whenever a user-configured event is being activated (e.g. via
289a C<perl:string> action bound to a key, see description of the B<keysym> 289a C<perl:string> action bound to a key, see description of the B<keysym>
290resource in the @@RXVT_NAME@@(1) manpage). 290resource in the urxvt(1) manpage).
291 291
292The event is simply the action string. This interface is assumed to change 292The event is simply the action string. This interface is going away in
293slightly in the future. 293preference to the C<< ->register_keysym_action >> method.
294 294
295=item on_register_command $term, $keysym, $modifiermask, $string 295=item on_register_command $term, $keysym, $modifiermask, $string
296 296
297Called after parsing a keysym resource but before registering the 297Called after parsing a keysym resource but before registering the
298associated binding. If this hook returns TRUE the binding is not 298associated binding. If this hook returns a true value the binding
299registered. It can be used to modify a binding by calling 299is not registered. It can be used to modify a binding by calling
300C<register_command>. 300C<register_command>.
301 301
302=item on_resize_all_windows $term, $new_width, $new_height 302=item on_resize_all_windows $term, $new_width, $new_height
303 303
304Called just after the new window size has been calculated, but before 304Called just after the new window size has been calculated, but before
305windows are actually being resized or hints are being set. If this hook 305windows are actually being resized or hints are being set. If this hook
306returns TRUE, setting of the window hints is being skipped. 306returns a true value, setting of the window hints is being skipped.
307 307
308=item on_x_event $term, $event 308=item on_x_event $term, $event
309 309
310Called on every X event received on the vt window (and possibly other 310Called on every X event received on the vt window (and possibly other
311windows). Should only be used as a last resort. Most event structure 311windows). Should only be used as a last resort. Most event structure
569 $name =~ y/-/./ if $isarg; 569 $name =~ y/-/./ if $isarg;
570 570
571 $term->scan_meta; 571 $term->scan_meta;
572 572
573 my $r = $term->{meta}{resource}; 573 my $r = $term->{meta}{resource};
574 keys %$r; # reste iterator 574 keys %$r; # reset iterator
575 while (my ($pattern, $v) = each %$r) { 575 while (my ($pattern, $v) = each %$r) {
576 if ( 576 if (
577 $pattern =~ /\.$/ 577 $pattern =~ /\.$/
578 ? $pattern eq substr $name, 0, length $pattern 578 ? $pattern eq substr $name, 0, length $pattern
579 : $pattern eq $name 579 : $pattern eq $name
667# called by the rxvt core 667# called by the rxvt core
668sub invoke { 668sub invoke {
669 local $TERM = shift; 669 local $TERM = shift;
670 my $htype = shift; 670 my $htype = shift;
671 671
672 if ($htype == 0) { # INIT 672 if ($htype == HOOK_INIT) {
673 my @dirs = $TERM->perl_libdirs; 673 my @dirs = $TERM->perl_libdirs;
674 674
675 my %ext_arg; 675 my %ext_arg;
676 676
677 { 677 {
716 716
717 if (my $cb = $TERM->{_hook}[$htype]) { 717 if (my $cb = $TERM->{_hook}[$htype]) {
718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
719 if $verbosity >= 10; 719 if $verbosity >= 10;
720 720
721 for my $pkg (keys %$cb) { 721 for my $pkg (
722 # this hook is only sent to the extension with the name
723 # matching the first arg
724 $htype == HOOK_KEYBOARD_DISPATCH
725 ? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
726 : keys %$cb
727 ) {
722 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; 728 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
723 $retval ||= $retval_; 729 $retval ||= $retval_;
724 730
725 if ($@) { 731 if ($@) {
726 $TERM->ungrab; # better to lose the grab than the session 732 $TERM->ungrab; # better to lose the grab than the session
730 736
731 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 737 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732 if $verbosity >= 11; 738 if $verbosity >= 11;
733 } 739 }
734 740
735 if ($htype == 1) { # DESTROY 741 if ($htype == HOOK_DESTROY) {
736 # clear package objects 742 # clear package objects
737 %$_ = () for values %{ $TERM->{_pkg} }; 743 %$_ = () for values %{ $TERM->{_pkg} };
738 744
739 # clear package 745 # clear package
740 %$TERM = (); 746 %$TERM = ();
827} 833}
828 834
829=item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) 835=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830 836
831Dynamically enable the given hooks (named without the C<on_> prefix) for 837Dynamically enable the given hooks (named without the C<on_> prefix) for
832this extension, replacing any previous hook. This is useful when you want 838this extension, replacing any hook previously installed via C<enable> in
833to overwrite time-critical hooks only temporarily. 839this extension.
840
841This is useful when you want to overwrite time-critical hooks only
842temporarily.
834 843
835To install additional callbacks for the same hook, you can use the C<on> 844To install additional callbacks for the same hook, you can use the C<on>
836method of the C<urxvt::term> class. 845method of the C<urxvt::term> class.
837 846
838=item $self->disable ($hook_name[, $hook_name..]) 847=item $self->disable ($hook_name[, $hook_name..])
881=cut 890=cut
882 891
883sub urxvt::extension::on_disable::DESTROY { 892sub urxvt::extension::on_disable::DESTROY {
884 my $disable = shift; 893 my $disable = shift;
885 894
886 my $self = delete $disable->{""}; 895 my $term = delete $disable->{""};
887 896
888 while (my ($htype, $id) = each %$disable) { 897 while (my ($htype, $id) = each %$disable) {
889 delete $self->{_hook}[$htype]{$id}; 898 delete $term->{_hook}[$htype]{$id};
890 $self->set_should_invoke ($htype, -1); 899 $term->set_should_invoke ($htype, -1);
891 } 900 }
892} 901}
893 902
894sub on { 903sub on {
895 my ($self, %hook) = @_; 904 my ($self, %hook) = @_;
896 905
906 my $term = $self->{term};
907
897 my %disable = ( "" => $self ); 908 my %disable = ( "" => $term );
898 909
899 while (my ($name, $cb) = each %hook) { 910 while (my ($name, $cb) = each %hook) {
900 my $htype = $HOOKTYPE{uc $name}; 911 my $htype = $HOOKTYPE{uc $name};
901 defined $htype 912 defined $htype
902 or Carp::croak "unsupported hook type '$name'"; 913 or Carp::croak "unsupported hook type '$name'";
903 914
904 my $id = $cb+0;
905
906 $self->set_should_invoke ($htype, +1); 915 $term->set_should_invoke ($htype, +1);
907 $disable{$htype} = $id; 916 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
908 $self->{_hook}[$htype]{$id} = sub { shift; $cb->($self, @_) }; # very ugly indeed 917 = sub { shift; $cb->($self, @_) }; # very ugly indeed
909 } 918 }
910 919
911 bless \%disable, "urxvt::extension::on_disable" 920 bless \%disable, "urxvt::extension::on_disable"
912} 921}
913 922
1077 1086
1078 for my $dir (reverse @libdirs) { 1087 for my $dir (reverse @libdirs) {
1079 opendir my $fh, $dir 1088 opendir my $fh, $dir
1080 or next; 1089 or next;
1081 for my $ext (readdir $fh) { 1090 for my $ext (readdir $fh) {
1082 $ext ne "." 1091 $ext !~ /^\./
1083 and $ext ne ".."
1084 and open my $fh, "<", "$dir/$ext" 1092 and open my $fh, "<", "$dir/$ext"
1085 or next; 1093 or next;
1086 1094
1087 while (<$fh>) { 1095 while (<$fh>) {
1088 if (/^#:META:X_RESOURCE:(.*)/) { 1096 if (/^#:META:X_RESOURCE:(.*)/) {
1127} 1135}
1128 1136
1129=item $term->destroy 1137=item $term->destroy
1130 1138
1131Destroy the terminal object (close the window, free resources 1139Destroy the terminal object (close the window, free resources
1132etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1140etc.). Please note that urxvt will not exit as long as any event
1133watchers (timers, io watchers) are still active. 1141watchers (timers, io watchers) are still active.
1134 1142
1135=item $term->exec_async ($cmd[, @args]) 1143=item $term->exec_async ($cmd[, @args])
1136 1144
1137Works like the combination of the C<fork>/C<exec> builtins, which executes 1145Works like the combination of the C<fork>/C<exec> builtins, which executes
1256} 1264}
1257 1265
1258=item $success = $term->parse_keysym ($key, $octets) 1266=item $success = $term->parse_keysym ($key, $octets)
1259 1267
1260Adds a key binding exactly as specified via a resource. See the 1268Adds a key binding exactly as specified via a resource. See the
1261C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1269C<keysym> resource in the urxvt(1) manpage.
1262 1270
1263=item $term->register_command ($keysym, $modifiermask, $string) 1271=item $term->register_command ($keysym, $modifiermask, $string)
1264 1272
1265Adds a key binding. This is a lower level api compared to 1273Adds a key binding. This is a lower level api compared to
1266C<parse_keysym>, as it expects a parsed key description, and can be 1274C<parse_keysym>, as it expects a parsed key description, and can be
1696} 1704}
1697 1705
1698sub urxvt::line::t { 1706sub urxvt::line::t {
1699 my ($self) = @_; 1707 my ($self) = @_;
1700 1708
1701 if (@_ > 1) 1709 if (@_ > 1) {
1702 {
1703 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1710 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1704 for $self->{beg} .. $self->{end}; 1711 for $self->{beg} .. $self->{end};
1705 } 1712 }
1706 1713
1707 defined wantarray && 1714 defined wantarray &&
1708 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1715 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1709 0, $self->{len} 1716 0, $self->{len}
1710} 1717}
1711 1718
1712sub urxvt::line::r { 1719sub urxvt::line::r {
1713 my ($self) = @_; 1720 my ($self) = @_;
1714 1721
1715 if (@_ > 1) 1722 if (@_ > 1) {
1716 {
1717 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1723 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1718 for $self->{beg} .. $self->{end}; 1724 for $self->{beg} .. $self->{end};
1719 } 1725 }
1720 1726
1721 if (defined wantarray) { 1727 if (defined wantarray) {
1722 my $rend = [ 1728 my $rend = [
1723 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1729 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1724 ]; 1730 ];

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines