… | |
… | |
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 | |
… | |
… | |
120 | |
120 | |
121 | For example, the following will transform selections of the form |
121 | For example, the following will transform selections of the form |
122 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
122 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
123 | $word>: |
123 | $word>: |
124 | |
124 | |
125 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
125 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
126 | |
126 | |
127 | And this example matches the same,but replaces it with vi-commands you can |
127 | And this example matches the same,but replaces it with vi-commands you can |
128 | paste directly into your (vi :) editor: |
128 | paste directly into your (vi :) editor: |
129 | |
129 | |
130 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
130 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
131 | |
131 | |
132 | Of course, this can be modified to suit your needs and your editor :) |
132 | Of course, this can be modified to suit your needs and your editor :) |
133 | |
133 | |
134 | To expand the example above to typical perl error messages ("XXX at |
134 | To expand the example above to typical perl error messages ("XXX at |
135 | FILENAME line YYY."), you need a slightly more elaborate solution: |
135 | FILENAME line YYY."), you need a slightly more elaborate solution: |
… | |
… | |
161 | =item example-refresh-hooks |
161 | =item example-refresh-hooks |
162 | |
162 | |
163 | Displays a very simple digital clock in the upper right corner of the |
163 | Displays a very simple digital clock in the upper right corner of the |
164 | window. Illustrates overwriting the refresh callbacks to create your own |
164 | window. Illustrates overwriting the refresh callbacks to create your own |
165 | overlays or changes. |
165 | overlays or changes. |
|
|
166 | |
|
|
167 | =item selection-pastebin |
|
|
168 | |
|
|
169 | This is a little rarely useful extension that Uploads the selection as |
|
|
170 | textfile to a remote site (or does other things). (The implementation is |
|
|
171 | not currently secure for use in a multiuser environment as it writes to |
|
|
172 | F</tmp> directly.). |
|
|
173 | |
|
|
174 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
175 | i.e. |
|
|
176 | |
|
|
177 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
178 | |
|
|
179 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
180 | the textfile. This command can be set via a resource: |
|
|
181 | |
|
|
182 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
183 | |
|
|
184 | And the default is likely not useful to anybody but the few people around |
|
|
185 | here :) |
|
|
186 | |
|
|
187 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
188 | the same content should lead to the same filename. |
|
|
189 | |
|
|
190 | After a successful upload the selection will be replaced by the text given |
|
|
191 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
192 | for the filename): |
|
|
193 | |
|
|
194 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
166 | |
195 | |
167 | =back |
196 | =back |
168 | |
197 | |
169 | =head1 API DOCUMENTATION |
198 | =head1 API DOCUMENTATION |
170 | |
199 | |
… | |
… | |
371 | |
400 | |
372 | Called whenever the user presses a key combination that has a |
401 | 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> |
402 | C<perl:string> action bound to it (see description of the B<keysym> |
374 | resource in the @@RXVT_NAME@@(1) manpage). |
403 | resource in the @@RXVT_NAME@@(1) manpage). |
375 | |
404 | |
|
|
405 | =item on_x_event $term, $event |
|
|
406 | |
|
|
407 | Called on every X event received on the vt window (and possibly other |
|
|
408 | windows). Should only be used as a last resort. Most event structure |
|
|
409 | members are not passed. |
|
|
410 | |
376 | =item on_focus_in $term |
411 | =item on_focus_in $term |
377 | |
412 | |
378 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
413 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
379 | does focus in processing. |
414 | does focus in processing. |
380 | |
415 | |
… | |
… | |
475 | Using this function has the advantage that its output ends up in the |
510 | 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. |
511 | correct place, e.g. on stderr of the connecting urxvtc client. |
477 | |
512 | |
478 | Messages have a size limit of 1023 bytes currently. |
513 | Messages have a size limit of 1023 bytes currently. |
479 | |
514 | |
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 |
515 | =item $time = urxvt::NOW |
487 | |
516 | |
488 | Returns the "current time" (as per the event loop). |
517 | Returns the "current time" (as per the event loop). |
489 | |
518 | |
490 | =item urxvt::CurrentTime |
519 | =item urxvt::CurrentTime |
491 | |
520 | |
492 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
521 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
493 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
522 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
494 | Button4Mask, Button5Mask, AnyModifier |
523 | Button4Mask, Button5Mask, AnyModifier |
|
|
524 | |
|
|
525 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
526 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
527 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
528 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
529 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
530 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
531 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
532 | |
|
|
533 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
534 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
535 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
536 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
537 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
538 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
539 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
495 | |
540 | |
496 | Various constants for use in X calls and event processing. |
541 | Various constants for use in X calls and event processing. |
497 | |
542 | |
498 | =back |
543 | =back |
499 | |
544 | |
… | |
… | |
567 | delete $ENV{CDPATH}; |
612 | delete $ENV{CDPATH}; |
568 | delete $ENV{BASH_ENV}; |
613 | delete $ENV{BASH_ENV}; |
569 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
614 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
570 | } |
615 | } |
571 | |
616 | |
572 | my @hook_count; |
|
|
573 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
617 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
574 | |
618 | |
575 | sub verbose { |
619 | sub verbose { |
576 | my ($level, $msg) = @_; |
620 | my ($level, $msg) = @_; |
577 | warn "$msg\n" if $level <= $verbosity; |
621 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
590 | verbose 3, "loading extension '$path' into package '$pkg'"; |
634 | verbose 3, "loading extension '$path' into package '$pkg'"; |
591 | |
635 | |
592 | open my $fh, "<:raw", $path |
636 | open my $fh, "<:raw", $path |
593 | or die "$path: $!"; |
637 | or die "$path: $!"; |
594 | |
638 | |
595 | my $source = untaint |
639 | my $source = |
596 | "package $pkg; use strict; use utf8;\n" |
640 | "package $pkg; use strict; use utf8;\n" |
597 | . "use base urxvt::term::extension::;\n" |
641 | . "use base urxvt::term::extension::;\n" |
598 | . "#line 1 \"$path\"\n{\n" |
642 | . "#line 1 \"$path\"\n{\n" |
599 | . (do { local $/; <$fh> }) |
643 | . (do { local $/; <$fh> }) |
600 | . "\n};\n1"; |
644 | . "\n};\n1"; |
… | |
… | |
665 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
709 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
666 | if $verbosity >= 11; |
710 | if $verbosity >= 11; |
667 | } |
711 | } |
668 | |
712 | |
669 | if ($htype == 1) { # DESTROY |
713 | 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 |
714 | # clear package objects |
678 | %$_ = () for values %{ $TERM->{_pkg} }; |
715 | %$_ = () for values %{ $TERM->{_pkg} }; |
679 | |
716 | |
680 | # clear package |
717 | # clear package |
681 | %$TERM = (); |
718 | %$TERM = (); |
… | |
… | |
707 | while (my ($name, $cb) = each %hook) { |
744 | while (my ($name, $cb) = each %hook) { |
708 | my $htype = $HOOKTYPE{uc $name}; |
745 | my $htype = $HOOKTYPE{uc $name}; |
709 | defined $htype |
746 | defined $htype |
710 | or Carp::croak "unsupported hook type '$name'"; |
747 | or Carp::croak "unsupported hook type '$name'"; |
711 | |
748 | |
|
|
749 | $self->set_should_invoke ($htype, +1) |
712 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
750 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
713 | $hook_count[$htype]++ |
|
|
714 | or urxvt::set_should_invoke $htype, 1; |
|
|
715 | } |
|
|
716 | |
751 | |
717 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
752 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
718 | } |
753 | } |
719 | } |
754 | } |
720 | |
755 | |
… | |
… | |
725 | for my $name (@hook) { |
760 | for my $name (@hook) { |
726 | my $htype = $HOOKTYPE{uc $name}; |
761 | my $htype = $HOOKTYPE{uc $name}; |
727 | defined $htype |
762 | defined $htype |
728 | or Carp::croak "unsupported hook type '$name'"; |
763 | or Carp::croak "unsupported hook type '$name'"; |
729 | |
764 | |
|
|
765 | $self->set_should_invoke ($htype, -1) |
730 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
766 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
731 | --$hook_count[$htype] |
|
|
732 | or urxvt::set_should_invoke $htype, 0; |
|
|
733 | } |
|
|
734 | } |
767 | } |
735 | } |
768 | } |
736 | |
769 | |
737 | our $AUTOLOAD; |
770 | our $AUTOLOAD; |
738 | |
771 | |
… | |
… | |
1143 | |
1176 | |
1144 | =item $windowid = $term->vt |
1177 | =item $windowid = $term->vt |
1145 | |
1178 | |
1146 | Return the window id of the terminal window. |
1179 | Return the window id of the terminal window. |
1147 | |
1180 | |
|
|
1181 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1182 | |
|
|
1183 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1184 | to receive pointer events all the times: |
|
|
1185 | |
|
|
1186 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1187 | |
1148 | =item $window_width = $term->width |
1188 | =item $window_width = $term->width |
1149 | |
1189 | |
1150 | =item $window_height = $term->height |
1190 | =item $window_height = $term->height |
1151 | |
1191 | |
1152 | =item $font_width = $term->fwidth |
1192 | =item $font_width = $term->fwidth |
… | |
… | |
1165 | |
1205 | |
1166 | =item $max_scrollback = $term->saveLines |
1206 | =item $max_scrollback = $term->saveLines |
1167 | |
1207 | |
1168 | =item $nrow_plus_saveLines = $term->total_rows |
1208 | =item $nrow_plus_saveLines = $term->total_rows |
1169 | |
1209 | |
1170 | =item $lines_in_scrollback = $term->nsaved |
1210 | =item $topmost_scrollback_row = $term->top_row |
1171 | |
1211 | |
1172 | Return various integers describing terminal characteristics. |
1212 | Return various integers describing terminal characteristics. |
1173 | |
1213 | |
1174 | =item $x_display = $term->display_id |
1214 | =item $x_display = $term->display_id |
1175 | |
1215 | |
… | |
… | |
1203 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1243 | 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. |
1244 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1205 | |
1245 | |
1206 | =item $view_start = $term->view_start ([$newvalue]) |
1246 | =item $view_start = $term->view_start ([$newvalue]) |
1207 | |
1247 | |
1208 | Returns the negative row number of the topmost line. Minimum value is |
1248 | Returns the row number of the topmost displayed line. Maximum value is |
1209 | C<0>, which displays the normal terminal contents. Larger values scroll |
1249 | C<0>, which displays the normal terminal contents. Lower values scroll |
1210 | this many lines into the scrollback buffer. |
1250 | this many lines into the scrollback buffer. |
1211 | |
1251 | |
1212 | =item $term->want_refresh |
1252 | =item $term->want_refresh |
1213 | |
1253 | |
1214 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1254 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |