ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC

… …
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
45when the user extends selections (double-click). Right now, it tries to 45when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 46now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 47arguments, which is very convenient, too, if your F<ls> supports
48C<--quoting-style=shell>.
48 49
50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection.
52
53The selection works by trying to match a number of regexes and displaying
54them in increasing order of length. You can add your own regexes by
55specifying resources of the form:
56
57 URxvt.selection.pattern-0: perl-regex
58 URxvt.selection.pattern-1: perl-regex
59 ...
60
61The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything
64between two vertical bars:
65
66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end.
70
49It also offers the following bindable keyboard command: 71This 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
… …
70evalution, web-browser starting etc.), depending on content. 92evalution, 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
74Adds regex search functionality to the scrollback buffer, triggered 96Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 97by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 98input/output is suspended and a regex is displayed at the bottom of the
99screen.
77 100
78C</> starts an incremental regex search, C<n> searches further, C<p> or 101Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 102search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 103search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 104bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary
107selection.
82 108
83=item digital-clock 109=item selection-autotransform
84 110
85Displays a digital clock using the built-in overlay. 111This selection allows you to do automatic transforms on a selection
112whenever a selection is made.
113
114It works by specifying perl snippets (most useful is a single C<s///>
115operator) that modify C<$_> as resources:
116
117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform
119 ...
120
121For example, the following will transform selections of the form
122C<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
127And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor:
129
130 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132Of course, this can be modified to suit your needs and your editor :)
133
134To expand the example above to typical perl error messages ("XXX at
135FILENAME 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
140The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file.
86 143
87=item mark-urls 144=item mark-urls
88 145
89Uses per-line display filtering (C<on_line_update>) to underline urls. 146Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument.
90 150
91=item block-graphics-to-ascii 151=item block-graphics-to-ascii
92 152
93A not very useful example of filtering all text output to the terminal, 153A not very useful example of filtering all text output to the terminal,
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 154by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 155similar-looking ascii character.
156
157=item digital-clock
158
159Displays a digital clock using the built-in overlay.
96 160
97=item example-refresh-hooks 161=item example-refresh-hooks
98 162
99Displays a very simple digital clock in the upper right corner of the 163Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
… …
228=item on_sel_extend $term 292=item on_sel_extend $term
229 293
230Called whenever the user tries to extend the selection (e.g. with a double 294Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 295click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 296should extend the selection itelf and return true to suppress the built-in
233processing. 297processing. This can happen multiple times, as long as the callback
298returns true, it will be called on every further click by the user and is
299supposed to enlarge the selection more and more, if possible.
234 300
235See the F<selection> example extension. 301See the F<selection> example extension.
236 302
237=item on_view_change $term, $offset 303=item on_view_change $term, $offset
238 304
… …
494 $msg .= "\n" 560 $msg .= "\n"
495 unless $msg =~ /\n$/; 561 unless $msg =~ /\n$/;
496 urxvt::warn ($msg); 562 urxvt::warn ($msg);
497 }; 563 };
498 564
565 # %ENV is the original startup environment
499 delete $ENV{IFS}; 566 delete $ENV{IFS};
500 delete $ENV{CDPATH}; 567 delete $ENV{CDPATH};
501 delete $ENV{BASH_ENV}; 568 delete $ENV{BASH_ENV};
502 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 569 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
503} 570}
… …
592 if ($@) { 659 if ($@) {
593 $TERM->ungrab; # better to lose the grab than the session 660 $TERM->ungrab; # better to lose the grab than the session
594 warn $@; 661 warn $@;
595 } 662 }
596 } 663 }
664
665 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666 if $verbosity >= 11;
597 } 667 }
598 668
599 if ($htype == 1) { # DESTROY 669 if ($htype == 1) { # DESTROY
600 if (my $hook = delete $TERM->{_hook}) { 670 if (my $hook = delete $TERM->{_hook}) {
601 for my $htype (0..$#$hook) { 671 for my $htype (0..$#$hook) {
… …
610 # clear package 680 # clear package
611 %$TERM = (); 681 %$TERM = ();
612 } 682 }
613 683
614 $retval 684 $retval
685}
686
687sub exec_async(@) {
688 my $pid = fork;
689
690 return
691 if !defined $pid or $pid;
692
693 %ENV = %{ $TERM->env };
694
695 exec @_;
696 _exit 255;
615} 697}
616 698
617# urxvt::term::extension 699# urxvt::term::extension
618 700
619package urxvt::term::extension; 701package urxvt::term::extension;
… …
860 my ($self, $name) = (shift, shift); 942 my ($self, $name) = (shift, shift);
861 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 943 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
862 &urxvt::term::_resource 944 &urxvt::term::_resource
863} 945}
864 946
947=item $value = $term->x_resource ($pattern)
948
949Returns the X-Resource for the given pattern, excluding the program or
950class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
951same value as used by this instance of rxvt-unicode. Returns C<undef> if no
952resource with that pattern exists.
953
954This method should only be called during the C<on_start> hook, as there is
955only one resource database per display, and later invocations might return
956the wrong resources.
957
865=item $success = $term->parse_keysym ($keysym_spec, $command_string) 958=item $success = $term->parse_keysym ($keysym_spec, $command_string)
866 959
867Adds a keymap translation exactly as specified via a resource. See the 960Adds a keymap translation exactly as specified via a resource. See the
868C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 961C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
869 962
… …
884=item ($row, $col) = $term->selection_end ([$row, $col]) 977=item ($row, $col) = $term->selection_end ([$row, $col])
885 978
886Return the current values of the selection mark, begin or end positions, 979Return the current values of the selection mark, begin or end positions,
887and optionally set them to new values. 980and optionally set them to new values.
888 981
982=item $term->selection_make ($eventtime[, $rectangular])
983
984Tries to make a selection as set by C<selection_beg> and
985C<selection_end>. If C<$rectangular> is true (default: false), a
986rectangular selection will be made. This is the prefered function to make
987a selection.
988
889=item $success = $term->selection_grab ($eventtime) 989=item $success = $term->selection_grab ($eventtime)
890 990
891Try to request the primary selection from the server (for example, as set 991Try to request the primary selection text from the server (for example, as
892by the next method). 992set by the next method). No visual feedback will be given. This function
993is mostly useful from within C<on_sel_grab> hooks.
893 994
894=item $oldtext = $term->selection ([$newtext]) 995=item $oldtext = $term->selection ([$newtext])
895 996
896Return the current selection text and optionally replace it by C<$newtext>. 997Return the current selection text and optionally replace it by C<$newtext>.
897 998
… …
990Convert the given locale-encoded octets into a perl string. 1091Convert the given locale-encoded octets into a perl string.
991 1092
992=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1093=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
993 1094
994XORs the rendition values in the given span with the provided value 1095XORs the rendition values in the given span with the provided value
995(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1096(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
996to the selection. 1097refresh hooks to provide effects similar to the selection.
997 1098
998=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1099=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
999 1100
1000Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1101Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1001whitespace will additionally be xored with the C<$rstyle2>, which defaults 1102whitespace will additionally be xored with the C<$rstyle2>, which defaults
1002to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1103to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1003it instead. 1104it instead. Both styles I<MUST NOT> contain font styles.
1004 1105
1005=item $term->scr_bell 1106=item $term->scr_bell
1006 1107
1007Ring the bell! 1108Ring the bell!
1008 1109
… …
1192Return the row number of the first/last row of the line, respectively. 1293Return the row number of the first/last row of the line, respectively.
1193 1294
1194=item $offset = $line->offset_of ($row, $col) 1295=item $offset = $line->offset_of ($row, $col)
1195 1296
1196Returns the character offset of the given row|col pair within the logical 1297Returns the character offset of the given row|col pair within the logical
1197line. 1298line. Works for rows outside the line, too, and returns corresponding
1299offsets outside the string.
1198 1300
1199=item ($row, $col) = $line->coord_of ($offset) 1301=item ($row, $col) = $line->coord_of ($offset)
1200 1302
1201Translates a string offset into terminal coordinates again. 1303Translates a string offset into terminal coordinates again.
1202 1304
… …
1557 1659
1558=item == 0 - fatal messages 1660=item == 0 - fatal messages
1559 1661
1560=item >= 3 - script loading and management 1662=item >= 3 - script loading and management
1561 1663
1562=item >=10 - all events received 1664=item >=10 - all called hooks
1665
1666=item >=11 - hook reutrn values
1563 1667
1564=back 1668=back
1565 1669
1566=head1 AUTHOR 1670=head1 AUTHOR
1567 1671

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines