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.106 by root, Wed Jan 18 19:44:22 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
… …
386=item $urxvt::TERM 515=item $urxvt::TERM
387 516
388The current terminal. This variable stores the current C<urxvt::term> 517The current terminal. This variable stores the current C<urxvt::term>
389object, whenever a callback/hook is executing. 518object, whenever a callback/hook is executing.
390 519
391=item
392
393=back 520=back
394 521
395=head2 Functions in the C<urxvt> Package 522=head2 Functions in the C<urxvt> Package
396 523
397=over 4 524=over 4
… …
411Using this function has the advantage that its output ends up in the 538Using this function has the advantage that its output ends up in the
412correct place, e.g. on stderr of the connecting urxvtc client. 539correct place, e.g. on stderr of the connecting urxvtc client.
413 540
414Messages have a size limit of 1023 bytes currently. 541Messages have a size limit of 1023 bytes currently.
415 542
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 543=item $time = urxvt::NOW
423 544
424Returns the "current time" (as per the event loop). 545Returns the "current time" (as per the event loop).
425 546
426=item urxvt::CurrentTime 547=item urxvt::CurrentTime
427 548
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 549=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 550Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier 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
431 568
432Various constants for use in X calls and event processing. 569Various constants for use in X calls and event processing.
433 570
434=back 571=back
435 572
… …
486=back 623=back
487 624
488=cut 625=cut
489 626
490BEGIN { 627BEGIN {
491 urxvt->bootstrap;
492
493 # overwrite perl's warn 628 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub { 629 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_; 630 my $msg = join "", @_;
496 $msg .= "\n" 631 $msg .= "\n"
497 unless $msg =~ /\n$/; 632 unless $msg =~ /\n$/;
498 urxvt::warn ($msg); 633 urxvt::warn ($msg);
499 }; 634 };
500 635
636 # %ENV is the original startup environment
501 delete $ENV{IFS}; 637 delete $ENV{IFS};
502 delete $ENV{CDPATH}; 638 delete $ENV{CDPATH};
503 delete $ENV{BASH_ENV}; 639 delete $ENV{BASH_ENV};
504 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 640 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
505} 641}
506 642
507my @hook_count;
508my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 643my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
509 644
510sub verbose { 645sub verbose {
511 my ($level, $msg) = @_; 646 my ($level, $msg) = @_;
512 warn "$msg\n" if $level <= $verbosity; 647 warn "$msg\n" if $level <= $verbosity;
513} 648}
514 649
515my $extension_pkg = "extension0000";
516my %extension_pkg; 650my %extension_pkg;
517 651
518# load a single script into its own package, once only 652# load a single script into its own package, once only
519sub extension_package($) { 653sub extension_package($) {
520 my ($path) = @_; 654 my ($path) = @_;
521 655
656 no strict 'refs';
657
522 $extension_pkg{$path} ||= do { 658 $extension_pkg{$path} ||= do {
523 my $pkg = "urxvt::" . ($extension_pkg++); 659 $path =~ /([^\/\\]+)$/;
660 my $pkg = $1;
661 $pkg =~ s/[^[:word:]]/_/g;
662 $pkg = "urxvt::ext::$pkg";
524 663
525 verbose 3, "loading extension '$path' into package '$pkg'"; 664 verbose 3, "loading extension '$path' into package '$pkg'";
526 665
527 open my $fh, "<:raw", $path 666 open my $fh, "<:raw", $path
528 or die "$path: $!"; 667 or die "$path: $!";
529 668
669 @{"$pkg\::ISA"} = urxvt::term::extension::;
670
530 my $source = untaint 671 my $source =
531 "package $pkg; use strict; use utf8;\n" 672 "package $pkg; use strict; use utf8;\n"
532 . "use base urxvt::term::extension::;\n"
533 . "#line 1 \"$path\"\n{\n" 673 . "#line 1 \"$path\"\n{\n"
534 . (do { local $/; <$fh> }) 674 . (do { local $/; <$fh> })
535 . "\n};\n1"; 675 . "\n};\n1";
536 676
537 eval $source 677 eval $source
… …
594 if ($@) { 734 if ($@) {
595 $TERM->ungrab; # better to lose the grab than the session 735 $TERM->ungrab; # better to lose the grab than the session
596 warn $@; 736 warn $@;
597 } 737 }
598 } 738 }
739
740 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
741 if $verbosity >= 11;
599 } 742 }
600 743
601 if ($htype == 1) { # DESTROY 744 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 745 # clear package objects
610 %$_ = () for values %{ $TERM->{_pkg} }; 746 %$_ = () for values %{ $TERM->{_pkg} };
611 747
612 # clear package 748 # clear package
613 %$TERM = (); 749 %$TERM = ();
614 } 750 }
615 751
616 $retval 752 $retval
753}
754
755sub exec_async(@) {
756 my $pid = fork;
757
758 return
759 if !defined $pid or $pid;
760
761 %ENV = %{ $TERM->env };
762
763 exec @_;
764 _exit 255;
617} 765}
618 766
619# urxvt::term::extension 767# urxvt::term::extension
620 768
621package urxvt::term::extension; 769package urxvt::term::extension;
… …
627 while (my ($name, $cb) = each %hook) { 775 while (my ($name, $cb) = each %hook) {
628 my $htype = $HOOKTYPE{uc $name}; 776 my $htype = $HOOKTYPE{uc $name};
629 defined $htype 777 defined $htype
630 or Carp::croak "unsupported hook type '$name'"; 778 or Carp::croak "unsupported hook type '$name'";
631 779
780 $self->set_should_invoke ($htype, +1)
632 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 781 unless exists $self->{term}{_hook}[$htype]{$pkg};
633 $hook_count[$htype]++
634 or urxvt::set_should_invoke $htype, 1;
635 }
636 782
637 $self->{term}{_hook}[$htype]{$pkg} = $cb; 783 $self->{term}{_hook}[$htype]{$pkg} = $cb;
638 } 784 }
639} 785}
640 786
… …
645 for my $name (@hook) { 791 for my $name (@hook) {
646 my $htype = $HOOKTYPE{uc $name}; 792 my $htype = $HOOKTYPE{uc $name};
647 defined $htype 793 defined $htype
648 or Carp::croak "unsupported hook type '$name'"; 794 or Carp::croak "unsupported hook type '$name'";
649 795
796 $self->set_should_invoke ($htype, -1)
650 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 797 if delete $self->{term}{_hook}[$htype]{$pkg};
651 --$hook_count[$htype]
652 or urxvt::set_should_invoke $htype, 0;
653 }
654 } 798 }
655} 799}
656 800
657our $AUTOLOAD; 801our $AUTOLOAD;
658 802
… …
782} 926}
783 927
784=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 928=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
785 929
786Creates a new terminal, very similar as if you had started it with system 930Creates 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 931C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
788C<hash which defines the environment of the new terminal. 932hash which defines the environment of the new terminal.
789 933
790Croaks (and probably outputs an error message) if the new instance 934Croaks (and probably outputs an error message) if the new instance
791couldn't be created. Returns C<undef> if the new instance didn't 935couldn't be created. Returns C<undef> if the new instance didn't
792initialise perl, and the terminal object otherwise. The C<init> and 936initialise perl, and the terminal object otherwise. The C<init> and
793C<start> hooks will be called during this call. 937C<start> hooks will be called during this call.
… …
815Here is a a likely non-exhaustive list of option names, please see the 959Here is a a likely non-exhaustive list of option names, please see the
816source file F</src/optinc.h> to see the actual list: 960source file F</src/optinc.h> to see the actual list:
817 961
818 borderLess console cursorBlink cursorUnderline hold iconic insecure 962 borderLess console cursorBlink cursorUnderline hold iconic insecure
819 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 963 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
820 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 964 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
821 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 965 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
822 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 966 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
823 tripleclickwords utmpInhibit visualBell 967 transparent tripleclickwords utmpInhibit visualBell
824 968
825=item $value = $term->resource ($name[, $newval]) 969=item $value = $term->resource ($name[, $newval])
826 970
827Returns the current resource value associated with a given name and 971Returns the current resource value associated with a given name and
828optionally sets a new value. Setting values is most useful in the C<init> 972optionally sets a new value. Setting values is most useful in the C<init>
… …
845 989
846 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 990 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
847 borderLess color cursorBlink cursorUnderline cutchars delete_key 991 borderLess color cursorBlink cursorUnderline cutchars delete_key
848 display_name embed ext_bwidth fade font geometry hold iconName 992 display_name embed ext_bwidth fade font geometry hold iconName
849 imFont imLocale inputMethod insecure int_bwidth intensityStyles 993 imFont imLocale inputMethod insecure int_bwidth intensityStyles
850 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 994 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
851 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 995 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
852 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 996 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
853 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 997 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
854 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 998 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
855 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 999 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
856 shade term_name title transparent transparent_all tripleclickwords 1000 secondaryScreen secondaryScroll selectstyle shade term_name title
857 utmpInhibit visualBell 1001 transient_for transparent transparent_all tripleclickwords utmpInhibit
1002 visualBell
858 1003
859=cut 1004=cut
860 1005
861sub resource($$;$) { 1006sub resource($$;$) {
862 my ($self, $name) = (shift, shift); 1007 my ($self, $name) = (shift, shift);
863 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1008 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
864 &urxvt::term::_resource 1009 &urxvt::term::_resource
865} 1010}
866 1011
1012=item $value = $term->x_resource ($pattern)
1013
1014Returns the X-Resource for the given pattern, excluding the program or
1015class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1016same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1017resource with that pattern exists.
1018
1019This method should only be called during the C<on_start> hook, as there is
1020only one resource database per display, and later invocations might return
1021the wrong resources.
1022
867=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1023=item $success = $term->parse_keysym ($keysym_spec, $command_string)
868 1024
869Adds a keymap translation exactly as specified via a resource. See the 1025Adds a keymap translation exactly as specified via a resource. See the
870C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1026C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
871 1027
… …
886=item ($row, $col) = $term->selection_end ([$row, $col]) 1042=item ($row, $col) = $term->selection_end ([$row, $col])
887 1043
888Return the current values of the selection mark, begin or end positions, 1044Return the current values of the selection mark, begin or end positions,
889and optionally set them to new values. 1045and optionally set them to new values.
890 1046
1047=item $term->selection_make ($eventtime[, $rectangular])
1048
1049Tries to make a selection as set by C<selection_beg> and
1050C<selection_end>. If C<$rectangular> is true (default: false), a
1051rectangular selection will be made. This is the prefered function to make
1052a selection.
1053
891=item $success = $term->selection_grab ($eventtime) 1054=item $success = $term->selection_grab ($eventtime)
892 1055
893Try to request the primary selection from the server (for example, as set 1056Try to request the primary selection text from the server (for example, as
894by the next method). 1057set by the next method). No visual feedback will be given. This function
1058is mostly useful from within C<on_sel_grab> hooks.
895 1059
896=item $oldtext = $term->selection ([$newtext]) 1060=item $oldtext = $term->selection ([$newtext])
897 1061
898Return the current selection text and optionally replace it by C<$newtext>. 1062Return the current selection text and optionally replace it by C<$newtext>.
899 1063
… …
992Convert the given locale-encoded octets into a perl string. 1156Convert the given locale-encoded octets into a perl string.
993 1157
994=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1158=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
995 1159
996XORs the rendition values in the given span with the provided value 1160XORs the rendition values in the given span with the provided value
997(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1161(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
998to the selection. 1162refresh hooks to provide effects similar to the selection.
999 1163
1000=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1164=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1001 1165
1002Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1166Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1003whitespace will additionally be xored with the C<$rstyle2>, which defaults 1167whitespace will additionally be xored with the C<$rstyle2>, which defaults
1004to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1168to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1005it instead. 1169it instead. Both styles I<MUST NOT> contain font styles.
1006 1170
1007=item $term->scr_bell 1171=item $term->scr_bell
1008 1172
1009Ring the bell! 1173Ring the bell!
1010 1174
… …
1044 1208
1045=item $windowid = $term->vt 1209=item $windowid = $term->vt
1046 1210
1047Return the window id of the terminal window. 1211Return the window id of the terminal window.
1048 1212
1213=item $term->vt_emask_add ($x_event_mask)
1214
1215Adds the specified events to the vt event mask. Useful e.g. when you want
1216to receive pointer events all the times:
1217
1218 $term->vt_emask_add (urxvt::PointerMotionMask);
1219
1049=item $window_width = $term->width 1220=item $window_width = $term->width
1050 1221
1051=item $window_height = $term->height 1222=item $window_height = $term->height
1052 1223
1053=item $font_width = $term->fwidth 1224=item $font_width = $term->fwidth
… …
1066 1237
1067=item $max_scrollback = $term->saveLines 1238=item $max_scrollback = $term->saveLines
1068 1239
1069=item $nrow_plus_saveLines = $term->total_rows 1240=item $nrow_plus_saveLines = $term->total_rows
1070 1241
1071=item $lines_in_scrollback = $term->nsaved 1242=item $topmost_scrollback_row = $term->top_row
1072 1243
1073Return various integers describing terminal characteristics. 1244Return various integers describing terminal characteristics.
1074 1245
1075=item $x_display = $term->display_id 1246=item $x_display = $term->display_id
1076 1247
… …
1104Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1275Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1105AltGr), the meta key (often Alt) and the num lock key, if applicable. 1276AltGr), the meta key (often Alt) and the num lock key, if applicable.
1106 1277
1107=item $view_start = $term->view_start ([$newvalue]) 1278=item $view_start = $term->view_start ([$newvalue])
1108 1279
1109Returns the negative row number of the topmost line. Minimum value is 1280Returns the row number of the topmost displayed line. Maximum value is
1110C<0>, which displays the normal terminal contents. Larger values scroll 1281C<0>, which displays the normal terminal contents. Lower values scroll
1111this many lines into the scrollback buffer. 1282this many lines into the scrollback buffer.
1112 1283
1113=item $term->want_refresh 1284=item $term->want_refresh
1114 1285
1115Requests a screen refresh. At the next opportunity, rxvt-unicode will 1286Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1194Return the row number of the first/last row of the line, respectively. 1365Return the row number of the first/last row of the line, respectively.
1195 1366
1196=item $offset = $line->offset_of ($row, $col) 1367=item $offset = $line->offset_of ($row, $col)
1197 1368
1198Returns the character offset of the given row|col pair within the logical 1369Returns the character offset of the given row|col pair within the logical
1199line. 1370line. Works for rows outside the line, too, and returns corresponding
1371offsets outside the string.
1200 1372
1201=item ($row, $col) = $line->coord_of ($offset) 1373=item ($row, $col) = $line->coord_of ($offset)
1202 1374
1203Translates a string offset into terminal coordinates again. 1375Translates a string offset into terminal coordinates again.
1204 1376
… …
1427 my $env = $self->{term}->env; 1599 my $env = $self->{term}->env;
1428 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1600 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1429 delete $env->{LC_ALL}; 1601 delete $env->{LC_ALL};
1430 $env->{LC_CTYPE} = $self->{term}->locale; 1602 $env->{LC_CTYPE} = $self->{term}->locale;
1431 1603
1432 urxvt::term->new ($env, $self->{term}->resource ("name"), 1604 urxvt::term->new ($env, "popup",
1433 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1605 "--perl-lib" => "", "--perl-ext-common" => "",
1606 "-pty-fd" => -1, "-sl" => 0,
1607 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1434 "--transient-for" => $self->{term}->parent, 1608 "--transient-for" => $self->{term}->parent,
1435 "-display" => $self->{term}->display_id, 1609 "-display" => $self->{term}->display_id,
1436 "-pe" => "urxvt-popup") 1610 "-pe" => "urxvt-popup")
1437 or die "unable to create popup window\n"; 1611 or die "unable to create popup window\n";
1438} 1612}
… …
1441 my ($self) = @_; 1615 my ($self) = @_;
1442 1616
1443 delete $self->{term}{_destroy}{$self}; 1617 delete $self->{term}{_destroy}{$self};
1444 $self->{term}->ungrab; 1618 $self->{term}->ungrab;
1445} 1619}
1620
1621=back
1446 1622
1447=head2 The C<urxvt::timer> Class 1623=head2 The C<urxvt::timer> Class
1448 1624
1449This class implements timer watchers/events. Time is represented as a 1625This class implements timer watchers/events. Time is represented as a
1450fractional number of seconds since the epoch. Example: 1626fractional number of seconds since the epoch. Example:
… …
1488Start the timer. 1664Start the timer.
1489 1665
1490=item $timer = $timer->start ($tstamp) 1666=item $timer = $timer->start ($tstamp)
1491 1667
1492Set the event trigger time to C<$tstamp> and start the timer. 1668Set the event trigger time to C<$tstamp> and start the timer.
1669
1670=item $timer = $timer->after ($delay)
1671
1672Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493 1673
1494=item $timer = $timer->stop 1674=item $timer = $timer->stop
1495 1675
1496Stop the timer. 1676Stop the timer.
1497 1677
… …
1557 1737
1558=item == 0 - fatal messages 1738=item == 0 - fatal messages
1559 1739
1560=item >= 3 - script loading and management 1740=item >= 3 - script loading and management
1561 1741
1562=item >=10 - all events received 1742=item >=10 - all called hooks
1743
1744=item >=11 - hook reutrn values
1563 1745
1564=back 1746=back
1565 1747
1566=head1 AUTHOR 1748=head1 AUTHOR
1567 1749

Diff Legend

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