… | |
… | |
91 | |
91 | |
92 | =item selection-popup (enabled by default) |
92 | =item selection-popup (enabled by default) |
93 | |
93 | |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
95 | text into various other formats/action (such as uri unescaping, perl |
95 | text into various other formats/action (such as uri unescaping, perl |
96 | evalution, web-browser starting etc.), depending on content. |
96 | evaluation, web-browser starting etc.), depending on content. |
97 | |
97 | |
98 | Other extensions can extend this popup menu by pushing a code reference |
98 | Other extensions can extend this popup menu by pushing a code reference |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
100 | popup is displayed. |
100 | popup is displayed. |
101 | |
101 | |
… | |
… | |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
129 | additionally stores the first match in the current line into the primary |
129 | additionally stores the first match in the current line into the primary |
130 | selection. |
130 | selection. |
131 | |
131 | |
|
|
132 | =item readline (enabled by default) |
|
|
133 | |
|
|
134 | A support package that tries to make editing with readline easier. At the |
|
|
135 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
136 | move the text cursor to this position. It does so by generating as many |
|
|
137 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
138 | for programs that correctly support wide characters). |
|
|
139 | |
|
|
140 | To avoid too many false positives, this is only done when: |
|
|
141 | |
|
|
142 | =over 4 |
|
|
143 | |
|
|
144 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
145 | |
|
|
146 | =item - the primary screen is currently being displayed. |
|
|
147 | |
|
|
148 | =item - the text cursor is visible. |
|
|
149 | |
|
|
150 | =back |
|
|
151 | |
|
|
152 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
153 | might interfere with selection creation in harmless ways. |
|
|
154 | |
132 | =item selection-autotransform |
155 | =item selection-autotransform |
133 | |
156 | |
134 | This selection allows you to do automatic transforms on a selection |
157 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
158 | whenever a selection is made. |
136 | |
159 | |
… | |
… | |
161 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
184 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
162 | |
185 | |
163 | The first line tells the selection code to treat the unchanging part of |
186 | The first line tells the selection code to treat the unchanging part of |
164 | every error message as a selection pattern, and the second line transforms |
187 | every error message as a selection pattern, and the second line transforms |
165 | the message into vi commands to load the file. |
188 | the message into vi commands to load the file. |
|
|
189 | |
|
|
190 | =item tabbed |
|
|
191 | |
|
|
192 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
193 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
194 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
195 | button per tab. |
|
|
196 | |
|
|
197 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
198 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
199 | while B<Shift-Down> creates a new tab. |
166 | |
200 | |
167 | =item mark-urls |
201 | =item mark-urls |
168 | |
202 | |
169 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
203 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
170 | make them clickable. When middle-clicked, the program specified in the |
204 | make them clickable. When middle-clicked, the program specified in the |
… | |
… | |
303 | called whenever the relevant event happens. |
337 | called whenever the relevant event happens. |
304 | |
338 | |
305 | The first argument passed to them is an extension oject as described in |
339 | The first argument passed to them is an extension oject as described in |
306 | the in the C<Extension Objects> section. |
340 | the in the C<Extension Objects> section. |
307 | |
341 | |
308 | B<All> of these hooks must return a boolean value. If it is true, then the |
342 | B<All> of these hooks must return a boolean value. If any of the called |
309 | event counts as being I<consumed>, and the invocation of other hooks is |
343 | hooks returns true, then the event counts as being I<consumed>, and the |
310 | skipped, and the relevant action might not be carried out by the C++ code. |
344 | relevant action might not be carried out by the C++ code. |
311 | |
345 | |
312 | I<< When in doubt, return a false value (preferably C<()>). >> |
346 | I<< When in doubt, return a false value (preferably C<()>). >> |
313 | |
347 | |
314 | =over 4 |
348 | =over 4 |
315 | |
349 | |
316 | =item on_init $term |
350 | =item on_init $term |
317 | |
351 | |
318 | Called after a new terminal object has been initialized, but before |
352 | Called after a new terminal object has been initialized, but before |
319 | windows are created or the command gets run. Most methods are unsafe to |
353 | windows are created or the command gets run. Most methods are unsafe to |
320 | call or deliver senseless data, as terminal size and other characteristics |
354 | call or deliver senseless data, as terminal size and other characteristics |
321 | have not yet been determined. You can safely query and change resources, |
355 | have not yet been determined. You can safely query and change resources |
322 | though. |
356 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
357 | place. |
|
|
358 | |
|
|
359 | =item on_start $term |
|
|
360 | |
|
|
361 | Called at the very end of initialisation of a new terminal, just before |
|
|
362 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
363 | |
|
|
364 | =item on_destroy $term |
|
|
365 | |
|
|
366 | Called whenever something tries to destroy terminal, before doing anything |
|
|
367 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
368 | rarely a good idea. |
323 | |
369 | |
324 | =item on_reset $term |
370 | =item on_reset $term |
325 | |
371 | |
326 | Called after the screen is "reset" for any reason, such as resizing or |
372 | Called after the screen is "reset" for any reason, such as resizing or |
327 | control sequences. Here is where you can react on changes to size-related |
373 | control sequences. Here is where you can react on changes to size-related |
328 | variables. |
374 | variables. |
329 | |
|
|
330 | =item on_start $term |
|
|
331 | |
|
|
332 | Called at the very end of initialisation of a new terminal, just before |
|
|
333 | returning to the mainloop. |
|
|
334 | |
375 | |
335 | =item on_child_start $term, $pid |
376 | =item on_child_start $term, $pid |
336 | |
377 | |
337 | Called just after the child process has been C<fork>ed. |
378 | Called just after the child process has been C<fork>ed. |
338 | |
379 | |
… | |
… | |
458 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
499 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
459 | focus out processing. |
500 | focus out processing. |
460 | |
501 | |
461 | =item on_configure_notify $term, $event |
502 | =item on_configure_notify $term, $event |
462 | |
503 | |
|
|
504 | =item on_property_notify $term, $event |
|
|
505 | |
463 | =item on_key_press $term, $event, $keysym, $octets |
506 | =item on_key_press $term, $event, $keysym, $octets |
464 | |
507 | |
465 | =item on_key_release $term, $event, $keysym |
508 | =item on_key_release $term, $event, $keysym |
466 | |
509 | |
467 | =item on_button_press $term, $event |
510 | =item on_button_press $term, $event |
… | |
… | |
476 | |
519 | |
477 | Called whenever the corresponding X event is received for the terminal If |
520 | Called whenever the corresponding X event is received for the terminal If |
478 | the hook returns true, then the even will be ignored by rxvt-unicode. |
521 | the hook returns true, then the even will be ignored by rxvt-unicode. |
479 | |
522 | |
480 | The event is a hash with most values as named by Xlib (see the XEvent |
523 | The event is a hash with most values as named by Xlib (see the XEvent |
481 | manpage), with the additional members C<row> and C<col>, which are the row |
524 | manpage), with the additional members C<row> and C<col>, which are the |
482 | and column under the mouse cursor. |
525 | (real, not screen-based) row and column under the mouse cursor. |
483 | |
526 | |
484 | C<on_key_press> additionally receives the string rxvt-unicode would |
527 | C<on_key_press> additionally receives the string rxvt-unicode would |
485 | output, if any, in locale-specific encoding. |
528 | output, if any, in locale-specific encoding. |
486 | |
529 | |
487 | subwindow. |
530 | subwindow. |
|
|
531 | |
|
|
532 | =item on_client_message $term, $event |
|
|
533 | |
|
|
534 | =item on_wm_protocols $term, $event |
|
|
535 | |
|
|
536 | =item on_wm_delete_window $term, $event |
|
|
537 | |
|
|
538 | Called when various types of ClientMessage events are received (all with |
|
|
539 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
488 | |
540 | |
489 | =back |
541 | =back |
490 | |
542 | |
491 | =cut |
543 | =cut |
492 | |
544 | |
… | |
… | |
498 | use Scalar::Util (); |
550 | use Scalar::Util (); |
499 | use List::Util (); |
551 | use List::Util (); |
500 | |
552 | |
501 | our $VERSION = 1; |
553 | our $VERSION = 1; |
502 | our $TERM; |
554 | our $TERM; |
|
|
555 | our @TERM_INIT; |
|
|
556 | our @TERM_EXT; |
503 | our @HOOKNAME; |
557 | our @HOOKNAME; |
504 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
558 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
505 | our %OPTION; |
559 | our %OPTION; |
506 | |
560 | |
507 | our $LIBDIR; |
561 | our $LIBDIR; |
508 | our $RESNAME; |
562 | our $RESNAME; |
509 | our $RESCLASS; |
563 | our $RESCLASS; |
510 | our $RXVTNAME; |
564 | our $RXVTNAME; |
511 | |
565 | |
|
|
566 | our $NOCHAR = chr 0xfffe; |
|
|
567 | |
512 | =head2 Variables in the C<urxvt> Package |
568 | =head2 Variables in the C<urxvt> Package |
513 | |
569 | |
514 | =over 4 |
570 | =over 4 |
515 | |
571 | |
516 | =item $urxvt::LIBDIR |
572 | =item $urxvt::LIBDIR |
… | |
… | |
528 | |
584 | |
529 | =item $urxvt::TERM |
585 | =item $urxvt::TERM |
530 | |
586 | |
531 | The current terminal. This variable stores the current C<urxvt::term> |
587 | The current terminal. This variable stores the current C<urxvt::term> |
532 | object, whenever a callback/hook is executing. |
588 | object, whenever a callback/hook is executing. |
|
|
589 | |
|
|
590 | =item @urxvt::TERM_INIT |
|
|
591 | |
|
|
592 | All coderefs in this array will be called as methods of the next newly |
|
|
593 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
594 | gets cleared before the codereferences that were in it are being executed, |
|
|
595 | so coderefs can push themselves onto it again if they so desire. |
|
|
596 | |
|
|
597 | This complements to the perl-eval commandline option, but gets executed |
|
|
598 | first. |
|
|
599 | |
|
|
600 | =item @urxvt::TERM_EXT |
|
|
601 | |
|
|
602 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
603 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
604 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
533 | |
605 | |
534 | =back |
606 | =back |
535 | |
607 | |
536 | =head2 Functions in the C<urxvt> Package |
608 | =head2 Functions in the C<urxvt> Package |
537 | |
609 | |
… | |
… | |
659 | |
731 | |
660 | # load a single script into its own package, once only |
732 | # load a single script into its own package, once only |
661 | sub extension_package($) { |
733 | sub extension_package($) { |
662 | my ($path) = @_; |
734 | my ($path) = @_; |
663 | |
735 | |
664 | no strict 'refs'; |
|
|
665 | |
|
|
666 | $extension_pkg{$path} ||= do { |
736 | $extension_pkg{$path} ||= do { |
667 | $path =~ /([^\/\\]+)$/; |
737 | $path =~ /([^\/\\]+)$/; |
668 | my $pkg = $1; |
738 | my $pkg = $1; |
669 | $pkg =~ s/[^[:word:]]/_/g; |
739 | $pkg =~ s/[^[:word:]]/_/g; |
670 | $pkg = "urxvt::ext::$pkg"; |
740 | $pkg = "urxvt::ext::$pkg"; |
… | |
… | |
672 | verbose 3, "loading extension '$path' into package '$pkg'"; |
742 | verbose 3, "loading extension '$path' into package '$pkg'"; |
673 | |
743 | |
674 | open my $fh, "<:raw", $path |
744 | open my $fh, "<:raw", $path |
675 | or die "$path: $!"; |
745 | or die "$path: $!"; |
676 | |
746 | |
677 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
678 | |
|
|
679 | my $source = |
747 | my $source = |
680 | "package $pkg; use strict; use utf8;\n" |
748 | "package $pkg; use strict; use utf8;\n" |
681 | . "#line 1 \"$path\"\n{\n" |
749 | . "#line 1 \"$path\"\n{\n" |
682 | . (do { local $/; <$fh> }) |
750 | . (do { local $/; <$fh> }) |
683 | . "\n};\n1"; |
751 | . "\n};\n1"; |
… | |
… | |
699 | if ($htype == 0) { # INIT |
767 | if ($htype == 0) { # INIT |
700 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
768 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
701 | |
769 | |
702 | my %ext_arg; |
770 | my %ext_arg; |
703 | |
771 | |
|
|
772 | { |
|
|
773 | my @init = @TERM_INIT; |
|
|
774 | @TERM_INIT = (); |
|
|
775 | $_->($TERM) for @init; |
|
|
776 | my @pkg = @TERM_EXT; |
|
|
777 | @TERM_EXT = (); |
|
|
778 | $TERM->register_package ($_) for @pkg; |
|
|
779 | } |
|
|
780 | |
704 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
781 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
705 | if ($_ eq "default") { |
782 | if ($_ eq "default") { |
706 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
783 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
707 | } elsif (/^-(.*)$/) { |
784 | } elsif (/^-(.*)$/) { |
708 | delete $ext_arg{$1}; |
785 | delete $ext_arg{$1}; |
709 | } elsif (/^([^<]+)<(.*)>$/) { |
786 | } elsif (/^([^<]+)<(.*)>$/) { |
710 | push @{ $ext_arg{$1} }, $2; |
787 | push @{ $ext_arg{$1} }, $2; |
711 | } else { |
788 | } else { |
… | |
… | |
734 | if $verbosity >= 10; |
811 | if $verbosity >= 10; |
735 | |
812 | |
736 | keys %$cb; |
813 | keys %$cb; |
737 | |
814 | |
738 | while (my ($pkg, $cb) = each %$cb) { |
815 | while (my ($pkg, $cb) = each %$cb) { |
739 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
816 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
740 | and last; |
817 | $retval ||= $retval_; |
741 | |
818 | |
742 | if ($@) { |
819 | if ($@) { |
743 | $TERM->ungrab; # better to lose the grab than the session |
820 | $TERM->ungrab; # better to lose the grab than the session |
744 | warn $@; |
821 | warn $@; |
745 | } |
822 | } |
… | |
… | |
903 | |
980 | |
904 | # find on_xxx subs in the package and register them |
981 | # find on_xxx subs in the package and register them |
905 | # as hooks |
982 | # as hooks |
906 | sub register_package { |
983 | sub register_package { |
907 | my ($self, $pkg, $argv) = @_; |
984 | my ($self, $pkg, $argv) = @_; |
|
|
985 | |
|
|
986 | no strict 'refs'; |
|
|
987 | |
|
|
988 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
989 | |
|
|
990 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
908 | |
991 | |
909 | my $proxy = bless { |
992 | my $proxy = bless { |
910 | _pkg => $pkg, |
993 | _pkg => $pkg, |
911 | argv => $argv, |
994 | argv => $argv, |
912 | }, $pkg; |
995 | }, $pkg; |
… | |
… | |
1202 | |
1285 | |
1203 | Normally its not a good idea to use this function, as programs might be |
1286 | Normally its not a good idea to use this function, as programs might be |
1204 | confused by changes in cursor position or scrolling. Its useful inside a |
1287 | confused by changes in cursor position or scrolling. Its useful inside a |
1205 | C<on_add_lines> hook, though. |
1288 | C<on_add_lines> hook, though. |
1206 | |
1289 | |
|
|
1290 | =item $term->scr_change_screen ($screen) |
|
|
1291 | |
|
|
1292 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1293 | |
1207 | =item $term->cmd_parse ($octets) |
1294 | =item $term->cmd_parse ($octets) |
1208 | |
1295 | |
1209 | Similar to C<scr_add_lines>, but the argument must be in the |
1296 | Similar to C<scr_add_lines>, but the argument must be in the |
1210 | locale-specific encoding of the terminal and can contain command sequences |
1297 | locale-specific encoding of the terminal and can contain command sequences |
1211 | (escape codes) that will be interpreted. |
1298 | (escape codes) that will be interpreted. |
… | |
… | |
1294 | =item $modifiermask = $term->ModNumLockMask |
1381 | =item $modifiermask = $term->ModNumLockMask |
1295 | |
1382 | |
1296 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1383 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1297 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1384 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1298 | |
1385 | |
|
|
1386 | =item $screen = $term->current_screen |
|
|
1387 | |
|
|
1388 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1389 | |
|
|
1390 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1391 | |
|
|
1392 | Returns wether the cursor is currently hidden or not. |
|
|
1393 | |
1299 | =item $view_start = $term->view_start ([$newvalue]) |
1394 | =item $view_start = $term->view_start ([$newvalue]) |
1300 | |
1395 | |
1301 | Returns the row number of the topmost displayed line. Maximum value is |
1396 | Returns the row number of the topmost displayed line. Maximum value is |
1302 | C<0>, which displays the normal terminal contents. Lower values scroll |
1397 | C<0>, which displays the normal terminal contents. Lower values scroll |
1303 | this many lines into the scrollback buffer. |
1398 | this many lines into the scrollback buffer. |
… | |
… | |
1321 | If C<$new_text> is specified, it will replace characters in the current |
1416 | If C<$new_text> is specified, it will replace characters in the current |
1322 | line, starting at column C<$start_col> (default C<0>), which is useful |
1417 | line, starting at column C<$start_col> (default C<0>), which is useful |
1323 | to replace only parts of a line. The font index in the rendition will |
1418 | to replace only parts of a line. The font index in the rendition will |
1324 | automatically be updated. |
1419 | automatically be updated. |
1325 | |
1420 | |
1326 | C<$text> is in a special encoding: tabs and wide characters that use more |
1421 | C<$text> is in a special encoding: tabs and wide characters that use |
1327 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1422 | more than one cell when displayed are padded with C<$urxvt::NOCHAR> |
1328 | (C<chr 65535>). Characters with combining characters and other characters |
1423 | characters. Characters with combining characters and other characters that |
1329 | that do not fit into the normal tetx encoding will be replaced with |
1424 | do not fit into the normal tetx encoding will be replaced with characters |
1330 | characters in the private use area. |
1425 | in the private use area. |
1331 | |
1426 | |
1332 | You have to obey this encoding when changing text. The advantage is |
1427 | You have to obey this encoding when changing text. The advantage is |
1333 | that C<substr> and similar functions work on screen cells and not on |
1428 | that C<substr> and similar functions work on screen cells and not on |
1334 | characters. |
1429 | characters. |
1335 | |
1430 | |
… | |
… | |
1509 | =item $term->ungrab |
1604 | =item $term->ungrab |
1510 | |
1605 | |
1511 | Calls XUngrab for the most recent grab. Is called automatically on |
1606 | Calls XUngrab for the most recent grab. Is called automatically on |
1512 | evaluation errors, as it is better to lose the grab in the error case as |
1607 | evaluation errors, as it is better to lose the grab in the error case as |
1513 | the session. |
1608 | the session. |
|
|
1609 | |
|
|
1610 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1611 | |
|
|
1612 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1613 | |
|
|
1614 | =item @atoms = $term->XListProperties ($window) |
|
|
1615 | |
|
|
1616 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1617 | |
|
|
1618 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1619 | |
|
|
1620 | =item $term->XDeleteProperty ($window, $property) |
|
|
1621 | |
|
|
1622 | =item $window = $term->DefaultRootWindow |
|
|
1623 | |
|
|
1624 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1625 | |
|
|
1626 | =item $term->XMapWindow ($window) |
|
|
1627 | |
|
|
1628 | =item $term->XUnmapWindow ($window) |
|
|
1629 | |
|
|
1630 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1631 | |
|
|
1632 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1633 | |
|
|
1634 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1635 | |
|
|
1636 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1637 | the source of the display, otherwise those functions map more-or-less |
|
|
1638 | directory onto the X functions of the same name. |
1514 | |
1639 | |
1515 | =back |
1640 | =back |
1516 | |
1641 | |
1517 | =cut |
1642 | =cut |
1518 | |
1643 | |
… | |
… | |
1638 | delete $self->{term}{_destroy}{$self}; |
1763 | delete $self->{term}{_destroy}{$self}; |
1639 | $self->{term}->ungrab; |
1764 | $self->{term}->ungrab; |
1640 | } |
1765 | } |
1641 | |
1766 | |
1642 | =back |
1767 | =back |
|
|
1768 | |
|
|
1769 | =cut |
|
|
1770 | |
|
|
1771 | package urxvt::watcher; |
|
|
1772 | |
|
|
1773 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1774 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1775 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1776 | @urxvt::iw::ISA = __PACKAGE__; |
1643 | |
1777 | |
1644 | =head2 The C<urxvt::timer> Class |
1778 | =head2 The C<urxvt::timer> Class |
1645 | |
1779 | |
1646 | This class implements timer watchers/events. Time is represented as a |
1780 | This class implements timer watchers/events. Time is represented as a |
1647 | fractional number of seconds since the epoch. Example: |
1781 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1745 | |
1879 | |
1746 | Stop watching for events on the given filehandle. |
1880 | Stop watching for events on the given filehandle. |
1747 | |
1881 | |
1748 | =back |
1882 | =back |
1749 | |
1883 | |
|
|
1884 | =head2 The C<urxvt::iw> Class |
|
|
1885 | |
|
|
1886 | This class implements idle watchers, that get called automatically when |
|
|
1887 | the process is idle. They should return as fast as possible, after doing |
|
|
1888 | some useful work. |
|
|
1889 | |
|
|
1890 | =over 4 |
|
|
1891 | |
|
|
1892 | =item $iw = new urxvt::iw |
|
|
1893 | |
|
|
1894 | Create a new idle watcher object in stopped state. |
|
|
1895 | |
|
|
1896 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1897 | |
|
|
1898 | Set the callback to be called when the watcher triggers. |
|
|
1899 | |
|
|
1900 | =item $timer = $timer->start |
|
|
1901 | |
|
|
1902 | Start the watcher. |
|
|
1903 | |
|
|
1904 | =item $timer = $timer->stop |
|
|
1905 | |
|
|
1906 | Stop the watcher. |
|
|
1907 | |
|
|
1908 | =back |
|
|
1909 | |
|
|
1910 | =head2 The C<urxvt::pw> Class |
|
|
1911 | |
|
|
1912 | This class implements process watchers. They create an event whenever a |
|
|
1913 | process exits, after which they stop automatically. |
|
|
1914 | |
|
|
1915 | my $pid = fork; |
|
|
1916 | ... |
|
|
1917 | $term->{pw} = urxvt::pw |
|
|
1918 | ->new |
|
|
1919 | ->start ($pid) |
|
|
1920 | ->cb (sub { |
|
|
1921 | my ($pw, $exit_status) = @_; |
|
|
1922 | ... |
|
|
1923 | }); |
|
|
1924 | |
|
|
1925 | =over 4 |
|
|
1926 | |
|
|
1927 | =item $pw = new urxvt::pw |
|
|
1928 | |
|
|
1929 | Create a new process watcher in stopped state. |
|
|
1930 | |
|
|
1931 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1932 | |
|
|
1933 | Set the callback to be called when the timer triggers. |
|
|
1934 | |
|
|
1935 | =item $pw = $timer->start ($pid) |
|
|
1936 | |
|
|
1937 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1938 | |
|
|
1939 | =item $pw = $pw->stop |
|
|
1940 | |
|
|
1941 | Stop the watcher. |
|
|
1942 | |
|
|
1943 | =back |
|
|
1944 | |
1750 | =head1 ENVIRONMENT |
1945 | =head1 ENVIRONMENT |
1751 | |
1946 | |
1752 | =head2 URXVT_PERL_VERBOSITY |
1947 | =head2 URXVT_PERL_VERBOSITY |
1753 | |
1948 | |
1754 | This variable controls the verbosity level of the perl extension. Higher |
1949 | This variable controls the verbosity level of the perl extension. Higher |