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.109 by root, Thu Jan 19 16:07:09 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 };
111
112Don't run it in a hook, otherwise the menu will grow and grow. Instead put
113it at the toplevel of your extension.
70 114
71=item searchable-scrollback<hotkey> (enabled by default) 115=item searchable-scrollback<hotkey> (enabled by default)
72 116
73Adds regex search functionality to the scrollback buffer, triggered 117Adds regex search functionality to the scrollback buffer, triggered
74by a hotkey (default: C<M-s>). When in search mode, normal terminal 118by a hotkey (default: C<M-s>). While in search mode, normal terminal
75input/output is suspended. 119input/output is suspended and a regex is displayed at the bottom of the
120screen.
76 121
77C</> starts an incremental regex search, C<n> searches further, C<p> or 122Inputting 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 123search. 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> 124search upwards/downwards in the scrollback buffer, C<End> jumps to the
80returns to the original position. 125bottom. C<Escape> leaves search mode and returns to the point where search
126was started, while C<Enter> or C<Return> stay at the current position and
127additionally stores the first match in the current line into the primary
128selection.
81 129
82=item digital-clock 130=item selection-autotransform
83 131
84Displays a digital clock using the built-in overlay. 132This selection allows you to do automatic transforms on a selection
133whenever a selection is made.
134
135It works by specifying perl snippets (most useful is a single C<s///>
136operator) that modify C<$_> as resources:
137
138 URxvt.selection-autotransform.0: transform
139 URxvt.selection-autotransform.1: transform
140 ...
141
142For example, the following will transform selections of the form
143C<filename:number>, often seen in compiler messages, into C<vi +$filename
144$word>:
145
146 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
147
148And this example matches the same,but replaces it with vi-commands you can
149paste directly into your (vi :) editor:
150
151 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
152
153Of course, this can be modified to suit your needs and your editor :)
154
155To expand the example above to typical perl error messages ("XXX at
156FILENAME line YYY."), you need a slightly more elaborate solution:
157
158 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
159 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
160
161The first line tells the selection code to treat the unchanging part of
162every error message as a selection pattern, and the second line transforms
163the message into vi commands to load the file.
85 164
86=item mark-urls 165=item mark-urls
87 166
88Uses per-line display filtering (C<on_line_update>) to underline urls. 167Uses per-line display filtering (C<on_line_update>) to underline urls and
168make them clickable. When middle-clicked, the program specified in the
169resource C<urlLauncher> (default C<x-www-browser>) will be started with
170the URL as first argument.
171
172=item automove-background
173
174This is basically a one-line extension that dynamically changes the background pixmap offset
175to the window position, in effect creating the same effect as pseudo transparency with
176a custom pixmap. No scaling is supported in this mode. Exmaple:
177
178 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
89 179
90=item block-graphics-to-ascii 180=item block-graphics-to-ascii
91 181
92A not very useful example of filtering all text output to the terminal, 182A not very useful example of filtering all text output to the terminal,
93by replacing all line-drawing characters (U+2500 .. U+259F) by a 183by replacing all line-drawing characters (U+2500 .. U+259F) by a
94similar-looking ascii character. 184similar-looking ascii character.
95 185
186=item digital-clock
187
188Displays a digital clock using the built-in overlay.
189
96=item example-refresh-hooks 190=item example-refresh-hooks
97 191
98Displays a very simple digital clock in the upper right corner of the 192Displays a very simple digital clock in the upper right corner of the
99window. Illustrates overwriting the refresh callbacks to create your own 193window. Illustrates overwriting the refresh callbacks to create your own
100overlays or changes. 194overlays or changes.
101 195
196=item selection-pastebin
197
198This is a little rarely useful extension that Uploads the selection as
199textfile to a remote site (or does other things). (The implementation is
200not currently secure for use in a multiuser environment as it writes to
201F</tmp> directly.).
202
203It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
204i.e.
205
206 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
207
208Pressing this combination runs a command with C<%> replaced by the name of
209the textfile. This command can be set via a resource:
210
211 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
212
213And the default is likely not useful to anybody but the few people around
214here :)
215
216The name of the textfile is the hex encoded md5 sum of the selection, so
217the same content should lead to the same filename.
218
219After a successful upload the selection will be replaced by the text given
220in the C<selection-pastebin-url> resource (again, the % is the placeholder
221for the filename):
222
223 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
224
102=back 225=back
226
227=head1 API DOCUMENTATION
103 228
104=head2 General API Considerations 229=head2 General API Considerations
105 230
106All objects (such as terminals, time watchers etc.) are typical 231All objects (such as terminals, time watchers etc.) are typical
107reference-to-hash objects. The hash can be used to store anything you 232reference-to-hash objects. The hash can be used to store anything you
120=over 4 245=over 4
121 246
122=item $text 247=item $text
123 248
124Rxvt-unicodes special way of encoding text, where one "unicode" character 249Rxvt-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. 250always represents one screen cell. See L<ROW_t> for a discussion of this format.
126 251
127=item $string 252=item $string
128 253
129A perl text string, with an emphasis on I<text>. It can store all unicode 254A 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 255characters and is to be distinguished with text encoded in a specific
203=item on_start $term 328=item on_start $term
204 329
205Called at the very end of initialisation of a new terminal, just before 330Called at the very end of initialisation of a new terminal, just before
206returning to the mainloop. 331returning to the mainloop.
207 332
333=item on_child_start $term, $pid
334
335Called just after the child process has been C<fork>ed.
336
337=item on_child_exit $term, $status
338
339Called just after the child process has exited. C<$status> is the status
340from C<waitpid>.
341
208=item on_sel_make $term, $eventtime 342=item on_sel_make $term, $eventtime
209 343
210Called whenever a selection has been made by the user, but before the 344Called whenever a selection has been made by the user, but before the
211selection text is copied, so changes to the beginning, end or type of the 345selection text is copied, so changes to the beginning, end or type of the
212selection will be honored. 346selection will be honored.
225=item on_sel_extend $term 359=item on_sel_extend $term
226 360
227Called whenever the user tries to extend the selection (e.g. with a double 361Called whenever the user tries to extend the selection (e.g. with a double
228click) and is either supposed to return false (normal operation), or 362click) and is either supposed to return false (normal operation), or
229should extend the selection itelf and return true to suppress the built-in 363should extend the selection itelf and return true to suppress the built-in
230processing. 364processing. This can happen multiple times, as long as the callback
365returns true, it will be called on every further click by the user and is
366supposed to enlarge the selection more and more, if possible.
231 367
232See the F<selection> example extension. 368See the F<selection> example extension.
233 369
234=item on_view_change $term, $offset 370=item on_view_change $term, $offset
235 371
302 438
303Called whenever the user presses a key combination that has a 439Called whenever the user presses a key combination that has a
304C<perl:string> action bound to it (see description of the B<keysym> 440C<perl:string> action bound to it (see description of the B<keysym>
305resource in the @@RXVT_NAME@@(1) manpage). 441resource in the @@RXVT_NAME@@(1) manpage).
306 442
443=item on_x_event $term, $event
444
445Called on every X event received on the vt window (and possibly other
446windows). Should only be used as a last resort. Most event structure
447members are not passed.
448
307=item on_focus_in $term 449=item on_focus_in $term
308 450
309Called whenever the window gets the keyboard focus, before rxvt-unicode 451Called whenever the window gets the keyboard focus, before rxvt-unicode
310does focus in processing. 452does focus in processing.
311 453
312=item on_focus_out $term 454=item on_focus_out $term
313 455
314Called wheneever the window loses keyboard focus, before rxvt-unicode does 456Called wheneever the window loses keyboard focus, before rxvt-unicode does
315focus out processing. 457focus out processing.
458
459=item on_configure_notify $term, $event
316 460
317=item on_key_press $term, $event, $keysym, $octets 461=item on_key_press $term, $event, $keysym, $octets
318 462
319=item on_key_release $term, $event, $keysym 463=item on_key_release $term, $event, $keysym
320 464
337 481
338C<on_key_press> additionally receives the string rxvt-unicode would 482C<on_key_press> additionally receives the string rxvt-unicode would
339output, if any, in locale-specific encoding. 483output, if any, in locale-specific encoding.
340 484
341subwindow. 485subwindow.
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 486
453=back 487=back
454 488
455=cut 489=cut
456 490
471our $LIBDIR; 505our $LIBDIR;
472our $RESNAME; 506our $RESNAME;
473our $RESCLASS; 507our $RESCLASS;
474our $RXVTNAME; 508our $RXVTNAME;
475 509
510=head2 Variables in the C<urxvt> Package
511
512=over 4
513
514=item $urxvt::LIBDIR
515
516The rxvt-unicode library directory, where, among other things, the perl
517modules and scripts are stored.
518
519=item $urxvt::RESCLASS, $urxvt::RESCLASS
520
521The resource class and name rxvt-unicode uses to look up X resources.
522
523=item $urxvt::RXVTNAME
524
525The basename of the installed binaries, usually C<urxvt>.
526
527=item $urxvt::TERM
528
529The current terminal. This variable stores the current C<urxvt::term>
530object, whenever a callback/hook is executing.
531
532=back
533
534=head2 Functions in the C<urxvt> Package
535
536=over 4
537
538=item urxvt::fatal $errormessage
539
540Fatally aborts execution with the given error message. Avoid at all
541costs! The only time this is acceptable is when the terminal process
542starts up.
543
544=item urxvt::warn $string
545
546Calls C<rxvt_warn> with the given string which should not include a
547newline. The module also overwrites the C<warn> builtin with a function
548that calls this function.
549
550Using this function has the advantage that its output ends up in the
551correct place, e.g. on stderr of the connecting urxvtc client.
552
553Messages have a size limit of 1023 bytes currently.
554
555=item $time = urxvt::NOW
556
557Returns the "current time" (as per the event loop).
558
559=item urxvt::CurrentTime
560
561=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
562Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
563Button4Mask, Button5Mask, AnyModifier
564
565=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
566ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
567PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
568Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
569KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
570ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
571FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
572
573=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
574EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
575GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
576UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
577ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
578CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
579SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
580
581Various constants for use in X calls and event processing.
582
583=back
584
585=head2 RENDITION
586
587Rendition bitsets contain information about colour, font, font styles and
588similar information for each screen cell.
589
590The following "macros" deal with changes in rendition sets. You should
591never just create a bitset, you should always modify an existing one,
592as they contain important information required for correct operation of
593rxvt-unicode.
594
595=over 4
596
597=item $rend = urxvt::DEFAULT_RSTYLE
598
599Returns the default rendition, as used when the terminal is starting up or
600being reset. Useful as a base to start when creating renditions.
601
602=item $rend = urxvt::OVERLAY_RSTYLE
603
604Return the rendition mask used for overlays by default.
605
606=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
607
608Return the bit that enabled bold, italic, blink, reverse-video and
609underline, respectively. To enable such a style, just logically OR it into
610the bitset.
611
612=item $foreground = urxvt::GET_BASEFG $rend
613
614=item $background = urxvt::GET_BASEBG $rend
615
616Return the foreground/background colour index, respectively.
617
618=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
619
620=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
621
622Replace the foreground/background colour in the rendition mask with the
623specified one.
624
625=item $value = urxvt::GET_CUSTOM $rend
626
627Return the "custom" value: Every rendition has 5 bits for use by
628extensions. They can be set and changed as you like and are initially
629zero.
630
631=item $rend = urxvt::SET_CUSTOM $rend, $new_value
632
633Change the custom value.
634
635=back
636
637=cut
638
476BEGIN { 639BEGIN {
477 urxvt->bootstrap;
478
479 # overwrite perl's warn 640 # overwrite perl's warn
480 *CORE::GLOBAL::warn = sub { 641 *CORE::GLOBAL::warn = sub {
481 my $msg = join "", @_; 642 my $msg = join "", @_;
482 $msg .= "\n" 643 $msg .= "\n"
483 unless $msg =~ /\n$/; 644 unless $msg =~ /\n$/;
484 urxvt::warn ($msg); 645 urxvt::warn ($msg);
485 }; 646 };
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} 647}
492 648
493my @hook_count;
494my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 649my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495 650
496sub verbose { 651sub verbose {
497 my ($level, $msg) = @_; 652 my ($level, $msg) = @_;
498 warn "$msg\n" if $level <= $verbosity; 653 warn "$msg\n" if $level <= $verbosity;
499} 654}
500 655
501my $extension_pkg = "extension0000";
502my %extension_pkg; 656my %extension_pkg;
503 657
504# load a single script into its own package, once only 658# load a single script into its own package, once only
505sub extension_package($) { 659sub extension_package($) {
506 my ($path) = @_; 660 my ($path) = @_;
507 661
662 no strict 'refs';
663
508 $extension_pkg{$path} ||= do { 664 $extension_pkg{$path} ||= do {
509 my $pkg = "urxvt::" . ($extension_pkg++); 665 $path =~ /([^\/\\]+)$/;
666 my $pkg = $1;
667 $pkg =~ s/[^[:word:]]/_/g;
668 $pkg = "urxvt::ext::$pkg";
510 669
511 verbose 3, "loading extension '$path' into package '$pkg'"; 670 verbose 3, "loading extension '$path' into package '$pkg'";
512 671
513 open my $fh, "<:raw", $path 672 open my $fh, "<:raw", $path
514 or die "$path: $!"; 673 or die "$path: $!";
515 674
675 @{"$pkg\::ISA"} = urxvt::term::extension::;
676
516 my $source = untaint 677 my $source =
517 "package $pkg; use strict; use utf8;\n" 678 "package $pkg; use strict; use utf8;\n"
518 . "use base urxvt::term::extension::;\n"
519 . "#line 1 \"$path\"\n{\n" 679 . "#line 1 \"$path\"\n{\n"
520 . (do { local $/; <$fh> }) 680 . (do { local $/; <$fh> })
521 . "\n};\n1"; 681 . "\n};\n1";
522 682
523 eval $source 683 eval $source
580 if ($@) { 740 if ($@) {
581 $TERM->ungrab; # better to lose the grab than the session 741 $TERM->ungrab; # better to lose the grab than the session
582 warn $@; 742 warn $@;
583 } 743 }
584 } 744 }
745
746 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
747 if $verbosity >= 11;
585 } 748 }
586 749
587 if ($htype == 1) { # DESTROY 750 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 751 # clear package objects
596 %$_ = () for values %{ $TERM->{_pkg} }; 752 %$_ = () for values %{ $TERM->{_pkg} };
597 753
598 # clear package 754 # clear package
599 %$TERM = (); 755 %$TERM = ();
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.
946
947=item $term->exec_async ($cmd[, @args])
948
949Works like the combination of the C<fork>/C<exec> builtins, which executes
950("starts") programs in the background. This function takes care of setting
951the user environment before exec'ing the command (e.g. C<PATH>) and should
952be preferred over explicit calls to C<exec> or C<system>.
953
954Returns the pid of the subprocess or C<undef> on error.
955
956=cut
957
958sub exec_async {
959 my $self = shift;
960
961 my $pid = fork;
962
963 return $pid
964 if !defined $pid or $pid;
965
966 %ENV = %{ $self->env };
967
968 exec @_;
969 urxvt::_exit 255;
970}
772 971
773=item $isset = $term->option ($optval[, $set]) 972=item $isset = $term->option ($optval[, $set])
774 973
775Returns true if the option specified by C<$optval> is enabled, and 974Returns true if the option specified by C<$optval> is enabled, and
776optionally change it. All option values are stored by name in the hash 975optionally 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 978Here is a a likely non-exhaustive list of option names, please see the
780source file F</src/optinc.h> to see the actual list: 979source file F</src/optinc.h> to see the actual list:
781 980
782 borderLess console cursorBlink cursorUnderline hold iconic insecure 981 borderLess console cursorBlink cursorUnderline hold iconic insecure
783 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 982 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 983 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
785 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 984 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
786 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 985 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
787 tripleclickwords utmpInhibit visualBell 986 transparent tripleclickwords utmpInhibit visualBell
788 987
789=item $value = $term->resource ($name[, $newval]) 988=item $value = $term->resource ($name[, $newval])
790 989
791Returns the current resource value associated with a given name and 990Returns the current resource value associated with a given name and
792optionally sets a new value. Setting values is most useful in the C<init> 991optionally sets a new value. Setting values is most useful in the C<init>
809 1008
810 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1009 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
811 borderLess color cursorBlink cursorUnderline cutchars delete_key 1010 borderLess color cursorBlink cursorUnderline cutchars delete_key
812 display_name embed ext_bwidth fade font geometry hold iconName 1011 display_name embed ext_bwidth fade font geometry hold iconName
813 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1012 imFont imLocale inputMethod insecure int_bwidth intensityStyles
814 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1013 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
815 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1014 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
816 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1015 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
817 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1016 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
818 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1017 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
819 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1018 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
820 shade term_name title transparent transparent_all tripleclickwords 1019 secondaryScreen secondaryScroll selectstyle shade term_name title
821 utmpInhibit visualBell 1020 transient_for transparent transparent_all tripleclickwords utmpInhibit
1021 visualBell
822 1022
823=cut 1023=cut
824 1024
825sub resource($$;$) { 1025sub resource($$;$) {
826 my ($self, $name) = (shift, shift); 1026 my ($self, $name) = (shift, shift);
827 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1027 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
828 &urxvt::term::_resource 1028 &urxvt::term::_resource
829} 1029}
830 1030
1031=item $value = $term->x_resource ($pattern)
1032
1033Returns the X-Resource for the given pattern, excluding the program or
1034class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1035same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1036resource with that pattern exists.
1037
1038This method should only be called during the C<on_start> hook, as there is
1039only one resource database per display, and later invocations might return
1040the wrong resources.
1041
831=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1042=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832 1043
833Adds a keymap translation exactly as specified via a resource. See the 1044Adds a keymap translation exactly as specified via a resource. See the
834C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1045C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835 1046
850=item ($row, $col) = $term->selection_end ([$row, $col]) 1061=item ($row, $col) = $term->selection_end ([$row, $col])
851 1062
852Return the current values of the selection mark, begin or end positions, 1063Return the current values of the selection mark, begin or end positions,
853and optionally set them to new values. 1064and optionally set them to new values.
854 1065
1066=item $term->selection_make ($eventtime[, $rectangular])
1067
1068Tries to make a selection as set by C<selection_beg> and
1069C<selection_end>. If C<$rectangular> is true (default: false), a
1070rectangular selection will be made. This is the prefered function to make
1071a selection.
1072
855=item $success = $term->selection_grab ($eventtime) 1073=item $success = $term->selection_grab ($eventtime)
856 1074
857Try to request the primary selection from the server (for example, as set 1075Try to request the primary selection text from the server (for example, as
858by the next method). 1076set by the next method). No visual feedback will be given. This function
1077is mostly useful from within C<on_sel_grab> hooks.
859 1078
860=item $oldtext = $term->selection ([$newtext]) 1079=item $oldtext = $term->selection ([$newtext])
861 1080
862Return the current selection text and optionally replace it by C<$newtext>. 1081Return the current selection text and optionally replace it by C<$newtext>.
863 1082
956Convert the given locale-encoded octets into a perl string. 1175Convert the given locale-encoded octets into a perl string.
957 1176
958=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1177=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959 1178
960XORs the rendition values in the given span with the provided value 1179XORs the rendition values in the given span with the provided value
961(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1180(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962to the selection. 1181refresh hooks to provide effects similar to the selection.
963 1182
964=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1183=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965 1184
966Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1185Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967whitespace will additionally be xored with the C<$rstyle2>, which defaults 1186whitespace will additionally be xored with the C<$rstyle2>, which defaults
968to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1187to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
969it instead. 1188it instead. Both styles I<MUST NOT> contain font styles.
970 1189
971=item $term->scr_bell 1190=item $term->scr_bell
972 1191
973Ring the bell! 1192Ring the bell!
974 1193
1008 1227
1009=item $windowid = $term->vt 1228=item $windowid = $term->vt
1010 1229
1011Return the window id of the terminal window. 1230Return the window id of the terminal window.
1012 1231
1232=item $term->vt_emask_add ($x_event_mask)
1233
1234Adds the specified events to the vt event mask. Useful e.g. when you want
1235to receive pointer events all the times:
1236
1237 $term->vt_emask_add (urxvt::PointerMotionMask);
1238
1013=item $window_width = $term->width 1239=item $window_width = $term->width
1014 1240
1015=item $window_height = $term->height 1241=item $window_height = $term->height
1016 1242
1017=item $font_width = $term->fwidth 1243=item $font_width = $term->fwidth
1030 1256
1031=item $max_scrollback = $term->saveLines 1257=item $max_scrollback = $term->saveLines
1032 1258
1033=item $nrow_plus_saveLines = $term->total_rows 1259=item $nrow_plus_saveLines = $term->total_rows
1034 1260
1035=item $lines_in_scrollback = $term->nsaved 1261=item $topmost_scrollback_row = $term->top_row
1036 1262
1037Return various integers describing terminal characteristics. 1263Return various integers describing terminal characteristics.
1038 1264
1265=item $x_display = $term->display_id
1266
1267Return the DISPLAY used by rxvt-unicode.
1268
1039=item $lc_ctype = $term->locale 1269=item $lc_ctype = $term->locale
1040 1270
1041Returns the LC_CTYPE category string used by this rxvt-unicode. 1271Returns the LC_CTYPE category string used by this rxvt-unicode.
1042 1272
1043=item $x_display = $term->display_id 1273=item $env = $term->env
1044 1274
1045Return the DISPLAY used by rxvt-unicode. 1275Returns a copy of the environment in effect for the terminal as a hashref
1276similar to C<\%ENV>.
1277
1278=cut
1279
1280sub env {
1281 if (my $env = $_[0]->_env) {
1282 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1283 } else {
1284 +{ %ENV }
1285 }
1286}
1046 1287
1047=item $modifiermask = $term->ModLevel3Mask 1288=item $modifiermask = $term->ModLevel3Mask
1048 1289
1049=item $modifiermask = $term->ModMetaMask 1290=item $modifiermask = $term->ModMetaMask
1050 1291
1053Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1294Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1054AltGr), the meta key (often Alt) and the num lock key, if applicable. 1295AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055 1296
1056=item $view_start = $term->view_start ([$newvalue]) 1297=item $view_start = $term->view_start ([$newvalue])
1057 1298
1058Returns the negative row number of the topmost line. Minimum value is 1299Returns the row number of the topmost displayed line. Maximum value is
1059C<0>, which displays the normal terminal contents. Larger values scroll 1300C<0>, which displays the normal terminal contents. Lower values scroll
1060this many lines into the scrollback buffer. 1301this many lines into the scrollback buffer.
1061 1302
1062=item $term->want_refresh 1303=item $term->want_refresh
1063 1304
1064Requests a screen refresh. At the next opportunity, rxvt-unicode will 1305Requests a screen refresh. At the next opportunity, rxvt-unicode will
1143Return the row number of the first/last row of the line, respectively. 1384Return the row number of the first/last row of the line, respectively.
1144 1385
1145=item $offset = $line->offset_of ($row, $col) 1386=item $offset = $line->offset_of ($row, $col)
1146 1387
1147Returns the character offset of the given row|col pair within the logical 1388Returns the character offset of the given row|col pair within the logical
1148line. 1389line. Works for rows outside the line, too, and returns corresponding
1390offsets outside the string.
1149 1391
1150=item ($row, $col) = $line->coord_of ($offset) 1392=item ($row, $col) = $line->coord_of ($offset)
1151 1393
1152Translates a string offset into terminal coordinates again. 1394Translates a string offset into terminal coordinates again.
1153 1395
1290 $item->{render} ||= sub { $_[0]{text} }; 1532 $item->{render} ||= sub { $_[0]{text} };
1291 1533
1292 push @{ $self->{item} }, $item; 1534 push @{ $self->{item} }, $item;
1293} 1535}
1294 1536
1537=item $popup->add_title ($title)
1538
1539Adds a non-clickable title to the popup.
1540
1541=cut
1542
1543sub add_title {
1544 my ($self, $title) = @_;
1545
1546 $self->add_item ({
1547 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1548 text => $title,
1549 activate => sub { },
1550 });
1551}
1552
1553=item $popup->add_separator ([$sepchr])
1554
1555Creates a separator, optionally using the character given as C<$sepchr>.
1556
1557=cut
1558
1295sub add_separator { 1559sub add_separator {
1296 my ($self, $sep) = @_; 1560 my ($self, $sep) = @_;
1297 1561
1298 $sep ||= "="; 1562 $sep ||= "=";
1299 1563
1303 render => sub { $sep x $self->{term}->ncol }, 1567 render => sub { $sep x $self->{term}->ncol },
1304 activate => sub { }, 1568 activate => sub { },
1305 }); 1569 });
1306} 1570}
1307 1571
1308sub add_title { 1572=item $popup->add_button ($text, $cb)
1309 my ($self, $title) = @_;
1310 1573
1311 $self->add_item ({ 1574Adds 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" }, 1575selected.
1313 text => $title, 1576
1314 activate => sub { }, 1577=cut
1315 });
1316}
1317 1578
1318sub add_button { 1579sub add_button {
1319 my ($self, $text, $cb) = @_; 1580 my ($self, $text, $cb) = @_;
1320 1581
1321 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1582 $self->add_item ({ type => "button", text => $text, activate => $cb});
1322} 1583}
1584
1585=item $popup->add_toggle ($text, $cb, $initial_value)
1586
1587Adds a toggle/checkbox item to the popup. Teh callback gets called
1588whenever it gets toggled, with a boolean indicating its value as its first
1589argument.
1590
1591=cut
1323 1592
1324sub add_toggle { 1593sub add_toggle {
1325 my ($self, $text, $cb, $value) = @_; 1594 my ($self, $text, $cb, $value) = @_;
1326 1595
1327 my $item; $item = { 1596 my $item; $item = {
1328 type => "button", 1597 type => "button",
1329 text => " $text", 1598 text => " $text",
1330 value => $value, 1599 value => $value,
1331 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1600 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1601 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333 }; 1602 };
1334 1603
1335 $self->add_item ($item); 1604 $self->add_item ($item);
1336} 1605}
1606
1607=item $popup->show
1608
1609Displays the popup (which is initially hidden).
1610
1611=cut
1337 1612
1338sub show { 1613sub show {
1339 my ($self) = @_; 1614 my ($self) = @_;
1340 1615
1341 local $urxvt::popup::self = $self; 1616 local $urxvt::popup::self = $self;
1342 1617
1618 my $env = $self->{term}->env;
1619 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1620 delete $env->{LC_ALL};
1343 local $ENV{LC_ALL} = $self->{term}->locale; 1621 $env->{LC_CTYPE} = $self->{term}->locale;
1344 1622
1345 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1623 urxvt::term->new ($env, "popup",
1624 "--perl-lib" => "", "--perl-ext-common" => "",
1625 "-pty-fd" => -1, "-sl" => 0,
1626 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1346 "--transient-for" => $self->{term}->parent, 1627 "--transient-for" => $self->{term}->parent,
1347 "-display" => $self->{term}->display_id, 1628 "-display" => $self->{term}->display_id,
1348 "-pe" => "urxvt-popup") 1629 "-pe" => "urxvt-popup")
1349 or die "unable to create popup window\n"; 1630 or die "unable to create popup window\n";
1350} 1631}
1351 1632
1352sub DESTROY { 1633sub DESTROY {
1353 my ($self) = @_; 1634 my ($self) = @_;
1354 1635
1355 delete $self->{term}{_destroy}{$self}; 1636 delete $self->{term}{_destroy}{$self};
1356 $self->{term}->ungrab; 1637 $self->{term}->ungrab;
1357} 1638}
1639
1640=back
1358 1641
1359=head2 The C<urxvt::timer> Class 1642=head2 The C<urxvt::timer> Class
1360 1643
1361This class implements timer watchers/events. Time is represented as a 1644This class implements timer watchers/events. Time is represented as a
1362fractional number of seconds since the epoch. Example: 1645fractional number of seconds since the epoch. Example:
1400Start the timer. 1683Start the timer.
1401 1684
1402=item $timer = $timer->start ($tstamp) 1685=item $timer = $timer->start ($tstamp)
1403 1686
1404Set the event trigger time to C<$tstamp> and start the timer. 1687Set the event trigger time to C<$tstamp> and start the timer.
1688
1689=item $timer = $timer->after ($delay)
1690
1691Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405 1692
1406=item $timer = $timer->stop 1693=item $timer = $timer->stop
1407 1694
1408Stop the timer. 1695Stop the timer.
1409 1696
1469 1756
1470=item == 0 - fatal messages 1757=item == 0 - fatal messages
1471 1758
1472=item >= 3 - script loading and management 1759=item >= 3 - script loading and management
1473 1760
1474=item >=10 - all events received 1761=item >=10 - all called hooks
1762
1763=item >=11 - hook reutrn values
1475 1764
1476=back 1765=back
1477 1766
1478=head1 AUTHOR 1767=head1 AUTHOR
1479 1768

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines