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.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.120 by root, Fri Jan 20 22:05:41 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 tabbed
168
169This transforms the terminal into a tabbar with additional terminals, that
170is, it implements what is commonly refered to as "tabbed terminal". The topmost line
171displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
172button per tab.
173
174Clicking a button will activate that tab. Pressing B<Shift-Left> and
175B<Shift-Right> will switch to the tab left or right of the current one,
176while B<Shift-Down> creates a new tab.
161 177
162=item mark-urls 178=item mark-urls
163 179
164Uses per-line display filtering (C<on_line_update>) to underline urls and 180Uses per-line display filtering (C<on_line_update>) to underline urls and
165make them clickable. When middle-clicked, the program specified in the 181make them clickable. When middle-clicked, the program specified in the
166resource C<urlLauncher> (default C<x-www-browser>) will be started with 182resource C<urlLauncher> (default C<x-www-browser>) will be started with
167the URL as first argument. 183the URL as first argument.
184
185=item automove-background
186
187This is basically a one-line extension that dynamically changes the background pixmap offset
188to the window position, in effect creating the same effect as pseudo transparency with
189a custom pixmap. No scaling is supported in this mode. Exmaple:
190
191 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
168 192
169=item block-graphics-to-ascii 193=item block-graphics-to-ascii
170 194
171A not very useful example of filtering all text output to the terminal, 195A not very useful example of filtering all text output to the terminal,
172by replacing all line-drawing characters (U+2500 .. U+259F) by a 196by replacing all line-drawing characters (U+2500 .. U+259F) by a
290called whenever the relevant event happens. 314called whenever the relevant event happens.
291 315
292The first argument passed to them is an extension oject as described in 316The first argument passed to them is an extension oject as described in
293the in the C<Extension Objects> section. 317the in the C<Extension Objects> section.
294 318
295B<All> of these hooks must return a boolean value. If it is true, then the 319B<All> of these hooks must return a boolean value. If any of the called
296event counts as being I<consumed>, and the invocation of other hooks is 320hooks returns true, then the event counts as being I<consumed>, and the
297skipped, and the relevant action might not be carried out by the C++ code. 321relevant action might not be carried out by the C++ code.
298 322
299I<< When in doubt, return a false value (preferably C<()>). >> 323I<< When in doubt, return a false value (preferably C<()>). >>
300 324
301=over 4 325=over 4
302 326
303=item on_init $term 327=item on_init $term
304 328
305Called after a new terminal object has been initialized, but before 329Called after a new terminal object has been initialized, but before
306windows are created or the command gets run. Most methods are unsafe to 330windows are created or the command gets run. Most methods are unsafe to
307call or deliver senseless data, as terminal size and other characteristics 331call or deliver senseless data, as terminal size and other characteristics
308have not yet been determined. You can safely query and change resources, 332have not yet been determined. You can safely query and change resources
309though. 333and options, though. For many purposes the C<on_start> hook is a better
334place.
335
336=item on_start $term
337
338Called at the very end of initialisation of a new terminal, just before
339trying to map (display) the toplevel and returning to the mainloop.
340
341=item on_destroy $term
342
343Called whenever something tries to destroy terminal, before doing anything
344yet. If this hook returns true, then destruction is skipped, but this is
345rarely a good idea.
310 346
311=item on_reset $term 347=item on_reset $term
312 348
313Called after the screen is "reset" for any reason, such as resizing or 349Called after the screen is "reset" for any reason, such as resizing or
314control sequences. Here is where you can react on changes to size-related 350control sequences. Here is where you can react on changes to size-related
315variables. 351variables.
316 352
317=item on_start $term 353=item on_child_start $term, $pid
318 354
319Called at the very end of initialisation of a new terminal, just before 355Called just after the child process has been C<fork>ed.
320returning to the mainloop. 356
357=item on_child_exit $term, $status
358
359Called just after the child process has exited. C<$status> is the status
360from C<waitpid>.
321 361
322=item on_sel_make $term, $eventtime 362=item on_sel_make $term, $eventtime
323 363
324Called whenever a selection has been made by the user, but before the 364Called whenever a selection has been made by the user, but before the
325selection text is copied, so changes to the beginning, end or type of the 365selection text is copied, so changes to the beginning, end or type of the
434=item on_focus_out $term 474=item on_focus_out $term
435 475
436Called wheneever the window loses keyboard focus, before rxvt-unicode does 476Called wheneever the window loses keyboard focus, before rxvt-unicode does
437focus out processing. 477focus out processing.
438 478
479=item on_configure_notify $term, $event
480
481=item on_property_notify $term, $event
482
439=item on_key_press $term, $event, $keysym, $octets 483=item on_key_press $term, $event, $keysym, $octets
440 484
441=item on_key_release $term, $event, $keysym 485=item on_key_release $term, $event, $keysym
442 486
443=item on_button_press $term, $event 487=item on_button_press $term, $event
452 496
453Called whenever the corresponding X event is received for the terminal If 497Called whenever the corresponding X event is received for the terminal If
454the hook returns true, then the even will be ignored by rxvt-unicode. 498the hook returns true, then the even will be ignored by rxvt-unicode.
455 499
456The event is a hash with most values as named by Xlib (see the XEvent 500The event is a hash with most values as named by Xlib (see the XEvent
457manpage), with the additional members C<row> and C<col>, which are the row 501manpage), with the additional members C<row> and C<col>, which are the
458and column under the mouse cursor. 502(real, not screen-based) row and column under the mouse cursor.
459 503
460C<on_key_press> additionally receives the string rxvt-unicode would 504C<on_key_press> additionally receives the string rxvt-unicode would
461output, if any, in locale-specific encoding. 505output, if any, in locale-specific encoding.
462 506
463subwindow. 507subwindow.
508
509=item on_client_message $term, $event
510
511=item on_wm_protocols $term, $event
512
513=item on_wm_delete_window $term, $event
514
515Called when various types of ClientMessage events are received (all with
516format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
464 517
465=back 518=back
466 519
467=cut 520=cut
468 521
474use Scalar::Util (); 527use Scalar::Util ();
475use List::Util (); 528use List::Util ();
476 529
477our $VERSION = 1; 530our $VERSION = 1;
478our $TERM; 531our $TERM;
532our @TERM_INIT;
533our @TERM_EXT;
479our @HOOKNAME; 534our @HOOKNAME;
480our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 535our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
481our %OPTION; 536our %OPTION;
482 537
483our $LIBDIR; 538our $LIBDIR;
504 559
505=item $urxvt::TERM 560=item $urxvt::TERM
506 561
507The current terminal. This variable stores the current C<urxvt::term> 562The current terminal. This variable stores the current C<urxvt::term>
508object, whenever a callback/hook is executing. 563object, whenever a callback/hook is executing.
564
565=item @urxvt::TERM_INIT
566
567All coderefs in this array will be called as methods of the next newly
568created C<urxvt::term> object (during the C<on_init> phase). The array
569gets cleared before the codereferences that were in it are being executed,
570so coderefs can push themselves onto it again if they so desire.
571
572This complements to the perl-eval commandline option, but gets executed
573first.
574
575=item @urxvt::TERM_EXT
576
577Works similar to C<@TERM_INIT>, but contains perl package/class names, which
578get registered as normal extensions after calling the hooks in C<@TERM_INIT>
579but before other extensions. Gets cleared just like C<@TERM_INIT>.
509 580
510=back 581=back
511 582
512=head2 Functions in the C<urxvt> Package 583=head2 Functions in the C<urxvt> Package
513 584
620 my $msg = join "", @_; 691 my $msg = join "", @_;
621 $msg .= "\n" 692 $msg .= "\n"
622 unless $msg =~ /\n$/; 693 unless $msg =~ /\n$/;
623 urxvt::warn ($msg); 694 urxvt::warn ($msg);
624 }; 695 };
625
626 # %ENV is the original startup environment
627 delete $ENV{IFS};
628 delete $ENV{CDPATH};
629 delete $ENV{BASH_ENV};
630 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
631} 696}
632 697
633my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 698my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
634 699
635sub verbose { 700sub verbose {
640my %extension_pkg; 705my %extension_pkg;
641 706
642# load a single script into its own package, once only 707# load a single script into its own package, once only
643sub extension_package($) { 708sub extension_package($) {
644 my ($path) = @_; 709 my ($path) = @_;
645
646 no strict 'refs';
647 710
648 $extension_pkg{$path} ||= do { 711 $extension_pkg{$path} ||= do {
649 $path =~ /([^\/\\]+)$/; 712 $path =~ /([^\/\\]+)$/;
650 my $pkg = $1; 713 my $pkg = $1;
651 $pkg =~ s/[^[:word:]]/_/g; 714 $pkg =~ s/[^[:word:]]/_/g;
654 verbose 3, "loading extension '$path' into package '$pkg'"; 717 verbose 3, "loading extension '$path' into package '$pkg'";
655 718
656 open my $fh, "<:raw", $path 719 open my $fh, "<:raw", $path
657 or die "$path: $!"; 720 or die "$path: $!";
658 721
659 @{"$pkg\::ISA"} = urxvt::term::extension::;
660
661 my $source = 722 my $source =
662 "package $pkg; use strict; use utf8;\n" 723 "package $pkg; use strict; use utf8;\n"
663 . "#line 1 \"$path\"\n{\n" 724 . "#line 1 \"$path\"\n{\n"
664 . (do { local $/; <$fh> }) 725 . (do { local $/; <$fh> })
665 . "\n};\n1"; 726 . "\n};\n1";
681 if ($htype == 0) { # INIT 742 if ($htype == 0) { # INIT
682 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 743 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
683 744
684 my %ext_arg; 745 my %ext_arg;
685 746
747 {
748 my @init = @TERM_INIT;
749 @TERM_INIT = ();
750 $_->($TERM) for @init;
751 my @pkg = @TERM_EXT;
752 @TERM_EXT = ();
753 $TERM->register_package ($_) for @pkg;
754 }
755
686 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 756 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
687 if ($_ eq "default") { 757 if ($_ eq "default") {
688 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 758 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
689 } elsif (/^-(.*)$/) { 759 } elsif (/^-(.*)$/) {
690 delete $ext_arg{$1}; 760 delete $ext_arg{$1};
691 } elsif (/^([^<]+)<(.*)>$/) { 761 } elsif (/^([^<]+)<(.*)>$/) {
716 if $verbosity >= 10; 786 if $verbosity >= 10;
717 787
718 keys %$cb; 788 keys %$cb;
719 789
720 while (my ($pkg, $cb) = each %$cb) { 790 while (my ($pkg, $cb) = each %$cb) {
721 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 791 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
722 and last; 792 $retval ||= $retval_;
723 793
724 if ($@) { 794 if ($@) {
725 $TERM->ungrab; # better to lose the grab than the session 795 $TERM->ungrab; # better to lose the grab than the session
726 warn $@; 796 warn $@;
727 } 797 }
738 # clear package 808 # clear package
739 %$TERM = (); 809 %$TERM = ();
740 } 810 }
741 811
742 $retval 812 $retval
743}
744
745sub exec_async(@) {
746 my $pid = fork;
747
748 return
749 if !defined $pid or $pid;
750
751 %ENV = %{ $TERM->env };
752
753 exec @_;
754 _exit 255;
755} 813}
756 814
757# urxvt::term::extension 815# urxvt::term::extension
758 816
759package urxvt::term::extension; 817package urxvt::term::extension;
898# find on_xxx subs in the package and register them 956# find on_xxx subs in the package and register them
899# as hooks 957# as hooks
900sub register_package { 958sub register_package {
901 my ($self, $pkg, $argv) = @_; 959 my ($self, $pkg, $argv) = @_;
902 960
961 no strict 'refs';
962
963 urxvt::verbose 6, "register package $pkg to $self";
964
965 @{"$pkg\::ISA"} = urxvt::term::extension::;
966
903 my $proxy = bless { 967 my $proxy = bless {
904 _pkg => $pkg, 968 _pkg => $pkg,
905 argv => $argv, 969 argv => $argv,
906 }, $pkg; 970 }, $pkg;
907 Scalar::Util::weaken ($proxy->{term} = $self); 971 Scalar::Util::weaken ($proxy->{term} = $self);
938 1002
939Destroy the terminal object (close the window, free resources 1003Destroy the terminal object (close the window, free resources
940etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1004etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
941watchers (timers, io watchers) are still active. 1005watchers (timers, io watchers) are still active.
942 1006
1007=item $term->exec_async ($cmd[, @args])
1008
1009Works like the combination of the C<fork>/C<exec> builtins, which executes
1010("starts") programs in the background. This function takes care of setting
1011the user environment before exec'ing the command (e.g. C<PATH>) and should
1012be preferred over explicit calls to C<exec> or C<system>.
1013
1014Returns the pid of the subprocess or C<undef> on error.
1015
1016=cut
1017
1018sub exec_async {
1019 my $self = shift;
1020
1021 my $pid = fork;
1022
1023 return $pid
1024 if !defined $pid or $pid;
1025
1026 %ENV = %{ $self->env };
1027
1028 exec @_;
1029 urxvt::_exit 255;
1030}
1031
943=item $isset = $term->option ($optval[, $set]) 1032=item $isset = $term->option ($optval[, $set])
944 1033
945Returns true if the option specified by C<$optval> is enabled, and 1034Returns true if the option specified by C<$optval> is enabled, and
946optionally change it. All option values are stored by name in the hash 1035optionally change it. All option values are stored by name in the hash
947C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1036C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
949Here is a a likely non-exhaustive list of option names, please see the 1038Here is a a likely non-exhaustive list of option names, please see the
950source file F</src/optinc.h> to see the actual list: 1039source file F</src/optinc.h> to see the actual list:
951 1040
952 borderLess console cursorBlink cursorUnderline hold iconic insecure 1041 borderLess console cursorBlink cursorUnderline hold iconic insecure
953 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1042 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
954 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1043 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
955 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1044 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
956 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1045 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
957 tripleclickwords utmpInhibit visualBell 1046 transparent tripleclickwords utmpInhibit visualBell
958 1047
959=item $value = $term->resource ($name[, $newval]) 1048=item $value = $term->resource ($name[, $newval])
960 1049
961Returns the current resource value associated with a given name and 1050Returns the current resource value associated with a given name and
962optionally sets a new value. Setting values is most useful in the C<init> 1051optionally sets a new value. Setting values is most useful in the C<init>
979 1068
980 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1069 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
981 borderLess color cursorBlink cursorUnderline cutchars delete_key 1070 borderLess color cursorBlink cursorUnderline cutchars delete_key
982 display_name embed ext_bwidth fade font geometry hold iconName 1071 display_name embed ext_bwidth fade font geometry hold iconName
983 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1072 imFont imLocale inputMethod insecure int_bwidth intensityStyles
984 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1073 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
985 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1074 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
986 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1075 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
987 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1076 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
988 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1077 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
989 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1078 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
990 shade term_name title transparent transparent_all tripleclickwords 1079 secondaryScreen secondaryScroll selectstyle shade term_name title
991 utmpInhibit visualBell 1080 transient_for transparent transparent_all tripleclickwords utmpInhibit
1081 visualBell
992 1082
993=cut 1083=cut
994 1084
995sub resource($$;$) { 1085sub resource($$;$) {
996 my ($self, $name) = (shift, shift); 1086 my ($self, $name) = (shift, shift);
1478 1568
1479Calls XUngrab for the most recent grab. Is called automatically on 1569Calls XUngrab for the most recent grab. Is called automatically on
1480evaluation errors, as it is better to lose the grab in the error case as 1570evaluation errors, as it is better to lose the grab in the error case as
1481the session. 1571the session.
1482 1572
1573=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1574
1575=item $atom_name = $term->XGetAtomName ($atom)
1576
1577=item @atoms = $term->XListProperties ($window)
1578
1579=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1580
1581=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1582
1583=item $term->XDeleteProperty ($window, $property)
1584
1585=item $window = $term->DefaultRootWindow
1586
1587=item $term->XReparentWindow ($window, $parent, [$x, $y])
1588
1589=item $term->XMapWindow ($window)
1590
1591=item $term->XUnmapWindow ($window)
1592
1593=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1594
1595=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1596
1597=item $term->XChangeInput ($window, $add_events[, $del_events])
1598
1599Various X or X-related functions. The C<$term> object only serves as
1600the source of the display, otherwise those functions map more-or-less
1601directory onto the X functions of the same name.
1602
1483=back 1603=back
1484 1604
1485=cut 1605=cut
1486 1606
1487package urxvt::popup; 1607package urxvt::popup;
1588 my $env = $self->{term}->env; 1708 my $env = $self->{term}->env;
1589 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1709 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1590 delete $env->{LC_ALL}; 1710 delete $env->{LC_ALL};
1591 $env->{LC_CTYPE} = $self->{term}->locale; 1711 $env->{LC_CTYPE} = $self->{term}->locale;
1592 1712
1593 urxvt::term->new ($env, $self->{term}->resource ("name"), 1713 urxvt::term->new ($env, "popup",
1594 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1714 "--perl-lib" => "", "--perl-ext-common" => "",
1715 "-pty-fd" => -1, "-sl" => 0,
1716 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1595 "--transient-for" => $self->{term}->parent, 1717 "--transient-for" => $self->{term}->parent,
1596 "-display" => $self->{term}->display_id, 1718 "-display" => $self->{term}->display_id,
1597 "-pe" => "urxvt-popup") 1719 "-pe" => "urxvt-popup")
1598 or die "unable to create popup window\n"; 1720 or die "unable to create popup window\n";
1599} 1721}
1604 delete $self->{term}{_destroy}{$self}; 1726 delete $self->{term}{_destroy}{$self};
1605 $self->{term}->ungrab; 1727 $self->{term}->ungrab;
1606} 1728}
1607 1729
1608=back 1730=back
1731
1732=cut
1733
1734package urxvt::watcher;
1735
1736@urxvt::timer::ISA = __PACKAGE__;
1737@urxvt::iow::ISA = __PACKAGE__;
1738@urxvt::pw::ISA = __PACKAGE__;
1739@urxvt::iw::ISA = __PACKAGE__;
1609 1740
1610=head2 The C<urxvt::timer> Class 1741=head2 The C<urxvt::timer> Class
1611 1742
1612This class implements timer watchers/events. Time is represented as a 1743This class implements timer watchers/events. Time is represented as a
1613fractional number of seconds since the epoch. Example: 1744fractional number of seconds since the epoch. Example:
1651Start the timer. 1782Start the timer.
1652 1783
1653=item $timer = $timer->start ($tstamp) 1784=item $timer = $timer->start ($tstamp)
1654 1785
1655Set the event trigger time to C<$tstamp> and start the timer. 1786Set the event trigger time to C<$tstamp> and start the timer.
1787
1788=item $timer = $timer->after ($delay)
1789
1790Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1656 1791
1657=item $timer = $timer->stop 1792=item $timer = $timer->stop
1658 1793
1659Stop the timer. 1794Stop the timer.
1660 1795
1707 1842
1708Stop watching for events on the given filehandle. 1843Stop watching for events on the given filehandle.
1709 1844
1710=back 1845=back
1711 1846
1847=head2 The C<urxvt::iw> Class
1848
1849This class implements idle watchers, that get called automatically when
1850the process is idle. They should return as fast as possible, after doing
1851some useful work.
1852
1853=over 4
1854
1855=item $iw = new urxvt::iw
1856
1857Create a new idle watcher object in stopped state.
1858
1859=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1860
1861Set the callback to be called when the watcher triggers.
1862
1863=item $timer = $timer->start
1864
1865Start the watcher.
1866
1867=item $timer = $timer->stop
1868
1869Stop the watcher.
1870
1871=back
1872
1873=head2 The C<urxvt::pw> Class
1874
1875This class implements process watchers. They create an event whenever a
1876process exits, after which they stop automatically.
1877
1878 my $pid = fork;
1879 ...
1880 $term->{pw} = urxvt::pw
1881 ->new
1882 ->start ($pid)
1883 ->cb (sub {
1884 my ($pw, $exit_status) = @_;
1885 ...
1886 });
1887
1888=over 4
1889
1890=item $pw = new urxvt::pw
1891
1892Create a new process watcher in stopped state.
1893
1894=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1895
1896Set the callback to be called when the timer triggers.
1897
1898=item $pw = $timer->start ($pid)
1899
1900Tells the wqtcher to start watching for process C<$pid>.
1901
1902=item $pw = $pw->stop
1903
1904Stop the watcher.
1905
1906=back
1907
1712=head1 ENVIRONMENT 1908=head1 ENVIRONMENT
1713 1909
1714=head2 URXVT_PERL_VERBOSITY 1910=head2 URXVT_PERL_VERBOSITY
1715 1911
1716This variable controls the verbosity level of the perl extension. Higher 1912This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines