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.83 by root, Thu Jan 12 01:38:37 2006 UTC vs.
Revision 1.100 by root, Wed Jan 18 08:33:34 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 following bindable keyboard commands:
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/^([^:[:space:]]+):(\\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/^([^:[:space:]]+(\\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 and 146Uses per-line display filtering (C<on_line_update>) to underline urls and
90make them clickable. When middle-clicked, the program specified in the 147make them clickable. When middle-clicked, the program specified in the
91resource C<urlLauncher> (default C<x-www-browser>) will be started. 148resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument.
92 150
93=item block-graphics-to-ascii 151=item block-graphics-to-ascii
94 152
95A 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,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 154by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 155similar-looking ascii character.
98 156
157=item digital-clock
158
159Displays a digital clock using the built-in overlay.
160
99=item example-refresh-hooks 161=item example-refresh-hooks
100 162
101Displays 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
102window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
103overlays or changes. 165overlays or changes.
166
167=item selection-pastebin
168
169This is a little rarely useful extension that Uploads the selection as
170textfile to a remote site (or does other things). (The implementation is
171not currently secure for use in a multiuser environment as it writes to
172F</tmp> directly.).
173
174It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
175i.e.
176
177 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
178
179Pressing this combination runs a command with C<%> replaced by the name of
180the 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
184And the default is likely not useful to anybody but the few people around
185here :)
186
187The name of the textfile is the hex encoded md5 sum of the selection, so
188the same content should lead to the same filename.
189
190After a successful upload the selection will be replaced by the text given
191in the C<selection-pastebin-url> resource (again, the % is the placeholder
192for the filename):
193
194 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
104 195
105=back 196=back
106 197
107=head1 API DOCUMENTATION 198=head1 API DOCUMENTATION
108 199
… …
230=item on_sel_extend $term 321=item on_sel_extend $term
231 322
232Called whenever the user tries to extend the selection (e.g. with a double 323Called whenever the user tries to extend the selection (e.g. with a double
233click) and is either supposed to return false (normal operation), or 324click) and is either supposed to return false (normal operation), or
234should extend the selection itelf and return true to suppress the built-in 325should extend the selection itelf and return true to suppress the built-in
235processing. 326processing. This can happen multiple times, as long as the callback
327returns true, it will be called on every further click by the user and is
328supposed to enlarge the selection more and more, if possible.
236 329
237See the F<selection> example extension. 330See the F<selection> example extension.
238 331
239=item on_view_change $term, $offset 332=item on_view_change $term, $offset
240 333
… …
307 400
308Called whenever the user presses a key combination that has a 401Called whenever the user presses a key combination that has a
309C<perl:string> action bound to it (see description of the B<keysym> 402C<perl:string> action bound to it (see description of the B<keysym>
310resource in the @@RXVT_NAME@@(1) manpage). 403resource in the @@RXVT_NAME@@(1) manpage).
311 404
405=item on_x_event $term, $event
406
407Called on every X event received on the vt window (and possibly other
408windows). Should only be used as a last resort. Most event structure
409members are not passed.
410
312=item on_focus_in $term 411=item on_focus_in $term
313 412
314Called whenever the window gets the keyboard focus, before rxvt-unicode 413Called whenever the window gets the keyboard focus, before rxvt-unicode
315does focus in processing. 414does focus in processing.
316 415
… …
411Using this function has the advantage that its output ends up in the 510Using this function has the advantage that its output ends up in the
412correct place, e.g. on stderr of the connecting urxvtc client. 511correct place, e.g. on stderr of the connecting urxvtc client.
413 512
414Messages have a size limit of 1023 bytes currently. 513Messages have a size limit of 1023 bytes currently.
415 514
416=item $is_safe = urxvt::safe
417
418Returns true when it is safe to do potentially unsafe things, such as
419evaluating perl code specified by the user. This is true when urxvt was
420started setuid or setgid.
421
422=item $time = urxvt::NOW 515=item $time = urxvt::NOW
423 516
424Returns the "current time" (as per the event loop). 517Returns the "current time" (as per the event loop).
425 518
426=item urxvt::CurrentTime 519=item urxvt::CurrentTime
427 520
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 521=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 522Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier 523Button4Mask, Button5Mask, AnyModifier
524
525=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
526ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
527PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
528Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
529KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
530ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
531FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
532
533=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
534EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
535GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
536UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
537ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
538CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
539SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431 540
432Various constants for use in X calls and event processing. 541Various constants for use in X calls and event processing.
433 542
434=back 543=back
435 544
… …
486=back 595=back
487 596
488=cut 597=cut
489 598
490BEGIN { 599BEGIN {
491 urxvt->bootstrap;
492
493 # overwrite perl's warn 600 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub { 601 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_; 602 my $msg = join "", @_;
496 $msg .= "\n" 603 $msg .= "\n"
497 unless $msg =~ /\n$/; 604 unless $msg =~ /\n$/;
… …
503 delete $ENV{CDPATH}; 610 delete $ENV{CDPATH};
504 delete $ENV{BASH_ENV}; 611 delete $ENV{BASH_ENV};
505 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 612 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506} 613}
507 614
508my @hook_count;
509my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 615my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510 616
511sub verbose { 617sub verbose {
512 my ($level, $msg) = @_; 618 my ($level, $msg) = @_;
513 warn "$msg\n" if $level <= $verbosity; 619 warn "$msg\n" if $level <= $verbosity;
514} 620}
515 621
516my $extension_pkg = "extension0000";
517my %extension_pkg; 622my %extension_pkg;
518 623
519# load a single script into its own package, once only 624# load a single script into its own package, once only
520sub extension_package($) { 625sub extension_package($) {
521 my ($path) = @_; 626 my ($path) = @_;
522 627
628 no strict 'refs';
629
523 $extension_pkg{$path} ||= do { 630 $extension_pkg{$path} ||= do {
524 my $pkg = "urxvt::" . ($extension_pkg++); 631 $path =~ /([^\/\\]+)$/;
632 my $pkg = $1;
633 $pkg =~ s/[^[:word:]]/_/g;
634 $pkg = "urxvt::ext::$pkg";
525 635
526 verbose 3, "loading extension '$path' into package '$pkg'"; 636 verbose 3, "loading extension '$path' into package '$pkg'";
527 637
528 open my $fh, "<:raw", $path 638 open my $fh, "<:raw", $path
529 or die "$path: $!"; 639 or die "$path: $!";
530 640
641 @{"$pkg\::ISA"} = urxvt::term::extension::;
642
531 my $source = untaint 643 my $source =
532 "package $pkg; use strict; use utf8;\n" 644 "package $pkg; use strict; use utf8;\n"
533 . "use base urxvt::term::extension::;\n"
534 . "#line 1 \"$path\"\n{\n" 645 . "#line 1 \"$path\"\n{\n"
535 . (do { local $/; <$fh> }) 646 . (do { local $/; <$fh> })
536 . "\n};\n1"; 647 . "\n};\n1";
537 648
538 eval $source 649 eval $source
… …
595 if ($@) { 706 if ($@) {
596 $TERM->ungrab; # better to lose the grab than the session 707 $TERM->ungrab; # better to lose the grab than the session
597 warn $@; 708 warn $@;
598 } 709 }
599 } 710 }
711
712 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
713 if $verbosity >= 11;
600 } 714 }
601 715
602 if ($htype == 1) { # DESTROY 716 if ($htype == 1) { # DESTROY
603 if (my $hook = delete $TERM->{_hook}) {
604 for my $htype (0..$#$hook) {
605 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
606 or set_should_invoke $htype, 0;
607 }
608 }
609
610 # clear package objects 717 # clear package objects
611 %$_ = () for values %{ $TERM->{_pkg} }; 718 %$_ = () for values %{ $TERM->{_pkg} };
612 719
613 # clear package 720 # clear package
614 %$TERM = (); 721 %$TERM = ();
615 } 722 }
616 723
617 $retval 724 $retval
725}
726
727sub exec_async(@) {
728 my $pid = fork;
729
730 return
731 if !defined $pid or $pid;
732
733 %ENV = %{ $TERM->env };
734
735 exec @_;
736 _exit 255;
618} 737}
619 738
620# urxvt::term::extension 739# urxvt::term::extension
621 740
622package urxvt::term::extension; 741package urxvt::term::extension;
… …
628 while (my ($name, $cb) = each %hook) { 747 while (my ($name, $cb) = each %hook) {
629 my $htype = $HOOKTYPE{uc $name}; 748 my $htype = $HOOKTYPE{uc $name};
630 defined $htype 749 defined $htype
631 or Carp::croak "unsupported hook type '$name'"; 750 or Carp::croak "unsupported hook type '$name'";
632 751
752 $self->set_should_invoke ($htype, +1)
633 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 753 unless exists $self->{term}{_hook}[$htype]{$pkg};
634 $hook_count[$htype]++
635 or urxvt::set_should_invoke $htype, 1;
636 }
637 754
638 $self->{term}{_hook}[$htype]{$pkg} = $cb; 755 $self->{term}{_hook}[$htype]{$pkg} = $cb;
639 } 756 }
640} 757}
641 758
… …
646 for my $name (@hook) { 763 for my $name (@hook) {
647 my $htype = $HOOKTYPE{uc $name}; 764 my $htype = $HOOKTYPE{uc $name};
648 defined $htype 765 defined $htype
649 or Carp::croak "unsupported hook type '$name'"; 766 or Carp::croak "unsupported hook type '$name'";
650 767
768 $self->set_should_invoke ($htype, -1)
651 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 769 if delete $self->{term}{_hook}[$htype]{$pkg};
652 --$hook_count[$htype]
653 or urxvt::set_should_invoke $htype, 0;
654 }
655 } 770 }
656} 771}
657 772
658our $AUTOLOAD; 773our $AUTOLOAD;
659 774
… …
898=item ($row, $col) = $term->selection_end ([$row, $col]) 1013=item ($row, $col) = $term->selection_end ([$row, $col])
899 1014
900Return the current values of the selection mark, begin or end positions, 1015Return the current values of the selection mark, begin or end positions,
901and optionally set them to new values. 1016and optionally set them to new values.
902 1017
1018=item $term->selection_make ($eventtime[, $rectangular])
1019
1020Tries to make a selection as set by C<selection_beg> and
1021C<selection_end>. If C<$rectangular> is true (default: false), a
1022rectangular selection will be made. This is the prefered function to make
1023a selection.
1024
903=item $success = $term->selection_grab ($eventtime) 1025=item $success = $term->selection_grab ($eventtime)
904 1026
905Try to request the primary selection from the server (for example, as set 1027Try to request the primary selection text from the server (for example, as
906by the next method). 1028set by the next method). No visual feedback will be given. This function
1029is mostly useful from within C<on_sel_grab> hooks.
907 1030
908=item $oldtext = $term->selection ([$newtext]) 1031=item $oldtext = $term->selection ([$newtext])
909 1032
910Return the current selection text and optionally replace it by C<$newtext>. 1033Return the current selection text and optionally replace it by C<$newtext>.
911 1034
… …
1004Convert the given locale-encoded octets into a perl string. 1127Convert the given locale-encoded octets into a perl string.
1005 1128
1006=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1129=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007 1130
1008XORs the rendition values in the given span with the provided value 1131XORs the rendition values in the given span with the provided value
1009(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1132(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1010to the selection. 1133refresh hooks to provide effects similar to the selection.
1011 1134
1012=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1135=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013 1136
1014Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1137Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015whitespace will additionally be xored with the C<$rstyle2>, which defaults 1138whitespace will additionally be xored with the C<$rstyle2>, which defaults
1016to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1139to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1017it instead. 1140it instead. Both styles I<MUST NOT> contain font styles.
1018 1141
1019=item $term->scr_bell 1142=item $term->scr_bell
1020 1143
1021Ring the bell! 1144Ring the bell!
1022 1145
… …
1056 1179
1057=item $windowid = $term->vt 1180=item $windowid = $term->vt
1058 1181
1059Return the window id of the terminal window. 1182Return the window id of the terminal window.
1060 1183
1184=item $term->vt_emask_add ($x_event_mask)
1185
1186Adds the specified events to the vt event mask. Useful e.g. when you want
1187to receive pointer events all the times:
1188
1189 $term->vt_emask_add (urxvt::PointerMotionMask);
1190
1061=item $window_width = $term->width 1191=item $window_width = $term->width
1062 1192
1063=item $window_height = $term->height 1193=item $window_height = $term->height
1064 1194
1065=item $font_width = $term->fwidth 1195=item $font_width = $term->fwidth
… …
1078 1208
1079=item $max_scrollback = $term->saveLines 1209=item $max_scrollback = $term->saveLines
1080 1210
1081=item $nrow_plus_saveLines = $term->total_rows 1211=item $nrow_plus_saveLines = $term->total_rows
1082 1212
1083=item $lines_in_scrollback = $term->nsaved 1213=item $topmost_scrollback_row = $term->top_row
1084 1214
1085Return various integers describing terminal characteristics. 1215Return various integers describing terminal characteristics.
1086 1216
1087=item $x_display = $term->display_id 1217=item $x_display = $term->display_id
1088 1218
… …
1116Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1246Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1117AltGr), the meta key (often Alt) and the num lock key, if applicable. 1247AltGr), the meta key (often Alt) and the num lock key, if applicable.
1118 1248
1119=item $view_start = $term->view_start ([$newvalue]) 1249=item $view_start = $term->view_start ([$newvalue])
1120 1250
1121Returns the negative row number of the topmost line. Minimum value is 1251Returns the row number of the topmost displayed line. Maximum value is
1122C<0>, which displays the normal terminal contents. Larger values scroll 1252C<0>, which displays the normal terminal contents. Lower values scroll
1123this many lines into the scrollback buffer. 1253this many lines into the scrollback buffer.
1124 1254
1125=item $term->want_refresh 1255=item $term->want_refresh
1126 1256
1127Requests a screen refresh. At the next opportunity, rxvt-unicode will 1257Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1206Return the row number of the first/last row of the line, respectively. 1336Return the row number of the first/last row of the line, respectively.
1207 1337
1208=item $offset = $line->offset_of ($row, $col) 1338=item $offset = $line->offset_of ($row, $col)
1209 1339
1210Returns the character offset of the given row|col pair within the logical 1340Returns the character offset of the given row|col pair within the logical
1211line. 1341line. Works for rows outside the line, too, and returns corresponding
1342offsets outside the string.
1212 1343
1213=item ($row, $col) = $line->coord_of ($offset) 1344=item ($row, $col) = $line->coord_of ($offset)
1214 1345
1215Translates a string offset into terminal coordinates again. 1346Translates a string offset into terminal coordinates again.
1216 1347
… …
1571 1702
1572=item == 0 - fatal messages 1703=item == 0 - fatal messages
1573 1704
1574=item >= 3 - script loading and management 1705=item >= 3 - script loading and management
1575 1706
1576=item >=10 - all events received 1707=item >=10 - all called hooks
1708
1709=item >=11 - hook reutrn values
1577 1710
1578=back 1711=back
1579 1712
1580=head1 AUTHOR 1713=head1 AUTHOR
1581 1714

Diff Legend

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