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.231 by root, Sun Apr 27 20:26:28 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
350manpage), with the additional members C<row> and C<col>, which are the 350manpage), with the additional members C<row> and C<col>, which are the
351(real, not screen-based) row and column under the mouse cursor. 351(real, not screen-based) row and column under the mouse cursor.
352 352
353C<on_key_press> additionally receives the string rxvt-unicode would 353C<on_key_press> additionally receives the string rxvt-unicode would
354output, if any, in locale-specific encoding. 354output, if any, in locale-specific encoding.
355
356subwindow.
357 355
358=item on_client_message $term, $event 356=item on_client_message $term, $event
359 357
360=item on_wm_protocols $term, $event 358=item on_wm_protocols $term, $event
361 359
569 $name =~ y/-/./ if $isarg; 567 $name =~ y/-/./ if $isarg;
570 568
571 $term->scan_meta; 569 $term->scan_meta;
572 570
573 my $r = $term->{meta}{resource}; 571 my $r = $term->{meta}{resource};
574 keys %$r; # reste iterator 572 keys %$r; # reset iterator
575 while (my ($pattern, $v) = each %$r) { 573 while (my ($pattern, $v) = each %$r) {
576 if ( 574 if (
577 $pattern =~ /\.$/ 575 $pattern =~ /\.$/
578 ? $pattern eq substr $name, 0, length $pattern 576 ? $pattern eq substr $name, 0, length $pattern
579 : $pattern eq $name 577 : $pattern eq $name
667# called by the rxvt core 665# called by the rxvt core
668sub invoke { 666sub invoke {
669 local $TERM = shift; 667 local $TERM = shift;
670 my $htype = shift; 668 my $htype = shift;
671 669
672 if ($htype == 0) { # INIT 670 if ($htype == HOOK_INIT) {
673 my @dirs = $TERM->perl_libdirs; 671 my @dirs = $TERM->perl_libdirs;
674 672
675 my %ext_arg; 673 my %ext_arg;
676 674
677 { 675 {
716 714
717 if (my $cb = $TERM->{_hook}[$htype]) { 715 if (my $cb = $TERM->{_hook}[$htype]) {
718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 716 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
719 if $verbosity >= 10; 717 if $verbosity >= 10;
720 718
721 for my $pkg (keys %$cb) { 719 for my $pkg (
720 # this hook is only sent to the extension with the name
721 # matching the first arg
722 $htype == HOOK_KEYBOARD_DISPATCH
723 ? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
724 : keys %$cb
725 ) {
722 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; 726 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
723 $retval ||= $retval_; 727 $retval ||= $retval_;
724 728
725 if ($@) { 729 if ($@) {
726 $TERM->ungrab; # better to lose the grab than the session 730 $TERM->ungrab; # better to lose the grab than the session
730 734
731 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 735 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732 if $verbosity >= 11; 736 if $verbosity >= 11;
733 } 737 }
734 738
735 if ($htype == 1) { # DESTROY 739 if ($htype == HOOK_DESTROY) {
736 # clear package objects 740 # clear package objects
737 %$_ = () for values %{ $TERM->{_pkg} }; 741 %$_ = () for values %{ $TERM->{_pkg} };
738 742
739 # clear package 743 # clear package
740 %$TERM = (); 744 %$TERM = ();
827} 831}
828 832
829=item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) 833=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830 834
831Dynamically enable the given hooks (named without the C<on_> prefix) for 835Dynamically enable the given hooks (named without the C<on_> prefix) for
832this extension, replacing any previous hook. This is useful when you want 836this extension, replacing any hook previously installed via C<enable> in
833to overwrite time-critical hooks only temporarily. 837this extension.
838
839This is useful when you want to overwrite time-critical hooks only
840temporarily.
834 841
835To install additional callbacks for the same hook, you can use the C<on> 842To install additional callbacks for the same hook, you can use the C<on>
836method of the C<urxvt::term> class. 843method of the C<urxvt::term> class.
837 844
838=item $self->disable ($hook_name[, $hook_name..]) 845=item $self->disable ($hook_name[, $hook_name..])
881=cut 888=cut
882 889
883sub urxvt::extension::on_disable::DESTROY { 890sub urxvt::extension::on_disable::DESTROY {
884 my $disable = shift; 891 my $disable = shift;
885 892
886 my $self = delete $disable->{""}; 893 my $term = delete $disable->{""};
887 894
888 while (my ($htype, $id) = each %$disable) { 895 while (my ($htype, $id) = each %$disable) {
889 delete $self->{_hook}[$htype]{$id}; 896 delete $term->{_hook}[$htype]{$id};
890 $self->set_should_invoke ($htype, -1); 897 $term->set_should_invoke ($htype, -1);
891 } 898 }
892} 899}
893 900
894sub on { 901sub on {
895 my ($self, %hook) = @_; 902 my ($self, %hook) = @_;
896 903
904 my $term = $self->{term};
905
897 my %disable = ( "" => $self ); 906 my %disable = ( "" => $term );
898 907
899 while (my ($name, $cb) = each %hook) { 908 while (my ($name, $cb) = each %hook) {
900 my $htype = $HOOKTYPE{uc $name}; 909 my $htype = $HOOKTYPE{uc $name};
901 defined $htype 910 defined $htype
902 or Carp::croak "unsupported hook type '$name'"; 911 or Carp::croak "unsupported hook type '$name'";
903 912
904 my $id = $cb+0;
905
906 $self->set_should_invoke ($htype, +1); 913 $term->set_should_invoke ($htype, +1);
907 $disable{$htype} = $id; 914 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
908 $self->{_hook}[$htype]{$id} = sub { shift; $cb->($self, @_) }; # very ugly indeed 915 = sub { shift; $cb->($self, @_) }; # very ugly indeed
909 } 916 }
910 917
911 bless \%disable, "urxvt::extension::on_disable" 918 bless \%disable, "urxvt::extension::on_disable"
912} 919}
913 920
1077 1084
1078 for my $dir (reverse @libdirs) { 1085 for my $dir (reverse @libdirs) {
1079 opendir my $fh, $dir 1086 opendir my $fh, $dir
1080 or next; 1087 or next;
1081 for my $ext (readdir $fh) { 1088 for my $ext (readdir $fh) {
1082 $ext ne "." 1089 $ext !~ /^\./
1083 and $ext ne ".."
1084 and open my $fh, "<", "$dir/$ext" 1090 and open my $fh, "<", "$dir/$ext"
1085 or next; 1091 or next;
1086 1092
1087 while (<$fh>) { 1093 while (<$fh>) {
1088 if (/^#:META:X_RESOURCE:(.*)/) { 1094 if (/^#:META:X_RESOURCE:(.*)/) {
1127} 1133}
1128 1134
1129=item $term->destroy 1135=item $term->destroy
1130 1136
1131Destroy the terminal object (close the window, free resources 1137Destroy the terminal object (close the window, free resources
1132etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1138etc.). Please note that urxvt will not exit as long as any event
1133watchers (timers, io watchers) are still active. 1139watchers (timers, io watchers) are still active.
1134 1140
1135=item $term->exec_async ($cmd[, @args]) 1141=item $term->exec_async ($cmd[, @args])
1136 1142
1137Works like the combination of the C<fork>/C<exec> builtins, which executes 1143Works like the combination of the C<fork>/C<exec> builtins, which executes
1256} 1262}
1257 1263
1258=item $success = $term->parse_keysym ($key, $octets) 1264=item $success = $term->parse_keysym ($key, $octets)
1259 1265
1260Adds a key binding exactly as specified via a resource. See the 1266Adds a key binding exactly as specified via a resource. See the
1261C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1267C<keysym> resource in the urxvt(1) manpage.
1262 1268
1263=item $term->register_command ($keysym, $modifiermask, $string) 1269=item $term->register_command ($keysym, $modifiermask, $string)
1264 1270
1265Adds a key binding. This is a lower level api compared to 1271Adds a key binding. This is a lower level api compared to
1266C<parse_keysym>, as it expects a parsed key description, and can be 1272C<parse_keysym>, as it expects a parsed key description, and can be
1696} 1702}
1697 1703
1698sub urxvt::line::t { 1704sub urxvt::line::t {
1699 my ($self) = @_; 1705 my ($self) = @_;
1700 1706
1701 if (@_ > 1) 1707 if (@_ > 1) {
1702 {
1703 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1708 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1704 for $self->{beg} .. $self->{end}; 1709 for $self->{beg} .. $self->{end};
1705 } 1710 }
1706 1711
1707 defined wantarray && 1712 defined wantarray &&
1708 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1713 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1709 0, $self->{len} 1714 0, $self->{len}
1710} 1715}
1711 1716
1712sub urxvt::line::r { 1717sub urxvt::line::r {
1713 my ($self) = @_; 1718 my ($self) = @_;
1714 1719
1715 if (@_ > 1) 1720 if (@_ > 1) {
1716 {
1717 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1721 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1718 for $self->{beg} .. $self->{end}; 1722 for $self->{beg} .. $self->{end};
1719 } 1723 }
1720 1724
1721 if (defined wantarray) { 1725 if (defined wantarray) {
1722 my $rend = [ 1726 my $rend = [
1723 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1727 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1724 ]; 1728 ];

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines