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.69 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.111 by root, Thu Jan 19 19:52:54 2006 UTC

26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31=head2 Prepackaged Extensions 31=head1 PREPACKAGED EXTENSIONS
32 32
33This section describes the extensiosn delivered with this version. You can 33This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 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
44Intelligent selection. This extension tries to be more intelligent when 48(More) intelligent selection. This extension tries to be more intelligent
45the user extends selections (double-click). Right now, it tries to select 49when the user extends selections (double-click and further clicks). Right
46urls and complete shell-quoted arguments, which is very convenient, too, 50now, it tries to select words, urls and complete shell-quoted
47if 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
49It also offers the following bindable event: 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
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
64runtime. 90runtime.
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. 95text into various other formats/action (such as uri unescaping, perl
96evalution, web-browser starting etc.), depending on content.
70 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 };
116
71=item searchable-scrollback (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
72 118
73Adds regex search functionality to the scrollback buffer, triggered by a 119Adds regex search functionality to the scrollback buffer, triggered
74hotkey (default: C<M-s>). When in search mode, terminal input/output is 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
75suspended, C</> starts an incremental regex search, C<n> searches further, 121input/output is suspended and a regex is displayed at the bottom of the
76C<p> jumps to the previous match. C<enter> leaves search mode at the 122screen.
77current position and C<escape> returns to the original position.
78 123
79=item digital-clock 124Inputting characters appends them to the regex and continues incremental
125search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126search upwards/downwards in the scrollback buffer, C<End> jumps to the
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.
80 131
81Displays a digital clock using the built-in overlay. 132=item selection-autotransform
133
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.
82 166
83=item mark-urls 167=item mark-urls
84 168
85Uses per-line display filtering (C<on_line_update>) to underline urls. 169Uses per-line display filtering (C<on_line_update>) to underline urls and
170make them clickable. When middle-clicked, the program specified in the
171resource C<urlLauncher> (default C<x-www-browser>) will be started with
172the URL as first argument.
173
174=item automove-background
175
176This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86 181
87=item block-graphics-to-ascii 182=item block-graphics-to-ascii
88 183
89A not very useful example of filtering all text output to the terminal, 184A not very useful example of filtering all text output to the terminal,
90by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
91similar-looking ascii character. 186similar-looking ascii character.
92 187
188=item digital-clock
189
190Displays a digital clock using the built-in overlay.
191
93=item example-refresh-hooks 192=item example-refresh-hooks
94 193
95Displays a very simple digital clock in the upper right corner of the 194Displays a very simple digital clock in the upper right corner of the
96window. Illustrates overwriting the refresh callbacks to create your own 195window. Illustrates overwriting the refresh callbacks to create your own
97overlays or changes. 196overlays or changes.
98 197
198=item selection-pastebin
199
200This is a little rarely useful extension that Uploads the selection as
201textfile to a remote site (or does other things). (The implementation is
202not currently secure for use in a multiuser environment as it writes to
203F</tmp> directly.).
204
205It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206i.e.
207
208 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210Pressing this combination runs a command with C<%> replaced by the name of
211the textfile. This command can be set via a resource:
212
213 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215And the default is likely not useful to anybody but the few people around
216here :)
217
218The name of the textfile is the hex encoded md5 sum of the selection, so
219the same content should lead to the same filename.
220
221After a successful upload the selection will be replaced by the text given
222in the C<selection-pastebin-url> resource (again, the % is the placeholder
223for the filename):
224
225 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
226
99=back 227=back
228
229=head1 API DOCUMENTATION
100 230
101=head2 General API Considerations 231=head2 General API Considerations
102 232
103All objects (such as terminals, time watchers etc.) are typical 233All objects (such as terminals, time watchers etc.) are typical
104reference-to-hash objects. The hash can be used to store anything you 234reference-to-hash objects. The hash can be used to store anything you
117=over 4 247=over 4
118 248
119=item $text 249=item $text
120 250
121Rxvt-unicodes special way of encoding text, where one "unicode" character 251Rxvt-unicodes special way of encoding text, where one "unicode" character
122always represents one screen cell. See L<row_t> for a discussion of this format. 252always represents one screen cell. See L<ROW_t> for a discussion of this format.
123 253
124=item $string 254=item $string
125 255
126A perl text string, with an emphasis on I<text>. It can store all unicode 256A perl text string, with an emphasis on I<text>. It can store all unicode
127characters and is to be distinguished with text encoded in a specific 257characters and is to be distinguished with text encoded in a specific
200=item on_start $term 330=item on_start $term
201 331
202Called at the very end of initialisation of a new terminal, just before 332Called at the very end of initialisation of a new terminal, just before
203returning to the mainloop. 333returning to the mainloop.
204 334
335=item on_child_start $term, $pid
336
337Called just after the child process has been C<fork>ed.
338
339=item on_child_exit $term, $status
340
341Called just after the child process has exited. C<$status> is the status
342from C<waitpid>.
343
205=item on_sel_make $term, $eventtime 344=item on_sel_make $term, $eventtime
206 345
207Called whenever a selection has been made by the user, but before the 346Called whenever a selection has been made by the user, but before the
208selection text is copied, so changes to the beginning, end or type of the 347selection text is copied, so changes to the beginning, end or type of the
209selection will be honored. 348selection will be honored.
222=item on_sel_extend $term 361=item on_sel_extend $term
223 362
224Called whenever the user tries to extend the selection (e.g. with a double 363Called whenever the user tries to extend the selection (e.g. with a double
225click) and is either supposed to return false (normal operation), or 364click) and is either supposed to return false (normal operation), or
226should extend the selection itelf and return true to suppress the built-in 365should extend the selection itelf and return true to suppress the built-in
227processing. 366processing. This can happen multiple times, as long as the callback
367returns true, it will be called on every further click by the user and is
368supposed to enlarge the selection more and more, if possible.
228 369
229See the F<selection> example extension. 370See the F<selection> example extension.
230 371
231=item on_view_change $term, $offset 372=item on_view_change $term, $offset
232 373
263can filter/change and output the text yourself by returning a true value 404can filter/change and output the text yourself by returning a true value
264and calling C<< $term->scr_add_lines >> yourself. Please note that this 405and calling C<< $term->scr_add_lines >> yourself. Please note that this
265might be very slow, however, as your hook is called for B<all> text being 406might be very slow, however, as your hook is called for B<all> text being
266output. 407output.
267 408
409=item on_tt_write $term, $octets
410
411Called whenever some data is written to the tty/pty and can be used to
412suppress or filter tty input.
413
268=item on_line_update $term, $row 414=item on_line_update $term, $row
269 415
270Called whenever a line was updated or changed. Can be used to filter 416Called whenever a line was updated or changed. Can be used to filter
271screen output (e.g. underline urls or other useless stuff). Only lines 417screen output (e.g. underline urls or other useless stuff). Only lines
272that are being shown will be filtered, and, due to performance reasons, 418that are being shown will be filtered, and, due to performance reasons,
294 440
295Called whenever the user presses a key combination that has a 441Called whenever the user presses a key combination that has a
296C<perl:string> action bound to it (see description of the B<keysym> 442C<perl:string> action bound to it (see description of the B<keysym>
297resource in the @@RXVT_NAME@@(1) manpage). 443resource in the @@RXVT_NAME@@(1) manpage).
298 444
445=item on_x_event $term, $event
446
447Called on every X event received on the vt window (and possibly other
448windows). Should only be used as a last resort. Most event structure
449members are not passed.
450
299=item on_focus_in $term 451=item on_focus_in $term
300 452
301Called whenever the window gets the keyboard focus, before rxvt-unicode 453Called whenever the window gets the keyboard focus, before rxvt-unicode
302does focus in processing. 454does focus in processing.
303 455
304=item on_focus_out $term 456=item on_focus_out $term
305 457
306Called wheneever the window loses keyboard focus, before rxvt-unicode does 458Called wheneever the window loses keyboard focus, before rxvt-unicode does
307focus out processing. 459focus out processing.
460
461=item on_configure_notify $term, $event
308 462
309=item on_key_press $term, $event, $keysym, $octets 463=item on_key_press $term, $event, $keysym, $octets
310 464
311=item on_key_release $term, $event, $keysym 465=item on_key_release $term, $event, $keysym
312 466
329 483
330C<on_key_press> additionally receives the string rxvt-unicode would 484C<on_key_press> additionally receives the string rxvt-unicode would
331output, if any, in locale-specific encoding. 485output, if any, in locale-specific encoding.
332 486
333subwindow. 487subwindow.
334
335=back
336
337=head2 Variables in the C<urxvt> Package
338
339=over 4
340
341=item $urxvt::TERM
342
343The current terminal. This variable stores the current C<urxvt::term>
344object, whenever a callback/hook is executing.
345
346=back
347
348=head2 Functions in the C<urxvt> Package
349
350=over 4
351
352=item $term = new urxvt [arg...]
353
354Creates a new terminal, very similar as if you had started it with
355C<system $binfile, arg...>. Croaks (and probably outputs an error message)
356if the new instance couldn't be created. Returns C<undef> if the new
357instance didn't initialise perl, and the terminal object otherwise. The
358C<init> and C<start> hooks will be called during the call.
359
360=item urxvt::fatal $errormessage
361
362Fatally aborts execution with the given error message. Avoid at all
363costs! The only time this is acceptable is when the terminal process
364starts up.
365
366=item urxvt::warn $string
367
368Calls C<rxvt_warn> with the given string which should not include a
369newline. The module also overwrites the C<warn> builtin with a function
370that calls this function.
371
372Using this function has the advantage that its output ends up in the
373correct place, e.g. on stderr of the connecting urxvtc client.
374
375=item $is_safe = urxvt::safe
376
377Returns true when it is safe to do potentially unsafe things, such as
378evaluating perl code specified by the user. This is true when urxvt was
379started setuid or setgid.
380
381=item $time = urxvt::NOW
382
383Returns the "current time" (as per the event loop).
384
385=item urxvt::CurrentTime
386
387=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
388Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
389Button4Mask, Button5Mask, AnyModifier
390
391Various constants for use in X calls and event processing.
392
393=back
394
395=head2 RENDITION
396
397Rendition bitsets contain information about colour, font, font styles and
398similar information for each screen cell.
399
400The following "macros" deal with changes in rendition sets. You should
401never just create a bitset, you should always modify an existing one,
402as they contain important information required for correct operation of
403rxvt-unicode.
404
405=over 4
406
407=item $rend = urxvt::DEFAULT_RSTYLE
408
409Returns the default rendition, as used when the terminal is starting up or
410being reset. Useful as a base to start when creating renditions.
411
412=item $rend = urxvt::OVERLAY_RSTYLE
413
414Return the rendition mask used for overlays by default.
415
416=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
417
418Return the bit that enabled bold, italic, blink, reverse-video and
419underline, respectively. To enable such a style, just logically OR it into
420the bitset.
421
422=item $foreground = urxvt::GET_BASEFG $rend
423
424=item $background = urxvt::GET_BASEBG $rend
425
426Return the foreground/background colour index, respectively.
427
428=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
429
430=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
431
432Replace the foreground/background colour in the rendition mask with the
433specified one.
434
435=item $value = urxvt::GET_CUSTOM ($rend)
436
437Return the "custom" value: Every rendition has 5 bits for use by
438extensions. They can be set and changed as you like and are initially
439zero.
440
441=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
442
443Change the custom value.
444 488
445=back 489=back
446 490
447=cut 491=cut
448 492
457our $VERSION = 1; 501our $VERSION = 1;
458our $TERM; 502our $TERM;
459our @HOOKNAME; 503our @HOOKNAME;
460our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 504our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461our %OPTION; 505our %OPTION;
506
462our $LIBDIR; 507our $LIBDIR;
508our $RESNAME;
509our $RESCLASS;
510our $RXVTNAME;
511
512=head2 Variables in the C<urxvt> Package
513
514=over 4
515
516=item $urxvt::LIBDIR
517
518The rxvt-unicode library directory, where, among other things, the perl
519modules and scripts are stored.
520
521=item $urxvt::RESCLASS, $urxvt::RESCLASS
522
523The resource class and name rxvt-unicode uses to look up X resources.
524
525=item $urxvt::RXVTNAME
526
527The basename of the installed binaries, usually C<urxvt>.
528
529=item $urxvt::TERM
530
531The current terminal. This variable stores the current C<urxvt::term>
532object, whenever a callback/hook is executing.
533
534=back
535
536=head2 Functions in the C<urxvt> Package
537
538=over 4
539
540=item urxvt::fatal $errormessage
541
542Fatally aborts execution with the given error message. Avoid at all
543costs! The only time this is acceptable is when the terminal process
544starts up.
545
546=item urxvt::warn $string
547
548Calls C<rxvt_warn> with the given string which should not include a
549newline. The module also overwrites the C<warn> builtin with a function
550that calls this function.
551
552Using this function has the advantage that its output ends up in the
553correct place, e.g. on stderr of the connecting urxvtc client.
554
555Messages have a size limit of 1023 bytes currently.
556
557=item $time = urxvt::NOW
558
559Returns the "current time" (as per the event loop).
560
561=item urxvt::CurrentTime
562
563=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
564Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
565Button4Mask, Button5Mask, AnyModifier
566
567=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
568ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
569PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
570Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
571KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
572ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
573FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
574
575=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
576EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
577GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
578UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
579ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
580CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
581SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
582
583Various constants for use in X calls and event processing.
584
585=back
586
587=head2 RENDITION
588
589Rendition bitsets contain information about colour, font, font styles and
590similar information for each screen cell.
591
592The following "macros" deal with changes in rendition sets. You should
593never just create a bitset, you should always modify an existing one,
594as they contain important information required for correct operation of
595rxvt-unicode.
596
597=over 4
598
599=item $rend = urxvt::DEFAULT_RSTYLE
600
601Returns the default rendition, as used when the terminal is starting up or
602being reset. Useful as a base to start when creating renditions.
603
604=item $rend = urxvt::OVERLAY_RSTYLE
605
606Return the rendition mask used for overlays by default.
607
608=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
609
610Return the bit that enabled bold, italic, blink, reverse-video and
611underline, respectively. To enable such a style, just logically OR it into
612the bitset.
613
614=item $foreground = urxvt::GET_BASEFG $rend
615
616=item $background = urxvt::GET_BASEBG $rend
617
618Return the foreground/background colour index, respectively.
619
620=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
621
622=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
623
624Replace the foreground/background colour in the rendition mask with the
625specified one.
626
627=item $value = urxvt::GET_CUSTOM $rend
628
629Return the "custom" value: Every rendition has 5 bits for use by
630extensions. They can be set and changed as you like and are initially
631zero.
632
633=item $rend = urxvt::SET_CUSTOM $rend, $new_value
634
635Change the custom value.
636
637=back
638
639=cut
463 640
464BEGIN { 641BEGIN {
465 urxvt->bootstrap;
466
467 # overwrite perl's warn 642 # overwrite perl's warn
468 *CORE::GLOBAL::warn = sub { 643 *CORE::GLOBAL::warn = sub {
469 my $msg = join "", @_; 644 my $msg = join "", @_;
470 $msg .= "\n" 645 $msg .= "\n"
471 unless $msg =~ /\n$/; 646 unless $msg =~ /\n$/;
472 urxvt::warn ($msg); 647 urxvt::warn ($msg);
473 }; 648 };
474
475 delete $ENV{IFS};
476 delete $ENV{CDPATH};
477 delete $ENV{BASH_ENV};
478 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
479} 649}
480 650
481my @hook_count;
482my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 651my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
483 652
484sub verbose { 653sub verbose {
485 my ($level, $msg) = @_; 654 my ($level, $msg) = @_;
486 warn "$msg\n" if $level <= $verbosity; 655 warn "$msg\n" if $level <= $verbosity;
487} 656}
488 657
489my $extension_pkg = "extension0000";
490my %extension_pkg; 658my %extension_pkg;
491 659
492# load a single script into its own package, once only 660# load a single script into its own package, once only
493sub extension_package($) { 661sub extension_package($) {
494 my ($path) = @_; 662 my ($path) = @_;
495 663
664 no strict 'refs';
665
496 $extension_pkg{$path} ||= do { 666 $extension_pkg{$path} ||= do {
497 my $pkg = "urxvt::" . ($extension_pkg++); 667 $path =~ /([^\/\\]+)$/;
668 my $pkg = $1;
669 $pkg =~ s/[^[:word:]]/_/g;
670 $pkg = "urxvt::ext::$pkg";
498 671
499 verbose 3, "loading extension '$path' into package '$pkg'"; 672 verbose 3, "loading extension '$path' into package '$pkg'";
500 673
501 open my $fh, "<:raw", $path 674 open my $fh, "<:raw", $path
502 or die "$path: $!"; 675 or die "$path: $!";
503 676
677 @{"$pkg\::ISA"} = urxvt::term::extension::;
678
504 my $source = untaint 679 my $source =
505 "package $pkg; use strict; use utf8;\n" 680 "package $pkg; use strict; use utf8;\n"
506 . "use base urxvt::term::proxy::;\n"
507 . "#line 1 \"$path\"\n{\n" 681 . "#line 1 \"$path\"\n{\n"
508 . (do { local $/; <$fh> }) 682 . (do { local $/; <$fh> })
509 . "\n};\n1"; 683 . "\n};\n1";
510 684
511 eval $source 685 eval $source
568 if ($@) { 742 if ($@) {
569 $TERM->ungrab; # better to lose the grab than the session 743 $TERM->ungrab; # better to lose the grab than the session
570 warn $@; 744 warn $@;
571 } 745 }
572 } 746 }
747
748 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
749 if $verbosity >= 11;
573 } 750 }
574 751
575 if ($htype == 1) { # DESTROY 752 if ($htype == 1) { # DESTROY
576 if (my $hook = delete $TERM->{_hook}) {
577 for my $htype (0..$#$hook) {
578 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
579 or set_should_invoke $htype, 0;
580 }
581 }
582
583 # clear package objects 753 # clear package objects
584 %$_ = () for values %{ $TERM->{_pkg} }; 754 %$_ = () for values %{ $TERM->{_pkg} };
585 755
586 # clear package 756 # clear package
587 %$TERM = (); 757 %$TERM = ();
588 } 758 }
589 759
590 $retval 760 $retval
591} 761}
592 762
593# urxvt::term::proxy 763# urxvt::term::extension
594 764
595package urxvt::term::proxy; 765package urxvt::term::extension;
596 766
597sub enable { 767sub enable {
598 my ($self, %hook) = @_; 768 my ($self, %hook) = @_;
599 my $pkg = $self->{_pkg}; 769 my $pkg = $self->{_pkg};
600 770
601 while (my ($name, $cb) = each %hook) { 771 while (my ($name, $cb) = each %hook) {
602 my $htype = $HOOKTYPE{uc $name}; 772 my $htype = $HOOKTYPE{uc $name};
603 defined $htype 773 defined $htype
604 or Carp::croak "unsupported hook type '$name'"; 774 or Carp::croak "unsupported hook type '$name'";
605 775
776 $self->set_should_invoke ($htype, +1)
606 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 777 unless exists $self->{term}{_hook}[$htype]{$pkg};
607 $hook_count[$htype]++
608 or urxvt::set_should_invoke $htype, 1;
609 }
610 778
611 $self->{term}{_hook}[$htype]{$pkg} = $cb; 779 $self->{term}{_hook}[$htype]{$pkg} = $cb;
612 } 780 }
613} 781}
614 782
619 for my $name (@hook) { 787 for my $name (@hook) {
620 my $htype = $HOOKTYPE{uc $name}; 788 my $htype = $HOOKTYPE{uc $name};
621 defined $htype 789 defined $htype
622 or Carp::croak "unsupported hook type '$name'"; 790 or Carp::croak "unsupported hook type '$name'";
623 791
792 $self->set_should_invoke ($htype, -1)
624 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 793 if delete $self->{term}{_hook}[$htype]{$pkg};
625 --$hook_count[$htype]
626 or urxvt::set_should_invoke $htype, 0;
627 }
628 } 794 }
629} 795}
630 796
631our $AUTOLOAD; 797our $AUTOLOAD;
632 798
663 829
664=head2 The C<urxvt::anyevent> Class 830=head2 The C<urxvt::anyevent> Class
665 831
666The sole purpose of this class is to deliver an interface to the 832The sole purpose of this class is to deliver an interface to the
667C<AnyEvent> module - any module using it will work inside urxvt without 833C<AnyEvent> module - any module using it will work inside urxvt without
668further work. The only exception is that you cannot wait on condition 834further programming. The only exception is that you cannot wait on
669variables, but non-blocking condvar use is ok. What this means is that you 835condition variables, but non-blocking condvar use is ok. What this means
670cannot use blocking APIs, but the non-blocking variant should work. 836is that you cannot use blocking APIs, but the non-blocking variant should
837work.
671 838
672=cut 839=cut
673 840
674our $VERSION = 1; 841our $VERSION = 1;
675 842
752 $proxy->enable ($name => $ref); 919 $proxy->enable ($name => $ref);
753 } 920 }
754 } 921 }
755} 922}
756 923
924=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
925
926Creates a new terminal, very similar as if you had started it with system
927C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
928hash which defines the environment of the new terminal.
929
930Croaks (and probably outputs an error message) if the new instance
931couldn't be created. Returns C<undef> if the new instance didn't
932initialise perl, and the terminal object otherwise. The C<init> and
933C<start> hooks will be called during this call.
934
935=cut
936
937sub new {
938 my ($class, $env, @args) = @_;
939
940 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
941}
942
757=item $term->destroy 943=item $term->destroy
758 944
759Destroy the terminal object (close the window, free resources etc.). 945Destroy the terminal object (close the window, free resources
946etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
947watchers (timers, io watchers) are still active.
948
949=item $term->exec_async ($cmd[, @args])
950
951Works like the combination of the C<fork>/C<exec> builtins, which executes
952("starts") programs in the background. This function takes care of setting
953the user environment before exec'ing the command (e.g. C<PATH>) and should
954be preferred over explicit calls to C<exec> or C<system>.
955
956Returns the pid of the subprocess or C<undef> on error.
957
958=cut
959
960sub exec_async {
961 my $self = shift;
962
963 my $pid = fork;
964
965 return $pid
966 if !defined $pid or $pid;
967
968 %ENV = %{ $self->env };
969
970 exec @_;
971 urxvt::_exit 255;
972}
760 973
761=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
762 975
763Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
764optionally change it. All option values are stored by name in the hash 977optionally change it. All option values are stored by name in the hash
767Here is a a likely non-exhaustive list of option names, please see the 980Here is a a likely non-exhaustive list of option names, please see the
768source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
769 982
770 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
771 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
772 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
773 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
774 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
775 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
776 989
777=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
778 991
779Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
780optionally sets a new value. Setting values is most useful in the C<init> 993optionally sets a new value. Setting values is most useful in the C<init>
797 1010
798 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
799 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
800 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
801 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
802 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
803 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
804 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
805 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
806 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
807 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
808 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
809 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
810 1024
811=cut 1025=cut
812 1026
813sub resource($$;$) { 1027sub resource($$;$) {
814 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
815 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1029 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
816 &urxvt::term::_resource 1030 &urxvt::term::_resource
817} 1031}
818 1032
1033=item $value = $term->x_resource ($pattern)
1034
1035Returns the X-Resource for the given pattern, excluding the program or
1036class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1037same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1038resource with that pattern exists.
1039
1040This method should only be called during the C<on_start> hook, as there is
1041only one resource database per display, and later invocations might return
1042the wrong resources.
1043
819=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1044=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820 1045
821Adds a keymap translation exactly as specified via a resource. See the 1046Adds a keymap translation exactly as specified via a resource. See the
822C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1047C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823 1048
838=item ($row, $col) = $term->selection_end ([$row, $col]) 1063=item ($row, $col) = $term->selection_end ([$row, $col])
839 1064
840Return the current values of the selection mark, begin or end positions, 1065Return the current values of the selection mark, begin or end positions,
841and optionally set them to new values. 1066and optionally set them to new values.
842 1067
1068=item $term->selection_make ($eventtime[, $rectangular])
1069
1070Tries to make a selection as set by C<selection_beg> and
1071C<selection_end>. If C<$rectangular> is true (default: false), a
1072rectangular selection will be made. This is the prefered function to make
1073a selection.
1074
843=item $success = $term->selection_grab ($eventtime) 1075=item $success = $term->selection_grab ($eventtime)
844 1076
845Try to request the primary selection from the server (for example, as set 1077Try to request the primary selection text from the server (for example, as
846by the next method). 1078set by the next method). No visual feedback will be given. This function
1079is mostly useful from within C<on_sel_grab> hooks.
847 1080
848=item $oldtext = $term->selection ([$newtext]) 1081=item $oldtext = $term->selection ([$newtext])
849 1082
850Return the current selection text and optionally replace it by C<$newtext>. 1083Return the current selection text and optionally replace it by C<$newtext>.
851 1084
941 1174
942=item $string = $term->locale_decode ($octets) 1175=item $string = $term->locale_decode ($octets)
943 1176
944Convert the given locale-encoded octets into a perl string. 1177Convert the given locale-encoded octets into a perl string.
945 1178
1179=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1180
1181XORs the rendition values in the given span with the provided value
1182(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1183refresh hooks to provide effects similar to the selection.
1184
1185=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1186
1187Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1188whitespace will additionally be xored with the C<$rstyle2>, which defaults
1189to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1190it instead. Both styles I<MUST NOT> contain font styles.
1191
946=item $term->scr_bell 1192=item $term->scr_bell
947 1193
948Ring the bell! 1194Ring the bell!
949 1195
950=item $term->scr_add_lines ($string) 1196=item $term->scr_add_lines ($string)
983 1229
984=item $windowid = $term->vt 1230=item $windowid = $term->vt
985 1231
986Return the window id of the terminal window. 1232Return the window id of the terminal window.
987 1233
1234=item $term->vt_emask_add ($x_event_mask)
1235
1236Adds the specified events to the vt event mask. Useful e.g. when you want
1237to receive pointer events all the times:
1238
1239 $term->vt_emask_add (urxvt::PointerMotionMask);
1240
988=item $window_width = $term->width 1241=item $window_width = $term->width
989 1242
990=item $window_height = $term->height 1243=item $window_height = $term->height
991 1244
992=item $font_width = $term->fwidth 1245=item $font_width = $term->fwidth
1005 1258
1006=item $max_scrollback = $term->saveLines 1259=item $max_scrollback = $term->saveLines
1007 1260
1008=item $nrow_plus_saveLines = $term->total_rows 1261=item $nrow_plus_saveLines = $term->total_rows
1009 1262
1010=item $lines_in_scrollback = $term->nsaved 1263=item $topmost_scrollback_row = $term->top_row
1011 1264
1012Return various integers describing terminal characteristics. 1265Return various integers describing terminal characteristics.
1013 1266
1267=item $x_display = $term->display_id
1268
1269Return the DISPLAY used by rxvt-unicode.
1270
1014=item $lc_ctype = $term->locale 1271=item $lc_ctype = $term->locale
1015 1272
1016Returns the LC_CTYPE category string used by this rxvt-unicode. 1273Returns the LC_CTYPE category string used by this rxvt-unicode.
1017 1274
1018=item $x_display = $term->display_id 1275=item $env = $term->env
1019 1276
1020Return the DISPLAY used by rxvt-unicode. 1277Returns a copy of the environment in effect for the terminal as a hashref
1278similar to C<\%ENV>.
1279
1280=cut
1281
1282sub env {
1283 if (my $env = $_[0]->_env) {
1284 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1285 } else {
1286 +{ %ENV }
1287 }
1288}
1021 1289
1022=item $modifiermask = $term->ModLevel3Mask 1290=item $modifiermask = $term->ModLevel3Mask
1023 1291
1024=item $modifiermask = $term->ModMetaMask 1292=item $modifiermask = $term->ModMetaMask
1025 1293
1028Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1296Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1029AltGr), the meta key (often Alt) and the num lock key, if applicable. 1297AltGr), the meta key (often Alt) and the num lock key, if applicable.
1030 1298
1031=item $view_start = $term->view_start ([$newvalue]) 1299=item $view_start = $term->view_start ([$newvalue])
1032 1300
1033Returns the negative row number of the topmost line. Minimum value is 1301Returns the row number of the topmost displayed line. Maximum value is
1034C<0>, which displays the normal terminal contents. Larger values scroll 1302C<0>, which displays the normal terminal contents. Lower values scroll
1035this many lines into the scrollback buffer. 1303this many lines into the scrollback buffer.
1036 1304
1037=item $term->want_refresh 1305=item $term->want_refresh
1038 1306
1039Requests a screen refresh. At the next opportunity, rxvt-unicode will 1307Requests a screen refresh. At the next opportunity, rxvt-unicode will
1118Return the row number of the first/last row of the line, respectively. 1386Return the row number of the first/last row of the line, respectively.
1119 1387
1120=item $offset = $line->offset_of ($row, $col) 1388=item $offset = $line->offset_of ($row, $col)
1121 1389
1122Returns the character offset of the given row|col pair within the logical 1390Returns the character offset of the given row|col pair within the logical
1123line. 1391line. Works for rows outside the line, too, and returns corresponding
1392offsets outside the string.
1124 1393
1125=item ($row, $col) = $line->coord_of ($offset) 1394=item ($row, $col) = $line->coord_of ($offset)
1126 1395
1127Translates a string offset into terminal coordinates again. 1396Translates a string offset into terminal coordinates again.
1128 1397
1265 $item->{render} ||= sub { $_[0]{text} }; 1534 $item->{render} ||= sub { $_[0]{text} };
1266 1535
1267 push @{ $self->{item} }, $item; 1536 push @{ $self->{item} }, $item;
1268} 1537}
1269 1538
1539=item $popup->add_title ($title)
1540
1541Adds a non-clickable title to the popup.
1542
1543=cut
1544
1545sub add_title {
1546 my ($self, $title) = @_;
1547
1548 $self->add_item ({
1549 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1550 text => $title,
1551 activate => sub { },
1552 });
1553}
1554
1555=item $popup->add_separator ([$sepchr])
1556
1557Creates a separator, optionally using the character given as C<$sepchr>.
1558
1559=cut
1560
1270sub add_separator { 1561sub add_separator {
1271 my ($self, $sep) = @_; 1562 my ($self, $sep) = @_;
1272 1563
1273 $sep ||= "="; 1564 $sep ||= "=";
1274 1565
1278 render => sub { $sep x $self->{term}->ncol }, 1569 render => sub { $sep x $self->{term}->ncol },
1279 activate => sub { }, 1570 activate => sub { },
1280 }); 1571 });
1281} 1572}
1282 1573
1283sub add_title { 1574=item $popup->add_button ($text, $cb)
1284 my ($self, $title) = @_;
1285 1575
1286 $self->add_item ({ 1576Adds a clickable button to the popup. C<$cb> is called whenever it is
1287 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, 1577selected.
1288 text => $title, 1578
1289 activate => sub { }, 1579=cut
1290 });
1291}
1292 1580
1293sub add_button { 1581sub add_button {
1294 my ($self, $text, $cb) = @_; 1582 my ($self, $text, $cb) = @_;
1295 1583
1296 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1584 $self->add_item ({ type => "button", text => $text, activate => $cb});
1297} 1585}
1586
1587=item $popup->add_toggle ($text, $cb, $initial_value)
1588
1589Adds a toggle/checkbox item to the popup. Teh callback gets called
1590whenever it gets toggled, with a boolean indicating its value as its first
1591argument.
1592
1593=cut
1298 1594
1299sub add_toggle { 1595sub add_toggle {
1300 my ($self, $text, $cb, $value) = @_; 1596 my ($self, $text, $cb, $value) = @_;
1301 1597
1302 my $item; $item = { 1598 my $item; $item = {
1303 type => "button", 1599 type => "button",
1304 text => " $text", 1600 text => " $text",
1305 value => $value, 1601 value => $value,
1306 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1602 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1307 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1603 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1308 }; 1604 };
1309 1605
1310 $self->add_item ($item); 1606 $self->add_item ($item);
1311} 1607}
1608
1609=item $popup->show
1610
1611Displays the popup (which is initially hidden).
1612
1613=cut
1312 1614
1313sub show { 1615sub show {
1314 my ($self) = @_; 1616 my ($self) = @_;
1315 1617
1316 local $urxvt::popup::self = $self; 1618 local $urxvt::popup::self = $self;
1317 1619
1620 my $env = $self->{term}->env;
1621 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1622 delete $env->{LC_ALL};
1318 local $ENV{LC_ALL} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1319 1624
1320 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1625 urxvt::term->new ($env, "popup",
1626 "--perl-lib" => "", "--perl-ext-common" => "",
1627 "-pty-fd" => -1, "-sl" => 0,
1628 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1321 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1322 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1323 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1324 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1325} 1633}
1326 1634
1327sub DESTROY { 1635sub DESTROY {
1328 my ($self) = @_; 1636 my ($self) = @_;
1329 1637
1330 delete $self->{term}{_destroy}{$self}; 1638 delete $self->{term}{_destroy}{$self};
1331 $self->{term}->ungrab; 1639 $self->{term}->ungrab;
1332} 1640}
1641
1642=back
1333 1643
1334=head2 The C<urxvt::timer> Class 1644=head2 The C<urxvt::timer> Class
1335 1645
1336This class implements timer watchers/events. Time is represented as a 1646This class implements timer watchers/events. Time is represented as a
1337fractional number of seconds since the epoch. Example: 1647fractional number of seconds since the epoch. Example:
1375Start the timer. 1685Start the timer.
1376 1686
1377=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1378 1688
1379Set the event trigger time to C<$tstamp> and start the timer. 1689Set the event trigger time to C<$tstamp> and start the timer.
1690
1691=item $timer = $timer->after ($delay)
1692
1693Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1380 1694
1381=item $timer = $timer->stop 1695=item $timer = $timer->stop
1382 1696
1383Stop the timer. 1697Stop the timer.
1384 1698
1444 1758
1445=item == 0 - fatal messages 1759=item == 0 - fatal messages
1446 1760
1447=item >= 3 - script loading and management 1761=item >= 3 - script loading and management
1448 1762
1449=item >=10 - all events received 1763=item >=10 - all called hooks
1764
1765=item >=11 - hook reutrn values
1450 1766
1451=back 1767=back
1452 1768
1453=head1 AUTHOR 1769=head1 AUTHOR
1454 1770

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines