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.225 by root, Fri Aug 10 19:06:06 2012 UTC vs.
Revision 1.232 by sf-exg, Fri May 2 20:33:56 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
295=item on_register_command $term, $keysym, $modifiermask, $string
296
297Called after parsing a keysym resource but before registering the
298associated binding. If this hook returns TRUE the binding is not
299registered. It can be used to modify a binding by calling
300C<register_command>.
301 294
302=item on_resize_all_windows $term, $new_width, $new_height 295=item on_resize_all_windows $term, $new_width, $new_height
303 296
304Called just after the new window size has been calculated, but before 297Called just after the new window size has been calculated, but before
305windows are actually being resized or hints are being set. If this hook 298windows are actually being resized or hints are being set. If this hook
306returns TRUE, setting of the window hints is being skipped. 299returns a true value, setting of the window hints is being skipped.
307 300
308=item on_x_event $term, $event 301=item on_x_event $term, $event
309 302
310Called on every X event received on the vt window (and possibly other 303Called on every X event received on the vt window (and possibly other
311windows). Should only be used as a last resort. Most event structure 304windows). Should only be used as a last resort. Most event structure
350manpage), with the additional members C<row> and C<col>, which are the 343manpage), with the additional members C<row> and C<col>, which are the
351(real, not screen-based) row and column under the mouse cursor. 344(real, not screen-based) row and column under the mouse cursor.
352 345
353C<on_key_press> additionally receives the string rxvt-unicode would 346C<on_key_press> additionally receives the string rxvt-unicode would
354output, if any, in locale-specific encoding. 347output, if any, in locale-specific encoding.
355
356subwindow.
357 348
358=item on_client_message $term, $event 349=item on_client_message $term, $event
359 350
360=item on_wm_protocols $term, $event 351=item on_wm_protocols $term, $event
361 352
569 $name =~ y/-/./ if $isarg; 560 $name =~ y/-/./ if $isarg;
570 561
571 $term->scan_meta; 562 $term->scan_meta;
572 563
573 my $r = $term->{meta}{resource}; 564 my $r = $term->{meta}{resource};
574 keys %$r; # reste iterator 565 keys %$r; # reset iterator
575 while (my ($pattern, $v) = each %$r) { 566 while (my ($pattern, $v) = each %$r) {
576 if ( 567 if (
577 $pattern =~ /\.$/ 568 $pattern =~ /\.$/
578 ? $pattern eq substr $name, 0, length $pattern 569 ? $pattern eq substr $name, 0, length $pattern
579 : $pattern eq $name 570 : $pattern eq $name
667# called by the rxvt core 658# called by the rxvt core
668sub invoke { 659sub invoke {
669 local $TERM = shift; 660 local $TERM = shift;
670 my $htype = shift; 661 my $htype = shift;
671 662
672 if ($htype == 0) { # INIT 663 if ($htype == HOOK_INIT) {
673 my @dirs = $TERM->perl_libdirs; 664 my @dirs = $TERM->perl_libdirs;
674 665
675 my %ext_arg; 666 my %ext_arg;
676 667
677 { 668 {
716 707
717 if (my $cb = $TERM->{_hook}[$htype]) { 708 if (my $cb = $TERM->{_hook}[$htype]) {
718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 709 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
719 if $verbosity >= 10; 710 if $verbosity >= 10;
720 711
721 for my $pkg (keys %$cb) { 712 for my $pkg (
713 # this hook is only sent to the extension with the name
714 # matching the first arg
715 $htype == HOOK_KEYBOARD_DISPATCH
716 ? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
717 : keys %$cb
718 ) {
722 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; 719 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
723 $retval ||= $retval_; 720 $retval ||= $retval_;
724 721
725 if ($@) { 722 if ($@) {
726 $TERM->ungrab; # better to lose the grab than the session 723 $TERM->ungrab; # better to lose the grab than the session
730 727
731 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 728 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732 if $verbosity >= 11; 729 if $verbosity >= 11;
733 } 730 }
734 731
735 if ($htype == 1) { # DESTROY 732 if ($htype == HOOK_DESTROY) {
736 # clear package objects 733 # clear package objects
737 %$_ = () for values %{ $TERM->{_pkg} }; 734 %$_ = () for values %{ $TERM->{_pkg} };
738 735
739 # clear package 736 # clear package
740 %$TERM = (); 737 %$TERM = ();
827} 824}
828 825
829=item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) 826=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830 827
831Dynamically enable the given hooks (named without the C<on_> prefix) for 828Dynamically enable the given hooks (named without the C<on_> prefix) for
832this extension, replacing any previous hook. This is useful when you want 829this extension, replacing any hook previously installed via C<enable> in
833to overwrite time-critical hooks only temporarily. 830this extension.
831
832This is useful when you want to overwrite time-critical hooks only
833temporarily.
834 834
835To install additional callbacks for the same hook, you can use the C<on> 835To install additional callbacks for the same hook, you can use the C<on>
836method of the C<urxvt::term> class. 836method of the C<urxvt::term> class.
837 837
838=item $self->disable ($hook_name[, $hook_name..]) 838=item $self->disable ($hook_name[, $hook_name..])
1126} 1126}
1127 1127
1128=item $term->destroy 1128=item $term->destroy
1129 1129
1130Destroy the terminal object (close the window, free resources 1130Destroy the terminal object (close the window, free resources
1131etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1131etc.). Please note that urxvt will not exit as long as any event
1132watchers (timers, io watchers) are still active. 1132watchers (timers, io watchers) are still active.
1133 1133
1134=item $term->exec_async ($cmd[, @args]) 1134=item $term->exec_async ($cmd[, @args])
1135 1135
1136Works like the combination of the C<fork>/C<exec> builtins, which executes 1136Works like the combination of the C<fork>/C<exec> builtins, which executes
1255} 1255}
1256 1256
1257=item $success = $term->parse_keysym ($key, $octets) 1257=item $success = $term->parse_keysym ($key, $octets)
1258 1258
1259Adds a key binding exactly as specified via a resource. See the 1259Adds a key binding exactly as specified via a resource. See the
1260C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1260C<keysym> resource in the urxvt(1) manpage.
1261
1262=item $term->register_command ($keysym, $modifiermask, $string)
1263
1264Adds a key binding. This is a lower level api compared to
1265C<parse_keysym>, as it expects a parsed key description, and can be
1266used only inside either the C<on_init> hook, to add a binding, or the
1267C<on_register_command> hook, to modify a parsed binding.
1268 1261
1269=item $rend = $term->rstyle ([$new_rstyle]) 1262=item $rend = $term->rstyle ([$new_rstyle])
1270 1263
1271Return and optionally change the current rendition. Text that is output by 1264Return and optionally change the current rendition. Text that is output by
1272the terminal application will use this style. 1265the terminal application will use this style.
1695} 1688}
1696 1689
1697sub urxvt::line::t { 1690sub urxvt::line::t {
1698 my ($self) = @_; 1691 my ($self) = @_;
1699 1692
1700 if (@_ > 1) 1693 if (@_ > 1) {
1701 {
1702 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1694 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1703 for $self->{beg} .. $self->{end}; 1695 for $self->{beg} .. $self->{end};
1704 } 1696 }
1705 1697
1706 defined wantarray && 1698 defined wantarray &&
1707 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1699 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1708 0, $self->{len} 1700 0, $self->{len}
1709} 1701}
1710 1702
1711sub urxvt::line::r { 1703sub urxvt::line::r {
1712 my ($self) = @_; 1704 my ($self) = @_;
1713 1705
1714 if (@_ > 1) 1706 if (@_ > 1) {
1715 {
1716 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1707 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1717 for $self->{beg} .. $self->{end}; 1708 for $self->{beg} .. $self->{end};
1718 } 1709 }
1719 1710
1720 if (defined wantarray) { 1711 if (defined wantarray) {
1721 my $rend = [ 1712 my $rend = [
1722 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1713 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1723 ]; 1714 ];

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines