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.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC

66 URxvt.selection.pattern-0: \\|([^|]+)\\| 66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67 67
68You can look at the source of the selection extension to see more 68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 69interesting uses, such as parsing a line from beginning to end.
70 70
71This extension also offers the following bindable keyboard command: 71This extension also offers following bindable keyboard commands:
72 72
73=over 4 73=over 4
74 74
75=item rot13 75=item rot13
76 76
120 120
121For example, the following will transform selections of the form 121For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename 122C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>: 123$word>:
124 124
125 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 126
127And this example matches the same,but replaces it with vi-commands you can 127And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 128paste directly into your (vi :) editor:
129 129
130 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131 131
132Of course, this can be modified to suit your needs and your editor :) 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.
133 143
134=item mark-urls 144=item mark-urls
135 145
136Uses 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
137make them clickable. When middle-clicked, the program specified in the 147make them clickable. When middle-clicked, the program specified in the
151=item example-refresh-hooks 161=item example-refresh-hooks
152 162
153Displays 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
154window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
155overlays 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/%
156 193
157=back 194=back
158 195
159=head1 API DOCUMENTATION 196=head1 API DOCUMENTATION
160 197
361 398
362Called whenever the user presses a key combination that has a 399Called whenever the user presses a key combination that has a
363C<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>
364resource in the @@RXVT_NAME@@(1) manpage). 401resource in the @@RXVT_NAME@@(1) manpage).
365 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
366=item on_focus_in $term 409=item on_focus_in $term
367 410
368Called whenever the window gets the keyboard focus, before rxvt-unicode 411Called whenever the window gets the keyboard focus, before rxvt-unicode
369does focus in processing. 412does focus in processing.
370 413
465Using 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
466correct place, e.g. on stderr of the connecting urxvtc client. 509correct place, e.g. on stderr of the connecting urxvtc client.
467 510
468Messages have a size limit of 1023 bytes currently. 511Messages have a size limit of 1023 bytes currently.
469 512
470=item $is_safe = urxvt::safe
471
472Returns true when it is safe to do potentially unsafe things, such as
473evaluating perl code specified by the user. This is true when urxvt was
474started setuid or setgid.
475
476=item $time = urxvt::NOW 513=item $time = urxvt::NOW
477 514
478Returns the "current time" (as per the event loop). 515Returns the "current time" (as per the event loop).
479 516
480=item urxvt::CurrentTime 517=item urxvt::CurrentTime
481 518
482=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 519=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 520Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484Button4Mask, 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
485 538
486Various constants for use in X calls and event processing. 539Various constants for use in X calls and event processing.
487 540
488=back 541=back
489 542
557 delete $ENV{CDPATH}; 610 delete $ENV{CDPATH};
558 delete $ENV{BASH_ENV}; 611 delete $ENV{BASH_ENV};
559 $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";
560} 613}
561 614
562my @hook_count;
563my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 615my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564 616
565sub verbose { 617sub verbose {
566 my ($level, $msg) = @_; 618 my ($level, $msg) = @_;
567 warn "$msg\n" if $level <= $verbosity; 619 warn "$msg\n" if $level <= $verbosity;
580 verbose 3, "loading extension '$path' into package '$pkg'"; 632 verbose 3, "loading extension '$path' into package '$pkg'";
581 633
582 open my $fh, "<:raw", $path 634 open my $fh, "<:raw", $path
583 or die "$path: $!"; 635 or die "$path: $!";
584 636
585 my $source = untaint 637 my $source =
586 "package $pkg; use strict; use utf8;\n" 638 "package $pkg; use strict; use utf8;\n"
587 . "use base urxvt::term::extension::;\n" 639 . "use base urxvt::term::extension::;\n"
588 . "#line 1 \"$path\"\n{\n" 640 . "#line 1 \"$path\"\n{\n"
589 . (do { local $/; <$fh> }) 641 . (do { local $/; <$fh> })
590 . "\n};\n1"; 642 . "\n};\n1";
655 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 707 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656 if $verbosity >= 11; 708 if $verbosity >= 11;
657 } 709 }
658 710
659 if ($htype == 1) { # DESTROY 711 if ($htype == 1) { # DESTROY
660 if (my $hook = delete $TERM->{_hook}) {
661 for my $htype (0..$#$hook) {
662 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
663 or set_should_invoke $htype, 0;
664 }
665 }
666
667 # clear package objects 712 # clear package objects
668 %$_ = () for values %{ $TERM->{_pkg} }; 713 %$_ = () for values %{ $TERM->{_pkg} };
669 714
670 # clear package 715 # clear package
671 %$TERM = (); 716 %$TERM = ();
697 while (my ($name, $cb) = each %hook) { 742 while (my ($name, $cb) = each %hook) {
698 my $htype = $HOOKTYPE{uc $name}; 743 my $htype = $HOOKTYPE{uc $name};
699 defined $htype 744 defined $htype
700 or Carp::croak "unsupported hook type '$name'"; 745 or Carp::croak "unsupported hook type '$name'";
701 746
747 $self->set_should_invoke ($htype, +1)
702 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 748 unless exists $self->{term}{_hook}[$htype]{$pkg};
703 $hook_count[$htype]++
704 or urxvt::set_should_invoke $htype, 1;
705 }
706 749
707 $self->{term}{_hook}[$htype]{$pkg} = $cb; 750 $self->{term}{_hook}[$htype]{$pkg} = $cb;
708 } 751 }
709} 752}
710 753
715 for my $name (@hook) { 758 for my $name (@hook) {
716 my $htype = $HOOKTYPE{uc $name}; 759 my $htype = $HOOKTYPE{uc $name};
717 defined $htype 760 defined $htype
718 or Carp::croak "unsupported hook type '$name'"; 761 or Carp::croak "unsupported hook type '$name'";
719 762
763 $self->set_should_invoke ($htype, -1)
720 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 764 if delete $self->{term}{_hook}[$htype]{$pkg};
721 --$hook_count[$htype]
722 or urxvt::set_should_invoke $htype, 0;
723 }
724 } 765 }
725} 766}
726 767
727our $AUTOLOAD; 768our $AUTOLOAD;
728 769
1133 1174
1134=item $windowid = $term->vt 1175=item $windowid = $term->vt
1135 1176
1136Return the window id of the terminal window. 1177Return the window id of the terminal window.
1137 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
1138=item $window_width = $term->width 1186=item $window_width = $term->width
1139 1187
1140=item $window_height = $term->height 1188=item $window_height = $term->height
1141 1189
1142=item $font_width = $term->fwidth 1190=item $font_width = $term->fwidth
1155 1203
1156=item $max_scrollback = $term->saveLines 1204=item $max_scrollback = $term->saveLines
1157 1205
1158=item $nrow_plus_saveLines = $term->total_rows 1206=item $nrow_plus_saveLines = $term->total_rows
1159 1207
1160=item $lines_in_scrollback = $term->nsaved 1208=item $topmost_scrollback_row = $term->top_row
1161 1209
1162Return various integers describing terminal characteristics. 1210Return various integers describing terminal characteristics.
1163 1211
1164=item $x_display = $term->display_id 1212=item $x_display = $term->display_id
1165 1213
1193Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1241Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194AltGr), 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.
1195 1243
1196=item $view_start = $term->view_start ([$newvalue]) 1244=item $view_start = $term->view_start ([$newvalue])
1197 1245
1198Returns the negative row number of the topmost line. Minimum value is 1246Returns the row number of the topmost displayed line. Maximum value is
1199C<0>, which displays the normal terminal contents. Larger values scroll 1247C<0>, which displays the normal terminal contents. Lower values scroll
1200this many lines into the scrollback buffer. 1248this many lines into the scrollback buffer.
1201 1249
1202=item $term->want_refresh 1250=item $term->want_refresh
1203 1251
1204Requests 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