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.84 by root, Thu Jan 12 02:20:56 2006 UTC vs.
Revision 1.128 by root, Wed Jan 25 00:57:57 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
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
78
79You can look at the source of the selection extension to see more
80interesting uses, such as parsing a line from beginning to end.
81
49It also offers the following bindable keyboard command: 82This extension also offers following bindable keyboard commands:
50 83
51=over 4 84=over 4
52 85
53=item rot13 86=item rot13
54 87
65 98
66=item selection-popup (enabled by default) 99=item selection-popup (enabled by default)
67 100
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 101Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action (such as uri unescaping, perl 102text into various other formats/action (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content. 103evaluation, web-browser starting etc.), depending on content.
104
105Other extensions can extend this popup menu by pushing a code reference
106onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
107popup is displayed.
108
109It's sole argument is the popup menu, which can be modified. The selection
110is in C<$_>, which can be used to decide wether to add something or not.
111It should either return nothing or a string and a code reference. The
112string will be used as button text and the code reference will be called
113when the button gets activated and should transform C<$_>.
114
115The following will add an entry C<a to b> that transforms all C<a>s in
116the selection to C<b>s, but only if the selection currently contains any
117C<a>s:
118
119 push @{ $self->{term}{selection_popup_hook} }, sub {
120 /a/ ? ("a to be" => sub { s/a/b/g }
121 : ()
122 };
71 123
72=item searchable-scrollback<hotkey> (enabled by default) 124=item searchable-scrollback<hotkey> (enabled by default)
73 125
74Adds regex search functionality to the scrollback buffer, triggered 126Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 127by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 128input/output is suspended and a regex is displayed at the bottom of the
129screen.
77 130
78C</> starts an incremental regex search, C<n> searches further, C<p> or 131Inputting 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 132search. 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> 133search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 134bottom. C<Escape> leaves search mode and returns to the point where search
135was started, while C<Enter> or C<Return> stay at the current position and
136additionally stores the first match in the current line into the primary
137selection.
82 138
83=item digital-clock 139=item readline (enabled by default)
84 140
85Displays a digital clock using the built-in overlay. 141A support package that tries to make editing with readline easier. At the
142moment, it reacts to clicking with the left mouse button by trying to
143move the text cursor to this position. It does so by generating as many
144cursor-left or cursor-right keypresses as required (the this only works
145for programs that correctly support wide characters).
146
147To avoid too many false positives, this is only done when:
148
149=over 4
150
151=item - the tty is in ICANON state.
152
153=item - the text cursor is visible.
154
155=item - the primary screen is currently being displayed.
156
157=item - the mouse is on the same (multi-row-) line as the text cursor.
158
159=back
160
161The normal selection mechanism isn't disabled, so quick successive clicks
162might interfere with selection creation in harmless ways.
163
164=item selection-autotransform
165
166This selection allows you to do automatic transforms on a selection
167whenever a selection is made.
168
169It works by specifying perl snippets (most useful is a single C<s///>
170operator) that modify C<$_> as resources:
171
172 URxvt.selection-autotransform.0: transform
173 URxvt.selection-autotransform.1: transform
174 ...
175
176For example, the following will transform selections of the form
177C<filename:number>, often seen in compiler messages, into C<vi +$filename
178$word>:
179
180 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
181
182And this example matches the same,but replaces it with vi-commands you can
183paste directly into your (vi :) editor:
184
185 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
186
187Of course, this can be modified to suit your needs and your editor :)
188
189To expand the example above to typical perl error messages ("XXX at
190FILENAME line YYY."), you need a slightly more elaborate solution:
191
192 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
193 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
194
195The first line tells the selection code to treat the unchanging part of
196every error message as a selection pattern, and the second line transforms
197the message into vi commands to load the file.
198
199=item tabbed
200
201This transforms the terminal into a tabbar with additional terminals, that
202is, it implements what is commonly refered to as "tabbed terminal". The topmost line
203displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204button per tab.
205
206Clicking a button will activate that tab. Pressing B<Shift-Left> and
207B<Shift-Right> will switch to the tab left or right of the current one,
208while B<Shift-Down> creates a new tab.
86 209
87=item mark-urls 210=item mark-urls
88 211
89Uses per-line display filtering (C<on_line_update>) to underline urls and 212Uses per-line display filtering (C<on_line_update>) to underline urls and
90make them clickable. When middle-clicked, the program specified in the 213make them clickable. When middle-clicked, the program specified in the
91resource C<urlLauncher> (default C<x-www-browser>) will be started. 214resource C<urlLauncher> (default C<x-www-browser>) will be started with
215the URL as first argument.
216
217=item xim-onthespot
218
219This (experimental) perl extension implements OnTheSpot editing. It does
220not work perfectly, and some input methods don't seem to work well with
221OnTheSpot editing in general, but it seems to work at leats for SCIM and
222kinput2.
223
224You enable it by specifying this extension and a preedit style of
225C<OnTheSpot>, i.e.:
226
227 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228
229=item automove-background
230
231This is basically a one-line extension that dynamically changes the background pixmap offset
232to the window position, in effect creating the same effect as pseudo transparency with
233a custom pixmap. No scaling is supported in this mode. Exmaple:
234
235 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
92 236
93=item block-graphics-to-ascii 237=item block-graphics-to-ascii
94 238
95A not very useful example of filtering all text output to the terminal, 239A not very useful example of filtering all text output to the terminal,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 240by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 241similar-looking ascii character.
98 242
243=item digital-clock
244
245Displays a digital clock using the built-in overlay.
246
99=item example-refresh-hooks 247=item example-refresh-hooks
100 248
101Displays a very simple digital clock in the upper right corner of the 249Displays a very simple digital clock in the upper right corner of the
102window. Illustrates overwriting the refresh callbacks to create your own 250window. Illustrates overwriting the refresh callbacks to create your own
103overlays or changes. 251overlays or changes.
252
253=item selection-pastebin
254
255This is a little rarely useful extension that Uploads the selection as
256textfile to a remote site (or does other things). (The implementation is
257not currently secure for use in a multiuser environment as it writes to
258F</tmp> directly.).
259
260It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
261i.e.
262
263 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
264
265Pressing this combination runs a command with C<%> replaced by the name of
266the textfile. This command can be set via a resource:
267
268 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
269
270And the default is likely not useful to anybody but the few people around
271here :)
272
273The name of the textfile is the hex encoded md5 sum of the selection, so
274the same content should lead to the same filename.
275
276After a successful upload the selection will be replaced by the text given
277in the C<selection-pastebin-url> resource (again, the % is the placeholder
278for the filename):
279
280 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
104 281
105=back 282=back
106 283
107=head1 API DOCUMENTATION 284=head1 API DOCUMENTATION
108 285
181called whenever the relevant event happens. 358called whenever the relevant event happens.
182 359
183The first argument passed to them is an extension oject as described in 360The first argument passed to them is an extension oject as described in
184the in the C<Extension Objects> section. 361the in the C<Extension Objects> section.
185 362
186B<All> of these hooks must return a boolean value. If it is true, then the 363B<All> of these hooks must return a boolean value. If any of the called
187event counts as being I<consumed>, and the invocation of other hooks is 364hooks returns true, then the event counts as being I<consumed>, and the
188skipped, and the relevant action might not be carried out by the C++ code. 365relevant action might not be carried out by the C++ code.
189 366
190I<< When in doubt, return a false value (preferably C<()>). >> 367I<< When in doubt, return a false value (preferably C<()>). >>
191 368
192=over 4 369=over 4
193 370
194=item on_init $term 371=item on_init $term
195 372
196Called after a new terminal object has been initialized, but before 373Called after a new terminal object has been initialized, but before
197windows are created or the command gets run. Most methods are unsafe to 374windows are created or the command gets run. Most methods are unsafe to
198call or deliver senseless data, as terminal size and other characteristics 375call or deliver senseless data, as terminal size and other characteristics
199have not yet been determined. You can safely query and change resources, 376have not yet been determined. You can safely query and change resources
200though. 377and options, though. For many purposes the C<on_start> hook is a better
378place.
379
380=item on_start $term
381
382Called at the very end of initialisation of a new terminal, just before
383trying to map (display) the toplevel and returning to the mainloop.
384
385=item on_destroy $term
386
387Called whenever something tries to destroy terminal, when the terminal is
388still fully functional (not for long, though).
201 389
202=item on_reset $term 390=item on_reset $term
203 391
204Called after the screen is "reset" for any reason, such as resizing or 392Called after the screen is "reset" for any reason, such as resizing or
205control sequences. Here is where you can react on changes to size-related 393control sequences. Here is where you can react on changes to size-related
206variables. 394variables.
207 395
208=item on_start $term 396=item on_child_start $term, $pid
209 397
210Called at the very end of initialisation of a new terminal, just before 398Called just after the child process has been C<fork>ed.
211returning to the mainloop. 399
400=item on_child_exit $term, $status
401
402Called just after the child process has exited. C<$status> is the status
403from C<waitpid>.
212 404
213=item on_sel_make $term, $eventtime 405=item on_sel_make $term, $eventtime
214 406
215Called whenever a selection has been made by the user, but before the 407Called whenever a selection has been made by the user, but before the
216selection text is copied, so changes to the beginning, end or type of the 408selection text is copied, so changes to the beginning, end or type of the
230=item on_sel_extend $term 422=item on_sel_extend $term
231 423
232Called whenever the user tries to extend the selection (e.g. with a double 424Called whenever the user tries to extend the selection (e.g. with a double
233click) and is either supposed to return false (normal operation), or 425click) and is either supposed to return false (normal operation), or
234should extend the selection itelf and return true to suppress the built-in 426should extend the selection itelf and return true to suppress the built-in
235processing. 427processing. This can happen multiple times, as long as the callback
428returns true, it will be called on every further click by the user and is
429supposed to enlarge the selection more and more, if possible.
236 430
237See the F<selection> example extension. 431See the F<selection> example extension.
238 432
239=item on_view_change $term, $offset 433=item on_view_change $term, $offset
240 434
307 501
308Called whenever the user presses a key combination that has a 502Called whenever the user presses a key combination that has a
309C<perl:string> action bound to it (see description of the B<keysym> 503C<perl:string> action bound to it (see description of the B<keysym>
310resource in the @@RXVT_NAME@@(1) manpage). 504resource in the @@RXVT_NAME@@(1) manpage).
311 505
506=item on_x_event $term, $event
507
508Called on every X event received on the vt window (and possibly other
509windows). Should only be used as a last resort. Most event structure
510members are not passed.
511
312=item on_focus_in $term 512=item on_focus_in $term
313 513
314Called whenever the window gets the keyboard focus, before rxvt-unicode 514Called whenever the window gets the keyboard focus, before rxvt-unicode
315does focus in processing. 515does focus in processing.
316 516
317=item on_focus_out $term 517=item on_focus_out $term
318 518
319Called wheneever the window loses keyboard focus, before rxvt-unicode does 519Called wheneever the window loses keyboard focus, before rxvt-unicode does
320focus out processing. 520focus out processing.
321 521
522=item on_configure_notify $term, $event
523
524=item on_property_notify $term, $event
525
322=item on_key_press $term, $event, $keysym, $octets 526=item on_key_press $term, $event, $keysym, $octets
323 527
324=item on_key_release $term, $event, $keysym 528=item on_key_release $term, $event, $keysym
325 529
326=item on_button_press $term, $event 530=item on_button_press $term, $event
335 539
336Called whenever the corresponding X event is received for the terminal If 540Called whenever the corresponding X event is received for the terminal If
337the hook returns true, then the even will be ignored by rxvt-unicode. 541the hook returns true, then the even will be ignored by rxvt-unicode.
338 542
339The event is a hash with most values as named by Xlib (see the XEvent 543The event is a hash with most values as named by Xlib (see the XEvent
340manpage), with the additional members C<row> and C<col>, which are the row 544manpage), with the additional members C<row> and C<col>, which are the
341and column under the mouse cursor. 545(real, not screen-based) row and column under the mouse cursor.
342 546
343C<on_key_press> additionally receives the string rxvt-unicode would 547C<on_key_press> additionally receives the string rxvt-unicode would
344output, if any, in locale-specific encoding. 548output, if any, in locale-specific encoding.
345 549
346subwindow. 550subwindow.
551
552=item on_client_message $term, $event
553
554=item on_wm_protocols $term, $event
555
556=item on_wm_delete_window $term, $event
557
558Called when various types of ClientMessage events are received (all with
559format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
347 560
348=back 561=back
349 562
350=cut 563=cut
351 564
357use Scalar::Util (); 570use Scalar::Util ();
358use List::Util (); 571use List::Util ();
359 572
360our $VERSION = 1; 573our $VERSION = 1;
361our $TERM; 574our $TERM;
575our @TERM_INIT;
576our @TERM_EXT;
362our @HOOKNAME; 577our @HOOKNAME;
363our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 578our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364our %OPTION; 579our %OPTION;
365 580
366our $LIBDIR; 581our $LIBDIR;
367our $RESNAME; 582our $RESNAME;
368our $RESCLASS; 583our $RESCLASS;
369our $RXVTNAME; 584our $RXVTNAME;
370 585
586our $NOCHAR = chr 0xffff;
587
371=head2 Variables in the C<urxvt> Package 588=head2 Variables in the C<urxvt> Package
372 589
373=over 4 590=over 4
374 591
375=item $urxvt::LIBDIR 592=item $urxvt::LIBDIR
387 604
388=item $urxvt::TERM 605=item $urxvt::TERM
389 606
390The current terminal. This variable stores the current C<urxvt::term> 607The current terminal. This variable stores the current C<urxvt::term>
391object, whenever a callback/hook is executing. 608object, whenever a callback/hook is executing.
609
610=item @urxvt::TERM_INIT
611
612All coderefs in this array will be called as methods of the next newly
613created C<urxvt::term> object (during the C<on_init> phase). The array
614gets cleared before the codereferences that were in it are being executed,
615so coderefs can push themselves onto it again if they so desire.
616
617This complements to the perl-eval commandline option, but gets executed
618first.
619
620=item @urxvt::TERM_EXT
621
622Works similar to C<@TERM_INIT>, but contains perl package/class names, which
623get registered as normal extensions after calling the hooks in C<@TERM_INIT>
624but before other extensions. Gets cleared just like C<@TERM_INIT>.
392 625
393=back 626=back
394 627
395=head2 Functions in the C<urxvt> Package 628=head2 Functions in the C<urxvt> Package
396 629
411Using this function has the advantage that its output ends up in the 644Using this function has the advantage that its output ends up in the
412correct place, e.g. on stderr of the connecting urxvtc client. 645correct place, e.g. on stderr of the connecting urxvtc client.
413 646
414Messages have a size limit of 1023 bytes currently. 647Messages have a size limit of 1023 bytes currently.
415 648
416=item $is_safe = urxvt::safe
417
418Returns true when it is safe to do potentially unsafe things, such as
419evaluating perl code specified by the user. This is true when urxvt was
420started setuid or setgid.
421
422=item $time = urxvt::NOW 649=item $time = urxvt::NOW
423 650
424Returns the "current time" (as per the event loop). 651Returns the "current time" (as per the event loop).
425 652
426=item urxvt::CurrentTime 653=item urxvt::CurrentTime
427 654
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 655=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 656Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier 657Button4Mask, Button5Mask, AnyModifier
658
659=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
660ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
661PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
662Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
663KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
664ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
665FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
666
667=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
668EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
669GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
670UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
671ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
672CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
673SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431 674
432Various constants for use in X calls and event processing. 675Various constants for use in X calls and event processing.
433 676
434=back 677=back
435 678
486=back 729=back
487 730
488=cut 731=cut
489 732
490BEGIN { 733BEGIN {
491 urxvt->bootstrap;
492
493 # overwrite perl's warn 734 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub { 735 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_; 736 my $msg = join "", @_;
496 $msg .= "\n" 737 $msg .= "\n"
497 unless $msg =~ /\n$/; 738 unless $msg =~ /\n$/;
498 urxvt::warn ($msg); 739 urxvt::warn ($msg);
499 }; 740 };
500
501 # %ENV is the original startup environment
502 delete $ENV{IFS};
503 delete $ENV{CDPATH};
504 delete $ENV{BASH_ENV};
505 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506} 741}
507 742
508my @hook_count; 743no warnings 'utf8';
744
509my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 745my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510 746
511sub verbose { 747sub verbose {
512 my ($level, $msg) = @_; 748 my ($level, $msg) = @_;
513 warn "$msg\n" if $level <= $verbosity; 749 warn "$msg\n" if $level <= $verbosity;
514} 750}
515 751
516my $extension_pkg = "extension0000";
517my %extension_pkg; 752my %extension_pkg;
518 753
519# load a single script into its own package, once only 754# load a single script into its own package, once only
520sub extension_package($) { 755sub extension_package($) {
521 my ($path) = @_; 756 my ($path) = @_;
522 757
523 $extension_pkg{$path} ||= do { 758 $extension_pkg{$path} ||= do {
524 my $pkg = "urxvt::" . ($extension_pkg++); 759 $path =~ /([^\/\\]+)$/;
760 my $pkg = $1;
761 $pkg =~ s/[^[:word:]]/_/g;
762 $pkg = "urxvt::ext::$pkg";
525 763
526 verbose 3, "loading extension '$path' into package '$pkg'"; 764 verbose 3, "loading extension '$path' into package '$pkg'";
527 765
528 open my $fh, "<:raw", $path 766 open my $fh, "<:raw", $path
529 or die "$path: $!"; 767 or die "$path: $!";
530 768
531 my $source = untaint 769 my $source =
532 "package $pkg; use strict; use utf8;\n" 770 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
533 . "use base urxvt::term::extension::;\n"
534 . "#line 1 \"$path\"\n{\n" 771 . "#line 1 \"$path\"\n{\n"
535 . (do { local $/; <$fh> }) 772 . (do { local $/; <$fh> })
536 . "\n};\n1"; 773 . "\n};\n1";
537 774
538 eval $source 775 eval $source
552 if ($htype == 0) { # INIT 789 if ($htype == 0) { # INIT
553 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 790 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554 791
555 my %ext_arg; 792 my %ext_arg;
556 793
794 {
795 my @init = @TERM_INIT;
796 @TERM_INIT = ();
797 $_->($TERM) for @init;
798 my @pkg = @TERM_EXT;
799 @TERM_EXT = ();
800 $TERM->register_package ($_) for @pkg;
801 }
802
557 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 803 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558 if ($_ eq "default") { 804 if ($_ eq "default") {
559 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 805 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
560 } elsif (/^-(.*)$/) { 806 } elsif (/^-(.*)$/) {
561 delete $ext_arg{$1}; 807 delete $ext_arg{$1};
562 } elsif (/^([^<]+)<(.*)>$/) { 808 } elsif (/^([^<]+)<(.*)>$/) {
563 push @{ $ext_arg{$1} }, $2; 809 push @{ $ext_arg{$1} }, $2;
564 } else { 810 } else {
587 if $verbosity >= 10; 833 if $verbosity >= 10;
588 834
589 keys %$cb; 835 keys %$cb;
590 836
591 while (my ($pkg, $cb) = each %$cb) { 837 while (my ($pkg, $cb) = each %$cb) {
592 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 838 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
593 and last; 839 $retval ||= $retval_;
594 840
595 if ($@) { 841 if ($@) {
596 $TERM->ungrab; # better to lose the grab than the session 842 $TERM->ungrab; # better to lose the grab than the session
597 warn $@; 843 warn $@;
598 } 844 }
599 } 845 }
846
847 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
848 if $verbosity >= 11;
600 } 849 }
601 850
602 if ($htype == 1) { # DESTROY 851 if ($htype == 1) { # DESTROY
603 if (my $hook = delete $TERM->{_hook}) {
604 for my $htype (0..$#$hook) {
605 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
606 or set_should_invoke $htype, 0;
607 }
608 }
609
610 # clear package objects 852 # clear package objects
611 %$_ = () for values %{ $TERM->{_pkg} }; 853 %$_ = () for values %{ $TERM->{_pkg} };
612 854
613 # clear package 855 # clear package
614 %$TERM = (); 856 %$TERM = ();
615 } 857 }
616 858
617 $retval 859 $retval
618}
619
620sub exec_async(@) {
621 my $pid = fork;
622
623 return
624 if !defined $pid or $pid;
625
626 %ENV = %{ $TERM->env };
627
628 exec @_;
629 _exit 255;
630} 860}
631 861
632# urxvt::term::extension 862# urxvt::term::extension
633 863
634package urxvt::term::extension; 864package urxvt::term::extension;
640 while (my ($name, $cb) = each %hook) { 870 while (my ($name, $cb) = each %hook) {
641 my $htype = $HOOKTYPE{uc $name}; 871 my $htype = $HOOKTYPE{uc $name};
642 defined $htype 872 defined $htype
643 or Carp::croak "unsupported hook type '$name'"; 873 or Carp::croak "unsupported hook type '$name'";
644 874
875 $self->set_should_invoke ($htype, +1)
645 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 876 unless exists $self->{term}{_hook}[$htype]{$pkg};
646 $hook_count[$htype]++
647 or urxvt::set_should_invoke $htype, 1;
648 }
649 877
650 $self->{term}{_hook}[$htype]{$pkg} = $cb; 878 $self->{term}{_hook}[$htype]{$pkg} = $cb;
651 } 879 }
652} 880}
653 881
658 for my $name (@hook) { 886 for my $name (@hook) {
659 my $htype = $HOOKTYPE{uc $name}; 887 my $htype = $HOOKTYPE{uc $name};
660 defined $htype 888 defined $htype
661 or Carp::croak "unsupported hook type '$name'"; 889 or Carp::croak "unsupported hook type '$name'";
662 890
891 $self->set_should_invoke ($htype, -1)
663 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 892 if delete $self->{term}{_hook}[$htype]{$pkg};
664 --$hook_count[$htype]
665 or urxvt::set_should_invoke $htype, 0;
666 }
667 } 893 }
668} 894}
669 895
670our $AUTOLOAD; 896our $AUTOLOAD;
671 897
777# find on_xxx subs in the package and register them 1003# find on_xxx subs in the package and register them
778# as hooks 1004# as hooks
779sub register_package { 1005sub register_package {
780 my ($self, $pkg, $argv) = @_; 1006 my ($self, $pkg, $argv) = @_;
781 1007
1008 no strict 'refs';
1009
1010 urxvt::verbose 6, "register package $pkg to $self";
1011
1012 @{"$pkg\::ISA"} = urxvt::term::extension::;
1013
782 my $proxy = bless { 1014 my $proxy = bless {
783 _pkg => $pkg, 1015 _pkg => $pkg,
784 argv => $argv, 1016 argv => $argv,
785 }, $pkg; 1017 }, $pkg;
786 Scalar::Util::weaken ($proxy->{term} = $self); 1018 Scalar::Util::weaken ($proxy->{term} = $self);
817 1049
818Destroy the terminal object (close the window, free resources 1050Destroy the terminal object (close the window, free resources
819etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1051etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
820watchers (timers, io watchers) are still active. 1052watchers (timers, io watchers) are still active.
821 1053
1054=item $term->exec_async ($cmd[, @args])
1055
1056Works like the combination of the C<fork>/C<exec> builtins, which executes
1057("starts") programs in the background. This function takes care of setting
1058the user environment before exec'ing the command (e.g. C<PATH>) and should
1059be preferred over explicit calls to C<exec> or C<system>.
1060
1061Returns the pid of the subprocess or C<undef> on error.
1062
1063=cut
1064
1065sub exec_async {
1066 my $self = shift;
1067
1068 my $pid = fork;
1069
1070 return $pid
1071 if !defined $pid or $pid;
1072
1073 %ENV = %{ $self->env };
1074
1075 exec @_;
1076 urxvt::_exit 255;
1077}
1078
822=item $isset = $term->option ($optval[, $set]) 1079=item $isset = $term->option ($optval[, $set])
823 1080
824Returns true if the option specified by C<$optval> is enabled, and 1081Returns true if the option specified by C<$optval> is enabled, and
825optionally change it. All option values are stored by name in the hash 1082optionally change it. All option values are stored by name in the hash
826C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1083C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
828Here is a a likely non-exhaustive list of option names, please see the 1085Here is a a likely non-exhaustive list of option names, please see the
829source file F</src/optinc.h> to see the actual list: 1086source file F</src/optinc.h> to see the actual list:
830 1087
831 borderLess console cursorBlink cursorUnderline hold iconic insecure 1088 borderLess console cursorBlink cursorUnderline hold iconic insecure
832 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1089 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
833 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1090 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
834 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1091 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
835 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1092 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
836 tripleclickwords utmpInhibit visualBell 1093 transparent tripleclickwords utmpInhibit visualBell
837 1094
838=item $value = $term->resource ($name[, $newval]) 1095=item $value = $term->resource ($name[, $newval])
839 1096
840Returns the current resource value associated with a given name and 1097Returns the current resource value associated with a given name and
841optionally sets a new value. Setting values is most useful in the C<init> 1098optionally sets a new value. Setting values is most useful in the C<init>
858 1115
859 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1116 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
860 borderLess color cursorBlink cursorUnderline cutchars delete_key 1117 borderLess color cursorBlink cursorUnderline cutchars delete_key
861 display_name embed ext_bwidth fade font geometry hold iconName 1118 display_name embed ext_bwidth fade font geometry hold iconName
862 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1119 imFont imLocale inputMethod insecure int_bwidth intensityStyles
863 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1120 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
864 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1121 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
865 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1122 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
866 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1123 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
867 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1124 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
868 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1125 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
869 shade term_name title transparent transparent_all tripleclickwords 1126 secondaryScreen secondaryScroll selectstyle shade term_name title
870 utmpInhibit visualBell 1127 transient_for transparent transparent_all tripleclickwords utmpInhibit
1128 visualBell
871 1129
872=cut 1130=cut
873 1131
874sub resource($$;$) { 1132sub resource($$;$) {
875 my ($self, $name) = (shift, shift); 1133 my ($self, $name) = (shift, shift);
910=item ($row, $col) = $term->selection_end ([$row, $col]) 1168=item ($row, $col) = $term->selection_end ([$row, $col])
911 1169
912Return the current values of the selection mark, begin or end positions, 1170Return the current values of the selection mark, begin or end positions,
913and optionally set them to new values. 1171and optionally set them to new values.
914 1172
1173=item $term->selection_make ($eventtime[, $rectangular])
1174
1175Tries to make a selection as set by C<selection_beg> and
1176C<selection_end>. If C<$rectangular> is true (default: false), a
1177rectangular selection will be made. This is the prefered function to make
1178a selection.
1179
915=item $success = $term->selection_grab ($eventtime) 1180=item $success = $term->selection_grab ($eventtime)
916 1181
917Try to request the primary selection from the server (for example, as set 1182Try to request the primary selection text from the server (for example, as
918by the next method). 1183set by the next method). No visual feedback will be given. This function
1184is mostly useful from within C<on_sel_grab> hooks.
919 1185
920=item $oldtext = $term->selection ([$newtext]) 1186=item $oldtext = $term->selection ([$newtext])
921 1187
922Return the current selection text and optionally replace it by C<$newtext>. 1188Return the current selection text and optionally replace it by C<$newtext>.
923 1189
1016Convert the given locale-encoded octets into a perl string. 1282Convert the given locale-encoded octets into a perl string.
1017 1283
1018=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1284=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1019 1285
1020XORs the rendition values in the given span with the provided value 1286XORs the rendition values in the given span with the provided value
1021(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1287(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1022to the selection. 1288refresh hooks to provide effects similar to the selection.
1023 1289
1024=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1290=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1025 1291
1026Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1292Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1027whitespace will additionally be xored with the C<$rstyle2>, which defaults 1293whitespace will additionally be xored with the C<$rstyle2>, which defaults
1028to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1294to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1029it instead. 1295it instead. Both styles I<MUST NOT> contain font styles.
1030 1296
1031=item $term->scr_bell 1297=item $term->scr_bell
1032 1298
1033Ring the bell! 1299Ring the bell!
1034 1300
1041 1307
1042Normally its not a good idea to use this function, as programs might be 1308Normally its not a good idea to use this function, as programs might be
1043confused by changes in cursor position or scrolling. Its useful inside a 1309confused by changes in cursor position or scrolling. Its useful inside a
1044C<on_add_lines> hook, though. 1310C<on_add_lines> hook, though.
1045 1311
1312=item $term->scr_change_screen ($screen)
1313
1314Switch to given screen - 0 primary, 1 secondary.
1315
1046=item $term->cmd_parse ($octets) 1316=item $term->cmd_parse ($octets)
1047 1317
1048Similar to C<scr_add_lines>, but the argument must be in the 1318Similar to C<scr_add_lines>, but the argument must be in the
1049locale-specific encoding of the terminal and can contain command sequences 1319locale-specific encoding of the terminal and can contain command sequences
1050(escape codes) that will be interpreted. 1320(escape codes) that will be interpreted.
1060Replaces the event mask of the pty watcher by the given event mask. Can 1330Replaces the event mask of the pty watcher by the given event mask. Can
1061be used to suppress input and output handling to the pty/tty. See the 1331be used to suppress input and output handling to the pty/tty. See the
1062description of C<< urxvt::timer->events >>. Make sure to always restore 1332description of C<< urxvt::timer->events >>. Make sure to always restore
1063the previous value. 1333the previous value.
1064 1334
1335=item $fd = $term->pty_fd
1336
1337Returns the master file descriptor for the pty in use, or C<-1> if no pty
1338is used.
1339
1065=item $windowid = $term->parent 1340=item $windowid = $term->parent
1066 1341
1067Return the window id of the toplevel window. 1342Return the window id of the toplevel window.
1068 1343
1069=item $windowid = $term->vt 1344=item $windowid = $term->vt
1070 1345
1071Return the window id of the terminal window. 1346Return the window id of the terminal window.
1072 1347
1348=item $term->vt_emask_add ($x_event_mask)
1349
1350Adds the specified events to the vt event mask. Useful e.g. when you want
1351to receive pointer events all the times:
1352
1353 $term->vt_emask_add (urxvt::PointerMotionMask);
1354
1073=item $window_width = $term->width 1355=item $window_width = $term->width
1074 1356
1075=item $window_height = $term->height 1357=item $window_height = $term->height
1076 1358
1077=item $font_width = $term->fwidth 1359=item $font_width = $term->fwidth
1090 1372
1091=item $max_scrollback = $term->saveLines 1373=item $max_scrollback = $term->saveLines
1092 1374
1093=item $nrow_plus_saveLines = $term->total_rows 1375=item $nrow_plus_saveLines = $term->total_rows
1094 1376
1095=item $lines_in_scrollback = $term->nsaved 1377=item $topmost_scrollback_row = $term->top_row
1096 1378
1097Return various integers describing terminal characteristics. 1379Return various integers describing terminal characteristics.
1098 1380
1099=item $x_display = $term->display_id 1381=item $x_display = $term->display_id
1100 1382
1126=item $modifiermask = $term->ModNumLockMask 1408=item $modifiermask = $term->ModNumLockMask
1127 1409
1128Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1410Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1129AltGr), the meta key (often Alt) and the num lock key, if applicable. 1411AltGr), the meta key (often Alt) and the num lock key, if applicable.
1130 1412
1413=item $screen = $term->current_screen
1414
1415Returns the currently displayed screen (0 primary, 1 secondary).
1416
1417=item $cursor_is_hidden = $term->hidden_cursor
1418
1419Returns wether the cursor is currently hidden or not.
1420
1131=item $view_start = $term->view_start ([$newvalue]) 1421=item $view_start = $term->view_start ([$newvalue])
1132 1422
1133Returns the negative row number of the topmost line. Minimum value is 1423Returns the row number of the topmost displayed line. Maximum value is
1134C<0>, which displays the normal terminal contents. Larger values scroll 1424C<0>, which displays the normal terminal contents. Lower values scroll
1135this many lines into the scrollback buffer. 1425this many lines into the scrollback buffer.
1136 1426
1137=item $term->want_refresh 1427=item $term->want_refresh
1138 1428
1139Requests a screen refresh. At the next opportunity, rxvt-unicode will 1429Requests a screen refresh. At the next opportunity, rxvt-unicode will
1154line, starting at column C<$start_col> (default C<0>), which is useful 1444line, starting at column C<$start_col> (default C<0>), which is useful
1155to replace only parts of a line. The font index in the rendition will 1445to replace only parts of a line. The font index in the rendition will
1156automatically be updated. 1446automatically be updated.
1157 1447
1158C<$text> is in a special encoding: tabs and wide characters that use more 1448C<$text> is in a special encoding: tabs and wide characters that use more
1159than one cell when displayed are padded with urxvt::NOCHAR characters 1449than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1160(C<chr 65535>). Characters with combining characters and other characters 1450characters. Characters with combining characters and other characters that
1161that do not fit into the normal tetx encoding will be replaced with 1451do not fit into the normal tetx encoding will be replaced with characters
1162characters in the private use area. 1452in the private use area.
1163 1453
1164You have to obey this encoding when changing text. The advantage is 1454You have to obey this encoding when changing text. The advantage is
1165that C<substr> and similar functions work on screen cells and not on 1455that C<substr> and similar functions work on screen cells and not on
1166characters. 1456characters.
1167 1457
1218Return the row number of the first/last row of the line, respectively. 1508Return the row number of the first/last row of the line, respectively.
1219 1509
1220=item $offset = $line->offset_of ($row, $col) 1510=item $offset = $line->offset_of ($row, $col)
1221 1511
1222Returns the character offset of the given row|col pair within the logical 1512Returns the character offset of the given row|col pair within the logical
1223line. 1513line. Works for rows outside the line, too, and returns corresponding
1514offsets outside the string.
1224 1515
1225=item ($row, $col) = $line->coord_of ($offset) 1516=item ($row, $col) = $line->coord_of ($offset)
1226 1517
1227Translates a string offset into terminal coordinates again. 1518Translates a string offset into terminal coordinates again.
1228 1519
1341 1632
1342Calls XUngrab for the most recent grab. Is called automatically on 1633Calls XUngrab for the most recent grab. Is called automatically on
1343evaluation errors, as it is better to lose the grab in the error case as 1634evaluation errors, as it is better to lose the grab in the error case as
1344the session. 1635the session.
1345 1636
1637=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1638
1639=item $atom_name = $term->XGetAtomName ($atom)
1640
1641=item @atoms = $term->XListProperties ($window)
1642
1643=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1644
1645=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1646
1647=item $term->XDeleteProperty ($window, $property)
1648
1649=item $window = $term->DefaultRootWindow
1650
1651=item $term->XReparentWindow ($window, $parent, [$x, $y])
1652
1653=item $term->XMapWindow ($window)
1654
1655=item $term->XUnmapWindow ($window)
1656
1657=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1658
1659=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1660
1661=item $term->XChangeInput ($window, $add_events[, $del_events])
1662
1663Various X or X-related functions. The C<$term> object only serves as
1664the source of the display, otherwise those functions map more-or-less
1665directory onto the X functions of the same name.
1666
1346=back 1667=back
1347 1668
1348=cut 1669=cut
1349 1670
1350package urxvt::popup; 1671package urxvt::popup;
1451 my $env = $self->{term}->env; 1772 my $env = $self->{term}->env;
1452 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1773 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1453 delete $env->{LC_ALL}; 1774 delete $env->{LC_ALL};
1454 $env->{LC_CTYPE} = $self->{term}->locale; 1775 $env->{LC_CTYPE} = $self->{term}->locale;
1455 1776
1456 urxvt::term->new ($env, $self->{term}->resource ("name"), 1777 urxvt::term->new ($env, "popup",
1457 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1778 "--perl-lib" => "", "--perl-ext-common" => "",
1779 "-pty-fd" => -1, "-sl" => 0,
1780 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1458 "--transient-for" => $self->{term}->parent, 1781 "--transient-for" => $self->{term}->parent,
1459 "-display" => $self->{term}->display_id, 1782 "-display" => $self->{term}->display_id,
1460 "-pe" => "urxvt-popup") 1783 "-pe" => "urxvt-popup")
1461 or die "unable to create popup window\n"; 1784 or die "unable to create popup window\n";
1462} 1785}
1467 delete $self->{term}{_destroy}{$self}; 1790 delete $self->{term}{_destroy}{$self};
1468 $self->{term}->ungrab; 1791 $self->{term}->ungrab;
1469} 1792}
1470 1793
1471=back 1794=back
1795
1796=cut
1797
1798package urxvt::watcher;
1799
1800@urxvt::timer::ISA = __PACKAGE__;
1801@urxvt::iow::ISA = __PACKAGE__;
1802@urxvt::pw::ISA = __PACKAGE__;
1803@urxvt::iw::ISA = __PACKAGE__;
1472 1804
1473=head2 The C<urxvt::timer> Class 1805=head2 The C<urxvt::timer> Class
1474 1806
1475This class implements timer watchers/events. Time is represented as a 1807This class implements timer watchers/events. Time is represented as a
1476fractional number of seconds since the epoch. Example: 1808fractional number of seconds since the epoch. Example:
1514Start the timer. 1846Start the timer.
1515 1847
1516=item $timer = $timer->start ($tstamp) 1848=item $timer = $timer->start ($tstamp)
1517 1849
1518Set the event trigger time to C<$tstamp> and start the timer. 1850Set the event trigger time to C<$tstamp> and start the timer.
1851
1852=item $timer = $timer->after ($delay)
1853
1854Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1519 1855
1520=item $timer = $timer->stop 1856=item $timer = $timer->stop
1521 1857
1522Stop the timer. 1858Stop the timer.
1523 1859
1570 1906
1571Stop watching for events on the given filehandle. 1907Stop watching for events on the given filehandle.
1572 1908
1573=back 1909=back
1574 1910
1911=head2 The C<urxvt::iw> Class
1912
1913This class implements idle watchers, that get called automatically when
1914the process is idle. They should return as fast as possible, after doing
1915some useful work.
1916
1917=over 4
1918
1919=item $iw = new urxvt::iw
1920
1921Create a new idle watcher object in stopped state.
1922
1923=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1924
1925Set the callback to be called when the watcher triggers.
1926
1927=item $timer = $timer->start
1928
1929Start the watcher.
1930
1931=item $timer = $timer->stop
1932
1933Stop the watcher.
1934
1935=back
1936
1937=head2 The C<urxvt::pw> Class
1938
1939This class implements process watchers. They create an event whenever a
1940process exits, after which they stop automatically.
1941
1942 my $pid = fork;
1943 ...
1944 $term->{pw} = urxvt::pw
1945 ->new
1946 ->start ($pid)
1947 ->cb (sub {
1948 my ($pw, $exit_status) = @_;
1949 ...
1950 });
1951
1952=over 4
1953
1954=item $pw = new urxvt::pw
1955
1956Create a new process watcher in stopped state.
1957
1958=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1959
1960Set the callback to be called when the timer triggers.
1961
1962=item $pw = $timer->start ($pid)
1963
1964Tells the wqtcher to start watching for process C<$pid>.
1965
1966=item $pw = $pw->stop
1967
1968Stop the watcher.
1969
1970=back
1971
1575=head1 ENVIRONMENT 1972=head1 ENVIRONMENT
1576 1973
1577=head2 URXVT_PERL_VERBOSITY 1974=head2 URXVT_PERL_VERBOSITY
1578 1975
1579This variable controls the verbosity level of the perl extension. Higher 1976This variable controls the verbosity level of the perl extension. Higher
1583 1980
1584=item == 0 - fatal messages 1981=item == 0 - fatal messages
1585 1982
1586=item >= 3 - script loading and management 1983=item >= 3 - script loading and management
1587 1984
1588=item >=10 - all events received 1985=item >=10 - all called hooks
1986
1987=item >=11 - hook reutrn values
1589 1988
1590=back 1989=back
1591 1990
1592=head1 AUTHOR 1991=head1 AUTHOR
1593 1992

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines