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.77 by root, Wed Jan 11 00:59:58 2006 UTC vs.
Revision 1.102 by root, Wed Jan 18 10:31:37 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.
90 168
91=item block-graphics-to-ascii 169=item block-graphics-to-ascii
92 170
93A not very useful example of filtering all text output to the terminal, 171A not very useful example of filtering all text output to the terminal,
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 172by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 173similar-looking ascii character.
96 174
175=item digital-clock
176
177Displays a digital clock using the built-in overlay.
178
97=item example-refresh-hooks 179=item example-refresh-hooks
98 180
99Displays a very simple digital clock in the upper right corner of the 181Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 182window. Illustrates overwriting the refresh callbacks to create your own
101overlays or changes. 183overlays or changes.
184
185=item selection-pastebin
186
187This is a little rarely useful extension that Uploads the selection as
188textfile to a remote site (or does other things). (The implementation is
189not currently secure for use in a multiuser environment as it writes to
190F</tmp> directly.).
191
192It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
193i.e.
194
195 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
196
197Pressing this combination runs a command with C<%> replaced by the name of
198the textfile. This command can be set via a resource:
199
200 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
201
202And the default is likely not useful to anybody but the few people around
203here :)
204
205The name of the textfile is the hex encoded md5 sum of the selection, so
206the same content should lead to the same filename.
207
208After a successful upload the selection will be replaced by the text given
209in the C<selection-pastebin-url> resource (again, the % is the placeholder
210for the filename):
211
212 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102 213
103=back 214=back
104 215
105=head1 API DOCUMENTATION 216=head1 API DOCUMENTATION
106 217
… …
123=over 4 234=over 4
124 235
125=item $text 236=item $text
126 237
127Rxvt-unicodes special way of encoding text, where one "unicode" character 238Rxvt-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. 239always represents one screen cell. See L<ROW_t> for a discussion of this format.
129 240
130=item $string 241=item $string
131 242
132A perl text string, with an emphasis on I<text>. It can store all unicode 243A 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 244characters and is to be distinguished with text encoded in a specific
… …
228=item on_sel_extend $term 339=item on_sel_extend $term
229 340
230Called whenever the user tries to extend the selection (e.g. with a double 341Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 342click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 343should extend the selection itelf and return true to suppress the built-in
233processing. 344processing. This can happen multiple times, as long as the callback
345returns true, it will be called on every further click by the user and is
346supposed to enlarge the selection more and more, if possible.
234 347
235See the F<selection> example extension. 348See the F<selection> example extension.
236 349
237=item on_view_change $term, $offset 350=item on_view_change $term, $offset
238 351
… …
305 418
306Called whenever the user presses a key combination that has a 419Called whenever the user presses a key combination that has a
307C<perl:string> action bound to it (see description of the B<keysym> 420C<perl:string> action bound to it (see description of the B<keysym>
308resource in the @@RXVT_NAME@@(1) manpage). 421resource in the @@RXVT_NAME@@(1) manpage).
309 422
423=item on_x_event $term, $event
424
425Called on every X event received on the vt window (and possibly other
426windows). Should only be used as a last resort. Most event structure
427members are not passed.
428
310=item on_focus_in $term 429=item on_focus_in $term
311 430
312Called whenever the window gets the keyboard focus, before rxvt-unicode 431Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 432does focus in processing.
314 433
315=item on_focus_out $term 434=item on_focus_out $term
316 435
317Called wheneever the window loses keyboard focus, before rxvt-unicode does 436Called wheneever the window loses keyboard focus, before rxvt-unicode does
318focus out processing. 437focus out processing.
438
439=item on_configure_notify $term, $event
319 440
320=item on_key_press $term, $event, $keysym, $octets 441=item on_key_press $term, $event, $keysym, $octets
321 442
322=item on_key_release $term, $event, $keysym 443=item on_key_release $term, $event, $keysym
323 444
… …
386=item $urxvt::TERM 507=item $urxvt::TERM
387 508
388The current terminal. This variable stores the current C<urxvt::term> 509The current terminal. This variable stores the current C<urxvt::term>
389object, whenever a callback/hook is executing. 510object, whenever a callback/hook is executing.
390 511
391=item
392
393=back 512=back
394 513
395=head2 Functions in the C<urxvt> Package 514=head2 Functions in the C<urxvt> Package
396 515
397=over 4 516=over 4
… …
411Using this function has the advantage that its output ends up in the 530Using this function has the advantage that its output ends up in the
412correct place, e.g. on stderr of the connecting urxvtc client. 531correct place, e.g. on stderr of the connecting urxvtc client.
413 532
414Messages have a size limit of 1023 bytes currently. 533Messages have a size limit of 1023 bytes currently.
415 534
416=item $is_safe = urxvt::safe
417
418Returns true when it is safe to do potentially unsafe things, such as
419evaluating perl code specified by the user. This is true when urxvt was
420started setuid or setgid.
421
422=item $time = urxvt::NOW 535=item $time = urxvt::NOW
423 536
424Returns the "current time" (as per the event loop). 537Returns the "current time" (as per the event loop).
425 538
426=item urxvt::CurrentTime 539=item urxvt::CurrentTime
427 540
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 541=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 542Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier 543Button4Mask, Button5Mask, AnyModifier
544
545=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
546ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
547PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
548Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
549KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
550ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
551FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
552
553=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
554EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
555GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
556UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
557ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
558CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
559SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431 560
432Various constants for use in X calls and event processing. 561Various constants for use in X calls and event processing.
433 562
434=back 563=back
435 564
… …
486=back 615=back
487 616
488=cut 617=cut
489 618
490BEGIN { 619BEGIN {
491 urxvt->bootstrap;
492
493 # overwrite perl's warn 620 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub { 621 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_; 622 my $msg = join "", @_;
496 $msg .= "\n" 623 $msg .= "\n"
497 unless $msg =~ /\n$/; 624 unless $msg =~ /\n$/;
498 urxvt::warn ($msg); 625 urxvt::warn ($msg);
499 }; 626 };
500 627
628 # %ENV is the original startup environment
501 delete $ENV{IFS}; 629 delete $ENV{IFS};
502 delete $ENV{CDPATH}; 630 delete $ENV{CDPATH};
503 delete $ENV{BASH_ENV}; 631 delete $ENV{BASH_ENV};
504 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 632 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
505} 633}
506 634
507my @hook_count;
508my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 635my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
509 636
510sub verbose { 637sub verbose {
511 my ($level, $msg) = @_; 638 my ($level, $msg) = @_;
512 warn "$msg\n" if $level <= $verbosity; 639 warn "$msg\n" if $level <= $verbosity;
513} 640}
514 641
515my $extension_pkg = "extension0000";
516my %extension_pkg; 642my %extension_pkg;
517 643
518# load a single script into its own package, once only 644# load a single script into its own package, once only
519sub extension_package($) { 645sub extension_package($) {
520 my ($path) = @_; 646 my ($path) = @_;
521 647
648 no strict 'refs';
649
522 $extension_pkg{$path} ||= do { 650 $extension_pkg{$path} ||= do {
523 my $pkg = "urxvt::" . ($extension_pkg++); 651 $path =~ /([^\/\\]+)$/;
652 my $pkg = $1;
653 $pkg =~ s/[^[:word:]]/_/g;
654 $pkg = "urxvt::ext::$pkg";
524 655
525 verbose 3, "loading extension '$path' into package '$pkg'"; 656 verbose 3, "loading extension '$path' into package '$pkg'";
526 657
527 open my $fh, "<:raw", $path 658 open my $fh, "<:raw", $path
528 or die "$path: $!"; 659 or die "$path: $!";
529 660
661 @{"$pkg\::ISA"} = urxvt::term::extension::;
662
530 my $source = untaint 663 my $source =
531 "package $pkg; use strict; use utf8;\n" 664 "package $pkg; use strict; use utf8;\n"
532 . "use base urxvt::term::extension::;\n"
533 . "#line 1 \"$path\"\n{\n" 665 . "#line 1 \"$path\"\n{\n"
534 . (do { local $/; <$fh> }) 666 . (do { local $/; <$fh> })
535 . "\n};\n1"; 667 . "\n};\n1";
536 668
537 eval $source 669 eval $source
… …
594 if ($@) { 726 if ($@) {
595 $TERM->ungrab; # better to lose the grab than the session 727 $TERM->ungrab; # better to lose the grab than the session
596 warn $@; 728 warn $@;
597 } 729 }
598 } 730 }
731
732 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
733 if $verbosity >= 11;
599 } 734 }
600 735
601 if ($htype == 1) { # DESTROY 736 if ($htype == 1) { # DESTROY
602 if (my $hook = delete $TERM->{_hook}) {
603 for my $htype (0..$#$hook) {
604 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
605 or set_should_invoke $htype, 0;
606 }
607 }
608
609 # clear package objects 737 # clear package objects
610 %$_ = () for values %{ $TERM->{_pkg} }; 738 %$_ = () for values %{ $TERM->{_pkg} };
611 739
612 # clear package 740 # clear package
613 %$TERM = (); 741 %$TERM = ();
614 } 742 }
615 743
616 $retval 744 $retval
745}
746
747sub exec_async(@) {
748 my $pid = fork;
749
750 return
751 if !defined $pid or $pid;
752
753 %ENV = %{ $TERM->env };
754
755 exec @_;
756 _exit 255;
617} 757}
618 758
619# urxvt::term::extension 759# urxvt::term::extension
620 760
621package urxvt::term::extension; 761package urxvt::term::extension;
… …
627 while (my ($name, $cb) = each %hook) { 767 while (my ($name, $cb) = each %hook) {
628 my $htype = $HOOKTYPE{uc $name}; 768 my $htype = $HOOKTYPE{uc $name};
629 defined $htype 769 defined $htype
630 or Carp::croak "unsupported hook type '$name'"; 770 or Carp::croak "unsupported hook type '$name'";
631 771
772 $self->set_should_invoke ($htype, +1)
632 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 773 unless exists $self->{term}{_hook}[$htype]{$pkg};
633 $hook_count[$htype]++
634 or urxvt::set_should_invoke $htype, 1;
635 }
636 774
637 $self->{term}{_hook}[$htype]{$pkg} = $cb; 775 $self->{term}{_hook}[$htype]{$pkg} = $cb;
638 } 776 }
639} 777}
640 778
… …
645 for my $name (@hook) { 783 for my $name (@hook) {
646 my $htype = $HOOKTYPE{uc $name}; 784 my $htype = $HOOKTYPE{uc $name};
647 defined $htype 785 defined $htype
648 or Carp::croak "unsupported hook type '$name'"; 786 or Carp::croak "unsupported hook type '$name'";
649 787
788 $self->set_should_invoke ($htype, -1)
650 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 789 if delete $self->{term}{_hook}[$htype]{$pkg};
651 --$hook_count[$htype]
652 or urxvt::set_should_invoke $htype, 0;
653 }
654 } 790 }
655} 791}
656 792
657our $AUTOLOAD; 793our $AUTOLOAD;
658 794
… …
782} 918}
783 919
784=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 920=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
785 921
786Creates a new terminal, very similar as if you had started it with system 922Creates a new terminal, very similar as if you had started it with system
787C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like 923C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
788C<hash which defines the environment of the new terminal. 924hash which defines the environment of the new terminal.
789 925
790Croaks (and probably outputs an error message) if the new instance 926Croaks (and probably outputs an error message) if the new instance
791couldn't be created. Returns C<undef> if the new instance didn't 927couldn't be created. Returns C<undef> if the new instance didn't
792initialise perl, and the terminal object otherwise. The C<init> and 928initialise perl, and the terminal object otherwise. The C<init> and
793C<start> hooks will be called during this call. 929C<start> hooks will be called during this call.
… …
862 my ($self, $name) = (shift, shift); 998 my ($self, $name) = (shift, shift);
863 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 999 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
864 &urxvt::term::_resource 1000 &urxvt::term::_resource
865} 1001}
866 1002
1003=item $value = $term->x_resource ($pattern)
1004
1005Returns the X-Resource for the given pattern, excluding the program or
1006class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1007same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1008resource with that pattern exists.
1009
1010This method should only be called during the C<on_start> hook, as there is
1011only one resource database per display, and later invocations might return
1012the wrong resources.
1013
867=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1014=item $success = $term->parse_keysym ($keysym_spec, $command_string)
868 1015
869Adds a keymap translation exactly as specified via a resource. See the 1016Adds a keymap translation exactly as specified via a resource. See the
870C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1017C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
871 1018
… …
886=item ($row, $col) = $term->selection_end ([$row, $col]) 1033=item ($row, $col) = $term->selection_end ([$row, $col])
887 1034
888Return the current values of the selection mark, begin or end positions, 1035Return the current values of the selection mark, begin or end positions,
889and optionally set them to new values. 1036and optionally set them to new values.
890 1037
1038=item $term->selection_make ($eventtime[, $rectangular])
1039
1040Tries to make a selection as set by C<selection_beg> and
1041C<selection_end>. If C<$rectangular> is true (default: false), a
1042rectangular selection will be made. This is the prefered function to make
1043a selection.
1044
891=item $success = $term->selection_grab ($eventtime) 1045=item $success = $term->selection_grab ($eventtime)
892 1046
893Try to request the primary selection from the server (for example, as set 1047Try to request the primary selection text from the server (for example, as
894by the next method). 1048set by the next method). No visual feedback will be given. This function
1049is mostly useful from within C<on_sel_grab> hooks.
895 1050
896=item $oldtext = $term->selection ([$newtext]) 1051=item $oldtext = $term->selection ([$newtext])
897 1052
898Return the current selection text and optionally replace it by C<$newtext>. 1053Return the current selection text and optionally replace it by C<$newtext>.
899 1054
… …
992Convert the given locale-encoded octets into a perl string. 1147Convert the given locale-encoded octets into a perl string.
993 1148
994=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1149=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
995 1150
996XORs the rendition values in the given span with the provided value 1151XORs the rendition values in the given span with the provided value
997(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1152(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
998to the selection. 1153refresh hooks to provide effects similar to the selection.
999 1154
1000=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1155=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1001 1156
1002Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1157Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1003whitespace will additionally be xored with the C<$rstyle2>, which defaults 1158whitespace will additionally be xored with the C<$rstyle2>, which defaults
1004to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1159to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1005it instead. 1160it instead. Both styles I<MUST NOT> contain font styles.
1006 1161
1007=item $term->scr_bell 1162=item $term->scr_bell
1008 1163
1009Ring the bell! 1164Ring the bell!
1010 1165
… …
1044 1199
1045=item $windowid = $term->vt 1200=item $windowid = $term->vt
1046 1201
1047Return the window id of the terminal window. 1202Return the window id of the terminal window.
1048 1203
1204=item $term->vt_emask_add ($x_event_mask)
1205
1206Adds the specified events to the vt event mask. Useful e.g. when you want
1207to receive pointer events all the times:
1208
1209 $term->vt_emask_add (urxvt::PointerMotionMask);
1210
1049=item $window_width = $term->width 1211=item $window_width = $term->width
1050 1212
1051=item $window_height = $term->height 1213=item $window_height = $term->height
1052 1214
1053=item $font_width = $term->fwidth 1215=item $font_width = $term->fwidth
… …
1066 1228
1067=item $max_scrollback = $term->saveLines 1229=item $max_scrollback = $term->saveLines
1068 1230
1069=item $nrow_plus_saveLines = $term->total_rows 1231=item $nrow_plus_saveLines = $term->total_rows
1070 1232
1071=item $lines_in_scrollback = $term->nsaved 1233=item $topmost_scrollback_row = $term->top_row
1072 1234
1073Return various integers describing terminal characteristics. 1235Return various integers describing terminal characteristics.
1074 1236
1075=item $x_display = $term->display_id 1237=item $x_display = $term->display_id
1076 1238
… …
1104Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1266Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1105AltGr), the meta key (often Alt) and the num lock key, if applicable. 1267AltGr), the meta key (often Alt) and the num lock key, if applicable.
1106 1268
1107=item $view_start = $term->view_start ([$newvalue]) 1269=item $view_start = $term->view_start ([$newvalue])
1108 1270
1109Returns the negative row number of the topmost line. Minimum value is 1271Returns the row number of the topmost displayed line. Maximum value is
1110C<0>, which displays the normal terminal contents. Larger values scroll 1272C<0>, which displays the normal terminal contents. Lower values scroll
1111this many lines into the scrollback buffer. 1273this many lines into the scrollback buffer.
1112 1274
1113=item $term->want_refresh 1275=item $term->want_refresh
1114 1276
1115Requests a screen refresh. At the next opportunity, rxvt-unicode will 1277Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1194Return the row number of the first/last row of the line, respectively. 1356Return the row number of the first/last row of the line, respectively.
1195 1357
1196=item $offset = $line->offset_of ($row, $col) 1358=item $offset = $line->offset_of ($row, $col)
1197 1359
1198Returns the character offset of the given row|col pair within the logical 1360Returns the character offset of the given row|col pair within the logical
1199line. 1361line. Works for rows outside the line, too, and returns corresponding
1362offsets outside the string.
1200 1363
1201=item ($row, $col) = $line->coord_of ($offset) 1364=item ($row, $col) = $line->coord_of ($offset)
1202 1365
1203Translates a string offset into terminal coordinates again. 1366Translates a string offset into terminal coordinates again.
1204 1367
… …
1441 my ($self) = @_; 1604 my ($self) = @_;
1442 1605
1443 delete $self->{term}{_destroy}{$self}; 1606 delete $self->{term}{_destroy}{$self};
1444 $self->{term}->ungrab; 1607 $self->{term}->ungrab;
1445} 1608}
1609
1610=back
1446 1611
1447=head2 The C<urxvt::timer> Class 1612=head2 The C<urxvt::timer> Class
1448 1613
1449This class implements timer watchers/events. Time is represented as a 1614This class implements timer watchers/events. Time is represented as a
1450fractional number of seconds since the epoch. Example: 1615fractional number of seconds since the epoch. Example:
… …
1557 1722
1558=item == 0 - fatal messages 1723=item == 0 - fatal messages
1559 1724
1560=item >= 3 - script loading and management 1725=item >= 3 - script loading and management
1561 1726
1562=item >=10 - all events received 1727=item >=10 - all called hooks
1728
1729=item >=11 - hook reutrn values
1563 1730
1564=back 1731=back
1565 1732
1566=head1 AUTHOR 1733=head1 AUTHOR
1567 1734

Diff Legend

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