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.82 by root, Thu Jan 12 01:30:53 2006 UTC vs.
Revision 1.130 by root, Wed Jan 25 15:32:48 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 clicked, the program specified in the resource 213make them clickable. When middle-clicked, the program specified in the
91C<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.
242
243=item digital-clock
244
245Displays a digital clock using the built-in overlay.
246
247=item remote-clipboard
248
249Somewhat of a misnomer, this extension adds two menu entries to the
250selection popup that allows one ti run external commands to store the
251selection somewhere and fetch it again.
252
253We use it to implement a "distributed selection mechanism", which just
254means that one command uploads the file to a remote server, and another
255reads it.
256
257The commands can be set using the C<URxvt.remote-selection.store> and
258C<URxvt.remote-selection.fetch> resources. The first should read the
259selection to store from STDIN (always in UTF-8), the second should provide
260the selection data on STDOUT (also in UTF-8).
261
262The defaults (which are likely useless to you) use rsh and cat:
263
264 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
266
267=item selection-pastebin
268
269This is a little rarely useful extension that Uploads the selection as
270textfile to a remote site (or does other things). (The implementation is
271not currently secure for use in a multiuser environment as it writes to
272F</tmp> directly.).
273
274It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
275i.e.
276
277 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
278
279Pressing this combination runs a command with C<%> replaced by the name of
280the textfile. This command can be set via a resource:
281
282 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
283
284And the default is likely not useful to anybody but the few people around
285here :)
286
287The name of the textfile is the hex encoded md5 sum of the selection, so
288the same content should lead to the same filename.
289
290After a successful upload the selection will be replaced by the text given
291in the C<selection-pastebin-url> resource (again, the % is the placeholder
292for the filename):
293
294 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
98 295
99=item example-refresh-hooks 296=item example-refresh-hooks
100 297
101Displays a very simple digital clock in the upper right corner of the 298Displays a very simple digital clock in the upper right corner of the
102window. Illustrates overwriting the refresh callbacks to create your own 299window. Illustrates overwriting the refresh callbacks to create your own
181called whenever the relevant event happens. 378called whenever the relevant event happens.
182 379
183The first argument passed to them is an extension oject as described in 380The first argument passed to them is an extension oject as described in
184the in the C<Extension Objects> section. 381the in the C<Extension Objects> section.
185 382
186B<All> of these hooks must return a boolean value. If it is true, then the 383B<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 384hooks 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. 385relevant action might not be carried out by the C++ code.
189 386
190I<< When in doubt, return a false value (preferably C<()>). >> 387I<< When in doubt, return a false value (preferably C<()>). >>
191 388
192=over 4 389=over 4
193 390
194=item on_init $term 391=item on_init $term
195 392
196Called after a new terminal object has been initialized, but before 393Called after a new terminal object has been initialized, but before
197windows are created or the command gets run. Most methods are unsafe to 394windows are created or the command gets run. Most methods are unsafe to
198call or deliver senseless data, as terminal size and other characteristics 395call or deliver senseless data, as terminal size and other characteristics
199have not yet been determined. You can safely query and change resources, 396have not yet been determined. You can safely query and change resources
200though. 397and options, though. For many purposes the C<on_start> hook is a better
398place.
399
400=item on_start $term
401
402Called at the very end of initialisation of a new terminal, just before
403trying to map (display) the toplevel and returning to the mainloop.
404
405=item on_destroy $term
406
407Called whenever something tries to destroy terminal, when the terminal is
408still fully functional (not for long, though).
201 409
202=item on_reset $term 410=item on_reset $term
203 411
204Called after the screen is "reset" for any reason, such as resizing or 412Called 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 413control sequences. Here is where you can react on changes to size-related
206variables. 414variables.
207 415
208=item on_start $term 416=item on_child_start $term, $pid
209 417
210Called at the very end of initialisation of a new terminal, just before 418Called just after the child process has been C<fork>ed.
211returning to the mainloop. 419
420=item on_child_exit $term, $status
421
422Called just after the child process has exited. C<$status> is the status
423from C<waitpid>.
212 424
213=item on_sel_make $term, $eventtime 425=item on_sel_make $term, $eventtime
214 426
215Called whenever a selection has been made by the user, but before the 427Called 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 428selection text is copied, so changes to the beginning, end or type of the
230=item on_sel_extend $term 442=item on_sel_extend $term
231 443
232Called whenever the user tries to extend the selection (e.g. with a double 444Called whenever the user tries to extend the selection (e.g. with a double
233click) and is either supposed to return false (normal operation), or 445click) and is either supposed to return false (normal operation), or
234should extend the selection itelf and return true to suppress the built-in 446should extend the selection itelf and return true to suppress the built-in
235processing. 447processing. This can happen multiple times, as long as the callback
448returns true, it will be called on every further click by the user and is
449supposed to enlarge the selection more and more, if possible.
236 450
237See the F<selection> example extension. 451See the F<selection> example extension.
238 452
239=item on_view_change $term, $offset 453=item on_view_change $term, $offset
240 454
301 515
302=item on_refresh_end $term 516=item on_refresh_end $term
303 517
304Called just after the screen gets redrawn. See C<on_refresh_begin>. 518Called just after the screen gets redrawn. See C<on_refresh_begin>.
305 519
306=item on_keyboard_command $term, $string 520=item on_user_command $term, $string
307 521
308Called whenever the user presses a key combination that has a 522Called whenever the a user-configured event is being activated (e.g. via
309C<perl:string> action bound to it (see description of the B<keysym> 523a C<perl:string> action bound to a key, see description of the B<keysym>
310resource in the @@RXVT_NAME@@(1) manpage). 524resource in the @@RXVT_NAME@@(1) manpage).
525
526The event is simply the action string. This interface is assumed to change
527slightly in the future.
528
529=item on_x_event $term, $event
530
531Called on every X event received on the vt window (and possibly other
532windows). Should only be used as a last resort. Most event structure
533members are not passed.
311 534
312=item on_focus_in $term 535=item on_focus_in $term
313 536
314Called whenever the window gets the keyboard focus, before rxvt-unicode 537Called whenever the window gets the keyboard focus, before rxvt-unicode
315does focus in processing. 538does focus in processing.
317=item on_focus_out $term 540=item on_focus_out $term
318 541
319Called wheneever the window loses keyboard focus, before rxvt-unicode does 542Called wheneever the window loses keyboard focus, before rxvt-unicode does
320focus out processing. 543focus out processing.
321 544
545=item on_configure_notify $term, $event
546
547=item on_property_notify $term, $event
548
322=item on_key_press $term, $event, $keysym, $octets 549=item on_key_press $term, $event, $keysym, $octets
323 550
324=item on_key_release $term, $event, $keysym 551=item on_key_release $term, $event, $keysym
325 552
326=item on_button_press $term, $event 553=item on_button_press $term, $event
335 562
336Called whenever the corresponding X event is received for the terminal If 563Called whenever the corresponding X event is received for the terminal If
337the hook returns true, then the even will be ignored by rxvt-unicode. 564the hook returns true, then the even will be ignored by rxvt-unicode.
338 565
339The event is a hash with most values as named by Xlib (see the XEvent 566The 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 567manpage), with the additional members C<row> and C<col>, which are the
341and column under the mouse cursor. 568(real, not screen-based) row and column under the mouse cursor.
342 569
343C<on_key_press> additionally receives the string rxvt-unicode would 570C<on_key_press> additionally receives the string rxvt-unicode would
344output, if any, in locale-specific encoding. 571output, if any, in locale-specific encoding.
345 572
346subwindow. 573subwindow.
574
575=item on_client_message $term, $event
576
577=item on_wm_protocols $term, $event
578
579=item on_wm_delete_window $term, $event
580
581Called when various types of ClientMessage events are received (all with
582format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
347 583
348=back 584=back
349 585
350=cut 586=cut
351 587
357use Scalar::Util (); 593use Scalar::Util ();
358use List::Util (); 594use List::Util ();
359 595
360our $VERSION = 1; 596our $VERSION = 1;
361our $TERM; 597our $TERM;
598our @TERM_INIT;
599our @TERM_EXT;
362our @HOOKNAME; 600our @HOOKNAME;
363our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 601our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364our %OPTION; 602our %OPTION;
365 603
366our $LIBDIR; 604our $LIBDIR;
367our $RESNAME; 605our $RESNAME;
368our $RESCLASS; 606our $RESCLASS;
369our $RXVTNAME; 607our $RXVTNAME;
370 608
609our $NOCHAR = chr 0xffff;
610
371=head2 Variables in the C<urxvt> Package 611=head2 Variables in the C<urxvt> Package
372 612
373=over 4 613=over 4
374 614
375=item $urxvt::LIBDIR 615=item $urxvt::LIBDIR
387 627
388=item $urxvt::TERM 628=item $urxvt::TERM
389 629
390The current terminal. This variable stores the current C<urxvt::term> 630The current terminal. This variable stores the current C<urxvt::term>
391object, whenever a callback/hook is executing. 631object, whenever a callback/hook is executing.
632
633=item @urxvt::TERM_INIT
634
635All coderefs in this array will be called as methods of the next newly
636created C<urxvt::term> object (during the C<on_init> phase). The array
637gets cleared before the codereferences that were in it are being executed,
638so coderefs can push themselves onto it again if they so desire.
639
640This complements to the perl-eval commandline option, but gets executed
641first.
642
643=item @urxvt::TERM_EXT
644
645Works similar to C<@TERM_INIT>, but contains perl package/class names, which
646get registered as normal extensions after calling the hooks in C<@TERM_INIT>
647but before other extensions. Gets cleared just like C<@TERM_INIT>.
392 648
393=back 649=back
394 650
395=head2 Functions in the C<urxvt> Package 651=head2 Functions in the C<urxvt> Package
396 652
411Using this function has the advantage that its output ends up in the 667Using this function has the advantage that its output ends up in the
412correct place, e.g. on stderr of the connecting urxvtc client. 668correct place, e.g. on stderr of the connecting urxvtc client.
413 669
414Messages have a size limit of 1023 bytes currently. 670Messages have a size limit of 1023 bytes currently.
415 671
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 672=item $time = urxvt::NOW
423 673
424Returns the "current time" (as per the event loop). 674Returns the "current time" (as per the event loop).
425 675
426=item urxvt::CurrentTime 676=item urxvt::CurrentTime
427 677
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 678=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 679Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier 680Button4Mask, Button5Mask, AnyModifier
681
682=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
683ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
684PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
685Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
686KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
687ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
688FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
689
690=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
691EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
692GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
693UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
694ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
695CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
696SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431 697
432Various constants for use in X calls and event processing. 698Various constants for use in X calls and event processing.
433 699
434=back 700=back
435 701
486=back 752=back
487 753
488=cut 754=cut
489 755
490BEGIN { 756BEGIN {
491 urxvt->bootstrap;
492
493 # overwrite perl's warn 757 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub { 758 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_; 759 my $msg = join "", @_;
496 $msg .= "\n" 760 $msg .= "\n"
497 unless $msg =~ /\n$/; 761 unless $msg =~ /\n$/;
498 urxvt::warn ($msg); 762 urxvt::warn ($msg);
499 }; 763 };
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} 764}
507 765
508my @hook_count; 766no warnings 'utf8';
767
509my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 768my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510 769
511sub verbose { 770sub verbose {
512 my ($level, $msg) = @_; 771 my ($level, $msg) = @_;
513 warn "$msg\n" if $level <= $verbosity; 772 warn "$msg\n" if $level <= $verbosity;
514} 773}
515 774
516my $extension_pkg = "extension0000";
517my %extension_pkg; 775my %extension_pkg;
518 776
519# load a single script into its own package, once only 777# load a single script into its own package, once only
520sub extension_package($) { 778sub extension_package($) {
521 my ($path) = @_; 779 my ($path) = @_;
522 780
523 $extension_pkg{$path} ||= do { 781 $extension_pkg{$path} ||= do {
524 my $pkg = "urxvt::" . ($extension_pkg++); 782 $path =~ /([^\/\\]+)$/;
783 my $pkg = $1;
784 $pkg =~ s/[^[:word:]]/_/g;
785 $pkg = "urxvt::ext::$pkg";
525 786
526 verbose 3, "loading extension '$path' into package '$pkg'"; 787 verbose 3, "loading extension '$path' into package '$pkg'";
527 788
528 open my $fh, "<:raw", $path 789 open my $fh, "<:raw", $path
529 or die "$path: $!"; 790 or die "$path: $!";
530 791
531 my $source = untaint 792 my $source =
532 "package $pkg; use strict; use utf8;\n" 793 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
533 . "use base urxvt::term::extension::;\n"
534 . "#line 1 \"$path\"\n{\n" 794 . "#line 1 \"$path\"\n{\n"
535 . (do { local $/; <$fh> }) 795 . (do { local $/; <$fh> })
536 . "\n};\n1"; 796 . "\n};\n1";
537 797
538 eval $source 798 eval $source
552 if ($htype == 0) { # INIT 812 if ($htype == 0) { # INIT
553 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 813 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554 814
555 my %ext_arg; 815 my %ext_arg;
556 816
817 {
818 my @init = @TERM_INIT;
819 @TERM_INIT = ();
820 $_->($TERM) for @init;
821 my @pkg = @TERM_EXT;
822 @TERM_EXT = ();
823 $TERM->register_package ($_) for @pkg;
824 }
825
557 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 826 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558 if ($_ eq "default") { 827 if ($_ eq "default") {
559 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 828 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
560 } elsif (/^-(.*)$/) { 829 } elsif (/^-(.*)$/) {
561 delete $ext_arg{$1}; 830 delete $ext_arg{$1};
562 } elsif (/^([^<]+)<(.*)>$/) { 831 } elsif (/^([^<]+)<(.*)>$/) {
563 push @{ $ext_arg{$1} }, $2; 832 push @{ $ext_arg{$1} }, $2;
564 } else { 833 } else {
587 if $verbosity >= 10; 856 if $verbosity >= 10;
588 857
589 keys %$cb; 858 keys %$cb;
590 859
591 while (my ($pkg, $cb) = each %$cb) { 860 while (my ($pkg, $cb) = each %$cb) {
592 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 861 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
593 and last; 862 $retval ||= $retval_;
594 863
595 if ($@) { 864 if ($@) {
596 $TERM->ungrab; # better to lose the grab than the session 865 $TERM->ungrab; # better to lose the grab than the session
597 warn $@; 866 warn $@;
598 } 867 }
599 } 868 }
869
870 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
871 if $verbosity >= 11;
600 } 872 }
601 873
602 if ($htype == 1) { # DESTROY 874 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 875 # clear package objects
611 %$_ = () for values %{ $TERM->{_pkg} }; 876 %$_ = () for values %{ $TERM->{_pkg} };
612 877
613 # clear package 878 # clear package
614 %$TERM = (); 879 %$TERM = ();
628 while (my ($name, $cb) = each %hook) { 893 while (my ($name, $cb) = each %hook) {
629 my $htype = $HOOKTYPE{uc $name}; 894 my $htype = $HOOKTYPE{uc $name};
630 defined $htype 895 defined $htype
631 or Carp::croak "unsupported hook type '$name'"; 896 or Carp::croak "unsupported hook type '$name'";
632 897
898 $self->set_should_invoke ($htype, +1)
633 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 899 unless exists $self->{term}{_hook}[$htype]{$pkg};
634 $hook_count[$htype]++
635 or urxvt::set_should_invoke $htype, 1;
636 }
637 900
638 $self->{term}{_hook}[$htype]{$pkg} = $cb; 901 $self->{term}{_hook}[$htype]{$pkg} = $cb;
639 } 902 }
640} 903}
641 904
646 for my $name (@hook) { 909 for my $name (@hook) {
647 my $htype = $HOOKTYPE{uc $name}; 910 my $htype = $HOOKTYPE{uc $name};
648 defined $htype 911 defined $htype
649 or Carp::croak "unsupported hook type '$name'"; 912 or Carp::croak "unsupported hook type '$name'";
650 913
914 $self->set_should_invoke ($htype, -1)
651 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 915 if delete $self->{term}{_hook}[$htype]{$pkg};
652 --$hook_count[$htype]
653 or urxvt::set_should_invoke $htype, 0;
654 }
655 } 916 }
656} 917}
657 918
658our $AUTOLOAD; 919our $AUTOLOAD;
659 920
765# find on_xxx subs in the package and register them 1026# find on_xxx subs in the package and register them
766# as hooks 1027# as hooks
767sub register_package { 1028sub register_package {
768 my ($self, $pkg, $argv) = @_; 1029 my ($self, $pkg, $argv) = @_;
769 1030
1031 no strict 'refs';
1032
1033 urxvt::verbose 6, "register package $pkg to $self";
1034
1035 @{"$pkg\::ISA"} = urxvt::term::extension::;
1036
770 my $proxy = bless { 1037 my $proxy = bless {
771 _pkg => $pkg, 1038 _pkg => $pkg,
772 argv => $argv, 1039 argv => $argv,
773 }, $pkg; 1040 }, $pkg;
774 Scalar::Util::weaken ($proxy->{term} = $self); 1041 Scalar::Util::weaken ($proxy->{term} = $self);
805 1072
806Destroy the terminal object (close the window, free resources 1073Destroy the terminal object (close the window, free resources
807etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1074etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
808watchers (timers, io watchers) are still active. 1075watchers (timers, io watchers) are still active.
809 1076
1077=item $term->exec_async ($cmd[, @args])
1078
1079Works like the combination of the C<fork>/C<exec> builtins, which executes
1080("starts") programs in the background. This function takes care of setting
1081the user environment before exec'ing the command (e.g. C<PATH>) and should
1082be preferred over explicit calls to C<exec> or C<system>.
1083
1084Returns the pid of the subprocess or C<undef> on error.
1085
1086=cut
1087
1088sub exec_async {
1089 my $self = shift;
1090
1091 my $pid = fork;
1092
1093 return $pid
1094 if !defined $pid or $pid;
1095
1096 %ENV = %{ $self->env };
1097
1098 exec @_;
1099 urxvt::_exit 255;
1100}
1101
810=item $isset = $term->option ($optval[, $set]) 1102=item $isset = $term->option ($optval[, $set])
811 1103
812Returns true if the option specified by C<$optval> is enabled, and 1104Returns true if the option specified by C<$optval> is enabled, and
813optionally change it. All option values are stored by name in the hash 1105optionally change it. All option values are stored by name in the hash
814C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1106C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
816Here is a a likely non-exhaustive list of option names, please see the 1108Here is a a likely non-exhaustive list of option names, please see the
817source file F</src/optinc.h> to see the actual list: 1109source file F</src/optinc.h> to see the actual list:
818 1110
819 borderLess console cursorBlink cursorUnderline hold iconic insecure 1111 borderLess console cursorBlink cursorUnderline hold iconic insecure
820 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1112 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
821 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1113 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
822 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1114 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
823 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1115 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
824 tripleclickwords utmpInhibit visualBell 1116 transparent tripleclickwords utmpInhibit visualBell
825 1117
826=item $value = $term->resource ($name[, $newval]) 1118=item $value = $term->resource ($name[, $newval])
827 1119
828Returns the current resource value associated with a given name and 1120Returns the current resource value associated with a given name and
829optionally sets a new value. Setting values is most useful in the C<init> 1121optionally sets a new value. Setting values is most useful in the C<init>
846 1138
847 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1139 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
848 borderLess color cursorBlink cursorUnderline cutchars delete_key 1140 borderLess color cursorBlink cursorUnderline cutchars delete_key
849 display_name embed ext_bwidth fade font geometry hold iconName 1141 display_name embed ext_bwidth fade font geometry hold iconName
850 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1142 imFont imLocale inputMethod insecure int_bwidth intensityStyles
851 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1143 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
852 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1144 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
853 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1145 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
854 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1146 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
855 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1147 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
856 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1148 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
857 shade term_name title transparent transparent_all tripleclickwords 1149 secondaryScreen secondaryScroll selectstyle shade term_name title
858 utmpInhibit visualBell 1150 transient_for transparent transparent_all tripleclickwords utmpInhibit
1151 visualBell
859 1152
860=cut 1153=cut
861 1154
862sub resource($$;$) { 1155sub resource($$;$) {
863 my ($self, $name) = (shift, shift); 1156 my ($self, $name) = (shift, shift);
898=item ($row, $col) = $term->selection_end ([$row, $col]) 1191=item ($row, $col) = $term->selection_end ([$row, $col])
899 1192
900Return the current values of the selection mark, begin or end positions, 1193Return the current values of the selection mark, begin or end positions,
901and optionally set them to new values. 1194and optionally set them to new values.
902 1195
1196=item $term->selection_make ($eventtime[, $rectangular])
1197
1198Tries to make a selection as set by C<selection_beg> and
1199C<selection_end>. If C<$rectangular> is true (default: false), a
1200rectangular selection will be made. This is the prefered function to make
1201a selection.
1202
903=item $success = $term->selection_grab ($eventtime) 1203=item $success = $term->selection_grab ($eventtime)
904 1204
905Try to request the primary selection from the server (for example, as set 1205Try to request the primary selection text from the server (for example, as
906by the next method). 1206set by the next method). No visual feedback will be given. This function
1207is mostly useful from within C<on_sel_grab> hooks.
907 1208
908=item $oldtext = $term->selection ([$newtext]) 1209=item $oldtext = $term->selection ([$newtext])
909 1210
910Return the current selection text and optionally replace it by C<$newtext>. 1211Return the current selection text and optionally replace it by C<$newtext>.
911 1212
1004Convert the given locale-encoded octets into a perl string. 1305Convert the given locale-encoded octets into a perl string.
1005 1306
1006=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1307=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007 1308
1008XORs the rendition values in the given span with the provided value 1309XORs the rendition values in the given span with the provided value
1009(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1310(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1010to the selection. 1311refresh hooks to provide effects similar to the selection.
1011 1312
1012=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1313=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013 1314
1014Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1315Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015whitespace will additionally be xored with the C<$rstyle2>, which defaults 1316whitespace will additionally be xored with the C<$rstyle2>, which defaults
1016to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1317to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1017it instead. 1318it instead. Both styles I<MUST NOT> contain font styles.
1018 1319
1019=item $term->scr_bell 1320=item $term->scr_bell
1020 1321
1021Ring the bell! 1322Ring the bell!
1022 1323
1029 1330
1030Normally its not a good idea to use this function, as programs might be 1331Normally its not a good idea to use this function, as programs might be
1031confused by changes in cursor position or scrolling. Its useful inside a 1332confused by changes in cursor position or scrolling. Its useful inside a
1032C<on_add_lines> hook, though. 1333C<on_add_lines> hook, though.
1033 1334
1335=item $term->scr_change_screen ($screen)
1336
1337Switch to given screen - 0 primary, 1 secondary.
1338
1034=item $term->cmd_parse ($octets) 1339=item $term->cmd_parse ($octets)
1035 1340
1036Similar to C<scr_add_lines>, but the argument must be in the 1341Similar to C<scr_add_lines>, but the argument must be in the
1037locale-specific encoding of the terminal and can contain command sequences 1342locale-specific encoding of the terminal and can contain command sequences
1038(escape codes) that will be interpreted. 1343(escape codes) that will be interpreted.
1048Replaces the event mask of the pty watcher by the given event mask. Can 1353Replaces the event mask of the pty watcher by the given event mask. Can
1049be used to suppress input and output handling to the pty/tty. See the 1354be used to suppress input and output handling to the pty/tty. See the
1050description of C<< urxvt::timer->events >>. Make sure to always restore 1355description of C<< urxvt::timer->events >>. Make sure to always restore
1051the previous value. 1356the previous value.
1052 1357
1358=item $fd = $term->pty_fd
1359
1360Returns the master file descriptor for the pty in use, or C<-1> if no pty
1361is used.
1362
1053=item $windowid = $term->parent 1363=item $windowid = $term->parent
1054 1364
1055Return the window id of the toplevel window. 1365Return the window id of the toplevel window.
1056 1366
1057=item $windowid = $term->vt 1367=item $windowid = $term->vt
1058 1368
1059Return the window id of the terminal window. 1369Return the window id of the terminal window.
1060 1370
1371=item $term->vt_emask_add ($x_event_mask)
1372
1373Adds the specified events to the vt event mask. Useful e.g. when you want
1374to receive pointer events all the times:
1375
1376 $term->vt_emask_add (urxvt::PointerMotionMask);
1377
1061=item $window_width = $term->width 1378=item $window_width = $term->width
1062 1379
1063=item $window_height = $term->height 1380=item $window_height = $term->height
1064 1381
1065=item $font_width = $term->fwidth 1382=item $font_width = $term->fwidth
1078 1395
1079=item $max_scrollback = $term->saveLines 1396=item $max_scrollback = $term->saveLines
1080 1397
1081=item $nrow_plus_saveLines = $term->total_rows 1398=item $nrow_plus_saveLines = $term->total_rows
1082 1399
1083=item $lines_in_scrollback = $term->nsaved 1400=item $topmost_scrollback_row = $term->top_row
1084 1401
1085Return various integers describing terminal characteristics. 1402Return various integers describing terminal characteristics.
1086 1403
1087=item $x_display = $term->display_id 1404=item $x_display = $term->display_id
1088 1405
1114=item $modifiermask = $term->ModNumLockMask 1431=item $modifiermask = $term->ModNumLockMask
1115 1432
1116Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1433Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1117AltGr), the meta key (often Alt) and the num lock key, if applicable. 1434AltGr), the meta key (often Alt) and the num lock key, if applicable.
1118 1435
1436=item $screen = $term->current_screen
1437
1438Returns the currently displayed screen (0 primary, 1 secondary).
1439
1440=item $cursor_is_hidden = $term->hidden_cursor
1441
1442Returns wether the cursor is currently hidden or not.
1443
1119=item $view_start = $term->view_start ([$newvalue]) 1444=item $view_start = $term->view_start ([$newvalue])
1120 1445
1121Returns the negative row number of the topmost line. Minimum value is 1446Returns the row number of the topmost displayed line. Maximum value is
1122C<0>, which displays the normal terminal contents. Larger values scroll 1447C<0>, which displays the normal terminal contents. Lower values scroll
1123this many lines into the scrollback buffer. 1448this many lines into the scrollback buffer.
1124 1449
1125=item $term->want_refresh 1450=item $term->want_refresh
1126 1451
1127Requests a screen refresh. At the next opportunity, rxvt-unicode will 1452Requests a screen refresh. At the next opportunity, rxvt-unicode will
1142line, starting at column C<$start_col> (default C<0>), which is useful 1467line, starting at column C<$start_col> (default C<0>), which is useful
1143to replace only parts of a line. The font index in the rendition will 1468to replace only parts of a line. The font index in the rendition will
1144automatically be updated. 1469automatically be updated.
1145 1470
1146C<$text> is in a special encoding: tabs and wide characters that use more 1471C<$text> is in a special encoding: tabs and wide characters that use more
1147than one cell when displayed are padded with urxvt::NOCHAR characters 1472than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1148(C<chr 65535>). Characters with combining characters and other characters 1473characters. Characters with combining characters and other characters that
1149that do not fit into the normal tetx encoding will be replaced with 1474do not fit into the normal tetx encoding will be replaced with characters
1150characters in the private use area. 1475in the private use area.
1151 1476
1152You have to obey this encoding when changing text. The advantage is 1477You have to obey this encoding when changing text. The advantage is
1153that C<substr> and similar functions work on screen cells and not on 1478that C<substr> and similar functions work on screen cells and not on
1154characters. 1479characters.
1155 1480
1206Return the row number of the first/last row of the line, respectively. 1531Return the row number of the first/last row of the line, respectively.
1207 1532
1208=item $offset = $line->offset_of ($row, $col) 1533=item $offset = $line->offset_of ($row, $col)
1209 1534
1210Returns the character offset of the given row|col pair within the logical 1535Returns the character offset of the given row|col pair within the logical
1211line. 1536line. Works for rows outside the line, too, and returns corresponding
1537offsets outside the string.
1212 1538
1213=item ($row, $col) = $line->coord_of ($offset) 1539=item ($row, $col) = $line->coord_of ($offset)
1214 1540
1215Translates a string offset into terminal coordinates again. 1541Translates a string offset into terminal coordinates again.
1216 1542
1329 1655
1330Calls XUngrab for the most recent grab. Is called automatically on 1656Calls XUngrab for the most recent grab. Is called automatically on
1331evaluation errors, as it is better to lose the grab in the error case as 1657evaluation errors, as it is better to lose the grab in the error case as
1332the session. 1658the session.
1333 1659
1660=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1661
1662=item $atom_name = $term->XGetAtomName ($atom)
1663
1664=item @atoms = $term->XListProperties ($window)
1665
1666=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1667
1668=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1669
1670=item $term->XDeleteProperty ($window, $property)
1671
1672=item $window = $term->DefaultRootWindow
1673
1674=item $term->XReparentWindow ($window, $parent, [$x, $y])
1675
1676=item $term->XMapWindow ($window)
1677
1678=item $term->XUnmapWindow ($window)
1679
1680=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1681
1682=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1683
1684=item $term->XChangeInput ($window, $add_events[, $del_events])
1685
1686Various X or X-related functions. The C<$term> object only serves as
1687the source of the display, otherwise those functions map more-or-less
1688directory onto the X functions of the same name.
1689
1334=back 1690=back
1335 1691
1336=cut 1692=cut
1337 1693
1338package urxvt::popup; 1694package urxvt::popup;
1439 my $env = $self->{term}->env; 1795 my $env = $self->{term}->env;
1440 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1796 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1441 delete $env->{LC_ALL}; 1797 delete $env->{LC_ALL};
1442 $env->{LC_CTYPE} = $self->{term}->locale; 1798 $env->{LC_CTYPE} = $self->{term}->locale;
1443 1799
1444 urxvt::term->new ($env, $self->{term}->resource ("name"), 1800 urxvt::term->new ($env, "popup",
1445 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1801 "--perl-lib" => "", "--perl-ext-common" => "",
1802 "-pty-fd" => -1, "-sl" => 0,
1803 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1446 "--transient-for" => $self->{term}->parent, 1804 "--transient-for" => $self->{term}->parent,
1447 "-display" => $self->{term}->display_id, 1805 "-display" => $self->{term}->display_id,
1448 "-pe" => "urxvt-popup") 1806 "-pe" => "urxvt-popup")
1449 or die "unable to create popup window\n"; 1807 or die "unable to create popup window\n";
1450} 1808}
1455 delete $self->{term}{_destroy}{$self}; 1813 delete $self->{term}{_destroy}{$self};
1456 $self->{term}->ungrab; 1814 $self->{term}->ungrab;
1457} 1815}
1458 1816
1459=back 1817=back
1818
1819=cut
1820
1821package urxvt::watcher;
1822
1823@urxvt::timer::ISA = __PACKAGE__;
1824@urxvt::iow::ISA = __PACKAGE__;
1825@urxvt::pw::ISA = __PACKAGE__;
1826@urxvt::iw::ISA = __PACKAGE__;
1460 1827
1461=head2 The C<urxvt::timer> Class 1828=head2 The C<urxvt::timer> Class
1462 1829
1463This class implements timer watchers/events. Time is represented as a 1830This class implements timer watchers/events. Time is represented as a
1464fractional number of seconds since the epoch. Example: 1831fractional number of seconds since the epoch. Example:
1502Start the timer. 1869Start the timer.
1503 1870
1504=item $timer = $timer->start ($tstamp) 1871=item $timer = $timer->start ($tstamp)
1505 1872
1506Set the event trigger time to C<$tstamp> and start the timer. 1873Set the event trigger time to C<$tstamp> and start the timer.
1874
1875=item $timer = $timer->after ($delay)
1876
1877Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1507 1878
1508=item $timer = $timer->stop 1879=item $timer = $timer->stop
1509 1880
1510Stop the timer. 1881Stop the timer.
1511 1882
1558 1929
1559Stop watching for events on the given filehandle. 1930Stop watching for events on the given filehandle.
1560 1931
1561=back 1932=back
1562 1933
1934=head2 The C<urxvt::iw> Class
1935
1936This class implements idle watchers, that get called automatically when
1937the process is idle. They should return as fast as possible, after doing
1938some useful work.
1939
1940=over 4
1941
1942=item $iw = new urxvt::iw
1943
1944Create a new idle watcher object in stopped state.
1945
1946=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1947
1948Set the callback to be called when the watcher triggers.
1949
1950=item $timer = $timer->start
1951
1952Start the watcher.
1953
1954=item $timer = $timer->stop
1955
1956Stop the watcher.
1957
1958=back
1959
1960=head2 The C<urxvt::pw> Class
1961
1962This class implements process watchers. They create an event whenever a
1963process exits, after which they stop automatically.
1964
1965 my $pid = fork;
1966 ...
1967 $term->{pw} = urxvt::pw
1968 ->new
1969 ->start ($pid)
1970 ->cb (sub {
1971 my ($pw, $exit_status) = @_;
1972 ...
1973 });
1974
1975=over 4
1976
1977=item $pw = new urxvt::pw
1978
1979Create a new process watcher in stopped state.
1980
1981=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1982
1983Set the callback to be called when the timer triggers.
1984
1985=item $pw = $timer->start ($pid)
1986
1987Tells the wqtcher to start watching for process C<$pid>.
1988
1989=item $pw = $pw->stop
1990
1991Stop the watcher.
1992
1993=back
1994
1563=head1 ENVIRONMENT 1995=head1 ENVIRONMENT
1564 1996
1565=head2 URXVT_PERL_VERBOSITY 1997=head2 URXVT_PERL_VERBOSITY
1566 1998
1567This variable controls the verbosity level of the perl extension. Higher 1999This variable controls the verbosity level of the perl extension. Higher
1571 2003
1572=item == 0 - fatal messages 2004=item == 0 - fatal messages
1573 2005
1574=item >= 3 - script loading and management 2006=item >= 3 - script loading and management
1575 2007
1576=item >=10 - all events received 2008=item >=10 - all called hooks
2009
2010=item >=11 - hook reutrn values
1577 2011
1578=back 2012=back
1579 2013
1580=head1 AUTHOR 2014=head1 AUTHOR
1581 2015

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines