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.94 by root, Sun Jan 15 06:02:41 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
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
67 71
68You can look at the source of the selection extension to see more 72You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 73interesting uses, such as parsing a line from beginning to end.
70 74
71This extension also offers the following bindable keyboard command: 75This extension also offers following bindable keyboard commands:
72 76
73=over 4 77=over 4
74 78
75=item rot13 79=item rot13
76 80
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.
161=item example-refresh-hooks 202=item example-refresh-hooks
162 203
163Displays a very simple digital clock in the upper right corner of the 204Displays a very simple digital clock in the upper right corner of the
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.
207
208=item selection-pastebin
209
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.
217
218 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
219
220Pressing this combination runs a command with C<%> replaced by the name of
221the textfile. This command can be set via a resource:
222
223 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
224
225And the default is likely not useful to anybody but the few people around
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
231After a successful upload the selection will be replaced by the text given
232in the C<selection-pastebin-url> resource (again, the % is the placeholder
233for the filename):
234
235 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166 236
167=back 237=back
168 238
169=head1 API DOCUMENTATION 239=head1 API DOCUMENTATION
170 240
243called whenever the relevant event happens. 313called whenever the relevant event happens.
244 314
245The 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
246the in the C<Extension Objects> section. 316the in the C<Extension Objects> section.
247 317
248B<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
249event 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
250skipped, and the relevant action might not be carried out by the C++ code. 320relevant action might not be carried out by the C++ code.
251 321
252I<< When in doubt, return a false value (preferably C<()>). >> 322I<< When in doubt, return a false value (preferably C<()>). >>
253 323
254=over 4 324=over 4
255 325
256=item on_init $term 326=item on_init $term
257 327
258Called after a new terminal object has been initialized, but before 328Called after a new terminal object has been initialized, but before
259windows 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
260call or deliver senseless data, as terminal size and other characteristics 330call or deliver senseless data, as terminal size and other characteristics
261have not yet been determined. You can safely query and change resources, 331have not yet been determined. You can safely query and change resources
262though. 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.
263 345
264=item on_reset $term 346=item on_reset $term
265 347
266Called 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
267control 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
268variables. 350variables.
269 351
270=item on_start $term 352=item on_child_start $term, $pid
271 353
272Called at the very end of initialisation of a new terminal, just before 354Called just after the child process has been C<fork>ed.
273returning 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>.
274 360
275=item on_sel_make $term, $eventtime 361=item on_sel_make $term, $eventtime
276 362
277Called 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
278selection 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
387=item on_focus_out $term 473=item on_focus_out $term
388 474
389Called wheneever the window loses keyboard focus, before rxvt-unicode does 475Called wheneever the window loses keyboard focus, before rxvt-unicode does
390focus out processing. 476focus out processing.
391 477
478=item on_configure_notify $term, $event
479
392=item on_key_press $term, $event, $keysym, $octets 480=item on_key_press $term, $event, $keysym, $octets
393 481
394=item on_key_release $term, $event, $keysym 482=item on_key_release $term, $event, $keysym
395 483
396=item on_button_press $term, $event 484=item on_button_press $term, $event
412 500
413C<on_key_press> additionally receives the string rxvt-unicode would 501C<on_key_press> additionally receives the string rxvt-unicode would
414output, if any, in locale-specific encoding. 502output, if any, in locale-specific encoding.
415 503
416subwindow. 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).
417 514
418=back 515=back
419 516
420=cut 517=cut
421 518
427use Scalar::Util (); 524use Scalar::Util ();
428use List::Util (); 525use List::Util ();
429 526
430our $VERSION = 1; 527our $VERSION = 1;
431our $TERM; 528our $TERM;
529our @TERM_INIT;
530our @TERM_EXT;
432our @HOOKNAME; 531our @HOOKNAME;
433our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 532our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
434our %OPTION; 533our %OPTION;
435 534
436our $LIBDIR; 535our $LIBDIR;
458=item $urxvt::TERM 557=item $urxvt::TERM
459 558
460The current terminal. This variable stores the current C<urxvt::term> 559The current terminal. This variable stores the current C<urxvt::term>
461object, whenever a callback/hook is executing. 560object, whenever a callback/hook is executing.
462 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>.
577
463=back 578=back
464 579
465=head2 Functions in the C<urxvt> Package 580=head2 Functions in the C<urxvt> Package
466 581
467=over 4 582=over 4
480 595
481Using this function has the advantage that its output ends up in the 596Using this function has the advantage that its output ends up in the
482correct place, e.g. on stderr of the connecting urxvtc client. 597correct place, e.g. on stderr of the connecting urxvtc client.
483 598
484Messages have a size limit of 1023 bytes currently. 599Messages have a size limit of 1023 bytes currently.
485
486=item $is_safe = urxvt::safe
487
488Returns true when it is safe to do potentially unsafe things, such as
489evaluating perl code specified by the user. This is true when urxvt was
490started setuid or setgid.
491 600
492=item $time = urxvt::NOW 601=item $time = urxvt::NOW
493 602
494Returns the "current time" (as per the event loop). 603Returns the "current time" (as per the event loop).
495 604
572=back 681=back
573 682
574=cut 683=cut
575 684
576BEGIN { 685BEGIN {
577 urxvt->bootstrap;
578
579 # overwrite perl's warn 686 # overwrite perl's warn
580 *CORE::GLOBAL::warn = sub { 687 *CORE::GLOBAL::warn = sub {
581 my $msg = join "", @_; 688 my $msg = join "", @_;
582 $msg .= "\n" 689 $msg .= "\n"
583 unless $msg =~ /\n$/; 690 unless $msg =~ /\n$/;
584 urxvt::warn ($msg); 691 urxvt::warn ($msg);
585 }; 692 };
586
587 # %ENV is the original startup environment
588 delete $ENV{IFS};
589 delete $ENV{CDPATH};
590 delete $ENV{BASH_ENV};
591 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
592} 693}
593 694
594my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 695my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595 696
596sub verbose { 697sub verbose {
597 my ($level, $msg) = @_; 698 my ($level, $msg) = @_;
598 warn "$msg\n" if $level <= $verbosity; 699 warn "$msg\n" if $level <= $verbosity;
599} 700}
600 701
601my $extension_pkg = "extension0000";
602my %extension_pkg; 702my %extension_pkg;
603 703
604# load a single script into its own package, once only 704# load a single script into its own package, once only
605sub extension_package($) { 705sub extension_package($) {
606 my ($path) = @_; 706 my ($path) = @_;
607 707
608 $extension_pkg{$path} ||= do { 708 $extension_pkg{$path} ||= do {
609 my $pkg = "urxvt::" . ($extension_pkg++); 709 $path =~ /([^\/\\]+)$/;
710 my $pkg = $1;
711 $pkg =~ s/[^[:word:]]/_/g;
712 $pkg = "urxvt::ext::$pkg";
610 713
611 verbose 3, "loading extension '$path' into package '$pkg'"; 714 verbose 3, "loading extension '$path' into package '$pkg'";
612 715
613 open my $fh, "<:raw", $path 716 open my $fh, "<:raw", $path
614 or die "$path: $!"; 717 or die "$path: $!";
615 718
616 my $source = untaint 719 my $source =
617 "package $pkg; use strict; use utf8;\n" 720 "package $pkg; use strict; use utf8;\n"
618 . "use base urxvt::term::extension::;\n"
619 . "#line 1 \"$path\"\n{\n" 721 . "#line 1 \"$path\"\n{\n"
620 . (do { local $/; <$fh> }) 722 . (do { local $/; <$fh> })
621 . "\n};\n1"; 723 . "\n};\n1";
622 724
623 eval $source 725 eval $source
637 if ($htype == 0) { # INIT 739 if ($htype == 0) { # INIT
638 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 740 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
639 741
640 my %ext_arg; 742 my %ext_arg;
641 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
642 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 753 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
643 if ($_ eq "default") { 754 if ($_ eq "default") {
644 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 755 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
645 } elsif (/^-(.*)$/) { 756 } elsif (/^-(.*)$/) {
646 delete $ext_arg{$1}; 757 delete $ext_arg{$1};
647 } elsif (/^([^<]+)<(.*)>$/) { 758 } elsif (/^([^<]+)<(.*)>$/) {
672 if $verbosity >= 10; 783 if $verbosity >= 10;
673 784
674 keys %$cb; 785 keys %$cb;
675 786
676 while (my ($pkg, $cb) = each %$cb) { 787 while (my ($pkg, $cb) = each %$cb) {
677 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 788 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
678 and last; 789 $retval ||= $retval_;
679 790
680 if ($@) { 791 if ($@) {
681 $TERM->ungrab; # better to lose the grab than the session 792 $TERM->ungrab; # better to lose the grab than the session
682 warn $@; 793 warn $@;
683 } 794 }
694 # clear package 805 # clear package
695 %$TERM = (); 806 %$TERM = ();
696 } 807 }
697 808
698 $retval 809 $retval
699}
700
701sub exec_async(@) {
702 my $pid = fork;
703
704 return
705 if !defined $pid or $pid;
706
707 %ENV = %{ $TERM->env };
708
709 exec @_;
710 _exit 255;
711} 810}
712 811
713# urxvt::term::extension 812# urxvt::term::extension
714 813
715package urxvt::term::extension; 814package urxvt::term::extension;
854# find on_xxx subs in the package and register them 953# find on_xxx subs in the package and register them
855# as hooks 954# as hooks
856sub register_package { 955sub register_package {
857 my ($self, $pkg, $argv) = @_; 956 my ($self, $pkg, $argv) = @_;
858 957
958 no strict 'refs';
959
960 urxvt::verbose 6, "register package $pkg to $self";
961
962 @{"$pkg\::ISA"} = urxvt::term::extension::;
963
859 my $proxy = bless { 964 my $proxy = bless {
860 _pkg => $pkg, 965 _pkg => $pkg,
861 argv => $argv, 966 argv => $argv,
862 }, $pkg; 967 }, $pkg;
863 Scalar::Util::weaken ($proxy->{term} = $self); 968 Scalar::Util::weaken ($proxy->{term} = $self);
894 999
895Destroy the terminal object (close the window, free resources 1000Destroy the terminal object (close the window, free resources
896etc.). 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
897watchers (timers, io watchers) are still active. 1002watchers (timers, io watchers) are still active.
898 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
899=item $isset = $term->option ($optval[, $set]) 1029=item $isset = $term->option ($optval[, $set])
900 1030
901Returns true if the option specified by C<$optval> is enabled, and 1031Returns true if the option specified by C<$optval> is enabled, and
902optionally 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
903C<%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.
905Here 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
906source file F</src/optinc.h> to see the actual list: 1036source file F</src/optinc.h> to see the actual list:
907 1037
908 borderLess console cursorBlink cursorUnderline hold iconic insecure 1038 borderLess console cursorBlink cursorUnderline hold iconic insecure
909 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1039 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
910 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1040 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
911 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1041 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
912 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1042 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
913 tripleclickwords utmpInhibit visualBell 1043 transparent tripleclickwords utmpInhibit visualBell
914 1044
915=item $value = $term->resource ($name[, $newval]) 1045=item $value = $term->resource ($name[, $newval])
916 1046
917Returns the current resource value associated with a given name and 1047Returns the current resource value associated with a given name and
918optionally 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>
935 1065
936 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1066 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
937 borderLess color cursorBlink cursorUnderline cutchars delete_key 1067 borderLess color cursorBlink cursorUnderline cutchars delete_key
938 display_name embed ext_bwidth fade font geometry hold iconName 1068 display_name embed ext_bwidth fade font geometry hold iconName
939 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1069 imFont imLocale inputMethod insecure int_bwidth intensityStyles
940 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1070 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
941 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1071 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1072 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1073 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1074 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1075 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946 shade term_name title transparent transparent_all tripleclickwords 1076 secondaryScreen secondaryScroll selectstyle shade term_name title
947 utmpInhibit visualBell 1077 transient_for transparent transparent_all tripleclickwords utmpInhibit
1078 visualBell
948 1079
949=cut 1080=cut
950 1081
951sub resource($$;$) { 1082sub resource($$;$) {
952 my ($self, $name) = (shift, shift); 1083 my ($self, $name) = (shift, shift);
1544 my $env = $self->{term}->env; 1675 my $env = $self->{term}->env;
1545 # 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.
1546 delete $env->{LC_ALL}; 1677 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale; 1678 $env->{LC_CTYPE} = $self->{term}->locale;
1548 1679
1549 urxvt::term->new ($env, $self->{term}->resource ("name"), 1680 urxvt::term->new ($env, "popup",
1550 "--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",
1551 "--transient-for" => $self->{term}->parent, 1684 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id, 1685 "-display" => $self->{term}->display_id,
1553 "-pe" => "urxvt-popup") 1686 "-pe" => "urxvt-popup")
1554 or die "unable to create popup window\n"; 1687 or die "unable to create popup window\n";
1555} 1688}
1560 delete $self->{term}{_destroy}{$self}; 1693 delete $self->{term}{_destroy}{$self};
1561 $self->{term}->ungrab; 1694 $self->{term}->ungrab;
1562} 1695}
1563 1696
1564=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__;
1565 1707
1566=head2 The C<urxvt::timer> Class 1708=head2 The C<urxvt::timer> Class
1567 1709
1568This class implements timer watchers/events. Time is represented as a 1710This class implements timer watchers/events. Time is represented as a
1569fractional number of seconds since the epoch. Example: 1711fractional number of seconds since the epoch. Example:
1607Start the timer. 1749Start the timer.
1608 1750
1609=item $timer = $timer->start ($tstamp) 1751=item $timer = $timer->start ($tstamp)
1610 1752
1611Set 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>.
1612 1758
1613=item $timer = $timer->stop 1759=item $timer = $timer->stop
1614 1760
1615Stop the timer. 1761Stop the timer.
1616 1762
1663 1809
1664Stop watching for events on the given filehandle. 1810Stop watching for events on the given filehandle.
1665 1811
1666=back 1812=back
1667 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
1668=head1 ENVIRONMENT 1875=head1 ENVIRONMENT
1669 1876
1670=head2 URXVT_PERL_VERBOSITY 1877=head2 URXVT_PERL_VERBOSITY
1671 1878
1672This 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