… | |
… | |
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 |
… | |
… | |
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<filename:number>, often seen in compiler messages, into C<vi +$filename |
140 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
123 | $word>: |
141 | $word>: |
124 | |
142 | |
125 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
143 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
126 | |
144 | |
127 | 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 |
128 | paste directly into your (vi :) editor: |
146 | paste directly into your (vi :) editor: |
129 | |
147 | |
130 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
131 | |
149 | |
132 | Of course, this can be modified to suit your needs and your editor :) |
150 | Of course, this can be modified to suit your needs and your editor :) |
133 | |
151 | |
134 | To expand the example above to typical perl error messages ("XXX at |
152 | To expand the example above to typical perl error messages ("XXX at |
135 | FILENAME line YYY."), you need a slightly more elaborate solution: |
153 | FILENAME line YYY."), you need a slightly more elaborate solution: |
… | |
… | |
161 | =item example-refresh-hooks |
179 | =item example-refresh-hooks |
162 | |
180 | |
163 | 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 |
164 | window. Illustrates overwriting the refresh callbacks to create your own |
182 | window. Illustrates overwriting the refresh callbacks to create your own |
165 | 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/% |
166 | |
213 | |
167 | =back |
214 | =back |
168 | |
215 | |
169 | =head1 API DOCUMENTATION |
216 | =head1 API DOCUMENTATION |
170 | |
217 | |
… | |
… | |
371 | |
418 | |
372 | Called whenever the user presses a key combination that has a |
419 | Called whenever the user presses a key combination that has a |
373 | 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> |
374 | resource in the @@RXVT_NAME@@(1) manpage). |
421 | resource in the @@RXVT_NAME@@(1) manpage). |
375 | |
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 | |
376 | =item on_focus_in $term |
429 | =item on_focus_in $term |
377 | |
430 | |
378 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
431 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
379 | does focus in processing. |
432 | does focus in processing. |
380 | |
433 | |
381 | =item on_focus_out $term |
434 | =item on_focus_out $term |
382 | |
435 | |
383 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
436 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
384 | focus out processing. |
437 | focus out processing. |
|
|
438 | |
|
|
439 | =item on_configure_notify $term, $event |
385 | |
440 | |
386 | =item on_key_press $term, $event, $keysym, $octets |
441 | =item on_key_press $term, $event, $keysym, $octets |
387 | |
442 | |
388 | =item on_key_release $term, $event, $keysym |
443 | =item on_key_release $term, $event, $keysym |
389 | |
444 | |
… | |
… | |
475 | 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 |
476 | correct place, e.g. on stderr of the connecting urxvtc client. |
531 | correct place, e.g. on stderr of the connecting urxvtc client. |
477 | |
532 | |
478 | Messages have a size limit of 1023 bytes currently. |
533 | Messages have a size limit of 1023 bytes currently. |
479 | |
534 | |
480 | =item $is_safe = urxvt::safe |
|
|
481 | |
|
|
482 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
483 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
484 | started setuid or setgid. |
|
|
485 | |
|
|
486 | =item $time = urxvt::NOW |
535 | =item $time = urxvt::NOW |
487 | |
536 | |
488 | Returns the "current time" (as per the event loop). |
537 | Returns the "current time" (as per the event loop). |
489 | |
538 | |
490 | =item urxvt::CurrentTime |
539 | =item urxvt::CurrentTime |
491 | |
540 | |
492 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
541 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
493 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
542 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
494 | 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 |
495 | |
560 | |
496 | Various constants for use in X calls and event processing. |
561 | Various constants for use in X calls and event processing. |
497 | |
562 | |
498 | =back |
563 | =back |
499 | |
564 | |
… | |
… | |
550 | =back |
615 | =back |
551 | |
616 | |
552 | =cut |
617 | =cut |
553 | |
618 | |
554 | BEGIN { |
619 | BEGIN { |
555 | urxvt->bootstrap; |
|
|
556 | |
|
|
557 | # overwrite perl's warn |
620 | # overwrite perl's warn |
558 | *CORE::GLOBAL::warn = sub { |
621 | *CORE::GLOBAL::warn = sub { |
559 | my $msg = join "", @_; |
622 | my $msg = join "", @_; |
560 | $msg .= "\n" |
623 | $msg .= "\n" |
561 | unless $msg =~ /\n$/; |
624 | unless $msg =~ /\n$/; |
… | |
… | |
567 | delete $ENV{CDPATH}; |
630 | delete $ENV{CDPATH}; |
568 | delete $ENV{BASH_ENV}; |
631 | delete $ENV{BASH_ENV}; |
569 | $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"; |
570 | } |
633 | } |
571 | |
634 | |
572 | my @hook_count; |
|
|
573 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
635 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
574 | |
636 | |
575 | sub verbose { |
637 | sub verbose { |
576 | my ($level, $msg) = @_; |
638 | my ($level, $msg) = @_; |
577 | warn "$msg\n" if $level <= $verbosity; |
639 | warn "$msg\n" if $level <= $verbosity; |
578 | } |
640 | } |
579 | |
641 | |
580 | my $extension_pkg = "extension0000"; |
|
|
581 | my %extension_pkg; |
642 | my %extension_pkg; |
582 | |
643 | |
583 | # load a single script into its own package, once only |
644 | # load a single script into its own package, once only |
584 | sub extension_package($) { |
645 | sub extension_package($) { |
585 | my ($path) = @_; |
646 | my ($path) = @_; |
586 | |
647 | |
|
|
648 | no strict 'refs'; |
|
|
649 | |
587 | $extension_pkg{$path} ||= do { |
650 | $extension_pkg{$path} ||= do { |
588 | my $pkg = "urxvt::" . ($extension_pkg++); |
651 | $path =~ /([^\/\\]+)$/; |
|
|
652 | my $pkg = $1; |
|
|
653 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
654 | $pkg = "urxvt::ext::$pkg"; |
589 | |
655 | |
590 | verbose 3, "loading extension '$path' into package '$pkg'"; |
656 | verbose 3, "loading extension '$path' into package '$pkg'"; |
591 | |
657 | |
592 | open my $fh, "<:raw", $path |
658 | open my $fh, "<:raw", $path |
593 | or die "$path: $!"; |
659 | or die "$path: $!"; |
594 | |
660 | |
|
|
661 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
662 | |
595 | my $source = untaint |
663 | my $source = |
596 | "package $pkg; use strict; use utf8;\n" |
664 | "package $pkg; use strict; use utf8;\n" |
597 | . "use base urxvt::term::extension::;\n" |
|
|
598 | . "#line 1 \"$path\"\n{\n" |
665 | . "#line 1 \"$path\"\n{\n" |
599 | . (do { local $/; <$fh> }) |
666 | . (do { local $/; <$fh> }) |
600 | . "\n};\n1"; |
667 | . "\n};\n1"; |
601 | |
668 | |
602 | eval $source |
669 | eval $source |
… | |
… | |
665 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
732 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
666 | if $verbosity >= 11; |
733 | if $verbosity >= 11; |
667 | } |
734 | } |
668 | |
735 | |
669 | if ($htype == 1) { # DESTROY |
736 | if ($htype == 1) { # DESTROY |
670 | if (my $hook = delete $TERM->{_hook}) { |
|
|
671 | for my $htype (0..$#$hook) { |
|
|
672 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
673 | or set_should_invoke $htype, 0; |
|
|
674 | } |
|
|
675 | } |
|
|
676 | |
|
|
677 | # clear package objects |
737 | # clear package objects |
678 | %$_ = () for values %{ $TERM->{_pkg} }; |
738 | %$_ = () for values %{ $TERM->{_pkg} }; |
679 | |
739 | |
680 | # clear package |
740 | # clear package |
681 | %$TERM = (); |
741 | %$TERM = (); |
… | |
… | |
707 | while (my ($name, $cb) = each %hook) { |
767 | while (my ($name, $cb) = each %hook) { |
708 | my $htype = $HOOKTYPE{uc $name}; |
768 | my $htype = $HOOKTYPE{uc $name}; |
709 | defined $htype |
769 | defined $htype |
710 | or Carp::croak "unsupported hook type '$name'"; |
770 | or Carp::croak "unsupported hook type '$name'"; |
711 | |
771 | |
|
|
772 | $self->set_should_invoke ($htype, +1) |
712 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
773 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
713 | $hook_count[$htype]++ |
|
|
714 | or urxvt::set_should_invoke $htype, 1; |
|
|
715 | } |
|
|
716 | |
774 | |
717 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
775 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
718 | } |
776 | } |
719 | } |
777 | } |
720 | |
778 | |
… | |
… | |
725 | for my $name (@hook) { |
783 | for my $name (@hook) { |
726 | my $htype = $HOOKTYPE{uc $name}; |
784 | my $htype = $HOOKTYPE{uc $name}; |
727 | defined $htype |
785 | defined $htype |
728 | or Carp::croak "unsupported hook type '$name'"; |
786 | or Carp::croak "unsupported hook type '$name'"; |
729 | |
787 | |
|
|
788 | $self->set_should_invoke ($htype, -1) |
730 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
789 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
731 | --$hook_count[$htype] |
|
|
732 | or urxvt::set_should_invoke $htype, 0; |
|
|
733 | } |
|
|
734 | } |
790 | } |
735 | } |
791 | } |
736 | |
792 | |
737 | our $AUTOLOAD; |
793 | our $AUTOLOAD; |
738 | |
794 | |
… | |
… | |
1143 | |
1199 | |
1144 | =item $windowid = $term->vt |
1200 | =item $windowid = $term->vt |
1145 | |
1201 | |
1146 | Return the window id of the terminal window. |
1202 | Return the window id of the terminal window. |
1147 | |
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 | |
1148 | =item $window_width = $term->width |
1211 | =item $window_width = $term->width |
1149 | |
1212 | |
1150 | =item $window_height = $term->height |
1213 | =item $window_height = $term->height |
1151 | |
1214 | |
1152 | =item $font_width = $term->fwidth |
1215 | =item $font_width = $term->fwidth |
… | |
… | |
1165 | |
1228 | |
1166 | =item $max_scrollback = $term->saveLines |
1229 | =item $max_scrollback = $term->saveLines |
1167 | |
1230 | |
1168 | =item $nrow_plus_saveLines = $term->total_rows |
1231 | =item $nrow_plus_saveLines = $term->total_rows |
1169 | |
1232 | |
1170 | =item $lines_in_scrollback = $term->nsaved |
1233 | =item $topmost_scrollback_row = $term->top_row |
1171 | |
1234 | |
1172 | Return various integers describing terminal characteristics. |
1235 | Return various integers describing terminal characteristics. |
1173 | |
1236 | |
1174 | =item $x_display = $term->display_id |
1237 | =item $x_display = $term->display_id |
1175 | |
1238 | |
… | |
… | |
1203 | 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 |
1204 | 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. |
1205 | |
1268 | |
1206 | =item $view_start = $term->view_start ([$newvalue]) |
1269 | =item $view_start = $term->view_start ([$newvalue]) |
1207 | |
1270 | |
1208 | 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 |
1209 | C<0>, which displays the normal terminal contents. Larger values scroll |
1272 | C<0>, which displays the normal terminal contents. Lower values scroll |
1210 | this many lines into the scrollback buffer. |
1273 | this many lines into the scrollback buffer. |
1211 | |
1274 | |
1212 | =item $term->want_refresh |
1275 | =item $term->want_refresh |
1213 | |
1276 | |
1214 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1277 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1527 | my $env = $self->{term}->env; |
1590 | my $env = $self->{term}->env; |
1528 | # 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. |
1529 | delete $env->{LC_ALL}; |
1592 | delete $env->{LC_ALL}; |
1530 | $env->{LC_CTYPE} = $self->{term}->locale; |
1593 | $env->{LC_CTYPE} = $self->{term}->locale; |
1531 | |
1594 | |
1532 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1595 | urxvt::term->new ($env, "popup", |
1533 | "--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, |
1534 | "--transient-for" => $self->{term}->parent, |
1597 | "--transient-for" => $self->{term}->parent, |
1535 | "-display" => $self->{term}->display_id, |
1598 | "-display" => $self->{term}->display_id, |
1536 | "-pe" => "urxvt-popup") |
1599 | "-pe" => "urxvt-popup") |
1537 | or die "unable to create popup window\n"; |
1600 | or die "unable to create popup window\n"; |
… | |
… | |
1590 | Start the timer. |
1653 | Start the timer. |
1591 | |
1654 | |
1592 | =item $timer = $timer->start ($tstamp) |
1655 | =item $timer = $timer->start ($tstamp) |
1593 | |
1656 | |
1594 | 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>. |
1595 | |
1662 | |
1596 | =item $timer = $timer->stop |
1663 | =item $timer = $timer->stop |
1597 | |
1664 | |
1598 | Stop the timer. |
1665 | Stop the timer. |
1599 | |
1666 | |