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.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC

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 39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
44(More) intelligent selection. This extension tries to be more intelligent 48(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 49when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 50now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 51arguments, which is very convenient, too, if your F<ls> supports
52C<--quoting-style=shell>.
48 53
54A double-click usually selects the word under the cursor, further clicks
55will enlarge the selection.
56
57The selection works by trying to match a number of regexes and displaying
58them in increasing order of length. You can add your own regexes by
59specifying resources of the form:
60
61 URxvt.selection.pattern-0: perl-regex
62 URxvt.selection.pattern-1: perl-regex
63 ...
64
65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything
68between two vertical bars:
69
70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end.
74
49It also offers the following bindable keyboard command: 75This extension also offers following bindable keyboard commands:
50 76
51=over 4 77=over 4
52 78
53=item rot13 79=item rot13
54 80
65 91
66=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
67 93
68Binds 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
69text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
70evalution, 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 };
71 116
72=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
73 118
74Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 121input/output is suspended and a regex is displayed at the bottom of the
122screen.
77 123
78C</> starts an incremental regex search, C<n> searches further, C<p> or 124Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 125search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 126search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 127bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary
130selection.
82 131
83=item digital-clock 132=item readline (enabled by default)
84 133
85Displays a digital clock using the built-in overlay. 134A support package that tries to make editing with readline easier. At the
135moment, it reacts to clicking with the left mouse button by trying to
136move the text cursor to this position. It does so by generating as many
137cursor-left or cursor-right keypresses as required (the this only works
138for programs that correctly support wide characters).
139
140To avoid too many false positives, this is only done when:
141
142=over 4
143
144=item - the tty is in ICANON state.
145
146=item - the text cursor is visible.
147
148=item - the primary screen is currently being displayed.
149
150=item - the mouse is on the same (multi-row-) line as the text cursor.
151
152=back
153
154The normal selection mechanism isn't disabled, so quick successive clicks
155might interfere with selection creation in harmless ways.
156
157=item selection-autotransform
158
159This selection allows you to do automatic transforms on a selection
160whenever a selection is made.
161
162It works by specifying perl snippets (most useful is a single C<s///>
163operator) that modify C<$_> as resources:
164
165 URxvt.selection-autotransform.0: transform
166 URxvt.selection-autotransform.1: transform
167 ...
168
169For example, the following will transform selections of the form
170C<filename:number>, often seen in compiler messages, into C<vi +$filename
171$word>:
172
173 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
174
175And this example matches the same,but replaces it with vi-commands you can
176paste directly into your (vi :) editor:
177
178 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
179
180Of course, this can be modified to suit your needs and your editor :)
181
182To expand the example above to typical perl error messages ("XXX at
183FILENAME line YYY."), you need a slightly more elaborate solution:
184
185 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
186 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
187
188The first line tells the selection code to treat the unchanging part of
189every error message as a selection pattern, and the second line transforms
190the message into vi commands to load the file.
191
192=item tabbed
193
194This transforms the terminal into a tabbar with additional terminals, that
195is, it implements what is commonly refered to as "tabbed terminal". The topmost line
196displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
197button per tab.
198
199Clicking a button will activate that tab. Pressing B<Shift-Left> and
200B<Shift-Right> will switch to the tab left or right of the current one,
201while B<Shift-Down> creates a new tab.
86 202
87=item mark-urls 203=item mark-urls
88 204
89Uses per-line display filtering (C<on_line_update>) to underline urls. 205Uses per-line display filtering (C<on_line_update>) to underline urls and
206make them clickable. When middle-clicked, the program specified in the
207resource C<urlLauncher> (default C<x-www-browser>) will be started with
208the URL as first argument.
209
210=item automove-background
211
212This is basically a one-line extension that dynamically changes the background pixmap offset
213to the window position, in effect creating the same effect as pseudo transparency with
214a custom pixmap. No scaling is supported in this mode. Exmaple:
215
216 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90 217
91=item block-graphics-to-ascii 218=item block-graphics-to-ascii
92 219
93A not very useful example of filtering all text output to the terminal, 220A not very useful example of filtering all text output to the terminal,
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 221by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 222similar-looking ascii character.
96 223
224=item digital-clock
225
226Displays a digital clock using the built-in overlay.
227
97=item example-refresh-hooks 228=item example-refresh-hooks
98 229
99Displays a very simple digital clock in the upper right corner of the 230Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 231window. Illustrates overwriting the refresh callbacks to create your own
101overlays or changes. 232overlays or changes.
233
234=item selection-pastebin
235
236This is a little rarely useful extension that Uploads the selection as
237textfile to a remote site (or does other things). (The implementation is
238not currently secure for use in a multiuser environment as it writes to
239F</tmp> directly.).
240
241It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
242i.e.
243
244 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
245
246Pressing this combination runs a command with C<%> replaced by the name of
247the textfile. This command can be set via a resource:
248
249 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
250
251And the default is likely not useful to anybody but the few people around
252here :)
253
254The name of the textfile is the hex encoded md5 sum of the selection, so
255the same content should lead to the same filename.
256
257After a successful upload the selection will be replaced by the text given
258in the C<selection-pastebin-url> resource (again, the % is the placeholder
259for the filename):
260
261 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102 262
103=back 263=back
104 264
105=head1 API DOCUMENTATION 265=head1 API DOCUMENTATION
106 266
179called whenever the relevant event happens. 339called whenever the relevant event happens.
180 340
181The first argument passed to them is an extension oject as described in 341The first argument passed to them is an extension oject as described in
182the in the C<Extension Objects> section. 342the in the C<Extension Objects> section.
183 343
184B<All> of these hooks must return a boolean value. If it is true, then the 344B<All> of these hooks must return a boolean value. If any of the called
185event counts as being I<consumed>, and the invocation of other hooks is 345hooks returns true, then the event counts as being I<consumed>, and the
186skipped, and the relevant action might not be carried out by the C++ code. 346relevant action might not be carried out by the C++ code.
187 347
188I<< When in doubt, return a false value (preferably C<()>). >> 348I<< When in doubt, return a false value (preferably C<()>). >>
189 349
190=over 4 350=over 4
191 351
192=item on_init $term 352=item on_init $term
193 353
194Called after a new terminal object has been initialized, but before 354Called after a new terminal object has been initialized, but before
195windows are created or the command gets run. Most methods are unsafe to 355windows are created or the command gets run. Most methods are unsafe to
196call or deliver senseless data, as terminal size and other characteristics 356call or deliver senseless data, as terminal size and other characteristics
197have not yet been determined. You can safely query and change resources, 357have not yet been determined. You can safely query and change resources
198though. 358and options, though. For many purposes the C<on_start> hook is a better
359place.
360
361=item on_start $term
362
363Called at the very end of initialisation of a new terminal, just before
364trying to map (display) the toplevel and returning to the mainloop.
365
366=item on_destroy $term
367
368Called whenever something tries to destroy terminal, before doing anything
369yet. If this hook returns true, then destruction is skipped, but this is
370rarely a good idea.
199 371
200=item on_reset $term 372=item on_reset $term
201 373
202Called after the screen is "reset" for any reason, such as resizing or 374Called after the screen is "reset" for any reason, such as resizing or
203control sequences. Here is where you can react on changes to size-related 375control sequences. Here is where you can react on changes to size-related
204variables. 376variables.
205 377
206=item on_start $term 378=item on_child_start $term, $pid
207 379
208Called at the very end of initialisation of a new terminal, just before 380Called just after the child process has been C<fork>ed.
209returning to the mainloop. 381
382=item on_child_exit $term, $status
383
384Called just after the child process has exited. C<$status> is the status
385from C<waitpid>.
210 386
211=item on_sel_make $term, $eventtime 387=item on_sel_make $term, $eventtime
212 388
213Called whenever a selection has been made by the user, but before the 389Called whenever a selection has been made by the user, but before the
214selection text is copied, so changes to the beginning, end or type of the 390selection text is copied, so changes to the beginning, end or type of the
228=item on_sel_extend $term 404=item on_sel_extend $term
229 405
230Called whenever the user tries to extend the selection (e.g. with a double 406Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 407click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 408should extend the selection itelf and return true to suppress the built-in
233processing. 409processing. This can happen multiple times, as long as the callback
410returns true, it will be called on every further click by the user and is
411supposed to enlarge the selection more and more, if possible.
234 412
235See the F<selection> example extension. 413See the F<selection> example extension.
236 414
237=item on_view_change $term, $offset 415=item on_view_change $term, $offset
238 416
305 483
306Called whenever the user presses a key combination that has a 484Called whenever the user presses a key combination that has a
307C<perl:string> action bound to it (see description of the B<keysym> 485C<perl:string> action bound to it (see description of the B<keysym>
308resource in the @@RXVT_NAME@@(1) manpage). 486resource in the @@RXVT_NAME@@(1) manpage).
309 487
488=item on_x_event $term, $event
489
490Called on every X event received on the vt window (and possibly other
491windows). Should only be used as a last resort. Most event structure
492members are not passed.
493
310=item on_focus_in $term 494=item on_focus_in $term
311 495
312Called whenever the window gets the keyboard focus, before rxvt-unicode 496Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 497does focus in processing.
314 498
315=item on_focus_out $term 499=item on_focus_out $term
316 500
317Called wheneever the window loses keyboard focus, before rxvt-unicode does 501Called wheneever the window loses keyboard focus, before rxvt-unicode does
318focus out processing. 502focus out processing.
319 503
504=item on_configure_notify $term, $event
505
506=item on_property_notify $term, $event
507
320=item on_key_press $term, $event, $keysym, $octets 508=item on_key_press $term, $event, $keysym, $octets
321 509
322=item on_key_release $term, $event, $keysym 510=item on_key_release $term, $event, $keysym
323 511
324=item on_button_press $term, $event 512=item on_button_press $term, $event
333 521
334Called whenever the corresponding X event is received for the terminal If 522Called whenever the corresponding X event is received for the terminal If
335the hook returns true, then the even will be ignored by rxvt-unicode. 523the hook returns true, then the even will be ignored by rxvt-unicode.
336 524
337The event is a hash with most values as named by Xlib (see the XEvent 525The event is a hash with most values as named by Xlib (see the XEvent
338manpage), with the additional members C<row> and C<col>, which are the row 526manpage), with the additional members C<row> and C<col>, which are the
339and column under the mouse cursor. 527(real, not screen-based) row and column under the mouse cursor.
340 528
341C<on_key_press> additionally receives the string rxvt-unicode would 529C<on_key_press> additionally receives the string rxvt-unicode would
342output, if any, in locale-specific encoding. 530output, if any, in locale-specific encoding.
343 531
344subwindow. 532subwindow.
533
534=item on_client_message $term, $event
535
536=item on_wm_protocols $term, $event
537
538=item on_wm_delete_window $term, $event
539
540Called when various types of ClientMessage events are received (all with
541format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
345 542
346=back 543=back
347 544
348=cut 545=cut
349 546
355use Scalar::Util (); 552use Scalar::Util ();
356use List::Util (); 553use List::Util ();
357 554
358our $VERSION = 1; 555our $VERSION = 1;
359our $TERM; 556our $TERM;
557our @TERM_INIT;
558our @TERM_EXT;
360our @HOOKNAME; 559our @HOOKNAME;
361our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 560our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362our %OPTION; 561our %OPTION;
363 562
364our $LIBDIR; 563our $LIBDIR;
365our $RESNAME; 564our $RESNAME;
366our $RESCLASS; 565our $RESCLASS;
367our $RXVTNAME; 566our $RXVTNAME;
368 567
568our $NOCHAR = chr 0xffff;
569
369=head2 Variables in the C<urxvt> Package 570=head2 Variables in the C<urxvt> Package
370 571
371=over 4 572=over 4
372 573
373=item $urxvt::LIBDIR 574=item $urxvt::LIBDIR
385 586
386=item $urxvt::TERM 587=item $urxvt::TERM
387 588
388The current terminal. This variable stores the current C<urxvt::term> 589The current terminal. This variable stores the current C<urxvt::term>
389object, whenever a callback/hook is executing. 590object, whenever a callback/hook is executing.
591
592=item @urxvt::TERM_INIT
593
594All coderefs in this array will be called as methods of the next newly
595created C<urxvt::term> object (during the C<on_init> phase). The array
596gets cleared before the codereferences that were in it are being executed,
597so coderefs can push themselves onto it again if they so desire.
598
599This complements to the perl-eval commandline option, but gets executed
600first.
601
602=item @urxvt::TERM_EXT
603
604Works similar to C<@TERM_INIT>, but contains perl package/class names, which
605get registered as normal extensions after calling the hooks in C<@TERM_INIT>
606but before other extensions. Gets cleared just like C<@TERM_INIT>.
390 607
391=back 608=back
392 609
393=head2 Functions in the C<urxvt> Package 610=head2 Functions in the C<urxvt> Package
394 611
409Using this function has the advantage that its output ends up in the 626Using this function has the advantage that its output ends up in the
410correct place, e.g. on stderr of the connecting urxvtc client. 627correct place, e.g. on stderr of the connecting urxvtc client.
411 628
412Messages have a size limit of 1023 bytes currently. 629Messages have a size limit of 1023 bytes currently.
413 630
414=item $is_safe = urxvt::safe
415
416Returns true when it is safe to do potentially unsafe things, such as
417evaluating perl code specified by the user. This is true when urxvt was
418started setuid or setgid.
419
420=item $time = urxvt::NOW 631=item $time = urxvt::NOW
421 632
422Returns the "current time" (as per the event loop). 633Returns the "current time" (as per the event loop).
423 634
424=item urxvt::CurrentTime 635=item urxvt::CurrentTime
425 636
426=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 637=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
427Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 638Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
428Button4Mask, Button5Mask, AnyModifier 639Button4Mask, Button5Mask, AnyModifier
640
641=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
642ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
643PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
644Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
645KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
646ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
647FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
648
649=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
650EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
651GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
652UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
653ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
654CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
655SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
429 656
430Various constants for use in X calls and event processing. 657Various constants for use in X calls and event processing.
431 658
432=back 659=back
433 660
484=back 711=back
485 712
486=cut 713=cut
487 714
488BEGIN { 715BEGIN {
489 urxvt->bootstrap;
490
491 # overwrite perl's warn 716 # overwrite perl's warn
492 *CORE::GLOBAL::warn = sub { 717 *CORE::GLOBAL::warn = sub {
493 my $msg = join "", @_; 718 my $msg = join "", @_;
494 $msg .= "\n" 719 $msg .= "\n"
495 unless $msg =~ /\n$/; 720 unless $msg =~ /\n$/;
496 urxvt::warn ($msg); 721 urxvt::warn ($msg);
497 }; 722 };
498
499 delete $ENV{IFS};
500 delete $ENV{CDPATH};
501 delete $ENV{BASH_ENV};
502 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
503} 723}
504 724
505my @hook_count; 725no warnings 'utf8';
726
506my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 727my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
507 728
508sub verbose { 729sub verbose {
509 my ($level, $msg) = @_; 730 my ($level, $msg) = @_;
510 warn "$msg\n" if $level <= $verbosity; 731 warn "$msg\n" if $level <= $verbosity;
511} 732}
512 733
513my $extension_pkg = "extension0000";
514my %extension_pkg; 734my %extension_pkg;
515 735
516# load a single script into its own package, once only 736# load a single script into its own package, once only
517sub extension_package($) { 737sub extension_package($) {
518 my ($path) = @_; 738 my ($path) = @_;
519 739
520 $extension_pkg{$path} ||= do { 740 $extension_pkg{$path} ||= do {
521 my $pkg = "urxvt::" . ($extension_pkg++); 741 $path =~ /([^\/\\]+)$/;
742 my $pkg = $1;
743 $pkg =~ s/[^[:word:]]/_/g;
744 $pkg = "urxvt::ext::$pkg";
522 745
523 verbose 3, "loading extension '$path' into package '$pkg'"; 746 verbose 3, "loading extension '$path' into package '$pkg'";
524 747
525 open my $fh, "<:raw", $path 748 open my $fh, "<:raw", $path
526 or die "$path: $!"; 749 or die "$path: $!";
527 750
528 my $source = untaint 751 my $source =
529 "package $pkg; use strict; use utf8;\n" 752 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
530 . "use base urxvt::term::extension::;\n"
531 . "#line 1 \"$path\"\n{\n" 753 . "#line 1 \"$path\"\n{\n"
532 . (do { local $/; <$fh> }) 754 . (do { local $/; <$fh> })
533 . "\n};\n1"; 755 . "\n};\n1";
534 756
535 eval $source 757 eval $source
549 if ($htype == 0) { # INIT 771 if ($htype == 0) { # INIT
550 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 772 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
551 773
552 my %ext_arg; 774 my %ext_arg;
553 775
776 {
777 my @init = @TERM_INIT;
778 @TERM_INIT = ();
779 $_->($TERM) for @init;
780 my @pkg = @TERM_EXT;
781 @TERM_EXT = ();
782 $TERM->register_package ($_) for @pkg;
783 }
784
554 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 785 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
555 if ($_ eq "default") { 786 if ($_ eq "default") {
556 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 787 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
557 } elsif (/^-(.*)$/) { 788 } elsif (/^-(.*)$/) {
558 delete $ext_arg{$1}; 789 delete $ext_arg{$1};
559 } elsif (/^([^<]+)<(.*)>$/) { 790 } elsif (/^([^<]+)<(.*)>$/) {
560 push @{ $ext_arg{$1} }, $2; 791 push @{ $ext_arg{$1} }, $2;
561 } else { 792 } else {
584 if $verbosity >= 10; 815 if $verbosity >= 10;
585 816
586 keys %$cb; 817 keys %$cb;
587 818
588 while (my ($pkg, $cb) = each %$cb) { 819 while (my ($pkg, $cb) = each %$cb) {
589 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 820 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
590 and last; 821 $retval ||= $retval_;
591 822
592 if ($@) { 823 if ($@) {
593 $TERM->ungrab; # better to lose the grab than the session 824 $TERM->ungrab; # better to lose the grab than the session
594 warn $@; 825 warn $@;
595 } 826 }
596 } 827 }
828
829 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
830 if $verbosity >= 11;
597 } 831 }
598 832
599 if ($htype == 1) { # DESTROY 833 if ($htype == 1) { # DESTROY
600 if (my $hook = delete $TERM->{_hook}) {
601 for my $htype (0..$#$hook) {
602 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
603 or set_should_invoke $htype, 0;
604 }
605 }
606
607 # clear package objects 834 # clear package objects
608 %$_ = () for values %{ $TERM->{_pkg} }; 835 %$_ = () for values %{ $TERM->{_pkg} };
609 836
610 # clear package 837 # clear package
611 %$TERM = (); 838 %$TERM = ();
625 while (my ($name, $cb) = each %hook) { 852 while (my ($name, $cb) = each %hook) {
626 my $htype = $HOOKTYPE{uc $name}; 853 my $htype = $HOOKTYPE{uc $name};
627 defined $htype 854 defined $htype
628 or Carp::croak "unsupported hook type '$name'"; 855 or Carp::croak "unsupported hook type '$name'";
629 856
857 $self->set_should_invoke ($htype, +1)
630 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 858 unless exists $self->{term}{_hook}[$htype]{$pkg};
631 $hook_count[$htype]++
632 or urxvt::set_should_invoke $htype, 1;
633 }
634 859
635 $self->{term}{_hook}[$htype]{$pkg} = $cb; 860 $self->{term}{_hook}[$htype]{$pkg} = $cb;
636 } 861 }
637} 862}
638 863
643 for my $name (@hook) { 868 for my $name (@hook) {
644 my $htype = $HOOKTYPE{uc $name}; 869 my $htype = $HOOKTYPE{uc $name};
645 defined $htype 870 defined $htype
646 or Carp::croak "unsupported hook type '$name'"; 871 or Carp::croak "unsupported hook type '$name'";
647 872
873 $self->set_should_invoke ($htype, -1)
648 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 874 if delete $self->{term}{_hook}[$htype]{$pkg};
649 --$hook_count[$htype]
650 or urxvt::set_should_invoke $htype, 0;
651 }
652 } 875 }
653} 876}
654 877
655our $AUTOLOAD; 878our $AUTOLOAD;
656 879
762# find on_xxx subs in the package and register them 985# find on_xxx subs in the package and register them
763# as hooks 986# as hooks
764sub register_package { 987sub register_package {
765 my ($self, $pkg, $argv) = @_; 988 my ($self, $pkg, $argv) = @_;
766 989
990 no strict 'refs';
991
992 urxvt::verbose 6, "register package $pkg to $self";
993
994 @{"$pkg\::ISA"} = urxvt::term::extension::;
995
767 my $proxy = bless { 996 my $proxy = bless {
768 _pkg => $pkg, 997 _pkg => $pkg,
769 argv => $argv, 998 argv => $argv,
770 }, $pkg; 999 }, $pkg;
771 Scalar::Util::weaken ($proxy->{term} = $self); 1000 Scalar::Util::weaken ($proxy->{term} = $self);
802 1031
803Destroy the terminal object (close the window, free resources 1032Destroy the terminal object (close the window, free resources
804etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1033etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
805watchers (timers, io watchers) are still active. 1034watchers (timers, io watchers) are still active.
806 1035
1036=item $term->exec_async ($cmd[, @args])
1037
1038Works like the combination of the C<fork>/C<exec> builtins, which executes
1039("starts") programs in the background. This function takes care of setting
1040the user environment before exec'ing the command (e.g. C<PATH>) and should
1041be preferred over explicit calls to C<exec> or C<system>.
1042
1043Returns the pid of the subprocess or C<undef> on error.
1044
1045=cut
1046
1047sub exec_async {
1048 my $self = shift;
1049
1050 my $pid = fork;
1051
1052 return $pid
1053 if !defined $pid or $pid;
1054
1055 %ENV = %{ $self->env };
1056
1057 exec @_;
1058 urxvt::_exit 255;
1059}
1060
807=item $isset = $term->option ($optval[, $set]) 1061=item $isset = $term->option ($optval[, $set])
808 1062
809Returns true if the option specified by C<$optval> is enabled, and 1063Returns true if the option specified by C<$optval> is enabled, and
810optionally change it. All option values are stored by name in the hash 1064optionally change it. All option values are stored by name in the hash
811C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1065C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
813Here is a a likely non-exhaustive list of option names, please see the 1067Here is a a likely non-exhaustive list of option names, please see the
814source file F</src/optinc.h> to see the actual list: 1068source file F</src/optinc.h> to see the actual list:
815 1069
816 borderLess console cursorBlink cursorUnderline hold iconic insecure 1070 borderLess console cursorBlink cursorUnderline hold iconic insecure
817 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1071 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
818 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1072 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
819 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1073 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
820 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1074 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
821 tripleclickwords utmpInhibit visualBell 1075 transparent tripleclickwords utmpInhibit visualBell
822 1076
823=item $value = $term->resource ($name[, $newval]) 1077=item $value = $term->resource ($name[, $newval])
824 1078
825Returns the current resource value associated with a given name and 1079Returns the current resource value associated with a given name and
826optionally sets a new value. Setting values is most useful in the C<init> 1080optionally sets a new value. Setting values is most useful in the C<init>
843 1097
844 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1098 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
845 borderLess color cursorBlink cursorUnderline cutchars delete_key 1099 borderLess color cursorBlink cursorUnderline cutchars delete_key
846 display_name embed ext_bwidth fade font geometry hold iconName 1100 display_name embed ext_bwidth fade font geometry hold iconName
847 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1101 imFont imLocale inputMethod insecure int_bwidth intensityStyles
848 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1102 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
849 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1103 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
850 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1104 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
851 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1105 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
852 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1106 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
853 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1107 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
854 shade term_name title transparent transparent_all tripleclickwords 1108 secondaryScreen secondaryScroll selectstyle shade term_name title
855 utmpInhibit visualBell 1109 transient_for transparent transparent_all tripleclickwords utmpInhibit
1110 visualBell
856 1111
857=cut 1112=cut
858 1113
859sub resource($$;$) { 1114sub resource($$;$) {
860 my ($self, $name) = (shift, shift); 1115 my ($self, $name) = (shift, shift);
861 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1116 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
862 &urxvt::term::_resource 1117 &urxvt::term::_resource
863} 1118}
864 1119
1120=item $value = $term->x_resource ($pattern)
1121
1122Returns the X-Resource for the given pattern, excluding the program or
1123class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1124same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1125resource with that pattern exists.
1126
1127This method should only be called during the C<on_start> hook, as there is
1128only one resource database per display, and later invocations might return
1129the wrong resources.
1130
865=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1131=item $success = $term->parse_keysym ($keysym_spec, $command_string)
866 1132
867Adds a keymap translation exactly as specified via a resource. See the 1133Adds a keymap translation exactly as specified via a resource. See the
868C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1134C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
869 1135
884=item ($row, $col) = $term->selection_end ([$row, $col]) 1150=item ($row, $col) = $term->selection_end ([$row, $col])
885 1151
886Return the current values of the selection mark, begin or end positions, 1152Return the current values of the selection mark, begin or end positions,
887and optionally set them to new values. 1153and optionally set them to new values.
888 1154
1155=item $term->selection_make ($eventtime[, $rectangular])
1156
1157Tries to make a selection as set by C<selection_beg> and
1158C<selection_end>. If C<$rectangular> is true (default: false), a
1159rectangular selection will be made. This is the prefered function to make
1160a selection.
1161
889=item $success = $term->selection_grab ($eventtime) 1162=item $success = $term->selection_grab ($eventtime)
890 1163
891Try to request the primary selection from the server (for example, as set 1164Try to request the primary selection text from the server (for example, as
892by the next method). 1165set by the next method). No visual feedback will be given. This function
1166is mostly useful from within C<on_sel_grab> hooks.
893 1167
894=item $oldtext = $term->selection ([$newtext]) 1168=item $oldtext = $term->selection ([$newtext])
895 1169
896Return the current selection text and optionally replace it by C<$newtext>. 1170Return the current selection text and optionally replace it by C<$newtext>.
897 1171
990Convert the given locale-encoded octets into a perl string. 1264Convert the given locale-encoded octets into a perl string.
991 1265
992=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1266=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
993 1267
994XORs the rendition values in the given span with the provided value 1268XORs the rendition values in the given span with the provided value
995(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1269(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
996to the selection. 1270refresh hooks to provide effects similar to the selection.
997 1271
998=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1272=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
999 1273
1000Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1274Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1001whitespace will additionally be xored with the C<$rstyle2>, which defaults 1275whitespace will additionally be xored with the C<$rstyle2>, which defaults
1002to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1276to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1003it instead. 1277it instead. Both styles I<MUST NOT> contain font styles.
1004 1278
1005=item $term->scr_bell 1279=item $term->scr_bell
1006 1280
1007Ring the bell! 1281Ring the bell!
1008 1282
1015 1289
1016Normally its not a good idea to use this function, as programs might be 1290Normally its not a good idea to use this function, as programs might be
1017confused by changes in cursor position or scrolling. Its useful inside a 1291confused by changes in cursor position or scrolling. Its useful inside a
1018C<on_add_lines> hook, though. 1292C<on_add_lines> hook, though.
1019 1293
1294=item $term->scr_change_screen ($screen)
1295
1296Switch to given screen - 0 primary, 1 secondary.
1297
1020=item $term->cmd_parse ($octets) 1298=item $term->cmd_parse ($octets)
1021 1299
1022Similar to C<scr_add_lines>, but the argument must be in the 1300Similar to C<scr_add_lines>, but the argument must be in the
1023locale-specific encoding of the terminal and can contain command sequences 1301locale-specific encoding of the terminal and can contain command sequences
1024(escape codes) that will be interpreted. 1302(escape codes) that will be interpreted.
1034Replaces the event mask of the pty watcher by the given event mask. Can 1312Replaces the event mask of the pty watcher by the given event mask. Can
1035be used to suppress input and output handling to the pty/tty. See the 1313be used to suppress input and output handling to the pty/tty. See the
1036description of C<< urxvt::timer->events >>. Make sure to always restore 1314description of C<< urxvt::timer->events >>. Make sure to always restore
1037the previous value. 1315the previous value.
1038 1316
1317=item $fd = $term->pty_fd
1318
1319Returns the master file descriptor for the pty in use, or C<-1> if no pty
1320is used.
1321
1039=item $windowid = $term->parent 1322=item $windowid = $term->parent
1040 1323
1041Return the window id of the toplevel window. 1324Return the window id of the toplevel window.
1042 1325
1043=item $windowid = $term->vt 1326=item $windowid = $term->vt
1044 1327
1045Return the window id of the terminal window. 1328Return the window id of the terminal window.
1046 1329
1330=item $term->vt_emask_add ($x_event_mask)
1331
1332Adds the specified events to the vt event mask. Useful e.g. when you want
1333to receive pointer events all the times:
1334
1335 $term->vt_emask_add (urxvt::PointerMotionMask);
1336
1047=item $window_width = $term->width 1337=item $window_width = $term->width
1048 1338
1049=item $window_height = $term->height 1339=item $window_height = $term->height
1050 1340
1051=item $font_width = $term->fwidth 1341=item $font_width = $term->fwidth
1064 1354
1065=item $max_scrollback = $term->saveLines 1355=item $max_scrollback = $term->saveLines
1066 1356
1067=item $nrow_plus_saveLines = $term->total_rows 1357=item $nrow_plus_saveLines = $term->total_rows
1068 1358
1069=item $lines_in_scrollback = $term->nsaved 1359=item $topmost_scrollback_row = $term->top_row
1070 1360
1071Return various integers describing terminal characteristics. 1361Return various integers describing terminal characteristics.
1072 1362
1073=item $x_display = $term->display_id 1363=item $x_display = $term->display_id
1074 1364
1100=item $modifiermask = $term->ModNumLockMask 1390=item $modifiermask = $term->ModNumLockMask
1101 1391
1102Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1392Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1103AltGr), the meta key (often Alt) and the num lock key, if applicable. 1393AltGr), the meta key (often Alt) and the num lock key, if applicable.
1104 1394
1395=item $screen = $term->current_screen
1396
1397Returns the currently displayed screen (0 primary, 1 secondary).
1398
1399=item $cursor_is_hidden = $term->hidden_cursor
1400
1401Returns wether the cursor is currently hidden or not.
1402
1105=item $view_start = $term->view_start ([$newvalue]) 1403=item $view_start = $term->view_start ([$newvalue])
1106 1404
1107Returns the negative row number of the topmost line. Minimum value is 1405Returns the row number of the topmost displayed line. Maximum value is
1108C<0>, which displays the normal terminal contents. Larger values scroll 1406C<0>, which displays the normal terminal contents. Lower values scroll
1109this many lines into the scrollback buffer. 1407this many lines into the scrollback buffer.
1110 1408
1111=item $term->want_refresh 1409=item $term->want_refresh
1112 1410
1113Requests a screen refresh. At the next opportunity, rxvt-unicode will 1411Requests a screen refresh. At the next opportunity, rxvt-unicode will
1128line, starting at column C<$start_col> (default C<0>), which is useful 1426line, starting at column C<$start_col> (default C<0>), which is useful
1129to replace only parts of a line. The font index in the rendition will 1427to replace only parts of a line. The font index in the rendition will
1130automatically be updated. 1428automatically be updated.
1131 1429
1132C<$text> is in a special encoding: tabs and wide characters that use more 1430C<$text> is in a special encoding: tabs and wide characters that use more
1133than one cell when displayed are padded with urxvt::NOCHAR characters 1431than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1134(C<chr 65535>). Characters with combining characters and other characters 1432characters. Characters with combining characters and other characters that
1135that do not fit into the normal tetx encoding will be replaced with 1433do not fit into the normal tetx encoding will be replaced with characters
1136characters in the private use area. 1434in the private use area.
1137 1435
1138You have to obey this encoding when changing text. The advantage is 1436You have to obey this encoding when changing text. The advantage is
1139that C<substr> and similar functions work on screen cells and not on 1437that C<substr> and similar functions work on screen cells and not on
1140characters. 1438characters.
1141 1439
1192Return the row number of the first/last row of the line, respectively. 1490Return the row number of the first/last row of the line, respectively.
1193 1491
1194=item $offset = $line->offset_of ($row, $col) 1492=item $offset = $line->offset_of ($row, $col)
1195 1493
1196Returns the character offset of the given row|col pair within the logical 1494Returns the character offset of the given row|col pair within the logical
1197line. 1495line. Works for rows outside the line, too, and returns corresponding
1496offsets outside the string.
1198 1497
1199=item ($row, $col) = $line->coord_of ($offset) 1498=item ($row, $col) = $line->coord_of ($offset)
1200 1499
1201Translates a string offset into terminal coordinates again. 1500Translates a string offset into terminal coordinates again.
1202 1501
1315 1614
1316Calls XUngrab for the most recent grab. Is called automatically on 1615Calls XUngrab for the most recent grab. Is called automatically on
1317evaluation errors, as it is better to lose the grab in the error case as 1616evaluation errors, as it is better to lose the grab in the error case as
1318the session. 1617the session.
1319 1618
1619=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1620
1621=item $atom_name = $term->XGetAtomName ($atom)
1622
1623=item @atoms = $term->XListProperties ($window)
1624
1625=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1626
1627=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1628
1629=item $term->XDeleteProperty ($window, $property)
1630
1631=item $window = $term->DefaultRootWindow
1632
1633=item $term->XReparentWindow ($window, $parent, [$x, $y])
1634
1635=item $term->XMapWindow ($window)
1636
1637=item $term->XUnmapWindow ($window)
1638
1639=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1640
1641=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1642
1643=item $term->XChangeInput ($window, $add_events[, $del_events])
1644
1645Various X or X-related functions. The C<$term> object only serves as
1646the source of the display, otherwise those functions map more-or-less
1647directory onto the X functions of the same name.
1648
1320=back 1649=back
1321 1650
1322=cut 1651=cut
1323 1652
1324package urxvt::popup; 1653package urxvt::popup;
1425 my $env = $self->{term}->env; 1754 my $env = $self->{term}->env;
1426 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1755 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1427 delete $env->{LC_ALL}; 1756 delete $env->{LC_ALL};
1428 $env->{LC_CTYPE} = $self->{term}->locale; 1757 $env->{LC_CTYPE} = $self->{term}->locale;
1429 1758
1430 urxvt::term->new ($env, $self->{term}->resource ("name"), 1759 urxvt::term->new ($env, "popup",
1431 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1760 "--perl-lib" => "", "--perl-ext-common" => "",
1761 "-pty-fd" => -1, "-sl" => 0,
1762 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1432 "--transient-for" => $self->{term}->parent, 1763 "--transient-for" => $self->{term}->parent,
1433 "-display" => $self->{term}->display_id, 1764 "-display" => $self->{term}->display_id,
1434 "-pe" => "urxvt-popup") 1765 "-pe" => "urxvt-popup")
1435 or die "unable to create popup window\n"; 1766 or die "unable to create popup window\n";
1436} 1767}
1441 delete $self->{term}{_destroy}{$self}; 1772 delete $self->{term}{_destroy}{$self};
1442 $self->{term}->ungrab; 1773 $self->{term}->ungrab;
1443} 1774}
1444 1775
1445=back 1776=back
1777
1778=cut
1779
1780package urxvt::watcher;
1781
1782@urxvt::timer::ISA = __PACKAGE__;
1783@urxvt::iow::ISA = __PACKAGE__;
1784@urxvt::pw::ISA = __PACKAGE__;
1785@urxvt::iw::ISA = __PACKAGE__;
1446 1786
1447=head2 The C<urxvt::timer> Class 1787=head2 The C<urxvt::timer> Class
1448 1788
1449This class implements timer watchers/events. Time is represented as a 1789This class implements timer watchers/events. Time is represented as a
1450fractional number of seconds since the epoch. Example: 1790fractional number of seconds since the epoch. Example:
1488Start the timer. 1828Start the timer.
1489 1829
1490=item $timer = $timer->start ($tstamp) 1830=item $timer = $timer->start ($tstamp)
1491 1831
1492Set the event trigger time to C<$tstamp> and start the timer. 1832Set the event trigger time to C<$tstamp> and start the timer.
1833
1834=item $timer = $timer->after ($delay)
1835
1836Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493 1837
1494=item $timer = $timer->stop 1838=item $timer = $timer->stop
1495 1839
1496Stop the timer. 1840Stop the timer.
1497 1841
1544 1888
1545Stop watching for events on the given filehandle. 1889Stop watching for events on the given filehandle.
1546 1890
1547=back 1891=back
1548 1892
1893=head2 The C<urxvt::iw> Class
1894
1895This class implements idle watchers, that get called automatically when
1896the process is idle. They should return as fast as possible, after doing
1897some useful work.
1898
1899=over 4
1900
1901=item $iw = new urxvt::iw
1902
1903Create a new idle watcher object in stopped state.
1904
1905=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1906
1907Set the callback to be called when the watcher triggers.
1908
1909=item $timer = $timer->start
1910
1911Start the watcher.
1912
1913=item $timer = $timer->stop
1914
1915Stop the watcher.
1916
1917=back
1918
1919=head2 The C<urxvt::pw> Class
1920
1921This class implements process watchers. They create an event whenever a
1922process exits, after which they stop automatically.
1923
1924 my $pid = fork;
1925 ...
1926 $term->{pw} = urxvt::pw
1927 ->new
1928 ->start ($pid)
1929 ->cb (sub {
1930 my ($pw, $exit_status) = @_;
1931 ...
1932 });
1933
1934=over 4
1935
1936=item $pw = new urxvt::pw
1937
1938Create a new process watcher in stopped state.
1939
1940=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1941
1942Set the callback to be called when the timer triggers.
1943
1944=item $pw = $timer->start ($pid)
1945
1946Tells the wqtcher to start watching for process C<$pid>.
1947
1948=item $pw = $pw->stop
1949
1950Stop the watcher.
1951
1952=back
1953
1549=head1 ENVIRONMENT 1954=head1 ENVIRONMENT
1550 1955
1551=head2 URXVT_PERL_VERBOSITY 1956=head2 URXVT_PERL_VERBOSITY
1552 1957
1553This variable controls the verbosity level of the perl extension. Higher 1958This variable controls the verbosity level of the perl extension. Higher
1557 1962
1558=item == 0 - fatal messages 1963=item == 0 - fatal messages
1559 1964
1560=item >= 3 - script loading and management 1965=item >= 3 - script loading and management
1561 1966
1562=item >=10 - all events received 1967=item >=10 - all called hooks
1968
1969=item >=11 - hook reutrn values
1563 1970
1564=back 1971=back
1565 1972
1566=head1 AUTHOR 1973=head1 AUTHOR
1567 1974

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines