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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines