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.83 by root, Thu Jan 12 01:38:37 2006 UTC vs.
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC

35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
44(More) intelligent selection. This extension tries to be more intelligent 48(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 49when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 50now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 51arguments, which is very convenient, too, if your F<ls> supports
52C<--quoting-style=shell>.
48 53
54A double-click usually selects the word under the cursor, further clicks
55will enlarge the selection.
56
57The selection works by trying to match a number of regexes and displaying
58them in increasing order of length. You can add your own regexes by
59specifying resources of the form:
60
61 URxvt.selection.pattern-0: perl-regex
62 URxvt.selection.pattern-1: perl-regex
63 ...
64
65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything
68between two vertical bars:
69
70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end.
74
49It also offers the following bindable keyboard command: 75This extension also offers following bindable keyboard commands:
50 76
51=over 4 77=over 4
52 78
53=item rot13 79=item rot13
54 80
65 91
66=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
67 93
68Binds 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
69text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
70evalution, 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 };
71 116
72=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
73 118
74Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 121input/output is suspended and a regex is displayed at the bottom of the
122screen.
77 123
78C</> starts an incremental regex search, C<n> searches further, C<p> or 124Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 125search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 126search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 127bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary
130selection.
82 131
83=item digital-clock 132=item selection-autotransform
84 133
85Displays a digital clock using the built-in overlay. 134This selection allows you to do automatic transforms on a selection
135whenever a selection is made.
136
137It works by specifying perl snippets (most useful is a single C<s///>
138operator) that modify C<$_> as resources:
139
140 URxvt.selection-autotransform.0: transform
141 URxvt.selection-autotransform.1: transform
142 ...
143
144For example, the following will transform selections of the form
145C<filename:number>, often seen in compiler messages, into C<vi +$filename
146$word>:
147
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150And this example matches the same,but replaces it with vi-commands you can
151paste directly into your (vi :) editor:
152
153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155Of course, this can be modified to suit your needs and your editor :)
156
157To expand the example above to typical perl error messages ("XXX at
158FILENAME line YYY."), you need a slightly more elaborate solution:
159
160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms
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.
86 191
87=item mark-urls 192=item mark-urls
88 193
89Uses 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
90make them clickable. When middle-clicked, the program specified in the 195make them clickable. When middle-clicked, the program specified in the
91resource C<urlLauncher> (default C<x-www-browser>) will be started. 196resource C<urlLauncher> (default C<x-www-browser>) will be started with
197the URL as first argument.
198
199=item automove-background
200
201This is basically a one-line extension that dynamically changes the background pixmap offset
202to the window position, in effect creating the same effect as pseudo transparency with
203a custom pixmap. No scaling is supported in this mode. Exmaple:
204
205 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
92 206
93=item block-graphics-to-ascii 207=item block-graphics-to-ascii
94 208
95A not very useful example of filtering all text output to the terminal, 209A not very useful example of filtering all text output to the terminal,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 210by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 211similar-looking ascii character.
98 212
213=item digital-clock
214
215Displays a digital clock using the built-in overlay.
216
99=item example-refresh-hooks 217=item example-refresh-hooks
100 218
101Displays a very simple digital clock in the upper right corner of the 219Displays a very simple digital clock in the upper right corner of the
102window. Illustrates overwriting the refresh callbacks to create your own 220window. Illustrates overwriting the refresh callbacks to create your own
103overlays or changes. 221overlays or changes.
222
223=item selection-pastebin
224
225This is a little rarely useful extension that Uploads the selection as
226textfile to a remote site (or does other things). (The implementation is
227not currently secure for use in a multiuser environment as it writes to
228F</tmp> directly.).
229
230It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
231i.e.
232
233 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
234
235Pressing this combination runs a command with C<%> replaced by the name of
236the textfile. This command can be set via a resource:
237
238 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
239
240And the default is likely not useful to anybody but the few people around
241here :)
242
243The name of the textfile is the hex encoded md5 sum of the selection, so
244the same content should lead to the same filename.
245
246After a successful upload the selection will be replaced by the text given
247in the C<selection-pastebin-url> resource (again, the % is the placeholder
248for the filename):
249
250 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
104 251
105=back 252=back
106 253
107=head1 API DOCUMENTATION 254=head1 API DOCUMENTATION
108 255
181called whenever the relevant event happens. 328called whenever the relevant event happens.
182 329
183The 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
184the in the C<Extension Objects> section. 331the in the C<Extension Objects> section.
185 332
186B<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
187event 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
188skipped, and the relevant action might not be carried out by the C++ code. 335relevant action might not be carried out by the C++ code.
189 336
190I<< When in doubt, return a false value (preferably C<()>). >> 337I<< When in doubt, return a false value (preferably C<()>). >>
191 338
192=over 4 339=over 4
193 340
194=item on_init $term 341=item on_init $term
195 342
196Called after a new terminal object has been initialized, but before 343Called after a new terminal object has been initialized, but before
197windows 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
198call or deliver senseless data, as terminal size and other characteristics 345call or deliver senseless data, as terminal size and other characteristics
199have not yet been determined. You can safely query and change resources, 346have not yet been determined. You can safely query and change resources
200though. 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.
201 360
202=item on_reset $term 361=item on_reset $term
203 362
204Called 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
205control 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
206variables. 365variables.
207 366
208=item on_start $term 367=item on_child_start $term, $pid
209 368
210Called at the very end of initialisation of a new terminal, just before 369Called just after the child process has been C<fork>ed.
211returning 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>.
212 375
213=item on_sel_make $term, $eventtime 376=item on_sel_make $term, $eventtime
214 377
215Called 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
216selection 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
230=item on_sel_extend $term 393=item on_sel_extend $term
231 394
232Called whenever the user tries to extend the selection (e.g. with a double 395Called whenever the user tries to extend the selection (e.g. with a double
233click) and is either supposed to return false (normal operation), or 396click) and is either supposed to return false (normal operation), or
234should extend the selection itelf and return true to suppress the built-in 397should extend the selection itelf and return true to suppress the built-in
235processing. 398processing. This can happen multiple times, as long as the callback
399returns true, it will be called on every further click by the user and is
400supposed to enlarge the selection more and more, if possible.
236 401
237See the F<selection> example extension. 402See the F<selection> example extension.
238 403
239=item on_view_change $term, $offset 404=item on_view_change $term, $offset
240 405
307 472
308Called whenever the user presses a key combination that has a 473Called whenever the user presses a key combination that has a
309C<perl:string> action bound to it (see description of the B<keysym> 474C<perl:string> action bound to it (see description of the B<keysym>
310resource in the @@RXVT_NAME@@(1) manpage). 475resource in the @@RXVT_NAME@@(1) manpage).
311 476
477=item on_x_event $term, $event
478
479Called on every X event received on the vt window (and possibly other
480windows). Should only be used as a last resort. Most event structure
481members are not passed.
482
312=item on_focus_in $term 483=item on_focus_in $term
313 484
314Called whenever the window gets the keyboard focus, before rxvt-unicode 485Called whenever the window gets the keyboard focus, before rxvt-unicode
315does focus in processing. 486does focus in processing.
316 487
317=item on_focus_out $term 488=item on_focus_out $term
318 489
319Called wheneever the window loses keyboard focus, before rxvt-unicode does 490Called wheneever the window loses keyboard focus, before rxvt-unicode does
320focus out processing. 491focus out processing.
321 492
493=item on_configure_notify $term, $event
494
495=item on_property_notify $term, $event
496
322=item on_key_press $term, $event, $keysym, $octets 497=item on_key_press $term, $event, $keysym, $octets
323 498
324=item on_key_release $term, $event, $keysym 499=item on_key_release $term, $event, $keysym
325 500
326=item on_button_press $term, $event 501=item on_button_press $term, $event
335 510
336Called whenever the corresponding X event is received for the terminal If 511Called whenever the corresponding X event is received for the terminal If
337the 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.
338 513
339The 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
340manpage), 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
341and column under the mouse cursor. 516(real, not screen-based) row and column under the mouse cursor.
342 517
343C<on_key_press> additionally receives the string rxvt-unicode would 518C<on_key_press> additionally receives the string rxvt-unicode would
344output, if any, in locale-specific encoding. 519output, if any, in locale-specific encoding.
345 520
346subwindow. 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).
347 531
348=back 532=back
349 533
350=cut 534=cut
351 535
357use Scalar::Util (); 541use Scalar::Util ();
358use List::Util (); 542use List::Util ();
359 543
360our $VERSION = 1; 544our $VERSION = 1;
361our $TERM; 545our $TERM;
546our @TERM_INIT;
547our @TERM_EXT;
362our @HOOKNAME; 548our @HOOKNAME;
363our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 549our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364our %OPTION; 550our %OPTION;
365 551
366our $LIBDIR; 552our $LIBDIR;
367our $RESNAME; 553our $RESNAME;
368our $RESCLASS; 554our $RESCLASS;
369our $RXVTNAME; 555our $RXVTNAME;
370 556
557our $NOCHAR = chr 0xfffe;
558
371=head2 Variables in the C<urxvt> Package 559=head2 Variables in the C<urxvt> Package
372 560
373=over 4 561=over 4
374 562
375=item $urxvt::LIBDIR 563=item $urxvt::LIBDIR
387 575
388=item $urxvt::TERM 576=item $urxvt::TERM
389 577
390The current terminal. This variable stores the current C<urxvt::term> 578The current terminal. This variable stores the current C<urxvt::term>
391object, 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>.
392 596
393=back 597=back
394 598
395=head2 Functions in the C<urxvt> Package 599=head2 Functions in the C<urxvt> Package
396 600
411Using this function has the advantage that its output ends up in the 615Using this function has the advantage that its output ends up in the
412correct place, e.g. on stderr of the connecting urxvtc client. 616correct place, e.g. on stderr of the connecting urxvtc client.
413 617
414Messages have a size limit of 1023 bytes currently. 618Messages have a size limit of 1023 bytes currently.
415 619
416=item $is_safe = urxvt::safe
417
418Returns true when it is safe to do potentially unsafe things, such as
419evaluating perl code specified by the user. This is true when urxvt was
420started setuid or setgid.
421
422=item $time = urxvt::NOW 620=item $time = urxvt::NOW
423 621
424Returns the "current time" (as per the event loop). 622Returns the "current time" (as per the event loop).
425 623
426=item urxvt::CurrentTime 624=item urxvt::CurrentTime
427 625
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 626=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 627Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier 628Button4Mask, Button5Mask, AnyModifier
629
630=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
631ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
632PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
633Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
634KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
635ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
636FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
637
638=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
639EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
640GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
641UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
642ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
643CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
644SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431 645
432Various constants for use in X calls and event processing. 646Various constants for use in X calls and event processing.
433 647
434=back 648=back
435 649
486=back 700=back
487 701
488=cut 702=cut
489 703
490BEGIN { 704BEGIN {
491 urxvt->bootstrap;
492
493 # overwrite perl's warn 705 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub { 706 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_; 707 my $msg = join "", @_;
496 $msg .= "\n" 708 $msg .= "\n"
497 unless $msg =~ /\n$/; 709 unless $msg =~ /\n$/;
498 urxvt::warn ($msg); 710 urxvt::warn ($msg);
499 }; 711 };
500
501 # %ENV is the original startup environment
502 delete $ENV{IFS};
503 delete $ENV{CDPATH};
504 delete $ENV{BASH_ENV};
505 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506} 712}
507 713
508my @hook_count;
509my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 714my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510 715
511sub verbose { 716sub verbose {
512 my ($level, $msg) = @_; 717 my ($level, $msg) = @_;
513 warn "$msg\n" if $level <= $verbosity; 718 warn "$msg\n" if $level <= $verbosity;
514} 719}
515 720
516my $extension_pkg = "extension0000";
517my %extension_pkg; 721my %extension_pkg;
518 722
519# load a single script into its own package, once only 723# load a single script into its own package, once only
520sub extension_package($) { 724sub extension_package($) {
521 my ($path) = @_; 725 my ($path) = @_;
522 726
523 $extension_pkg{$path} ||= do { 727 $extension_pkg{$path} ||= do {
524 my $pkg = "urxvt::" . ($extension_pkg++); 728 $path =~ /([^\/\\]+)$/;
729 my $pkg = $1;
730 $pkg =~ s/[^[:word:]]/_/g;
731 $pkg = "urxvt::ext::$pkg";
525 732
526 verbose 3, "loading extension '$path' into package '$pkg'"; 733 verbose 3, "loading extension '$path' into package '$pkg'";
527 734
528 open my $fh, "<:raw", $path 735 open my $fh, "<:raw", $path
529 or die "$path: $!"; 736 or die "$path: $!";
530 737
531 my $source = untaint 738 my $source =
532 "package $pkg; use strict; use utf8;\n" 739 "package $pkg; use strict; use utf8;\n"
533 . "use base urxvt::term::extension::;\n"
534 . "#line 1 \"$path\"\n{\n" 740 . "#line 1 \"$path\"\n{\n"
535 . (do { local $/; <$fh> }) 741 . (do { local $/; <$fh> })
536 . "\n};\n1"; 742 . "\n};\n1";
537 743
538 eval $source 744 eval $source
552 if ($htype == 0) { # INIT 758 if ($htype == 0) { # INIT
553 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 759 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554 760
555 my %ext_arg; 761 my %ext_arg;
556 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
557 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 772 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558 if ($_ eq "default") { 773 if ($_ eq "default") {
559 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 774 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
560 } elsif (/^-(.*)$/) { 775 } elsif (/^-(.*)$/) {
561 delete $ext_arg{$1}; 776 delete $ext_arg{$1};
562 } elsif (/^([^<]+)<(.*)>$/) { 777 } elsif (/^([^<]+)<(.*)>$/) {
587 if $verbosity >= 10; 802 if $verbosity >= 10;
588 803
589 keys %$cb; 804 keys %$cb;
590 805
591 while (my ($pkg, $cb) = each %$cb) { 806 while (my ($pkg, $cb) = each %$cb) {
592 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 807 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
593 and last; 808 $retval ||= $retval_;
594 809
595 if ($@) { 810 if ($@) {
596 $TERM->ungrab; # better to lose the grab than the session 811 $TERM->ungrab; # better to lose the grab than the session
597 warn $@; 812 warn $@;
598 } 813 }
599 } 814 }
815
816 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
817 if $verbosity >= 11;
600 } 818 }
601 819
602 if ($htype == 1) { # DESTROY 820 if ($htype == 1) { # DESTROY
603 if (my $hook = delete $TERM->{_hook}) {
604 for my $htype (0..$#$hook) {
605 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
606 or set_should_invoke $htype, 0;
607 }
608 }
609
610 # clear package objects 821 # clear package objects
611 %$_ = () for values %{ $TERM->{_pkg} }; 822 %$_ = () for values %{ $TERM->{_pkg} };
612 823
613 # clear package 824 # clear package
614 %$TERM = (); 825 %$TERM = ();
628 while (my ($name, $cb) = each %hook) { 839 while (my ($name, $cb) = each %hook) {
629 my $htype = $HOOKTYPE{uc $name}; 840 my $htype = $HOOKTYPE{uc $name};
630 defined $htype 841 defined $htype
631 or Carp::croak "unsupported hook type '$name'"; 842 or Carp::croak "unsupported hook type '$name'";
632 843
844 $self->set_should_invoke ($htype, +1)
633 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 845 unless exists $self->{term}{_hook}[$htype]{$pkg};
634 $hook_count[$htype]++
635 or urxvt::set_should_invoke $htype, 1;
636 }
637 846
638 $self->{term}{_hook}[$htype]{$pkg} = $cb; 847 $self->{term}{_hook}[$htype]{$pkg} = $cb;
639 } 848 }
640} 849}
641 850
646 for my $name (@hook) { 855 for my $name (@hook) {
647 my $htype = $HOOKTYPE{uc $name}; 856 my $htype = $HOOKTYPE{uc $name};
648 defined $htype 857 defined $htype
649 or Carp::croak "unsupported hook type '$name'"; 858 or Carp::croak "unsupported hook type '$name'";
650 859
860 $self->set_should_invoke ($htype, -1)
651 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 861 if delete $self->{term}{_hook}[$htype]{$pkg};
652 --$hook_count[$htype]
653 or urxvt::set_should_invoke $htype, 0;
654 }
655 } 862 }
656} 863}
657 864
658our $AUTOLOAD; 865our $AUTOLOAD;
659 866
765# find on_xxx subs in the package and register them 972# find on_xxx subs in the package and register them
766# as hooks 973# as hooks
767sub register_package { 974sub register_package {
768 my ($self, $pkg, $argv) = @_; 975 my ($self, $pkg, $argv) = @_;
769 976
977 no strict 'refs';
978
979 urxvt::verbose 6, "register package $pkg to $self";
980
981 @{"$pkg\::ISA"} = urxvt::term::extension::;
982
770 my $proxy = bless { 983 my $proxy = bless {
771 _pkg => $pkg, 984 _pkg => $pkg,
772 argv => $argv, 985 argv => $argv,
773 }, $pkg; 986 }, $pkg;
774 Scalar::Util::weaken ($proxy->{term} = $self); 987 Scalar::Util::weaken ($proxy->{term} = $self);
805 1018
806Destroy the terminal object (close the window, free resources 1019Destroy the terminal object (close the window, free resources
807etc.). 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
808watchers (timers, io watchers) are still active. 1021watchers (timers, io watchers) are still active.
809 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}
1047
810=item $isset = $term->option ($optval[, $set]) 1048=item $isset = $term->option ($optval[, $set])
811 1049
812Returns true if the option specified by C<$optval> is enabled, and 1050Returns true if the option specified by C<$optval> is enabled, and
813optionally 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
814C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1052C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
816Here is a a likely non-exhaustive list of option names, please see the 1054Here is a a likely non-exhaustive list of option names, please see the
817source file F</src/optinc.h> to see the actual list: 1055source file F</src/optinc.h> to see the actual list:
818 1056
819 borderLess console cursorBlink cursorUnderline hold iconic insecure 1057 borderLess console cursorBlink cursorUnderline hold iconic insecure
820 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1058 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
821 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1059 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
822 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1060 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
823 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1061 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
824 tripleclickwords utmpInhibit visualBell 1062 transparent tripleclickwords utmpInhibit visualBell
825 1063
826=item $value = $term->resource ($name[, $newval]) 1064=item $value = $term->resource ($name[, $newval])
827 1065
828Returns the current resource value associated with a given name and 1066Returns the current resource value associated with a given name and
829optionally sets a new value. Setting values is most useful in the C<init> 1067optionally sets a new value. Setting values is most useful in the C<init>
846 1084
847 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1085 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
848 borderLess color cursorBlink cursorUnderline cutchars delete_key 1086 borderLess color cursorBlink cursorUnderline cutchars delete_key
849 display_name embed ext_bwidth fade font geometry hold iconName 1087 display_name embed ext_bwidth fade font geometry hold iconName
850 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1088 imFont imLocale inputMethod insecure int_bwidth intensityStyles
851 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1089 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
852 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1090 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
853 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1091 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
854 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1092 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
855 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1093 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
856 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1094 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
857 shade term_name title transparent transparent_all tripleclickwords 1095 secondaryScreen secondaryScroll selectstyle shade term_name title
858 utmpInhibit visualBell 1096 transient_for transparent transparent_all tripleclickwords utmpInhibit
1097 visualBell
859 1098
860=cut 1099=cut
861 1100
862sub resource($$;$) { 1101sub resource($$;$) {
863 my ($self, $name) = (shift, shift); 1102 my ($self, $name) = (shift, shift);
898=item ($row, $col) = $term->selection_end ([$row, $col]) 1137=item ($row, $col) = $term->selection_end ([$row, $col])
899 1138
900Return the current values of the selection mark, begin or end positions, 1139Return the current values of the selection mark, begin or end positions,
901and optionally set them to new values. 1140and optionally set them to new values.
902 1141
1142=item $term->selection_make ($eventtime[, $rectangular])
1143
1144Tries to make a selection as set by C<selection_beg> and
1145C<selection_end>. If C<$rectangular> is true (default: false), a
1146rectangular selection will be made. This is the prefered function to make
1147a selection.
1148
903=item $success = $term->selection_grab ($eventtime) 1149=item $success = $term->selection_grab ($eventtime)
904 1150
905Try to request the primary selection from the server (for example, as set 1151Try to request the primary selection text from the server (for example, as
906by the next method). 1152set by the next method). No visual feedback will be given. This function
1153is mostly useful from within C<on_sel_grab> hooks.
907 1154
908=item $oldtext = $term->selection ([$newtext]) 1155=item $oldtext = $term->selection ([$newtext])
909 1156
910Return the current selection text and optionally replace it by C<$newtext>. 1157Return the current selection text and optionally replace it by C<$newtext>.
911 1158
1004Convert the given locale-encoded octets into a perl string. 1251Convert the given locale-encoded octets into a perl string.
1005 1252
1006=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1253=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007 1254
1008XORs the rendition values in the given span with the provided value 1255XORs the rendition values in the given span with the provided value
1009(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1256(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1010to the selection. 1257refresh hooks to provide effects similar to the selection.
1011 1258
1012=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1259=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013 1260
1014Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1261Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015whitespace will additionally be xored with the C<$rstyle2>, which defaults 1262whitespace will additionally be xored with the C<$rstyle2>, which defaults
1016to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1263to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1017it instead. 1264it instead. Both styles I<MUST NOT> contain font styles.
1018 1265
1019=item $term->scr_bell 1266=item $term->scr_bell
1020 1267
1021Ring the bell! 1268Ring the bell!
1022 1269
1029 1276
1030Normally 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
1031confused by changes in cursor position or scrolling. Its useful inside a 1278confused by changes in cursor position or scrolling. Its useful inside a
1032C<on_add_lines> hook, though. 1279C<on_add_lines> hook, though.
1033 1280
1281=item $term->scr_change_screen ($screen)
1282
1283Switch to given screen - 0 primary, 1 secondary.
1284
1034=item $term->cmd_parse ($octets) 1285=item $term->cmd_parse ($octets)
1035 1286
1036Similar 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
1037locale-specific encoding of the terminal and can contain command sequences 1288locale-specific encoding of the terminal and can contain command sequences
1038(escape codes) that will be interpreted. 1289(escape codes) that will be interpreted.
1056 1307
1057=item $windowid = $term->vt 1308=item $windowid = $term->vt
1058 1309
1059Return the window id of the terminal window. 1310Return the window id of the terminal window.
1060 1311
1312=item $term->vt_emask_add ($x_event_mask)
1313
1314Adds the specified events to the vt event mask. Useful e.g. when you want
1315to receive pointer events all the times:
1316
1317 $term->vt_emask_add (urxvt::PointerMotionMask);
1318
1061=item $window_width = $term->width 1319=item $window_width = $term->width
1062 1320
1063=item $window_height = $term->height 1321=item $window_height = $term->height
1064 1322
1065=item $font_width = $term->fwidth 1323=item $font_width = $term->fwidth
1078 1336
1079=item $max_scrollback = $term->saveLines 1337=item $max_scrollback = $term->saveLines
1080 1338
1081=item $nrow_plus_saveLines = $term->total_rows 1339=item $nrow_plus_saveLines = $term->total_rows
1082 1340
1083=item $lines_in_scrollback = $term->nsaved 1341=item $topmost_scrollback_row = $term->top_row
1084 1342
1085Return various integers describing terminal characteristics. 1343Return various integers describing terminal characteristics.
1086 1344
1087=item $x_display = $term->display_id 1345=item $x_display = $term->display_id
1088 1346
1114=item $modifiermask = $term->ModNumLockMask 1372=item $modifiermask = $term->ModNumLockMask
1115 1373
1116Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1374Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1117AltGr), 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.
1118 1376
1377=item $screen = $term->current_screen
1378
1379Returns the currently displayed screen (0 primary, 1 secondary).
1380
1119=item $view_start = $term->view_start ([$newvalue]) 1381=item $view_start = $term->view_start ([$newvalue])
1120 1382
1121Returns the negative row number of the topmost line. Minimum value is 1383Returns the row number of the topmost displayed line. Maximum value is
1122C<0>, which displays the normal terminal contents. Larger values scroll 1384C<0>, which displays the normal terminal contents. Lower values scroll
1123this many lines into the scrollback buffer. 1385this many lines into the scrollback buffer.
1124 1386
1125=item $term->want_refresh 1387=item $term->want_refresh
1126 1388
1127Requests a screen refresh. At the next opportunity, rxvt-unicode will 1389Requests a screen refresh. At the next opportunity, rxvt-unicode will
1141If 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
1142line, 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
1143to 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
1144automatically be updated. 1406automatically be updated.
1145 1407
1146C<$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
1147than one cell when displayed are padded with urxvt::NOCHAR characters 1409more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1148(C<chr 65535>). Characters with combining characters and other characters 1410characters. Characters with combining characters and other characters that
1149that 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
1150characters in the private use area. 1412in the private use area.
1151 1413
1152You have to obey this encoding when changing text. The advantage is 1414You have to obey this encoding when changing text. The advantage is
1153that 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
1154characters. 1416characters.
1155 1417
1206Return the row number of the first/last row of the line, respectively. 1468Return the row number of the first/last row of the line, respectively.
1207 1469
1208=item $offset = $line->offset_of ($row, $col) 1470=item $offset = $line->offset_of ($row, $col)
1209 1471
1210Returns the character offset of the given row|col pair within the logical 1472Returns the character offset of the given row|col pair within the logical
1211line. 1473line. Works for rows outside the line, too, and returns corresponding
1474offsets outside the string.
1212 1475
1213=item ($row, $col) = $line->coord_of ($offset) 1476=item ($row, $col) = $line->coord_of ($offset)
1214 1477
1215Translates a string offset into terminal coordinates again. 1478Translates a string offset into terminal coordinates again.
1216 1479
1329 1592
1330Calls XUngrab for the most recent grab. Is called automatically on 1593Calls XUngrab for the most recent grab. Is called automatically on
1331evaluation errors, as it is better to lose the grab in the error case as 1594evaluation errors, as it is better to lose the grab in the error case as
1332the session. 1595the session.
1333 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
1334=back 1627=back
1335 1628
1336=cut 1629=cut
1337 1630
1338package urxvt::popup; 1631package urxvt::popup;
1439 my $env = $self->{term}->env; 1732 my $env = $self->{term}->env;
1440 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1733 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1441 delete $env->{LC_ALL}; 1734 delete $env->{LC_ALL};
1442 $env->{LC_CTYPE} = $self->{term}->locale; 1735 $env->{LC_CTYPE} = $self->{term}->locale;
1443 1736
1444 urxvt::term->new ($env, $self->{term}->resource ("name"), 1737 urxvt::term->new ($env, "popup",
1445 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1738 "--perl-lib" => "", "--perl-ext-common" => "",
1739 "-pty-fd" => -1, "-sl" => 0,
1740 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1446 "--transient-for" => $self->{term}->parent, 1741 "--transient-for" => $self->{term}->parent,
1447 "-display" => $self->{term}->display_id, 1742 "-display" => $self->{term}->display_id,
1448 "-pe" => "urxvt-popup") 1743 "-pe" => "urxvt-popup")
1449 or die "unable to create popup window\n"; 1744 or die "unable to create popup window\n";
1450} 1745}
1455 delete $self->{term}{_destroy}{$self}; 1750 delete $self->{term}{_destroy}{$self};
1456 $self->{term}->ungrab; 1751 $self->{term}->ungrab;
1457} 1752}
1458 1753
1459=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__;
1460 1764
1461=head2 The C<urxvt::timer> Class 1765=head2 The C<urxvt::timer> Class
1462 1766
1463This class implements timer watchers/events. Time is represented as a 1767This class implements timer watchers/events. Time is represented as a
1464fractional number of seconds since the epoch. Example: 1768fractional number of seconds since the epoch. Example:
1502Start the timer. 1806Start the timer.
1503 1807
1504=item $timer = $timer->start ($tstamp) 1808=item $timer = $timer->start ($tstamp)
1505 1809
1506Set the event trigger time to C<$tstamp> and start the timer. 1810Set the event trigger time to C<$tstamp> and start the timer.
1811
1812=item $timer = $timer->after ($delay)
1813
1814Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1507 1815
1508=item $timer = $timer->stop 1816=item $timer = $timer->stop
1509 1817
1510Stop the timer. 1818Stop the timer.
1511 1819
1558 1866
1559Stop watching for events on the given filehandle. 1867Stop watching for events on the given filehandle.
1560 1868
1561=back 1869=back
1562 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
1563=head1 ENVIRONMENT 1932=head1 ENVIRONMENT
1564 1933
1565=head2 URXVT_PERL_VERBOSITY 1934=head2 URXVT_PERL_VERBOSITY
1566 1935
1567This variable controls the verbosity level of the perl extension. Higher 1936This variable controls the verbosity level of the perl extension. Higher
1571 1940
1572=item == 0 - fatal messages 1941=item == 0 - fatal messages
1573 1942
1574=item >= 3 - script loading and management 1943=item >= 3 - script loading and management
1575 1944
1576=item >=10 - all events received 1945=item >=10 - all called hooks
1946
1947=item >=11 - hook reutrn values
1577 1948
1578=back 1949=back
1579 1950
1580=head1 AUTHOR 1951=head1 AUTHOR
1581 1952

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines