… | |
… | |
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 |
45 | when the user extends selections (double-click). Right now, it tries to |
45 | when the user extends selections (double-click and further clicks). Right |
46 | select urls and complete shell-quoted arguments, which is very convenient, |
46 | now, it tries to select words, urls and complete shell-quoted |
47 | too, if your F<ls> supports C<--quoting-style=shell>. |
47 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
48 | C<--quoting-style=shell>. |
48 | |
49 | |
|
|
50 | A double-click usually selects the word under the cursor, further clicks |
|
|
51 | will enlarge the selection. |
|
|
52 | |
|
|
53 | The selection works by trying to match a number of regexes and displaying |
|
|
54 | them in increasing order of length. You can add your own regexes by |
|
|
55 | specifying resources of the form: |
|
|
56 | |
|
|
57 | URxvt.selection.pattern-0: perl-regex |
|
|
58 | URxvt.selection.pattern-1: perl-regex |
|
|
59 | ... |
|
|
60 | |
|
|
61 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
62 | contain at least one pair of capturing parentheses, which will be used for |
|
|
63 | the match. For example, the followign adds a regex that matches everything |
|
|
64 | between two vertical bars: |
|
|
65 | |
|
|
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
67 | |
|
|
68 | You can look at the source of the selection extension to see more |
|
|
69 | interesting uses, such as parsing a line from beginning to end. |
|
|
70 | |
49 | It also offers the following bindable keyboard command: |
71 | This 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 | |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
69 | text into various other formats/action (such as uri unescaping, perl |
91 | text into various other formats/action (such as uri unescaping, perl |
70 | evalution, web-browser starting etc.), depending on content. |
92 | evalution, web-browser starting etc.), depending on content. |
71 | |
93 | |
|
|
94 | Other extensions can extend this popup menu by pushing a code reference onto |
|
|
95 | C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. |
|
|
96 | |
|
|
97 | It's sole argument is the popup menu, which can be modified. The selection |
|
|
98 | is in C<$_>, which can be used to decide wether to add something or not. |
|
|
99 | It should either return nothing or a string and a code reference. The |
|
|
100 | string will be used as button text and the code reference will be called |
|
|
101 | when the button gets activated and should transform C<$_>. |
|
|
102 | |
|
|
103 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
104 | the selection to C<b>s, but only if the selection currently contains any |
|
|
105 | C<a>s: |
|
|
106 | |
|
|
107 | push urxvt::ext::selection_popup::hook, sub { |
|
|
108 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
109 | : () |
|
|
110 | }; |
|
|
111 | |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
112 | =item searchable-scrollback<hotkey> (enabled by default) |
73 | |
113 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
114 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
115 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
116 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
117 | screen. |
77 | |
118 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
119 | Inputting characters appends them to the regex and continues incremental |
79 | C<N> jump to the previous match, C<G> jumps to the bottom and clears the |
120 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
80 | history, C<enter> leaves search mode at the current position and C<escape> |
121 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
122 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
123 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
124 | additionally stores the first match in the current line into the primary |
|
|
125 | selection. |
82 | |
126 | |
83 | =item digital-clock |
127 | =item selection-autotransform |
84 | |
128 | |
85 | Displays a digital clock using the built-in overlay. |
129 | This selection allows you to do automatic transforms on a selection |
|
|
130 | whenever a selection is made. |
|
|
131 | |
|
|
132 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
133 | operator) that modify C<$_> as resources: |
|
|
134 | |
|
|
135 | URxvt.selection-autotransform.0: transform |
|
|
136 | URxvt.selection-autotransform.1: transform |
|
|
137 | ... |
|
|
138 | |
|
|
139 | For example, the following will transform selections of the form |
|
|
140 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
141 | $word>: |
|
|
142 | |
|
|
143 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
144 | |
|
|
145 | And this example matches the same,but replaces it with vi-commands you can |
|
|
146 | paste directly into your (vi :) editor: |
|
|
147 | |
|
|
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
149 | |
|
|
150 | Of course, this can be modified to suit your needs and your editor :) |
|
|
151 | |
|
|
152 | To expand the example above to typical perl error messages ("XXX at |
|
|
153 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
154 | |
|
|
155 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
156 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
157 | |
|
|
158 | The first line tells the selection code to treat the unchanging part of |
|
|
159 | every error message as a selection pattern, and the second line transforms |
|
|
160 | the message into vi commands to load the file. |
86 | |
161 | |
87 | =item mark-urls |
162 | =item mark-urls |
88 | |
163 | |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
164 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
|
|
165 | make them clickable. When middle-clicked, the program specified in the |
|
|
166 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
167 | the URL as first argument. |
90 | |
168 | |
91 | =item block-graphics-to-ascii |
169 | =item block-graphics-to-ascii |
92 | |
170 | |
93 | A not very useful example of filtering all text output to the terminal, |
171 | A not very useful example of filtering all text output to the terminal, |
94 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
172 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
95 | similar-looking ascii character. |
173 | similar-looking ascii character. |
96 | |
174 | |
|
|
175 | =item digital-clock |
|
|
176 | |
|
|
177 | Displays a digital clock using the built-in overlay. |
|
|
178 | |
97 | =item example-refresh-hooks |
179 | =item example-refresh-hooks |
98 | |
180 | |
99 | Displays a very simple digital clock in the upper right corner of the |
181 | Displays a very simple digital clock in the upper right corner of the |
100 | window. Illustrates overwriting the refresh callbacks to create your own |
182 | window. Illustrates overwriting the refresh callbacks to create your own |
101 | overlays or changes. |
183 | overlays or changes. |
|
|
184 | |
|
|
185 | =item selection-pastebin |
|
|
186 | |
|
|
187 | This is a little rarely useful extension that Uploads the selection as |
|
|
188 | textfile to a remote site (or does other things). (The implementation is |
|
|
189 | not currently secure for use in a multiuser environment as it writes to |
|
|
190 | F</tmp> directly.). |
|
|
191 | |
|
|
192 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
193 | i.e. |
|
|
194 | |
|
|
195 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
196 | |
|
|
197 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
198 | the textfile. This command can be set via a resource: |
|
|
199 | |
|
|
200 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
201 | |
|
|
202 | And the default is likely not useful to anybody but the few people around |
|
|
203 | here :) |
|
|
204 | |
|
|
205 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
206 | the same content should lead to the same filename. |
|
|
207 | |
|
|
208 | After a successful upload the selection will be replaced by the text given |
|
|
209 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
210 | for the filename): |
|
|
211 | |
|
|
212 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
102 | |
213 | |
103 | =back |
214 | =back |
104 | |
215 | |
105 | =head1 API DOCUMENTATION |
216 | =head1 API DOCUMENTATION |
106 | |
217 | |
… | |
… | |
228 | =item on_sel_extend $term |
339 | =item on_sel_extend $term |
229 | |
340 | |
230 | Called whenever the user tries to extend the selection (e.g. with a double |
341 | Called whenever the user tries to extend the selection (e.g. with a double |
231 | click) and is either supposed to return false (normal operation), or |
342 | click) and is either supposed to return false (normal operation), or |
232 | should extend the selection itelf and return true to suppress the built-in |
343 | should extend the selection itelf and return true to suppress the built-in |
233 | processing. |
344 | processing. This can happen multiple times, as long as the callback |
|
|
345 | returns true, it will be called on every further click by the user and is |
|
|
346 | supposed to enlarge the selection more and more, if possible. |
234 | |
347 | |
235 | See the F<selection> example extension. |
348 | See the F<selection> example extension. |
236 | |
349 | |
237 | =item on_view_change $term, $offset |
350 | =item on_view_change $term, $offset |
238 | |
351 | |
… | |
… | |
305 | |
418 | |
306 | Called whenever the user presses a key combination that has a |
419 | Called whenever the user presses a key combination that has a |
307 | C<perl:string> action bound to it (see description of the B<keysym> |
420 | C<perl:string> action bound to it (see description of the B<keysym> |
308 | resource in the @@RXVT_NAME@@(1) manpage). |
421 | resource in the @@RXVT_NAME@@(1) manpage). |
309 | |
422 | |
|
|
423 | =item on_x_event $term, $event |
|
|
424 | |
|
|
425 | Called on every X event received on the vt window (and possibly other |
|
|
426 | windows). Should only be used as a last resort. Most event structure |
|
|
427 | members are not passed. |
|
|
428 | |
310 | =item on_focus_in $term |
429 | =item on_focus_in $term |
311 | |
430 | |
312 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
431 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
313 | does focus in processing. |
432 | does focus in processing. |
314 | |
433 | |
315 | =item on_focus_out $term |
434 | =item on_focus_out $term |
316 | |
435 | |
317 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
436 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
318 | focus out processing. |
437 | focus out processing. |
|
|
438 | |
|
|
439 | =item on_configure_notify $term, $event |
319 | |
440 | |
320 | =item on_key_press $term, $event, $keysym, $octets |
441 | =item on_key_press $term, $event, $keysym, $octets |
321 | |
442 | |
322 | =item on_key_release $term, $event, $keysym |
443 | =item on_key_release $term, $event, $keysym |
323 | |
444 | |
… | |
… | |
409 | Using this function has the advantage that its output ends up in the |
530 | Using this function has the advantage that its output ends up in the |
410 | correct place, e.g. on stderr of the connecting urxvtc client. |
531 | correct place, e.g. on stderr of the connecting urxvtc client. |
411 | |
532 | |
412 | Messages have a size limit of 1023 bytes currently. |
533 | Messages have a size limit of 1023 bytes currently. |
413 | |
534 | |
414 | =item $is_safe = urxvt::safe |
|
|
415 | |
|
|
416 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
417 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
418 | started setuid or setgid. |
|
|
419 | |
|
|
420 | =item $time = urxvt::NOW |
535 | =item $time = urxvt::NOW |
421 | |
536 | |
422 | Returns the "current time" (as per the event loop). |
537 | Returns the "current time" (as per the event loop). |
423 | |
538 | |
424 | =item urxvt::CurrentTime |
539 | =item urxvt::CurrentTime |
425 | |
540 | |
426 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
541 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
427 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
542 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
428 | Button4Mask, Button5Mask, AnyModifier |
543 | Button4Mask, Button5Mask, AnyModifier |
|
|
544 | |
|
|
545 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
546 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
547 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
548 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
549 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
550 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
551 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
552 | |
|
|
553 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
554 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
555 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
556 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
557 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
558 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
559 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
429 | |
560 | |
430 | Various constants for use in X calls and event processing. |
561 | Various constants for use in X calls and event processing. |
431 | |
562 | |
432 | =back |
563 | =back |
433 | |
564 | |
… | |
… | |
484 | =back |
615 | =back |
485 | |
616 | |
486 | =cut |
617 | =cut |
487 | |
618 | |
488 | BEGIN { |
619 | BEGIN { |
489 | urxvt->bootstrap; |
|
|
490 | |
|
|
491 | # overwrite perl's warn |
620 | # overwrite perl's warn |
492 | *CORE::GLOBAL::warn = sub { |
621 | *CORE::GLOBAL::warn = sub { |
493 | my $msg = join "", @_; |
622 | my $msg = join "", @_; |
494 | $msg .= "\n" |
623 | $msg .= "\n" |
495 | unless $msg =~ /\n$/; |
624 | unless $msg =~ /\n$/; |
496 | urxvt::warn ($msg); |
625 | urxvt::warn ($msg); |
497 | }; |
626 | }; |
498 | |
627 | |
|
|
628 | # %ENV is the original startup environment |
499 | delete $ENV{IFS}; |
629 | delete $ENV{IFS}; |
500 | delete $ENV{CDPATH}; |
630 | delete $ENV{CDPATH}; |
501 | delete $ENV{BASH_ENV}; |
631 | delete $ENV{BASH_ENV}; |
502 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
632 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
503 | } |
633 | } |
504 | |
634 | |
505 | my @hook_count; |
|
|
506 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
635 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
507 | |
636 | |
508 | sub verbose { |
637 | sub verbose { |
509 | my ($level, $msg) = @_; |
638 | my ($level, $msg) = @_; |
510 | warn "$msg\n" if $level <= $verbosity; |
639 | warn "$msg\n" if $level <= $verbosity; |
511 | } |
640 | } |
512 | |
641 | |
513 | my $extension_pkg = "extension0000"; |
|
|
514 | my %extension_pkg; |
642 | my %extension_pkg; |
515 | |
643 | |
516 | # load a single script into its own package, once only |
644 | # load a single script into its own package, once only |
517 | sub extension_package($) { |
645 | sub extension_package($) { |
518 | my ($path) = @_; |
646 | my ($path) = @_; |
519 | |
647 | |
|
|
648 | no strict 'refs'; |
|
|
649 | |
520 | $extension_pkg{$path} ||= do { |
650 | $extension_pkg{$path} ||= do { |
521 | my $pkg = "urxvt::" . ($extension_pkg++); |
651 | $path =~ /([^\/\\]+)$/; |
|
|
652 | my $pkg = $1; |
|
|
653 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
654 | $pkg = "urxvt::ext::$pkg"; |
522 | |
655 | |
523 | verbose 3, "loading extension '$path' into package '$pkg'"; |
656 | verbose 3, "loading extension '$path' into package '$pkg'"; |
524 | |
657 | |
525 | open my $fh, "<:raw", $path |
658 | open my $fh, "<:raw", $path |
526 | or die "$path: $!"; |
659 | or die "$path: $!"; |
527 | |
660 | |
|
|
661 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
662 | |
528 | my $source = untaint |
663 | my $source = |
529 | "package $pkg; use strict; use utf8;\n" |
664 | "package $pkg; use strict; use utf8;\n" |
530 | . "use base urxvt::term::extension::;\n" |
|
|
531 | . "#line 1 \"$path\"\n{\n" |
665 | . "#line 1 \"$path\"\n{\n" |
532 | . (do { local $/; <$fh> }) |
666 | . (do { local $/; <$fh> }) |
533 | . "\n};\n1"; |
667 | . "\n};\n1"; |
534 | |
668 | |
535 | eval $source |
669 | eval $source |
… | |
… | |
592 | if ($@) { |
726 | if ($@) { |
593 | $TERM->ungrab; # better to lose the grab than the session |
727 | $TERM->ungrab; # better to lose the grab than the session |
594 | warn $@; |
728 | warn $@; |
595 | } |
729 | } |
596 | } |
730 | } |
|
|
731 | |
|
|
732 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
733 | if $verbosity >= 11; |
597 | } |
734 | } |
598 | |
735 | |
599 | if ($htype == 1) { # DESTROY |
736 | 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 |
737 | # clear package objects |
608 | %$_ = () for values %{ $TERM->{_pkg} }; |
738 | %$_ = () for values %{ $TERM->{_pkg} }; |
609 | |
739 | |
610 | # clear package |
740 | # clear package |
611 | %$TERM = (); |
741 | %$TERM = (); |
612 | } |
742 | } |
613 | |
743 | |
614 | $retval |
744 | $retval |
|
|
745 | } |
|
|
746 | |
|
|
747 | sub exec_async(@) { |
|
|
748 | my $pid = fork; |
|
|
749 | |
|
|
750 | return |
|
|
751 | if !defined $pid or $pid; |
|
|
752 | |
|
|
753 | %ENV = %{ $TERM->env }; |
|
|
754 | |
|
|
755 | exec @_; |
|
|
756 | _exit 255; |
615 | } |
757 | } |
616 | |
758 | |
617 | # urxvt::term::extension |
759 | # urxvt::term::extension |
618 | |
760 | |
619 | package urxvt::term::extension; |
761 | package urxvt::term::extension; |
… | |
… | |
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 | |
655 | our $AUTOLOAD; |
793 | our $AUTOLOAD; |
656 | |
794 | |
… | |
… | |
860 | my ($self, $name) = (shift, shift); |
998 | my ($self, $name) = (shift, shift); |
861 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
999 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
862 | &urxvt::term::_resource |
1000 | &urxvt::term::_resource |
863 | } |
1001 | } |
864 | |
1002 | |
|
|
1003 | =item $value = $term->x_resource ($pattern) |
|
|
1004 | |
|
|
1005 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
1006 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
1007 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
1008 | resource with that pattern exists. |
|
|
1009 | |
|
|
1010 | This method should only be called during the C<on_start> hook, as there is |
|
|
1011 | only one resource database per display, and later invocations might return |
|
|
1012 | the wrong resources. |
|
|
1013 | |
865 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1014 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
866 | |
1015 | |
867 | Adds a keymap translation exactly as specified via a resource. See the |
1016 | Adds a keymap translation exactly as specified via a resource. See the |
868 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1017 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
869 | |
1018 | |
… | |
… | |
884 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1033 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
885 | |
1034 | |
886 | Return the current values of the selection mark, begin or end positions, |
1035 | Return the current values of the selection mark, begin or end positions, |
887 | and optionally set them to new values. |
1036 | and optionally set them to new values. |
888 | |
1037 | |
|
|
1038 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1039 | |
|
|
1040 | Tries to make a selection as set by C<selection_beg> and |
|
|
1041 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1042 | rectangular selection will be made. This is the prefered function to make |
|
|
1043 | a selection. |
|
|
1044 | |
889 | =item $success = $term->selection_grab ($eventtime) |
1045 | =item $success = $term->selection_grab ($eventtime) |
890 | |
1046 | |
891 | Try to request the primary selection from the server (for example, as set |
1047 | Try to request the primary selection text from the server (for example, as |
892 | by the next method). |
1048 | set by the next method). No visual feedback will be given. This function |
|
|
1049 | is mostly useful from within C<on_sel_grab> hooks. |
893 | |
1050 | |
894 | =item $oldtext = $term->selection ([$newtext]) |
1051 | =item $oldtext = $term->selection ([$newtext]) |
895 | |
1052 | |
896 | Return the current selection text and optionally replace it by C<$newtext>. |
1053 | Return the current selection text and optionally replace it by C<$newtext>. |
897 | |
1054 | |
… | |
… | |
990 | Convert the given locale-encoded octets into a perl string. |
1147 | Convert the given locale-encoded octets into a perl string. |
991 | |
1148 | |
992 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1149 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
993 | |
1150 | |
994 | XORs the rendition values in the given span with the provided value |
1151 | XORs the rendition values in the given span with the provided value |
995 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
1152 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
996 | to the selection. |
1153 | refresh hooks to provide effects similar to the selection. |
997 | |
1154 | |
998 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1155 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
999 | |
1156 | |
1000 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1157 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1001 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1158 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1002 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1159 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1003 | it instead. |
1160 | it instead. Both styles I<MUST NOT> contain font styles. |
1004 | |
1161 | |
1005 | =item $term->scr_bell |
1162 | =item $term->scr_bell |
1006 | |
1163 | |
1007 | Ring the bell! |
1164 | Ring the bell! |
1008 | |
1165 | |
… | |
… | |
1042 | |
1199 | |
1043 | =item $windowid = $term->vt |
1200 | =item $windowid = $term->vt |
1044 | |
1201 | |
1045 | Return the window id of the terminal window. |
1202 | Return the window id of the terminal window. |
1046 | |
1203 | |
|
|
1204 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1205 | |
|
|
1206 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1207 | to receive pointer events all the times: |
|
|
1208 | |
|
|
1209 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1210 | |
1047 | =item $window_width = $term->width |
1211 | =item $window_width = $term->width |
1048 | |
1212 | |
1049 | =item $window_height = $term->height |
1213 | =item $window_height = $term->height |
1050 | |
1214 | |
1051 | =item $font_width = $term->fwidth |
1215 | =item $font_width = $term->fwidth |
… | |
… | |
1064 | |
1228 | |
1065 | =item $max_scrollback = $term->saveLines |
1229 | =item $max_scrollback = $term->saveLines |
1066 | |
1230 | |
1067 | =item $nrow_plus_saveLines = $term->total_rows |
1231 | =item $nrow_plus_saveLines = $term->total_rows |
1068 | |
1232 | |
1069 | =item $lines_in_scrollback = $term->nsaved |
1233 | =item $topmost_scrollback_row = $term->top_row |
1070 | |
1234 | |
1071 | Return various integers describing terminal characteristics. |
1235 | Return various integers describing terminal characteristics. |
1072 | |
1236 | |
1073 | =item $x_display = $term->display_id |
1237 | =item $x_display = $term->display_id |
1074 | |
1238 | |
… | |
… | |
1102 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1266 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1103 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1267 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1104 | |
1268 | |
1105 | =item $view_start = $term->view_start ([$newvalue]) |
1269 | =item $view_start = $term->view_start ([$newvalue]) |
1106 | |
1270 | |
1107 | Returns the negative row number of the topmost line. Minimum value is |
1271 | Returns the row number of the topmost displayed line. Maximum value is |
1108 | C<0>, which displays the normal terminal contents. Larger values scroll |
1272 | C<0>, which displays the normal terminal contents. Lower values scroll |
1109 | this many lines into the scrollback buffer. |
1273 | this many lines into the scrollback buffer. |
1110 | |
1274 | |
1111 | =item $term->want_refresh |
1275 | =item $term->want_refresh |
1112 | |
1276 | |
1113 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1277 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1192 | Return the row number of the first/last row of the line, respectively. |
1356 | Return the row number of the first/last row of the line, respectively. |
1193 | |
1357 | |
1194 | =item $offset = $line->offset_of ($row, $col) |
1358 | =item $offset = $line->offset_of ($row, $col) |
1195 | |
1359 | |
1196 | Returns the character offset of the given row|col pair within the logical |
1360 | Returns the character offset of the given row|col pair within the logical |
1197 | line. |
1361 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1362 | offsets outside the string. |
1198 | |
1363 | |
1199 | =item ($row, $col) = $line->coord_of ($offset) |
1364 | =item ($row, $col) = $line->coord_of ($offset) |
1200 | |
1365 | |
1201 | Translates a string offset into terminal coordinates again. |
1366 | Translates a string offset into terminal coordinates again. |
1202 | |
1367 | |
… | |
… | |
1425 | my $env = $self->{term}->env; |
1590 | my $env = $self->{term}->env; |
1426 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1591 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1427 | delete $env->{LC_ALL}; |
1592 | delete $env->{LC_ALL}; |
1428 | $env->{LC_CTYPE} = $self->{term}->locale; |
1593 | $env->{LC_CTYPE} = $self->{term}->locale; |
1429 | |
1594 | |
1430 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1595 | urxvt::term->new ($env, "popup", |
1431 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1596 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1432 | "--transient-for" => $self->{term}->parent, |
1597 | "--transient-for" => $self->{term}->parent, |
1433 | "-display" => $self->{term}->display_id, |
1598 | "-display" => $self->{term}->display_id, |
1434 | "-pe" => "urxvt-popup") |
1599 | "-pe" => "urxvt-popup") |
1435 | or die "unable to create popup window\n"; |
1600 | or die "unable to create popup window\n"; |
… | |
… | |
1488 | Start the timer. |
1653 | Start the timer. |
1489 | |
1654 | |
1490 | =item $timer = $timer->start ($tstamp) |
1655 | =item $timer = $timer->start ($tstamp) |
1491 | |
1656 | |
1492 | Set the event trigger time to C<$tstamp> and start the timer. |
1657 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1658 | |
|
|
1659 | =item $timer = $timer->after ($delay) |
|
|
1660 | |
|
|
1661 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1493 | |
1662 | |
1494 | =item $timer = $timer->stop |
1663 | =item $timer = $timer->stop |
1495 | |
1664 | |
1496 | Stop the timer. |
1665 | Stop the timer. |
1497 | |
1666 | |
… | |
… | |
1557 | |
1726 | |
1558 | =item == 0 - fatal messages |
1727 | =item == 0 - fatal messages |
1559 | |
1728 | |
1560 | =item >= 3 - script loading and management |
1729 | =item >= 3 - script loading and management |
1561 | |
1730 | |
1562 | =item >=10 - all events received |
1731 | =item >=10 - all called hooks |
|
|
1732 | |
|
|
1733 | =item >=11 - hook reutrn values |
1563 | |
1734 | |
1564 | =back |
1735 | =back |
1565 | |
1736 | |
1566 | =head1 AUTHOR |
1737 | =head1 AUTHOR |
1567 | |
1738 | |