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.109 by root, Thu Jan 19 16:07:09 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 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
72=item searchable-scrollback<hotkey> (enabled by default) 115=item searchable-scrollback<hotkey> (enabled by default)
73 116
74Adds regex search functionality to the scrollback buffer, triggered 117Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 118by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 119input/output is suspended and a regex is displayed at the bottom of the
120screen.
77 121
78C</> starts an incremental regex search, C<n> searches further, C<p> or 122Inputting 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 123search. 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> 124search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 125bottom. C<Escape> leaves search mode and returns to the point where search
126was started, while C<Enter> or C<Return> stay at the current position and
127additionally stores the first match in the current line into the primary
128selection.
82 129
83=item digital-clock 130=item selection-autotransform
84 131
85Displays a digital clock using the built-in overlay. 132This selection allows you to do automatic transforms on a selection
133whenever a selection is made.
134
135It works by specifying perl snippets (most useful is a single C<s///>
136operator) that modify C<$_> as resources:
137
138 URxvt.selection-autotransform.0: transform
139 URxvt.selection-autotransform.1: transform
140 ...
141
142For example, the following will transform selections of the form
143C<filename:number>, often seen in compiler messages, into C<vi +$filename
144$word>:
145
146 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
147
148And this example matches the same,but replaces it with vi-commands you can
149paste directly into your (vi :) editor:
150
151 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
152
153Of course, this can be modified to suit your needs and your editor :)
154
155To expand the example above to typical perl error messages ("XXX at
156FILENAME line YYY."), you need a slightly more elaborate solution:
157
158 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
159 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
160
161The first line tells the selection code to treat the unchanging part of
162every error message as a selection pattern, and the second line transforms
163the message into vi commands to load the file.
86 164
87=item mark-urls 165=item mark-urls
88 166
89Uses 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
90 179
91=item block-graphics-to-ascii 180=item block-graphics-to-ascii
92 181
93A 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,
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 183by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 184similar-looking ascii character.
96 185
186=item digital-clock
187
188Displays a digital clock using the built-in overlay.
189
97=item example-refresh-hooks 190=item example-refresh-hooks
98 191
99Displays 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
100window. Illustrates overwriting the refresh callbacks to create your own 193window. Illustrates overwriting the refresh callbacks to create your own
101overlays or changes. 194overlays or changes.
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/%
102 224
103=back 225=back
104 226
105=head1 API DOCUMENTATION 227=head1 API DOCUMENTATION
106 228
123=over 4 245=over 4
124 246
125=item $text 247=item $text
126 248
127Rxvt-unicodes special way of encoding text, where one "unicode" character 249Rxvt-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. 250always represents one screen cell. See L<ROW_t> for a discussion of this format.
129 251
130=item $string 252=item $string
131 253
132A 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
133characters and is to be distinguished with text encoded in a specific 255characters and is to be distinguished with text encoded in a specific
206=item on_start $term 328=item on_start $term
207 329
208Called 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
209returning to the mainloop. 331returning to the mainloop.
210 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
211=item on_sel_make $term, $eventtime 342=item on_sel_make $term, $eventtime
212 343
213Called 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
214selection 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
215selection will be honored. 346selection will be honored.
228=item on_sel_extend $term 359=item on_sel_extend $term
229 360
230Called 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
231click) and is either supposed to return false (normal operation), or 362click) and is either supposed to return false (normal operation), or
232should 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
233processing. 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.
234 367
235See the F<selection> example extension. 368See the F<selection> example extension.
236 369
237=item on_view_change $term, $offset 370=item on_view_change $term, $offset
238 371
305 438
306Called whenever the user presses a key combination that has a 439Called whenever the user presses a key combination that has a
307C<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>
308resource in the @@RXVT_NAME@@(1) manpage). 441resource in the @@RXVT_NAME@@(1) manpage).
309 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
310=item on_focus_in $term 449=item on_focus_in $term
311 450
312Called whenever the window gets the keyboard focus, before rxvt-unicode 451Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 452does focus in processing.
314 453
315=item on_focus_out $term 454=item on_focus_out $term
316 455
317Called wheneever the window loses keyboard focus, before rxvt-unicode does 456Called wheneever the window loses keyboard focus, before rxvt-unicode does
318focus out processing. 457focus out processing.
458
459=item on_configure_notify $term, $event
319 460
320=item on_key_press $term, $event, $keysym, $octets 461=item on_key_press $term, $event, $keysym, $octets
321 462
322=item on_key_release $term, $event, $keysym 463=item on_key_release $term, $event, $keysym
323 464
340 481
341C<on_key_press> additionally receives the string rxvt-unicode would 482C<on_key_press> additionally receives the string rxvt-unicode would
342output, if any, in locale-specific encoding. 483output, if any, in locale-specific encoding.
343 484
344subwindow. 485subwindow.
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 486
471=back 487=back
472 488
473=cut 489=cut
474 490
489our $LIBDIR; 505our $LIBDIR;
490our $RESNAME; 506our $RESNAME;
491our $RESCLASS; 507our $RESCLASS;
492our $RXVTNAME; 508our $RXVTNAME;
493 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
494BEGIN { 639BEGIN {
495 urxvt->bootstrap;
496
497 # overwrite perl's warn 640 # overwrite perl's warn
498 *CORE::GLOBAL::warn = sub { 641 *CORE::GLOBAL::warn = sub {
499 my $msg = join "", @_; 642 my $msg = join "", @_;
500 $msg .= "\n" 643 $msg .= "\n"
501 unless $msg =~ /\n$/; 644 unless $msg =~ /\n$/;
502 urxvt::warn ($msg); 645 urxvt::warn ($msg);
503 }; 646 };
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} 647}
510 648
511my @hook_count;
512my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 649my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513 650
514sub verbose { 651sub verbose {
515 my ($level, $msg) = @_; 652 my ($level, $msg) = @_;
516 warn "$msg\n" if $level <= $verbosity; 653 warn "$msg\n" if $level <= $verbosity;
517} 654}
518 655
519my $extension_pkg = "extension0000";
520my %extension_pkg; 656my %extension_pkg;
521 657
522# load a single script into its own package, once only 658# load a single script into its own package, once only
523sub extension_package($) { 659sub extension_package($) {
524 my ($path) = @_; 660 my ($path) = @_;
525 661
662 no strict 'refs';
663
526 $extension_pkg{$path} ||= do { 664 $extension_pkg{$path} ||= do {
527 my $pkg = "urxvt::" . ($extension_pkg++); 665 $path =~ /([^\/\\]+)$/;
666 my $pkg = $1;
667 $pkg =~ s/[^[:word:]]/_/g;
668 $pkg = "urxvt::ext::$pkg";
528 669
529 verbose 3, "loading extension '$path' into package '$pkg'"; 670 verbose 3, "loading extension '$path' into package '$pkg'";
530 671
531 open my $fh, "<:raw", $path 672 open my $fh, "<:raw", $path
532 or die "$path: $!"; 673 or die "$path: $!";
533 674
675 @{"$pkg\::ISA"} = urxvt::term::extension::;
676
534 my $source = untaint 677 my $source =
535 "package $pkg; use strict; use utf8;\n" 678 "package $pkg; use strict; use utf8;\n"
536 . "use base urxvt::term::extension::;\n"
537 . "#line 1 \"$path\"\n{\n" 679 . "#line 1 \"$path\"\n{\n"
538 . (do { local $/; <$fh> }) 680 . (do { local $/; <$fh> })
539 . "\n};\n1"; 681 . "\n};\n1";
540 682
541 eval $source 683 eval $source
598 if ($@) { 740 if ($@) {
599 $TERM->ungrab; # better to lose the grab than the session 741 $TERM->ungrab; # better to lose the grab than the session
600 warn $@; 742 warn $@;
601 } 743 }
602 } 744 }
745
746 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
747 if $verbosity >= 11;
603 } 748 }
604 749
605 if ($htype == 1) { # DESTROY 750 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 751 # clear package objects
614 %$_ = () for values %{ $TERM->{_pkg} }; 752 %$_ = () for values %{ $TERM->{_pkg} };
615 753
616 # clear package 754 # clear package
617 %$TERM = (); 755 %$TERM = ();
631 while (my ($name, $cb) = each %hook) { 769 while (my ($name, $cb) = each %hook) {
632 my $htype = $HOOKTYPE{uc $name}; 770 my $htype = $HOOKTYPE{uc $name};
633 defined $htype 771 defined $htype
634 or Carp::croak "unsupported hook type '$name'"; 772 or Carp::croak "unsupported hook type '$name'";
635 773
774 $self->set_should_invoke ($htype, +1)
636 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 775 unless exists $self->{term}{_hook}[$htype]{$pkg};
637 $hook_count[$htype]++
638 or urxvt::set_should_invoke $htype, 1;
639 }
640 776
641 $self->{term}{_hook}[$htype]{$pkg} = $cb; 777 $self->{term}{_hook}[$htype]{$pkg} = $cb;
642 } 778 }
643} 779}
644 780
649 for my $name (@hook) { 785 for my $name (@hook) {
650 my $htype = $HOOKTYPE{uc $name}; 786 my $htype = $HOOKTYPE{uc $name};
651 defined $htype 787 defined $htype
652 or Carp::croak "unsupported hook type '$name'"; 788 or Carp::croak "unsupported hook type '$name'";
653 789
790 $self->set_should_invoke ($htype, -1)
654 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 791 if delete $self->{term}{_hook}[$htype]{$pkg};
655 --$hook_count[$htype]
656 or urxvt::set_should_invoke $htype, 0;
657 }
658 } 792 }
659} 793}
660 794
661our $AUTOLOAD; 795our $AUTOLOAD;
662 796
783 $proxy->enable ($name => $ref); 917 $proxy->enable ($name => $ref);
784 } 918 }
785 } 919 }
786} 920}
787 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
788=item $term->destroy 941=item $term->destroy
789 942
790Destroy the terminal object (close the window, free resources 943Destroy the terminal object (close the window, free resources
791etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 944etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792watchers (timers, io watchers) are still active. 945watchers (timers, io watchers) are still active.
793 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}
971
794=item $isset = $term->option ($optval[, $set]) 972=item $isset = $term->option ($optval[, $set])
795 973
796Returns true if the option specified by C<$optval> is enabled, and 974Returns true if the option specified by C<$optval> is enabled, and
797optionally 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
798C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 976C<%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 978Here is a a likely non-exhaustive list of option names, please see the
801source file F</src/optinc.h> to see the actual list: 979source file F</src/optinc.h> to see the actual list:
802 980
803 borderLess console cursorBlink cursorUnderline hold iconic insecure 981 borderLess console cursorBlink cursorUnderline hold iconic insecure
804 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 982 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 983 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 984 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 985 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808 tripleclickwords utmpInhibit visualBell 986 transparent tripleclickwords utmpInhibit visualBell
809 987
810=item $value = $term->resource ($name[, $newval]) 988=item $value = $term->resource ($name[, $newval])
811 989
812Returns the current resource value associated with a given name and 990Returns the current resource value associated with a given name and
813optionally 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>
830 1008
831 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1009 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832 borderLess color cursorBlink cursorUnderline cutchars delete_key 1010 borderLess color cursorBlink cursorUnderline cutchars delete_key
833 display_name embed ext_bwidth fade font geometry hold iconName 1011 display_name embed ext_bwidth fade font geometry hold iconName
834 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1012 imFont imLocale inputMethod insecure int_bwidth intensityStyles
835 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1013 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1014 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1015 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1016 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1017 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1018 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841 shade term_name title transparent transparent_all tripleclickwords 1019 secondaryScreen secondaryScroll selectstyle shade term_name title
842 utmpInhibit visualBell 1020 transient_for transparent transparent_all tripleclickwords utmpInhibit
1021 visualBell
843 1022
844=cut 1023=cut
845 1024
846sub resource($$;$) { 1025sub resource($$;$) {
847 my ($self, $name) = (shift, shift); 1026 my ($self, $name) = (shift, shift);
848 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1027 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849 &urxvt::term::_resource 1028 &urxvt::term::_resource
850} 1029}
851 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
852=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1042=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853 1043
854Adds a keymap translation exactly as specified via a resource. See the 1044Adds a keymap translation exactly as specified via a resource. See the
855C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1045C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856 1046
871=item ($row, $col) = $term->selection_end ([$row, $col]) 1061=item ($row, $col) = $term->selection_end ([$row, $col])
872 1062
873Return the current values of the selection mark, begin or end positions, 1063Return the current values of the selection mark, begin or end positions,
874and optionally set them to new values. 1064and optionally set them to new values.
875 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
876=item $success = $term->selection_grab ($eventtime) 1073=item $success = $term->selection_grab ($eventtime)
877 1074
878Try 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
879by 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.
880 1078
881=item $oldtext = $term->selection ([$newtext]) 1079=item $oldtext = $term->selection ([$newtext])
882 1080
883Return the current selection text and optionally replace it by C<$newtext>. 1081Return the current selection text and optionally replace it by C<$newtext>.
884 1082
977Convert the given locale-encoded octets into a perl string. 1175Convert the given locale-encoded octets into a perl string.
978 1176
979=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])
980 1178
981XORs the rendition values in the given span with the provided value 1179XORs the rendition values in the given span with the provided value
982(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
983to the selection. 1181refresh hooks to provide effects similar to the selection.
984 1182
985=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]])
986 1184
987Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1185Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988whitespace will additionally be xored with the C<$rstyle2>, which defaults 1186whitespace will additionally be xored with the C<$rstyle2>, which defaults
989to 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
990it instead. 1188it instead. Both styles I<MUST NOT> contain font styles.
991 1189
992=item $term->scr_bell 1190=item $term->scr_bell
993 1191
994Ring the bell! 1192Ring the bell!
995 1193
1029 1227
1030=item $windowid = $term->vt 1228=item $windowid = $term->vt
1031 1229
1032Return the window id of the terminal window. 1230Return the window id of the terminal window.
1033 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
1034=item $window_width = $term->width 1239=item $window_width = $term->width
1035 1240
1036=item $window_height = $term->height 1241=item $window_height = $term->height
1037 1242
1038=item $font_width = $term->fwidth 1243=item $font_width = $term->fwidth
1051 1256
1052=item $max_scrollback = $term->saveLines 1257=item $max_scrollback = $term->saveLines
1053 1258
1054=item $nrow_plus_saveLines = $term->total_rows 1259=item $nrow_plus_saveLines = $term->total_rows
1055 1260
1056=item $lines_in_scrollback = $term->nsaved 1261=item $topmost_scrollback_row = $term->top_row
1057 1262
1058Return various integers describing terminal characteristics. 1263Return various integers describing terminal characteristics.
1059 1264
1265=item $x_display = $term->display_id
1266
1267Return the DISPLAY used by rxvt-unicode.
1268
1060=item $lc_ctype = $term->locale 1269=item $lc_ctype = $term->locale
1061 1270
1062Returns the LC_CTYPE category string used by this rxvt-unicode. 1271Returns the LC_CTYPE category string used by this rxvt-unicode.
1063 1272
1064=item $x_display = $term->display_id 1273=item $env = $term->env
1065 1274
1066Return 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}
1067 1287
1068=item $modifiermask = $term->ModLevel3Mask 1288=item $modifiermask = $term->ModLevel3Mask
1069 1289
1070=item $modifiermask = $term->ModMetaMask 1290=item $modifiermask = $term->ModMetaMask
1071 1291
1074Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1294Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075AltGr), 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.
1076 1296
1077=item $view_start = $term->view_start ([$newvalue]) 1297=item $view_start = $term->view_start ([$newvalue])
1078 1298
1079Returns the negative row number of the topmost line. Minimum value is 1299Returns the row number of the topmost displayed line. Maximum value is
1080C<0>, which displays the normal terminal contents. Larger values scroll 1300C<0>, which displays the normal terminal contents. Lower values scroll
1081this many lines into the scrollback buffer. 1301this many lines into the scrollback buffer.
1082 1302
1083=item $term->want_refresh 1303=item $term->want_refresh
1084 1304
1085Requests a screen refresh. At the next opportunity, rxvt-unicode will 1305Requests a screen refresh. At the next opportunity, rxvt-unicode will
1164Return 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.
1165 1385
1166=item $offset = $line->offset_of ($row, $col) 1386=item $offset = $line->offset_of ($row, $col)
1167 1387
1168Returns 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
1169line. 1389line. Works for rows outside the line, too, and returns corresponding
1390offsets outside the string.
1170 1391
1171=item ($row, $col) = $line->coord_of ($offset) 1392=item ($row, $col) = $line->coord_of ($offset)
1172 1393
1173Translates a string offset into terminal coordinates again. 1394Translates a string offset into terminal coordinates again.
1174 1395
1311 $item->{render} ||= sub { $_[0]{text} }; 1532 $item->{render} ||= sub { $_[0]{text} };
1312 1533
1313 push @{ $self->{item} }, $item; 1534 push @{ $self->{item} }, $item;
1314} 1535}
1315 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
1316sub add_separator { 1559sub add_separator {
1317 my ($self, $sep) = @_; 1560 my ($self, $sep) = @_;
1318 1561
1319 $sep ||= "="; 1562 $sep ||= "=";
1320 1563
1324 render => sub { $sep x $self->{term}->ncol }, 1567 render => sub { $sep x $self->{term}->ncol },
1325 activate => sub { }, 1568 activate => sub { },
1326 }); 1569 });
1327} 1570}
1328 1571
1329sub add_title { 1572=item $popup->add_button ($text, $cb)
1330 my ($self, $title) = @_;
1331 1573
1332 $self->add_item ({ 1574Adds 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" }, 1575selected.
1334 text => $title, 1576
1335 activate => sub { }, 1577=cut
1336 });
1337}
1338 1578
1339sub add_button { 1579sub add_button {
1340 my ($self, $text, $cb) = @_; 1580 my ($self, $text, $cb) = @_;
1341 1581
1342 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1582 $self->add_item ({ type => "button", text => $text, activate => $cb});
1343} 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
1344 1592
1345sub add_toggle { 1593sub add_toggle {
1346 my ($self, $text, $cb, $value) = @_; 1594 my ($self, $text, $cb, $value) = @_;
1347 1595
1348 my $item; $item = { 1596 my $item; $item = {
1349 type => "button", 1597 type => "button",
1350 text => " $text", 1598 text => " $text",
1351 value => $value, 1599 value => $value,
1352 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1600 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1601 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354 }; 1602 };
1355 1603
1356 $self->add_item ($item); 1604 $self->add_item ($item);
1357} 1605}
1606
1607=item $popup->show
1608
1609Displays the popup (which is initially hidden).
1610
1611=cut
1358 1612
1359sub show { 1613sub show {
1360 my ($self) = @_; 1614 my ($self) = @_;
1361 1615
1362 local $urxvt::popup::self = $self; 1616 local $urxvt::popup::self = $self;
1363 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};
1364 local $ENV{LC_ALL} = $self->{term}->locale; 1621 $env->{LC_CTYPE} = $self->{term}->locale;
1365 1622
1366 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",
1367 "--transient-for" => $self->{term}->parent, 1627 "--transient-for" => $self->{term}->parent,
1368 "-display" => $self->{term}->display_id, 1628 "-display" => $self->{term}->display_id,
1369 "-pe" => "urxvt-popup") 1629 "-pe" => "urxvt-popup")
1370 or die "unable to create popup window\n"; 1630 or die "unable to create popup window\n";
1371} 1631}
1372 1632
1373sub DESTROY { 1633sub DESTROY {
1374 my ($self) = @_; 1634 my ($self) = @_;
1375 1635
1376 delete $self->{term}{_destroy}{$self}; 1636 delete $self->{term}{_destroy}{$self};
1377 $self->{term}->ungrab; 1637 $self->{term}->ungrab;
1378} 1638}
1639
1640=back
1379 1641
1380=head2 The C<urxvt::timer> Class 1642=head2 The C<urxvt::timer> Class
1381 1643
1382This class implements timer watchers/events. Time is represented as a 1644This class implements timer watchers/events. Time is represented as a
1383fractional number of seconds since the epoch. Example: 1645fractional number of seconds since the epoch. Example:
1421Start the timer. 1683Start the timer.
1422 1684
1423=item $timer = $timer->start ($tstamp) 1685=item $timer = $timer->start ($tstamp)
1424 1686
1425Set 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>.
1426 1692
1427=item $timer = $timer->stop 1693=item $timer = $timer->stop
1428 1694
1429Stop the timer. 1695Stop the timer.
1430 1696
1490 1756
1491=item == 0 - fatal messages 1757=item == 0 - fatal messages
1492 1758
1493=item >= 3 - script loading and management 1759=item >= 3 - script loading and management
1494 1760
1495=item >=10 - all events received 1761=item >=10 - all called hooks
1762
1763=item >=11 - hook reutrn values
1496 1764
1497=back 1765=back
1498 1766
1499=head1 AUTHOR 1767=head1 AUTHOR
1500 1768

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines