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.96 by root, Tue Jan 17 16:22:41 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
… …
422Using this function has the advantage that its output ends up in the 498Using this function has the advantage that its output ends up in the
423correct place, e.g. on stderr of the connecting urxvtc client. 499correct place, e.g. on stderr of the connecting urxvtc client.
424 500
425Messages have a size limit of 1023 bytes currently. 501Messages have a size limit of 1023 bytes currently.
426 502
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 503=item $time = urxvt::NOW
434 504
435Returns the "current time" (as per the event loop). 505Returns the "current time" (as per the event loop).
436 506
437=item urxvt::CurrentTime 507=item urxvt::CurrentTime
438 508
439=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 509=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 510Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441Button4Mask, Button5Mask, AnyModifier 511Button4Mask, Button5Mask, AnyModifier
512
513=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
514ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
515PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
516Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
517KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
518ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
519FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
520
521=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
522EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
523GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
524UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
525ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
526CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
527SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
442 528
443Various constants for use in X calls and event processing. 529Various constants for use in X calls and event processing.
444 530
445=back 531=back
446 532
… …
514 delete $ENV{CDPATH}; 600 delete $ENV{CDPATH};
515 delete $ENV{BASH_ENV}; 601 delete $ENV{BASH_ENV};
516 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 602 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517} 603}
518 604
519my @hook_count;
520my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 605my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521 606
522sub verbose { 607sub verbose {
523 my ($level, $msg) = @_; 608 my ($level, $msg) = @_;
524 warn "$msg\n" if $level <= $verbosity; 609 warn "$msg\n" if $level <= $verbosity;
… …
537 verbose 3, "loading extension '$path' into package '$pkg'"; 622 verbose 3, "loading extension '$path' into package '$pkg'";
538 623
539 open my $fh, "<:raw", $path 624 open my $fh, "<:raw", $path
540 or die "$path: $!"; 625 or die "$path: $!";
541 626
542 my $source = untaint 627 my $source =
543 "package $pkg; use strict; use utf8;\n" 628 "package $pkg; use strict; use utf8;\n"
544 . "use base urxvt::term::extension::;\n" 629 . "use base urxvt::term::extension::;\n"
545 . "#line 1 \"$path\"\n{\n" 630 . "#line 1 \"$path\"\n{\n"
546 . (do { local $/; <$fh> }) 631 . (do { local $/; <$fh> })
547 . "\n};\n1"; 632 . "\n};\n1";
… …
612 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 697 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613 if $verbosity >= 11; 698 if $verbosity >= 11;
614 } 699 }
615 700
616 if ($htype == 1) { # DESTROY 701 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 702 # clear package objects
625 %$_ = () for values %{ $TERM->{_pkg} }; 703 %$_ = () for values %{ $TERM->{_pkg} };
626 704
627 # clear package 705 # clear package
628 %$TERM = (); 706 %$TERM = ();
… …
654 while (my ($name, $cb) = each %hook) { 732 while (my ($name, $cb) = each %hook) {
655 my $htype = $HOOKTYPE{uc $name}; 733 my $htype = $HOOKTYPE{uc $name};
656 defined $htype 734 defined $htype
657 or Carp::croak "unsupported hook type '$name'"; 735 or Carp::croak "unsupported hook type '$name'";
658 736
737 $self->set_should_invoke ($htype, +1)
659 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 738 unless exists $self->{term}{_hook}[$htype]{$pkg};
660 $hook_count[$htype]++
661 or urxvt::set_should_invoke $htype, 1;
662 }
663 739
664 $self->{term}{_hook}[$htype]{$pkg} = $cb; 740 $self->{term}{_hook}[$htype]{$pkg} = $cb;
665 } 741 }
666} 742}
667 743
… …
672 for my $name (@hook) { 748 for my $name (@hook) {
673 my $htype = $HOOKTYPE{uc $name}; 749 my $htype = $HOOKTYPE{uc $name};
674 defined $htype 750 defined $htype
675 or Carp::croak "unsupported hook type '$name'"; 751 or Carp::croak "unsupported hook type '$name'";
676 752
753 $self->set_should_invoke ($htype, -1)
677 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 754 if delete $self->{term}{_hook}[$htype]{$pkg};
678 --$hook_count[$htype]
679 or urxvt::set_should_invoke $htype, 0;
680 }
681 } 755 }
682} 756}
683 757
684our $AUTOLOAD; 758our $AUTOLOAD;
685 759
… …
1090 1164
1091=item $windowid = $term->vt 1165=item $windowid = $term->vt
1092 1166
1093Return the window id of the terminal window. 1167Return the window id of the terminal window.
1094 1168
1169=item $term->vt_emask_add ($x_event_mask)
1170
1171Adds the specified events to the vt event mask. Useful e.g. when you want
1172to receive pointer events all the times:
1173
1174 $term->vt_emask_add (urxvt::PointerMotionMask);
1175
1095=item $window_width = $term->width 1176=item $window_width = $term->width
1096 1177
1097=item $window_height = $term->height 1178=item $window_height = $term->height
1098 1179
1099=item $font_width = $term->fwidth 1180=item $font_width = $term->fwidth
… …
1112 1193
1113=item $max_scrollback = $term->saveLines 1194=item $max_scrollback = $term->saveLines
1114 1195
1115=item $nrow_plus_saveLines = $term->total_rows 1196=item $nrow_plus_saveLines = $term->total_rows
1116 1197
1117=item $lines_in_scrollback = $term->nsaved 1198=item $topmost_scrollback_row = $term->top_row
1118 1199
1119Return various integers describing terminal characteristics. 1200Return various integers describing terminal characteristics.
1120 1201
1121=item $x_display = $term->display_id 1202=item $x_display = $term->display_id
1122 1203
… …
1150Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1231Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151AltGr), the meta key (often Alt) and the num lock key, if applicable. 1232AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152 1233
1153=item $view_start = $term->view_start ([$newvalue]) 1234=item $view_start = $term->view_start ([$newvalue])
1154 1235
1155Returns the negative row number of the topmost line. Minimum value is 1236Returns the row number of the topmost displayed line. Maximum value is
1156C<0>, which displays the normal terminal contents. Larger values scroll 1237C<0>, which displays the normal terminal contents. Lower values scroll
1157this many lines into the scrollback buffer. 1238this many lines into the scrollback buffer.
1158 1239
1159=item $term->want_refresh 1240=item $term->want_refresh
1160 1241
1161Requests a screen refresh. At the next opportunity, rxvt-unicode will 1242Requests a screen refresh. At the next opportunity, rxvt-unicode will

Diff Legend

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