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.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.107 by root, Wed Jan 18 21:30:50 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.
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 };
70 111
71=item searchable-scrollback<hotkey> (enabled by default) 112=item searchable-scrollback<hotkey> (enabled by default)
72 113
73Adds regex search functionality to the scrollback buffer, triggered 114Adds regex search functionality to the scrollback buffer, triggered
74by a hotkey (default: C<M-s>). When in search mode, normal terminal 115by a hotkey (default: C<M-s>). While in search mode, normal terminal
75input/output is suspended. 116input/output is suspended and a regex is displayed at the bottom of the
117screen.
76 118
77C</> starts an incremental regex search, C<n> searches further, C<p> or 119Inputting characters appends them to the regex and continues incremental
78C<N> jump to the previous match, C<G> jumps to the bottom and clears the 120search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
79history, C<enter> leaves search mode at the current position and C<escape> 121search upwards/downwards in the scrollback buffer, C<End> jumps to the
80returns to the original position. 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.
81 126
82=item digital-clock 127=item selection-autotransform
83 128
84Displays a digital clock using the built-in overlay. 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.
85 161
86=item mark-urls 162=item mark-urls
87 163
88Uses 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
89 176
90=item block-graphics-to-ascii 177=item block-graphics-to-ascii
91 178
92A 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,
93by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
94similar-looking ascii character. 181similar-looking ascii character.
95 182
183=item digital-clock
184
185Displays a digital clock using the built-in overlay.
186
96=item example-refresh-hooks 187=item example-refresh-hooks
97 188
98Displays 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
99window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
100overlays or changes. 191overlays or changes.
101 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
102=back 222=back
223
224=head1 API DOCUMENTATION
103 225
104=head2 General API Considerations 226=head2 General API Considerations
105 227
106All objects (such as terminals, time watchers etc.) are typical 228All objects (such as terminals, time watchers etc.) are typical
107reference-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
120=over 4 242=over 4
121 243
122=item $text 244=item $text
123 245
124Rxvt-unicodes special way of encoding text, where one "unicode" character 246Rxvt-unicodes special way of encoding text, where one "unicode" character
125always 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.
126 248
127=item $string 249=item $string
128 250
129A 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
130characters and is to be distinguished with text encoded in a specific 252characters and is to be distinguished with text encoded in a specific
225=item on_sel_extend $term 347=item on_sel_extend $term
226 348
227Called 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
228click) and is either supposed to return false (normal operation), or 350click) and is either supposed to return false (normal operation), or
229should 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
230processing. 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.
231 355
232See the F<selection> example extension. 356See the F<selection> example extension.
233 357
234=item on_view_change $term, $offset 358=item on_view_change $term, $offset
235 359
302 426
303Called whenever the user presses a key combination that has a 427Called whenever the user presses a key combination that has a
304C<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>
305resource in the @@RXVT_NAME@@(1) manpage). 429resource in the @@RXVT_NAME@@(1) manpage).
306 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
307=item on_focus_in $term 437=item on_focus_in $term
308 438
309Called whenever the window gets the keyboard focus, before rxvt-unicode 439Called whenever the window gets the keyboard focus, before rxvt-unicode
310does focus in processing. 440does focus in processing.
311 441
312=item on_focus_out $term 442=item on_focus_out $term
313 443
314Called wheneever the window loses keyboard focus, before rxvt-unicode does 444Called wheneever the window loses keyboard focus, before rxvt-unicode does
315focus out processing. 445focus out processing.
446
447=item on_configure_notify $term, $event
316 448
317=item on_key_press $term, $event, $keysym, $octets 449=item on_key_press $term, $event, $keysym, $octets
318 450
319=item on_key_release $term, $event, $keysym 451=item on_key_release $term, $event, $keysym
320 452
337 469
338C<on_key_press> additionally receives the string rxvt-unicode would 470C<on_key_press> additionally receives the string rxvt-unicode would
339output, if any, in locale-specific encoding. 471output, if any, in locale-specific encoding.
340 472
341subwindow. 473subwindow.
342
343=back
344
345=head2 Variables in the C<urxvt> Package
346
347=over 4
348
349=item $urxvt::TERM
350
351The current terminal. This variable stores the current C<urxvt::term>
352object, whenever a callback/hook is executing.
353
354=back
355
356=head2 Functions in the C<urxvt> Package
357
358=over 4
359
360=item $term = new urxvt [arg...]
361
362Creates a new terminal, very similar as if you had started it with
363C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364if the new instance couldn't be created. Returns C<undef> if the new
365instance didn't initialise perl, and the terminal object otherwise. The
366C<init> and C<start> hooks will be called during the call.
367
368=item urxvt::fatal $errormessage
369
370Fatally aborts execution with the given error message. Avoid at all
371costs! The only time this is acceptable is when the terminal process
372starts up.
373
374=item urxvt::warn $string
375
376Calls C<rxvt_warn> with the given string which should not include a
377newline. The module also overwrites the C<warn> builtin with a function
378that calls this function.
379
380Using this function has the advantage that its output ends up in the
381correct place, e.g. on stderr of the connecting urxvtc client.
382
383=item $is_safe = urxvt::safe
384
385Returns true when it is safe to do potentially unsafe things, such as
386evaluating perl code specified by the user. This is true when urxvt was
387started setuid or setgid.
388
389=item $time = urxvt::NOW
390
391Returns the "current time" (as per the event loop).
392
393=item urxvt::CurrentTime
394
395=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397Button4Mask, Button5Mask, AnyModifier
398
399Various constants for use in X calls and event processing.
400
401=back
402
403=head2 RENDITION
404
405Rendition bitsets contain information about colour, font, font styles and
406similar information for each screen cell.
407
408The following "macros" deal with changes in rendition sets. You should
409never just create a bitset, you should always modify an existing one,
410as they contain important information required for correct operation of
411rxvt-unicode.
412
413=over 4
414
415=item $rend = urxvt::DEFAULT_RSTYLE
416
417Returns the default rendition, as used when the terminal is starting up or
418being reset. Useful as a base to start when creating renditions.
419
420=item $rend = urxvt::OVERLAY_RSTYLE
421
422Return the rendition mask used for overlays by default.
423
424=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426Return the bit that enabled bold, italic, blink, reverse-video and
427underline, respectively. To enable such a style, just logically OR it into
428the bitset.
429
430=item $foreground = urxvt::GET_BASEFG $rend
431
432=item $background = urxvt::GET_BASEBG $rend
433
434Return the foreground/background colour index, respectively.
435
436=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440Replace the foreground/background colour in the rendition mask with the
441specified one.
442
443=item $value = urxvt::GET_CUSTOM ($rend)
444
445Return the "custom" value: Every rendition has 5 bits for use by
446extensions. They can be set and changed as you like and are initially
447zero.
448
449=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451Change the custom value.
452 474
453=back 475=back
454 476
455=cut 477=cut
456 478
471our $LIBDIR; 493our $LIBDIR;
472our $RESNAME; 494our $RESNAME;
473our $RESCLASS; 495our $RESCLASS;
474our $RXVTNAME; 496our $RXVTNAME;
475 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
626
476BEGIN { 627BEGIN {
477 urxvt->bootstrap;
478
479 # overwrite perl's warn 628 # overwrite perl's warn
480 *CORE::GLOBAL::warn = sub { 629 *CORE::GLOBAL::warn = sub {
481 my $msg = join "", @_; 630 my $msg = join "", @_;
482 $msg .= "\n" 631 $msg .= "\n"
483 unless $msg =~ /\n$/; 632 unless $msg =~ /\n$/;
484 urxvt::warn ($msg); 633 urxvt::warn ($msg);
485 }; 634 };
486
487 delete $ENV{IFS};
488 delete $ENV{CDPATH};
489 delete $ENV{BASH_ENV};
490 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491} 635}
492 636
493my @hook_count;
494my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 637my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495 638
496sub verbose { 639sub verbose {
497 my ($level, $msg) = @_; 640 my ($level, $msg) = @_;
498 warn "$msg\n" if $level <= $verbosity; 641 warn "$msg\n" if $level <= $verbosity;
499} 642}
500 643
501my $extension_pkg = "extension0000";
502my %extension_pkg; 644my %extension_pkg;
503 645
504# load a single script into its own package, once only 646# load a single script into its own package, once only
505sub extension_package($) { 647sub extension_package($) {
506 my ($path) = @_; 648 my ($path) = @_;
507 649
650 no strict 'refs';
651
508 $extension_pkg{$path} ||= do { 652 $extension_pkg{$path} ||= do {
509 my $pkg = "urxvt::" . ($extension_pkg++); 653 $path =~ /([^\/\\]+)$/;
654 my $pkg = $1;
655 $pkg =~ s/[^[:word:]]/_/g;
656 $pkg = "urxvt::ext::$pkg";
510 657
511 verbose 3, "loading extension '$path' into package '$pkg'"; 658 verbose 3, "loading extension '$path' into package '$pkg'";
512 659
513 open my $fh, "<:raw", $path 660 open my $fh, "<:raw", $path
514 or die "$path: $!"; 661 or die "$path: $!";
515 662
663 @{"$pkg\::ISA"} = urxvt::term::extension::;
664
516 my $source = untaint 665 my $source =
517 "package $pkg; use strict; use utf8;\n" 666 "package $pkg; use strict; use utf8;\n"
518 . "use base urxvt::term::extension::;\n"
519 . "#line 1 \"$path\"\n{\n" 667 . "#line 1 \"$path\"\n{\n"
520 . (do { local $/; <$fh> }) 668 . (do { local $/; <$fh> })
521 . "\n};\n1"; 669 . "\n};\n1";
522 670
523 eval $source 671 eval $source
580 if ($@) { 728 if ($@) {
581 $TERM->ungrab; # better to lose the grab than the session 729 $TERM->ungrab; # better to lose the grab than the session
582 warn $@; 730 warn $@;
583 } 731 }
584 } 732 }
733
734 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
735 if $verbosity >= 11;
585 } 736 }
586 737
587 if ($htype == 1) { # DESTROY 738 if ($htype == 1) { # DESTROY
588 if (my $hook = delete $TERM->{_hook}) {
589 for my $htype (0..$#$hook) {
590 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
591 or set_should_invoke $htype, 0;
592 }
593 }
594
595 # clear package objects 739 # clear package objects
596 %$_ = () for values %{ $TERM->{_pkg} }; 740 %$_ = () for values %{ $TERM->{_pkg} };
597 741
598 # clear package 742 # clear package
599 %$TERM = (); 743 %$TERM = ();
600 } 744 }
601 745
602 $retval 746 $retval
747}
748
749sub exec_async(@) {
750 my $pid = fork;
751
752 return
753 if !defined $pid or $pid;
754
755 %ENV = %{ $TERM->env };
756
757 exec @_;
758 _exit 255;
603} 759}
604 760
605# urxvt::term::extension 761# urxvt::term::extension
606 762
607package urxvt::term::extension; 763package urxvt::term::extension;
613 while (my ($name, $cb) = each %hook) { 769 while (my ($name, $cb) = each %hook) {
614 my $htype = $HOOKTYPE{uc $name}; 770 my $htype = $HOOKTYPE{uc $name};
615 defined $htype 771 defined $htype
616 or Carp::croak "unsupported hook type '$name'"; 772 or Carp::croak "unsupported hook type '$name'";
617 773
774 $self->set_should_invoke ($htype, +1)
618 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 775 unless exists $self->{term}{_hook}[$htype]{$pkg};
619 $hook_count[$htype]++
620 or urxvt::set_should_invoke $htype, 1;
621 }
622 776
623 $self->{term}{_hook}[$htype]{$pkg} = $cb; 777 $self->{term}{_hook}[$htype]{$pkg} = $cb;
624 } 778 }
625} 779}
626 780
631 for my $name (@hook) { 785 for my $name (@hook) {
632 my $htype = $HOOKTYPE{uc $name}; 786 my $htype = $HOOKTYPE{uc $name};
633 defined $htype 787 defined $htype
634 or Carp::croak "unsupported hook type '$name'"; 788 or Carp::croak "unsupported hook type '$name'";
635 789
790 $self->set_should_invoke ($htype, -1)
636 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 791 if delete $self->{term}{_hook}[$htype]{$pkg};
637 --$hook_count[$htype]
638 or urxvt::set_should_invoke $htype, 0;
639 }
640 } 792 }
641} 793}
642 794
643our $AUTOLOAD; 795our $AUTOLOAD;
644 796
675 827
676=head2 The C<urxvt::anyevent> Class 828=head2 The C<urxvt::anyevent> Class
677 829
678The sole purpose of this class is to deliver an interface to the 830The sole purpose of this class is to deliver an interface to the
679C<AnyEvent> module - any module using it will work inside urxvt without 831C<AnyEvent> module - any module using it will work inside urxvt without
680further work. The only exception is that you cannot wait on condition 832further programming. The only exception is that you cannot wait on
681variables, but non-blocking condvar use is ok. What this means is that you 833condition variables, but non-blocking condvar use is ok. What this means
682cannot use blocking APIs, but the non-blocking variant should work. 834is that you cannot use blocking APIs, but the non-blocking variant should
835work.
683 836
684=cut 837=cut
685 838
686our $VERSION = 1; 839our $VERSION = 1;
687 840
764 $proxy->enable ($name => $ref); 917 $proxy->enable ($name => $ref);
765 } 918 }
766 } 919 }
767} 920}
768 921
922=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
923
924Creates a new terminal, very similar as if you had started it with system
925C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
926hash which defines the environment of the new terminal.
927
928Croaks (and probably outputs an error message) if the new instance
929couldn't be created. Returns C<undef> if the new instance didn't
930initialise perl, and the terminal object otherwise. The C<init> and
931C<start> hooks will be called during this call.
932
933=cut
934
935sub new {
936 my ($class, $env, @args) = @_;
937
938 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
939}
940
769=item $term->destroy 941=item $term->destroy
770 942
771Destroy the terminal object (close the window, free resources etc.). 943Destroy the terminal object (close the window, free resources
944etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945watchers (timers, io watchers) are still active.
772 946
773=item $isset = $term->option ($optval[, $set]) 947=item $isset = $term->option ($optval[, $set])
774 948
775Returns true if the option specified by C<$optval> is enabled, and 949Returns true if the option specified by C<$optval> is enabled, and
776optionally change it. All option values are stored by name in the hash 950optionally change it. All option values are stored by name in the hash
779Here is a a likely non-exhaustive list of option names, please see the 953Here is a a likely non-exhaustive list of option names, please see the
780source file F</src/optinc.h> to see the actual list: 954source file F</src/optinc.h> to see the actual list:
781 955
782 borderLess console cursorBlink cursorUnderline hold iconic insecure 956 borderLess console cursorBlink cursorUnderline hold iconic insecure
783 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 957 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 958 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
785 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 959 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
786 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 960 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
787 tripleclickwords utmpInhibit visualBell 961 transparent tripleclickwords utmpInhibit visualBell
788 962
789=item $value = $term->resource ($name[, $newval]) 963=item $value = $term->resource ($name[, $newval])
790 964
791Returns the current resource value associated with a given name and 965Returns the current resource value associated with a given name and
792optionally sets a new value. Setting values is most useful in the C<init> 966optionally sets a new value. Setting values is most useful in the C<init>
809 983
810 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 984 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
811 borderLess color cursorBlink cursorUnderline cutchars delete_key 985 borderLess color cursorBlink cursorUnderline cutchars delete_key
812 display_name embed ext_bwidth fade font geometry hold iconName 986 display_name embed ext_bwidth fade font geometry hold iconName
813 imFont imLocale inputMethod insecure int_bwidth intensityStyles 987 imFont imLocale inputMethod insecure int_bwidth intensityStyles
814 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 988 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
815 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 989 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
816 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 990 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
817 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 991 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
818 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 992 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
819 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 993 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
820 shade term_name title transparent transparent_all tripleclickwords 994 secondaryScreen secondaryScroll selectstyle shade term_name title
821 utmpInhibit visualBell 995 transient_for transparent transparent_all tripleclickwords utmpInhibit
996 visualBell
822 997
823=cut 998=cut
824 999
825sub resource($$;$) { 1000sub resource($$;$) {
826 my ($self, $name) = (shift, shift); 1001 my ($self, $name) = (shift, shift);
827 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1002 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
828 &urxvt::term::_resource 1003 &urxvt::term::_resource
829} 1004}
830 1005
1006=item $value = $term->x_resource ($pattern)
1007
1008Returns the X-Resource for the given pattern, excluding the program or
1009class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1010same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1011resource with that pattern exists.
1012
1013This method should only be called during the C<on_start> hook, as there is
1014only one resource database per display, and later invocations might return
1015the wrong resources.
1016
831=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1017=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832 1018
833Adds a keymap translation exactly as specified via a resource. See the 1019Adds a keymap translation exactly as specified via a resource. See the
834C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1020C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835 1021
850=item ($row, $col) = $term->selection_end ([$row, $col]) 1036=item ($row, $col) = $term->selection_end ([$row, $col])
851 1037
852Return the current values of the selection mark, begin or end positions, 1038Return the current values of the selection mark, begin or end positions,
853and optionally set them to new values. 1039and optionally set them to new values.
854 1040
1041=item $term->selection_make ($eventtime[, $rectangular])
1042
1043Tries to make a selection as set by C<selection_beg> and
1044C<selection_end>. If C<$rectangular> is true (default: false), a
1045rectangular selection will be made. This is the prefered function to make
1046a selection.
1047
855=item $success = $term->selection_grab ($eventtime) 1048=item $success = $term->selection_grab ($eventtime)
856 1049
857Try to request the primary selection from the server (for example, as set 1050Try to request the primary selection text from the server (for example, as
858by the next method). 1051set by the next method). No visual feedback will be given. This function
1052is mostly useful from within C<on_sel_grab> hooks.
859 1053
860=item $oldtext = $term->selection ([$newtext]) 1054=item $oldtext = $term->selection ([$newtext])
861 1055
862Return the current selection text and optionally replace it by C<$newtext>. 1056Return the current selection text and optionally replace it by C<$newtext>.
863 1057
956Convert the given locale-encoded octets into a perl string. 1150Convert the given locale-encoded octets into a perl string.
957 1151
958=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1152=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959 1153
960XORs the rendition values in the given span with the provided value 1154XORs the rendition values in the given span with the provided value
961(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1155(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962to the selection. 1156refresh hooks to provide effects similar to the selection.
963 1157
964=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1158=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965 1159
966Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1160Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967whitespace will additionally be xored with the C<$rstyle2>, which defaults 1161whitespace will additionally be xored with the C<$rstyle2>, which defaults
968to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1162to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
969it instead. 1163it instead. Both styles I<MUST NOT> contain font styles.
970 1164
971=item $term->scr_bell 1165=item $term->scr_bell
972 1166
973Ring the bell! 1167Ring the bell!
974 1168
1008 1202
1009=item $windowid = $term->vt 1203=item $windowid = $term->vt
1010 1204
1011Return the window id of the terminal window. 1205Return the window id of the terminal window.
1012 1206
1207=item $term->vt_emask_add ($x_event_mask)
1208
1209Adds the specified events to the vt event mask. Useful e.g. when you want
1210to receive pointer events all the times:
1211
1212 $term->vt_emask_add (urxvt::PointerMotionMask);
1213
1013=item $window_width = $term->width 1214=item $window_width = $term->width
1014 1215
1015=item $window_height = $term->height 1216=item $window_height = $term->height
1016 1217
1017=item $font_width = $term->fwidth 1218=item $font_width = $term->fwidth
1030 1231
1031=item $max_scrollback = $term->saveLines 1232=item $max_scrollback = $term->saveLines
1032 1233
1033=item $nrow_plus_saveLines = $term->total_rows 1234=item $nrow_plus_saveLines = $term->total_rows
1034 1235
1035=item $lines_in_scrollback = $term->nsaved 1236=item $topmost_scrollback_row = $term->top_row
1036 1237
1037Return various integers describing terminal characteristics. 1238Return various integers describing terminal characteristics.
1038 1239
1240=item $x_display = $term->display_id
1241
1242Return the DISPLAY used by rxvt-unicode.
1243
1039=item $lc_ctype = $term->locale 1244=item $lc_ctype = $term->locale
1040 1245
1041Returns the LC_CTYPE category string used by this rxvt-unicode. 1246Returns the LC_CTYPE category string used by this rxvt-unicode.
1042 1247
1043=item $x_display = $term->display_id 1248=item $env = $term->env
1044 1249
1045Return the DISPLAY used by rxvt-unicode. 1250Returns a copy of the environment in effect for the terminal as a hashref
1251similar to C<\%ENV>.
1252
1253=cut
1254
1255sub env {
1256 if (my $env = $_[0]->_env) {
1257 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1258 } else {
1259 +{ %ENV }
1260 }
1261}
1046 1262
1047=item $modifiermask = $term->ModLevel3Mask 1263=item $modifiermask = $term->ModLevel3Mask
1048 1264
1049=item $modifiermask = $term->ModMetaMask 1265=item $modifiermask = $term->ModMetaMask
1050 1266
1053Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1269Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1054AltGr), the meta key (often Alt) and the num lock key, if applicable. 1270AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055 1271
1056=item $view_start = $term->view_start ([$newvalue]) 1272=item $view_start = $term->view_start ([$newvalue])
1057 1273
1058Returns the negative row number of the topmost line. Minimum value is 1274Returns the row number of the topmost displayed line. Maximum value is
1059C<0>, which displays the normal terminal contents. Larger values scroll 1275C<0>, which displays the normal terminal contents. Lower values scroll
1060this many lines into the scrollback buffer. 1276this many lines into the scrollback buffer.
1061 1277
1062=item $term->want_refresh 1278=item $term->want_refresh
1063 1279
1064Requests a screen refresh. At the next opportunity, rxvt-unicode will 1280Requests a screen refresh. At the next opportunity, rxvt-unicode will
1143Return the row number of the first/last row of the line, respectively. 1359Return the row number of the first/last row of the line, respectively.
1144 1360
1145=item $offset = $line->offset_of ($row, $col) 1361=item $offset = $line->offset_of ($row, $col)
1146 1362
1147Returns the character offset of the given row|col pair within the logical 1363Returns the character offset of the given row|col pair within the logical
1148line. 1364line. Works for rows outside the line, too, and returns corresponding
1365offsets outside the string.
1149 1366
1150=item ($row, $col) = $line->coord_of ($offset) 1367=item ($row, $col) = $line->coord_of ($offset)
1151 1368
1152Translates a string offset into terminal coordinates again. 1369Translates a string offset into terminal coordinates again.
1153 1370
1290 $item->{render} ||= sub { $_[0]{text} }; 1507 $item->{render} ||= sub { $_[0]{text} };
1291 1508
1292 push @{ $self->{item} }, $item; 1509 push @{ $self->{item} }, $item;
1293} 1510}
1294 1511
1512=item $popup->add_title ($title)
1513
1514Adds a non-clickable title to the popup.
1515
1516=cut
1517
1518sub add_title {
1519 my ($self, $title) = @_;
1520
1521 $self->add_item ({
1522 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1523 text => $title,
1524 activate => sub { },
1525 });
1526}
1527
1528=item $popup->add_separator ([$sepchr])
1529
1530Creates a separator, optionally using the character given as C<$sepchr>.
1531
1532=cut
1533
1295sub add_separator { 1534sub add_separator {
1296 my ($self, $sep) = @_; 1535 my ($self, $sep) = @_;
1297 1536
1298 $sep ||= "="; 1537 $sep ||= "=";
1299 1538
1303 render => sub { $sep x $self->{term}->ncol }, 1542 render => sub { $sep x $self->{term}->ncol },
1304 activate => sub { }, 1543 activate => sub { },
1305 }); 1544 });
1306} 1545}
1307 1546
1308sub add_title { 1547=item $popup->add_button ($text, $cb)
1309 my ($self, $title) = @_;
1310 1548
1311 $self->add_item ({ 1549Adds a clickable button to the popup. C<$cb> is called whenever it is
1312 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, 1550selected.
1313 text => $title, 1551
1314 activate => sub { }, 1552=cut
1315 });
1316}
1317 1553
1318sub add_button { 1554sub add_button {
1319 my ($self, $text, $cb) = @_; 1555 my ($self, $text, $cb) = @_;
1320 1556
1321 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1557 $self->add_item ({ type => "button", text => $text, activate => $cb});
1322} 1558}
1559
1560=item $popup->add_toggle ($text, $cb, $initial_value)
1561
1562Adds a toggle/checkbox item to the popup. Teh callback gets called
1563whenever it gets toggled, with a boolean indicating its value as its first
1564argument.
1565
1566=cut
1323 1567
1324sub add_toggle { 1568sub add_toggle {
1325 my ($self, $text, $cb, $value) = @_; 1569 my ($self, $text, $cb, $value) = @_;
1326 1570
1327 my $item; $item = { 1571 my $item; $item = {
1328 type => "button", 1572 type => "button",
1329 text => " $text", 1573 text => " $text",
1330 value => $value, 1574 value => $value,
1331 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1575 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1576 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333 }; 1577 };
1334 1578
1335 $self->add_item ($item); 1579 $self->add_item ($item);
1336} 1580}
1581
1582=item $popup->show
1583
1584Displays the popup (which is initially hidden).
1585
1586=cut
1337 1587
1338sub show { 1588sub show {
1339 my ($self) = @_; 1589 my ($self) = @_;
1340 1590
1341 local $urxvt::popup::self = $self; 1591 local $urxvt::popup::self = $self;
1342 1592
1593 my $env = $self->{term}->env;
1594 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1595 delete $env->{LC_ALL};
1343 local $ENV{LC_ALL} = $self->{term}->locale; 1596 $env->{LC_CTYPE} = $self->{term}->locale;
1344 1597
1345 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1598 urxvt::term->new ($env, "popup",
1599 "--perl-lib" => "", "--perl-ext-common" => "",
1600 "-pty-fd" => -1, "-sl" => 0,
1601 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1346 "--transient-for" => $self->{term}->parent, 1602 "--transient-for" => $self->{term}->parent,
1347 "-display" => $self->{term}->display_id, 1603 "-display" => $self->{term}->display_id,
1348 "-pe" => "urxvt-popup") 1604 "-pe" => "urxvt-popup")
1349 or die "unable to create popup window\n"; 1605 or die "unable to create popup window\n";
1350} 1606}
1351 1607
1352sub DESTROY { 1608sub DESTROY {
1353 my ($self) = @_; 1609 my ($self) = @_;
1354 1610
1355 delete $self->{term}{_destroy}{$self}; 1611 delete $self->{term}{_destroy}{$self};
1356 $self->{term}->ungrab; 1612 $self->{term}->ungrab;
1357} 1613}
1614
1615=back
1358 1616
1359=head2 The C<urxvt::timer> Class 1617=head2 The C<urxvt::timer> Class
1360 1618
1361This class implements timer watchers/events. Time is represented as a 1619This class implements timer watchers/events. Time is represented as a
1362fractional number of seconds since the epoch. Example: 1620fractional number of seconds since the epoch. Example:
1400Start the timer. 1658Start the timer.
1401 1659
1402=item $timer = $timer->start ($tstamp) 1660=item $timer = $timer->start ($tstamp)
1403 1661
1404Set the event trigger time to C<$tstamp> and start the timer. 1662Set the event trigger time to C<$tstamp> and start the timer.
1663
1664=item $timer = $timer->after ($delay)
1665
1666Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405 1667
1406=item $timer = $timer->stop 1668=item $timer = $timer->stop
1407 1669
1408Stop the timer. 1670Stop the timer.
1409 1671
1469 1731
1470=item == 0 - fatal messages 1732=item == 0 - fatal messages
1471 1733
1472=item >= 3 - script loading and management 1734=item >= 3 - script loading and management
1473 1735
1474=item >=10 - all events received 1736=item >=10 - all called hooks
1737
1738=item >=11 - hook reutrn values
1475 1739
1476=back 1740=back
1477 1741
1478=head1 AUTHOR 1742=head1 AUTHOR
1479 1743

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines