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.73 by root, Tue Jan 10 04:23:39 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.
70 93
94Other extensions can extend this popup menu by pushing a code reference onto
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
96
97It's sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not.
99It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called
101when the button gets activated and should transform C<$_>.
102
103The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any
105C<a>s:
106
107 push urxvt::ext::selection_popup::hook, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g }
109 : ()
110 };
111
112Don't run it in a hook, otherwise the menu will grow and grow. Instead put
113it at the toplevel of your extension.
114
71=item searchable-scrollback (enabled by default) 115=item searchable-scrollback<hotkey> (enabled by default)
72 116
73Adds regex search functionality to the scrollback buffer, triggered by a 117Adds regex search functionality to the scrollback buffer, triggered
74hotkey (default: C<M-s>). When in search mode, terminal input/output is 118by a hotkey (default: C<M-s>). While in search mode, normal terminal
75suspended, C</> starts an incremental regex search, C<n> searches further, 119input/output is suspended and a regex is displayed at the bottom of the
76C<p> jumps to the previous match. C<enter> leaves search mode at the 120screen.
77current position and C<escape> returns to the original position.
78 121
79=item digital-clock 122Inputting characters appends them to the regex and continues incremental
123search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
124search upwards/downwards in the scrollback buffer, C<End> jumps to the
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.
80 129
81Displays a digital clock using the built-in overlay. 130=item selection-autotransform
131
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.
82 164
83=item mark-urls 165=item mark-urls
84 166
85Uses 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
86 179
87=item block-graphics-to-ascii 180=item block-graphics-to-ascii
88 181
89A 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,
90by replacing all line-drawing characters (U+2500 .. U+259F) by a 183by replacing all line-drawing characters (U+2500 .. U+259F) by a
91similar-looking ascii character. 184similar-looking ascii character.
92 185
186=item digital-clock
187
188Displays a digital clock using the built-in overlay.
189
93=item example-refresh-hooks 190=item example-refresh-hooks
94 191
95Displays 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
96window. Illustrates overwriting the refresh callbacks to create your own 193window. Illustrates overwriting the refresh callbacks to create your own
97overlays or changes. 194overlays or changes.
98 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
99=back 225=back
226
227=head1 API DOCUMENTATION
100 228
101=head2 General API Considerations 229=head2 General API Considerations
102 230
103All objects (such as terminals, time watchers etc.) are typical 231All objects (such as terminals, time watchers etc.) are typical
104reference-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
117=over 4 245=over 4
118 246
119=item $text 247=item $text
120 248
121Rxvt-unicodes special way of encoding text, where one "unicode" character 249Rxvt-unicodes special way of encoding text, where one "unicode" character
122always represents one screen cell. See L<row_t> for a discussion of this format. 250always represents one screen cell. See L<ROW_t> for a discussion of this format.
123 251
124=item $string 252=item $string
125 253
126A 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
127characters and is to be distinguished with text encoded in a specific 255characters and is to be distinguished with text encoded in a specific
200=item on_start $term 328=item on_start $term
201 329
202Called 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
203returning to the mainloop. 331returning to the mainloop.
204 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
205=item on_sel_make $term, $eventtime 342=item on_sel_make $term, $eventtime
206 343
207Called 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
208selection 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
209selection will be honored. 346selection will be honored.
222=item on_sel_extend $term 359=item on_sel_extend $term
223 360
224Called 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
225click) and is either supposed to return false (normal operation), or 362click) and is either supposed to return false (normal operation), or
226should 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
227processing. 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.
228 367
229See the F<selection> example extension. 368See the F<selection> example extension.
230 369
231=item on_view_change $term, $offset 370=item on_view_change $term, $offset
232 371
299 438
300Called whenever the user presses a key combination that has a 439Called whenever the user presses a key combination that has a
301C<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>
302resource in the @@RXVT_NAME@@(1) manpage). 441resource in the @@RXVT_NAME@@(1) manpage).
303 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
304=item on_focus_in $term 449=item on_focus_in $term
305 450
306Called whenever the window gets the keyboard focus, before rxvt-unicode 451Called whenever the window gets the keyboard focus, before rxvt-unicode
307does focus in processing. 452does focus in processing.
308 453
309=item on_focus_out $term 454=item on_focus_out $term
310 455
311Called wheneever the window loses keyboard focus, before rxvt-unicode does 456Called wheneever the window loses keyboard focus, before rxvt-unicode does
312focus out processing. 457focus out processing.
458
459=item on_configure_notify $term, $event
313 460
314=item on_key_press $term, $event, $keysym, $octets 461=item on_key_press $term, $event, $keysym, $octets
315 462
316=item on_key_release $term, $event, $keysym 463=item on_key_release $term, $event, $keysym
317 464
334 481
335C<on_key_press> additionally receives the string rxvt-unicode would 482C<on_key_press> additionally receives the string rxvt-unicode would
336output, if any, in locale-specific encoding. 483output, if any, in locale-specific encoding.
337 484
338subwindow. 485subwindow.
339
340=back
341
342=head2 Variables in the C<urxvt> Package
343
344=over 4
345
346=item $urxvt::TERM
347
348The current terminal. This variable stores the current C<urxvt::term>
349object, whenever a callback/hook is executing.
350
351=back
352
353=head2 Functions in the C<urxvt> Package
354
355=over 4
356
357=item $term = new urxvt [arg...]
358
359Creates a new terminal, very similar as if you had started it with
360C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361if the new instance couldn't be created. Returns C<undef> if the new
362instance didn't initialise perl, and the terminal object otherwise. The
363C<init> and C<start> hooks will be called during the call.
364
365=item urxvt::fatal $errormessage
366
367Fatally aborts execution with the given error message. Avoid at all
368costs! The only time this is acceptable is when the terminal process
369starts up.
370
371=item urxvt::warn $string
372
373Calls C<rxvt_warn> with the given string which should not include a
374newline. The module also overwrites the C<warn> builtin with a function
375that calls this function.
376
377Using this function has the advantage that its output ends up in the
378correct place, e.g. on stderr of the connecting urxvtc client.
379
380=item $is_safe = urxvt::safe
381
382Returns true when it is safe to do potentially unsafe things, such as
383evaluating perl code specified by the user. This is true when urxvt was
384started setuid or setgid.
385
386=item $time = urxvt::NOW
387
388Returns the "current time" (as per the event loop).
389
390=item urxvt::CurrentTime
391
392=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394Button4Mask, Button5Mask, AnyModifier
395
396Various constants for use in X calls and event processing.
397
398=back
399
400=head2 RENDITION
401
402Rendition bitsets contain information about colour, font, font styles and
403similar information for each screen cell.
404
405The following "macros" deal with changes in rendition sets. You should
406never just create a bitset, you should always modify an existing one,
407as they contain important information required for correct operation of
408rxvt-unicode.
409
410=over 4
411
412=item $rend = urxvt::DEFAULT_RSTYLE
413
414Returns the default rendition, as used when the terminal is starting up or
415being reset. Useful as a base to start when creating renditions.
416
417=item $rend = urxvt::OVERLAY_RSTYLE
418
419Return the rendition mask used for overlays by default.
420
421=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423Return the bit that enabled bold, italic, blink, reverse-video and
424underline, respectively. To enable such a style, just logically OR it into
425the bitset.
426
427=item $foreground = urxvt::GET_BASEFG $rend
428
429=item $background = urxvt::GET_BASEBG $rend
430
431Return the foreground/background colour index, respectively.
432
433=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437Replace the foreground/background colour in the rendition mask with the
438specified one.
439
440=item $value = urxvt::GET_CUSTOM ($rend)
441
442Return the "custom" value: Every rendition has 5 bits for use by
443extensions. They can be set and changed as you like and are initially
444zero.
445
446=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448Change the custom value.
449 486
450=back 487=back
451 488
452=cut 489=cut
453 490
468our $LIBDIR; 505our $LIBDIR;
469our $RESNAME; 506our $RESNAME;
470our $RESCLASS; 507our $RESCLASS;
471our $RXVTNAME; 508our $RXVTNAME;
472 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
473BEGIN { 639BEGIN {
474 urxvt->bootstrap;
475
476 # overwrite perl's warn 640 # overwrite perl's warn
477 *CORE::GLOBAL::warn = sub { 641 *CORE::GLOBAL::warn = sub {
478 my $msg = join "", @_; 642 my $msg = join "", @_;
479 $msg .= "\n" 643 $msg .= "\n"
480 unless $msg =~ /\n$/; 644 unless $msg =~ /\n$/;
481 urxvt::warn ($msg); 645 urxvt::warn ($msg);
482 }; 646 };
483
484 delete $ENV{IFS};
485 delete $ENV{CDPATH};
486 delete $ENV{BASH_ENV};
487 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
488} 647}
489 648
490my @hook_count;
491my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 649my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
492 650
493sub verbose { 651sub verbose {
494 my ($level, $msg) = @_; 652 my ($level, $msg) = @_;
495 warn "$msg\n" if $level <= $verbosity; 653 warn "$msg\n" if $level <= $verbosity;
496} 654}
497 655
498my $extension_pkg = "extension0000";
499my %extension_pkg; 656my %extension_pkg;
500 657
501# load a single script into its own package, once only 658# load a single script into its own package, once only
502sub extension_package($) { 659sub extension_package($) {
503 my ($path) = @_; 660 my ($path) = @_;
504 661
662 no strict 'refs';
663
505 $extension_pkg{$path} ||= do { 664 $extension_pkg{$path} ||= do {
506 my $pkg = "urxvt::" . ($extension_pkg++); 665 $path =~ /([^\/\\]+)$/;
666 my $pkg = $1;
667 $pkg =~ s/[^[:word:]]/_/g;
668 $pkg = "urxvt::ext::$pkg";
507 669
508 verbose 3, "loading extension '$path' into package '$pkg'"; 670 verbose 3, "loading extension '$path' into package '$pkg'";
509 671
510 open my $fh, "<:raw", $path 672 open my $fh, "<:raw", $path
511 or die "$path: $!"; 673 or die "$path: $!";
512 674
675 @{"$pkg\::ISA"} = urxvt::term::extension::;
676
513 my $source = untaint 677 my $source =
514 "package $pkg; use strict; use utf8;\n" 678 "package $pkg; use strict; use utf8;\n"
515 . "use base urxvt::term::extension::;\n"
516 . "#line 1 \"$path\"\n{\n" 679 . "#line 1 \"$path\"\n{\n"
517 . (do { local $/; <$fh> }) 680 . (do { local $/; <$fh> })
518 . "\n};\n1"; 681 . "\n};\n1";
519 682
520 eval $source 683 eval $source
577 if ($@) { 740 if ($@) {
578 $TERM->ungrab; # better to lose the grab than the session 741 $TERM->ungrab; # better to lose the grab than the session
579 warn $@; 742 warn $@;
580 } 743 }
581 } 744 }
745
746 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
747 if $verbosity >= 11;
582 } 748 }
583 749
584 if ($htype == 1) { # DESTROY 750 if ($htype == 1) { # DESTROY
585 if (my $hook = delete $TERM->{_hook}) {
586 for my $htype (0..$#$hook) {
587 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
588 or set_should_invoke $htype, 0;
589 }
590 }
591
592 # clear package objects 751 # clear package objects
593 %$_ = () for values %{ $TERM->{_pkg} }; 752 %$_ = () for values %{ $TERM->{_pkg} };
594 753
595 # clear package 754 # clear package
596 %$TERM = (); 755 %$TERM = ();
610 while (my ($name, $cb) = each %hook) { 769 while (my ($name, $cb) = each %hook) {
611 my $htype = $HOOKTYPE{uc $name}; 770 my $htype = $HOOKTYPE{uc $name};
612 defined $htype 771 defined $htype
613 or Carp::croak "unsupported hook type '$name'"; 772 or Carp::croak "unsupported hook type '$name'";
614 773
774 $self->set_should_invoke ($htype, +1)
615 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 775 unless exists $self->{term}{_hook}[$htype]{$pkg};
616 $hook_count[$htype]++
617 or urxvt::set_should_invoke $htype, 1;
618 }
619 776
620 $self->{term}{_hook}[$htype]{$pkg} = $cb; 777 $self->{term}{_hook}[$htype]{$pkg} = $cb;
621 } 778 }
622} 779}
623 780
628 for my $name (@hook) { 785 for my $name (@hook) {
629 my $htype = $HOOKTYPE{uc $name}; 786 my $htype = $HOOKTYPE{uc $name};
630 defined $htype 787 defined $htype
631 or Carp::croak "unsupported hook type '$name'"; 788 or Carp::croak "unsupported hook type '$name'";
632 789
790 $self->set_should_invoke ($htype, -1)
633 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 791 if delete $self->{term}{_hook}[$htype]{$pkg};
634 --$hook_count[$htype]
635 or urxvt::set_should_invoke $htype, 0;
636 }
637 } 792 }
638} 793}
639 794
640our $AUTOLOAD; 795our $AUTOLOAD;
641 796
672 827
673=head2 The C<urxvt::anyevent> Class 828=head2 The C<urxvt::anyevent> Class
674 829
675The 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
676C<AnyEvent> module - any module using it will work inside urxvt without 831C<AnyEvent> module - any module using it will work inside urxvt without
677further work. The only exception is that you cannot wait on condition 832further programming. The only exception is that you cannot wait on
678variables, 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
679cannot use blocking APIs, but the non-blocking variant should work. 834is that you cannot use blocking APIs, but the non-blocking variant should
835work.
680 836
681=cut 837=cut
682 838
683our $VERSION = 1; 839our $VERSION = 1;
684 840
761 $proxy->enable ($name => $ref); 917 $proxy->enable ($name => $ref);
762 } 918 }
763 } 919 }
764} 920}
765 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
766=item $term->destroy 941=item $term->destroy
767 942
768Destroy 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}
769 971
770=item $isset = $term->option ($optval[, $set]) 972=item $isset = $term->option ($optval[, $set])
771 973
772Returns true if the option specified by C<$optval> is enabled, and 974Returns true if the option specified by C<$optval> is enabled, and
773optionally 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
776Here 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
777source file F</src/optinc.h> to see the actual list: 979source file F</src/optinc.h> to see the actual list:
778 980
779 borderLess console cursorBlink cursorUnderline hold iconic insecure 981 borderLess console cursorBlink cursorUnderline hold iconic insecure
780 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 982 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
781 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 983 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
782 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 984 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
783 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 985 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
784 tripleclickwords utmpInhibit visualBell 986 transparent tripleclickwords utmpInhibit visualBell
785 987
786=item $value = $term->resource ($name[, $newval]) 988=item $value = $term->resource ($name[, $newval])
787 989
788Returns the current resource value associated with a given name and 990Returns the current resource value associated with a given name and
789optionally 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>
806 1008
807 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1009 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
808 borderLess color cursorBlink cursorUnderline cutchars delete_key 1010 borderLess color cursorBlink cursorUnderline cutchars delete_key
809 display_name embed ext_bwidth fade font geometry hold iconName 1011 display_name embed ext_bwidth fade font geometry hold iconName
810 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1012 imFont imLocale inputMethod insecure int_bwidth intensityStyles
811 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1013 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
812 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1014 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
813 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1015 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
814 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1016 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
815 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1017 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
816 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1018 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
817 shade term_name title transparent transparent_all tripleclickwords 1019 secondaryScreen secondaryScroll selectstyle shade term_name title
818 utmpInhibit visualBell 1020 transient_for transparent transparent_all tripleclickwords utmpInhibit
1021 visualBell
819 1022
820=cut 1023=cut
821 1024
822sub resource($$;$) { 1025sub resource($$;$) {
823 my ($self, $name) = (shift, shift); 1026 my ($self, $name) = (shift, shift);
824 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1027 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
825 &urxvt::term::_resource 1028 &urxvt::term::_resource
826} 1029}
827 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
828=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1042=item $success = $term->parse_keysym ($keysym_spec, $command_string)
829 1043
830Adds a keymap translation exactly as specified via a resource. See the 1044Adds a keymap translation exactly as specified via a resource. See the
831C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1045C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
832 1046
847=item ($row, $col) = $term->selection_end ([$row, $col]) 1061=item ($row, $col) = $term->selection_end ([$row, $col])
848 1062
849Return the current values of the selection mark, begin or end positions, 1063Return the current values of the selection mark, begin or end positions,
850and optionally set them to new values. 1064and optionally set them to new values.
851 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
852=item $success = $term->selection_grab ($eventtime) 1073=item $success = $term->selection_grab ($eventtime)
853 1074
854Try 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
855by 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.
856 1078
857=item $oldtext = $term->selection ([$newtext]) 1079=item $oldtext = $term->selection ([$newtext])
858 1080
859Return the current selection text and optionally replace it by C<$newtext>. 1081Return the current selection text and optionally replace it by C<$newtext>.
860 1082
953Convert the given locale-encoded octets into a perl string. 1175Convert the given locale-encoded octets into a perl string.
954 1176
955=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])
956 1178
957XORs the rendition values in the given span with the provided value 1179XORs the rendition values in the given span with the provided value
958(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
959to the selection. 1181refresh hooks to provide effects similar to the selection.
960 1182
961=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]])
962 1184
963Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1185Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
964whitespace will additionally be xored with the C<$rstyle2>, which defaults 1186whitespace will additionally be xored with the C<$rstyle2>, which defaults
965to 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
966it instead. 1188it instead. Both styles I<MUST NOT> contain font styles.
967 1189
968=item $term->scr_bell 1190=item $term->scr_bell
969 1191
970Ring the bell! 1192Ring the bell!
971 1193
1005 1227
1006=item $windowid = $term->vt 1228=item $windowid = $term->vt
1007 1229
1008Return the window id of the terminal window. 1230Return the window id of the terminal window.
1009 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
1010=item $window_width = $term->width 1239=item $window_width = $term->width
1011 1240
1012=item $window_height = $term->height 1241=item $window_height = $term->height
1013 1242
1014=item $font_width = $term->fwidth 1243=item $font_width = $term->fwidth
1027 1256
1028=item $max_scrollback = $term->saveLines 1257=item $max_scrollback = $term->saveLines
1029 1258
1030=item $nrow_plus_saveLines = $term->total_rows 1259=item $nrow_plus_saveLines = $term->total_rows
1031 1260
1032=item $lines_in_scrollback = $term->nsaved 1261=item $topmost_scrollback_row = $term->top_row
1033 1262
1034Return various integers describing terminal characteristics. 1263Return various integers describing terminal characteristics.
1035 1264
1265=item $x_display = $term->display_id
1266
1267Return the DISPLAY used by rxvt-unicode.
1268
1036=item $lc_ctype = $term->locale 1269=item $lc_ctype = $term->locale
1037 1270
1038Returns the LC_CTYPE category string used by this rxvt-unicode. 1271Returns the LC_CTYPE category string used by this rxvt-unicode.
1039 1272
1040=item $x_display = $term->display_id 1273=item $env = $term->env
1041 1274
1042Return 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}
1043 1287
1044=item $modifiermask = $term->ModLevel3Mask 1288=item $modifiermask = $term->ModLevel3Mask
1045 1289
1046=item $modifiermask = $term->ModMetaMask 1290=item $modifiermask = $term->ModMetaMask
1047 1291
1050Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1294Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1051AltGr), 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.
1052 1296
1053=item $view_start = $term->view_start ([$newvalue]) 1297=item $view_start = $term->view_start ([$newvalue])
1054 1298
1055Returns the negative row number of the topmost line. Minimum value is 1299Returns the row number of the topmost displayed line. Maximum value is
1056C<0>, which displays the normal terminal contents. Larger values scroll 1300C<0>, which displays the normal terminal contents. Lower values scroll
1057this many lines into the scrollback buffer. 1301this many lines into the scrollback buffer.
1058 1302
1059=item $term->want_refresh 1303=item $term->want_refresh
1060 1304
1061Requests a screen refresh. At the next opportunity, rxvt-unicode will 1305Requests a screen refresh. At the next opportunity, rxvt-unicode will
1140Return 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.
1141 1385
1142=item $offset = $line->offset_of ($row, $col) 1386=item $offset = $line->offset_of ($row, $col)
1143 1387
1144Returns 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
1145line. 1389line. Works for rows outside the line, too, and returns corresponding
1390offsets outside the string.
1146 1391
1147=item ($row, $col) = $line->coord_of ($offset) 1392=item ($row, $col) = $line->coord_of ($offset)
1148 1393
1149Translates a string offset into terminal coordinates again. 1394Translates a string offset into terminal coordinates again.
1150 1395
1287 $item->{render} ||= sub { $_[0]{text} }; 1532 $item->{render} ||= sub { $_[0]{text} };
1288 1533
1289 push @{ $self->{item} }, $item; 1534 push @{ $self->{item} }, $item;
1290} 1535}
1291 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
1292sub add_separator { 1559sub add_separator {
1293 my ($self, $sep) = @_; 1560 my ($self, $sep) = @_;
1294 1561
1295 $sep ||= "="; 1562 $sep ||= "=";
1296 1563
1300 render => sub { $sep x $self->{term}->ncol }, 1567 render => sub { $sep x $self->{term}->ncol },
1301 activate => sub { }, 1568 activate => sub { },
1302 }); 1569 });
1303} 1570}
1304 1571
1305sub add_title { 1572=item $popup->add_button ($text, $cb)
1306 my ($self, $title) = @_;
1307 1573
1308 $self->add_item ({ 1574Adds a clickable button to the popup. C<$cb> is called whenever it is
1309 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, 1575selected.
1310 text => $title, 1576
1311 activate => sub { }, 1577=cut
1312 });
1313}
1314 1578
1315sub add_button { 1579sub add_button {
1316 my ($self, $text, $cb) = @_; 1580 my ($self, $text, $cb) = @_;
1317 1581
1318 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1582 $self->add_item ({ type => "button", text => $text, activate => $cb});
1319} 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
1320 1592
1321sub add_toggle { 1593sub add_toggle {
1322 my ($self, $text, $cb, $value) = @_; 1594 my ($self, $text, $cb, $value) = @_;
1323 1595
1324 my $item; $item = { 1596 my $item; $item = {
1325 type => "button", 1597 type => "button",
1326 text => " $text", 1598 text => " $text",
1327 value => $value, 1599 value => $value,
1328 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1600 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1329 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1601 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1330 }; 1602 };
1331 1603
1332 $self->add_item ($item); 1604 $self->add_item ($item);
1333} 1605}
1606
1607=item $popup->show
1608
1609Displays the popup (which is initially hidden).
1610
1611=cut
1334 1612
1335sub show { 1613sub show {
1336 my ($self) = @_; 1614 my ($self) = @_;
1337 1615
1338 local $urxvt::popup::self = $self; 1616 local $urxvt::popup::self = $self;
1339 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};
1340 local $ENV{LC_ALL} = $self->{term}->locale; 1621 $env->{LC_CTYPE} = $self->{term}->locale;
1341 1622
1342 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",
1343 "--transient-for" => $self->{term}->parent, 1627 "--transient-for" => $self->{term}->parent,
1344 "-display" => $self->{term}->display_id, 1628 "-display" => $self->{term}->display_id,
1345 "-pe" => "urxvt-popup") 1629 "-pe" => "urxvt-popup")
1346 or die "unable to create popup window\n"; 1630 or die "unable to create popup window\n";
1347} 1631}
1348 1632
1349sub DESTROY { 1633sub DESTROY {
1350 my ($self) = @_; 1634 my ($self) = @_;
1351 1635
1352 delete $self->{term}{_destroy}{$self}; 1636 delete $self->{term}{_destroy}{$self};
1353 $self->{term}->ungrab; 1637 $self->{term}->ungrab;
1354} 1638}
1639
1640=back
1355 1641
1356=head2 The C<urxvt::timer> Class 1642=head2 The C<urxvt::timer> Class
1357 1643
1358This class implements timer watchers/events. Time is represented as a 1644This class implements timer watchers/events. Time is represented as a
1359fractional number of seconds since the epoch. Example: 1645fractional number of seconds since the epoch. Example:
1397Start the timer. 1683Start the timer.
1398 1684
1399=item $timer = $timer->start ($tstamp) 1685=item $timer = $timer->start ($tstamp)
1400 1686
1401Set 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>.
1402 1692
1403=item $timer = $timer->stop 1693=item $timer = $timer->stop
1404 1694
1405Stop the timer. 1695Stop the timer.
1406 1696
1466 1756
1467=item == 0 - fatal messages 1757=item == 0 - fatal messages
1468 1758
1469=item >= 3 - script loading and management 1759=item >= 3 - script loading and management
1470 1760
1471=item >=10 - all events received 1761=item >=10 - all called hooks
1762
1763=item >=11 - hook reutrn values
1472 1764
1473=back 1765=back
1474 1766
1475=head1 AUTHOR 1767=head1 AUTHOR
1476 1768

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines