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.108 by root, Thu Jan 19 09:47:15 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines