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.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.105 by root, Wed Jan 18 19:43:51 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 onto
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
96
97It's sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not.
99It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called
101when the button gets activated and should transform C<$_>.
102
103The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any
105C<a>s:
106
107 push urxvt::ext::selection_popup::hook, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g }
109 : ()
110 };
111
71=item searchable-scrollback (enabled by default) 112=item searchable-scrollback<hotkey> (enabled by default)
72 113
73Adds regex search functionality to the scrollback buffer, triggered by a 114Adds regex search functionality to the scrollback buffer, triggered
74hotkey (default: C<M-s>). When in search mode, terminal input/output is 115by a hotkey (default: C<M-s>). While in search mode, normal terminal
75suspended, C</> starts an incremental regex search, C<n> searches further, 116input/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 117screen.
77current position and C<escape> returns to the original position.
78 118
79=item digital-clock 119Inputting characters appends them to the regex and continues incremental
120search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
121search upwards/downwards in the scrollback buffer, C<End> jumps to the
122bottom. C<Escape> leaves search mode and returns to the point where search
123was started, while C<Enter> or C<Return> stay at the current position and
124additionally stores the first match in the current line into the primary
125selection.
80 126
81Displays a digital clock using the built-in overlay. 127=item selection-autotransform
128
129This selection allows you to do automatic transforms on a selection
130whenever a selection is made.
131
132It works by specifying perl snippets (most useful is a single C<s///>
133operator) that modify C<$_> as resources:
134
135 URxvt.selection-autotransform.0: transform
136 URxvt.selection-autotransform.1: transform
137 ...
138
139For example, the following will transform selections of the form
140C<filename:number>, often seen in compiler messages, into C<vi +$filename
141$word>:
142
143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144
145And this example matches the same,but replaces it with vi-commands you can
146paste directly into your (vi :) editor:
147
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
149
150Of course, this can be modified to suit your needs and your editor :)
151
152To expand the example above to typical perl error messages ("XXX at
153FILENAME line YYY."), you need a slightly more elaborate solution:
154
155 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
156 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
157
158The first line tells the selection code to treat the unchanging part of
159every error message as a selection pattern, and the second line transforms
160the message into vi commands to load the file.
82 161
83=item mark-urls 162=item mark-urls
84 163
85Uses per-line display filtering (C<on_line_update>) to underline urls. 164Uses per-line display filtering (C<on_line_update>) to underline urls and
165make them clickable. When middle-clicked, the program specified in the
166resource C<urlLauncher> (default C<x-www-browser>) will be started with
167the URL as first argument.
168
169=item automove-background
170
171This is basically a one-line extension that dynamically changes the background pixmap offset
172to the window position, in effect creating the same effect as pseudo transparency with
173a custom pixmap. No scaling is supported in this mode. Exmaple:
174
175 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86 176
87=item block-graphics-to-ascii 177=item block-graphics-to-ascii
88 178
89A not very useful example of filtering all text output to the terminal, 179A not very useful example of filtering all text output to the terminal,
90by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
91similar-looking ascii character. 181similar-looking ascii character.
92 182
183=item digital-clock
184
185Displays a digital clock using the built-in overlay.
186
93=item example-refresh-hooks 187=item example-refresh-hooks
94 188
95Displays a very simple digital clock in the upper right corner of the 189Displays a very simple digital clock in the upper right corner of the
96window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
97overlays or changes. 191overlays or changes.
98 192
193=item selection-pastebin
194
195This is a little rarely useful extension that Uploads the selection as
196textfile to a remote site (or does other things). (The implementation is
197not currently secure for use in a multiuser environment as it writes to
198F</tmp> directly.).
199
200It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
201i.e.
202
203 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
204
205Pressing this combination runs a command with C<%> replaced by the name of
206the textfile. This command can be set via a resource:
207
208 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
209
210And the default is likely not useful to anybody but the few people around
211here :)
212
213The name of the textfile is the hex encoded md5 sum of the selection, so
214the same content should lead to the same filename.
215
216After a successful upload the selection will be replaced by the text given
217in the C<selection-pastebin-url> resource (again, the % is the placeholder
218for the filename):
219
220 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
221
99=back 222=back
223
224=head1 API DOCUMENTATION
100 225
101=head2 General API Considerations 226=head2 General API Considerations
102 227
103All objects (such as terminals, time watchers etc.) are typical 228All objects (such as terminals, time watchers etc.) are typical
104reference-to-hash objects. The hash can be used to store anything you 229reference-to-hash objects. The hash can be used to store anything you
117=over 4 242=over 4
118 243
119=item $text 244=item $text
120 245
121Rxvt-unicodes special way of encoding text, where one "unicode" character 246Rxvt-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. 247always represents one screen cell. See L<ROW_t> for a discussion of this format.
123 248
124=item $string 249=item $string
125 250
126A perl text string, with an emphasis on I<text>. It can store all unicode 251A 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 252characters and is to be distinguished with text encoded in a specific
222=item on_sel_extend $term 347=item on_sel_extend $term
223 348
224Called whenever the user tries to extend the selection (e.g. with a double 349Called whenever the user tries to extend the selection (e.g. with a double
225click) and is either supposed to return false (normal operation), or 350click) and is either supposed to return false (normal operation), or
226should extend the selection itelf and return true to suppress the built-in 351should extend the selection itelf and return true to suppress the built-in
227processing. 352processing. This can happen multiple times, as long as the callback
353returns true, it will be called on every further click by the user and is
354supposed to enlarge the selection more and more, if possible.
228 355
229See the F<selection> example extension. 356See the F<selection> example extension.
230 357
231=item on_view_change $term, $offset 358=item on_view_change $term, $offset
232 359
299 426
300Called whenever the user presses a key combination that has a 427Called whenever the user presses a key combination that has a
301C<perl:string> action bound to it (see description of the B<keysym> 428C<perl:string> action bound to it (see description of the B<keysym>
302resource in the @@RXVT_NAME@@(1) manpage). 429resource in the @@RXVT_NAME@@(1) manpage).
303 430
431=item on_x_event $term, $event
432
433Called on every X event received on the vt window (and possibly other
434windows). Should only be used as a last resort. Most event structure
435members are not passed.
436
304=item on_focus_in $term 437=item on_focus_in $term
305 438
306Called whenever the window gets the keyboard focus, before rxvt-unicode 439Called whenever the window gets the keyboard focus, before rxvt-unicode
307does focus in processing. 440does focus in processing.
308 441
309=item on_focus_out $term 442=item on_focus_out $term
310 443
311Called wheneever the window loses keyboard focus, before rxvt-unicode does 444Called wheneever the window loses keyboard focus, before rxvt-unicode does
312focus out processing. 445focus out processing.
446
447=item on_configure_notify $term, $event
313 448
314=item on_key_press $term, $event, $keysym, $octets 449=item on_key_press $term, $event, $keysym, $octets
315 450
316=item on_key_release $term, $event, $keysym 451=item on_key_release $term, $event, $keysym
317 452
334 469
335C<on_key_press> additionally receives the string rxvt-unicode would 470C<on_key_press> additionally receives the string rxvt-unicode would
336output, if any, in locale-specific encoding. 471output, if any, in locale-specific encoding.
337 472
338subwindow. 473subwindow.
339
340=back
341
342=head2 Variables in the C<urxvt> Package
343
344=over 4
345
346=item $urxvt::TERM
347
348The current terminal. This variable stores the current C<urxvt::term>
349object, whenever a callback/hook is executing.
350
351=back
352
353=head2 Functions in the C<urxvt> Package
354
355=over 4
356
357=item $term = new urxvt [arg...]
358
359Creates a new terminal, very similar as if you had started it with
360C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361if the new instance couldn't be created. Returns C<undef> if the new
362instance didn't initialise perl, and the terminal object otherwise. The
363C<init> and C<start> hooks will be called during the call.
364
365=item urxvt::fatal $errormessage
366
367Fatally aborts execution with the given error message. Avoid at all
368costs! The only time this is acceptable is when the terminal process
369starts up.
370
371=item urxvt::warn $string
372
373Calls C<rxvt_warn> with the given string which should not include a
374newline. The module also overwrites the C<warn> builtin with a function
375that calls this function.
376
377Using this function has the advantage that its output ends up in the
378correct place, e.g. on stderr of the connecting urxvtc client.
379
380=item $is_safe = urxvt::safe
381
382Returns true when it is safe to do potentially unsafe things, such as
383evaluating perl code specified by the user. This is true when urxvt was
384started setuid or setgid.
385
386=item $time = urxvt::NOW
387
388Returns the "current time" (as per the event loop).
389
390=item urxvt::CurrentTime
391
392=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394Button4Mask, Button5Mask, AnyModifier
395
396Various constants for use in X calls and event processing.
397
398=back
399
400=head2 RENDITION
401
402Rendition bitsets contain information about colour, font, font styles and
403similar information for each screen cell.
404
405The following "macros" deal with changes in rendition sets. You should
406never just create a bitset, you should always modify an existing one,
407as they contain important information required for correct operation of
408rxvt-unicode.
409
410=over 4
411
412=item $rend = urxvt::DEFAULT_RSTYLE
413
414Returns the default rendition, as used when the terminal is starting up or
415being reset. Useful as a base to start when creating renditions.
416
417=item $rend = urxvt::OVERLAY_RSTYLE
418
419Return the rendition mask used for overlays by default.
420
421=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423Return the bit that enabled bold, italic, blink, reverse-video and
424underline, respectively. To enable such a style, just logically OR it into
425the bitset.
426
427=item $foreground = urxvt::GET_BASEFG $rend
428
429=item $background = urxvt::GET_BASEBG $rend
430
431Return the foreground/background colour index, respectively.
432
433=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437Replace the foreground/background colour in the rendition mask with the
438specified one.
439
440=item $value = urxvt::GET_CUSTOM ($rend)
441
442Return the "custom" value: Every rendition has 5 bits for use by
443extensions. They can be set and changed as you like and are initially
444zero.
445
446=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448Change the custom value.
449 474
450=back 475=back
451 476
452=cut 477=cut
453 478
462our $VERSION = 1; 487our $VERSION = 1;
463our $TERM; 488our $TERM;
464our @HOOKNAME; 489our @HOOKNAME;
465our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 490our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466our %OPTION; 491our %OPTION;
492
467our $LIBDIR; 493our $LIBDIR;
494our $RESNAME;
495our $RESCLASS;
496our $RXVTNAME;
497
498=head2 Variables in the C<urxvt> Package
499
500=over 4
501
502=item $urxvt::LIBDIR
503
504The rxvt-unicode library directory, where, among other things, the perl
505modules and scripts are stored.
506
507=item $urxvt::RESCLASS, $urxvt::RESCLASS
508
509The resource class and name rxvt-unicode uses to look up X resources.
510
511=item $urxvt::RXVTNAME
512
513The basename of the installed binaries, usually C<urxvt>.
514
515=item $urxvt::TERM
516
517The current terminal. This variable stores the current C<urxvt::term>
518object, whenever a callback/hook is executing.
519
520=back
521
522=head2 Functions in the C<urxvt> Package
523
524=over 4
525
526=item urxvt::fatal $errormessage
527
528Fatally aborts execution with the given error message. Avoid at all
529costs! The only time this is acceptable is when the terminal process
530starts up.
531
532=item urxvt::warn $string
533
534Calls C<rxvt_warn> with the given string which should not include a
535newline. The module also overwrites the C<warn> builtin with a function
536that calls this function.
537
538Using this function has the advantage that its output ends up in the
539correct place, e.g. on stderr of the connecting urxvtc client.
540
541Messages have a size limit of 1023 bytes currently.
542
543=item $time = urxvt::NOW
544
545Returns the "current time" (as per the event loop).
546
547=item urxvt::CurrentTime
548
549=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
550Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
551Button4Mask, Button5Mask, AnyModifier
552
553=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
554ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
555PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
556Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
557KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
558ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
559FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
560
561=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
562EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
563GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
564UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
565ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
566CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
567SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
568
569Various constants for use in X calls and event processing.
570
571=back
572
573=head2 RENDITION
574
575Rendition bitsets contain information about colour, font, font styles and
576similar information for each screen cell.
577
578The following "macros" deal with changes in rendition sets. You should
579never just create a bitset, you should always modify an existing one,
580as they contain important information required for correct operation of
581rxvt-unicode.
582
583=over 4
584
585=item $rend = urxvt::DEFAULT_RSTYLE
586
587Returns the default rendition, as used when the terminal is starting up or
588being reset. Useful as a base to start when creating renditions.
589
590=item $rend = urxvt::OVERLAY_RSTYLE
591
592Return the rendition mask used for overlays by default.
593
594=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
595
596Return the bit that enabled bold, italic, blink, reverse-video and
597underline, respectively. To enable such a style, just logically OR it into
598the bitset.
599
600=item $foreground = urxvt::GET_BASEFG $rend
601
602=item $background = urxvt::GET_BASEBG $rend
603
604Return the foreground/background colour index, respectively.
605
606=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607
608=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
609
610Replace the foreground/background colour in the rendition mask with the
611specified one.
612
613=item $value = urxvt::GET_CUSTOM $rend
614
615Return the "custom" value: Every rendition has 5 bits for use by
616extensions. They can be set and changed as you like and are initially
617zero.
618
619=item $rend = urxvt::SET_CUSTOM $rend, $new_value
620
621Change the custom value.
622
623=back
624
625=cut
468 626
469BEGIN { 627BEGIN {
470 urxvt->bootstrap;
471
472 # overwrite perl's warn 628 # overwrite perl's warn
473 *CORE::GLOBAL::warn = sub { 629 *CORE::GLOBAL::warn = sub {
474 my $msg = join "", @_; 630 my $msg = join "", @_;
475 $msg .= "\n" 631 $msg .= "\n"
476 unless $msg =~ /\n$/; 632 unless $msg =~ /\n$/;
477 urxvt::warn ($msg); 633 urxvt::warn ($msg);
478 }; 634 };
479 635
636 # %ENV is the original startup environment
480 delete $ENV{IFS}; 637 delete $ENV{IFS};
481 delete $ENV{CDPATH}; 638 delete $ENV{CDPATH};
482 delete $ENV{BASH_ENV}; 639 delete $ENV{BASH_ENV};
483 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 640 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
484} 641}
485 642
486my @hook_count;
487my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 643my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
488 644
489sub verbose { 645sub verbose {
490 my ($level, $msg) = @_; 646 my ($level, $msg) = @_;
491 warn "$msg\n" if $level <= $verbosity; 647 warn "$msg\n" if $level <= $verbosity;
492} 648}
493 649
494my $extension_pkg = "extension0000";
495my %extension_pkg; 650my %extension_pkg;
496 651
497# load a single script into its own package, once only 652# load a single script into its own package, once only
498sub extension_package($) { 653sub extension_package($) {
499 my ($path) = @_; 654 my ($path) = @_;
500 655
656 no strict 'refs';
657
501 $extension_pkg{$path} ||= do { 658 $extension_pkg{$path} ||= do {
502 my $pkg = "urxvt::" . ($extension_pkg++); 659 $path =~ /([^\/\\]+)$/;
660 my $pkg = $1;
661 $pkg =~ s/[^[:word:]]/_/g;
662 $pkg = "urxvt::ext::$pkg";
503 663
504 verbose 3, "loading extension '$path' into package '$pkg'"; 664 verbose 3, "loading extension '$path' into package '$pkg'";
505 665
506 open my $fh, "<:raw", $path 666 open my $fh, "<:raw", $path
507 or die "$path: $!"; 667 or die "$path: $!";
508 668
669 @{"$pkg\::ISA"} = urxvt::term::extension::;
670
509 my $source = untaint 671 my $source =
510 "package $pkg; use strict; use utf8;\n" 672 "package $pkg; use strict; use utf8;\n"
511 . "use base urxvt::term::extension::;\n"
512 . "#line 1 \"$path\"\n{\n" 673 . "#line 1 \"$path\"\n{\n"
513 . (do { local $/; <$fh> }) 674 . (do { local $/; <$fh> })
514 . "\n};\n1"; 675 . "\n};\n1";
515 676
516 eval $source 677 eval $source
573 if ($@) { 734 if ($@) {
574 $TERM->ungrab; # better to lose the grab than the session 735 $TERM->ungrab; # better to lose the grab than the session
575 warn $@; 736 warn $@;
576 } 737 }
577 } 738 }
739
740 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
741 if $verbosity >= 11;
578 } 742 }
579 743
580 if ($htype == 1) { # DESTROY 744 if ($htype == 1) { # DESTROY
581 if (my $hook = delete $TERM->{_hook}) {
582 for my $htype (0..$#$hook) {
583 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
584 or set_should_invoke $htype, 0;
585 }
586 }
587
588 # clear package objects 745 # clear package objects
589 %$_ = () for values %{ $TERM->{_pkg} }; 746 %$_ = () for values %{ $TERM->{_pkg} };
590 747
591 # clear package 748 # clear package
592 %$TERM = (); 749 %$TERM = ();
593 } 750 }
594 751
595 $retval 752 $retval
753}
754
755sub exec_async(@) {
756 my $pid = fork;
757
758 return
759 if !defined $pid or $pid;
760
761 %ENV = %{ $TERM->env };
762
763 exec @_;
764 _exit 255;
596} 765}
597 766
598# urxvt::term::extension 767# urxvt::term::extension
599 768
600package urxvt::term::extension; 769package urxvt::term::extension;
606 while (my ($name, $cb) = each %hook) { 775 while (my ($name, $cb) = each %hook) {
607 my $htype = $HOOKTYPE{uc $name}; 776 my $htype = $HOOKTYPE{uc $name};
608 defined $htype 777 defined $htype
609 or Carp::croak "unsupported hook type '$name'"; 778 or Carp::croak "unsupported hook type '$name'";
610 779
780 $self->set_should_invoke ($htype, +1)
611 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 781 unless exists $self->{term}{_hook}[$htype]{$pkg};
612 $hook_count[$htype]++
613 or urxvt::set_should_invoke $htype, 1;
614 }
615 782
616 $self->{term}{_hook}[$htype]{$pkg} = $cb; 783 $self->{term}{_hook}[$htype]{$pkg} = $cb;
617 } 784 }
618} 785}
619 786
624 for my $name (@hook) { 791 for my $name (@hook) {
625 my $htype = $HOOKTYPE{uc $name}; 792 my $htype = $HOOKTYPE{uc $name};
626 defined $htype 793 defined $htype
627 or Carp::croak "unsupported hook type '$name'"; 794 or Carp::croak "unsupported hook type '$name'";
628 795
796 $self->set_should_invoke ($htype, -1)
629 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 797 if delete $self->{term}{_hook}[$htype]{$pkg};
630 --$hook_count[$htype]
631 or urxvt::set_should_invoke $htype, 0;
632 }
633 } 798 }
634} 799}
635 800
636our $AUTOLOAD; 801our $AUTOLOAD;
637 802
668 833
669=head2 The C<urxvt::anyevent> Class 834=head2 The C<urxvt::anyevent> Class
670 835
671The sole purpose of this class is to deliver an interface to the 836The sole purpose of this class is to deliver an interface to the
672C<AnyEvent> module - any module using it will work inside urxvt without 837C<AnyEvent> module - any module using it will work inside urxvt without
673further work. The only exception is that you cannot wait on condition 838further programming. The only exception is that you cannot wait on
674variables, but non-blocking condvar use is ok. What this means is that you 839condition variables, but non-blocking condvar use is ok. What this means
675cannot use blocking APIs, but the non-blocking variant should work. 840is that you cannot use blocking APIs, but the non-blocking variant should
841work.
676 842
677=cut 843=cut
678 844
679our $VERSION = 1; 845our $VERSION = 1;
680 846
757 $proxy->enable ($name => $ref); 923 $proxy->enable ($name => $ref);
758 } 924 }
759 } 925 }
760} 926}
761 927
928=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
929
930Creates a new terminal, very similar as if you had started it with system
931C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
932hash which defines the environment of the new terminal.
933
934Croaks (and probably outputs an error message) if the new instance
935couldn't be created. Returns C<undef> if the new instance didn't
936initialise perl, and the terminal object otherwise. The C<init> and
937C<start> hooks will be called during this call.
938
939=cut
940
941sub new {
942 my ($class, $env, @args) = @_;
943
944 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
945}
946
762=item $term->destroy 947=item $term->destroy
763 948
764Destroy the terminal object (close the window, free resources etc.). 949Destroy the terminal object (close the window, free resources
950etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
951watchers (timers, io watchers) are still active.
765 952
766=item $isset = $term->option ($optval[, $set]) 953=item $isset = $term->option ($optval[, $set])
767 954
768Returns true if the option specified by C<$optval> is enabled, and 955Returns true if the option specified by C<$optval> is enabled, and
769optionally change it. All option values are stored by name in the hash 956optionally change it. All option values are stored by name in the hash
772Here is a a likely non-exhaustive list of option names, please see the 959Here is a a likely non-exhaustive list of option names, please see the
773source file F</src/optinc.h> to see the actual list: 960source file F</src/optinc.h> to see the actual list:
774 961
775 borderLess console cursorBlink cursorUnderline hold iconic insecure 962 borderLess console cursorBlink cursorUnderline hold iconic insecure
776 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 963 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
777 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 964 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
778 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 965 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
779 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 966 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
780 tripleclickwords utmpInhibit visualBell 967 transparent tripleclickwords utmpInhibit visualBell
781 968
782=item $value = $term->resource ($name[, $newval]) 969=item $value = $term->resource ($name[, $newval])
783 970
784Returns the current resource value associated with a given name and 971Returns the current resource value associated with a given name and
785optionally sets a new value. Setting values is most useful in the C<init> 972optionally sets a new value. Setting values is most useful in the C<init>
802 989
803 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 990 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
804 borderLess color cursorBlink cursorUnderline cutchars delete_key 991 borderLess color cursorBlink cursorUnderline cutchars delete_key
805 display_name embed ext_bwidth fade font geometry hold iconName 992 display_name embed ext_bwidth fade font geometry hold iconName
806 imFont imLocale inputMethod insecure int_bwidth intensityStyles 993 imFont imLocale inputMethod insecure int_bwidth intensityStyles
807 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 994 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
808 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 995 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
809 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 996 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
810 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 997 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
811 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 998 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
812 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 999 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
813 shade term_name title transparent transparent_all tripleclickwords 1000 secondaryScreen secondaryScroll selectstyle shade term_name title
814 utmpInhibit visualBell 1001 transient_for transparent transparent_all tripleclickwords utmpInhibit
1002 visualBell
815 1003
816=cut 1004=cut
817 1005
818sub resource($$;$) { 1006sub resource($$;$) {
819 my ($self, $name) = (shift, shift); 1007 my ($self, $name) = (shift, shift);
820 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1008 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
821 &urxvt::term::_resource 1009 &urxvt::term::_resource
822} 1010}
823 1011
1012=item $value = $term->x_resource ($pattern)
1013
1014Returns the X-Resource for the given pattern, excluding the program or
1015class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1016same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1017resource with that pattern exists.
1018
1019This method should only be called during the C<on_start> hook, as there is
1020only one resource database per display, and later invocations might return
1021the wrong resources.
1022
824=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1023=item $success = $term->parse_keysym ($keysym_spec, $command_string)
825 1024
826Adds a keymap translation exactly as specified via a resource. See the 1025Adds a keymap translation exactly as specified via a resource. See the
827C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1026C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
828 1027
843=item ($row, $col) = $term->selection_end ([$row, $col]) 1042=item ($row, $col) = $term->selection_end ([$row, $col])
844 1043
845Return the current values of the selection mark, begin or end positions, 1044Return the current values of the selection mark, begin or end positions,
846and optionally set them to new values. 1045and optionally set them to new values.
847 1046
1047=item $term->selection_make ($eventtime[, $rectangular])
1048
1049Tries to make a selection as set by C<selection_beg> and
1050C<selection_end>. If C<$rectangular> is true (default: false), a
1051rectangular selection will be made. This is the prefered function to make
1052a selection.
1053
848=item $success = $term->selection_grab ($eventtime) 1054=item $success = $term->selection_grab ($eventtime)
849 1055
850Try to request the primary selection from the server (for example, as set 1056Try to request the primary selection text from the server (for example, as
851by the next method). 1057set by the next method). No visual feedback will be given. This function
1058is mostly useful from within C<on_sel_grab> hooks.
852 1059
853=item $oldtext = $term->selection ([$newtext]) 1060=item $oldtext = $term->selection ([$newtext])
854 1061
855Return the current selection text and optionally replace it by C<$newtext>. 1062Return the current selection text and optionally replace it by C<$newtext>.
856 1063
949Convert the given locale-encoded octets into a perl string. 1156Convert the given locale-encoded octets into a perl string.
950 1157
951=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1158=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
952 1159
953XORs the rendition values in the given span with the provided value 1160XORs the rendition values in the given span with the provided value
954(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1161(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
955to the selection. 1162refresh hooks to provide effects similar to the selection.
956 1163
957=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1164=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
958 1165
959Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1166Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
960whitespace will additionally be xored with the C<$rstyle2>, which defaults 1167whitespace will additionally be xored with the C<$rstyle2>, which defaults
961to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1168to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
962it instead. 1169it instead. Both styles I<MUST NOT> contain font styles.
963 1170
964=item $term->scr_bell 1171=item $term->scr_bell
965 1172
966Ring the bell! 1173Ring the bell!
967 1174
1001 1208
1002=item $windowid = $term->vt 1209=item $windowid = $term->vt
1003 1210
1004Return the window id of the terminal window. 1211Return the window id of the terminal window.
1005 1212
1213=item $term->vt_emask_add ($x_event_mask)
1214
1215Adds the specified events to the vt event mask. Useful e.g. when you want
1216to receive pointer events all the times:
1217
1218 $term->vt_emask_add (urxvt::PointerMotionMask);
1219
1006=item $window_width = $term->width 1220=item $window_width = $term->width
1007 1221
1008=item $window_height = $term->height 1222=item $window_height = $term->height
1009 1223
1010=item $font_width = $term->fwidth 1224=item $font_width = $term->fwidth
1023 1237
1024=item $max_scrollback = $term->saveLines 1238=item $max_scrollback = $term->saveLines
1025 1239
1026=item $nrow_plus_saveLines = $term->total_rows 1240=item $nrow_plus_saveLines = $term->total_rows
1027 1241
1028=item $lines_in_scrollback = $term->nsaved 1242=item $topmost_scrollback_row = $term->top_row
1029 1243
1030Return various integers describing terminal characteristics. 1244Return various integers describing terminal characteristics.
1031 1245
1246=item $x_display = $term->display_id
1247
1248Return the DISPLAY used by rxvt-unicode.
1249
1032=item $lc_ctype = $term->locale 1250=item $lc_ctype = $term->locale
1033 1251
1034Returns the LC_CTYPE category string used by this rxvt-unicode. 1252Returns the LC_CTYPE category string used by this rxvt-unicode.
1035 1253
1036=item $x_display = $term->display_id 1254=item $env = $term->env
1037 1255
1038Return the DISPLAY used by rxvt-unicode. 1256Returns a copy of the environment in effect for the terminal as a hashref
1257similar to C<\%ENV>.
1258
1259=cut
1260
1261sub env {
1262 if (my $env = $_[0]->_env) {
1263 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1264 } else {
1265 +{ %ENV }
1266 }
1267}
1039 1268
1040=item $modifiermask = $term->ModLevel3Mask 1269=item $modifiermask = $term->ModLevel3Mask
1041 1270
1042=item $modifiermask = $term->ModMetaMask 1271=item $modifiermask = $term->ModMetaMask
1043 1272
1046Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1275Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1047AltGr), the meta key (often Alt) and the num lock key, if applicable. 1276AltGr), the meta key (often Alt) and the num lock key, if applicable.
1048 1277
1049=item $view_start = $term->view_start ([$newvalue]) 1278=item $view_start = $term->view_start ([$newvalue])
1050 1279
1051Returns the negative row number of the topmost line. Minimum value is 1280Returns the row number of the topmost displayed line. Maximum value is
1052C<0>, which displays the normal terminal contents. Larger values scroll 1281C<0>, which displays the normal terminal contents. Lower values scroll
1053this many lines into the scrollback buffer. 1282this many lines into the scrollback buffer.
1054 1283
1055=item $term->want_refresh 1284=item $term->want_refresh
1056 1285
1057Requests a screen refresh. At the next opportunity, rxvt-unicode will 1286Requests a screen refresh. At the next opportunity, rxvt-unicode will
1136Return the row number of the first/last row of the line, respectively. 1365Return the row number of the first/last row of the line, respectively.
1137 1366
1138=item $offset = $line->offset_of ($row, $col) 1367=item $offset = $line->offset_of ($row, $col)
1139 1368
1140Returns the character offset of the given row|col pair within the logical 1369Returns the character offset of the given row|col pair within the logical
1141line. 1370line. Works for rows outside the line, too, and returns corresponding
1371offsets outside the string.
1142 1372
1143=item ($row, $col) = $line->coord_of ($offset) 1373=item ($row, $col) = $line->coord_of ($offset)
1144 1374
1145Translates a string offset into terminal coordinates again. 1375Translates a string offset into terminal coordinates again.
1146 1376
1283 $item->{render} ||= sub { $_[0]{text} }; 1513 $item->{render} ||= sub { $_[0]{text} };
1284 1514
1285 push @{ $self->{item} }, $item; 1515 push @{ $self->{item} }, $item;
1286} 1516}
1287 1517
1518=item $popup->add_title ($title)
1519
1520Adds a non-clickable title to the popup.
1521
1522=cut
1523
1524sub add_title {
1525 my ($self, $title) = @_;
1526
1527 $self->add_item ({
1528 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1529 text => $title,
1530 activate => sub { },
1531 });
1532}
1533
1534=item $popup->add_separator ([$sepchr])
1535
1536Creates a separator, optionally using the character given as C<$sepchr>.
1537
1538=cut
1539
1288sub add_separator { 1540sub add_separator {
1289 my ($self, $sep) = @_; 1541 my ($self, $sep) = @_;
1290 1542
1291 $sep ||= "="; 1543 $sep ||= "=";
1292 1544
1296 render => sub { $sep x $self->{term}->ncol }, 1548 render => sub { $sep x $self->{term}->ncol },
1297 activate => sub { }, 1549 activate => sub { },
1298 }); 1550 });
1299} 1551}
1300 1552
1301sub add_title { 1553=item $popup->add_button ($text, $cb)
1302 my ($self, $title) = @_;
1303 1554
1304 $self->add_item ({ 1555Adds a clickable button to the popup. C<$cb> is called whenever it is
1305 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, 1556selected.
1306 text => $title, 1557
1307 activate => sub { }, 1558=cut
1308 });
1309}
1310 1559
1311sub add_button { 1560sub add_button {
1312 my ($self, $text, $cb) = @_; 1561 my ($self, $text, $cb) = @_;
1313 1562
1314 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1563 $self->add_item ({ type => "button", text => $text, activate => $cb});
1315} 1564}
1565
1566=item $popup->add_toggle ($text, $cb, $initial_value)
1567
1568Adds a toggle/checkbox item to the popup. Teh callback gets called
1569whenever it gets toggled, with a boolean indicating its value as its first
1570argument.
1571
1572=cut
1316 1573
1317sub add_toggle { 1574sub add_toggle {
1318 my ($self, $text, $cb, $value) = @_; 1575 my ($self, $text, $cb, $value) = @_;
1319 1576
1320 my $item; $item = { 1577 my $item; $item = {
1321 type => "button", 1578 type => "button",
1322 text => " $text", 1579 text => " $text",
1323 value => $value, 1580 value => $value,
1324 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1581 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1582 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326 }; 1583 };
1327 1584
1328 $self->add_item ($item); 1585 $self->add_item ($item);
1329} 1586}
1587
1588=item $popup->show
1589
1590Displays the popup (which is initially hidden).
1591
1592=cut
1330 1593
1331sub show { 1594sub show {
1332 my ($self) = @_; 1595 my ($self) = @_;
1333 1596
1334 local $urxvt::popup::self = $self; 1597 local $urxvt::popup::self = $self;
1335 1598
1599 my $env = $self->{term}->env;
1600 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1601 delete $env->{LC_ALL};
1336 local $ENV{LC_ALL} = $self->{term}->locale; 1602 $env->{LC_CTYPE} = $self->{term}->locale;
1337 1603
1338 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1604 urxvt::term->new ($env, "popup",
1605 "--perl-lib" => "", "--perl-ext-common" => "",
1606 "-pty-fd" => -1, "-sl" => 0, "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1339 "--transient-for" => $self->{term}->parent, 1607 "--transient-for" => $self->{term}->parent,
1340 "-display" => $self->{term}->display_id, 1608 "-display" => $self->{term}->display_id,
1341 "-pe" => "urxvt-popup") 1609 "-pe" => "urxvt-popup")
1342 or die "unable to create popup window\n"; 1610 or die "unable to create popup window\n";
1343} 1611}
1344 1612
1345sub DESTROY { 1613sub DESTROY {
1346 my ($self) = @_; 1614 my ($self) = @_;
1347 1615
1348 delete $self->{term}{_destroy}{$self}; 1616 delete $self->{term}{_destroy}{$self};
1349 $self->{term}->ungrab; 1617 $self->{term}->ungrab;
1350} 1618}
1619
1620=back
1351 1621
1352=head2 The C<urxvt::timer> Class 1622=head2 The C<urxvt::timer> Class
1353 1623
1354This class implements timer watchers/events. Time is represented as a 1624This class implements timer watchers/events. Time is represented as a
1355fractional number of seconds since the epoch. Example: 1625fractional number of seconds since the epoch. Example:
1393Start the timer. 1663Start the timer.
1394 1664
1395=item $timer = $timer->start ($tstamp) 1665=item $timer = $timer->start ($tstamp)
1396 1666
1397Set the event trigger time to C<$tstamp> and start the timer. 1667Set the event trigger time to C<$tstamp> and start the timer.
1668
1669=item $timer = $timer->after ($delay)
1670
1671Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1398 1672
1399=item $timer = $timer->stop 1673=item $timer = $timer->stop
1400 1674
1401Stop the timer. 1675Stop the timer.
1402 1676
1462 1736
1463=item == 0 - fatal messages 1737=item == 0 - fatal messages
1464 1738
1465=item >= 3 - script loading and management 1739=item >= 3 - script loading and management
1466 1740
1467=item >=10 - all events received 1741=item >=10 - all called hooks
1742
1743=item >=11 - hook reutrn values
1468 1744
1469=back 1745=back
1470 1746
1471=head1 AUTHOR 1747=head1 AUTHOR
1472 1748

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines