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.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.110 by root, Thu Jan 19 16:22:13 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines