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.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC

… …
48C<--quoting-style=shell>. 48C<--quoting-style=shell>.
49 49
50A double-click usually selects the word under the cursor, further clicks 50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection. 51will enlarge the selection.
52 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
53It also offers the following bindable keyboard command: 71This extension also offers following bindable keyboard commands:
54 72
55=over 4 73=over 4
56 74
57=item rot13 75=item rot13
58 76
… …
86bottom. C<Escape> leaves search mode and returns to the point where search 104bottom. C<Escape> leaves search mode and returns to the point where search
87was started, while C<Enter> or C<Return> stay at the current position and 105was started, while C<Enter> or C<Return> stay at the current position and
88additionally stores the first match in the current line into the primary 106additionally stores the first match in the current line into the primary
89selection. 107selection.
90 108
91=item digital-clock 109=item selection-autotransform
92 110
93Displays 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.
94 143
95=item mark-urls 144=item mark-urls
96 145
97Uses 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
98make them clickable. When middle-clicked, the program specified in the 147make them clickable. When middle-clicked, the program specified in the
… …
103 152
104A 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,
105by replacing all line-drawing characters (U+2500 .. U+259F) by a 154by replacing all line-drawing characters (U+2500 .. U+259F) by a
106similar-looking ascii character. 155similar-looking ascii character.
107 156
157=item digital-clock
158
159Displays a digital clock using the built-in overlay.
160
108=item example-refresh-hooks 161=item example-refresh-hooks
109 162
110Displays 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
111window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
112overlays 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).
171
172It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173i.e.
174
175 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
176
177Pressing this combination runs a command with C<%> replaced by the name of
178the textfile. This command can be set via a resource:
179
180 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
181
182And the default is likely not useful to anybody but the few people around
183here :)
184
185The name of the textfile is the hex encoded md5 sum of the selection, so
186the same content should lead to the same filename.
187
188After a successful upload the selection will be replaced by the text given
189in the C<selection-pastebin-url> resource (again, the % is the placeholder
190for the filename):
191
192 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
113 193
114=back 194=back
115 195
116=head1 API DOCUMENTATION 196=head1 API DOCUMENTATION
117 197
… …
318 398
319Called whenever the user presses a key combination that has a 399Called whenever the user presses a key combination that has a
320C<perl:string> action bound to it (see description of the B<keysym> 400C<perl:string> action bound to it (see description of the B<keysym>
321resource in the @@RXVT_NAME@@(1) manpage). 401resource in the @@RXVT_NAME@@(1) manpage).
322 402
403=item on_x_event $term, $event
404
405Called on every X event received on the vt window (and possibly other
406windows). Should only be used as a last resort. Most event structure
407members are not passed.
408
323=item on_focus_in $term 409=item on_focus_in $term
324 410
325Called whenever the window gets the keyboard focus, before rxvt-unicode 411Called whenever the window gets the keyboard focus, before rxvt-unicode
326does focus in processing. 412does focus in processing.
327 413
… …
422Using this function has the advantage that its output ends up in the 508Using this function has the advantage that its output ends up in the
423correct place, e.g. on stderr of the connecting urxvtc client. 509correct place, e.g. on stderr of the connecting urxvtc client.
424 510
425Messages have a size limit of 1023 bytes currently. 511Messages have a size limit of 1023 bytes currently.
426 512
427=item $is_safe = urxvt::safe
428
429Returns true when it is safe to do potentially unsafe things, such as
430evaluating perl code specified by the user. This is true when urxvt was
431started setuid or setgid.
432
433=item $time = urxvt::NOW 513=item $time = urxvt::NOW
434 514
435Returns the "current time" (as per the event loop). 515Returns the "current time" (as per the event loop).
436 516
437=item urxvt::CurrentTime 517=item urxvt::CurrentTime
438 518
439=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 519=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 520Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441Button4Mask, Button5Mask, AnyModifier 521Button4Mask, Button5Mask, AnyModifier
522
523=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
524ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
525PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
526Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
527KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
528ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
529FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
530
531=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
532EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
533GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
534UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
535ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
536CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
537SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
442 538
443Various constants for use in X calls and event processing. 539Various constants for use in X calls and event processing.
444 540
445=back 541=back
446 542
… …
514 delete $ENV{CDPATH}; 610 delete $ENV{CDPATH};
515 delete $ENV{BASH_ENV}; 611 delete $ENV{BASH_ENV};
516 $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";
517} 613}
518 614
519my @hook_count;
520my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 615my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521 616
522sub verbose { 617sub verbose {
523 my ($level, $msg) = @_; 618 my ($level, $msg) = @_;
524 warn "$msg\n" if $level <= $verbosity; 619 warn "$msg\n" if $level <= $verbosity;
… …
537 verbose 3, "loading extension '$path' into package '$pkg'"; 632 verbose 3, "loading extension '$path' into package '$pkg'";
538 633
539 open my $fh, "<:raw", $path 634 open my $fh, "<:raw", $path
540 or die "$path: $!"; 635 or die "$path: $!";
541 636
542 my $source = untaint 637 my $source =
543 "package $pkg; use strict; use utf8;\n" 638 "package $pkg; use strict; use utf8;\n"
544 . "use base urxvt::term::extension::;\n" 639 . "use base urxvt::term::extension::;\n"
545 . "#line 1 \"$path\"\n{\n" 640 . "#line 1 \"$path\"\n{\n"
546 . (do { local $/; <$fh> }) 641 . (do { local $/; <$fh> })
547 . "\n};\n1"; 642 . "\n};\n1";
… …
612 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 707 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613 if $verbosity >= 11; 708 if $verbosity >= 11;
614 } 709 }
615 710
616 if ($htype == 1) { # DESTROY 711 if ($htype == 1) { # DESTROY
617 if (my $hook = delete $TERM->{_hook}) {
618 for my $htype (0..$#$hook) {
619 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
620 or set_should_invoke $htype, 0;
621 }
622 }
623
624 # clear package objects 712 # clear package objects
625 %$_ = () for values %{ $TERM->{_pkg} }; 713 %$_ = () for values %{ $TERM->{_pkg} };
626 714
627 # clear package 715 # clear package
628 %$TERM = (); 716 %$TERM = ();
… …
654 while (my ($name, $cb) = each %hook) { 742 while (my ($name, $cb) = each %hook) {
655 my $htype = $HOOKTYPE{uc $name}; 743 my $htype = $HOOKTYPE{uc $name};
656 defined $htype 744 defined $htype
657 or Carp::croak "unsupported hook type '$name'"; 745 or Carp::croak "unsupported hook type '$name'";
658 746
747 $self->set_should_invoke ($htype, +1)
659 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 748 unless exists $self->{term}{_hook}[$htype]{$pkg};
660 $hook_count[$htype]++
661 or urxvt::set_should_invoke $htype, 1;
662 }
663 749
664 $self->{term}{_hook}[$htype]{$pkg} = $cb; 750 $self->{term}{_hook}[$htype]{$pkg} = $cb;
665 } 751 }
666} 752}
667 753
… …
672 for my $name (@hook) { 758 for my $name (@hook) {
673 my $htype = $HOOKTYPE{uc $name}; 759 my $htype = $HOOKTYPE{uc $name};
674 defined $htype 760 defined $htype
675 or Carp::croak "unsupported hook type '$name'"; 761 or Carp::croak "unsupported hook type '$name'";
676 762
763 $self->set_should_invoke ($htype, -1)
677 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 764 if delete $self->{term}{_hook}[$htype]{$pkg};
678 --$hook_count[$htype]
679 or urxvt::set_should_invoke $htype, 0;
680 }
681 } 765 }
682} 766}
683 767
684our $AUTOLOAD; 768our $AUTOLOAD;
685 769
… …
1090 1174
1091=item $windowid = $term->vt 1175=item $windowid = $term->vt
1092 1176
1093Return the window id of the terminal window. 1177Return the window id of the terminal window.
1094 1178
1179=item $term->vt_emask_add ($x_event_mask)
1180
1181Adds the specified events to the vt event mask. Useful e.g. when you want
1182to receive pointer events all the times:
1183
1184 $term->vt_emask_add (urxvt::PointerMotionMask);
1185
1095=item $window_width = $term->width 1186=item $window_width = $term->width
1096 1187
1097=item $window_height = $term->height 1188=item $window_height = $term->height
1098 1189
1099=item $font_width = $term->fwidth 1190=item $font_width = $term->fwidth
… …
1112 1203
1113=item $max_scrollback = $term->saveLines 1204=item $max_scrollback = $term->saveLines
1114 1205
1115=item $nrow_plus_saveLines = $term->total_rows 1206=item $nrow_plus_saveLines = $term->total_rows
1116 1207
1117=item $lines_in_scrollback = $term->nsaved 1208=item $topmost_scrollback_row = $term->top_row
1118 1209
1119Return various integers describing terminal characteristics. 1210Return various integers describing terminal characteristics.
1120 1211
1121=item $x_display = $term->display_id 1212=item $x_display = $term->display_id
1122 1213
… …
1150Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1241Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151AltGr), the meta key (often Alt) and the num lock key, if applicable. 1242AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152 1243
1153=item $view_start = $term->view_start ([$newvalue]) 1244=item $view_start = $term->view_start ([$newvalue])
1154 1245
1155Returns the negative row number of the topmost line. Minimum value is 1246Returns the row number of the topmost displayed line. Maximum value is
1156C<0>, which displays the normal terminal contents. Larger values scroll 1247C<0>, which displays the normal terminal contents. Lower values scroll
1157this many lines into the scrollback buffer. 1248this many lines into the scrollback buffer.
1158 1249
1159=item $term->want_refresh 1250=item $term->want_refresh
1160 1251
1161Requests a screen refresh. At the next opportunity, rxvt-unicode will 1252Requests a screen refresh. At the next opportunity, rxvt-unicode will

Diff Legend

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