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.82 by root, Thu Jan 12 01:30:53 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 and 164Uses per-line display filtering (C<on_line_update>) to underline urls and
90make them clickable. When clicked, the program specified in the resource 165make them clickable. When middle-clicked, the program specified in the
91C<urlLauncher> (default C<x-www-browser>) will be started. 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
92 176
93=item block-graphics-to-ascii 177=item block-graphics-to-ascii
94 178
95A 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,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 181similar-looking ascii character.
98 182
183=item digital-clock
184
185Displays a digital clock using the built-in overlay.
186
99=item example-refresh-hooks 187=item example-refresh-hooks
100 188
101Displays 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
102window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
103overlays 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/%
104 221
105=back 222=back
106 223
107=head1 API DOCUMENTATION 224=head1 API DOCUMENTATION
108 225
… …
208=item on_start $term 325=item on_start $term
209 326
210Called 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
211returning to the mainloop. 328returning to the mainloop.
212 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
213=item on_sel_make $term, $eventtime 339=item on_sel_make $term, $eventtime
214 340
215Called 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
216selection 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
217selection will be honored. 343selection will be honored.
… …
230=item on_sel_extend $term 356=item on_sel_extend $term
231 357
232Called 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
233click) and is either supposed to return false (normal operation), or 359click) and is either supposed to return false (normal operation), or
234should 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
235processing. 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.
236 364
237See the F<selection> example extension. 365See the F<selection> example extension.
238 366
239=item on_view_change $term, $offset 367=item on_view_change $term, $offset
240 368
… …
307 435
308Called whenever the user presses a key combination that has a 436Called whenever the user presses a key combination that has a
309C<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>
310resource in the @@RXVT_NAME@@(1) manpage). 438resource in the @@RXVT_NAME@@(1) manpage).
311 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
312=item on_focus_in $term 446=item on_focus_in $term
313 447
314Called whenever the window gets the keyboard focus, before rxvt-unicode 448Called whenever the window gets the keyboard focus, before rxvt-unicode
315does focus in processing. 449does focus in processing.
316 450
317=item on_focus_out $term 451=item on_focus_out $term
318 452
319Called wheneever the window loses keyboard focus, before rxvt-unicode does 453Called wheneever the window loses keyboard focus, before rxvt-unicode does
320focus out processing. 454focus out processing.
455
456=item on_configure_notify $term, $event
321 457
322=item on_key_press $term, $event, $keysym, $octets 458=item on_key_press $term, $event, $keysym, $octets
323 459
324=item on_key_release $term, $event, $keysym 460=item on_key_release $term, $event, $keysym
325 461
… …
411Using this function has the advantage that its output ends up in the 547Using this function has the advantage that its output ends up in the
412correct place, e.g. on stderr of the connecting urxvtc client. 548correct place, e.g. on stderr of the connecting urxvtc client.
413 549
414Messages have a size limit of 1023 bytes currently. 550Messages have a size limit of 1023 bytes currently.
415 551
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 552=item $time = urxvt::NOW
423 553
424Returns the "current time" (as per the event loop). 554Returns the "current time" (as per the event loop).
425 555
426=item urxvt::CurrentTime 556=item urxvt::CurrentTime
427 557
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 558=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 559Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier 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
431 577
432Various constants for use in X calls and event processing. 578Various constants for use in X calls and event processing.
433 579
434=back 580=back
435 581
… …
486=back 632=back
487 633
488=cut 634=cut
489 635
490BEGIN { 636BEGIN {
491 urxvt->bootstrap;
492
493 # overwrite perl's warn 637 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub { 638 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_; 639 my $msg = join "", @_;
496 $msg .= "\n" 640 $msg .= "\n"
497 unless $msg =~ /\n$/; 641 unless $msg =~ /\n$/;
498 urxvt::warn ($msg); 642 urxvt::warn ($msg);
499 }; 643 };
500
501 # %ENV is the original startup environment
502 delete $ENV{IFS};
503 delete $ENV{CDPATH};
504 delete $ENV{BASH_ENV};
505 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506} 644}
507 645
508my @hook_count;
509my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 646my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510 647
511sub verbose { 648sub verbose {
512 my ($level, $msg) = @_; 649 my ($level, $msg) = @_;
513 warn "$msg\n" if $level <= $verbosity; 650 warn "$msg\n" if $level <= $verbosity;
514} 651}
515 652
516my $extension_pkg = "extension0000";
517my %extension_pkg; 653my %extension_pkg;
518 654
519# load a single script into its own package, once only 655# load a single script into its own package, once only
520sub extension_package($) { 656sub extension_package($) {
521 my ($path) = @_; 657 my ($path) = @_;
522 658
659 no strict 'refs';
660
523 $extension_pkg{$path} ||= do { 661 $extension_pkg{$path} ||= do {
524 my $pkg = "urxvt::" . ($extension_pkg++); 662 $path =~ /([^\/\\]+)$/;
663 my $pkg = $1;
664 $pkg =~ s/[^[:word:]]/_/g;
665 $pkg = "urxvt::ext::$pkg";
525 666
526 verbose 3, "loading extension '$path' into package '$pkg'"; 667 verbose 3, "loading extension '$path' into package '$pkg'";
527 668
528 open my $fh, "<:raw", $path 669 open my $fh, "<:raw", $path
529 or die "$path: $!"; 670 or die "$path: $!";
530 671
672 @{"$pkg\::ISA"} = urxvt::term::extension::;
673
531 my $source = untaint 674 my $source =
532 "package $pkg; use strict; use utf8;\n" 675 "package $pkg; use strict; use utf8;\n"
533 . "use base urxvt::term::extension::;\n"
534 . "#line 1 \"$path\"\n{\n" 676 . "#line 1 \"$path\"\n{\n"
535 . (do { local $/; <$fh> }) 677 . (do { local $/; <$fh> })
536 . "\n};\n1"; 678 . "\n};\n1";
537 679
538 eval $source 680 eval $source
… …
595 if ($@) { 737 if ($@) {
596 $TERM->ungrab; # better to lose the grab than the session 738 $TERM->ungrab; # better to lose the grab than the session
597 warn $@; 739 warn $@;
598 } 740 }
599 } 741 }
742
743 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
744 if $verbosity >= 11;
600 } 745 }
601 746
602 if ($htype == 1) { # DESTROY 747 if ($htype == 1) { # DESTROY
603 if (my $hook = delete $TERM->{_hook}) {
604 for my $htype (0..$#$hook) {
605 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
606 or set_should_invoke $htype, 0;
607 }
608 }
609
610 # clear package objects 748 # clear package objects
611 %$_ = () for values %{ $TERM->{_pkg} }; 749 %$_ = () for values %{ $TERM->{_pkg} };
612 750
613 # clear package 751 # clear package
614 %$TERM = (); 752 %$TERM = ();
… …
628 while (my ($name, $cb) = each %hook) { 766 while (my ($name, $cb) = each %hook) {
629 my $htype = $HOOKTYPE{uc $name}; 767 my $htype = $HOOKTYPE{uc $name};
630 defined $htype 768 defined $htype
631 or Carp::croak "unsupported hook type '$name'"; 769 or Carp::croak "unsupported hook type '$name'";
632 770
771 $self->set_should_invoke ($htype, +1)
633 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 772 unless exists $self->{term}{_hook}[$htype]{$pkg};
634 $hook_count[$htype]++
635 or urxvt::set_should_invoke $htype, 1;
636 }
637 773
638 $self->{term}{_hook}[$htype]{$pkg} = $cb; 774 $self->{term}{_hook}[$htype]{$pkg} = $cb;
639 } 775 }
640} 776}
641 777
… …
646 for my $name (@hook) { 782 for my $name (@hook) {
647 my $htype = $HOOKTYPE{uc $name}; 783 my $htype = $HOOKTYPE{uc $name};
648 defined $htype 784 defined $htype
649 or Carp::croak "unsupported hook type '$name'"; 785 or Carp::croak "unsupported hook type '$name'";
650 786
787 $self->set_should_invoke ($htype, -1)
651 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 788 if delete $self->{term}{_hook}[$htype]{$pkg};
652 --$hook_count[$htype]
653 or urxvt::set_should_invoke $htype, 0;
654 }
655 } 789 }
656} 790}
657 791
658our $AUTOLOAD; 792our $AUTOLOAD;
659 793
… …
805 939
806Destroy the terminal object (close the window, free resources 940Destroy the terminal object (close the window, free resources
807etc.). 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
808watchers (timers, io watchers) are still active. 942watchers (timers, io watchers) are still active.
809 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
810=item $isset = $term->option ($optval[, $set]) 969=item $isset = $term->option ($optval[, $set])
811 970
812Returns true if the option specified by C<$optval> is enabled, and 971Returns true if the option specified by C<$optval> is enabled, and
813optionally 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
814C<%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.
… …
816Here 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
817source file F</src/optinc.h> to see the actual list: 976source file F</src/optinc.h> to see the actual list:
818 977
819 borderLess console cursorBlink cursorUnderline hold iconic insecure 978 borderLess console cursorBlink cursorUnderline hold iconic insecure
820 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 979 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
821 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 980 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
822 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 981 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
823 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 982 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
824 tripleclickwords utmpInhibit visualBell 983 transparent tripleclickwords utmpInhibit visualBell
825 984
826=item $value = $term->resource ($name[, $newval]) 985=item $value = $term->resource ($name[, $newval])
827 986
828Returns the current resource value associated with a given name and 987Returns the current resource value associated with a given name and
829optionally 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>
… …
846 1005
847 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1006 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
848 borderLess color cursorBlink cursorUnderline cutchars delete_key 1007 borderLess color cursorBlink cursorUnderline cutchars delete_key
849 display_name embed ext_bwidth fade font geometry hold iconName 1008 display_name embed ext_bwidth fade font geometry hold iconName
850 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1009 imFont imLocale inputMethod insecure int_bwidth intensityStyles
851 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1010 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
852 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1011 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
853 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1012 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
854 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1013 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
855 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1014 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
856 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1015 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
857 shade term_name title transparent transparent_all tripleclickwords 1016 secondaryScreen secondaryScroll selectstyle shade term_name title
858 utmpInhibit visualBell 1017 transient_for transparent transparent_all tripleclickwords utmpInhibit
1018 visualBell
859 1019
860=cut 1020=cut
861 1021
862sub resource($$;$) { 1022sub resource($$;$) {
863 my ($self, $name) = (shift, shift); 1023 my ($self, $name) = (shift, shift);
… …
898=item ($row, $col) = $term->selection_end ([$row, $col]) 1058=item ($row, $col) = $term->selection_end ([$row, $col])
899 1059
900Return the current values of the selection mark, begin or end positions, 1060Return the current values of the selection mark, begin or end positions,
901and optionally set them to new values. 1061and optionally set them to new values.
902 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
903=item $success = $term->selection_grab ($eventtime) 1070=item $success = $term->selection_grab ($eventtime)
904 1071
905Try 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
906by 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.
907 1075
908=item $oldtext = $term->selection ([$newtext]) 1076=item $oldtext = $term->selection ([$newtext])
909 1077
910Return the current selection text and optionally replace it by C<$newtext>. 1078Return the current selection text and optionally replace it by C<$newtext>.
911 1079
… …
1004Convert the given locale-encoded octets into a perl string. 1172Convert the given locale-encoded octets into a perl string.
1005 1173
1006=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])
1007 1175
1008XORs the rendition values in the given span with the provided value 1176XORs the rendition values in the given span with the provided value
1009(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
1010to the selection. 1178refresh hooks to provide effects similar to the selection.
1011 1179
1012=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]])
1013 1181
1014Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1182Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015whitespace will additionally be xored with the C<$rstyle2>, which defaults 1183whitespace will additionally be xored with the C<$rstyle2>, which defaults
1016to 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
1017it instead. 1185it instead. Both styles I<MUST NOT> contain font styles.
1018 1186
1019=item $term->scr_bell 1187=item $term->scr_bell
1020 1188
1021Ring the bell! 1189Ring the bell!
1022 1190
… …
1056 1224
1057=item $windowid = $term->vt 1225=item $windowid = $term->vt
1058 1226
1059Return the window id of the terminal window. 1227Return the window id of the terminal window.
1060 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
1061=item $window_width = $term->width 1236=item $window_width = $term->width
1062 1237
1063=item $window_height = $term->height 1238=item $window_height = $term->height
1064 1239
1065=item $font_width = $term->fwidth 1240=item $font_width = $term->fwidth
… …
1078 1253
1079=item $max_scrollback = $term->saveLines 1254=item $max_scrollback = $term->saveLines
1080 1255
1081=item $nrow_plus_saveLines = $term->total_rows 1256=item $nrow_plus_saveLines = $term->total_rows
1082 1257
1083=item $lines_in_scrollback = $term->nsaved 1258=item $topmost_scrollback_row = $term->top_row
1084 1259
1085Return various integers describing terminal characteristics. 1260Return various integers describing terminal characteristics.
1086 1261
1087=item $x_display = $term->display_id 1262=item $x_display = $term->display_id
1088 1263
… …
1116Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1291Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1117AltGr), 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.
1118 1293
1119=item $view_start = $term->view_start ([$newvalue]) 1294=item $view_start = $term->view_start ([$newvalue])
1120 1295
1121Returns the negative row number of the topmost line. Minimum value is 1296Returns the row number of the topmost displayed line. Maximum value is
1122C<0>, which displays the normal terminal contents. Larger values scroll 1297C<0>, which displays the normal terminal contents. Lower values scroll
1123this many lines into the scrollback buffer. 1298this many lines into the scrollback buffer.
1124 1299
1125=item $term->want_refresh 1300=item $term->want_refresh
1126 1301
1127Requests a screen refresh. At the next opportunity, rxvt-unicode will 1302Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1206Return 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.
1207 1382
1208=item $offset = $line->offset_of ($row, $col) 1383=item $offset = $line->offset_of ($row, $col)
1209 1384
1210Returns 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
1211line. 1386line. Works for rows outside the line, too, and returns corresponding
1387offsets outside the string.
1212 1388
1213=item ($row, $col) = $line->coord_of ($offset) 1389=item ($row, $col) = $line->coord_of ($offset)
1214 1390
1215Translates a string offset into terminal coordinates again. 1391Translates a string offset into terminal coordinates again.
1216 1392
… …
1439 my $env = $self->{term}->env; 1615 my $env = $self->{term}->env;
1440 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1616 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1441 delete $env->{LC_ALL}; 1617 delete $env->{LC_ALL};
1442 $env->{LC_CTYPE} = $self->{term}->locale; 1618 $env->{LC_CTYPE} = $self->{term}->locale;
1443 1619
1444 urxvt::term->new ($env, $self->{term}->resource ("name"), 1620 urxvt::term->new ($env, "popup",
1445 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1621 "--perl-lib" => "", "--perl-ext-common" => "",
1622 "-pty-fd" => -1, "-sl" => 0,
1623 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1446 "--transient-for" => $self->{term}->parent, 1624 "--transient-for" => $self->{term}->parent,
1447 "-display" => $self->{term}->display_id, 1625 "-display" => $self->{term}->display_id,
1448 "-pe" => "urxvt-popup") 1626 "-pe" => "urxvt-popup")
1449 or die "unable to create popup window\n"; 1627 or die "unable to create popup window\n";
1450} 1628}
… …
1502Start the timer. 1680Start the timer.
1503 1681
1504=item $timer = $timer->start ($tstamp) 1682=item $timer = $timer->start ($tstamp)
1505 1683
1506Set 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>.
1507 1689
1508=item $timer = $timer->stop 1690=item $timer = $timer->stop
1509 1691
1510Stop the timer. 1692Stop the timer.
1511 1693
… …
1571 1753
1572=item == 0 - fatal messages 1754=item == 0 - fatal messages
1573 1755
1574=item >= 3 - script loading and management 1756=item >= 3 - script loading and management
1575 1757
1576=item >=10 - all events received 1758=item >=10 - all called hooks
1759
1760=item >=11 - hook reutrn values
1577 1761
1578=back 1762=back
1579 1763
1580=head1 AUTHOR 1764=head1 AUTHOR
1581 1765

Diff Legend

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