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.95 by elmex, Tue Jan 17 13:19:45 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
59Rot-13 the selection when activated. Used via keyboard trigger: 77Rot-13 the selection when activated. Used via keyboard trigger:
60 78
61 URxvt.keysym.C-M-r: perl:selection:rot13 79 URxvt.keysym.C-M-r: perl:selection:rot13
80
81=item remote-pastebin
82
83Upload the selection as textfile to a remote site.
84
85 URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87To set the command to upload the file set this resource:
88
89 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92md5 sum of the selection.
93After an successful upload the selection will be replaced by the following url
94(the % is the placeholder for the filename):
95
96 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
62 97
63=back 98=back
64 99
65=item option-popup (enabled by default) 100=item option-popup (enabled by default)
66 101
… …
86bottom. C<Escape> leaves search mode and returns to the point where search 121bottom. 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 122was 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 123additionally stores the first match in the current line into the primary
89selection. 124selection.
90 125
91=item digital-clock 126=item selection-autotransform
92 127
93Displays a digital clock using the built-in overlay. 128This selection allows you to do automatic transforms on a selection
129whenever a selection is made.
130
131It works by specifying perl snippets (most useful is a single C<s///>
132operator) that modify C<$_> as resources:
133
134 URxvt.selection-autotransform.0: transform
135 URxvt.selection-autotransform.1: transform
136 ...
137
138For example, the following will transform selections of the form
139C<filename:number>, often seen in compiler messages, into C<vi +$filename
140$word>:
141
142 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143
144And this example matches the same,but replaces it with vi-commands you can
145paste directly into your (vi :) editor:
146
147 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
148
149Of course, this can be modified to suit your needs and your editor :)
150
151To expand the example above to typical perl error messages ("XXX at
152FILENAME line YYY."), you need a slightly more elaborate solution:
153
154 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
155 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
156
157The first line tells the selection code to treat the unchanging part of
158every error message as a selection pattern, and the second line transforms
159the message into vi commands to load the file.
94 160
95=item mark-urls 161=item mark-urls
96 162
97Uses per-line display filtering (C<on_line_update>) to underline urls and 163Uses per-line display filtering (C<on_line_update>) to underline urls and
98make them clickable. When middle-clicked, the program specified in the 164make them clickable. When middle-clicked, the program specified in the
… …
102=item block-graphics-to-ascii 168=item block-graphics-to-ascii
103 169
104A not very useful example of filtering all text output to the terminal, 170A not very useful example of filtering all text output to the terminal,
105by replacing all line-drawing characters (U+2500 .. U+259F) by a 171by replacing all line-drawing characters (U+2500 .. U+259F) by a
106similar-looking ascii character. 172similar-looking ascii character.
173
174=item digital-clock
175
176Displays a digital clock using the built-in overlay.
107 177
108=item example-refresh-hooks 178=item example-refresh-hooks
109 179
110Displays a very simple digital clock in the upper right corner of the 180Displays a very simple digital clock in the upper right corner of the
111window. Illustrates overwriting the refresh callbacks to create your own 181window. Illustrates overwriting the refresh callbacks to create your own
… …
318 388
319Called whenever the user presses a key combination that has a 389Called whenever the user presses a key combination that has a
320C<perl:string> action bound to it (see description of the B<keysym> 390C<perl:string> action bound to it (see description of the B<keysym>
321resource in the @@RXVT_NAME@@(1) manpage). 391resource in the @@RXVT_NAME@@(1) manpage).
322 392
393=item on_x_event $term, $event
394
395Called on every X event received on the vt window (and possibly other
396windows). Should only be used as a last resort. Most event structure
397members are not passed.
398
323=item on_focus_in $term 399=item on_focus_in $term
324 400
325Called whenever the window gets the keyboard focus, before rxvt-unicode 401Called whenever the window gets the keyboard focus, before rxvt-unicode
326does focus in processing. 402does focus in processing.
327 403
… …
437=item urxvt::CurrentTime 513=item urxvt::CurrentTime
438 514
439=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 515=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 516Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441Button4Mask, Button5Mask, AnyModifier 517Button4Mask, Button5Mask, AnyModifier
518
519=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
520ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
521PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
522Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
523KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
524ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
525FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
526
527=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
528EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
529GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
530UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
531ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
532CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
533SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
442 534
443Various constants for use in X calls and event processing. 535Various constants for use in X calls and event processing.
444 536
445=back 537=back
446 538
… …
514 delete $ENV{CDPATH}; 606 delete $ENV{CDPATH};
515 delete $ENV{BASH_ENV}; 607 delete $ENV{BASH_ENV};
516 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 608 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517} 609}
518 610
519my @hook_count;
520my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 611my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521 612
522sub verbose { 613sub verbose {
523 my ($level, $msg) = @_; 614 my ($level, $msg) = @_;
524 warn "$msg\n" if $level <= $verbosity; 615 warn "$msg\n" if $level <= $verbosity;
… …
612 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 703 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613 if $verbosity >= 11; 704 if $verbosity >= 11;
614 } 705 }
615 706
616 if ($htype == 1) { # DESTROY 707 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 708 # clear package objects
625 %$_ = () for values %{ $TERM->{_pkg} }; 709 %$_ = () for values %{ $TERM->{_pkg} };
626 710
627 # clear package 711 # clear package
628 %$TERM = (); 712 %$TERM = ();
… …
654 while (my ($name, $cb) = each %hook) { 738 while (my ($name, $cb) = each %hook) {
655 my $htype = $HOOKTYPE{uc $name}; 739 my $htype = $HOOKTYPE{uc $name};
656 defined $htype 740 defined $htype
657 or Carp::croak "unsupported hook type '$name'"; 741 or Carp::croak "unsupported hook type '$name'";
658 742
743 $self->set_should_invoke ($htype, +1)
659 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 744 unless exists $self->{term}{_hook}[$htype]{$pkg};
660 $hook_count[$htype]++
661 or urxvt::set_should_invoke $htype, 1;
662 }
663 745
664 $self->{term}{_hook}[$htype]{$pkg} = $cb; 746 $self->{term}{_hook}[$htype]{$pkg} = $cb;
665 } 747 }
666} 748}
667 749
… …
672 for my $name (@hook) { 754 for my $name (@hook) {
673 my $htype = $HOOKTYPE{uc $name}; 755 my $htype = $HOOKTYPE{uc $name};
674 defined $htype 756 defined $htype
675 or Carp::croak "unsupported hook type '$name'"; 757 or Carp::croak "unsupported hook type '$name'";
676 758
759 $self->set_should_invoke ($htype, -1)
677 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 760 if delete $self->{term}{_hook}[$htype]{$pkg};
678 --$hook_count[$htype]
679 or urxvt::set_should_invoke $htype, 0;
680 }
681 } 761 }
682} 762}
683 763
684our $AUTOLOAD; 764our $AUTOLOAD;
685 765
… …
1090 1170
1091=item $windowid = $term->vt 1171=item $windowid = $term->vt
1092 1172
1093Return the window id of the terminal window. 1173Return the window id of the terminal window.
1094 1174
1175=item $term->vt_emask_add ($x_event_mask)
1176
1177Adds the specified events to the vt event mask. Useful e.g. when you want
1178to receive pointer events all the times:
1179
1180 $term->vt_emask_add (urxvt::PointerMotionMask);
1181
1095=item $window_width = $term->width 1182=item $window_width = $term->width
1096 1183
1097=item $window_height = $term->height 1184=item $window_height = $term->height
1098 1185
1099=item $font_width = $term->fwidth 1186=item $font_width = $term->fwidth
… …
1112 1199
1113=item $max_scrollback = $term->saveLines 1200=item $max_scrollback = $term->saveLines
1114 1201
1115=item $nrow_plus_saveLines = $term->total_rows 1202=item $nrow_plus_saveLines = $term->total_rows
1116 1203
1117=item $lines_in_scrollback = $term->nsaved 1204=item $topmost_scrollback_row = $term->top_row
1118 1205
1119Return various integers describing terminal characteristics. 1206Return various integers describing terminal characteristics.
1120 1207
1121=item $x_display = $term->display_id 1208=item $x_display = $term->display_id
1122 1209
… …
1150Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1237Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151AltGr), the meta key (often Alt) and the num lock key, if applicable. 1238AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152 1239
1153=item $view_start = $term->view_start ([$newvalue]) 1240=item $view_start = $term->view_start ([$newvalue])
1154 1241
1155Returns the negative row number of the topmost line. Minimum value is 1242Returns the row number of the topmost displayed line. Maximum value is
1156C<0>, which displays the normal terminal contents. Larger values scroll 1243C<0>, which displays the normal terminal contents. Lower values scroll
1157this many lines into the scrollback buffer. 1244this many lines into the scrollback buffer.
1158 1245
1159=item $term->want_refresh 1246=item $term->want_refresh
1160 1247
1161Requests a screen refresh. At the next opportunity, rxvt-unicode will 1248Requests a screen refresh. At the next opportunity, rxvt-unicode will

Diff Legend

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