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

Diff Legend

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