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.118 by root, Fri Jan 20 18:50:49 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
87 91
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. 96evaluation, 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.
161=item example-refresh-hooks 203=item example-refresh-hooks
162 204
163Displays a very simple digital clock in the upper right corner of the 205Displays a very simple digital clock in the upper right corner of the
164window. Illustrates overwriting the refresh callbacks to create your own 206window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 207overlays or changes.
208
209=item selection-pastebin
210
211This is a little rarely useful extension that Uploads the selection as
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.).
215
216It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
217i.e.
218
219 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
220
221Pressing this combination runs a command with C<%> replaced by the name of
222the textfile. This command can be set via a resource:
223
224 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
225
226And the default is likely not useful to anybody but the few people around
227here :)
228
229The name of the textfile is the hex encoded md5 sum of the selection, so
230the same content should lead to the same filename.
231
232After a successful upload the selection will be replaced by the text given
233in the C<selection-pastebin-url> resource (again, the % is the placeholder
234for the filename):
235
236 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166 237
167=back 238=back
168 239
169=head1 API DOCUMENTATION 240=head1 API DOCUMENTATION
170 241
243called whenever the relevant event happens. 314called whenever the relevant event happens.
244 315
245The 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
246the in the C<Extension Objects> section. 317the in the C<Extension Objects> section.
247 318
248B<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
249event 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
250skipped, and the relevant action might not be carried out by the C++ code. 321relevant action might not be carried out by the C++ code.
251 322
252I<< When in doubt, return a false value (preferably C<()>). >> 323I<< When in doubt, return a false value (preferably C<()>). >>
253 324
254=over 4 325=over 4
255 326
256=item on_init $term 327=item on_init $term
257 328
258Called after a new terminal object has been initialized, but before 329Called after a new terminal object has been initialized, but before
259windows 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
260call or deliver senseless data, as terminal size and other characteristics 331call or deliver senseless data, as terminal size and other characteristics
261have not yet been determined. You can safely query and change resources, 332have not yet been determined. You can safely query and change resources
262though. 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.
263 346
264=item on_reset $term 347=item on_reset $term
265 348
266Called 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
267control 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
268variables. 351variables.
269 352
270=item on_start $term 353=item on_child_start $term, $pid
271 354
272Called at the very end of initialisation of a new terminal, just before 355Called just after the child process has been C<fork>ed.
273returning 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>.
274 361
275=item on_sel_make $term, $eventtime 362=item on_sel_make $term, $eventtime
276 363
277Called 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
278selection 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
387=item on_focus_out $term 474=item on_focus_out $term
388 475
389Called wheneever the window loses keyboard focus, before rxvt-unicode does 476Called wheneever the window loses keyboard focus, before rxvt-unicode does
390focus out processing. 477focus out processing.
391 478
479=item on_configure_notify $term, $event
480
481=item on_property_notify $term, $event
482
392=item on_key_press $term, $event, $keysym, $octets 483=item on_key_press $term, $event, $keysym, $octets
393 484
394=item on_key_release $term, $event, $keysym 485=item on_key_release $term, $event, $keysym
395 486
396=item on_button_press $term, $event 487=item on_button_press $term, $event
412 503
413C<on_key_press> additionally receives the string rxvt-unicode would 504C<on_key_press> additionally receives the string rxvt-unicode would
414output, if any, in locale-specific encoding. 505output, if any, in locale-specific encoding.
415 506
416subwindow. 507subwindow.
508
509=item on_client_message $term, $event
510
511=item on_wm_protocols $term, $event
512
513=item on_wm_delete_window $term, $event
514
515Called when various types of ClientMessage events are received (all with
516format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
417 517
418=back 518=back
419 519
420=cut 520=cut
421 521
427use Scalar::Util (); 527use Scalar::Util ();
428use List::Util (); 528use List::Util ();
429 529
430our $VERSION = 1; 530our $VERSION = 1;
431our $TERM; 531our $TERM;
532our @TERM_INIT;
533our @TERM_EXT;
432our @HOOKNAME; 534our @HOOKNAME;
433our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 535our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
434our %OPTION; 536our %OPTION;
435 537
436our $LIBDIR; 538our $LIBDIR;
458=item $urxvt::TERM 560=item $urxvt::TERM
459 561
460The current terminal. This variable stores the current C<urxvt::term> 562The current terminal. This variable stores the current C<urxvt::term>
461object, whenever a callback/hook is executing. 563object, whenever a callback/hook is executing.
462 564
565=item @urxvt::TERM_INIT
566
567All coderefs in this array will be called as methods of the next newly
568created C<urxvt::term> object (during the C<on_init> phase). The array
569gets cleared before the codereferences that were in it are being executed,
570so coderefs can push themselves onto it again if they so desire.
571
572This complements to the perl-eval commandline option, but gets executed
573first.
574
575=item @urxvt::TERM_EXT
576
577Works similar to C<@TERM_INIT>, but contains perl package/class names, which
578get registered as normal extensions after calling the hooks in C<@TERM_INIT>
579but before other extensions. Gets cleared just like C<@TERM_INIT>.
580
463=back 581=back
464 582
465=head2 Functions in the C<urxvt> Package 583=head2 Functions in the C<urxvt> Package
466 584
467=over 4 585=over 4
480 598
481Using this function has the advantage that its output ends up in the 599Using this function has the advantage that its output ends up in the
482correct place, e.g. on stderr of the connecting urxvtc client. 600correct place, e.g. on stderr of the connecting urxvtc client.
483 601
484Messages have a size limit of 1023 bytes currently. 602Messages 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 603
492=item $time = urxvt::NOW 604=item $time = urxvt::NOW
493 605
494Returns the "current time" (as per the event loop). 606Returns the "current time" (as per the event loop).
495 607
572=back 684=back
573 685
574=cut 686=cut
575 687
576BEGIN { 688BEGIN {
577 urxvt->bootstrap;
578
579 # overwrite perl's warn 689 # overwrite perl's warn
580 *CORE::GLOBAL::warn = sub { 690 *CORE::GLOBAL::warn = sub {
581 my $msg = join "", @_; 691 my $msg = join "", @_;
582 $msg .= "\n" 692 $msg .= "\n"
583 unless $msg =~ /\n$/; 693 unless $msg =~ /\n$/;
584 urxvt::warn ($msg); 694 urxvt::warn ($msg);
585 }; 695 };
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} 696}
593 697
594my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 698my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595 699
596sub verbose { 700sub verbose {
597 my ($level, $msg) = @_; 701 my ($level, $msg) = @_;
598 warn "$msg\n" if $level <= $verbosity; 702 warn "$msg\n" if $level <= $verbosity;
599} 703}
600 704
601my $extension_pkg = "extension0000";
602my %extension_pkg; 705my %extension_pkg;
603 706
604# load a single script into its own package, once only 707# load a single script into its own package, once only
605sub extension_package($) { 708sub extension_package($) {
606 my ($path) = @_; 709 my ($path) = @_;
607 710
608 $extension_pkg{$path} ||= do { 711 $extension_pkg{$path} ||= do {
609 my $pkg = "urxvt::" . ($extension_pkg++); 712 $path =~ /([^\/\\]+)$/;
713 my $pkg = $1;
714 $pkg =~ s/[^[:word:]]/_/g;
715 $pkg = "urxvt::ext::$pkg";
610 716
611 verbose 3, "loading extension '$path' into package '$pkg'"; 717 verbose 3, "loading extension '$path' into package '$pkg'";
612 718
613 open my $fh, "<:raw", $path 719 open my $fh, "<:raw", $path
614 or die "$path: $!"; 720 or die "$path: $!";
615 721
616 my $source = untaint 722 my $source =
617 "package $pkg; use strict; use utf8;\n" 723 "package $pkg; use strict; use utf8;\n"
618 . "use base urxvt::term::extension::;\n"
619 . "#line 1 \"$path\"\n{\n" 724 . "#line 1 \"$path\"\n{\n"
620 . (do { local $/; <$fh> }) 725 . (do { local $/; <$fh> })
621 . "\n};\n1"; 726 . "\n};\n1";
622 727
623 eval $source 728 eval $source
637 if ($htype == 0) { # INIT 742 if ($htype == 0) { # INIT
638 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 743 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
639 744
640 my %ext_arg; 745 my %ext_arg;
641 746
747 {
748 my @init = @TERM_INIT;
749 @TERM_INIT = ();
750 $_->($TERM) for @init;
751 my @pkg = @TERM_EXT;
752 @TERM_EXT = ();
753 $TERM->register_package ($_) for @pkg;
754 }
755
642 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 756 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
643 if ($_ eq "default") { 757 if ($_ eq "default") {
644 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 758 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
645 } elsif (/^-(.*)$/) { 759 } elsif (/^-(.*)$/) {
646 delete $ext_arg{$1}; 760 delete $ext_arg{$1};
647 } elsif (/^([^<]+)<(.*)>$/) { 761 } elsif (/^([^<]+)<(.*)>$/) {
672 if $verbosity >= 10; 786 if $verbosity >= 10;
673 787
674 keys %$cb; 788 keys %$cb;
675 789
676 while (my ($pkg, $cb) = each %$cb) { 790 while (my ($pkg, $cb) = each %$cb) {
677 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 791 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
678 and last; 792 $retval ||= $retval_;
679 793
680 if ($@) { 794 if ($@) {
681 $TERM->ungrab; # better to lose the grab than the session 795 $TERM->ungrab; # better to lose the grab than the session
682 warn $@; 796 warn $@;
683 } 797 }
694 # clear package 808 # clear package
695 %$TERM = (); 809 %$TERM = ();
696 } 810 }
697 811
698 $retval 812 $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} 813}
712 814
713# urxvt::term::extension 815# urxvt::term::extension
714 816
715package urxvt::term::extension; 817package urxvt::term::extension;
854# find on_xxx subs in the package and register them 956# find on_xxx subs in the package and register them
855# as hooks 957# as hooks
856sub register_package { 958sub register_package {
857 my ($self, $pkg, $argv) = @_; 959 my ($self, $pkg, $argv) = @_;
858 960
961 no strict 'refs';
962
963 urxvt::verbose 6, "register package $pkg to $self";
964
965 @{"$pkg\::ISA"} = urxvt::term::extension::;
966
859 my $proxy = bless { 967 my $proxy = bless {
860 _pkg => $pkg, 968 _pkg => $pkg,
861 argv => $argv, 969 argv => $argv,
862 }, $pkg; 970 }, $pkg;
863 Scalar::Util::weaken ($proxy->{term} = $self); 971 Scalar::Util::weaken ($proxy->{term} = $self);
894 1002
895Destroy the terminal object (close the window, free resources 1003Destroy the terminal object (close the window, free resources
896etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1004etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
897watchers (timers, io watchers) are still active. 1005watchers (timers, io watchers) are still active.
898 1006
1007=item $term->exec_async ($cmd[, @args])
1008
1009Works like the combination of the C<fork>/C<exec> builtins, which executes
1010("starts") programs in the background. This function takes care of setting
1011the user environment before exec'ing the command (e.g. C<PATH>) and should
1012be preferred over explicit calls to C<exec> or C<system>.
1013
1014Returns the pid of the subprocess or C<undef> on error.
1015
1016=cut
1017
1018sub exec_async {
1019 my $self = shift;
1020
1021 my $pid = fork;
1022
1023 return $pid
1024 if !defined $pid or $pid;
1025
1026 %ENV = %{ $self->env };
1027
1028 exec @_;
1029 urxvt::_exit 255;
1030}
1031
899=item $isset = $term->option ($optval[, $set]) 1032=item $isset = $term->option ($optval[, $set])
900 1033
901Returns true if the option specified by C<$optval> is enabled, and 1034Returns true if the option specified by C<$optval> is enabled, and
902optionally change it. All option values are stored by name in the hash 1035optionally 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. 1036C<%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 1038Here is a a likely non-exhaustive list of option names, please see the
906source file F</src/optinc.h> to see the actual list: 1039source file F</src/optinc.h> to see the actual list:
907 1040
908 borderLess console cursorBlink cursorUnderline hold iconic insecure 1041 borderLess console cursorBlink cursorUnderline hold iconic insecure
909 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1042 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
910 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1043 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
911 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1044 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
912 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1045 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
913 tripleclickwords utmpInhibit visualBell 1046 transparent tripleclickwords utmpInhibit visualBell
914 1047
915=item $value = $term->resource ($name[, $newval]) 1048=item $value = $term->resource ($name[, $newval])
916 1049
917Returns the current resource value associated with a given name and 1050Returns the current resource value associated with a given name and
918optionally sets a new value. Setting values is most useful in the C<init> 1051optionally sets a new value. Setting values is most useful in the C<init>
935 1068
936 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1069 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
937 borderLess color cursorBlink cursorUnderline cutchars delete_key 1070 borderLess color cursorBlink cursorUnderline cutchars delete_key
938 display_name embed ext_bwidth fade font geometry hold iconName 1071 display_name embed ext_bwidth fade font geometry hold iconName
939 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1072 imFont imLocale inputMethod insecure int_bwidth intensityStyles
940 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1073 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
941 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1074 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1075 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1076 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1077 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1078 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946 shade term_name title transparent transparent_all tripleclickwords 1079 secondaryScreen secondaryScroll selectstyle shade term_name title
947 utmpInhibit visualBell 1080 transient_for transparent transparent_all tripleclickwords utmpInhibit
1081 visualBell
948 1082
949=cut 1083=cut
950 1084
951sub resource($$;$) { 1085sub resource($$;$) {
952 my ($self, $name) = (shift, shift); 1086 my ($self, $name) = (shift, shift);
1544 my $env = $self->{term}->env; 1678 my $env = $self->{term}->env;
1545 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1679 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546 delete $env->{LC_ALL}; 1680 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale; 1681 $env->{LC_CTYPE} = $self->{term}->locale;
1548 1682
1549 urxvt::term->new ($env, $self->{term}->resource ("name"), 1683 urxvt::term->new ($env, "popup",
1550 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1684 "--perl-lib" => "", "--perl-ext-common" => "",
1685 "-pty-fd" => -1, "-sl" => 0,
1686 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1551 "--transient-for" => $self->{term}->parent, 1687 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id, 1688 "-display" => $self->{term}->display_id,
1553 "-pe" => "urxvt-popup") 1689 "-pe" => "urxvt-popup")
1554 or die "unable to create popup window\n"; 1690 or die "unable to create popup window\n";
1555} 1691}
1560 delete $self->{term}{_destroy}{$self}; 1696 delete $self->{term}{_destroy}{$self};
1561 $self->{term}->ungrab; 1697 $self->{term}->ungrab;
1562} 1698}
1563 1699
1564=back 1700=back
1701
1702=cut
1703
1704package urxvt::watcher;
1705
1706@urxvt::timer::ISA = __PACKAGE__;
1707@urxvt::iow::ISA = __PACKAGE__;
1708@urxvt::pw::ISA = __PACKAGE__;
1709@urxvt::iw::ISA = __PACKAGE__;
1565 1710
1566=head2 The C<urxvt::timer> Class 1711=head2 The C<urxvt::timer> Class
1567 1712
1568This class implements timer watchers/events. Time is represented as a 1713This class implements timer watchers/events. Time is represented as a
1569fractional number of seconds since the epoch. Example: 1714fractional number of seconds since the epoch. Example:
1607Start the timer. 1752Start the timer.
1608 1753
1609=item $timer = $timer->start ($tstamp) 1754=item $timer = $timer->start ($tstamp)
1610 1755
1611Set the event trigger time to C<$tstamp> and start the timer. 1756Set the event trigger time to C<$tstamp> and start the timer.
1757
1758=item $timer = $timer->after ($delay)
1759
1760Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1612 1761
1613=item $timer = $timer->stop 1762=item $timer = $timer->stop
1614 1763
1615Stop the timer. 1764Stop the timer.
1616 1765
1663 1812
1664Stop watching for events on the given filehandle. 1813Stop watching for events on the given filehandle.
1665 1814
1666=back 1815=back
1667 1816
1817=head2 The C<urxvt::iw> Class
1818
1819This class implements idle watchers, that get called automatically when
1820the process is idle. They should return as fast as possible, after doing
1821some useful work.
1822
1823=over 4
1824
1825=item $iw = new urxvt::iw
1826
1827Create a new idle watcher object in stopped state.
1828
1829=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1830
1831Set the callback to be called when the watcher triggers.
1832
1833=item $timer = $timer->start
1834
1835Start the watcher.
1836
1837=item $timer = $timer->stop
1838
1839Stop the watcher.
1840
1841=back
1842
1843=head2 The C<urxvt::pw> Class
1844
1845This class implements process watchers. They create an event whenever a
1846process exits, after which they stop automatically.
1847
1848 my $pid = fork;
1849 ...
1850 $term->{pw} = urxvt::pw
1851 ->new
1852 ->start ($pid)
1853 ->cb (sub {
1854 my ($pw, $exit_status) = @_;
1855 ...
1856 });
1857
1858=over 4
1859
1860=item $pw = new urxvt::pw
1861
1862Create a new process watcher in stopped state.
1863
1864=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1865
1866Set the callback to be called when the timer triggers.
1867
1868=item $pw = $timer->start ($pid)
1869
1870Tells the wqtcher to start watching for process C<$pid>.
1871
1872=item $pw = $pw->stop
1873
1874Stop the watcher.
1875
1876=back
1877
1668=head1 ENVIRONMENT 1878=head1 ENVIRONMENT
1669 1879
1670=head2 URXVT_PERL_VERBOSITY 1880=head2 URXVT_PERL_VERBOSITY
1671 1881
1672This variable controls the verbosity level of the perl extension. Higher 1882This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines