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.76 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.108 by root, Thu Jan 19 09:47:15 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
72=item searchable-scrollback<hotkey> (enabled by default) 112=item searchable-scrollback<hotkey> (enabled by default)
73 113
74Adds regex search functionality to the scrollback buffer, triggered 114Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 115by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 116input/output is suspended and a regex is displayed at the bottom of the
117screen.
77 118
78C</> starts an incremental regex search, C<n> searches further, C<p> or 119Inputting 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 120search. 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> 121search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 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.
82 126
83=item digital-clock 127=item selection-autotransform
84 128
85Displays a digital clock using the built-in overlay. 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.
86 161
87=item mark-urls 162=item mark-urls
88 163
89Uses 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
90 176
91=item block-graphics-to-ascii 177=item block-graphics-to-ascii
92 178
93A 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,
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 181similar-looking ascii character.
96 182
183=item digital-clock
184
185Displays a digital clock using the built-in overlay.
186
97=item example-refresh-hooks 187=item example-refresh-hooks
98 188
99Displays 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
100window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
101overlays or changes. 191overlays or changes.
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/%
102 221
103=back 222=back
104 223
105=head1 API DOCUMENTATION 224=head1 API DOCUMENTATION
106 225
… …
123=over 4 242=over 4
124 243
125=item $text 244=item $text
126 245
127Rxvt-unicodes special way of encoding text, where one "unicode" character 246Rxvt-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. 247always represents one screen cell. See L<ROW_t> for a discussion of this format.
129 248
130=item $string 249=item $string
131 250
132A 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
133characters and is to be distinguished with text encoded in a specific 252characters and is to be distinguished with text encoded in a specific
… …
206=item on_start $term 325=item on_start $term
207 326
208Called 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
209returning to the mainloop. 328returning to the mainloop.
210 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
211=item on_sel_make $term, $eventtime 339=item on_sel_make $term, $eventtime
212 340
213Called 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
214selection 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
215selection will be honored. 343selection will be honored.
… …
228=item on_sel_extend $term 356=item on_sel_extend $term
229 357
230Called 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
231click) and is either supposed to return false (normal operation), or 359click) and is either supposed to return false (normal operation), or
232should 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
233processing. 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.
234 364
235See the F<selection> example extension. 365See the F<selection> example extension.
236 366
237=item on_view_change $term, $offset 367=item on_view_change $term, $offset
238 368
… …
305 435
306Called whenever the user presses a key combination that has a 436Called whenever the user presses a key combination that has a
307C<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>
308resource in the @@RXVT_NAME@@(1) manpage). 438resource in the @@RXVT_NAME@@(1) manpage).
309 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
310=item on_focus_in $term 446=item on_focus_in $term
311 447
312Called whenever the window gets the keyboard focus, before rxvt-unicode 448Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 449does focus in processing.
314 450
315=item on_focus_out $term 451=item on_focus_out $term
316 452
317Called wheneever the window loses keyboard focus, before rxvt-unicode does 453Called wheneever the window loses keyboard focus, before rxvt-unicode does
318focus out processing. 454focus out processing.
455
456=item on_configure_notify $term, $event
319 457
320=item on_key_press $term, $event, $keysym, $octets 458=item on_key_press $term, $event, $keysym, $octets
321 459
322=item on_key_release $term, $event, $keysym 460=item on_key_release $term, $event, $keysym
323 461
… …
340 478
341C<on_key_press> additionally receives the string rxvt-unicode would 479C<on_key_press> additionally receives the string rxvt-unicode would
342output, if any, in locale-specific encoding. 480output, if any, in locale-specific encoding.
343 481
344subwindow. 482subwindow.
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 483
471=back 484=back
472 485
473=cut 486=cut
474 487
… …
489our $LIBDIR; 502our $LIBDIR;
490our $RESNAME; 503our $RESNAME;
491our $RESCLASS; 504our $RESCLASS;
492our $RXVTNAME; 505our $RXVTNAME;
493 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
494BEGIN { 636BEGIN {
495 urxvt->bootstrap;
496
497 # overwrite perl's warn 637 # overwrite perl's warn
498 *CORE::GLOBAL::warn = sub { 638 *CORE::GLOBAL::warn = sub {
499 my $msg = join "", @_; 639 my $msg = join "", @_;
500 $msg .= "\n" 640 $msg .= "\n"
501 unless $msg =~ /\n$/; 641 unless $msg =~ /\n$/;
502 urxvt::warn ($msg); 642 urxvt::warn ($msg);
503 }; 643 };
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} 644}
510 645
511my @hook_count;
512my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 646my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513 647
514sub verbose { 648sub verbose {
515 my ($level, $msg) = @_; 649 my ($level, $msg) = @_;
516 warn "$msg\n" if $level <= $verbosity; 650 warn "$msg\n" if $level <= $verbosity;
517} 651}
518 652
519my $extension_pkg = "extension0000";
520my %extension_pkg; 653my %extension_pkg;
521 654
522# load a single script into its own package, once only 655# load a single script into its own package, once only
523sub extension_package($) { 656sub extension_package($) {
524 my ($path) = @_; 657 my ($path) = @_;
525 658
659 no strict 'refs';
660
526 $extension_pkg{$path} ||= do { 661 $extension_pkg{$path} ||= do {
527 my $pkg = "urxvt::" . ($extension_pkg++); 662 $path =~ /([^\/\\]+)$/;
663 my $pkg = $1;
664 $pkg =~ s/[^[:word:]]/_/g;
665 $pkg = "urxvt::ext::$pkg";
528 666
529 verbose 3, "loading extension '$path' into package '$pkg'"; 667 verbose 3, "loading extension '$path' into package '$pkg'";
530 668
531 open my $fh, "<:raw", $path 669 open my $fh, "<:raw", $path
532 or die "$path: $!"; 670 or die "$path: $!";
533 671
672 @{"$pkg\::ISA"} = urxvt::term::extension::;
673
534 my $source = untaint 674 my $source =
535 "package $pkg; use strict; use utf8;\n" 675 "package $pkg; use strict; use utf8;\n"
536 . "use base urxvt::term::extension::;\n"
537 . "#line 1 \"$path\"\n{\n" 676 . "#line 1 \"$path\"\n{\n"
538 . (do { local $/; <$fh> }) 677 . (do { local $/; <$fh> })
539 . "\n};\n1"; 678 . "\n};\n1";
540 679
541 eval $source 680 eval $source
… …
598 if ($@) { 737 if ($@) {
599 $TERM->ungrab; # better to lose the grab than the session 738 $TERM->ungrab; # better to lose the grab than the session
600 warn $@; 739 warn $@;
601 } 740 }
602 } 741 }
742
743 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
744 if $verbosity >= 11;
603 } 745 }
604 746
605 if ($htype == 1) { # DESTROY 747 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 748 # clear package objects
614 %$_ = () for values %{ $TERM->{_pkg} }; 749 %$_ = () for values %{ $TERM->{_pkg} };
615 750
616 # clear package 751 # clear package
617 %$TERM = (); 752 %$TERM = ();
… …
631 while (my ($name, $cb) = each %hook) { 766 while (my ($name, $cb) = each %hook) {
632 my $htype = $HOOKTYPE{uc $name}; 767 my $htype = $HOOKTYPE{uc $name};
633 defined $htype 768 defined $htype
634 or Carp::croak "unsupported hook type '$name'"; 769 or Carp::croak "unsupported hook type '$name'";
635 770
771 $self->set_should_invoke ($htype, +1)
636 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 772 unless exists $self->{term}{_hook}[$htype]{$pkg};
637 $hook_count[$htype]++
638 or urxvt::set_should_invoke $htype, 1;
639 }
640 773
641 $self->{term}{_hook}[$htype]{$pkg} = $cb; 774 $self->{term}{_hook}[$htype]{$pkg} = $cb;
642 } 775 }
643} 776}
644 777
… …
649 for my $name (@hook) { 782 for my $name (@hook) {
650 my $htype = $HOOKTYPE{uc $name}; 783 my $htype = $HOOKTYPE{uc $name};
651 defined $htype 784 defined $htype
652 or Carp::croak "unsupported hook type '$name'"; 785 or Carp::croak "unsupported hook type '$name'";
653 786
787 $self->set_should_invoke ($htype, -1)
654 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 788 if delete $self->{term}{_hook}[$htype]{$pkg};
655 --$hook_count[$htype]
656 or urxvt::set_should_invoke $htype, 0;
657 }
658 } 789 }
659} 790}
660 791
661our $AUTOLOAD; 792our $AUTOLOAD;
662 793
… …
783 $proxy->enable ($name => $ref); 914 $proxy->enable ($name => $ref);
784 } 915 }
785 } 916 }
786} 917}
787 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
788=item $term->destroy 938=item $term->destroy
789 939
790Destroy the terminal object (close the window, free resources 940Destroy the terminal object (close the window, free resources
791etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 941etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792watchers (timers, io watchers) are still active. 942watchers (timers, io watchers) are still active.
793 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}
968
794=item $isset = $term->option ($optval[, $set]) 969=item $isset = $term->option ($optval[, $set])
795 970
796Returns true if the option specified by C<$optval> is enabled, and 971Returns true if the option specified by C<$optval> is enabled, and
797optionally 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
798C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 973C<%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 975Here is a a likely non-exhaustive list of option names, please see the
801source file F</src/optinc.h> to see the actual list: 976source file F</src/optinc.h> to see the actual list:
802 977
803 borderLess console cursorBlink cursorUnderline hold iconic insecure 978 borderLess console cursorBlink cursorUnderline hold iconic insecure
804 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 979 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 980 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 981 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 982 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808 tripleclickwords utmpInhibit visualBell 983 transparent tripleclickwords utmpInhibit visualBell
809 984
810=item $value = $term->resource ($name[, $newval]) 985=item $value = $term->resource ($name[, $newval])
811 986
812Returns the current resource value associated with a given name and 987Returns the current resource value associated with a given name and
813optionally 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>
… …
830 1005
831 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1006 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832 borderLess color cursorBlink cursorUnderline cutchars delete_key 1007 borderLess color cursorBlink cursorUnderline cutchars delete_key
833 display_name embed ext_bwidth fade font geometry hold iconName 1008 display_name embed ext_bwidth fade font geometry hold iconName
834 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1009 imFont imLocale inputMethod insecure int_bwidth intensityStyles
835 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1010 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1011 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1012 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1013 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1014 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1015 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841 shade term_name title transparent transparent_all tripleclickwords 1016 secondaryScreen secondaryScroll selectstyle shade term_name title
842 utmpInhibit visualBell 1017 transient_for transparent transparent_all tripleclickwords utmpInhibit
1018 visualBell
843 1019
844=cut 1020=cut
845 1021
846sub resource($$;$) { 1022sub resource($$;$) {
847 my ($self, $name) = (shift, shift); 1023 my ($self, $name) = (shift, shift);
848 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1024 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849 &urxvt::term::_resource 1025 &urxvt::term::_resource
850} 1026}
851 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
852=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1039=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853 1040
854Adds a keymap translation exactly as specified via a resource. See the 1041Adds a keymap translation exactly as specified via a resource. See the
855C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1042C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856 1043
… …
871=item ($row, $col) = $term->selection_end ([$row, $col]) 1058=item ($row, $col) = $term->selection_end ([$row, $col])
872 1059
873Return the current values of the selection mark, begin or end positions, 1060Return the current values of the selection mark, begin or end positions,
874and optionally set them to new values. 1061and optionally set them to new values.
875 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
876=item $success = $term->selection_grab ($eventtime) 1070=item $success = $term->selection_grab ($eventtime)
877 1071
878Try 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
879by 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.
880 1075
881=item $oldtext = $term->selection ([$newtext]) 1076=item $oldtext = $term->selection ([$newtext])
882 1077
883Return the current selection text and optionally replace it by C<$newtext>. 1078Return the current selection text and optionally replace it by C<$newtext>.
884 1079
… …
977Convert the given locale-encoded octets into a perl string. 1172Convert the given locale-encoded octets into a perl string.
978 1173
979=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])
980 1175
981XORs the rendition values in the given span with the provided value 1176XORs the rendition values in the given span with the provided value
982(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
983to the selection. 1178refresh hooks to provide effects similar to the selection.
984 1179
985=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]])
986 1181
987Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1182Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988whitespace will additionally be xored with the C<$rstyle2>, which defaults 1183whitespace will additionally be xored with the C<$rstyle2>, which defaults
989to 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
990it instead. 1185it instead. Both styles I<MUST NOT> contain font styles.
991 1186
992=item $term->scr_bell 1187=item $term->scr_bell
993 1188
994Ring the bell! 1189Ring the bell!
995 1190
… …
1029 1224
1030=item $windowid = $term->vt 1225=item $windowid = $term->vt
1031 1226
1032Return the window id of the terminal window. 1227Return the window id of the terminal window.
1033 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
1034=item $window_width = $term->width 1236=item $window_width = $term->width
1035 1237
1036=item $window_height = $term->height 1238=item $window_height = $term->height
1037 1239
1038=item $font_width = $term->fwidth 1240=item $font_width = $term->fwidth
… …
1051 1253
1052=item $max_scrollback = $term->saveLines 1254=item $max_scrollback = $term->saveLines
1053 1255
1054=item $nrow_plus_saveLines = $term->total_rows 1256=item $nrow_plus_saveLines = $term->total_rows
1055 1257
1056=item $lines_in_scrollback = $term->nsaved 1258=item $topmost_scrollback_row = $term->top_row
1057 1259
1058Return various integers describing terminal characteristics. 1260Return various integers describing terminal characteristics.
1059 1261
1262=item $x_display = $term->display_id
1263
1264Return the DISPLAY used by rxvt-unicode.
1265
1060=item $lc_ctype = $term->locale 1266=item $lc_ctype = $term->locale
1061 1267
1062Returns the LC_CTYPE category string used by this rxvt-unicode. 1268Returns the LC_CTYPE category string used by this rxvt-unicode.
1063 1269
1064=item $x_display = $term->display_id 1270=item $env = $term->env
1065 1271
1066Return 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}
1067 1284
1068=item $modifiermask = $term->ModLevel3Mask 1285=item $modifiermask = $term->ModLevel3Mask
1069 1286
1070=item $modifiermask = $term->ModMetaMask 1287=item $modifiermask = $term->ModMetaMask
1071 1288
… …
1074Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1291Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075AltGr), 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.
1076 1293
1077=item $view_start = $term->view_start ([$newvalue]) 1294=item $view_start = $term->view_start ([$newvalue])
1078 1295
1079Returns the negative row number of the topmost line. Minimum value is 1296Returns the row number of the topmost displayed line. Maximum value is
1080C<0>, which displays the normal terminal contents. Larger values scroll 1297C<0>, which displays the normal terminal contents. Lower values scroll
1081this many lines into the scrollback buffer. 1298this many lines into the scrollback buffer.
1082 1299
1083=item $term->want_refresh 1300=item $term->want_refresh
1084 1301
1085Requests a screen refresh. At the next opportunity, rxvt-unicode will 1302Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1164Return 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.
1165 1382
1166=item $offset = $line->offset_of ($row, $col) 1383=item $offset = $line->offset_of ($row, $col)
1167 1384
1168Returns 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
1169line. 1386line. Works for rows outside the line, too, and returns corresponding
1387offsets outside the string.
1170 1388
1171=item ($row, $col) = $line->coord_of ($offset) 1389=item ($row, $col) = $line->coord_of ($offset)
1172 1390
1173Translates a string offset into terminal coordinates again. 1391Translates a string offset into terminal coordinates again.
1174 1392
… …
1392sub show { 1610sub show {
1393 my ($self) = @_; 1611 my ($self) = @_;
1394 1612
1395 local $urxvt::popup::self = $self; 1613 local $urxvt::popup::self = $self;
1396 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};
1397 local $ENV{LC_ALL} = $self->{term}->locale; 1618 $env->{LC_CTYPE} = $self->{term}->locale;
1398 1619
1399 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",
1400 "--transient-for" => $self->{term}->parent, 1624 "--transient-for" => $self->{term}->parent,
1401 "-display" => $self->{term}->display_id, 1625 "-display" => $self->{term}->display_id,
1402 "-pe" => "urxvt-popup") 1626 "-pe" => "urxvt-popup")
1403 or die "unable to create popup window\n"; 1627 or die "unable to create popup window\n";
1404} 1628}
1405 1629
1406sub DESTROY { 1630sub DESTROY {
1407 my ($self) = @_; 1631 my ($self) = @_;
1408 1632
1409 delete $self->{term}{_destroy}{$self}; 1633 delete $self->{term}{_destroy}{$self};
1410 $self->{term}->ungrab; 1634 $self->{term}->ungrab;
1411} 1635}
1636
1637=back
1412 1638
1413=head2 The C<urxvt::timer> Class 1639=head2 The C<urxvt::timer> Class
1414 1640
1415This class implements timer watchers/events. Time is represented as a 1641This class implements timer watchers/events. Time is represented as a
1416fractional number of seconds since the epoch. Example: 1642fractional number of seconds since the epoch. Example:
… …
1454Start the timer. 1680Start the timer.
1455 1681
1456=item $timer = $timer->start ($tstamp) 1682=item $timer = $timer->start ($tstamp)
1457 1683
1458Set 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>.
1459 1689
1460=item $timer = $timer->stop 1690=item $timer = $timer->stop
1461 1691
1462Stop the timer. 1692Stop the timer.
1463 1693
… …
1523 1753
1524=item == 0 - fatal messages 1754=item == 0 - fatal messages
1525 1755
1526=item >= 3 - script loading and management 1756=item >= 3 - script loading and management
1527 1757
1528=item >=10 - all events received 1758=item >=10 - all called hooks
1759
1760=item >=11 - hook reutrn values
1529 1761
1530=back 1762=back
1531 1763
1532=head1 AUTHOR 1764=head1 AUTHOR
1533 1765

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines