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.116 by root, Fri Jan 20 16:18:07 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.
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 B<Shift-Left> and
175B<Shift-Right> will switch to the tab left or right of the current one,
176while B<Shift-Down> creates a new tab.
143 177
144=item mark-urls 178=item mark-urls
145 179
146Uses per-line display filtering (C<on_line_update>) to underline urls and 180Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the 181make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 182resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 183the URL as first argument.
150 184
185=item automove-background
186
187This is basically a one-line extension that dynamically changes the background pixmap offset
188to the window position, in effect creating the same effect as pseudo transparency with
189a custom pixmap. No scaling is supported in this mode. Exmaple:
190
191 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
192
151=item block-graphics-to-ascii 193=item block-graphics-to-ascii
152 194
153A not very useful example of filtering all text output to the terminal, 195A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 196by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 197similar-looking ascii character.
165overlays or changes. 207overlays or changes.
166 208
167=item selection-pastebin 209=item selection-pastebin
168 210
169This is a little rarely useful extension that Uploads the selection as 211This is a little rarely useful extension that Uploads the selection as
170textfile to a remote site (or does other things). 212textfile to a remote site (or does other things). (The implementation is
213not currently secure for use in a multiuser environment as it writes to
214F</tmp> directly.).
171 215
172It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 216It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173i.e. 217i.e.
174 218
175 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 219 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
270called whenever the relevant event happens. 314called whenever the relevant event happens.
271 315
272The first argument passed to them is an extension oject as described in 316The first argument passed to them is an extension oject as described in
273the in the C<Extension Objects> section. 317the in the C<Extension Objects> section.
274 318
275B<All> of these hooks must return a boolean value. If it is true, then the 319B<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 320hooks 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. 321relevant action might not be carried out by the C++ code.
278 322
279I<< When in doubt, return a false value (preferably C<()>). >> 323I<< When in doubt, return a false value (preferably C<()>). >>
280 324
281=over 4 325=over 4
282 326
283=item on_init $term 327=item on_init $term
284 328
285Called after a new terminal object has been initialized, but before 329Called after a new terminal object has been initialized, but before
286windows are created or the command gets run. Most methods are unsafe to 330windows are created or the command gets run. Most methods are unsafe to
287call or deliver senseless data, as terminal size and other characteristics 331call or deliver senseless data, as terminal size and other characteristics
288have not yet been determined. You can safely query and change resources, 332have not yet been determined. You can safely query and change resources
289though. 333and options, though. For many purposes the C<on_start> hook is a better
334place.
335
336=item on_start $term
337
338Called at the very end of initialisation of a new terminal, just before
339trying to map (display) the toplevel and returning to the mainloop.
340
341=item on_destroy $term
342
343Called whenever something tries to destroy terminal, before doing anything
344yet. If this hook returns true, then destruction is skipped, but this is
345rarely a good idea.
290 346
291=item on_reset $term 347=item on_reset $term
292 348
293Called after the screen is "reset" for any reason, such as resizing or 349Called 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 350control sequences. Here is where you can react on changes to size-related
295variables. 351variables.
296 352
297=item on_start $term 353=item on_child_start $term, $pid
298 354
299Called at the very end of initialisation of a new terminal, just before 355Called just after the child process has been C<fork>ed.
300returning to the mainloop. 356
357=item on_child_exit $term, $status
358
359Called just after the child process has exited. C<$status> is the status
360from C<waitpid>.
301 361
302=item on_sel_make $term, $eventtime 362=item on_sel_make $term, $eventtime
303 363
304Called whenever a selection has been made by the user, but before the 364Called 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 365selection text is copied, so changes to the beginning, end or type of the
414=item on_focus_out $term 474=item on_focus_out $term
415 475
416Called wheneever the window loses keyboard focus, before rxvt-unicode does 476Called wheneever the window loses keyboard focus, before rxvt-unicode does
417focus out processing. 477focus out processing.
418 478
479=item on_configure_notify $term, $event
480
419=item on_key_press $term, $event, $keysym, $octets 481=item on_key_press $term, $event, $keysym, $octets
420 482
421=item on_key_release $term, $event, $keysym 483=item on_key_release $term, $event, $keysym
422 484
423=item on_button_press $term, $event 485=item on_button_press $term, $event
439 501
440C<on_key_press> additionally receives the string rxvt-unicode would 502C<on_key_press> additionally receives the string rxvt-unicode would
441output, if any, in locale-specific encoding. 503output, if any, in locale-specific encoding.
442 504
443subwindow. 505subwindow.
506
507=item on_client_message $term, $event
508
509=item on_wm_protocols $term, $event
510
511=item on_wm_delete_window $term, $event
512
513Called when various types of ClientMessage events are received (all with
514format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
444 515
445=back 516=back
446 517
447=cut 518=cut
448 519
454use Scalar::Util (); 525use Scalar::Util ();
455use List::Util (); 526use List::Util ();
456 527
457our $VERSION = 1; 528our $VERSION = 1;
458our $TERM; 529our $TERM;
530our @TERM_INIT;
531our @TERM_EXT;
459our @HOOKNAME; 532our @HOOKNAME;
460our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 533our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461our %OPTION; 534our %OPTION;
462 535
463our $LIBDIR; 536our $LIBDIR;
484 557
485=item $urxvt::TERM 558=item $urxvt::TERM
486 559
487The current terminal. This variable stores the current C<urxvt::term> 560The current terminal. This variable stores the current C<urxvt::term>
488object, whenever a callback/hook is executing. 561object, whenever a callback/hook is executing.
562
563=item @urxvt::TERM_INIT
564
565All coderefs in this array will be called as methods of the next newly
566created C<urxvt::term> object (during the C<on_init> phase). The array
567gets cleared before the codereferences that were in it are being executed,
568so coderefs can push themselves onto it again if they so desire.
569
570This complements to the perl-eval commandline option, but gets executed
571first.
572
573=item @urxvt::TERM_EXT
574
575Works similar to C<@TERM_INIT>, but contains perl package/class names, which
576get registered as normal extensions after calling the hooks in C<@TERM_INIT>
577but before other extensions. Gets cleared just like C<@TERM_INIT>.
489 578
490=back 579=back
491 580
492=head2 Functions in the C<urxvt> Package 581=head2 Functions in the C<urxvt> Package
493 582
593=back 682=back
594 683
595=cut 684=cut
596 685
597BEGIN { 686BEGIN {
598 urxvt->bootstrap;
599
600 # overwrite perl's warn 687 # overwrite perl's warn
601 *CORE::GLOBAL::warn = sub { 688 *CORE::GLOBAL::warn = sub {
602 my $msg = join "", @_; 689 my $msg = join "", @_;
603 $msg .= "\n" 690 $msg .= "\n"
604 unless $msg =~ /\n$/; 691 unless $msg =~ /\n$/;
605 urxvt::warn ($msg); 692 urxvt::warn ($msg);
606 }; 693 };
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} 694}
614 695
615my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 696my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616 697
617sub verbose { 698sub verbose {
618 my ($level, $msg) = @_; 699 my ($level, $msg) = @_;
619 warn "$msg\n" if $level <= $verbosity; 700 warn "$msg\n" if $level <= $verbosity;
620} 701}
621 702
622my $extension_pkg = "extension0000";
623my %extension_pkg; 703my %extension_pkg;
624 704
625# load a single script into its own package, once only 705# load a single script into its own package, once only
626sub extension_package($) { 706sub extension_package($) {
627 my ($path) = @_; 707 my ($path) = @_;
628 708
629 $extension_pkg{$path} ||= do { 709 $extension_pkg{$path} ||= do {
630 my $pkg = "urxvt::" . ($extension_pkg++); 710 $path =~ /([^\/\\]+)$/;
711 my $pkg = $1;
712 $pkg =~ s/[^[:word:]]/_/g;
713 $pkg = "urxvt::ext::$pkg";
631 714
632 verbose 3, "loading extension '$path' into package '$pkg'"; 715 verbose 3, "loading extension '$path' into package '$pkg'";
633 716
634 open my $fh, "<:raw", $path 717 open my $fh, "<:raw", $path
635 or die "$path: $!"; 718 or die "$path: $!";
636 719
637 my $source = 720 my $source =
638 "package $pkg; use strict; use utf8;\n" 721 "package $pkg; use strict; use utf8;\n"
639 . "use base urxvt::term::extension::;\n"
640 . "#line 1 \"$path\"\n{\n" 722 . "#line 1 \"$path\"\n{\n"
641 . (do { local $/; <$fh> }) 723 . (do { local $/; <$fh> })
642 . "\n};\n1"; 724 . "\n};\n1";
643 725
644 eval $source 726 eval $source
658 if ($htype == 0) { # INIT 740 if ($htype == 0) { # INIT
659 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 741 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
660 742
661 my %ext_arg; 743 my %ext_arg;
662 744
745 {
746 my @init = @TERM_INIT;
747 @TERM_INIT = ();
748 $_->($TERM) for @init;
749 my @pkg = @TERM_EXT;
750 @TERM_EXT = ();
751 $TERM->register_package ($_) for @pkg;
752 }
753
663 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 754 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
664 if ($_ eq "default") { 755 if ($_ eq "default") {
665 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 756 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
666 } elsif (/^-(.*)$/) { 757 } elsif (/^-(.*)$/) {
667 delete $ext_arg{$1}; 758 delete $ext_arg{$1};
668 } elsif (/^([^<]+)<(.*)>$/) { 759 } elsif (/^([^<]+)<(.*)>$/) {
693 if $verbosity >= 10; 784 if $verbosity >= 10;
694 785
695 keys %$cb; 786 keys %$cb;
696 787
697 while (my ($pkg, $cb) = each %$cb) { 788 while (my ($pkg, $cb) = each %$cb) {
698 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 789 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
699 and last; 790 $retval ||= $retval_;
700 791
701 if ($@) { 792 if ($@) {
702 $TERM->ungrab; # better to lose the grab than the session 793 $TERM->ungrab; # better to lose the grab than the session
703 warn $@; 794 warn $@;
704 } 795 }
715 # clear package 806 # clear package
716 %$TERM = (); 807 %$TERM = ();
717 } 808 }
718 809
719 $retval 810 $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} 811}
733 812
734# urxvt::term::extension 813# urxvt::term::extension
735 814
736package urxvt::term::extension; 815package urxvt::term::extension;
875# find on_xxx subs in the package and register them 954# find on_xxx subs in the package and register them
876# as hooks 955# as hooks
877sub register_package { 956sub register_package {
878 my ($self, $pkg, $argv) = @_; 957 my ($self, $pkg, $argv) = @_;
879 958
959 no strict 'refs';
960
961 urxvt::verbose 6, "register package $pkg to $self";
962
963 @{"$pkg\::ISA"} = urxvt::term::extension::;
964
880 my $proxy = bless { 965 my $proxy = bless {
881 _pkg => $pkg, 966 _pkg => $pkg,
882 argv => $argv, 967 argv => $argv,
883 }, $pkg; 968 }, $pkg;
884 Scalar::Util::weaken ($proxy->{term} = $self); 969 Scalar::Util::weaken ($proxy->{term} = $self);
915 1000
916Destroy the terminal object (close the window, free resources 1001Destroy the terminal object (close the window, free resources
917etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1002etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
918watchers (timers, io watchers) are still active. 1003watchers (timers, io watchers) are still active.
919 1004
1005=item $term->exec_async ($cmd[, @args])
1006
1007Works like the combination of the C<fork>/C<exec> builtins, which executes
1008("starts") programs in the background. This function takes care of setting
1009the user environment before exec'ing the command (e.g. C<PATH>) and should
1010be preferred over explicit calls to C<exec> or C<system>.
1011
1012Returns the pid of the subprocess or C<undef> on error.
1013
1014=cut
1015
1016sub exec_async {
1017 my $self = shift;
1018
1019 my $pid = fork;
1020
1021 return $pid
1022 if !defined $pid or $pid;
1023
1024 %ENV = %{ $self->env };
1025
1026 exec @_;
1027 urxvt::_exit 255;
1028}
1029
920=item $isset = $term->option ($optval[, $set]) 1030=item $isset = $term->option ($optval[, $set])
921 1031
922Returns true if the option specified by C<$optval> is enabled, and 1032Returns true if the option specified by C<$optval> is enabled, and
923optionally change it. All option values are stored by name in the hash 1033optionally 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. 1034C<%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 1036Here is a a likely non-exhaustive list of option names, please see the
927source file F</src/optinc.h> to see the actual list: 1037source file F</src/optinc.h> to see the actual list:
928 1038
929 borderLess console cursorBlink cursorUnderline hold iconic insecure 1039 borderLess console cursorBlink cursorUnderline hold iconic insecure
930 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1040 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1041 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1042 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1043 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934 tripleclickwords utmpInhibit visualBell 1044 transparent tripleclickwords utmpInhibit visualBell
935 1045
936=item $value = $term->resource ($name[, $newval]) 1046=item $value = $term->resource ($name[, $newval])
937 1047
938Returns the current resource value associated with a given name and 1048Returns the current resource value associated with a given name and
939optionally sets a new value. Setting values is most useful in the C<init> 1049optionally sets a new value. Setting values is most useful in the C<init>
956 1066
957 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1067 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958 borderLess color cursorBlink cursorUnderline cutchars delete_key 1068 borderLess color cursorBlink cursorUnderline cutchars delete_key
959 display_name embed ext_bwidth fade font geometry hold iconName 1069 display_name embed ext_bwidth fade font geometry hold iconName
960 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1070 imFont imLocale inputMethod insecure int_bwidth intensityStyles
961 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1071 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1072 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1073 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1074 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1075 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1076 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967 shade term_name title transparent transparent_all tripleclickwords 1077 secondaryScreen secondaryScroll selectstyle shade term_name title
968 utmpInhibit visualBell 1078 transient_for transparent transparent_all tripleclickwords utmpInhibit
1079 visualBell
969 1080
970=cut 1081=cut
971 1082
972sub resource($$;$) { 1083sub resource($$;$) {
973 my ($self, $name) = (shift, shift); 1084 my ($self, $name) = (shift, shift);
1565 my $env = $self->{term}->env; 1676 my $env = $self->{term}->env;
1566 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1677 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1567 delete $env->{LC_ALL}; 1678 delete $env->{LC_ALL};
1568 $env->{LC_CTYPE} = $self->{term}->locale; 1679 $env->{LC_CTYPE} = $self->{term}->locale;
1569 1680
1570 urxvt::term->new ($env, $self->{term}->resource ("name"), 1681 urxvt::term->new ($env, "popup",
1571 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1682 "--perl-lib" => "", "--perl-ext-common" => "",
1683 "-pty-fd" => -1, "-sl" => 0,
1684 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572 "--transient-for" => $self->{term}->parent, 1685 "--transient-for" => $self->{term}->parent,
1573 "-display" => $self->{term}->display_id, 1686 "-display" => $self->{term}->display_id,
1574 "-pe" => "urxvt-popup") 1687 "-pe" => "urxvt-popup")
1575 or die "unable to create popup window\n"; 1688 or die "unable to create popup window\n";
1576} 1689}
1581 delete $self->{term}{_destroy}{$self}; 1694 delete $self->{term}{_destroy}{$self};
1582 $self->{term}->ungrab; 1695 $self->{term}->ungrab;
1583} 1696}
1584 1697
1585=back 1698=back
1699
1700=cut
1701
1702package urxvt::watcher;
1703
1704@urxvt::timer::ISA = __PACKAGE__;
1705@urxvt::iow::ISA = __PACKAGE__;
1706@urxvt::pw::ISA = __PACKAGE__;
1707@urxvt::iw::ISA = __PACKAGE__;
1586 1708
1587=head2 The C<urxvt::timer> Class 1709=head2 The C<urxvt::timer> Class
1588 1710
1589This class implements timer watchers/events. Time is represented as a 1711This class implements timer watchers/events. Time is represented as a
1590fractional number of seconds since the epoch. Example: 1712fractional number of seconds since the epoch. Example:
1628Start the timer. 1750Start the timer.
1629 1751
1630=item $timer = $timer->start ($tstamp) 1752=item $timer = $timer->start ($tstamp)
1631 1753
1632Set the event trigger time to C<$tstamp> and start the timer. 1754Set the event trigger time to C<$tstamp> and start the timer.
1755
1756=item $timer = $timer->after ($delay)
1757
1758Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633 1759
1634=item $timer = $timer->stop 1760=item $timer = $timer->stop
1635 1761
1636Stop the timer. 1762Stop the timer.
1637 1763
1684 1810
1685Stop watching for events on the given filehandle. 1811Stop watching for events on the given filehandle.
1686 1812
1687=back 1813=back
1688 1814
1815=head2 The C<urxvt::iw> Class
1816
1817This class implements idle watchers, that get called automatically when
1818the process is idle. They should return as fast as possible, after doing
1819some useful work.
1820
1821=over 4
1822
1823=item $iw = new urxvt::iw
1824
1825Create a new idle watcher object in stopped state.
1826
1827=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1828
1829Set the callback to be called when the watcher triggers.
1830
1831=item $timer = $timer->start
1832
1833Start the watcher.
1834
1835=item $timer = $timer->stop
1836
1837Stop the watcher.
1838
1839=back
1840
1841=head2 The C<urxvt::pw> Class
1842
1843This class implements process watchers. They create an event whenever a
1844process exits, after which they stop automatically.
1845
1846 my $pid = fork;
1847 ...
1848 $term->{pw} = urxvt::pw
1849 ->new
1850 ->start ($pid)
1851 ->cb (sub {
1852 my ($pw, $exit_status) = @_;
1853 ...
1854 });
1855
1856=over 4
1857
1858=item $pw = new urxvt::pw
1859
1860Create a new process watcher in stopped state.
1861
1862=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1863
1864Set the callback to be called when the timer triggers.
1865
1866=item $pw = $timer->start ($pid)
1867
1868Tells the wqtcher to start watching for process C<$pid>.
1869
1870=item $pw = $pw->stop
1871
1872Stop the watcher.
1873
1874=back
1875
1689=head1 ENVIRONMENT 1876=head1 ENVIRONMENT
1690 1877
1691=head2 URXVT_PERL_VERBOSITY 1878=head2 URXVT_PERL_VERBOSITY
1692 1879
1693This variable controls the verbosity level of the perl extension. Higher 1880This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines