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.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.114 by root, Fri Jan 20 12:16:28 2006 UTC

34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
88=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
89 93
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 96evalution, web-browser starting etc.), depending on content.
97
98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
101
102It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>.
107
108The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any
110C<a>s:
111
112 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g }
114 : ()
115 };
93 116
94=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
95 118
96Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 149
127And this example matches the same,but replaces it with vi-commands you can 150And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 151paste directly into your (vi :) editor:
129 152
130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131 154
132Of course, this can be modified to suit your needs and your editor :) 155Of course, this can be modified to suit your needs and your editor :)
133 156
134To expand the example above to typical perl error messages ("XXX at 157To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 158FILENAME line YYY."), you need a slightly more elaborate solution:
136 159
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139 162
140The first line tells the selection code to treat the unchanging part of 163The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms 164every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file. 165the message into vi commands to load the file.
143 166
146Uses per-line display filtering (C<on_line_update>) to underline urls and 169Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the 170make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 171resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 172the URL as first argument.
150 173
174=item automove-background
175
176This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181
151=item block-graphics-to-ascii 182=item block-graphics-to-ascii
152 183
153A not very useful example of filtering all text output to the terminal, 184A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 186similar-looking ascii character.
165overlays or changes. 196overlays or changes.
166 197
167=item selection-pastebin 198=item selection-pastebin
168 199
169This is a little rarely useful extension that Uploads the selection as 200This is a little rarely useful extension that Uploads the selection as
170textfile to a remote site (or does other things). 201textfile to a remote site (or does other things). (The implementation is
202not currently secure for use in a multiuser environment as it writes to
203F</tmp> directly.).
171 204
172It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 205It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173i.e. 206i.e.
174 207
175 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 208 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
270called whenever the relevant event happens. 303called whenever the relevant event happens.
271 304
272The first argument passed to them is an extension oject as described in 305The first argument passed to them is an extension oject as described in
273the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
274 307
275B<All> of these hooks must return a boolean value. If it is true, then the 308B<All> of these hooks must return a boolean value. If any of the called
276event counts as being I<consumed>, and the invocation of other hooks is 309hooks returns true, then the event counts as being I<consumed>, and the
277skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
278 311
279I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
280 313
281=over 4 314=over 4
282 315
283=item on_init $term 316=item on_init $term
284 317
285Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
286windows are created or the command gets run. Most methods are unsafe to 319windows are created or the command gets run. Most methods are unsafe to
287call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
288have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
289though. 322and options, though. For many purposes the C<on_start> hook is a better
323place.
324
325=item on_start $term
326
327Called at the very end of initialisation of a new terminal, just before
328trying to map (display) the toplevel and returning to the mainloop.
329
330=item on_destroy $term
331
332Called whenever something tries to destroy terminal, before doing anything
333yet. If this hook returns true, then destruction is skipped, but this is
334rarely a good idea.
290 335
291=item on_reset $term 336=item on_reset $term
292 337
293Called after the screen is "reset" for any reason, such as resizing or 338Called after the screen is "reset" for any reason, such as resizing or
294control sequences. Here is where you can react on changes to size-related 339control sequences. Here is where you can react on changes to size-related
295variables. 340variables.
296 341
297=item on_start $term 342=item on_child_start $term, $pid
298 343
299Called at the very end of initialisation of a new terminal, just before 344Called just after the child process has been C<fork>ed.
300returning to the mainloop. 345
346=item on_child_exit $term, $status
347
348Called just after the child process has exited. C<$status> is the status
349from C<waitpid>.
301 350
302=item on_sel_make $term, $eventtime 351=item on_sel_make $term, $eventtime
303 352
304Called whenever a selection has been made by the user, but before the 353Called whenever a selection has been made by the user, but before the
305selection text is copied, so changes to the beginning, end or type of the 354selection text is copied, so changes to the beginning, end or type of the
414=item on_focus_out $term 463=item on_focus_out $term
415 464
416Called wheneever the window loses keyboard focus, before rxvt-unicode does 465Called wheneever the window loses keyboard focus, before rxvt-unicode does
417focus out processing. 466focus out processing.
418 467
468=item on_configure_notify $term, $event
469
419=item on_key_press $term, $event, $keysym, $octets 470=item on_key_press $term, $event, $keysym, $octets
420 471
421=item on_key_release $term, $event, $keysym 472=item on_key_release $term, $event, $keysym
422 473
423=item on_button_press $term, $event 474=item on_button_press $term, $event
439 490
440C<on_key_press> additionally receives the string rxvt-unicode would 491C<on_key_press> additionally receives the string rxvt-unicode would
441output, if any, in locale-specific encoding. 492output, if any, in locale-specific encoding.
442 493
443subwindow. 494subwindow.
495
496=item on_client_message $term, $event
497
498=item on_wm_protocols $term, $event
499
500=item on_wm_delete_window $term, $event
501
502Called when various types of ClientMessage events are received (all with
503format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
444 504
445=back 505=back
446 506
447=cut 507=cut
448 508
454use Scalar::Util (); 514use Scalar::Util ();
455use List::Util (); 515use List::Util ();
456 516
457our $VERSION = 1; 517our $VERSION = 1;
458our $TERM; 518our $TERM;
519our @TERM_INIT;
520our @TERM_EXT;
459our @HOOKNAME; 521our @HOOKNAME;
460our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 522our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461our %OPTION; 523our %OPTION;
462 524
463our $LIBDIR; 525our $LIBDIR;
484 546
485=item $urxvt::TERM 547=item $urxvt::TERM
486 548
487The current terminal. This variable stores the current C<urxvt::term> 549The current terminal. This variable stores the current C<urxvt::term>
488object, whenever a callback/hook is executing. 550object, whenever a callback/hook is executing.
551
552=item @urxvt::TERM_INIT
553
554All coderefs in this array will be called as methods of the next newly
555created C<urxvt::term> object (during the C<on_init> phase). The array
556gets cleared before the codereferences that were in it are being executed,
557so coderefs can push themselves onto it again if they so desire.
558
559This complements to the perl-eval commandline option, but gets executed
560first.
561
562=item @urxvt::TERM_EXT
563
564Works similar to C<@TERM_INIT>, but contains perl package/class names, which
565get registered as normal extensions after calling the hooks in C<@TERM_INIT>
566but before other extensions. Gets cleared just like C<@TERM_INIT>.
489 567
490=back 568=back
491 569
492=head2 Functions in the C<urxvt> Package 570=head2 Functions in the C<urxvt> Package
493 571
593=back 671=back
594 672
595=cut 673=cut
596 674
597BEGIN { 675BEGIN {
598 urxvt->bootstrap;
599
600 # overwrite perl's warn 676 # overwrite perl's warn
601 *CORE::GLOBAL::warn = sub { 677 *CORE::GLOBAL::warn = sub {
602 my $msg = join "", @_; 678 my $msg = join "", @_;
603 $msg .= "\n" 679 $msg .= "\n"
604 unless $msg =~ /\n$/; 680 unless $msg =~ /\n$/;
605 urxvt::warn ($msg); 681 urxvt::warn ($msg);
606 }; 682 };
607
608 # %ENV is the original startup environment
609 delete $ENV{IFS};
610 delete $ENV{CDPATH};
611 delete $ENV{BASH_ENV};
612 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
613} 683}
614 684
615my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 685my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616 686
617sub verbose { 687sub verbose {
618 my ($level, $msg) = @_; 688 my ($level, $msg) = @_;
619 warn "$msg\n" if $level <= $verbosity; 689 warn "$msg\n" if $level <= $verbosity;
620} 690}
621 691
622my $extension_pkg = "extension0000";
623my %extension_pkg; 692my %extension_pkg;
624 693
625# load a single script into its own package, once only 694# load a single script into its own package, once only
626sub extension_package($) { 695sub extension_package($) {
627 my ($path) = @_; 696 my ($path) = @_;
628 697
629 $extension_pkg{$path} ||= do { 698 $extension_pkg{$path} ||= do {
630 my $pkg = "urxvt::" . ($extension_pkg++); 699 $path =~ /([^\/\\]+)$/;
700 my $pkg = $1;
701 $pkg =~ s/[^[:word:]]/_/g;
702 $pkg = "urxvt::ext::$pkg";
631 703
632 verbose 3, "loading extension '$path' into package '$pkg'"; 704 verbose 3, "loading extension '$path' into package '$pkg'";
633 705
634 open my $fh, "<:raw", $path 706 open my $fh, "<:raw", $path
635 or die "$path: $!"; 707 or die "$path: $!";
636 708
637 my $source = 709 my $source =
638 "package $pkg; use strict; use utf8;\n" 710 "package $pkg; use strict; use utf8;\n"
639 . "use base urxvt::term::extension::;\n"
640 . "#line 1 \"$path\"\n{\n" 711 . "#line 1 \"$path\"\n{\n"
641 . (do { local $/; <$fh> }) 712 . (do { local $/; <$fh> })
642 . "\n};\n1"; 713 . "\n};\n1";
643 714
644 eval $source 715 eval $source
658 if ($htype == 0) { # INIT 729 if ($htype == 0) { # INIT
659 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 730 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
660 731
661 my %ext_arg; 732 my %ext_arg;
662 733
734 {
735 my @init = @TERM_INIT;
736 @TERM_INIT = ();
737 $_->($TERM) for @init;
738 my @pkg = @TERM_EXT;
739 @TERM_EXT = ();
740 $TERM->register_package ($_) for @pkg;
741 }
742
663 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 743 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
664 if ($_ eq "default") { 744 if ($_ eq "default") {
665 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 745 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
666 } elsif (/^-(.*)$/) { 746 } elsif (/^-(.*)$/) {
667 delete $ext_arg{$1}; 747 delete $ext_arg{$1};
668 } elsif (/^([^<]+)<(.*)>$/) { 748 } elsif (/^([^<]+)<(.*)>$/) {
693 if $verbosity >= 10; 773 if $verbosity >= 10;
694 774
695 keys %$cb; 775 keys %$cb;
696 776
697 while (my ($pkg, $cb) = each %$cb) { 777 while (my ($pkg, $cb) = each %$cb) {
698 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 778 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
699 and last; 779 $retval ||= $retval_;
700 780
701 if ($@) { 781 if ($@) {
702 $TERM->ungrab; # better to lose the grab than the session 782 $TERM->ungrab; # better to lose the grab than the session
703 warn $@; 783 warn $@;
704 } 784 }
715 # clear package 795 # clear package
716 %$TERM = (); 796 %$TERM = ();
717 } 797 }
718 798
719 $retval 799 $retval
720}
721
722sub exec_async(@) {
723 my $pid = fork;
724
725 return
726 if !defined $pid or $pid;
727
728 %ENV = %{ $TERM->env };
729
730 exec @_;
731 _exit 255;
732} 800}
733 801
734# urxvt::term::extension 802# urxvt::term::extension
735 803
736package urxvt::term::extension; 804package urxvt::term::extension;
875# find on_xxx subs in the package and register them 943# find on_xxx subs in the package and register them
876# as hooks 944# as hooks
877sub register_package { 945sub register_package {
878 my ($self, $pkg, $argv) = @_; 946 my ($self, $pkg, $argv) = @_;
879 947
948 no strict 'refs';
949
950 urxvt::verbose 6, "register package $pkg to $self";
951
952 @{"$pkg\::ISA"} = urxvt::term::extension::;
953
880 my $proxy = bless { 954 my $proxy = bless {
881 _pkg => $pkg, 955 _pkg => $pkg,
882 argv => $argv, 956 argv => $argv,
883 }, $pkg; 957 }, $pkg;
884 Scalar::Util::weaken ($proxy->{term} = $self); 958 Scalar::Util::weaken ($proxy->{term} = $self);
915 989
916Destroy the terminal object (close the window, free resources 990Destroy the terminal object (close the window, free resources
917etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 991etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
918watchers (timers, io watchers) are still active. 992watchers (timers, io watchers) are still active.
919 993
994=item $term->exec_async ($cmd[, @args])
995
996Works like the combination of the C<fork>/C<exec> builtins, which executes
997("starts") programs in the background. This function takes care of setting
998the user environment before exec'ing the command (e.g. C<PATH>) and should
999be preferred over explicit calls to C<exec> or C<system>.
1000
1001Returns the pid of the subprocess or C<undef> on error.
1002
1003=cut
1004
1005sub exec_async {
1006 my $self = shift;
1007
1008 my $pid = fork;
1009
1010 return $pid
1011 if !defined $pid or $pid;
1012
1013 %ENV = %{ $self->env };
1014
1015 exec @_;
1016 urxvt::_exit 255;
1017}
1018
920=item $isset = $term->option ($optval[, $set]) 1019=item $isset = $term->option ($optval[, $set])
921 1020
922Returns true if the option specified by C<$optval> is enabled, and 1021Returns true if the option specified by C<$optval> is enabled, and
923optionally change it. All option values are stored by name in the hash 1022optionally change it. All option values are stored by name in the hash
924C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1023C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
926Here is a a likely non-exhaustive list of option names, please see the 1025Here is a a likely non-exhaustive list of option names, please see the
927source file F</src/optinc.h> to see the actual list: 1026source file F</src/optinc.h> to see the actual list:
928 1027
929 borderLess console cursorBlink cursorUnderline hold iconic insecure 1028 borderLess console cursorBlink cursorUnderline hold iconic insecure
930 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1029 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1030 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1031 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1032 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934 tripleclickwords utmpInhibit visualBell 1033 transparent tripleclickwords utmpInhibit visualBell
935 1034
936=item $value = $term->resource ($name[, $newval]) 1035=item $value = $term->resource ($name[, $newval])
937 1036
938Returns the current resource value associated with a given name and 1037Returns the current resource value associated with a given name and
939optionally sets a new value. Setting values is most useful in the C<init> 1038optionally sets a new value. Setting values is most useful in the C<init>
956 1055
957 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1056 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958 borderLess color cursorBlink cursorUnderline cutchars delete_key 1057 borderLess color cursorBlink cursorUnderline cutchars delete_key
959 display_name embed ext_bwidth fade font geometry hold iconName 1058 display_name embed ext_bwidth fade font geometry hold iconName
960 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1059 imFont imLocale inputMethod insecure int_bwidth intensityStyles
961 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1060 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1061 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1062 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1063 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1064 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1065 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967 shade term_name title transparent transparent_all tripleclickwords 1066 secondaryScreen secondaryScroll selectstyle shade term_name title
968 utmpInhibit visualBell 1067 transient_for transparent transparent_all tripleclickwords utmpInhibit
1068 visualBell
969 1069
970=cut 1070=cut
971 1071
972sub resource($$;$) { 1072sub resource($$;$) {
973 my ($self, $name) = (shift, shift); 1073 my ($self, $name) = (shift, shift);
1565 my $env = $self->{term}->env; 1665 my $env = $self->{term}->env;
1566 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1666 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1567 delete $env->{LC_ALL}; 1667 delete $env->{LC_ALL};
1568 $env->{LC_CTYPE} = $self->{term}->locale; 1668 $env->{LC_CTYPE} = $self->{term}->locale;
1569 1669
1570 urxvt::term->new ($env, $self->{term}->resource ("name"), 1670 urxvt::term->new ($env, "popup",
1571 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1671 "--perl-lib" => "", "--perl-ext-common" => "",
1672 "-pty-fd" => -1, "-sl" => 0,
1673 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572 "--transient-for" => $self->{term}->parent, 1674 "--transient-for" => $self->{term}->parent,
1573 "-display" => $self->{term}->display_id, 1675 "-display" => $self->{term}->display_id,
1574 "-pe" => "urxvt-popup") 1676 "-pe" => "urxvt-popup")
1575 or die "unable to create popup window\n"; 1677 or die "unable to create popup window\n";
1576} 1678}
1581 delete $self->{term}{_destroy}{$self}; 1683 delete $self->{term}{_destroy}{$self};
1582 $self->{term}->ungrab; 1684 $self->{term}->ungrab;
1583} 1685}
1584 1686
1585=back 1687=back
1688
1689=cut
1690
1691package urxvt::watcher;
1692
1693@urxvt::timer::ISA = __PACKAGE__;
1694@urxvt::iow::ISA = __PACKAGE__;
1695@urxvt::pw::ISA = __PACKAGE__;
1696@urxvt::iw::ISA = __PACKAGE__;
1586 1697
1587=head2 The C<urxvt::timer> Class 1698=head2 The C<urxvt::timer> Class
1588 1699
1589This class implements timer watchers/events. Time is represented as a 1700This class implements timer watchers/events. Time is represented as a
1590fractional number of seconds since the epoch. Example: 1701fractional number of seconds since the epoch. Example:
1628Start the timer. 1739Start the timer.
1629 1740
1630=item $timer = $timer->start ($tstamp) 1741=item $timer = $timer->start ($tstamp)
1631 1742
1632Set the event trigger time to C<$tstamp> and start the timer. 1743Set the event trigger time to C<$tstamp> and start the timer.
1744
1745=item $timer = $timer->after ($delay)
1746
1747Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633 1748
1634=item $timer = $timer->stop 1749=item $timer = $timer->stop
1635 1750
1636Stop the timer. 1751Stop the timer.
1637 1752
1684 1799
1685Stop watching for events on the given filehandle. 1800Stop watching for events on the given filehandle.
1686 1801
1687=back 1802=back
1688 1803
1804=head2 The C<urxvt::iw> Class
1805
1806This class implements idle watchers, that get called automatically when
1807the process is idle. They should return as fast as possible, after doing
1808some useful work.
1809
1810=over 4
1811
1812=item $iw = new urxvt::iw
1813
1814Create a new idle watcher object in stopped state.
1815
1816=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1817
1818Set the callback to be called when the watcher triggers.
1819
1820=item $timer = $timer->start
1821
1822Start the watcher.
1823
1824=item $timer = $timer->stop
1825
1826Stop the watcher.
1827
1828=back
1829
1830=head2 The C<urxvt::pw> Class
1831
1832This class implements process watchers. They create an event whenever a
1833process exits, after which they stop automatically.
1834
1835 my $pid = fork;
1836 ...
1837 $term->{pw} = urxvt::pw
1838 ->new
1839 ->start ($pid)
1840 ->cb (sub {
1841 my ($pw, $exit_status) = @_;
1842 ...
1843 });
1844
1845=over 4
1846
1847=item $pw = new urxvt::pw
1848
1849Create a new process watcher in stopped state.
1850
1851=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1852
1853Set the callback to be called when the timer triggers.
1854
1855=item $pw = $timer->start ($pid)
1856
1857Tells the wqtcher to start watching for process C<$pid>.
1858
1859=item $pw = $pw->stop
1860
1861Stop the watcher.
1862
1863=back
1864
1689=head1 ENVIRONMENT 1865=head1 ENVIRONMENT
1690 1866
1691=head2 URXVT_PERL_VERBOSITY 1867=head2 URXVT_PERL_VERBOSITY
1692 1868
1693This variable controls the verbosity level of the perl extension. Higher 1869This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines