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.97 by elmex, Tue Jan 17 16:53:47 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
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 Shift-Left and
175Shift-Right will switch to the tab left or right of the current one.
143 176
144=item mark-urls 177=item mark-urls
145 178
146Uses 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
147make them clickable. When middle-clicked, the program specified in the 180make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 181resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 182the URL as first argument.
150 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
191
151=item block-graphics-to-ascii 192=item block-graphics-to-ascii
152 193
153A 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,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 195by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 196similar-looking ascii character.
164window. Illustrates overwriting the refresh callbacks to create your own 205window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 206overlays or changes.
166 207
167=item selection-pastebin 208=item selection-pastebin
168 209
169Uploads the selection as textfile to a remote site. 210This is a little rarely useful extension that Uploads the selection as
211textfile to a remote site (or does other things). (The implementation is
212not currently secure for use in a multiuser environment as it writes to
213F</tmp> directly.).
214
215It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
216i.e.
170 217
171 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 218 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
172 219
173To set the command to upload the file set this resource: 220Pressing this combination runs a command with C<%> replaced by the name of
221the textfile. This command can be set via a resource:
174 222
175 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. 223 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
176 224
177The % is the placeholder for the textfile. The name of the textfile is the hex encoded 225And the default is likely not useful to anybody but the few people around
178md5 sum of the selection. 226here :)
227
228The name of the textfile is the hex encoded md5 sum of the selection, so
229the same content should lead to the same filename.
230
179After an successful upload the selection will be replaced by the following url 231After a successful upload the selection will be replaced by the text given
180(the % is the placeholder for the filename): 232in the C<selection-pastebin-url> resource (again, the % is the placeholder
233for the filename):
181 234
182 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/% 235 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
183 236
184=back 237=back
185 238
186=head1 API DOCUMENTATION 239=head1 API DOCUMENTATION
187 240
260called whenever the relevant event happens. 313called whenever the relevant event happens.
261 314
262The 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
263the in the C<Extension Objects> section. 316the in the C<Extension Objects> section.
264 317
265B<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
266event 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
267skipped, and the relevant action might not be carried out by the C++ code. 320relevant action might not be carried out by the C++ code.
268 321
269I<< When in doubt, return a false value (preferably C<()>). >> 322I<< When in doubt, return a false value (preferably C<()>). >>
270 323
271=over 4 324=over 4
272 325
273=item on_init $term 326=item on_init $term
274 327
275Called after a new terminal object has been initialized, but before 328Called after a new terminal object has been initialized, but before
276windows 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
277call or deliver senseless data, as terminal size and other characteristics 330call or deliver senseless data, as terminal size and other characteristics
278have not yet been determined. You can safely query and change resources, 331have not yet been determined. You can safely query and change resources
279though. 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.
280 345
281=item on_reset $term 346=item on_reset $term
282 347
283Called 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
284control 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
285variables. 350variables.
286 351
287=item on_start $term 352=item on_child_start $term, $pid
288 353
289Called at the very end of initialisation of a new terminal, just before 354Called just after the child process has been C<fork>ed.
290returning 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>.
291 360
292=item on_sel_make $term, $eventtime 361=item on_sel_make $term, $eventtime
293 362
294Called 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
295selection 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
404=item on_focus_out $term 473=item on_focus_out $term
405 474
406Called wheneever the window loses keyboard focus, before rxvt-unicode does 475Called wheneever the window loses keyboard focus, before rxvt-unicode does
407focus out processing. 476focus out processing.
408 477
478=item on_configure_notify $term, $event
479
409=item on_key_press $term, $event, $keysym, $octets 480=item on_key_press $term, $event, $keysym, $octets
410 481
411=item on_key_release $term, $event, $keysym 482=item on_key_release $term, $event, $keysym
412 483
413=item on_button_press $term, $event 484=item on_button_press $term, $event
429 500
430C<on_key_press> additionally receives the string rxvt-unicode would 501C<on_key_press> additionally receives the string rxvt-unicode would
431output, if any, in locale-specific encoding. 502output, if any, in locale-specific encoding.
432 503
433subwindow. 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).
434 514
435=back 515=back
436 516
437=cut 517=cut
438 518
444use Scalar::Util (); 524use Scalar::Util ();
445use List::Util (); 525use List::Util ();
446 526
447our $VERSION = 1; 527our $VERSION = 1;
448our $TERM; 528our $TERM;
529our @TERM_INIT;
530our @TERM_EXT;
449our @HOOKNAME; 531our @HOOKNAME;
450our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 532our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451our %OPTION; 533our %OPTION;
452 534
453our $LIBDIR; 535our $LIBDIR;
474 556
475=item $urxvt::TERM 557=item $urxvt::TERM
476 558
477The current terminal. This variable stores the current C<urxvt::term> 559The current terminal. This variable stores the current C<urxvt::term>
478object, 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>.
479 577
480=back 578=back
481 579
482=head2 Functions in the C<urxvt> Package 580=head2 Functions in the C<urxvt> Package
483 581
583=back 681=back
584 682
585=cut 683=cut
586 684
587BEGIN { 685BEGIN {
588 urxvt->bootstrap;
589
590 # overwrite perl's warn 686 # overwrite perl's warn
591 *CORE::GLOBAL::warn = sub { 687 *CORE::GLOBAL::warn = sub {
592 my $msg = join "", @_; 688 my $msg = join "", @_;
593 $msg .= "\n" 689 $msg .= "\n"
594 unless $msg =~ /\n$/; 690 unless $msg =~ /\n$/;
595 urxvt::warn ($msg); 691 urxvt::warn ($msg);
596 }; 692 };
597
598 # %ENV is the original startup environment
599 delete $ENV{IFS};
600 delete $ENV{CDPATH};
601 delete $ENV{BASH_ENV};
602 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
603} 693}
604 694
605my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 695my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
606 696
607sub verbose { 697sub verbose {
608 my ($level, $msg) = @_; 698 my ($level, $msg) = @_;
609 warn "$msg\n" if $level <= $verbosity; 699 warn "$msg\n" if $level <= $verbosity;
610} 700}
611 701
612my $extension_pkg = "extension0000";
613my %extension_pkg; 702my %extension_pkg;
614 703
615# load a single script into its own package, once only 704# load a single script into its own package, once only
616sub extension_package($) { 705sub extension_package($) {
617 my ($path) = @_; 706 my ($path) = @_;
618 707
619 $extension_pkg{$path} ||= do { 708 $extension_pkg{$path} ||= do {
620 my $pkg = "urxvt::" . ($extension_pkg++); 709 $path =~ /([^\/\\]+)$/;
710 my $pkg = $1;
711 $pkg =~ s/[^[:word:]]/_/g;
712 $pkg = "urxvt::ext::$pkg";
621 713
622 verbose 3, "loading extension '$path' into package '$pkg'"; 714 verbose 3, "loading extension '$path' into package '$pkg'";
623 715
624 open my $fh, "<:raw", $path 716 open my $fh, "<:raw", $path
625 or die "$path: $!"; 717 or die "$path: $!";
626 718
627 my $source = 719 my $source =
628 "package $pkg; use strict; use utf8;\n" 720 "package $pkg; use strict; use utf8;\n"
629 . "use base urxvt::term::extension::;\n"
630 . "#line 1 \"$path\"\n{\n" 721 . "#line 1 \"$path\"\n{\n"
631 . (do { local $/; <$fh> }) 722 . (do { local $/; <$fh> })
632 . "\n};\n1"; 723 . "\n};\n1";
633 724
634 eval $source 725 eval $source
648 if ($htype == 0) { # INIT 739 if ($htype == 0) { # INIT
649 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 740 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
650 741
651 my %ext_arg; 742 my %ext_arg;
652 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
653 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 753 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
654 if ($_ eq "default") { 754 if ($_ eq "default") {
655 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 755 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
656 } elsif (/^-(.*)$/) { 756 } elsif (/^-(.*)$/) {
657 delete $ext_arg{$1}; 757 delete $ext_arg{$1};
658 } elsif (/^([^<]+)<(.*)>$/) { 758 } elsif (/^([^<]+)<(.*)>$/) {
683 if $verbosity >= 10; 783 if $verbosity >= 10;
684 784
685 keys %$cb; 785 keys %$cb;
686 786
687 while (my ($pkg, $cb) = each %$cb) { 787 while (my ($pkg, $cb) = each %$cb) {
688 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 788 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
689 and last; 789 $retval ||= $retval_;
690 790
691 if ($@) { 791 if ($@) {
692 $TERM->ungrab; # better to lose the grab than the session 792 $TERM->ungrab; # better to lose the grab than the session
693 warn $@; 793 warn $@;
694 } 794 }
705 # clear package 805 # clear package
706 %$TERM = (); 806 %$TERM = ();
707 } 807 }
708 808
709 $retval 809 $retval
710}
711
712sub exec_async(@) {
713 my $pid = fork;
714
715 return
716 if !defined $pid or $pid;
717
718 %ENV = %{ $TERM->env };
719
720 exec @_;
721 _exit 255;
722} 810}
723 811
724# urxvt::term::extension 812# urxvt::term::extension
725 813
726package urxvt::term::extension; 814package urxvt::term::extension;
865# find on_xxx subs in the package and register them 953# find on_xxx subs in the package and register them
866# as hooks 954# as hooks
867sub register_package { 955sub register_package {
868 my ($self, $pkg, $argv) = @_; 956 my ($self, $pkg, $argv) = @_;
869 957
958 no strict 'refs';
959
960 urxvt::verbose 6, "register package $pkg to $self";
961
962 @{"$pkg\::ISA"} = urxvt::term::extension::;
963
870 my $proxy = bless { 964 my $proxy = bless {
871 _pkg => $pkg, 965 _pkg => $pkg,
872 argv => $argv, 966 argv => $argv,
873 }, $pkg; 967 }, $pkg;
874 Scalar::Util::weaken ($proxy->{term} = $self); 968 Scalar::Util::weaken ($proxy->{term} = $self);
905 999
906Destroy the terminal object (close the window, free resources 1000Destroy the terminal object (close the window, free resources
907etc.). 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
908watchers (timers, io watchers) are still active. 1002watchers (timers, io watchers) are still active.
909 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
910=item $isset = $term->option ($optval[, $set]) 1029=item $isset = $term->option ($optval[, $set])
911 1030
912Returns true if the option specified by C<$optval> is enabled, and 1031Returns true if the option specified by C<$optval> is enabled, and
913optionally 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
914C<%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.
916Here 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
917source file F</src/optinc.h> to see the actual list: 1036source file F</src/optinc.h> to see the actual list:
918 1037
919 borderLess console cursorBlink cursorUnderline hold iconic insecure 1038 borderLess console cursorBlink cursorUnderline hold iconic insecure
920 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1039 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
921 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1040 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
922 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1041 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
923 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1042 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
924 tripleclickwords utmpInhibit visualBell 1043 transparent tripleclickwords utmpInhibit visualBell
925 1044
926=item $value = $term->resource ($name[, $newval]) 1045=item $value = $term->resource ($name[, $newval])
927 1046
928Returns the current resource value associated with a given name and 1047Returns the current resource value associated with a given name and
929optionally 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>
946 1065
947 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1066 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
948 borderLess color cursorBlink cursorUnderline cutchars delete_key 1067 borderLess color cursorBlink cursorUnderline cutchars delete_key
949 display_name embed ext_bwidth fade font geometry hold iconName 1068 display_name embed ext_bwidth fade font geometry hold iconName
950 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1069 imFont imLocale inputMethod insecure int_bwidth intensityStyles
951 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1070 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
952 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1071 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
953 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1072 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
954 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1073 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
955 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1074 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
956 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1075 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
957 shade term_name title transparent transparent_all tripleclickwords 1076 secondaryScreen secondaryScroll selectstyle shade term_name title
958 utmpInhibit visualBell 1077 transient_for transparent transparent_all tripleclickwords utmpInhibit
1078 visualBell
959 1079
960=cut 1080=cut
961 1081
962sub resource($$;$) { 1082sub resource($$;$) {
963 my ($self, $name) = (shift, shift); 1083 my ($self, $name) = (shift, shift);
1555 my $env = $self->{term}->env; 1675 my $env = $self->{term}->env;
1556 # 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.
1557 delete $env->{LC_ALL}; 1677 delete $env->{LC_ALL};
1558 $env->{LC_CTYPE} = $self->{term}->locale; 1678 $env->{LC_CTYPE} = $self->{term}->locale;
1559 1679
1560 urxvt::term->new ($env, $self->{term}->resource ("name"), 1680 urxvt::term->new ($env, "popup",
1561 "--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",
1562 "--transient-for" => $self->{term}->parent, 1684 "--transient-for" => $self->{term}->parent,
1563 "-display" => $self->{term}->display_id, 1685 "-display" => $self->{term}->display_id,
1564 "-pe" => "urxvt-popup") 1686 "-pe" => "urxvt-popup")
1565 or die "unable to create popup window\n"; 1687 or die "unable to create popup window\n";
1566} 1688}
1571 delete $self->{term}{_destroy}{$self}; 1693 delete $self->{term}{_destroy}{$self};
1572 $self->{term}->ungrab; 1694 $self->{term}->ungrab;
1573} 1695}
1574 1696
1575=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__;
1576 1707
1577=head2 The C<urxvt::timer> Class 1708=head2 The C<urxvt::timer> Class
1578 1709
1579This class implements timer watchers/events. Time is represented as a 1710This class implements timer watchers/events. Time is represented as a
1580fractional number of seconds since the epoch. Example: 1711fractional number of seconds since the epoch. Example:
1618Start the timer. 1749Start the timer.
1619 1750
1620=item $timer = $timer->start ($tstamp) 1751=item $timer = $timer->start ($tstamp)
1621 1752
1622Set 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>.
1623 1758
1624=item $timer = $timer->stop 1759=item $timer = $timer->stop
1625 1760
1626Stop the timer. 1761Stop the timer.
1627 1762
1674 1809
1675Stop watching for events on the given filehandle. 1810Stop watching for events on the given filehandle.
1676 1811
1677=back 1812=back
1678 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
1679=head1 ENVIRONMENT 1875=head1 ENVIRONMENT
1680 1876
1681=head2 URXVT_PERL_VERBOSITY 1877=head2 URXVT_PERL_VERBOSITY
1682 1878
1683This 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