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.105 by root, Wed Jan 18 19:43:51 2006 UTC vs.
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC

34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
87 91
88=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
89 93
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 96evaluation, web-browser starting etc.), depending on content.
93 97
94Other extensions can extend this popup menu by pushing a code reference onto 98Other extensions can extend this popup menu by pushing a code reference
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. 99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
96 101
97It's sole argument is the popup menu, which can be modified. The selection 102It's sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not. 103is in C<$_>, which can be used to decide wether to add something or not.
99It should either return nothing or a string and a code reference. The 104It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called 105string will be used as button text and the code reference will be called
102 107
103The following will add an entry C<a to b> that transforms all C<a>s in 108The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any 109the selection to C<b>s, but only if the selection currently contains any
105C<a>s: 110C<a>s:
106 111
107 push urxvt::ext::selection_popup::hook, sub { 112 push @{ $self->{term}{selection_popup_hook} }, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g } 113 /a/ ? ("a to be" => sub { s/a/b/g }
109 : () 114 : ()
110 }; 115 };
111 116
112=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144 149
145And this example matches the same,but replaces it with vi-commands you can 150And this example matches the same,but replaces it with vi-commands you can
146paste directly into your (vi :) editor: 151paste directly into your (vi :) editor:
147 152
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149 154
150Of course, this can be modified to suit your needs and your editor :) 155Of course, this can be modified to suit your needs and your editor :)
151 156
152To expand the example above to typical perl error messages ("XXX at 157To expand the example above to typical perl error messages ("XXX at
153FILENAME line YYY."), you need a slightly more elaborate solution: 158FILENAME line YYY."), you need a slightly more elaborate solution:
154 159
155 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157 162
158The first line tells the selection code to treat the unchanging part of 163The first line tells the selection code to treat the unchanging part of
159every error message as a selection pattern, and the second line transforms 164every error message as a selection pattern, and the second line transforms
160the message into vi commands to load the file. 165the message into vi commands to load the file.
166
167=item readline
168
169A support package that tries to make editing with readline easier. At the
170moment, it reacts to clicking with the left mouse button by trying to
171move the text cursor to this position. It does so by generating as many
172cursor-left or cursor-right keypresses as required (the this only works
173for programs that correctly support wide characters).
174
175It only works when clicking into the same line (possibly extended over
176multiple rows) as the text cursor and on the primary screen, to reduce the
177risk of misinterpreting. The normal selection isn't disabled, so quick
178successive clicks might interfere with selection creation in harmless
179ways.
180
181=item tabbed
182
183This transforms the terminal into a tabbar with additional terminals, that
184is, it implements what is commonly refered to as "tabbed terminal". The topmost line
185displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
186button per tab.
187
188Clicking a button will activate that tab. Pressing B<Shift-Left> and
189B<Shift-Right> will switch to the tab left or right of the current one,
190while B<Shift-Down> creates a new tab.
161 191
162=item mark-urls 192=item mark-urls
163 193
164Uses per-line display filtering (C<on_line_update>) to underline urls and 194Uses per-line display filtering (C<on_line_update>) to underline urls and
165make them clickable. When middle-clicked, the program specified in the 195make them clickable. When middle-clicked, the program specified in the
298called whenever the relevant event happens. 328called whenever the relevant event happens.
299 329
300The first argument passed to them is an extension oject as described in 330The first argument passed to them is an extension oject as described in
301the in the C<Extension Objects> section. 331the in the C<Extension Objects> section.
302 332
303B<All> of these hooks must return a boolean value. If it is true, then the 333B<All> of these hooks must return a boolean value. If any of the called
304event counts as being I<consumed>, and the invocation of other hooks is 334hooks returns true, then the event counts as being I<consumed>, and the
305skipped, and the relevant action might not be carried out by the C++ code. 335relevant action might not be carried out by the C++ code.
306 336
307I<< When in doubt, return a false value (preferably C<()>). >> 337I<< When in doubt, return a false value (preferably C<()>). >>
308 338
309=over 4 339=over 4
310 340
311=item on_init $term 341=item on_init $term
312 342
313Called after a new terminal object has been initialized, but before 343Called after a new terminal object has been initialized, but before
314windows are created or the command gets run. Most methods are unsafe to 344windows are created or the command gets run. Most methods are unsafe to
315call or deliver senseless data, as terminal size and other characteristics 345call or deliver senseless data, as terminal size and other characteristics
316have not yet been determined. You can safely query and change resources, 346have not yet been determined. You can safely query and change resources
317though. 347and options, though. For many purposes the C<on_start> hook is a better
348place.
349
350=item on_start $term
351
352Called at the very end of initialisation of a new terminal, just before
353trying to map (display) the toplevel and returning to the mainloop.
354
355=item on_destroy $term
356
357Called whenever something tries to destroy terminal, before doing anything
358yet. If this hook returns true, then destruction is skipped, but this is
359rarely a good idea.
318 360
319=item on_reset $term 361=item on_reset $term
320 362
321Called after the screen is "reset" for any reason, such as resizing or 363Called after the screen is "reset" for any reason, such as resizing or
322control sequences. Here is where you can react on changes to size-related 364control sequences. Here is where you can react on changes to size-related
323variables. 365variables.
324 366
325=item on_start $term 367=item on_child_start $term, $pid
326 368
327Called at the very end of initialisation of a new terminal, just before 369Called just after the child process has been C<fork>ed.
328returning to the mainloop. 370
371=item on_child_exit $term, $status
372
373Called just after the child process has exited. C<$status> is the status
374from C<waitpid>.
329 375
330=item on_sel_make $term, $eventtime 376=item on_sel_make $term, $eventtime
331 377
332Called whenever a selection has been made by the user, but before the 378Called whenever a selection has been made by the user, but before the
333selection text is copied, so changes to the beginning, end or type of the 379selection text is copied, so changes to the beginning, end or type of the
444Called wheneever the window loses keyboard focus, before rxvt-unicode does 490Called wheneever the window loses keyboard focus, before rxvt-unicode does
445focus out processing. 491focus out processing.
446 492
447=item on_configure_notify $term, $event 493=item on_configure_notify $term, $event
448 494
495=item on_property_notify $term, $event
496
449=item on_key_press $term, $event, $keysym, $octets 497=item on_key_press $term, $event, $keysym, $octets
450 498
451=item on_key_release $term, $event, $keysym 499=item on_key_release $term, $event, $keysym
452 500
453=item on_button_press $term, $event 501=item on_button_press $term, $event
462 510
463Called whenever the corresponding X event is received for the terminal If 511Called whenever the corresponding X event is received for the terminal If
464the hook returns true, then the even will be ignored by rxvt-unicode. 512the hook returns true, then the even will be ignored by rxvt-unicode.
465 513
466The event is a hash with most values as named by Xlib (see the XEvent 514The event is a hash with most values as named by Xlib (see the XEvent
467manpage), with the additional members C<row> and C<col>, which are the row 515manpage), with the additional members C<row> and C<col>, which are the
468and column under the mouse cursor. 516(real, not screen-based) row and column under the mouse cursor.
469 517
470C<on_key_press> additionally receives the string rxvt-unicode would 518C<on_key_press> additionally receives the string rxvt-unicode would
471output, if any, in locale-specific encoding. 519output, if any, in locale-specific encoding.
472 520
473subwindow. 521subwindow.
522
523=item on_client_message $term, $event
524
525=item on_wm_protocols $term, $event
526
527=item on_wm_delete_window $term, $event
528
529Called when various types of ClientMessage events are received (all with
530format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
474 531
475=back 532=back
476 533
477=cut 534=cut
478 535
484use Scalar::Util (); 541use Scalar::Util ();
485use List::Util (); 542use List::Util ();
486 543
487our $VERSION = 1; 544our $VERSION = 1;
488our $TERM; 545our $TERM;
546our @TERM_INIT;
547our @TERM_EXT;
489our @HOOKNAME; 548our @HOOKNAME;
490our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 549our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491our %OPTION; 550our %OPTION;
492 551
493our $LIBDIR; 552our $LIBDIR;
494our $RESNAME; 553our $RESNAME;
495our $RESCLASS; 554our $RESCLASS;
496our $RXVTNAME; 555our $RXVTNAME;
497 556
557our $NOCHAR = chr 0xfffe;
558
498=head2 Variables in the C<urxvt> Package 559=head2 Variables in the C<urxvt> Package
499 560
500=over 4 561=over 4
501 562
502=item $urxvt::LIBDIR 563=item $urxvt::LIBDIR
514 575
515=item $urxvt::TERM 576=item $urxvt::TERM
516 577
517The current terminal. This variable stores the current C<urxvt::term> 578The current terminal. This variable stores the current C<urxvt::term>
518object, whenever a callback/hook is executing. 579object, whenever a callback/hook is executing.
580
581=item @urxvt::TERM_INIT
582
583All coderefs in this array will be called as methods of the next newly
584created C<urxvt::term> object (during the C<on_init> phase). The array
585gets cleared before the codereferences that were in it are being executed,
586so coderefs can push themselves onto it again if they so desire.
587
588This complements to the perl-eval commandline option, but gets executed
589first.
590
591=item @urxvt::TERM_EXT
592
593Works similar to C<@TERM_INIT>, but contains perl package/class names, which
594get registered as normal extensions after calling the hooks in C<@TERM_INIT>
595but before other extensions. Gets cleared just like C<@TERM_INIT>.
519 596
520=back 597=back
521 598
522=head2 Functions in the C<urxvt> Package 599=head2 Functions in the C<urxvt> Package
523 600
630 my $msg = join "", @_; 707 my $msg = join "", @_;
631 $msg .= "\n" 708 $msg .= "\n"
632 unless $msg =~ /\n$/; 709 unless $msg =~ /\n$/;
633 urxvt::warn ($msg); 710 urxvt::warn ($msg);
634 }; 711 };
635
636 # %ENV is the original startup environment
637 delete $ENV{IFS};
638 delete $ENV{CDPATH};
639 delete $ENV{BASH_ENV};
640 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
641} 712}
642 713
643my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 714my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
644 715
645sub verbose { 716sub verbose {
650my %extension_pkg; 721my %extension_pkg;
651 722
652# load a single script into its own package, once only 723# load a single script into its own package, once only
653sub extension_package($) { 724sub extension_package($) {
654 my ($path) = @_; 725 my ($path) = @_;
655
656 no strict 'refs';
657 726
658 $extension_pkg{$path} ||= do { 727 $extension_pkg{$path} ||= do {
659 $path =~ /([^\/\\]+)$/; 728 $path =~ /([^\/\\]+)$/;
660 my $pkg = $1; 729 my $pkg = $1;
661 $pkg =~ s/[^[:word:]]/_/g; 730 $pkg =~ s/[^[:word:]]/_/g;
664 verbose 3, "loading extension '$path' into package '$pkg'"; 733 verbose 3, "loading extension '$path' into package '$pkg'";
665 734
666 open my $fh, "<:raw", $path 735 open my $fh, "<:raw", $path
667 or die "$path: $!"; 736 or die "$path: $!";
668 737
669 @{"$pkg\::ISA"} = urxvt::term::extension::;
670
671 my $source = 738 my $source =
672 "package $pkg; use strict; use utf8;\n" 739 "package $pkg; use strict; use utf8;\n"
673 . "#line 1 \"$path\"\n{\n" 740 . "#line 1 \"$path\"\n{\n"
674 . (do { local $/; <$fh> }) 741 . (do { local $/; <$fh> })
675 . "\n};\n1"; 742 . "\n};\n1";
691 if ($htype == 0) { # INIT 758 if ($htype == 0) { # INIT
692 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 759 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
693 760
694 my %ext_arg; 761 my %ext_arg;
695 762
763 {
764 my @init = @TERM_INIT;
765 @TERM_INIT = ();
766 $_->($TERM) for @init;
767 my @pkg = @TERM_EXT;
768 @TERM_EXT = ();
769 $TERM->register_package ($_) for @pkg;
770 }
771
696 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 772 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
697 if ($_ eq "default") { 773 if ($_ eq "default") {
698 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 774 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
699 } elsif (/^-(.*)$/) { 775 } elsif (/^-(.*)$/) {
700 delete $ext_arg{$1}; 776 delete $ext_arg{$1};
701 } elsif (/^([^<]+)<(.*)>$/) { 777 } elsif (/^([^<]+)<(.*)>$/) {
726 if $verbosity >= 10; 802 if $verbosity >= 10;
727 803
728 keys %$cb; 804 keys %$cb;
729 805
730 while (my ($pkg, $cb) = each %$cb) { 806 while (my ($pkg, $cb) = each %$cb) {
731 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 807 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
732 and last; 808 $retval ||= $retval_;
733 809
734 if ($@) { 810 if ($@) {
735 $TERM->ungrab; # better to lose the grab than the session 811 $TERM->ungrab; # better to lose the grab than the session
736 warn $@; 812 warn $@;
737 } 813 }
748 # clear package 824 # clear package
749 %$TERM = (); 825 %$TERM = ();
750 } 826 }
751 827
752 $retval 828 $retval
753}
754
755sub exec_async(@) {
756 my $pid = fork;
757
758 return
759 if !defined $pid or $pid;
760
761 %ENV = %{ $TERM->env };
762
763 exec @_;
764 _exit 255;
765} 829}
766 830
767# urxvt::term::extension 831# urxvt::term::extension
768 832
769package urxvt::term::extension; 833package urxvt::term::extension;
908# find on_xxx subs in the package and register them 972# find on_xxx subs in the package and register them
909# as hooks 973# as hooks
910sub register_package { 974sub register_package {
911 my ($self, $pkg, $argv) = @_; 975 my ($self, $pkg, $argv) = @_;
912 976
977 no strict 'refs';
978
979 urxvt::verbose 6, "register package $pkg to $self";
980
981 @{"$pkg\::ISA"} = urxvt::term::extension::;
982
913 my $proxy = bless { 983 my $proxy = bless {
914 _pkg => $pkg, 984 _pkg => $pkg,
915 argv => $argv, 985 argv => $argv,
916 }, $pkg; 986 }, $pkg;
917 Scalar::Util::weaken ($proxy->{term} = $self); 987 Scalar::Util::weaken ($proxy->{term} = $self);
947=item $term->destroy 1017=item $term->destroy
948 1018
949Destroy the terminal object (close the window, free resources 1019Destroy the terminal object (close the window, free resources
950etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1020etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
951watchers (timers, io watchers) are still active. 1021watchers (timers, io watchers) are still active.
1022
1023=item $term->exec_async ($cmd[, @args])
1024
1025Works like the combination of the C<fork>/C<exec> builtins, which executes
1026("starts") programs in the background. This function takes care of setting
1027the user environment before exec'ing the command (e.g. C<PATH>) and should
1028be preferred over explicit calls to C<exec> or C<system>.
1029
1030Returns the pid of the subprocess or C<undef> on error.
1031
1032=cut
1033
1034sub exec_async {
1035 my $self = shift;
1036
1037 my $pid = fork;
1038
1039 return $pid
1040 if !defined $pid or $pid;
1041
1042 %ENV = %{ $self->env };
1043
1044 exec @_;
1045 urxvt::_exit 255;
1046}
952 1047
953=item $isset = $term->option ($optval[, $set]) 1048=item $isset = $term->option ($optval[, $set])
954 1049
955Returns true if the option specified by C<$optval> is enabled, and 1050Returns true if the option specified by C<$optval> is enabled, and
956optionally change it. All option values are stored by name in the hash 1051optionally change it. All option values are stored by name in the hash
1181 1276
1182Normally its not a good idea to use this function, as programs might be 1277Normally its not a good idea to use this function, as programs might be
1183confused by changes in cursor position or scrolling. Its useful inside a 1278confused by changes in cursor position or scrolling. Its useful inside a
1184C<on_add_lines> hook, though. 1279C<on_add_lines> hook, though.
1185 1280
1281=item $term->scr_change_screen ($screen)
1282
1283Switch to given screen - 0 primary, 1 secondary.
1284
1186=item $term->cmd_parse ($octets) 1285=item $term->cmd_parse ($octets)
1187 1286
1188Similar to C<scr_add_lines>, but the argument must be in the 1287Similar to C<scr_add_lines>, but the argument must be in the
1189locale-specific encoding of the terminal and can contain command sequences 1288locale-specific encoding of the terminal and can contain command sequences
1190(escape codes) that will be interpreted. 1289(escape codes) that will be interpreted.
1273=item $modifiermask = $term->ModNumLockMask 1372=item $modifiermask = $term->ModNumLockMask
1274 1373
1275Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1374Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1276AltGr), the meta key (often Alt) and the num lock key, if applicable. 1375AltGr), the meta key (often Alt) and the num lock key, if applicable.
1277 1376
1377=item $screen = $term->current_screen
1378
1379Returns the currently displayed screen (0 primary, 1 secondary).
1380
1278=item $view_start = $term->view_start ([$newvalue]) 1381=item $view_start = $term->view_start ([$newvalue])
1279 1382
1280Returns the row number of the topmost displayed line. Maximum value is 1383Returns the row number of the topmost displayed line. Maximum value is
1281C<0>, which displays the normal terminal contents. Lower values scroll 1384C<0>, which displays the normal terminal contents. Lower values scroll
1282this many lines into the scrollback buffer. 1385this many lines into the scrollback buffer.
1300If C<$new_text> is specified, it will replace characters in the current 1403If C<$new_text> is specified, it will replace characters in the current
1301line, starting at column C<$start_col> (default C<0>), which is useful 1404line, starting at column C<$start_col> (default C<0>), which is useful
1302to replace only parts of a line. The font index in the rendition will 1405to replace only parts of a line. The font index in the rendition will
1303automatically be updated. 1406automatically be updated.
1304 1407
1305C<$text> is in a special encoding: tabs and wide characters that use more 1408C<$text> is in a special encoding: tabs and wide characters that use
1306than one cell when displayed are padded with urxvt::NOCHAR characters 1409more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1307(C<chr 65535>). Characters with combining characters and other characters 1410characters. Characters with combining characters and other characters that
1308that do not fit into the normal tetx encoding will be replaced with 1411do not fit into the normal tetx encoding will be replaced with characters
1309characters in the private use area. 1412in the private use area.
1310 1413
1311You have to obey this encoding when changing text. The advantage is 1414You have to obey this encoding when changing text. The advantage is
1312that C<substr> and similar functions work on screen cells and not on 1415that C<substr> and similar functions work on screen cells and not on
1313characters. 1416characters.
1314 1417
1489 1592
1490Calls XUngrab for the most recent grab. Is called automatically on 1593Calls XUngrab for the most recent grab. Is called automatically on
1491evaluation errors, as it is better to lose the grab in the error case as 1594evaluation errors, as it is better to lose the grab in the error case as
1492the session. 1595the session.
1493 1596
1597=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1598
1599=item $atom_name = $term->XGetAtomName ($atom)
1600
1601=item @atoms = $term->XListProperties ($window)
1602
1603=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1604
1605=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1606
1607=item $term->XDeleteProperty ($window, $property)
1608
1609=item $window = $term->DefaultRootWindow
1610
1611=item $term->XReparentWindow ($window, $parent, [$x, $y])
1612
1613=item $term->XMapWindow ($window)
1614
1615=item $term->XUnmapWindow ($window)
1616
1617=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1618
1619=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1620
1621=item $term->XChangeInput ($window, $add_events[, $del_events])
1622
1623Various X or X-related functions. The C<$term> object only serves as
1624the source of the display, otherwise those functions map more-or-less
1625directory onto the X functions of the same name.
1626
1494=back 1627=back
1495 1628
1496=cut 1629=cut
1497 1630
1498package urxvt::popup; 1631package urxvt::popup;
1601 delete $env->{LC_ALL}; 1734 delete $env->{LC_ALL};
1602 $env->{LC_CTYPE} = $self->{term}->locale; 1735 $env->{LC_CTYPE} = $self->{term}->locale;
1603 1736
1604 urxvt::term->new ($env, "popup", 1737 urxvt::term->new ($env, "popup",
1605 "--perl-lib" => "", "--perl-ext-common" => "", 1738 "--perl-lib" => "", "--perl-ext-common" => "",
1739 "-pty-fd" => -1, "-sl" => 0,
1606 "-pty-fd" => -1, "-sl" => 0, "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1740 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1607 "--transient-for" => $self->{term}->parent, 1741 "--transient-for" => $self->{term}->parent,
1608 "-display" => $self->{term}->display_id, 1742 "-display" => $self->{term}->display_id,
1609 "-pe" => "urxvt-popup") 1743 "-pe" => "urxvt-popup")
1610 or die "unable to create popup window\n"; 1744 or die "unable to create popup window\n";
1611} 1745}
1616 delete $self->{term}{_destroy}{$self}; 1750 delete $self->{term}{_destroy}{$self};
1617 $self->{term}->ungrab; 1751 $self->{term}->ungrab;
1618} 1752}
1619 1753
1620=back 1754=back
1755
1756=cut
1757
1758package urxvt::watcher;
1759
1760@urxvt::timer::ISA = __PACKAGE__;
1761@urxvt::iow::ISA = __PACKAGE__;
1762@urxvt::pw::ISA = __PACKAGE__;
1763@urxvt::iw::ISA = __PACKAGE__;
1621 1764
1622=head2 The C<urxvt::timer> Class 1765=head2 The C<urxvt::timer> Class
1623 1766
1624This class implements timer watchers/events. Time is represented as a 1767This class implements timer watchers/events. Time is represented as a
1625fractional number of seconds since the epoch. Example: 1768fractional number of seconds since the epoch. Example:
1723 1866
1724Stop watching for events on the given filehandle. 1867Stop watching for events on the given filehandle.
1725 1868
1726=back 1869=back
1727 1870
1871=head2 The C<urxvt::iw> Class
1872
1873This class implements idle watchers, that get called automatically when
1874the process is idle. They should return as fast as possible, after doing
1875some useful work.
1876
1877=over 4
1878
1879=item $iw = new urxvt::iw
1880
1881Create a new idle watcher object in stopped state.
1882
1883=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1884
1885Set the callback to be called when the watcher triggers.
1886
1887=item $timer = $timer->start
1888
1889Start the watcher.
1890
1891=item $timer = $timer->stop
1892
1893Stop the watcher.
1894
1895=back
1896
1897=head2 The C<urxvt::pw> Class
1898
1899This class implements process watchers. They create an event whenever a
1900process exits, after which they stop automatically.
1901
1902 my $pid = fork;
1903 ...
1904 $term->{pw} = urxvt::pw
1905 ->new
1906 ->start ($pid)
1907 ->cb (sub {
1908 my ($pw, $exit_status) = @_;
1909 ...
1910 });
1911
1912=over 4
1913
1914=item $pw = new urxvt::pw
1915
1916Create a new process watcher in stopped state.
1917
1918=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1919
1920Set the callback to be called when the timer triggers.
1921
1922=item $pw = $timer->start ($pid)
1923
1924Tells the wqtcher to start watching for process C<$pid>.
1925
1926=item $pw = $pw->stop
1927
1928Stop the watcher.
1929
1930=back
1931
1728=head1 ENVIRONMENT 1932=head1 ENVIRONMENT
1729 1933
1730=head2 URXVT_PERL_VERBOSITY 1934=head2 URXVT_PERL_VERBOSITY
1731 1935
1732This variable controls the verbosity level of the perl extension. Higher 1936This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines