… | |
… | |
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
67 | |
67 | |
68 | You can look at the source of the selection extension to see more |
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. |
69 | interesting uses, such as parsing a line from beginning to end. |
70 | |
70 | |
71 | This extension also offers the following bindable keyboard command: |
71 | This extension also offers following bindable keyboard commands: |
72 | |
72 | |
73 | =over 4 |
73 | =over 4 |
74 | |
74 | |
75 | =item rot13 |
75 | =item rot13 |
76 | |
76 | |
… | |
… | |
88 | =item selection-popup (enabled by default) |
88 | =item selection-popup (enabled by default) |
89 | |
89 | |
90 | 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 |
91 | text into various other formats/action (such as uri unescaping, perl |
91 | text into various other formats/action (such as uri unescaping, perl |
92 | evalution, web-browser starting etc.), depending on content. |
92 | evalution, web-browser starting etc.), depending on content. |
|
|
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 | }; |
93 | |
111 | |
94 | =item searchable-scrollback<hotkey> (enabled by default) |
112 | =item searchable-scrollback<hotkey> (enabled by default) |
95 | |
113 | |
96 | Adds regex search functionality to the scrollback buffer, triggered |
114 | Adds regex search functionality to the scrollback buffer, triggered |
97 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
115 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
… | |
… | |
117 | URxvt.selection-autotransform.0: transform |
135 | URxvt.selection-autotransform.0: transform |
118 | URxvt.selection-autotransform.1: transform |
136 | URxvt.selection-autotransform.1: transform |
119 | ... |
137 | ... |
120 | |
138 | |
121 | For example, the following will transform selections of the form |
139 | For example, the following will transform selections of the form |
122 | C<word:number> into C<vi +$number $word>: |
140 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
141 | $word>: |
123 | |
142 | |
124 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/ |
143 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
125 | |
144 | |
126 | And this example matches the same,but replaces it with vi-commands you can |
145 | And this example matches the same,but replaces it with vi-commands you can |
127 | paste directory into your (vi :) editor: |
146 | paste directly into your (vi :) editor: |
128 | |
147 | |
129 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/ |
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. |
130 | |
161 | |
131 | =item mark-urls |
162 | =item mark-urls |
132 | |
163 | |
133 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
164 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
134 | make them clickable. When middle-clicked, the program specified in the |
165 | make them clickable. When middle-clicked, the program specified in the |
… | |
… | |
148 | =item example-refresh-hooks |
179 | =item example-refresh-hooks |
149 | |
180 | |
150 | 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 |
151 | window. Illustrates overwriting the refresh callbacks to create your own |
182 | window. Illustrates overwriting the refresh callbacks to create your own |
152 | 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/% |
153 | |
213 | |
154 | =back |
214 | =back |
155 | |
215 | |
156 | =head1 API DOCUMENTATION |
216 | =head1 API DOCUMENTATION |
157 | |
217 | |
… | |
… | |
358 | |
418 | |
359 | Called whenever the user presses a key combination that has a |
419 | Called whenever the user presses a key combination that has a |
360 | 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> |
361 | resource in the @@RXVT_NAME@@(1) manpage). |
421 | resource in the @@RXVT_NAME@@(1) manpage). |
362 | |
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 | |
363 | =item on_focus_in $term |
429 | =item on_focus_in $term |
364 | |
430 | |
365 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
431 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
366 | does focus in processing. |
432 | does focus in processing. |
367 | |
433 | |
… | |
… | |
462 | Using this function has the advantage that its output ends up in the |
528 | Using this function has the advantage that its output ends up in the |
463 | correct place, e.g. on stderr of the connecting urxvtc client. |
529 | correct place, e.g. on stderr of the connecting urxvtc client. |
464 | |
530 | |
465 | Messages have a size limit of 1023 bytes currently. |
531 | Messages have a size limit of 1023 bytes currently. |
466 | |
532 | |
467 | =item $is_safe = urxvt::safe |
|
|
468 | |
|
|
469 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
470 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
471 | started setuid or setgid. |
|
|
472 | |
|
|
473 | =item $time = urxvt::NOW |
533 | =item $time = urxvt::NOW |
474 | |
534 | |
475 | Returns the "current time" (as per the event loop). |
535 | Returns the "current time" (as per the event loop). |
476 | |
536 | |
477 | =item urxvt::CurrentTime |
537 | =item urxvt::CurrentTime |
478 | |
538 | |
479 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
539 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
480 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
540 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
481 | Button4Mask, Button5Mask, AnyModifier |
541 | Button4Mask, Button5Mask, AnyModifier |
|
|
542 | |
|
|
543 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
544 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
545 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
546 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
547 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
548 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
549 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
550 | |
|
|
551 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
552 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
553 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
554 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
555 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
556 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
557 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
482 | |
558 | |
483 | Various constants for use in X calls and event processing. |
559 | Various constants for use in X calls and event processing. |
484 | |
560 | |
485 | =back |
561 | =back |
486 | |
562 | |
… | |
… | |
537 | =back |
613 | =back |
538 | |
614 | |
539 | =cut |
615 | =cut |
540 | |
616 | |
541 | BEGIN { |
617 | BEGIN { |
542 | urxvt->bootstrap; |
|
|
543 | |
|
|
544 | # overwrite perl's warn |
618 | # overwrite perl's warn |
545 | *CORE::GLOBAL::warn = sub { |
619 | *CORE::GLOBAL::warn = sub { |
546 | my $msg = join "", @_; |
620 | my $msg = join "", @_; |
547 | $msg .= "\n" |
621 | $msg .= "\n" |
548 | unless $msg =~ /\n$/; |
622 | unless $msg =~ /\n$/; |
… | |
… | |
554 | delete $ENV{CDPATH}; |
628 | delete $ENV{CDPATH}; |
555 | delete $ENV{BASH_ENV}; |
629 | delete $ENV{BASH_ENV}; |
556 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
630 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
557 | } |
631 | } |
558 | |
632 | |
559 | my @hook_count; |
|
|
560 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
633 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
561 | |
634 | |
562 | sub verbose { |
635 | sub verbose { |
563 | my ($level, $msg) = @_; |
636 | my ($level, $msg) = @_; |
564 | warn "$msg\n" if $level <= $verbosity; |
637 | warn "$msg\n" if $level <= $verbosity; |
565 | } |
638 | } |
566 | |
639 | |
567 | my $extension_pkg = "extension0000"; |
|
|
568 | my %extension_pkg; |
640 | my %extension_pkg; |
569 | |
641 | |
570 | # load a single script into its own package, once only |
642 | # load a single script into its own package, once only |
571 | sub extension_package($) { |
643 | sub extension_package($) { |
572 | my ($path) = @_; |
644 | my ($path) = @_; |
573 | |
645 | |
|
|
646 | no strict 'refs'; |
|
|
647 | |
574 | $extension_pkg{$path} ||= do { |
648 | $extension_pkg{$path} ||= do { |
575 | my $pkg = "urxvt::" . ($extension_pkg++); |
649 | $path =~ /([^\/\\]+)$/; |
|
|
650 | my $pkg = $1; |
|
|
651 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
652 | $pkg = "urxvt::ext::$pkg"; |
576 | |
653 | |
577 | verbose 3, "loading extension '$path' into package '$pkg'"; |
654 | verbose 3, "loading extension '$path' into package '$pkg'"; |
578 | |
655 | |
579 | open my $fh, "<:raw", $path |
656 | open my $fh, "<:raw", $path |
580 | or die "$path: $!"; |
657 | or die "$path: $!"; |
581 | |
658 | |
|
|
659 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
660 | |
582 | my $source = untaint |
661 | my $source = |
583 | "package $pkg; use strict; use utf8;\n" |
662 | "package $pkg; use strict; use utf8;\n" |
584 | . "use base urxvt::term::extension::;\n" |
|
|
585 | . "#line 1 \"$path\"\n{\n" |
663 | . "#line 1 \"$path\"\n{\n" |
586 | . (do { local $/; <$fh> }) |
664 | . (do { local $/; <$fh> }) |
587 | . "\n};\n1"; |
665 | . "\n};\n1"; |
588 | |
666 | |
589 | eval $source |
667 | eval $source |
… | |
… | |
652 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
730 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
653 | if $verbosity >= 11; |
731 | if $verbosity >= 11; |
654 | } |
732 | } |
655 | |
733 | |
656 | if ($htype == 1) { # DESTROY |
734 | 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 |
735 | # clear package objects |
665 | %$_ = () for values %{ $TERM->{_pkg} }; |
736 | %$_ = () for values %{ $TERM->{_pkg} }; |
666 | |
737 | |
667 | # clear package |
738 | # clear package |
668 | %$TERM = (); |
739 | %$TERM = (); |
… | |
… | |
694 | while (my ($name, $cb) = each %hook) { |
765 | while (my ($name, $cb) = each %hook) { |
695 | my $htype = $HOOKTYPE{uc $name}; |
766 | my $htype = $HOOKTYPE{uc $name}; |
696 | defined $htype |
767 | defined $htype |
697 | or Carp::croak "unsupported hook type '$name'"; |
768 | or Carp::croak "unsupported hook type '$name'"; |
698 | |
769 | |
|
|
770 | $self->set_should_invoke ($htype, +1) |
699 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
771 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
700 | $hook_count[$htype]++ |
|
|
701 | or urxvt::set_should_invoke $htype, 1; |
|
|
702 | } |
|
|
703 | |
772 | |
704 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
773 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
705 | } |
774 | } |
706 | } |
775 | } |
707 | |
776 | |
… | |
… | |
712 | for my $name (@hook) { |
781 | for my $name (@hook) { |
713 | my $htype = $HOOKTYPE{uc $name}; |
782 | my $htype = $HOOKTYPE{uc $name}; |
714 | defined $htype |
783 | defined $htype |
715 | or Carp::croak "unsupported hook type '$name'"; |
784 | or Carp::croak "unsupported hook type '$name'"; |
716 | |
785 | |
|
|
786 | $self->set_should_invoke ($htype, -1) |
717 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
787 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
718 | --$hook_count[$htype] |
|
|
719 | or urxvt::set_should_invoke $htype, 0; |
|
|
720 | } |
|
|
721 | } |
788 | } |
722 | } |
789 | } |
723 | |
790 | |
724 | our $AUTOLOAD; |
791 | our $AUTOLOAD; |
725 | |
792 | |
… | |
… | |
1130 | |
1197 | |
1131 | =item $windowid = $term->vt |
1198 | =item $windowid = $term->vt |
1132 | |
1199 | |
1133 | Return the window id of the terminal window. |
1200 | Return the window id of the terminal window. |
1134 | |
1201 | |
|
|
1202 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1203 | |
|
|
1204 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1205 | to receive pointer events all the times: |
|
|
1206 | |
|
|
1207 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1208 | |
1135 | =item $window_width = $term->width |
1209 | =item $window_width = $term->width |
1136 | |
1210 | |
1137 | =item $window_height = $term->height |
1211 | =item $window_height = $term->height |
1138 | |
1212 | |
1139 | =item $font_width = $term->fwidth |
1213 | =item $font_width = $term->fwidth |
… | |
… | |
1152 | |
1226 | |
1153 | =item $max_scrollback = $term->saveLines |
1227 | =item $max_scrollback = $term->saveLines |
1154 | |
1228 | |
1155 | =item $nrow_plus_saveLines = $term->total_rows |
1229 | =item $nrow_plus_saveLines = $term->total_rows |
1156 | |
1230 | |
1157 | =item $lines_in_scrollback = $term->nsaved |
1231 | =item $topmost_scrollback_row = $term->top_row |
1158 | |
1232 | |
1159 | Return various integers describing terminal characteristics. |
1233 | Return various integers describing terminal characteristics. |
1160 | |
1234 | |
1161 | =item $x_display = $term->display_id |
1235 | =item $x_display = $term->display_id |
1162 | |
1236 | |
… | |
… | |
1190 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1264 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1191 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1265 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1192 | |
1266 | |
1193 | =item $view_start = $term->view_start ([$newvalue]) |
1267 | =item $view_start = $term->view_start ([$newvalue]) |
1194 | |
1268 | |
1195 | Returns the negative row number of the topmost line. Minimum value is |
1269 | Returns the row number of the topmost displayed line. Maximum value is |
1196 | C<0>, which displays the normal terminal contents. Larger values scroll |
1270 | C<0>, which displays the normal terminal contents. Lower values scroll |
1197 | this many lines into the scrollback buffer. |
1271 | this many lines into the scrollback buffer. |
1198 | |
1272 | |
1199 | =item $term->want_refresh |
1273 | =item $term->want_refresh |
1200 | |
1274 | |
1201 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1275 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |