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.107 by root, Wed Jan 18 21:30:50 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+):?$/\\x1b: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+)\\.$/\x1b: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
… …
228=item on_sel_extend $term 347=item on_sel_extend $term
229 348
230Called whenever the user tries to extend the selection (e.g. with a double 349Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 350click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 351should extend the selection itelf and return true to suppress the built-in
233processing. 352processing. This can happen multiple times, as long as the callback
353returns true, it will be called on every further click by the user and is
354supposed to enlarge the selection more and more, if possible.
234 355
235See the F<selection> example extension. 356See the F<selection> example extension.
236 357
237=item on_view_change $term, $offset 358=item on_view_change $term, $offset
238 359
… …
305 426
306Called whenever the user presses a key combination that has a 427Called whenever the user presses a key combination that has a
307C<perl:string> action bound to it (see description of the B<keysym> 428C<perl:string> action bound to it (see description of the B<keysym>
308resource in the @@RXVT_NAME@@(1) manpage). 429resource in the @@RXVT_NAME@@(1) manpage).
309 430
431=item on_x_event $term, $event
432
433Called on every X event received on the vt window (and possibly other
434windows). Should only be used as a last resort. Most event structure
435members are not passed.
436
310=item on_focus_in $term 437=item on_focus_in $term
311 438
312Called whenever the window gets the keyboard focus, before rxvt-unicode 439Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 440does focus in processing.
314 441
315=item on_focus_out $term 442=item on_focus_out $term
316 443
317Called wheneever the window loses keyboard focus, before rxvt-unicode does 444Called wheneever the window loses keyboard focus, before rxvt-unicode does
318focus out processing. 445focus out processing.
446
447=item on_configure_notify $term, $event
319 448
320=item on_key_press $term, $event, $keysym, $octets 449=item on_key_press $term, $event, $keysym, $octets
321 450
322=item on_key_release $term, $event, $keysym 451=item on_key_release $term, $event, $keysym
323 452
… …
340 469
341C<on_key_press> additionally receives the string rxvt-unicode would 470C<on_key_press> additionally receives the string rxvt-unicode would
342output, if any, in locale-specific encoding. 471output, if any, in locale-specific encoding.
343 472
344subwindow. 473subwindow.
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 474
471=back 475=back
472 476
473=cut 477=cut
474 478
… …
489our $LIBDIR; 493our $LIBDIR;
490our $RESNAME; 494our $RESNAME;
491our $RESCLASS; 495our $RESCLASS;
492our $RXVTNAME; 496our $RXVTNAME;
493 497
498=head2 Variables in the C<urxvt> Package
499
500=over 4
501
502=item $urxvt::LIBDIR
503
504The rxvt-unicode library directory, where, among other things, the perl
505modules and scripts are stored.
506
507=item $urxvt::RESCLASS, $urxvt::RESCLASS
508
509The resource class and name rxvt-unicode uses to look up X resources.
510
511=item $urxvt::RXVTNAME
512
513The basename of the installed binaries, usually C<urxvt>.
514
515=item $urxvt::TERM
516
517The current terminal. This variable stores the current C<urxvt::term>
518object, whenever a callback/hook is executing.
519
520=back
521
522=head2 Functions in the C<urxvt> Package
523
524=over 4
525
526=item urxvt::fatal $errormessage
527
528Fatally aborts execution with the given error message. Avoid at all
529costs! The only time this is acceptable is when the terminal process
530starts up.
531
532=item urxvt::warn $string
533
534Calls C<rxvt_warn> with the given string which should not include a
535newline. The module also overwrites the C<warn> builtin with a function
536that calls this function.
537
538Using this function has the advantage that its output ends up in the
539correct place, e.g. on stderr of the connecting urxvtc client.
540
541Messages have a size limit of 1023 bytes currently.
542
543=item $time = urxvt::NOW
544
545Returns the "current time" (as per the event loop).
546
547=item urxvt::CurrentTime
548
549=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
550Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
551Button4Mask, Button5Mask, AnyModifier
552
553=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
554ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
555PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
556Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
557KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
558ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
559FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
560
561=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
562EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
563GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
564UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
565ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
566CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
567SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
568
569Various constants for use in X calls and event processing.
570
571=back
572
573=head2 RENDITION
574
575Rendition bitsets contain information about colour, font, font styles and
576similar information for each screen cell.
577
578The following "macros" deal with changes in rendition sets. You should
579never just create a bitset, you should always modify an existing one,
580as they contain important information required for correct operation of
581rxvt-unicode.
582
583=over 4
584
585=item $rend = urxvt::DEFAULT_RSTYLE
586
587Returns the default rendition, as used when the terminal is starting up or
588being reset. Useful as a base to start when creating renditions.
589
590=item $rend = urxvt::OVERLAY_RSTYLE
591
592Return the rendition mask used for overlays by default.
593
594=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
595
596Return the bit that enabled bold, italic, blink, reverse-video and
597underline, respectively. To enable such a style, just logically OR it into
598the bitset.
599
600=item $foreground = urxvt::GET_BASEFG $rend
601
602=item $background = urxvt::GET_BASEBG $rend
603
604Return the foreground/background colour index, respectively.
605
606=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607
608=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
609
610Replace the foreground/background colour in the rendition mask with the
611specified one.
612
613=item $value = urxvt::GET_CUSTOM $rend
614
615Return the "custom" value: Every rendition has 5 bits for use by
616extensions. They can be set and changed as you like and are initially
617zero.
618
619=item $rend = urxvt::SET_CUSTOM $rend, $new_value
620
621Change the custom value.
622
623=back
624
625=cut
626
494BEGIN { 627BEGIN {
495 urxvt->bootstrap;
496
497 # overwrite perl's warn 628 # overwrite perl's warn
498 *CORE::GLOBAL::warn = sub { 629 *CORE::GLOBAL::warn = sub {
499 my $msg = join "", @_; 630 my $msg = join "", @_;
500 $msg .= "\n" 631 $msg .= "\n"
501 unless $msg =~ /\n$/; 632 unless $msg =~ /\n$/;
502 urxvt::warn ($msg); 633 urxvt::warn ($msg);
503 }; 634 };
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} 635}
510 636
511my @hook_count;
512my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 637my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513 638
514sub verbose { 639sub verbose {
515 my ($level, $msg) = @_; 640 my ($level, $msg) = @_;
516 warn "$msg\n" if $level <= $verbosity; 641 warn "$msg\n" if $level <= $verbosity;
517} 642}
518 643
519my $extension_pkg = "extension0000";
520my %extension_pkg; 644my %extension_pkg;
521 645
522# load a single script into its own package, once only 646# load a single script into its own package, once only
523sub extension_package($) { 647sub extension_package($) {
524 my ($path) = @_; 648 my ($path) = @_;
525 649
650 no strict 'refs';
651
526 $extension_pkg{$path} ||= do { 652 $extension_pkg{$path} ||= do {
527 my $pkg = "urxvt::" . ($extension_pkg++); 653 $path =~ /([^\/\\]+)$/;
654 my $pkg = $1;
655 $pkg =~ s/[^[:word:]]/_/g;
656 $pkg = "urxvt::ext::$pkg";
528 657
529 verbose 3, "loading extension '$path' into package '$pkg'"; 658 verbose 3, "loading extension '$path' into package '$pkg'";
530 659
531 open my $fh, "<:raw", $path 660 open my $fh, "<:raw", $path
532 or die "$path: $!"; 661 or die "$path: $!";
533 662
663 @{"$pkg\::ISA"} = urxvt::term::extension::;
664
534 my $source = untaint 665 my $source =
535 "package $pkg; use strict; use utf8;\n" 666 "package $pkg; use strict; use utf8;\n"
536 . "use base urxvt::term::extension::;\n"
537 . "#line 1 \"$path\"\n{\n" 667 . "#line 1 \"$path\"\n{\n"
538 . (do { local $/; <$fh> }) 668 . (do { local $/; <$fh> })
539 . "\n};\n1"; 669 . "\n};\n1";
540 670
541 eval $source 671 eval $source
… …
598 if ($@) { 728 if ($@) {
599 $TERM->ungrab; # better to lose the grab than the session 729 $TERM->ungrab; # better to lose the grab than the session
600 warn $@; 730 warn $@;
601 } 731 }
602 } 732 }
733
734 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
735 if $verbosity >= 11;
603 } 736 }
604 737
605 if ($htype == 1) { # DESTROY 738 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 739 # clear package objects
614 %$_ = () for values %{ $TERM->{_pkg} }; 740 %$_ = () for values %{ $TERM->{_pkg} };
615 741
616 # clear package 742 # clear package
617 %$TERM = (); 743 %$TERM = ();
618 } 744 }
619 745
620 $retval 746 $retval
747}
748
749sub exec_async(@) {
750 my $pid = fork;
751
752 return
753 if !defined $pid or $pid;
754
755 %ENV = %{ $TERM->env };
756
757 exec @_;
758 _exit 255;
621} 759}
622 760
623# urxvt::term::extension 761# urxvt::term::extension
624 762
625package urxvt::term::extension; 763package urxvt::term::extension;
… …
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.
… …
800Here is a a likely non-exhaustive list of option names, please see the 953Here is a a likely non-exhaustive list of option names, please see the
801source file F</src/optinc.h> to see the actual list: 954source file F</src/optinc.h> to see the actual list:
802 955
803 borderLess console cursorBlink cursorUnderline hold iconic insecure 956 borderLess console cursorBlink cursorUnderline hold iconic insecure
804 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 957 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 958 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 959 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 960 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808 tripleclickwords utmpInhibit visualBell 961 transparent tripleclickwords utmpInhibit visualBell
809 962
810=item $value = $term->resource ($name[, $newval]) 963=item $value = $term->resource ($name[, $newval])
811 964
812Returns the current resource value associated with a given name and 965Returns the current resource value associated with a given name and
813optionally sets a new value. Setting values is most useful in the C<init> 966optionally sets a new value. Setting values is most useful in the C<init>
… …
830 983
831 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 984 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832 borderLess color cursorBlink cursorUnderline cutchars delete_key 985 borderLess color cursorBlink cursorUnderline cutchars delete_key
833 display_name embed ext_bwidth fade font geometry hold iconName 986 display_name embed ext_bwidth fade font geometry hold iconName
834 imFont imLocale inputMethod insecure int_bwidth intensityStyles 987 imFont imLocale inputMethod insecure int_bwidth intensityStyles
835 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 988 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 989 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 990 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 991 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 992 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 993 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841 shade term_name title transparent transparent_all tripleclickwords 994 secondaryScreen secondaryScroll selectstyle shade term_name title
842 utmpInhibit visualBell 995 transient_for transparent transparent_all tripleclickwords utmpInhibit
996 visualBell
843 997
844=cut 998=cut
845 999
846sub resource($$;$) { 1000sub resource($$;$) {
847 my ($self, $name) = (shift, shift); 1001 my ($self, $name) = (shift, shift);
848 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1002 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849 &urxvt::term::_resource 1003 &urxvt::term::_resource
850} 1004}
851 1005
1006=item $value = $term->x_resource ($pattern)
1007
1008Returns the X-Resource for the given pattern, excluding the program or
1009class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1010same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1011resource with that pattern exists.
1012
1013This method should only be called during the C<on_start> hook, as there is
1014only one resource database per display, and later invocations might return
1015the wrong resources.
1016
852=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1017=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853 1018
854Adds a keymap translation exactly as specified via a resource. See the 1019Adds a keymap translation exactly as specified via a resource. See the
855C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1020C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856 1021
… …
871=item ($row, $col) = $term->selection_end ([$row, $col]) 1036=item ($row, $col) = $term->selection_end ([$row, $col])
872 1037
873Return the current values of the selection mark, begin or end positions, 1038Return the current values of the selection mark, begin or end positions,
874and optionally set them to new values. 1039and optionally set them to new values.
875 1040
1041=item $term->selection_make ($eventtime[, $rectangular])
1042
1043Tries to make a selection as set by C<selection_beg> and
1044C<selection_end>. If C<$rectangular> is true (default: false), a
1045rectangular selection will be made. This is the prefered function to make
1046a selection.
1047
876=item $success = $term->selection_grab ($eventtime) 1048=item $success = $term->selection_grab ($eventtime)
877 1049
878Try to request the primary selection from the server (for example, as set 1050Try to request the primary selection text from the server (for example, as
879by the next method). 1051set by the next method). No visual feedback will be given. This function
1052is mostly useful from within C<on_sel_grab> hooks.
880 1053
881=item $oldtext = $term->selection ([$newtext]) 1054=item $oldtext = $term->selection ([$newtext])
882 1055
883Return the current selection text and optionally replace it by C<$newtext>. 1056Return the current selection text and optionally replace it by C<$newtext>.
884 1057
… …
977Convert the given locale-encoded octets into a perl string. 1150Convert the given locale-encoded octets into a perl string.
978 1151
979=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1152=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980 1153
981XORs the rendition values in the given span with the provided value 1154XORs the rendition values in the given span with the provided value
982(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1155(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983to the selection. 1156refresh hooks to provide effects similar to the selection.
984 1157
985=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1158=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986 1159
987Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1160Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988whitespace will additionally be xored with the C<$rstyle2>, which defaults 1161whitespace will additionally be xored with the C<$rstyle2>, which defaults
989to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1162to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
990it instead. 1163it instead. Both styles I<MUST NOT> contain font styles.
991 1164
992=item $term->scr_bell 1165=item $term->scr_bell
993 1166
994Ring the bell! 1167Ring the bell!
995 1168
… …
1029 1202
1030=item $windowid = $term->vt 1203=item $windowid = $term->vt
1031 1204
1032Return the window id of the terminal window. 1205Return the window id of the terminal window.
1033 1206
1207=item $term->vt_emask_add ($x_event_mask)
1208
1209Adds the specified events to the vt event mask. Useful e.g. when you want
1210to receive pointer events all the times:
1211
1212 $term->vt_emask_add (urxvt::PointerMotionMask);
1213
1034=item $window_width = $term->width 1214=item $window_width = $term->width
1035 1215
1036=item $window_height = $term->height 1216=item $window_height = $term->height
1037 1217
1038=item $font_width = $term->fwidth 1218=item $font_width = $term->fwidth
… …
1051 1231
1052=item $max_scrollback = $term->saveLines 1232=item $max_scrollback = $term->saveLines
1053 1233
1054=item $nrow_plus_saveLines = $term->total_rows 1234=item $nrow_plus_saveLines = $term->total_rows
1055 1235
1056=item $lines_in_scrollback = $term->nsaved 1236=item $topmost_scrollback_row = $term->top_row
1057 1237
1058Return various integers describing terminal characteristics. 1238Return various integers describing terminal characteristics.
1059 1239
1240=item $x_display = $term->display_id
1241
1242Return the DISPLAY used by rxvt-unicode.
1243
1060=item $lc_ctype = $term->locale 1244=item $lc_ctype = $term->locale
1061 1245
1062Returns the LC_CTYPE category string used by this rxvt-unicode. 1246Returns the LC_CTYPE category string used by this rxvt-unicode.
1063 1247
1064=item $x_display = $term->display_id 1248=item $env = $term->env
1065 1249
1066Return the DISPLAY used by rxvt-unicode. 1250Returns a copy of the environment in effect for the terminal as a hashref
1251similar to C<\%ENV>.
1252
1253=cut
1254
1255sub env {
1256 if (my $env = $_[0]->_env) {
1257 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1258 } else {
1259 +{ %ENV }
1260 }
1261}
1067 1262
1068=item $modifiermask = $term->ModLevel3Mask 1263=item $modifiermask = $term->ModLevel3Mask
1069 1264
1070=item $modifiermask = $term->ModMetaMask 1265=item $modifiermask = $term->ModMetaMask
1071 1266
… …
1074Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1269Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075AltGr), the meta key (often Alt) and the num lock key, if applicable. 1270AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076 1271
1077=item $view_start = $term->view_start ([$newvalue]) 1272=item $view_start = $term->view_start ([$newvalue])
1078 1273
1079Returns the negative row number of the topmost line. Minimum value is 1274Returns the row number of the topmost displayed line. Maximum value is
1080C<0>, which displays the normal terminal contents. Larger values scroll 1275C<0>, which displays the normal terminal contents. Lower values scroll
1081this many lines into the scrollback buffer. 1276this many lines into the scrollback buffer.
1082 1277
1083=item $term->want_refresh 1278=item $term->want_refresh
1084 1279
1085Requests a screen refresh. At the next opportunity, rxvt-unicode will 1280Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1164Return the row number of the first/last row of the line, respectively. 1359Return the row number of the first/last row of the line, respectively.
1165 1360
1166=item $offset = $line->offset_of ($row, $col) 1361=item $offset = $line->offset_of ($row, $col)
1167 1362
1168Returns the character offset of the given row|col pair within the logical 1363Returns the character offset of the given row|col pair within the logical
1169line. 1364line. Works for rows outside the line, too, and returns corresponding
1365offsets outside the string.
1170 1366
1171=item ($row, $col) = $line->coord_of ($offset) 1367=item ($row, $col) = $line->coord_of ($offset)
1172 1368
1173Translates a string offset into terminal coordinates again. 1369Translates a string offset into terminal coordinates again.
1174 1370
… …
1392sub show { 1588sub show {
1393 my ($self) = @_; 1589 my ($self) = @_;
1394 1590
1395 local $urxvt::popup::self = $self; 1591 local $urxvt::popup::self = $self;
1396 1592
1593 my $env = $self->{term}->env;
1594 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1595 delete $env->{LC_ALL};
1397 local $ENV{LC_ALL} = $self->{term}->locale; 1596 $env->{LC_CTYPE} = $self->{term}->locale;
1398 1597
1399 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1598 urxvt::term->new ($env, "popup",
1599 "--perl-lib" => "", "--perl-ext-common" => "",
1600 "-pty-fd" => -1, "-sl" => 0,
1601 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1400 "--transient-for" => $self->{term}->parent, 1602 "--transient-for" => $self->{term}->parent,
1401 "-display" => $self->{term}->display_id, 1603 "-display" => $self->{term}->display_id,
1402 "-pe" => "urxvt-popup") 1604 "-pe" => "urxvt-popup")
1403 or die "unable to create popup window\n"; 1605 or die "unable to create popup window\n";
1404} 1606}
1405 1607
1406sub DESTROY { 1608sub DESTROY {
1407 my ($self) = @_; 1609 my ($self) = @_;
1408 1610
1409 delete $self->{term}{_destroy}{$self}; 1611 delete $self->{term}{_destroy}{$self};
1410 $self->{term}->ungrab; 1612 $self->{term}->ungrab;
1411} 1613}
1614
1615=back
1412 1616
1413=head2 The C<urxvt::timer> Class 1617=head2 The C<urxvt::timer> Class
1414 1618
1415This class implements timer watchers/events. Time is represented as a 1619This class implements timer watchers/events. Time is represented as a
1416fractional number of seconds since the epoch. Example: 1620fractional number of seconds since the epoch. Example:
… …
1454Start the timer. 1658Start the timer.
1455 1659
1456=item $timer = $timer->start ($tstamp) 1660=item $timer = $timer->start ($tstamp)
1457 1661
1458Set the event trigger time to C<$tstamp> and start the timer. 1662Set the event trigger time to C<$tstamp> and start the timer.
1663
1664=item $timer = $timer->after ($delay)
1665
1666Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1459 1667
1460=item $timer = $timer->stop 1668=item $timer = $timer->stop
1461 1669
1462Stop the timer. 1670Stop the timer.
1463 1671
… …
1523 1731
1524=item == 0 - fatal messages 1732=item == 0 - fatal messages
1525 1733
1526=item >= 3 - script loading and management 1734=item >= 3 - script loading and management
1527 1735
1528=item >=10 - all events received 1736=item >=10 - all called hooks
1737
1738=item >=11 - hook reutrn values
1529 1739
1530=back 1740=back
1531 1741
1532=head1 AUTHOR 1742=head1 AUTHOR
1533 1743

Diff Legend

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