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.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC

34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
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
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
67 71
68You can look at the source of the selection extension to see more 72You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 73interesting uses, such as parsing a line from beginning to end.
70 74
71This extension also offers the following bindable keyboard command: 75This extension also offers following bindable keyboard commands:
72 76
73=over 4 77=over 4
74 78
75=item rot13 79=item rot13
76 80
88=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
89 93
90Binds 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
91text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 96evalution, web-browser starting etc.), depending on content.
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 };
93 116
94=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
95 118
96Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
117 URxvt.selection-autotransform.0: transform 140 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform 141 URxvt.selection-autotransform.1: transform
119 ... 142 ...
120 143
121For example, the following will transform selections of the form 144For example, the following will transform selections of the form
122C<word:number> into C<vi +$number $word>: 145C<filename:number>, often seen in compiler messages, into C<vi +$filename
146$word>:
123 147
124 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/ 148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125 149
126And this example matches the same,but replaces it with vi-commands you can 150And this example matches the same,but replaces it with vi-commands you can
127paste directory into your (vi :) editor: 151paste directly into your (vi :) editor:
128 152
129 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/ 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.
130 166
131=item mark-urls 167=item mark-urls
132 168
133Uses per-line display filtering (C<on_line_update>) to underline urls and 169Uses per-line display filtering (C<on_line_update>) to underline urls and
134make them clickable. When middle-clicked, the program specified in the 170make them clickable. When middle-clicked, the program specified in the
135resource C<urlLauncher> (default C<x-www-browser>) will be started with 171resource C<urlLauncher> (default C<x-www-browser>) will be started with
136the URL as first argument. 172the URL as first argument.
137 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
181
138=item block-graphics-to-ascii 182=item block-graphics-to-ascii
139 183
140A 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,
141by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
142similar-looking ascii character. 186similar-looking ascii character.
148=item example-refresh-hooks 192=item example-refresh-hooks
149 193
150Displays 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
151window. Illustrates overwriting the refresh callbacks to create your own 195window. Illustrates overwriting the refresh callbacks to create your own
152overlays 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/%
153 226
154=back 227=back
155 228
156=head1 API DOCUMENTATION 229=head1 API DOCUMENTATION
157 230
230called whenever the relevant event happens. 303called whenever the relevant event happens.
231 304
232The first argument passed to them is an extension oject as described in 305The first argument passed to them is an extension oject as described in
233the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
234 307
235B<All> of these hooks must return a boolean value. If it is true, then the 308B<All> of these hooks must return a boolean value. If any of the called
236event counts as being I<consumed>, and the invocation of other hooks is 309hooks returns true, then the event counts as being I<consumed>, and the
237skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
238 311
239I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
240 313
241=over 4 314=over 4
242 315
243=item on_init $term 316=item on_init $term
244 317
245Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
246windows are created or the command gets run. Most methods are unsafe to 319windows are created or the command gets run. Most methods are unsafe to
247call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
248have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
249though. 322and options, though. For many purposes the C<on_start> hook is a better
323place.
324
325=item on_start $term
326
327Called at the very end of initialisation of a new terminal, just before
328returning to the mainloop.
250 329
251=item on_reset $term 330=item on_reset $term
252 331
253Called after the screen is "reset" for any reason, such as resizing or 332Called after the screen is "reset" for any reason, such as resizing or
254control sequences. Here is where you can react on changes to size-related 333control sequences. Here is where you can react on changes to size-related
255variables. 334variables.
256 335
257=item on_start $term 336=item on_child_start $term, $pid
258 337
259Called at the very end of initialisation of a new terminal, just before 338Called just after the child process has been C<fork>ed.
260returning to the mainloop. 339
340=item on_child_exit $term, $status
341
342Called just after the child process has exited. C<$status> is the status
343from C<waitpid>.
261 344
262=item on_sel_make $term, $eventtime 345=item on_sel_make $term, $eventtime
263 346
264Called whenever a selection has been made by the user, but before the 347Called whenever a selection has been made by the user, but before the
265selection text is copied, so changes to the beginning, end or type of the 348selection text is copied, so changes to the beginning, end or type of the
358 441
359Called whenever the user presses a key combination that has a 442Called whenever the user presses a key combination that has a
360C<perl:string> action bound to it (see description of the B<keysym> 443C<perl:string> action bound to it (see description of the B<keysym>
361resource in the @@RXVT_NAME@@(1) manpage). 444resource in the @@RXVT_NAME@@(1) manpage).
362 445
446=item on_x_event $term, $event
447
448Called on every X event received on the vt window (and possibly other
449windows). Should only be used as a last resort. Most event structure
450members are not passed.
451
363=item on_focus_in $term 452=item on_focus_in $term
364 453
365Called whenever the window gets the keyboard focus, before rxvt-unicode 454Called whenever the window gets the keyboard focus, before rxvt-unicode
366does focus in processing. 455does focus in processing.
367 456
368=item on_focus_out $term 457=item on_focus_out $term
369 458
370Called wheneever the window loses keyboard focus, before rxvt-unicode does 459Called wheneever the window loses keyboard focus, before rxvt-unicode does
371focus out processing. 460focus out processing.
461
462=item on_configure_notify $term, $event
372 463
373=item on_key_press $term, $event, $keysym, $octets 464=item on_key_press $term, $event, $keysym, $octets
374 465
375=item on_key_release $term, $event, $keysym 466=item on_key_release $term, $event, $keysym
376 467
462Using this function has the advantage that its output ends up in the 553Using this function has the advantage that its output ends up in the
463correct place, e.g. on stderr of the connecting urxvtc client. 554correct place, e.g. on stderr of the connecting urxvtc client.
464 555
465Messages have a size limit of 1023 bytes currently. 556Messages have a size limit of 1023 bytes currently.
466 557
467=item $is_safe = urxvt::safe
468
469Returns true when it is safe to do potentially unsafe things, such as
470evaluating perl code specified by the user. This is true when urxvt was
471started setuid or setgid.
472
473=item $time = urxvt::NOW 558=item $time = urxvt::NOW
474 559
475Returns the "current time" (as per the event loop). 560Returns the "current time" (as per the event loop).
476 561
477=item urxvt::CurrentTime 562=item urxvt::CurrentTime
478 563
479=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 564=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 565Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481Button4Mask, Button5Mask, AnyModifier 566Button4Mask, Button5Mask, AnyModifier
567
568=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
569ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
570PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
571Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
572KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
573ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
574FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
575
576=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
577EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
578GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
579UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
580ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
581CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
582SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
482 583
483Various constants for use in X calls and event processing. 584Various constants for use in X calls and event processing.
484 585
485=back 586=back
486 587
537=back 638=back
538 639
539=cut 640=cut
540 641
541BEGIN { 642BEGIN {
542 urxvt->bootstrap;
543
544 # overwrite perl's warn 643 # overwrite perl's warn
545 *CORE::GLOBAL::warn = sub { 644 *CORE::GLOBAL::warn = sub {
546 my $msg = join "", @_; 645 my $msg = join "", @_;
547 $msg .= "\n" 646 $msg .= "\n"
548 unless $msg =~ /\n$/; 647 unless $msg =~ /\n$/;
549 urxvt::warn ($msg); 648 urxvt::warn ($msg);
550 }; 649 };
551
552 # %ENV is the original startup environment
553 delete $ENV{IFS};
554 delete $ENV{CDPATH};
555 delete $ENV{BASH_ENV};
556 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
557} 650}
558 651
559my @hook_count;
560my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 652my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561 653
562sub verbose { 654sub verbose {
563 my ($level, $msg) = @_; 655 my ($level, $msg) = @_;
564 warn "$msg\n" if $level <= $verbosity; 656 warn "$msg\n" if $level <= $verbosity;
565} 657}
566 658
567my $extension_pkg = "extension0000";
568my %extension_pkg; 659my %extension_pkg;
569 660
570# load a single script into its own package, once only 661# load a single script into its own package, once only
571sub extension_package($) { 662sub extension_package($) {
572 my ($path) = @_; 663 my ($path) = @_;
573 664
665 no strict 'refs';
666
574 $extension_pkg{$path} ||= do { 667 $extension_pkg{$path} ||= do {
575 my $pkg = "urxvt::" . ($extension_pkg++); 668 $path =~ /([^\/\\]+)$/;
669 my $pkg = $1;
670 $pkg =~ s/[^[:word:]]/_/g;
671 $pkg = "urxvt::ext::$pkg";
576 672
577 verbose 3, "loading extension '$path' into package '$pkg'"; 673 verbose 3, "loading extension '$path' into package '$pkg'";
578 674
579 open my $fh, "<:raw", $path 675 open my $fh, "<:raw", $path
580 or die "$path: $!"; 676 or die "$path: $!";
581 677
678 @{"$pkg\::ISA"} = urxvt::term::extension::;
679
582 my $source = untaint 680 my $source =
583 "package $pkg; use strict; use utf8;\n" 681 "package $pkg; use strict; use utf8;\n"
584 . "use base urxvt::term::extension::;\n"
585 . "#line 1 \"$path\"\n{\n" 682 . "#line 1 \"$path\"\n{\n"
586 . (do { local $/; <$fh> }) 683 . (do { local $/; <$fh> })
587 . "\n};\n1"; 684 . "\n};\n1";
588 685
589 eval $source 686 eval $source
638 if $verbosity >= 10; 735 if $verbosity >= 10;
639 736
640 keys %$cb; 737 keys %$cb;
641 738
642 while (my ($pkg, $cb) = each %$cb) { 739 while (my ($pkg, $cb) = each %$cb) {
643 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 740 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
644 and last;
645 741
646 if ($@) { 742 if ($@) {
647 $TERM->ungrab; # better to lose the grab than the session 743 $TERM->ungrab; # better to lose the grab than the session
648 warn $@; 744 warn $@;
649 } 745 }
652 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 748 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653 if $verbosity >= 11; 749 if $verbosity >= 11;
654 } 750 }
655 751
656 if ($htype == 1) { # DESTROY 752 if ($htype == 1) { # DESTROY
657 if (my $hook = delete $TERM->{_hook}) {
658 for my $htype (0..$#$hook) {
659 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
660 or set_should_invoke $htype, 0;
661 }
662 }
663
664 # clear package objects 753 # clear package objects
665 %$_ = () for values %{ $TERM->{_pkg} }; 754 %$_ = () for values %{ $TERM->{_pkg} };
666 755
667 # clear package 756 # clear package
668 %$TERM = (); 757 %$TERM = ();
669 } 758 }
670 759
671 $retval 760 $retval
672}
673
674sub exec_async(@) {
675 my $pid = fork;
676
677 return
678 if !defined $pid or $pid;
679
680 %ENV = %{ $TERM->env };
681
682 exec @_;
683 _exit 255;
684} 761}
685 762
686# urxvt::term::extension 763# urxvt::term::extension
687 764
688package urxvt::term::extension; 765package urxvt::term::extension;
694 while (my ($name, $cb) = each %hook) { 771 while (my ($name, $cb) = each %hook) {
695 my $htype = $HOOKTYPE{uc $name}; 772 my $htype = $HOOKTYPE{uc $name};
696 defined $htype 773 defined $htype
697 or Carp::croak "unsupported hook type '$name'"; 774 or Carp::croak "unsupported hook type '$name'";
698 775
776 $self->set_should_invoke ($htype, +1)
699 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 777 unless exists $self->{term}{_hook}[$htype]{$pkg};
700 $hook_count[$htype]++
701 or urxvt::set_should_invoke $htype, 1;
702 }
703 778
704 $self->{term}{_hook}[$htype]{$pkg} = $cb; 779 $self->{term}{_hook}[$htype]{$pkg} = $cb;
705 } 780 }
706} 781}
707 782
712 for my $name (@hook) { 787 for my $name (@hook) {
713 my $htype = $HOOKTYPE{uc $name}; 788 my $htype = $HOOKTYPE{uc $name};
714 defined $htype 789 defined $htype
715 or Carp::croak "unsupported hook type '$name'"; 790 or Carp::croak "unsupported hook type '$name'";
716 791
792 $self->set_should_invoke ($htype, -1)
717 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 793 if delete $self->{term}{_hook}[$htype]{$pkg};
718 --$hook_count[$htype]
719 or urxvt::set_should_invoke $htype, 0;
720 }
721 } 794 }
722} 795}
723 796
724our $AUTOLOAD; 797our $AUTOLOAD;
725 798
871 944
872Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
873etc.). 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
874watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
875 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
876=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
877 975
878Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
879optionally 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
880C<%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.
882Here 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
883source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
884 982
885 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
886 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
887 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
888 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
889 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
890 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
891 989
892=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
893 991
894Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
895optionally 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>
912 1010
913 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
914 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
915 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
916 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
917 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
918 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
919 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
920 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
921 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
922 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
923 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
924 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
925 1024
926=cut 1025=cut
927 1026
928sub resource($$;$) { 1027sub resource($$;$) {
929 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
1130 1229
1131=item $windowid = $term->vt 1230=item $windowid = $term->vt
1132 1231
1133Return the window id of the terminal window. 1232Return the window id of the terminal window.
1134 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
1135=item $window_width = $term->width 1241=item $window_width = $term->width
1136 1242
1137=item $window_height = $term->height 1243=item $window_height = $term->height
1138 1244
1139=item $font_width = $term->fwidth 1245=item $font_width = $term->fwidth
1152 1258
1153=item $max_scrollback = $term->saveLines 1259=item $max_scrollback = $term->saveLines
1154 1260
1155=item $nrow_plus_saveLines = $term->total_rows 1261=item $nrow_plus_saveLines = $term->total_rows
1156 1262
1157=item $lines_in_scrollback = $term->nsaved 1263=item $topmost_scrollback_row = $term->top_row
1158 1264
1159Return various integers describing terminal characteristics. 1265Return various integers describing terminal characteristics.
1160 1266
1161=item $x_display = $term->display_id 1267=item $x_display = $term->display_id
1162 1268
1190Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1296Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1191AltGr), 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.
1192 1298
1193=item $view_start = $term->view_start ([$newvalue]) 1299=item $view_start = $term->view_start ([$newvalue])
1194 1300
1195Returns the negative row number of the topmost line. Minimum value is 1301Returns the row number of the topmost displayed line. Maximum value is
1196C<0>, which displays the normal terminal contents. Larger values scroll 1302C<0>, which displays the normal terminal contents. Lower values scroll
1197this many lines into the scrollback buffer. 1303this many lines into the scrollback buffer.
1198 1304
1199=item $term->want_refresh 1305=item $term->want_refresh
1200 1306
1201Requests a screen refresh. At the next opportunity, rxvt-unicode will 1307Requests a screen refresh. At the next opportunity, rxvt-unicode will
1514 my $env = $self->{term}->env; 1620 my $env = $self->{term}->env;
1515 # 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.
1516 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1517 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1518 1624
1519 urxvt::term->new ($env, $self->{term}->resource ("name"), 1625 urxvt::term->new ($env, "popup",
1520 "--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",
1521 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1522 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1523 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1524 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1525} 1633}
1577Start the timer. 1685Start the timer.
1578 1686
1579=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1580 1688
1581Set 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>.
1582 1694
1583=item $timer = $timer->stop 1695=item $timer = $timer->stop
1584 1696
1585Stop the timer. 1697Stop the timer.
1586 1698

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines