… | |
… | |
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 the following bindable keyboard command: |
50 | |
72 | |
51 | =over 4 |
73 | =over 4 |
52 | |
74 | |
53 | =item rot13 |
75 | =item rot13 |
54 | |
76 | |
… | |
… | |
70 | evalution, web-browser starting etc.), depending on content. |
92 | evalution, web-browser starting etc.), depending on content. |
71 | |
93 | |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
94 | =item searchable-scrollback<hotkey> (enabled by default) |
73 | |
95 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
96 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
97 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
98 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
99 | screen. |
77 | |
100 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
101 | 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 |
102 | 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> |
103 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
104 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
105 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
106 | additionally stores the first match in the current line into the primary |
|
|
107 | selection. |
82 | |
108 | |
83 | =item digital-clock |
109 | =item selection-autotransform |
84 | |
110 | |
85 | Displays a digital clock using the built-in overlay. |
111 | This selection allows you to do automatic transforms on a selection |
|
|
112 | whenever a selection is made. |
|
|
113 | |
|
|
114 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
115 | operator) that modify C<$_> as resources: |
|
|
116 | |
|
|
117 | URxvt.selection-autotransform.0: transform |
|
|
118 | URxvt.selection-autotransform.1: transform |
|
|
119 | ... |
|
|
120 | |
|
|
121 | For example, the following will transform selections of the form |
|
|
122 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
123 | $word>: |
|
|
124 | |
|
|
125 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
126 | |
|
|
127 | And this example matches the same,but replaces it with vi-commands you can |
|
|
128 | paste directly into your (vi :) editor: |
|
|
129 | |
|
|
130 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
131 | |
|
|
132 | Of course, this can be modified to suit your needs and your editor :) |
|
|
133 | |
|
|
134 | To expand the example above to typical perl error messages ("XXX at |
|
|
135 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
136 | |
|
|
137 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
138 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
139 | |
|
|
140 | The first line tells the selection code to treat the unchanging part of |
|
|
141 | every error message as a selection pattern, and the second line transforms |
|
|
142 | the message into vi commands to load the file. |
86 | |
143 | |
87 | =item mark-urls |
144 | =item mark-urls |
88 | |
145 | |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
146 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
90 | make them clickable. When clicked, the program specified in the resource |
147 | make them clickable. When middle-clicked, the program specified in the |
91 | C<urlLauncher> (default C<x-www-browser>) will be started. |
148 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
149 | the URL as first argument. |
92 | |
150 | |
93 | =item block-graphics-to-ascii |
151 | =item block-graphics-to-ascii |
94 | |
152 | |
95 | A not very useful example of filtering all text output to the terminal, |
153 | A not very useful example of filtering all text output to the terminal, |
96 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
154 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
97 | similar-looking ascii character. |
155 | similar-looking ascii character. |
|
|
156 | |
|
|
157 | =item digital-clock |
|
|
158 | |
|
|
159 | Displays a digital clock using the built-in overlay. |
98 | |
160 | |
99 | =item example-refresh-hooks |
161 | =item example-refresh-hooks |
100 | |
162 | |
101 | 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 |
102 | window. Illustrates overwriting the refresh callbacks to create your own |
164 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
230 | =item on_sel_extend $term |
292 | =item on_sel_extend $term |
231 | |
293 | |
232 | Called whenever the user tries to extend the selection (e.g. with a double |
294 | Called whenever the user tries to extend the selection (e.g. with a double |
233 | click) and is either supposed to return false (normal operation), or |
295 | click) and is either supposed to return false (normal operation), or |
234 | should extend the selection itelf and return true to suppress the built-in |
296 | should extend the selection itelf and return true to suppress the built-in |
235 | processing. |
297 | processing. This can happen multiple times, as long as the callback |
|
|
298 | returns true, it will be called on every further click by the user and is |
|
|
299 | supposed to enlarge the selection more and more, if possible. |
236 | |
300 | |
237 | See the F<selection> example extension. |
301 | See the F<selection> example extension. |
238 | |
302 | |
239 | =item on_view_change $term, $offset |
303 | =item on_view_change $term, $offset |
240 | |
304 | |
… | |
… | |
307 | |
371 | |
308 | Called whenever the user presses a key combination that has a |
372 | Called whenever the user presses a key combination that has a |
309 | C<perl:string> action bound to it (see description of the B<keysym> |
373 | C<perl:string> action bound to it (see description of the B<keysym> |
310 | resource in the @@RXVT_NAME@@(1) manpage). |
374 | resource in the @@RXVT_NAME@@(1) manpage). |
311 | |
375 | |
|
|
376 | =item on_x_event $term, $event |
|
|
377 | |
|
|
378 | Called on every X event received on the vt window (and possibly other |
|
|
379 | windows). Should only be used as a last resort. Most event structure |
|
|
380 | members are not passed. |
|
|
381 | |
312 | =item on_focus_in $term |
382 | =item on_focus_in $term |
313 | |
383 | |
314 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
384 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
315 | does focus in processing. |
385 | does focus in processing. |
316 | |
386 | |
… | |
… | |
426 | =item urxvt::CurrentTime |
496 | =item urxvt::CurrentTime |
427 | |
497 | |
428 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
498 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
429 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
499 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
430 | Button4Mask, Button5Mask, AnyModifier |
500 | Button4Mask, Button5Mask, AnyModifier |
|
|
501 | |
|
|
502 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
503 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
504 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
505 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
506 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
507 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
508 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
509 | |
|
|
510 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
511 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
512 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
513 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
514 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
515 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
516 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
431 | |
517 | |
432 | Various constants for use in X calls and event processing. |
518 | Various constants for use in X calls and event processing. |
433 | |
519 | |
434 | =back |
520 | =back |
435 | |
521 | |
… | |
… | |
496 | $msg .= "\n" |
582 | $msg .= "\n" |
497 | unless $msg =~ /\n$/; |
583 | unless $msg =~ /\n$/; |
498 | urxvt::warn ($msg); |
584 | urxvt::warn ($msg); |
499 | }; |
585 | }; |
500 | |
586 | |
|
|
587 | # %ENV is the original startup environment |
501 | delete $ENV{IFS}; |
588 | delete $ENV{IFS}; |
502 | delete $ENV{CDPATH}; |
589 | delete $ENV{CDPATH}; |
503 | delete $ENV{BASH_ENV}; |
590 | delete $ENV{BASH_ENV}; |
504 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
591 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
505 | } |
592 | } |
506 | |
593 | |
507 | my @hook_count; |
|
|
508 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
594 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
509 | |
595 | |
510 | sub verbose { |
596 | sub verbose { |
511 | my ($level, $msg) = @_; |
597 | my ($level, $msg) = @_; |
512 | warn "$msg\n" if $level <= $verbosity; |
598 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
594 | if ($@) { |
680 | if ($@) { |
595 | $TERM->ungrab; # better to lose the grab than the session |
681 | $TERM->ungrab; # better to lose the grab than the session |
596 | warn $@; |
682 | warn $@; |
597 | } |
683 | } |
598 | } |
684 | } |
|
|
685 | |
|
|
686 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
687 | if $verbosity >= 11; |
599 | } |
688 | } |
600 | |
689 | |
601 | if ($htype == 1) { # DESTROY |
690 | if ($htype == 1) { # DESTROY |
602 | if (my $hook = delete $TERM->{_hook}) { |
|
|
603 | for my $htype (0..$#$hook) { |
|
|
604 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
605 | or set_should_invoke $htype, 0; |
|
|
606 | } |
|
|
607 | } |
|
|
608 | |
|
|
609 | # clear package objects |
691 | # clear package objects |
610 | %$_ = () for values %{ $TERM->{_pkg} }; |
692 | %$_ = () for values %{ $TERM->{_pkg} }; |
611 | |
693 | |
612 | # clear package |
694 | # clear package |
613 | %$TERM = (); |
695 | %$TERM = (); |
614 | } |
696 | } |
615 | |
697 | |
616 | $retval |
698 | $retval |
|
|
699 | } |
|
|
700 | |
|
|
701 | sub exec_async(@) { |
|
|
702 | my $pid = fork; |
|
|
703 | |
|
|
704 | return |
|
|
705 | if !defined $pid or $pid; |
|
|
706 | |
|
|
707 | %ENV = %{ $TERM->env }; |
|
|
708 | |
|
|
709 | exec @_; |
|
|
710 | _exit 255; |
617 | } |
711 | } |
618 | |
712 | |
619 | # urxvt::term::extension |
713 | # urxvt::term::extension |
620 | |
714 | |
621 | package urxvt::term::extension; |
715 | package urxvt::term::extension; |
… | |
… | |
627 | while (my ($name, $cb) = each %hook) { |
721 | while (my ($name, $cb) = each %hook) { |
628 | my $htype = $HOOKTYPE{uc $name}; |
722 | my $htype = $HOOKTYPE{uc $name}; |
629 | defined $htype |
723 | defined $htype |
630 | or Carp::croak "unsupported hook type '$name'"; |
724 | or Carp::croak "unsupported hook type '$name'"; |
631 | |
725 | |
|
|
726 | $self->set_should_invoke ($htype, +1) |
632 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
727 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
633 | $hook_count[$htype]++ |
|
|
634 | or urxvt::set_should_invoke $htype, 1; |
|
|
635 | } |
|
|
636 | |
728 | |
637 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
729 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
638 | } |
730 | } |
639 | } |
731 | } |
640 | |
732 | |
… | |
… | |
645 | for my $name (@hook) { |
737 | for my $name (@hook) { |
646 | my $htype = $HOOKTYPE{uc $name}; |
738 | my $htype = $HOOKTYPE{uc $name}; |
647 | defined $htype |
739 | defined $htype |
648 | or Carp::croak "unsupported hook type '$name'"; |
740 | or Carp::croak "unsupported hook type '$name'"; |
649 | |
741 | |
|
|
742 | $self->set_should_invoke ($htype, -1) |
650 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
743 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
651 | --$hook_count[$htype] |
|
|
652 | or urxvt::set_should_invoke $htype, 0; |
|
|
653 | } |
|
|
654 | } |
744 | } |
655 | } |
745 | } |
656 | |
746 | |
657 | our $AUTOLOAD; |
747 | our $AUTOLOAD; |
658 | |
748 | |
… | |
… | |
897 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
987 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
898 | |
988 | |
899 | Return the current values of the selection mark, begin or end positions, |
989 | Return the current values of the selection mark, begin or end positions, |
900 | and optionally set them to new values. |
990 | and optionally set them to new values. |
901 | |
991 | |
|
|
992 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
993 | |
|
|
994 | Tries to make a selection as set by C<selection_beg> and |
|
|
995 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
996 | rectangular selection will be made. This is the prefered function to make |
|
|
997 | a selection. |
|
|
998 | |
902 | =item $success = $term->selection_grab ($eventtime) |
999 | =item $success = $term->selection_grab ($eventtime) |
903 | |
1000 | |
904 | Try to request the primary selection from the server (for example, as set |
1001 | Try to request the primary selection text from the server (for example, as |
905 | by the next method). |
1002 | set by the next method). No visual feedback will be given. This function |
|
|
1003 | is mostly useful from within C<on_sel_grab> hooks. |
906 | |
1004 | |
907 | =item $oldtext = $term->selection ([$newtext]) |
1005 | =item $oldtext = $term->selection ([$newtext]) |
908 | |
1006 | |
909 | Return the current selection text and optionally replace it by C<$newtext>. |
1007 | Return the current selection text and optionally replace it by C<$newtext>. |
910 | |
1008 | |
… | |
… | |
1003 | Convert the given locale-encoded octets into a perl string. |
1101 | Convert the given locale-encoded octets into a perl string. |
1004 | |
1102 | |
1005 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1103 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1006 | |
1104 | |
1007 | XORs the rendition values in the given span with the provided value |
1105 | XORs the rendition values in the given span with the provided value |
1008 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
1106 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
1009 | to the selection. |
1107 | refresh hooks to provide effects similar to the selection. |
1010 | |
1108 | |
1011 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1109 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1012 | |
1110 | |
1013 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1111 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1014 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1112 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1015 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1113 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1016 | it instead. |
1114 | it instead. Both styles I<MUST NOT> contain font styles. |
1017 | |
1115 | |
1018 | =item $term->scr_bell |
1116 | =item $term->scr_bell |
1019 | |
1117 | |
1020 | Ring the bell! |
1118 | Ring the bell! |
1021 | |
1119 | |
… | |
… | |
1054 | Return the window id of the toplevel window. |
1152 | Return the window id of the toplevel window. |
1055 | |
1153 | |
1056 | =item $windowid = $term->vt |
1154 | =item $windowid = $term->vt |
1057 | |
1155 | |
1058 | Return the window id of the terminal window. |
1156 | Return the window id of the terminal window. |
|
|
1157 | |
|
|
1158 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1159 | |
|
|
1160 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1161 | to receive pointer events all the times: |
|
|
1162 | |
|
|
1163 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1059 | |
1164 | |
1060 | =item $window_width = $term->width |
1165 | =item $window_width = $term->width |
1061 | |
1166 | |
1062 | =item $window_height = $term->height |
1167 | =item $window_height = $term->height |
1063 | |
1168 | |
… | |
… | |
1205 | Return the row number of the first/last row of the line, respectively. |
1310 | Return the row number of the first/last row of the line, respectively. |
1206 | |
1311 | |
1207 | =item $offset = $line->offset_of ($row, $col) |
1312 | =item $offset = $line->offset_of ($row, $col) |
1208 | |
1313 | |
1209 | Returns the character offset of the given row|col pair within the logical |
1314 | Returns the character offset of the given row|col pair within the logical |
1210 | line. |
1315 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1316 | offsets outside the string. |
1211 | |
1317 | |
1212 | =item ($row, $col) = $line->coord_of ($offset) |
1318 | =item ($row, $col) = $line->coord_of ($offset) |
1213 | |
1319 | |
1214 | Translates a string offset into terminal coordinates again. |
1320 | Translates a string offset into terminal coordinates again. |
1215 | |
1321 | |
… | |
… | |
1570 | |
1676 | |
1571 | =item == 0 - fatal messages |
1677 | =item == 0 - fatal messages |
1572 | |
1678 | |
1573 | =item >= 3 - script loading and management |
1679 | =item >= 3 - script loading and management |
1574 | |
1680 | |
1575 | =item >=10 - all events received |
1681 | =item >=10 - all called hooks |
|
|
1682 | |
|
|
1683 | =item >=11 - hook reutrn values |
1576 | |
1684 | |
1577 | =back |
1685 | =back |
1578 | |
1686 | |
1579 | =head1 AUTHOR |
1687 | =head1 AUTHOR |
1580 | |
1688 | |