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.111 by root, Thu Jan 19 19:52:54 2006 UTC

35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
44(More) intelligent selection. This extension tries to be more intelligent 48(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 49when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 50now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 51arguments, which is very convenient, too, if your F<ls> supports
52C<--quoting-style=shell>.
48 53
54A double-click usually selects the word under the cursor, further clicks
55will enlarge the selection.
56
57The selection works by trying to match a number of regexes and displaying
58them in increasing order of length. You can add your own regexes by
59specifying resources of the form:
60
61 URxvt.selection.pattern-0: perl-regex
62 URxvt.selection.pattern-1: perl-regex
63 ...
64
65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything
68between two vertical bars:
69
70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end.
74
49It also offers the following bindable keyboard command: 75This extension also offers following bindable keyboard commands:
50 76
51=over 4 77=over 4
52 78
53=item rot13 79=item rot13
54 80
67 93
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content. 96evalution, web-browser starting etc.), depending on content.
71 97
98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
101
102It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>.
107
108The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any
110C<a>s:
111
112 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g }
114 : ()
115 };
116
72=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
73 118
74Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 121input/output is suspended and a regex is displayed at the bottom of the
122screen.
77 123
78C</> starts an incremental regex search, C<n> searches further, C<p> or 124Inputting 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 125search. 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> 126search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 127bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary
130selection.
82 131
83=item digital-clock 132=item selection-autotransform
84 133
85Displays a digital clock using the built-in overlay. 134This selection allows you to do automatic transforms on a selection
135whenever a selection is made.
136
137It works by specifying perl snippets (most useful is a single C<s///>
138operator) that modify C<$_> as resources:
139
140 URxvt.selection-autotransform.0: transform
141 URxvt.selection-autotransform.1: transform
142 ...
143
144For example, the following will transform selections of the form
145C<filename:number>, often seen in compiler messages, into C<vi +$filename
146$word>:
147
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150And this example matches the same,but replaces it with vi-commands you can
151paste directly into your (vi :) editor:
152
153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155Of course, this can be modified to suit your needs and your editor :)
156
157To expand the example above to typical perl error messages ("XXX at
158FILENAME line YYY."), you need a slightly more elaborate solution:
159
160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file.
86 166
87=item mark-urls 167=item mark-urls
88 168
89Uses per-line display filtering (C<on_line_update>) to underline urls. 169Uses per-line display filtering (C<on_line_update>) to underline urls and
170make them clickable. When middle-clicked, the program specified in the
171resource C<urlLauncher> (default C<x-www-browser>) will be started with
172the URL as first argument.
173
174=item automove-background
175
176This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90 181
91=item block-graphics-to-ascii 182=item block-graphics-to-ascii
92 183
93A not very useful example of filtering all text output to the terminal, 184A not very useful example of filtering all text output to the terminal,
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 186similar-looking ascii character.
96 187
188=item digital-clock
189
190Displays a digital clock using the built-in overlay.
191
97=item example-refresh-hooks 192=item example-refresh-hooks
98 193
99Displays a very simple digital clock in the upper right corner of the 194Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 195window. Illustrates overwriting the refresh callbacks to create your own
101overlays or changes. 196overlays or changes.
197
198=item selection-pastebin
199
200This is a little rarely useful extension that Uploads the selection as
201textfile to a remote site (or does other things). (The implementation is
202not currently secure for use in a multiuser environment as it writes to
203F</tmp> directly.).
204
205It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206i.e.
207
208 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210Pressing this combination runs a command with C<%> replaced by the name of
211the textfile. This command can be set via a resource:
212
213 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215And the default is likely not useful to anybody but the few people around
216here :)
217
218The name of the textfile is the hex encoded md5 sum of the selection, so
219the same content should lead to the same filename.
220
221After a successful upload the selection will be replaced by the text given
222in the C<selection-pastebin-url> resource (again, the % is the placeholder
223for the filename):
224
225 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102 226
103=back 227=back
104 228
105=head1 API DOCUMENTATION 229=head1 API DOCUMENTATION
106 230
123=over 4 247=over 4
124 248
125=item $text 249=item $text
126 250
127Rxvt-unicodes special way of encoding text, where one "unicode" character 251Rxvt-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. 252always represents one screen cell. See L<ROW_t> for a discussion of this format.
129 253
130=item $string 254=item $string
131 255
132A perl text string, with an emphasis on I<text>. It can store all unicode 256A 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 257characters and is to be distinguished with text encoded in a specific
206=item on_start $term 330=item on_start $term
207 331
208Called at the very end of initialisation of a new terminal, just before 332Called at the very end of initialisation of a new terminal, just before
209returning to the mainloop. 333returning to the mainloop.
210 334
335=item on_child_start $term, $pid
336
337Called just after the child process has been C<fork>ed.
338
339=item on_child_exit $term, $status
340
341Called just after the child process has exited. C<$status> is the status
342from C<waitpid>.
343
211=item on_sel_make $term, $eventtime 344=item on_sel_make $term, $eventtime
212 345
213Called whenever a selection has been made by the user, but before the 346Called whenever a selection has been made by the user, but before the
214selection text is copied, so changes to the beginning, end or type of the 347selection text is copied, so changes to the beginning, end or type of the
215selection will be honored. 348selection will be honored.
228=item on_sel_extend $term 361=item on_sel_extend $term
229 362
230Called whenever the user tries to extend the selection (e.g. with a double 363Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 364click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 365should extend the selection itelf and return true to suppress the built-in
233processing. 366processing. This can happen multiple times, as long as the callback
367returns true, it will be called on every further click by the user and is
368supposed to enlarge the selection more and more, if possible.
234 369
235See the F<selection> example extension. 370See the F<selection> example extension.
236 371
237=item on_view_change $term, $offset 372=item on_view_change $term, $offset
238 373
305 440
306Called whenever the user presses a key combination that has a 441Called whenever the user presses a key combination that has a
307C<perl:string> action bound to it (see description of the B<keysym> 442C<perl:string> action bound to it (see description of the B<keysym>
308resource in the @@RXVT_NAME@@(1) manpage). 443resource in the @@RXVT_NAME@@(1) manpage).
309 444
445=item on_x_event $term, $event
446
447Called on every X event received on the vt window (and possibly other
448windows). Should only be used as a last resort. Most event structure
449members are not passed.
450
310=item on_focus_in $term 451=item on_focus_in $term
311 452
312Called whenever the window gets the keyboard focus, before rxvt-unicode 453Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 454does focus in processing.
314 455
315=item on_focus_out $term 456=item on_focus_out $term
316 457
317Called wheneever the window loses keyboard focus, before rxvt-unicode does 458Called wheneever the window loses keyboard focus, before rxvt-unicode does
318focus out processing. 459focus out processing.
460
461=item on_configure_notify $term, $event
319 462
320=item on_key_press $term, $event, $keysym, $octets 463=item on_key_press $term, $event, $keysym, $octets
321 464
322=item on_key_release $term, $event, $keysym 465=item on_key_release $term, $event, $keysym
323 466
386=item $urxvt::TERM 529=item $urxvt::TERM
387 530
388The current terminal. This variable stores the current C<urxvt::term> 531The current terminal. This variable stores the current C<urxvt::term>
389object, whenever a callback/hook is executing. 532object, whenever a callback/hook is executing.
390 533
391=item
392
393=back 534=back
394 535
395=head2 Functions in the C<urxvt> Package 536=head2 Functions in the C<urxvt> Package
396 537
397=over 4 538=over 4
411Using this function has the advantage that its output ends up in the 552Using this function has the advantage that its output ends up in the
412correct place, e.g. on stderr of the connecting urxvtc client. 553correct place, e.g. on stderr of the connecting urxvtc client.
413 554
414Messages have a size limit of 1023 bytes currently. 555Messages have a size limit of 1023 bytes currently.
415 556
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 557=item $time = urxvt::NOW
423 558
424Returns the "current time" (as per the event loop). 559Returns the "current time" (as per the event loop).
425 560
426=item urxvt::CurrentTime 561=item urxvt::CurrentTime
427 562
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 563=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 564Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier 565Button4Mask, Button5Mask, AnyModifier
566
567=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
568ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
569PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
570Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
571KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
572ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
573FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
574
575=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
576EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
577GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
578UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
579ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
580CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
581SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431 582
432Various constants for use in X calls and event processing. 583Various constants for use in X calls and event processing.
433 584
434=back 585=back
435 586
486=back 637=back
487 638
488=cut 639=cut
489 640
490BEGIN { 641BEGIN {
491 urxvt->bootstrap;
492
493 # overwrite perl's warn 642 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub { 643 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_; 644 my $msg = join "", @_;
496 $msg .= "\n" 645 $msg .= "\n"
497 unless $msg =~ /\n$/; 646 unless $msg =~ /\n$/;
498 urxvt::warn ($msg); 647 urxvt::warn ($msg);
499 }; 648 };
500
501 delete $ENV{IFS};
502 delete $ENV{CDPATH};
503 delete $ENV{BASH_ENV};
504 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
505} 649}
506 650
507my @hook_count;
508my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 651my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
509 652
510sub verbose { 653sub verbose {
511 my ($level, $msg) = @_; 654 my ($level, $msg) = @_;
512 warn "$msg\n" if $level <= $verbosity; 655 warn "$msg\n" if $level <= $verbosity;
513} 656}
514 657
515my $extension_pkg = "extension0000";
516my %extension_pkg; 658my %extension_pkg;
517 659
518# load a single script into its own package, once only 660# load a single script into its own package, once only
519sub extension_package($) { 661sub extension_package($) {
520 my ($path) = @_; 662 my ($path) = @_;
521 663
664 no strict 'refs';
665
522 $extension_pkg{$path} ||= do { 666 $extension_pkg{$path} ||= do {
523 my $pkg = "urxvt::" . ($extension_pkg++); 667 $path =~ /([^\/\\]+)$/;
668 my $pkg = $1;
669 $pkg =~ s/[^[:word:]]/_/g;
670 $pkg = "urxvt::ext::$pkg";
524 671
525 verbose 3, "loading extension '$path' into package '$pkg'"; 672 verbose 3, "loading extension '$path' into package '$pkg'";
526 673
527 open my $fh, "<:raw", $path 674 open my $fh, "<:raw", $path
528 or die "$path: $!"; 675 or die "$path: $!";
529 676
677 @{"$pkg\::ISA"} = urxvt::term::extension::;
678
530 my $source = untaint 679 my $source =
531 "package $pkg; use strict; use utf8;\n" 680 "package $pkg; use strict; use utf8;\n"
532 . "use base urxvt::term::extension::;\n"
533 . "#line 1 \"$path\"\n{\n" 681 . "#line 1 \"$path\"\n{\n"
534 . (do { local $/; <$fh> }) 682 . (do { local $/; <$fh> })
535 . "\n};\n1"; 683 . "\n};\n1";
536 684
537 eval $source 685 eval $source
594 if ($@) { 742 if ($@) {
595 $TERM->ungrab; # better to lose the grab than the session 743 $TERM->ungrab; # better to lose the grab than the session
596 warn $@; 744 warn $@;
597 } 745 }
598 } 746 }
747
748 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
749 if $verbosity >= 11;
599 } 750 }
600 751
601 if ($htype == 1) { # DESTROY 752 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 753 # clear package objects
610 %$_ = () for values %{ $TERM->{_pkg} }; 754 %$_ = () for values %{ $TERM->{_pkg} };
611 755
612 # clear package 756 # clear package
613 %$TERM = (); 757 %$TERM = ();
627 while (my ($name, $cb) = each %hook) { 771 while (my ($name, $cb) = each %hook) {
628 my $htype = $HOOKTYPE{uc $name}; 772 my $htype = $HOOKTYPE{uc $name};
629 defined $htype 773 defined $htype
630 or Carp::croak "unsupported hook type '$name'"; 774 or Carp::croak "unsupported hook type '$name'";
631 775
776 $self->set_should_invoke ($htype, +1)
632 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 777 unless exists $self->{term}{_hook}[$htype]{$pkg};
633 $hook_count[$htype]++
634 or urxvt::set_should_invoke $htype, 1;
635 }
636 778
637 $self->{term}{_hook}[$htype]{$pkg} = $cb; 779 $self->{term}{_hook}[$htype]{$pkg} = $cb;
638 } 780 }
639} 781}
640 782
645 for my $name (@hook) { 787 for my $name (@hook) {
646 my $htype = $HOOKTYPE{uc $name}; 788 my $htype = $HOOKTYPE{uc $name};
647 defined $htype 789 defined $htype
648 or Carp::croak "unsupported hook type '$name'"; 790 or Carp::croak "unsupported hook type '$name'";
649 791
792 $self->set_should_invoke ($htype, -1)
650 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 793 if delete $self->{term}{_hook}[$htype]{$pkg};
651 --$hook_count[$htype]
652 or urxvt::set_should_invoke $htype, 0;
653 }
654 } 794 }
655} 795}
656 796
657our $AUTOLOAD; 797our $AUTOLOAD;
658 798
782} 922}
783 923
784=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 924=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
785 925
786Creates a new terminal, very similar as if you had started it with system 926Creates 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 927C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
788C<hash which defines the environment of the new terminal. 928hash which defines the environment of the new terminal.
789 929
790Croaks (and probably outputs an error message) if the new instance 930Croaks (and probably outputs an error message) if the new instance
791couldn't be created. Returns C<undef> if the new instance didn't 931couldn't be created. Returns C<undef> if the new instance didn't
792initialise perl, and the terminal object otherwise. The C<init> and 932initialise perl, and the terminal object otherwise. The C<init> and
793C<start> hooks will be called during this call. 933C<start> hooks will be called during this call.
804 944
805Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
806etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 946etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
807watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
808 948
949=item $term->exec_async ($cmd[, @args])
950
951Works like the combination of the C<fork>/C<exec> builtins, which executes
952("starts") programs in the background. This function takes care of setting
953the user environment before exec'ing the command (e.g. C<PATH>) and should
954be preferred over explicit calls to C<exec> or C<system>.
955
956Returns the pid of the subprocess or C<undef> on error.
957
958=cut
959
960sub exec_async {
961 my $self = shift;
962
963 my $pid = fork;
964
965 return $pid
966 if !defined $pid or $pid;
967
968 %ENV = %{ $self->env };
969
970 exec @_;
971 urxvt::_exit 255;
972}
973
809=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
810 975
811Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
812optionally change it. All option values are stored by name in the hash 977optionally change it. All option values are stored by name in the hash
813C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 978C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
815Here is a a likely non-exhaustive list of option names, please see the 980Here is a a likely non-exhaustive list of option names, please see the
816source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
817 982
818 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
819 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
820 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
821 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
822 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
823 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
824 989
825=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
826 991
827Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
828optionally sets a new value. Setting values is most useful in the C<init> 993optionally sets a new value. Setting values is most useful in the C<init>
845 1010
846 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
847 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
848 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
849 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
850 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
851 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
852 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
853 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
854 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
855 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
856 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
857 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
858 1024
859=cut 1025=cut
860 1026
861sub resource($$;$) { 1027sub resource($$;$) {
862 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
863 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1029 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
864 &urxvt::term::_resource 1030 &urxvt::term::_resource
865} 1031}
866 1032
1033=item $value = $term->x_resource ($pattern)
1034
1035Returns the X-Resource for the given pattern, excluding the program or
1036class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1037same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1038resource with that pattern exists.
1039
1040This method should only be called during the C<on_start> hook, as there is
1041only one resource database per display, and later invocations might return
1042the wrong resources.
1043
867=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1044=item $success = $term->parse_keysym ($keysym_spec, $command_string)
868 1045
869Adds a keymap translation exactly as specified via a resource. See the 1046Adds a keymap translation exactly as specified via a resource. See the
870C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1047C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
871 1048
886=item ($row, $col) = $term->selection_end ([$row, $col]) 1063=item ($row, $col) = $term->selection_end ([$row, $col])
887 1064
888Return the current values of the selection mark, begin or end positions, 1065Return the current values of the selection mark, begin or end positions,
889and optionally set them to new values. 1066and optionally set them to new values.
890 1067
1068=item $term->selection_make ($eventtime[, $rectangular])
1069
1070Tries to make a selection as set by C<selection_beg> and
1071C<selection_end>. If C<$rectangular> is true (default: false), a
1072rectangular selection will be made. This is the prefered function to make
1073a selection.
1074
891=item $success = $term->selection_grab ($eventtime) 1075=item $success = $term->selection_grab ($eventtime)
892 1076
893Try to request the primary selection from the server (for example, as set 1077Try to request the primary selection text from the server (for example, as
894by the next method). 1078set by the next method). No visual feedback will be given. This function
1079is mostly useful from within C<on_sel_grab> hooks.
895 1080
896=item $oldtext = $term->selection ([$newtext]) 1081=item $oldtext = $term->selection ([$newtext])
897 1082
898Return the current selection text and optionally replace it by C<$newtext>. 1083Return the current selection text and optionally replace it by C<$newtext>.
899 1084
992Convert the given locale-encoded octets into a perl string. 1177Convert the given locale-encoded octets into a perl string.
993 1178
994=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1179=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
995 1180
996XORs the rendition values in the given span with the provided value 1181XORs the rendition values in the given span with the provided value
997(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1182(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
998to the selection. 1183refresh hooks to provide effects similar to the selection.
999 1184
1000=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1185=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1001 1186
1002Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1187Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1003whitespace will additionally be xored with the C<$rstyle2>, which defaults 1188whitespace will additionally be xored with the C<$rstyle2>, which defaults
1004to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1189to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1005it instead. 1190it instead. Both styles I<MUST NOT> contain font styles.
1006 1191
1007=item $term->scr_bell 1192=item $term->scr_bell
1008 1193
1009Ring the bell! 1194Ring the bell!
1010 1195
1044 1229
1045=item $windowid = $term->vt 1230=item $windowid = $term->vt
1046 1231
1047Return the window id of the terminal window. 1232Return the window id of the terminal window.
1048 1233
1234=item $term->vt_emask_add ($x_event_mask)
1235
1236Adds the specified events to the vt event mask. Useful e.g. when you want
1237to receive pointer events all the times:
1238
1239 $term->vt_emask_add (urxvt::PointerMotionMask);
1240
1049=item $window_width = $term->width 1241=item $window_width = $term->width
1050 1242
1051=item $window_height = $term->height 1243=item $window_height = $term->height
1052 1244
1053=item $font_width = $term->fwidth 1245=item $font_width = $term->fwidth
1066 1258
1067=item $max_scrollback = $term->saveLines 1259=item $max_scrollback = $term->saveLines
1068 1260
1069=item $nrow_plus_saveLines = $term->total_rows 1261=item $nrow_plus_saveLines = $term->total_rows
1070 1262
1071=item $lines_in_scrollback = $term->nsaved 1263=item $topmost_scrollback_row = $term->top_row
1072 1264
1073Return various integers describing terminal characteristics. 1265Return various integers describing terminal characteristics.
1074 1266
1075=item $x_display = $term->display_id 1267=item $x_display = $term->display_id
1076 1268
1104Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1296Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1105AltGr), the meta key (often Alt) and the num lock key, if applicable. 1297AltGr), the meta key (often Alt) and the num lock key, if applicable.
1106 1298
1107=item $view_start = $term->view_start ([$newvalue]) 1299=item $view_start = $term->view_start ([$newvalue])
1108 1300
1109Returns the negative row number of the topmost line. Minimum value is 1301Returns the row number of the topmost displayed line. Maximum value is
1110C<0>, which displays the normal terminal contents. Larger values scroll 1302C<0>, which displays the normal terminal contents. Lower values scroll
1111this many lines into the scrollback buffer. 1303this many lines into the scrollback buffer.
1112 1304
1113=item $term->want_refresh 1305=item $term->want_refresh
1114 1306
1115Requests a screen refresh. At the next opportunity, rxvt-unicode will 1307Requests a screen refresh. At the next opportunity, rxvt-unicode will
1194Return the row number of the first/last row of the line, respectively. 1386Return the row number of the first/last row of the line, respectively.
1195 1387
1196=item $offset = $line->offset_of ($row, $col) 1388=item $offset = $line->offset_of ($row, $col)
1197 1389
1198Returns the character offset of the given row|col pair within the logical 1390Returns the character offset of the given row|col pair within the logical
1199line. 1391line. Works for rows outside the line, too, and returns corresponding
1392offsets outside the string.
1200 1393
1201=item ($row, $col) = $line->coord_of ($offset) 1394=item ($row, $col) = $line->coord_of ($offset)
1202 1395
1203Translates a string offset into terminal coordinates again. 1396Translates a string offset into terminal coordinates again.
1204 1397
1427 my $env = $self->{term}->env; 1620 my $env = $self->{term}->env;
1428 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1621 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1429 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1430 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1431 1624
1432 urxvt::term->new ($env, $self->{term}->resource ("name"), 1625 urxvt::term->new ($env, "popup",
1433 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1626 "--perl-lib" => "", "--perl-ext-common" => "",
1627 "-pty-fd" => -1, "-sl" => 0,
1628 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1434 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1435 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1436 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1437 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1438} 1633}
1441 my ($self) = @_; 1636 my ($self) = @_;
1442 1637
1443 delete $self->{term}{_destroy}{$self}; 1638 delete $self->{term}{_destroy}{$self};
1444 $self->{term}->ungrab; 1639 $self->{term}->ungrab;
1445} 1640}
1641
1642=back
1446 1643
1447=head2 The C<urxvt::timer> Class 1644=head2 The C<urxvt::timer> Class
1448 1645
1449This class implements timer watchers/events. Time is represented as a 1646This class implements timer watchers/events. Time is represented as a
1450fractional number of seconds since the epoch. Example: 1647fractional number of seconds since the epoch. Example:
1488Start the timer. 1685Start the timer.
1489 1686
1490=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1491 1688
1492Set the event trigger time to C<$tstamp> and start the timer. 1689Set the event trigger time to C<$tstamp> and start the timer.
1690
1691=item $timer = $timer->after ($delay)
1692
1693Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493 1694
1494=item $timer = $timer->stop 1695=item $timer = $timer->stop
1495 1696
1496Stop the timer. 1697Stop the timer.
1497 1698
1557 1758
1558=item == 0 - fatal messages 1759=item == 0 - fatal messages
1559 1760
1560=item >= 3 - script loading and management 1761=item >= 3 - script loading and management
1561 1762
1562=item >=10 - all events received 1763=item >=10 - all called hooks
1764
1765=item >=11 - hook reutrn values
1563 1766
1564=back 1767=back
1565 1768
1566=head1 AUTHOR 1769=head1 AUTHOR
1567 1770

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines