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.79 by root, Wed Jan 11 02:13:56 2006 UTC vs.
Revision 1.122 by root, Sat Jan 21 08:07:38 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
175To avoid too many false positives, this is only done when:
176
177=over 4
178
179=item - the mouse is on the same (multi-row-) line as the text cursor.
180
181=item - the primary screen is currently being displayed.
182
183=item - the text cursor is visible.
184
185=back
186
187The normal selection mechanism isn't disabled, so quick successive clicks
188might interfere with selection creation in harmless ways.
189
190=item tabbed
191
192This transforms the terminal into a tabbar with additional terminals, that
193is, it implements what is commonly refered to as "tabbed terminal". The topmost line
194displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
195button per tab.
196
197Clicking a button will activate that tab. Pressing B<Shift-Left> and
198B<Shift-Right> will switch to the tab left or right of the current one,
199while B<Shift-Down> creates a new tab.
86 200
87=item mark-urls 201=item mark-urls
88 202
89Uses per-line display filtering (C<on_line_update>) to underline urls and 203Uses per-line display filtering (C<on_line_update>) to underline urls and
90make them clickable. When clicked, the program specified in the resource 204make them clickable. When middle-clicked, the program specified in the
91C<urlLauncher> (default C<x-www-browser>) will be started. 205resource C<urlLauncher> (default C<x-www-browser>) will be started with
206the URL as first argument.
207
208=item automove-background
209
210This is basically a one-line extension that dynamically changes the background pixmap offset
211to the window position, in effect creating the same effect as pseudo transparency with
212a custom pixmap. No scaling is supported in this mode. Exmaple:
213
214 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
92 215
93=item block-graphics-to-ascii 216=item block-graphics-to-ascii
94 217
95A not very useful example of filtering all text output to the terminal, 218A not very useful example of filtering all text output to the terminal,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 219by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 220similar-looking ascii character.
98 221
222=item digital-clock
223
224Displays a digital clock using the built-in overlay.
225
99=item example-refresh-hooks 226=item example-refresh-hooks
100 227
101Displays a very simple digital clock in the upper right corner of the 228Displays a very simple digital clock in the upper right corner of the
102window. Illustrates overwriting the refresh callbacks to create your own 229window. Illustrates overwriting the refresh callbacks to create your own
103overlays or changes. 230overlays or changes.
231
232=item selection-pastebin
233
234This is a little rarely useful extension that Uploads the selection as
235textfile to a remote site (or does other things). (The implementation is
236not currently secure for use in a multiuser environment as it writes to
237F</tmp> directly.).
238
239It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
240i.e.
241
242 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
243
244Pressing this combination runs a command with C<%> replaced by the name of
245the textfile. This command can be set via a resource:
246
247 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
248
249And the default is likely not useful to anybody but the few people around
250here :)
251
252The name of the textfile is the hex encoded md5 sum of the selection, so
253the same content should lead to the same filename.
254
255After a successful upload the selection will be replaced by the text given
256in the C<selection-pastebin-url> resource (again, the % is the placeholder
257for the filename):
258
259 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
104 260
105=back 261=back
106 262
107=head1 API DOCUMENTATION 263=head1 API DOCUMENTATION
108 264
181called whenever the relevant event happens. 337called whenever the relevant event happens.
182 338
183The first argument passed to them is an extension oject as described in 339The first argument passed to them is an extension oject as described in
184the in the C<Extension Objects> section. 340the in the C<Extension Objects> section.
185 341
186B<All> of these hooks must return a boolean value. If it is true, then the 342B<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 343hooks 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. 344relevant action might not be carried out by the C++ code.
189 345
190I<< When in doubt, return a false value (preferably C<()>). >> 346I<< When in doubt, return a false value (preferably C<()>). >>
191 347
192=over 4 348=over 4
193 349
194=item on_init $term 350=item on_init $term
195 351
196Called after a new terminal object has been initialized, but before 352Called after a new terminal object has been initialized, but before
197windows are created or the command gets run. Most methods are unsafe to 353windows are created or the command gets run. Most methods are unsafe to
198call or deliver senseless data, as terminal size and other characteristics 354call or deliver senseless data, as terminal size and other characteristics
199have not yet been determined. You can safely query and change resources, 355have not yet been determined. You can safely query and change resources
200though. 356and options, though. For many purposes the C<on_start> hook is a better
357place.
358
359=item on_start $term
360
361Called at the very end of initialisation of a new terminal, just before
362trying to map (display) the toplevel and returning to the mainloop.
363
364=item on_destroy $term
365
366Called whenever something tries to destroy terminal, before doing anything
367yet. If this hook returns true, then destruction is skipped, but this is
368rarely a good idea.
201 369
202=item on_reset $term 370=item on_reset $term
203 371
204Called after the screen is "reset" for any reason, such as resizing or 372Called 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 373control sequences. Here is where you can react on changes to size-related
206variables. 374variables.
207 375
208=item on_start $term 376=item on_child_start $term, $pid
209 377
210Called at the very end of initialisation of a new terminal, just before 378Called just after the child process has been C<fork>ed.
211returning to the mainloop. 379
380=item on_child_exit $term, $status
381
382Called just after the child process has exited. C<$status> is the status
383from C<waitpid>.
212 384
213=item on_sel_make $term, $eventtime 385=item on_sel_make $term, $eventtime
214 386
215Called whenever a selection has been made by the user, but before the 387Called 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 388selection text is copied, so changes to the beginning, end or type of the
230=item on_sel_extend $term 402=item on_sel_extend $term
231 403
232Called whenever the user tries to extend the selection (e.g. with a double 404Called whenever the user tries to extend the selection (e.g. with a double
233click) and is either supposed to return false (normal operation), or 405click) and is either supposed to return false (normal operation), or
234should extend the selection itelf and return true to suppress the built-in 406should extend the selection itelf and return true to suppress the built-in
235processing. 407processing. This can happen multiple times, as long as the callback
408returns true, it will be called on every further click by the user and is
409supposed to enlarge the selection more and more, if possible.
236 410
237See the F<selection> example extension. 411See the F<selection> example extension.
238 412
239=item on_view_change $term, $offset 413=item on_view_change $term, $offset
240 414
307 481
308Called whenever the user presses a key combination that has a 482Called whenever the user presses a key combination that has a
309C<perl:string> action bound to it (see description of the B<keysym> 483C<perl:string> action bound to it (see description of the B<keysym>
310resource in the @@RXVT_NAME@@(1) manpage). 484resource in the @@RXVT_NAME@@(1) manpage).
311 485
486=item on_x_event $term, $event
487
488Called on every X event received on the vt window (and possibly other
489windows). Should only be used as a last resort. Most event structure
490members are not passed.
491
312=item on_focus_in $term 492=item on_focus_in $term
313 493
314Called whenever the window gets the keyboard focus, before rxvt-unicode 494Called whenever the window gets the keyboard focus, before rxvt-unicode
315does focus in processing. 495does focus in processing.
316 496
317=item on_focus_out $term 497=item on_focus_out $term
318 498
319Called wheneever the window loses keyboard focus, before rxvt-unicode does 499Called wheneever the window loses keyboard focus, before rxvt-unicode does
320focus out processing. 500focus out processing.
321 501
502=item on_configure_notify $term, $event
503
504=item on_property_notify $term, $event
505
322=item on_key_press $term, $event, $keysym, $octets 506=item on_key_press $term, $event, $keysym, $octets
323 507
324=item on_key_release $term, $event, $keysym 508=item on_key_release $term, $event, $keysym
325 509
326=item on_button_press $term, $event 510=item on_button_press $term, $event
335 519
336Called whenever the corresponding X event is received for the terminal If 520Called whenever the corresponding X event is received for the terminal If
337the hook returns true, then the even will be ignored by rxvt-unicode. 521the hook returns true, then the even will be ignored by rxvt-unicode.
338 522
339The event is a hash with most values as named by Xlib (see the XEvent 523The 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 524manpage), with the additional members C<row> and C<col>, which are the
341and column under the mouse cursor. 525(real, not screen-based) row and column under the mouse cursor.
342 526
343C<on_key_press> additionally receives the string rxvt-unicode would 527C<on_key_press> additionally receives the string rxvt-unicode would
344output, if any, in locale-specific encoding. 528output, if any, in locale-specific encoding.
345 529
346subwindow. 530subwindow.
531
532=item on_client_message $term, $event
533
534=item on_wm_protocols $term, $event
535
536=item on_wm_delete_window $term, $event
537
538Called when various types of ClientMessage events are received (all with
539format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
347 540
348=back 541=back
349 542
350=cut 543=cut
351 544
357use Scalar::Util (); 550use Scalar::Util ();
358use List::Util (); 551use List::Util ();
359 552
360our $VERSION = 1; 553our $VERSION = 1;
361our $TERM; 554our $TERM;
555our @TERM_INIT;
556our @TERM_EXT;
362our @HOOKNAME; 557our @HOOKNAME;
363our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 558our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364our %OPTION; 559our %OPTION;
365 560
366our $LIBDIR; 561our $LIBDIR;
367our $RESNAME; 562our $RESNAME;
368our $RESCLASS; 563our $RESCLASS;
369our $RXVTNAME; 564our $RXVTNAME;
370 565
566our $NOCHAR = chr 0xfffe;
567
371=head2 Variables in the C<urxvt> Package 568=head2 Variables in the C<urxvt> Package
372 569
373=over 4 570=over 4
374 571
375=item $urxvt::LIBDIR 572=item $urxvt::LIBDIR
387 584
388=item $urxvt::TERM 585=item $urxvt::TERM
389 586
390The current terminal. This variable stores the current C<urxvt::term> 587The current terminal. This variable stores the current C<urxvt::term>
391object, whenever a callback/hook is executing. 588object, whenever a callback/hook is executing.
589
590=item @urxvt::TERM_INIT
591
592All coderefs in this array will be called as methods of the next newly
593created C<urxvt::term> object (during the C<on_init> phase). The array
594gets cleared before the codereferences that were in it are being executed,
595so coderefs can push themselves onto it again if they so desire.
596
597This complements to the perl-eval commandline option, but gets executed
598first.
599
600=item @urxvt::TERM_EXT
601
602Works similar to C<@TERM_INIT>, but contains perl package/class names, which
603get registered as normal extensions after calling the hooks in C<@TERM_INIT>
604but before other extensions. Gets cleared just like C<@TERM_INIT>.
392 605
393=back 606=back
394 607
395=head2 Functions in the C<urxvt> Package 608=head2 Functions in the C<urxvt> Package
396 609
411Using this function has the advantage that its output ends up in the 624Using this function has the advantage that its output ends up in the
412correct place, e.g. on stderr of the connecting urxvtc client. 625correct place, e.g. on stderr of the connecting urxvtc client.
413 626
414Messages have a size limit of 1023 bytes currently. 627Messages have a size limit of 1023 bytes currently.
415 628
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 629=item $time = urxvt::NOW
423 630
424Returns the "current time" (as per the event loop). 631Returns the "current time" (as per the event loop).
425 632
426=item urxvt::CurrentTime 633=item urxvt::CurrentTime
427 634
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 635=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 636Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier 637Button4Mask, Button5Mask, AnyModifier
638
639=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
640ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
641PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
642Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
643KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
644ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
645FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
646
647=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
648EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
649GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
650UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
651ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
652CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
653SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431 654
432Various constants for use in X calls and event processing. 655Various constants for use in X calls and event processing.
433 656
434=back 657=back
435 658
486=back 709=back
487 710
488=cut 711=cut
489 712
490BEGIN { 713BEGIN {
491 urxvt->bootstrap;
492
493 # overwrite perl's warn 714 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub { 715 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_; 716 my $msg = join "", @_;
496 $msg .= "\n" 717 $msg .= "\n"
497 unless $msg =~ /\n$/; 718 unless $msg =~ /\n$/;
498 urxvt::warn ($msg); 719 urxvt::warn ($msg);
499 }; 720 };
500
501 delete $ENV{IFS};
502 delete $ENV{CDPATH};
503 delete $ENV{BASH_ENV};
504 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
505} 721}
506 722
507my @hook_count;
508my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 723my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
509 724
510sub verbose { 725sub verbose {
511 my ($level, $msg) = @_; 726 my ($level, $msg) = @_;
512 warn "$msg\n" if $level <= $verbosity; 727 warn "$msg\n" if $level <= $verbosity;
513} 728}
514 729
515my $extension_pkg = "extension0000";
516my %extension_pkg; 730my %extension_pkg;
517 731
518# load a single script into its own package, once only 732# load a single script into its own package, once only
519sub extension_package($) { 733sub extension_package($) {
520 my ($path) = @_; 734 my ($path) = @_;
521 735
522 $extension_pkg{$path} ||= do { 736 $extension_pkg{$path} ||= do {
523 my $pkg = "urxvt::" . ($extension_pkg++); 737 $path =~ /([^\/\\]+)$/;
738 my $pkg = $1;
739 $pkg =~ s/[^[:word:]]/_/g;
740 $pkg = "urxvt::ext::$pkg";
524 741
525 verbose 3, "loading extension '$path' into package '$pkg'"; 742 verbose 3, "loading extension '$path' into package '$pkg'";
526 743
527 open my $fh, "<:raw", $path 744 open my $fh, "<:raw", $path
528 or die "$path: $!"; 745 or die "$path: $!";
529 746
530 my $source = untaint 747 my $source =
531 "package $pkg; use strict; use utf8;\n" 748 "package $pkg; use strict; use utf8;\n"
532 . "use base urxvt::term::extension::;\n"
533 . "#line 1 \"$path\"\n{\n" 749 . "#line 1 \"$path\"\n{\n"
534 . (do { local $/; <$fh> }) 750 . (do { local $/; <$fh> })
535 . "\n};\n1"; 751 . "\n};\n1";
536 752
537 eval $source 753 eval $source
551 if ($htype == 0) { # INIT 767 if ($htype == 0) { # INIT
552 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 768 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
553 769
554 my %ext_arg; 770 my %ext_arg;
555 771
772 {
773 my @init = @TERM_INIT;
774 @TERM_INIT = ();
775 $_->($TERM) for @init;
776 my @pkg = @TERM_EXT;
777 @TERM_EXT = ();
778 $TERM->register_package ($_) for @pkg;
779 }
780
556 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 781 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
557 if ($_ eq "default") { 782 if ($_ eq "default") {
558 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 783 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
559 } elsif (/^-(.*)$/) { 784 } elsif (/^-(.*)$/) {
560 delete $ext_arg{$1}; 785 delete $ext_arg{$1};
561 } elsif (/^([^<]+)<(.*)>$/) { 786 } elsif (/^([^<]+)<(.*)>$/) {
586 if $verbosity >= 10; 811 if $verbosity >= 10;
587 812
588 keys %$cb; 813 keys %$cb;
589 814
590 while (my ($pkg, $cb) = each %$cb) { 815 while (my ($pkg, $cb) = each %$cb) {
591 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 816 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
592 and last; 817 $retval ||= $retval_;
593 818
594 if ($@) { 819 if ($@) {
595 $TERM->ungrab; # better to lose the grab than the session 820 $TERM->ungrab; # better to lose the grab than the session
596 warn $@; 821 warn $@;
597 } 822 }
598 } 823 }
824
825 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
826 if $verbosity >= 11;
599 } 827 }
600 828
601 if ($htype == 1) { # DESTROY 829 if ($htype == 1) { # DESTROY
602 if (my $hook = delete $TERM->{_hook}) {
603 for my $htype (0..$#$hook) {
604 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
605 or set_should_invoke $htype, 0;
606 }
607 }
608
609 # clear package objects 830 # clear package objects
610 %$_ = () for values %{ $TERM->{_pkg} }; 831 %$_ = () for values %{ $TERM->{_pkg} };
611 832
612 # clear package 833 # clear package
613 %$TERM = (); 834 %$TERM = ();
627 while (my ($name, $cb) = each %hook) { 848 while (my ($name, $cb) = each %hook) {
628 my $htype = $HOOKTYPE{uc $name}; 849 my $htype = $HOOKTYPE{uc $name};
629 defined $htype 850 defined $htype
630 or Carp::croak "unsupported hook type '$name'"; 851 or Carp::croak "unsupported hook type '$name'";
631 852
853 $self->set_should_invoke ($htype, +1)
632 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 854 unless exists $self->{term}{_hook}[$htype]{$pkg};
633 $hook_count[$htype]++
634 or urxvt::set_should_invoke $htype, 1;
635 }
636 855
637 $self->{term}{_hook}[$htype]{$pkg} = $cb; 856 $self->{term}{_hook}[$htype]{$pkg} = $cb;
638 } 857 }
639} 858}
640 859
645 for my $name (@hook) { 864 for my $name (@hook) {
646 my $htype = $HOOKTYPE{uc $name}; 865 my $htype = $HOOKTYPE{uc $name};
647 defined $htype 866 defined $htype
648 or Carp::croak "unsupported hook type '$name'"; 867 or Carp::croak "unsupported hook type '$name'";
649 868
869 $self->set_should_invoke ($htype, -1)
650 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 870 if delete $self->{term}{_hook}[$htype]{$pkg};
651 --$hook_count[$htype]
652 or urxvt::set_should_invoke $htype, 0;
653 }
654 } 871 }
655} 872}
656 873
657our $AUTOLOAD; 874our $AUTOLOAD;
658 875
764# find on_xxx subs in the package and register them 981# find on_xxx subs in the package and register them
765# as hooks 982# as hooks
766sub register_package { 983sub register_package {
767 my ($self, $pkg, $argv) = @_; 984 my ($self, $pkg, $argv) = @_;
768 985
986 no strict 'refs';
987
988 urxvt::verbose 6, "register package $pkg to $self";
989
990 @{"$pkg\::ISA"} = urxvt::term::extension::;
991
769 my $proxy = bless { 992 my $proxy = bless {
770 _pkg => $pkg, 993 _pkg => $pkg,
771 argv => $argv, 994 argv => $argv,
772 }, $pkg; 995 }, $pkg;
773 Scalar::Util::weaken ($proxy->{term} = $self); 996 Scalar::Util::weaken ($proxy->{term} = $self);
804 1027
805Destroy the terminal object (close the window, free resources 1028Destroy the terminal object (close the window, free resources
806etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1029etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
807watchers (timers, io watchers) are still active. 1030watchers (timers, io watchers) are still active.
808 1031
1032=item $term->exec_async ($cmd[, @args])
1033
1034Works like the combination of the C<fork>/C<exec> builtins, which executes
1035("starts") programs in the background. This function takes care of setting
1036the user environment before exec'ing the command (e.g. C<PATH>) and should
1037be preferred over explicit calls to C<exec> or C<system>.
1038
1039Returns the pid of the subprocess or C<undef> on error.
1040
1041=cut
1042
1043sub exec_async {
1044 my $self = shift;
1045
1046 my $pid = fork;
1047
1048 return $pid
1049 if !defined $pid or $pid;
1050
1051 %ENV = %{ $self->env };
1052
1053 exec @_;
1054 urxvt::_exit 255;
1055}
1056
809=item $isset = $term->option ($optval[, $set]) 1057=item $isset = $term->option ($optval[, $set])
810 1058
811Returns true if the option specified by C<$optval> is enabled, and 1059Returns true if the option specified by C<$optval> is enabled, and
812optionally change it. All option values are stored by name in the hash 1060optionally change it. All option values are stored by name in the hash
813C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1061C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
815Here is a a likely non-exhaustive list of option names, please see the 1063Here is a a likely non-exhaustive list of option names, please see the
816source file F</src/optinc.h> to see the actual list: 1064source file F</src/optinc.h> to see the actual list:
817 1065
818 borderLess console cursorBlink cursorUnderline hold iconic insecure 1066 borderLess console cursorBlink cursorUnderline hold iconic insecure
819 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1067 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
820 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1068 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
821 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1069 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
822 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1070 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
823 tripleclickwords utmpInhibit visualBell 1071 transparent tripleclickwords utmpInhibit visualBell
824 1072
825=item $value = $term->resource ($name[, $newval]) 1073=item $value = $term->resource ($name[, $newval])
826 1074
827Returns the current resource value associated with a given name and 1075Returns the current resource value associated with a given name and
828optionally sets a new value. Setting values is most useful in the C<init> 1076optionally sets a new value. Setting values is most useful in the C<init>
845 1093
846 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1094 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
847 borderLess color cursorBlink cursorUnderline cutchars delete_key 1095 borderLess color cursorBlink cursorUnderline cutchars delete_key
848 display_name embed ext_bwidth fade font geometry hold iconName 1096 display_name embed ext_bwidth fade font geometry hold iconName
849 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1097 imFont imLocale inputMethod insecure int_bwidth intensityStyles
850 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1098 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
851 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1099 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
852 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1100 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
853 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1101 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
854 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1102 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
855 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1103 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
856 shade term_name title transparent transparent_all tripleclickwords 1104 secondaryScreen secondaryScroll selectstyle shade term_name title
857 utmpInhibit visualBell 1105 transient_for transparent transparent_all tripleclickwords utmpInhibit
1106 visualBell
858 1107
859=cut 1108=cut
860 1109
861sub resource($$;$) { 1110sub resource($$;$) {
862 my ($self, $name) = (shift, shift); 1111 my ($self, $name) = (shift, shift);
897=item ($row, $col) = $term->selection_end ([$row, $col]) 1146=item ($row, $col) = $term->selection_end ([$row, $col])
898 1147
899Return the current values of the selection mark, begin or end positions, 1148Return the current values of the selection mark, begin or end positions,
900and optionally set them to new values. 1149and optionally set them to new values.
901 1150
1151=item $term->selection_make ($eventtime[, $rectangular])
1152
1153Tries to make a selection as set by C<selection_beg> and
1154C<selection_end>. If C<$rectangular> is true (default: false), a
1155rectangular selection will be made. This is the prefered function to make
1156a selection.
1157
902=item $success = $term->selection_grab ($eventtime) 1158=item $success = $term->selection_grab ($eventtime)
903 1159
904Try to request the primary selection from the server (for example, as set 1160Try to request the primary selection text from the server (for example, as
905by the next method). 1161set by the next method). No visual feedback will be given. This function
1162is mostly useful from within C<on_sel_grab> hooks.
906 1163
907=item $oldtext = $term->selection ([$newtext]) 1164=item $oldtext = $term->selection ([$newtext])
908 1165
909Return the current selection text and optionally replace it by C<$newtext>. 1166Return the current selection text and optionally replace it by C<$newtext>.
910 1167
1003Convert the given locale-encoded octets into a perl string. 1260Convert the given locale-encoded octets into a perl string.
1004 1261
1005=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1262=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1006 1263
1007XORs the rendition values in the given span with the provided value 1264XORs the rendition values in the given span with the provided value
1008(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1265(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1009to the selection. 1266refresh hooks to provide effects similar to the selection.
1010 1267
1011=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1268=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1012 1269
1013Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1270Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1014whitespace will additionally be xored with the C<$rstyle2>, which defaults 1271whitespace will additionally be xored with the C<$rstyle2>, which defaults
1015to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1272to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1016it instead. 1273it instead. Both styles I<MUST NOT> contain font styles.
1017 1274
1018=item $term->scr_bell 1275=item $term->scr_bell
1019 1276
1020Ring the bell! 1277Ring the bell!
1021 1278
1028 1285
1029Normally its not a good idea to use this function, as programs might be 1286Normally its not a good idea to use this function, as programs might be
1030confused by changes in cursor position or scrolling. Its useful inside a 1287confused by changes in cursor position or scrolling. Its useful inside a
1031C<on_add_lines> hook, though. 1288C<on_add_lines> hook, though.
1032 1289
1290=item $term->scr_change_screen ($screen)
1291
1292Switch to given screen - 0 primary, 1 secondary.
1293
1033=item $term->cmd_parse ($octets) 1294=item $term->cmd_parse ($octets)
1034 1295
1035Similar to C<scr_add_lines>, but the argument must be in the 1296Similar to C<scr_add_lines>, but the argument must be in the
1036locale-specific encoding of the terminal and can contain command sequences 1297locale-specific encoding of the terminal and can contain command sequences
1037(escape codes) that will be interpreted. 1298(escape codes) that will be interpreted.
1055 1316
1056=item $windowid = $term->vt 1317=item $windowid = $term->vt
1057 1318
1058Return the window id of the terminal window. 1319Return the window id of the terminal window.
1059 1320
1321=item $term->vt_emask_add ($x_event_mask)
1322
1323Adds the specified events to the vt event mask. Useful e.g. when you want
1324to receive pointer events all the times:
1325
1326 $term->vt_emask_add (urxvt::PointerMotionMask);
1327
1060=item $window_width = $term->width 1328=item $window_width = $term->width
1061 1329
1062=item $window_height = $term->height 1330=item $window_height = $term->height
1063 1331
1064=item $font_width = $term->fwidth 1332=item $font_width = $term->fwidth
1077 1345
1078=item $max_scrollback = $term->saveLines 1346=item $max_scrollback = $term->saveLines
1079 1347
1080=item $nrow_plus_saveLines = $term->total_rows 1348=item $nrow_plus_saveLines = $term->total_rows
1081 1349
1082=item $lines_in_scrollback = $term->nsaved 1350=item $topmost_scrollback_row = $term->top_row
1083 1351
1084Return various integers describing terminal characteristics. 1352Return various integers describing terminal characteristics.
1085 1353
1086=item $x_display = $term->display_id 1354=item $x_display = $term->display_id
1087 1355
1113=item $modifiermask = $term->ModNumLockMask 1381=item $modifiermask = $term->ModNumLockMask
1114 1382
1115Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1383Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1116AltGr), the meta key (often Alt) and the num lock key, if applicable. 1384AltGr), the meta key (often Alt) and the num lock key, if applicable.
1117 1385
1386=item $screen = $term->current_screen
1387
1388Returns the currently displayed screen (0 primary, 1 secondary).
1389
1390=item $cursor_is_hidden = $term->hidden_cursor
1391
1392Returns wether the cursor is currently hidden or not.
1393
1118=item $view_start = $term->view_start ([$newvalue]) 1394=item $view_start = $term->view_start ([$newvalue])
1119 1395
1120Returns the negative row number of the topmost line. Minimum value is 1396Returns the row number of the topmost displayed line. Maximum value is
1121C<0>, which displays the normal terminal contents. Larger values scroll 1397C<0>, which displays the normal terminal contents. Lower values scroll
1122this many lines into the scrollback buffer. 1398this many lines into the scrollback buffer.
1123 1399
1124=item $term->want_refresh 1400=item $term->want_refresh
1125 1401
1126Requests a screen refresh. At the next opportunity, rxvt-unicode will 1402Requests a screen refresh. At the next opportunity, rxvt-unicode will
1140If C<$new_text> is specified, it will replace characters in the current 1416If C<$new_text> is specified, it will replace characters in the current
1141line, starting at column C<$start_col> (default C<0>), which is useful 1417line, starting at column C<$start_col> (default C<0>), which is useful
1142to replace only parts of a line. The font index in the rendition will 1418to replace only parts of a line. The font index in the rendition will
1143automatically be updated. 1419automatically be updated.
1144 1420
1145C<$text> is in a special encoding: tabs and wide characters that use more 1421C<$text> is in a special encoding: tabs and wide characters that use
1146than one cell when displayed are padded with urxvt::NOCHAR characters 1422more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1147(C<chr 65535>). Characters with combining characters and other characters 1423characters. Characters with combining characters and other characters that
1148that do not fit into the normal tetx encoding will be replaced with 1424do not fit into the normal tetx encoding will be replaced with characters
1149characters in the private use area. 1425in the private use area.
1150 1426
1151You have to obey this encoding when changing text. The advantage is 1427You have to obey this encoding when changing text. The advantage is
1152that C<substr> and similar functions work on screen cells and not on 1428that C<substr> and similar functions work on screen cells and not on
1153characters. 1429characters.
1154 1430
1205Return the row number of the first/last row of the line, respectively. 1481Return the row number of the first/last row of the line, respectively.
1206 1482
1207=item $offset = $line->offset_of ($row, $col) 1483=item $offset = $line->offset_of ($row, $col)
1208 1484
1209Returns the character offset of the given row|col pair within the logical 1485Returns the character offset of the given row|col pair within the logical
1210line. 1486line. Works for rows outside the line, too, and returns corresponding
1487offsets outside the string.
1211 1488
1212=item ($row, $col) = $line->coord_of ($offset) 1489=item ($row, $col) = $line->coord_of ($offset)
1213 1490
1214Translates a string offset into terminal coordinates again. 1491Translates a string offset into terminal coordinates again.
1215 1492
1328 1605
1329Calls XUngrab for the most recent grab. Is called automatically on 1606Calls XUngrab for the most recent grab. Is called automatically on
1330evaluation errors, as it is better to lose the grab in the error case as 1607evaluation errors, as it is better to lose the grab in the error case as
1331the session. 1608the session.
1332 1609
1610=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1611
1612=item $atom_name = $term->XGetAtomName ($atom)
1613
1614=item @atoms = $term->XListProperties ($window)
1615
1616=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1617
1618=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1619
1620=item $term->XDeleteProperty ($window, $property)
1621
1622=item $window = $term->DefaultRootWindow
1623
1624=item $term->XReparentWindow ($window, $parent, [$x, $y])
1625
1626=item $term->XMapWindow ($window)
1627
1628=item $term->XUnmapWindow ($window)
1629
1630=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1631
1632=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1633
1634=item $term->XChangeInput ($window, $add_events[, $del_events])
1635
1636Various X or X-related functions. The C<$term> object only serves as
1637the source of the display, otherwise those functions map more-or-less
1638directory onto the X functions of the same name.
1639
1333=back 1640=back
1334 1641
1335=cut 1642=cut
1336 1643
1337package urxvt::popup; 1644package urxvt::popup;
1438 my $env = $self->{term}->env; 1745 my $env = $self->{term}->env;
1439 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1746 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1440 delete $env->{LC_ALL}; 1747 delete $env->{LC_ALL};
1441 $env->{LC_CTYPE} = $self->{term}->locale; 1748 $env->{LC_CTYPE} = $self->{term}->locale;
1442 1749
1443 urxvt::term->new ($env, $self->{term}->resource ("name"), 1750 urxvt::term->new ($env, "popup",
1444 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1751 "--perl-lib" => "", "--perl-ext-common" => "",
1752 "-pty-fd" => -1, "-sl" => 0,
1753 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1445 "--transient-for" => $self->{term}->parent, 1754 "--transient-for" => $self->{term}->parent,
1446 "-display" => $self->{term}->display_id, 1755 "-display" => $self->{term}->display_id,
1447 "-pe" => "urxvt-popup") 1756 "-pe" => "urxvt-popup")
1448 or die "unable to create popup window\n"; 1757 or die "unable to create popup window\n";
1449} 1758}
1454 delete $self->{term}{_destroy}{$self}; 1763 delete $self->{term}{_destroy}{$self};
1455 $self->{term}->ungrab; 1764 $self->{term}->ungrab;
1456} 1765}
1457 1766
1458=back 1767=back
1768
1769=cut
1770
1771package urxvt::watcher;
1772
1773@urxvt::timer::ISA = __PACKAGE__;
1774@urxvt::iow::ISA = __PACKAGE__;
1775@urxvt::pw::ISA = __PACKAGE__;
1776@urxvt::iw::ISA = __PACKAGE__;
1459 1777
1460=head2 The C<urxvt::timer> Class 1778=head2 The C<urxvt::timer> Class
1461 1779
1462This class implements timer watchers/events. Time is represented as a 1780This class implements timer watchers/events. Time is represented as a
1463fractional number of seconds since the epoch. Example: 1781fractional number of seconds since the epoch. Example:
1501Start the timer. 1819Start the timer.
1502 1820
1503=item $timer = $timer->start ($tstamp) 1821=item $timer = $timer->start ($tstamp)
1504 1822
1505Set the event trigger time to C<$tstamp> and start the timer. 1823Set the event trigger time to C<$tstamp> and start the timer.
1824
1825=item $timer = $timer->after ($delay)
1826
1827Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1506 1828
1507=item $timer = $timer->stop 1829=item $timer = $timer->stop
1508 1830
1509Stop the timer. 1831Stop the timer.
1510 1832
1557 1879
1558Stop watching for events on the given filehandle. 1880Stop watching for events on the given filehandle.
1559 1881
1560=back 1882=back
1561 1883
1884=head2 The C<urxvt::iw> Class
1885
1886This class implements idle watchers, that get called automatically when
1887the process is idle. They should return as fast as possible, after doing
1888some useful work.
1889
1890=over 4
1891
1892=item $iw = new urxvt::iw
1893
1894Create a new idle watcher object in stopped state.
1895
1896=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1897
1898Set the callback to be called when the watcher triggers.
1899
1900=item $timer = $timer->start
1901
1902Start the watcher.
1903
1904=item $timer = $timer->stop
1905
1906Stop the watcher.
1907
1908=back
1909
1910=head2 The C<urxvt::pw> Class
1911
1912This class implements process watchers. They create an event whenever a
1913process exits, after which they stop automatically.
1914
1915 my $pid = fork;
1916 ...
1917 $term->{pw} = urxvt::pw
1918 ->new
1919 ->start ($pid)
1920 ->cb (sub {
1921 my ($pw, $exit_status) = @_;
1922 ...
1923 });
1924
1925=over 4
1926
1927=item $pw = new urxvt::pw
1928
1929Create a new process watcher in stopped state.
1930
1931=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1932
1933Set the callback to be called when the timer triggers.
1934
1935=item $pw = $timer->start ($pid)
1936
1937Tells the wqtcher to start watching for process C<$pid>.
1938
1939=item $pw = $pw->stop
1940
1941Stop the watcher.
1942
1943=back
1944
1562=head1 ENVIRONMENT 1945=head1 ENVIRONMENT
1563 1946
1564=head2 URXVT_PERL_VERBOSITY 1947=head2 URXVT_PERL_VERBOSITY
1565 1948
1566This variable controls the verbosity level of the perl extension. Higher 1949This variable controls the verbosity level of the perl extension. Higher
1570 1953
1571=item == 0 - fatal messages 1954=item == 0 - fatal messages
1572 1955
1573=item >= 3 - script loading and management 1956=item >= 3 - script loading and management
1574 1957
1575=item >=10 - all events received 1958=item >=10 - all called hooks
1959
1960=item >=11 - hook reutrn values
1576 1961
1577=back 1962=back
1578 1963
1579=head1 AUTHOR 1964=head1 AUTHOR
1580 1965

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines