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.98 by root, Tue Jan 17 17:01:54 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.
97
98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
101
102It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>.
107
108The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any
110C<a>s:
111
112 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g }
114 : ()
115 };
93 116
94=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
95 118
96Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
125 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/
126 149
127And 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
128paste directly into your (vi :) editor: 151paste directly into your (vi :) editor:
129 152
130 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/
131 154
132Of 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 :)
133 156
134To expand the example above to typical perl error messages ("XXX at 157To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 158FILENAME line YYY."), you need a slightly more elaborate solution:
136 159
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 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/
139 162
140The 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
141every error message as a selection pattern, and the second line transforms 164every error message as a selection pattern, and the second line transforms
142the 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.
143 177
144=item mark-urls 178=item mark-urls
145 179
146Uses 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
147make them clickable. When middle-clicked, the program specified in the 181make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 182resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 183the URL as first argument.
150 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
192
151=item block-graphics-to-ascii 193=item block-graphics-to-ascii
152 194
153A 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,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 196by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 197similar-looking ascii character.
165overlays or changes. 207overlays or changes.
166 208
167=item selection-pastebin 209=item selection-pastebin
168 210
169This is a little rarely useful extension that Uploads the selection as 211This is a little rarely useful extension that Uploads the selection as
170textfile to a remote site (or does other things). 212textfile to a remote site (or does other things). (The implementation is
213not currently secure for use in a multiuser environment as it writes to
214F</tmp> directly.).
171 215
172It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 216It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173i.e. 217i.e.
174 218
175 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 219 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
270called whenever the relevant event happens. 314called whenever the relevant event happens.
271 315
272The 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
273the in the C<Extension Objects> section. 317the in the C<Extension Objects> section.
274 318
275B<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
276event 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
277skipped, and the relevant action might not be carried out by the C++ code. 321relevant action might not be carried out by the C++ code.
278 322
279I<< When in doubt, return a false value (preferably C<()>). >> 323I<< When in doubt, return a false value (preferably C<()>). >>
280 324
281=over 4 325=over 4
282 326
283=item on_init $term 327=item on_init $term
284 328
285Called after a new terminal object has been initialized, but before 329Called after a new terminal object has been initialized, but before
286windows 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
287call or deliver senseless data, as terminal size and other characteristics 331call or deliver senseless data, as terminal size and other characteristics
288have not yet been determined. You can safely query and change resources, 332have not yet been determined. You can safely query and change resources
289though. 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.
290 346
291=item on_reset $term 347=item on_reset $term
292 348
293Called 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
294control 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
295variables. 351variables.
296 352
297=item on_start $term 353=item on_child_start $term, $pid
298 354
299Called at the very end of initialisation of a new terminal, just before 355Called just after the child process has been C<fork>ed.
300returning 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>.
301 361
302=item on_sel_make $term, $eventtime 362=item on_sel_make $term, $eventtime
303 363
304Called 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
305selection 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
414=item on_focus_out $term 474=item on_focus_out $term
415 475
416Called wheneever the window loses keyboard focus, before rxvt-unicode does 476Called wheneever the window loses keyboard focus, before rxvt-unicode does
417focus out processing. 477focus out processing.
418 478
479=item on_configure_notify $term, $event
480
481=item on_property_notify $term, $event
482
419=item on_key_press $term, $event, $keysym, $octets 483=item on_key_press $term, $event, $keysym, $octets
420 484
421=item on_key_release $term, $event, $keysym 485=item on_key_release $term, $event, $keysym
422 486
423=item on_button_press $term, $event 487=item on_button_press $term, $event
432 496
433Called whenever the corresponding X event is received for the terminal If 497Called whenever the corresponding X event is received for the terminal If
434the 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.
435 499
436The 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
437manpage), 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
438and column under the mouse cursor. 502(real, not screen-based) row and column under the mouse cursor.
439 503
440C<on_key_press> additionally receives the string rxvt-unicode would 504C<on_key_press> additionally receives the string rxvt-unicode would
441output, if any, in locale-specific encoding. 505output, if any, in locale-specific encoding.
442 506
443subwindow. 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).
444 517
445=back 518=back
446 519
447=cut 520=cut
448 521
454use Scalar::Util (); 527use Scalar::Util ();
455use List::Util (); 528use List::Util ();
456 529
457our $VERSION = 1; 530our $VERSION = 1;
458our $TERM; 531our $TERM;
532our @TERM_INIT;
533our @TERM_EXT;
459our @HOOKNAME; 534our @HOOKNAME;
460our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 535our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461our %OPTION; 536our %OPTION;
462 537
463our $LIBDIR; 538our $LIBDIR;
484 559
485=item $urxvt::TERM 560=item $urxvt::TERM
486 561
487The current terminal. This variable stores the current C<urxvt::term> 562The current terminal. This variable stores the current C<urxvt::term>
488object, 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>.
489 580
490=back 581=back
491 582
492=head2 Functions in the C<urxvt> Package 583=head2 Functions in the C<urxvt> Package
493 584
593=back 684=back
594 685
595=cut 686=cut
596 687
597BEGIN { 688BEGIN {
598 urxvt->bootstrap;
599
600 # overwrite perl's warn 689 # overwrite perl's warn
601 *CORE::GLOBAL::warn = sub { 690 *CORE::GLOBAL::warn = sub {
602 my $msg = join "", @_; 691 my $msg = join "", @_;
603 $msg .= "\n" 692 $msg .= "\n"
604 unless $msg =~ /\n$/; 693 unless $msg =~ /\n$/;
605 urxvt::warn ($msg); 694 urxvt::warn ($msg);
606 }; 695 };
607
608 # %ENV is the original startup environment
609 delete $ENV{IFS};
610 delete $ENV{CDPATH};
611 delete $ENV{BASH_ENV};
612 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
613} 696}
614 697
615my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 698my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616 699
617sub verbose { 700sub verbose {
618 my ($level, $msg) = @_; 701 my ($level, $msg) = @_;
619 warn "$msg\n" if $level <= $verbosity; 702 warn "$msg\n" if $level <= $verbosity;
620} 703}
621 704
622my $extension_pkg = "extension0000";
623my %extension_pkg; 705my %extension_pkg;
624 706
625# load a single script into its own package, once only 707# load a single script into its own package, once only
626sub extension_package($) { 708sub extension_package($) {
627 my ($path) = @_; 709 my ($path) = @_;
628 710
629 $extension_pkg{$path} ||= do { 711 $extension_pkg{$path} ||= do {
630 my $pkg = "urxvt::" . ($extension_pkg++); 712 $path =~ /([^\/\\]+)$/;
713 my $pkg = $1;
714 $pkg =~ s/[^[:word:]]/_/g;
715 $pkg = "urxvt::ext::$pkg";
631 716
632 verbose 3, "loading extension '$path' into package '$pkg'"; 717 verbose 3, "loading extension '$path' into package '$pkg'";
633 718
634 open my $fh, "<:raw", $path 719 open my $fh, "<:raw", $path
635 or die "$path: $!"; 720 or die "$path: $!";
636 721
637 my $source = 722 my $source =
638 "package $pkg; use strict; use utf8;\n" 723 "package $pkg; use strict; use utf8;\n"
639 . "use base urxvt::term::extension::;\n"
640 . "#line 1 \"$path\"\n{\n" 724 . "#line 1 \"$path\"\n{\n"
641 . (do { local $/; <$fh> }) 725 . (do { local $/; <$fh> })
642 . "\n};\n1"; 726 . "\n};\n1";
643 727
644 eval $source 728 eval $source
658 if ($htype == 0) { # INIT 742 if ($htype == 0) { # INIT
659 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 743 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
660 744
661 my %ext_arg; 745 my %ext_arg;
662 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
663 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 756 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
664 if ($_ eq "default") { 757 if ($_ eq "default") {
665 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 758 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
666 } elsif (/^-(.*)$/) { 759 } elsif (/^-(.*)$/) {
667 delete $ext_arg{$1}; 760 delete $ext_arg{$1};
668 } elsif (/^([^<]+)<(.*)>$/) { 761 } elsif (/^([^<]+)<(.*)>$/) {
693 if $verbosity >= 10; 786 if $verbosity >= 10;
694 787
695 keys %$cb; 788 keys %$cb;
696 789
697 while (my ($pkg, $cb) = each %$cb) { 790 while (my ($pkg, $cb) = each %$cb) {
698 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 791 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
699 and last; 792 $retval ||= $retval_;
700 793
701 if ($@) { 794 if ($@) {
702 $TERM->ungrab; # better to lose the grab than the session 795 $TERM->ungrab; # better to lose the grab than the session
703 warn $@; 796 warn $@;
704 } 797 }
715 # clear package 808 # clear package
716 %$TERM = (); 809 %$TERM = ();
717 } 810 }
718 811
719 $retval 812 $retval
720}
721
722sub exec_async(@) {
723 my $pid = fork;
724
725 return
726 if !defined $pid or $pid;
727
728 %ENV = %{ $TERM->env };
729
730 exec @_;
731 _exit 255;
732} 813}
733 814
734# urxvt::term::extension 815# urxvt::term::extension
735 816
736package urxvt::term::extension; 817package urxvt::term::extension;
875# find on_xxx subs in the package and register them 956# find on_xxx subs in the package and register them
876# as hooks 957# as hooks
877sub register_package { 958sub register_package {
878 my ($self, $pkg, $argv) = @_; 959 my ($self, $pkg, $argv) = @_;
879 960
961 no strict 'refs';
962
963 urxvt::verbose 6, "register package $pkg to $self";
964
965 @{"$pkg\::ISA"} = urxvt::term::extension::;
966
880 my $proxy = bless { 967 my $proxy = bless {
881 _pkg => $pkg, 968 _pkg => $pkg,
882 argv => $argv, 969 argv => $argv,
883 }, $pkg; 970 }, $pkg;
884 Scalar::Util::weaken ($proxy->{term} = $self); 971 Scalar::Util::weaken ($proxy->{term} = $self);
915 1002
916Destroy the terminal object (close the window, free resources 1003Destroy the terminal object (close the window, free resources
917etc.). 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
918watchers (timers, io watchers) are still active. 1005watchers (timers, io watchers) are still active.
919 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
920=item $isset = $term->option ($optval[, $set]) 1032=item $isset = $term->option ($optval[, $set])
921 1033
922Returns true if the option specified by C<$optval> is enabled, and 1034Returns true if the option specified by C<$optval> is enabled, and
923optionally 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
924C<%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.
926Here 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
927source file F</src/optinc.h> to see the actual list: 1039source file F</src/optinc.h> to see the actual list:
928 1040
929 borderLess console cursorBlink cursorUnderline hold iconic insecure 1041 borderLess console cursorBlink cursorUnderline hold iconic insecure
930 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1042 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1043 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1044 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1045 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934 tripleclickwords utmpInhibit visualBell 1046 transparent tripleclickwords utmpInhibit visualBell
935 1047
936=item $value = $term->resource ($name[, $newval]) 1048=item $value = $term->resource ($name[, $newval])
937 1049
938Returns the current resource value associated with a given name and 1050Returns the current resource value associated with a given name and
939optionally 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>
956 1068
957 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1069 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958 borderLess color cursorBlink cursorUnderline cutchars delete_key 1070 borderLess color cursorBlink cursorUnderline cutchars delete_key
959 display_name embed ext_bwidth fade font geometry hold iconName 1071 display_name embed ext_bwidth fade font geometry hold iconName
960 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1072 imFont imLocale inputMethod insecure int_bwidth intensityStyles
961 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1073 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1074 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1075 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1076 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1077 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1078 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967 shade term_name title transparent transparent_all tripleclickwords 1079 secondaryScreen secondaryScroll selectstyle shade term_name title
968 utmpInhibit visualBell 1080 transient_for transparent transparent_all tripleclickwords utmpInhibit
1081 visualBell
969 1082
970=cut 1083=cut
971 1084
972sub resource($$;$) { 1085sub resource($$;$) {
973 my ($self, $name) = (shift, shift); 1086 my ($self, $name) = (shift, shift);
1455 1568
1456Calls XUngrab for the most recent grab. Is called automatically on 1569Calls XUngrab for the most recent grab. Is called automatically on
1457evaluation 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
1458the session. 1571the session.
1459 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
1460=back 1603=back
1461 1604
1462=cut 1605=cut
1463 1606
1464package urxvt::popup; 1607package urxvt::popup;
1565 my $env = $self->{term}->env; 1708 my $env = $self->{term}->env;
1566 # 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.
1567 delete $env->{LC_ALL}; 1710 delete $env->{LC_ALL};
1568 $env->{LC_CTYPE} = $self->{term}->locale; 1711 $env->{LC_CTYPE} = $self->{term}->locale;
1569 1712
1570 urxvt::term->new ($env, $self->{term}->resource ("name"), 1713 urxvt::term->new ($env, "popup",
1571 "--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",
1572 "--transient-for" => $self->{term}->parent, 1717 "--transient-for" => $self->{term}->parent,
1573 "-display" => $self->{term}->display_id, 1718 "-display" => $self->{term}->display_id,
1574 "-pe" => "urxvt-popup") 1719 "-pe" => "urxvt-popup")
1575 or die "unable to create popup window\n"; 1720 or die "unable to create popup window\n";
1576} 1721}
1581 delete $self->{term}{_destroy}{$self}; 1726 delete $self->{term}{_destroy}{$self};
1582 $self->{term}->ungrab; 1727 $self->{term}->ungrab;
1583} 1728}
1584 1729
1585=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__;
1586 1740
1587=head2 The C<urxvt::timer> Class 1741=head2 The C<urxvt::timer> Class
1588 1742
1589This class implements timer watchers/events. Time is represented as a 1743This class implements timer watchers/events. Time is represented as a
1590fractional number of seconds since the epoch. Example: 1744fractional number of seconds since the epoch. Example:
1628Start the timer. 1782Start the timer.
1629 1783
1630=item $timer = $timer->start ($tstamp) 1784=item $timer = $timer->start ($tstamp)
1631 1785
1632Set 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>.
1633 1791
1634=item $timer = $timer->stop 1792=item $timer = $timer->stop
1635 1793
1636Stop the timer. 1794Stop the timer.
1637 1795
1684 1842
1685Stop watching for events on the given filehandle. 1843Stop watching for events on the given filehandle.
1686 1844
1687=back 1845=back
1688 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
1689=head1 ENVIRONMENT 1908=head1 ENVIRONMENT
1690 1909
1691=head2 URXVT_PERL_VERBOSITY 1910=head2 URXVT_PERL_VERBOSITY
1692 1911
1693This 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