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.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.115 by root, Fri Jan 20 15:57:21 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
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.
93 97
94Other extensions can extend this popup menu by pushing a code reference onto 98Other extensions can extend this popup menu by pushing a code reference
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. 99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
96 101
97It's sole argument is the popup menu, which can be modified. The selection 102It's sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not. 103is in C<$_>, which can be used to decide wether to add something or not.
99It should either return nothing or a string and a code reference. The 104It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called 105string will be used as button text and the code reference will be called
102 107
103The following will add an entry C<a to b> that transforms all C<a>s in 108The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any 109the selection to C<b>s, but only if the selection currently contains any
105C<a>s: 110C<a>s:
106 111
107 push urxvt::ext::selection_popup::hook, sub { 112 push @{ $self->{term}{selection_popup_hook} }, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g } 113 /a/ ? ("a to be" => sub { s/a/b/g }
109 : () 114 : ()
110 }; 115 };
111 116
112=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
143 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/
144 149
145And 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
146paste directly into your (vi :) editor: 151paste directly into your (vi :) editor:
147 152
148 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/
149 154
150Of 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 :)
151 156
152To expand the example above to typical perl error messages ("XXX at 157To expand the example above to typical perl error messages ("XXX at
153FILENAME line YYY."), you need a slightly more elaborate solution: 158FILENAME line YYY."), you need a slightly more elaborate solution:
154 159
155 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156 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/
157 162
158The 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
159every error message as a selection pattern, and the second line transforms 164every error message as a selection pattern, and the second line transforms
160the message into vi commands to load the file. 165the message into vi commands to load the file.
166
167=item tabbed
168
169This transforms the terminal into a tabbar with additional terminals, that
170is, it implements what is commonly refered to as "tabbed terminal". The topmost line
171displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
172button per tab.
173
174Clicking a button will activate that tab. Pressing Shift-Left and
175Shift-Right will switch to the tab left or right of the current one.
161 176
162=item mark-urls 177=item mark-urls
163 178
164Uses per-line display filtering (C<on_line_update>) to underline urls and 179Uses per-line display filtering (C<on_line_update>) to underline urls and
165make them clickable. When middle-clicked, the program specified in the 180make them clickable. When middle-clicked, the program specified in the
166resource C<urlLauncher> (default C<x-www-browser>) will be started with 181resource C<urlLauncher> (default C<x-www-browser>) will be started with
167the URL as first argument. 182the URL as first argument.
183
184=item automove-background
185
186This is basically a one-line extension that dynamically changes the background pixmap offset
187to the window position, in effect creating the same effect as pseudo transparency with
188a custom pixmap. No scaling is supported in this mode. Exmaple:
189
190 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
168 191
169=item block-graphics-to-ascii 192=item block-graphics-to-ascii
170 193
171A not very useful example of filtering all text output to the terminal, 194A not very useful example of filtering all text output to the terminal,
172by replacing all line-drawing characters (U+2500 .. U+259F) by a 195by replacing all line-drawing characters (U+2500 .. U+259F) by a
290called whenever the relevant event happens. 313called whenever the relevant event happens.
291 314
292The first argument passed to them is an extension oject as described in 315The first argument passed to them is an extension oject as described in
293the in the C<Extension Objects> section. 316the in the C<Extension Objects> section.
294 317
295B<All> of these hooks must return a boolean value. If it is true, then the 318B<All> of these hooks must return a boolean value. If any of the called
296event counts as being I<consumed>, and the invocation of other hooks is 319hooks returns true, then the event counts as being I<consumed>, and the
297skipped, and the relevant action might not be carried out by the C++ code. 320relevant action might not be carried out by the C++ code.
298 321
299I<< When in doubt, return a false value (preferably C<()>). >> 322I<< When in doubt, return a false value (preferably C<()>). >>
300 323
301=over 4 324=over 4
302 325
303=item on_init $term 326=item on_init $term
304 327
305Called after a new terminal object has been initialized, but before 328Called after a new terminal object has been initialized, but before
306windows are created or the command gets run. Most methods are unsafe to 329windows are created or the command gets run. Most methods are unsafe to
307call or deliver senseless data, as terminal size and other characteristics 330call or deliver senseless data, as terminal size and other characteristics
308have not yet been determined. You can safely query and change resources, 331have not yet been determined. You can safely query and change resources
309though. 332and options, though. For many purposes the C<on_start> hook is a better
333place.
334
335=item on_start $term
336
337Called at the very end of initialisation of a new terminal, just before
338trying to map (display) the toplevel and returning to the mainloop.
339
340=item on_destroy $term
341
342Called whenever something tries to destroy terminal, before doing anything
343yet. If this hook returns true, then destruction is skipped, but this is
344rarely a good idea.
310 345
311=item on_reset $term 346=item on_reset $term
312 347
313Called after the screen is "reset" for any reason, such as resizing or 348Called after the screen is "reset" for any reason, such as resizing or
314control sequences. Here is where you can react on changes to size-related 349control sequences. Here is where you can react on changes to size-related
315variables. 350variables.
316 351
317=item on_start $term 352=item on_child_start $term, $pid
318 353
319Called at the very end of initialisation of a new terminal, just before 354Called just after the child process has been C<fork>ed.
320returning to the mainloop. 355
356=item on_child_exit $term, $status
357
358Called just after the child process has exited. C<$status> is the status
359from C<waitpid>.
321 360
322=item on_sel_make $term, $eventtime 361=item on_sel_make $term, $eventtime
323 362
324Called whenever a selection has been made by the user, but before the 363Called whenever a selection has been made by the user, but before the
325selection text is copied, so changes to the beginning, end or type of the 364selection text is copied, so changes to the beginning, end or type of the
434=item on_focus_out $term 473=item on_focus_out $term
435 474
436Called wheneever the window loses keyboard focus, before rxvt-unicode does 475Called wheneever the window loses keyboard focus, before rxvt-unicode does
437focus out processing. 476focus out processing.
438 477
478=item on_configure_notify $term, $event
479
439=item on_key_press $term, $event, $keysym, $octets 480=item on_key_press $term, $event, $keysym, $octets
440 481
441=item on_key_release $term, $event, $keysym 482=item on_key_release $term, $event, $keysym
442 483
443=item on_button_press $term, $event 484=item on_button_press $term, $event
459 500
460C<on_key_press> additionally receives the string rxvt-unicode would 501C<on_key_press> additionally receives the string rxvt-unicode would
461output, if any, in locale-specific encoding. 502output, if any, in locale-specific encoding.
462 503
463subwindow. 504subwindow.
505
506=item on_client_message $term, $event
507
508=item on_wm_protocols $term, $event
509
510=item on_wm_delete_window $term, $event
511
512Called when various types of ClientMessage events are received (all with
513format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
464 514
465=back 515=back
466 516
467=cut 517=cut
468 518
474use Scalar::Util (); 524use Scalar::Util ();
475use List::Util (); 525use List::Util ();
476 526
477our $VERSION = 1; 527our $VERSION = 1;
478our $TERM; 528our $TERM;
529our @TERM_INIT;
530our @TERM_EXT;
479our @HOOKNAME; 531our @HOOKNAME;
480our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 532our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
481our %OPTION; 533our %OPTION;
482 534
483our $LIBDIR; 535our $LIBDIR;
504 556
505=item $urxvt::TERM 557=item $urxvt::TERM
506 558
507The current terminal. This variable stores the current C<urxvt::term> 559The current terminal. This variable stores the current C<urxvt::term>
508object, whenever a callback/hook is executing. 560object, whenever a callback/hook is executing.
561
562=item @urxvt::TERM_INIT
563
564All coderefs in this array will be called as methods of the next newly
565created C<urxvt::term> object (during the C<on_init> phase). The array
566gets cleared before the codereferences that were in it are being executed,
567so coderefs can push themselves onto it again if they so desire.
568
569This complements to the perl-eval commandline option, but gets executed
570first.
571
572=item @urxvt::TERM_EXT
573
574Works similar to C<@TERM_INIT>, but contains perl package/class names, which
575get registered as normal extensions after calling the hooks in C<@TERM_INIT>
576but before other extensions. Gets cleared just like C<@TERM_INIT>.
509 577
510=back 578=back
511 579
512=head2 Functions in the C<urxvt> Package 580=head2 Functions in the C<urxvt> Package
513 581
620 my $msg = join "", @_; 688 my $msg = join "", @_;
621 $msg .= "\n" 689 $msg .= "\n"
622 unless $msg =~ /\n$/; 690 unless $msg =~ /\n$/;
623 urxvt::warn ($msg); 691 urxvt::warn ($msg);
624 }; 692 };
625
626 # %ENV is the original startup environment
627 delete $ENV{IFS};
628 delete $ENV{CDPATH};
629 delete $ENV{BASH_ENV};
630 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
631} 693}
632 694
633my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 695my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
634 696
635sub verbose { 697sub verbose {
640my %extension_pkg; 702my %extension_pkg;
641 703
642# load a single script into its own package, once only 704# load a single script into its own package, once only
643sub extension_package($) { 705sub extension_package($) {
644 my ($path) = @_; 706 my ($path) = @_;
645
646 no strict 'refs';
647 707
648 $extension_pkg{$path} ||= do { 708 $extension_pkg{$path} ||= do {
649 $path =~ /([^\/\\]+)$/; 709 $path =~ /([^\/\\]+)$/;
650 my $pkg = $1; 710 my $pkg = $1;
651 $pkg =~ s/[^[:word:]]/_/g; 711 $pkg =~ s/[^[:word:]]/_/g;
654 verbose 3, "loading extension '$path' into package '$pkg'"; 714 verbose 3, "loading extension '$path' into package '$pkg'";
655 715
656 open my $fh, "<:raw", $path 716 open my $fh, "<:raw", $path
657 or die "$path: $!"; 717 or die "$path: $!";
658 718
659 @{"$pkg\::ISA"} = urxvt::term::extension::;
660
661 my $source = 719 my $source =
662 "package $pkg; use strict; use utf8;\n" 720 "package $pkg; use strict; use utf8;\n"
663 . "#line 1 \"$path\"\n{\n" 721 . "#line 1 \"$path\"\n{\n"
664 . (do { local $/; <$fh> }) 722 . (do { local $/; <$fh> })
665 . "\n};\n1"; 723 . "\n};\n1";
681 if ($htype == 0) { # INIT 739 if ($htype == 0) { # INIT
682 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 740 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
683 741
684 my %ext_arg; 742 my %ext_arg;
685 743
744 {
745 my @init = @TERM_INIT;
746 @TERM_INIT = ();
747 $_->($TERM) for @init;
748 my @pkg = @TERM_EXT;
749 @TERM_EXT = ();
750 $TERM->register_package ($_) for @pkg;
751 }
752
686 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 753 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
687 if ($_ eq "default") { 754 if ($_ eq "default") {
688 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 755 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
689 } elsif (/^-(.*)$/) { 756 } elsif (/^-(.*)$/) {
690 delete $ext_arg{$1}; 757 delete $ext_arg{$1};
691 } elsif (/^([^<]+)<(.*)>$/) { 758 } elsif (/^([^<]+)<(.*)>$/) {
716 if $verbosity >= 10; 783 if $verbosity >= 10;
717 784
718 keys %$cb; 785 keys %$cb;
719 786
720 while (my ($pkg, $cb) = each %$cb) { 787 while (my ($pkg, $cb) = each %$cb) {
721 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 788 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
722 and last; 789 $retval ||= $retval_;
723 790
724 if ($@) { 791 if ($@) {
725 $TERM->ungrab; # better to lose the grab than the session 792 $TERM->ungrab; # better to lose the grab than the session
726 warn $@; 793 warn $@;
727 } 794 }
738 # clear package 805 # clear package
739 %$TERM = (); 806 %$TERM = ();
740 } 807 }
741 808
742 $retval 809 $retval
743}
744
745sub exec_async(@) {
746 my $pid = fork;
747
748 return
749 if !defined $pid or $pid;
750
751 %ENV = %{ $TERM->env };
752
753 exec @_;
754 _exit 255;
755} 810}
756 811
757# urxvt::term::extension 812# urxvt::term::extension
758 813
759package urxvt::term::extension; 814package urxvt::term::extension;
898# find on_xxx subs in the package and register them 953# find on_xxx subs in the package and register them
899# as hooks 954# as hooks
900sub register_package { 955sub register_package {
901 my ($self, $pkg, $argv) = @_; 956 my ($self, $pkg, $argv) = @_;
902 957
958 no strict 'refs';
959
960 urxvt::verbose 6, "register package $pkg to $self";
961
962 @{"$pkg\::ISA"} = urxvt::term::extension::;
963
903 my $proxy = bless { 964 my $proxy = bless {
904 _pkg => $pkg, 965 _pkg => $pkg,
905 argv => $argv, 966 argv => $argv,
906 }, $pkg; 967 }, $pkg;
907 Scalar::Util::weaken ($proxy->{term} = $self); 968 Scalar::Util::weaken ($proxy->{term} = $self);
938 999
939Destroy the terminal object (close the window, free resources 1000Destroy the terminal object (close the window, free resources
940etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1001etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
941watchers (timers, io watchers) are still active. 1002watchers (timers, io watchers) are still active.
942 1003
1004=item $term->exec_async ($cmd[, @args])
1005
1006Works like the combination of the C<fork>/C<exec> builtins, which executes
1007("starts") programs in the background. This function takes care of setting
1008the user environment before exec'ing the command (e.g. C<PATH>) and should
1009be preferred over explicit calls to C<exec> or C<system>.
1010
1011Returns the pid of the subprocess or C<undef> on error.
1012
1013=cut
1014
1015sub exec_async {
1016 my $self = shift;
1017
1018 my $pid = fork;
1019
1020 return $pid
1021 if !defined $pid or $pid;
1022
1023 %ENV = %{ $self->env };
1024
1025 exec @_;
1026 urxvt::_exit 255;
1027}
1028
943=item $isset = $term->option ($optval[, $set]) 1029=item $isset = $term->option ($optval[, $set])
944 1030
945Returns true if the option specified by C<$optval> is enabled, and 1031Returns true if the option specified by C<$optval> is enabled, and
946optionally change it. All option values are stored by name in the hash 1032optionally change it. All option values are stored by name in the hash
947C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1033C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
949Here is a a likely non-exhaustive list of option names, please see the 1035Here is a a likely non-exhaustive list of option names, please see the
950source file F</src/optinc.h> to see the actual list: 1036source file F</src/optinc.h> to see the actual list:
951 1037
952 borderLess console cursorBlink cursorUnderline hold iconic insecure 1038 borderLess console cursorBlink cursorUnderline hold iconic insecure
953 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1039 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
954 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1040 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
955 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1041 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
956 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1042 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
957 tripleclickwords utmpInhibit visualBell 1043 transparent tripleclickwords utmpInhibit visualBell
958 1044
959=item $value = $term->resource ($name[, $newval]) 1045=item $value = $term->resource ($name[, $newval])
960 1046
961Returns the current resource value associated with a given name and 1047Returns the current resource value associated with a given name and
962optionally sets a new value. Setting values is most useful in the C<init> 1048optionally sets a new value. Setting values is most useful in the C<init>
979 1065
980 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1066 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
981 borderLess color cursorBlink cursorUnderline cutchars delete_key 1067 borderLess color cursorBlink cursorUnderline cutchars delete_key
982 display_name embed ext_bwidth fade font geometry hold iconName 1068 display_name embed ext_bwidth fade font geometry hold iconName
983 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1069 imFont imLocale inputMethod insecure int_bwidth intensityStyles
984 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1070 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
985 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1071 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
986 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1072 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
987 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1073 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
988 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1074 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
989 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1075 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
990 shade term_name title transparent transparent_all tripleclickwords 1076 secondaryScreen secondaryScroll selectstyle shade term_name title
991 utmpInhibit visualBell 1077 transient_for transparent transparent_all tripleclickwords utmpInhibit
1078 visualBell
992 1079
993=cut 1080=cut
994 1081
995sub resource($$;$) { 1082sub resource($$;$) {
996 my ($self, $name) = (shift, shift); 1083 my ($self, $name) = (shift, shift);
1588 my $env = $self->{term}->env; 1675 my $env = $self->{term}->env;
1589 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1676 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1590 delete $env->{LC_ALL}; 1677 delete $env->{LC_ALL};
1591 $env->{LC_CTYPE} = $self->{term}->locale; 1678 $env->{LC_CTYPE} = $self->{term}->locale;
1592 1679
1593 urxvt::term->new ($env, $self->{term}->resource ("name"), 1680 urxvt::term->new ($env, "popup",
1594 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1681 "--perl-lib" => "", "--perl-ext-common" => "",
1682 "-pty-fd" => -1, "-sl" => 0,
1683 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1595 "--transient-for" => $self->{term}->parent, 1684 "--transient-for" => $self->{term}->parent,
1596 "-display" => $self->{term}->display_id, 1685 "-display" => $self->{term}->display_id,
1597 "-pe" => "urxvt-popup") 1686 "-pe" => "urxvt-popup")
1598 or die "unable to create popup window\n"; 1687 or die "unable to create popup window\n";
1599} 1688}
1604 delete $self->{term}{_destroy}{$self}; 1693 delete $self->{term}{_destroy}{$self};
1605 $self->{term}->ungrab; 1694 $self->{term}->ungrab;
1606} 1695}
1607 1696
1608=back 1697=back
1698
1699=cut
1700
1701package urxvt::watcher;
1702
1703@urxvt::timer::ISA = __PACKAGE__;
1704@urxvt::iow::ISA = __PACKAGE__;
1705@urxvt::pw::ISA = __PACKAGE__;
1706@urxvt::iw::ISA = __PACKAGE__;
1609 1707
1610=head2 The C<urxvt::timer> Class 1708=head2 The C<urxvt::timer> Class
1611 1709
1612This class implements timer watchers/events. Time is represented as a 1710This class implements timer watchers/events. Time is represented as a
1613fractional number of seconds since the epoch. Example: 1711fractional number of seconds since the epoch. Example:
1651Start the timer. 1749Start the timer.
1652 1750
1653=item $timer = $timer->start ($tstamp) 1751=item $timer = $timer->start ($tstamp)
1654 1752
1655Set the event trigger time to C<$tstamp> and start the timer. 1753Set the event trigger time to C<$tstamp> and start the timer.
1754
1755=item $timer = $timer->after ($delay)
1756
1757Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1656 1758
1657=item $timer = $timer->stop 1759=item $timer = $timer->stop
1658 1760
1659Stop the timer. 1761Stop the timer.
1660 1762
1707 1809
1708Stop watching for events on the given filehandle. 1810Stop watching for events on the given filehandle.
1709 1811
1710=back 1812=back
1711 1813
1814=head2 The C<urxvt::iw> Class
1815
1816This class implements idle watchers, that get called automatically when
1817the process is idle. They should return as fast as possible, after doing
1818some useful work.
1819
1820=over 4
1821
1822=item $iw = new urxvt::iw
1823
1824Create a new idle watcher object in stopped state.
1825
1826=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1827
1828Set the callback to be called when the watcher triggers.
1829
1830=item $timer = $timer->start
1831
1832Start the watcher.
1833
1834=item $timer = $timer->stop
1835
1836Stop the watcher.
1837
1838=back
1839
1840=head2 The C<urxvt::pw> Class
1841
1842This class implements process watchers. They create an event whenever a
1843process exits, after which they stop automatically.
1844
1845 my $pid = fork;
1846 ...
1847 $term->{pw} = urxvt::pw
1848 ->new
1849 ->start ($pid)
1850 ->cb (sub {
1851 my ($pw, $exit_status) = @_;
1852 ...
1853 });
1854
1855=over 4
1856
1857=item $pw = new urxvt::pw
1858
1859Create a new process watcher in stopped state.
1860
1861=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1862
1863Set the callback to be called when the timer triggers.
1864
1865=item $pw = $timer->start ($pid)
1866
1867Tells the wqtcher to start watching for process C<$pid>.
1868
1869=item $pw = $pw->stop
1870
1871Stop the watcher.
1872
1873=back
1874
1712=head1 ENVIRONMENT 1875=head1 ENVIRONMENT
1713 1876
1714=head2 URXVT_PERL_VERBOSITY 1877=head2 URXVT_PERL_VERBOSITY
1715 1878
1716This variable controls the verbosity level of the perl extension. Higher 1879This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines