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.89 by root, Thu Jan 12 12:10:06 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
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.
131 143
132=item mark-urls 144=item mark-urls
133 145
134Uses 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
135make them clickable. When middle-clicked, the program specified in the 147make them clickable. When middle-clicked, the program specified in the
149=item example-refresh-hooks 161=item example-refresh-hooks
150 162
151Displays 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
152window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
153overlays 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/%
154 193
155=back 194=back
156 195
157=head1 API DOCUMENTATION 196=head1 API DOCUMENTATION
158 197
359 398
360Called whenever the user presses a key combination that has a 399Called whenever the user presses a key combination that has a
361C<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>
362resource in the @@RXVT_NAME@@(1) manpage). 401resource in the @@RXVT_NAME@@(1) manpage).
363 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
364=item on_focus_in $term 409=item on_focus_in $term
365 410
366Called whenever the window gets the keyboard focus, before rxvt-unicode 411Called whenever the window gets the keyboard focus, before rxvt-unicode
367does focus in processing. 412does focus in processing.
368 413
463Using 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
464correct place, e.g. on stderr of the connecting urxvtc client. 509correct place, e.g. on stderr of the connecting urxvtc client.
465 510
466Messages have a size limit of 1023 bytes currently. 511Messages have a size limit of 1023 bytes currently.
467 512
468=item $is_safe = urxvt::safe
469
470Returns true when it is safe to do potentially unsafe things, such as
471evaluating perl code specified by the user. This is true when urxvt was
472started setuid or setgid.
473
474=item $time = urxvt::NOW 513=item $time = urxvt::NOW
475 514
476Returns the "current time" (as per the event loop). 515Returns the "current time" (as per the event loop).
477 516
478=item urxvt::CurrentTime 517=item urxvt::CurrentTime
479 518
480=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 519=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 520Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482Button4Mask, 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
483 538
484Various constants for use in X calls and event processing. 539Various constants for use in X calls and event processing.
485 540
486=back 541=back
487 542
555 delete $ENV{CDPATH}; 610 delete $ENV{CDPATH};
556 delete $ENV{BASH_ENV}; 611 delete $ENV{BASH_ENV};
557 $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";
558} 613}
559 614
560my @hook_count;
561my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 615my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562 616
563sub verbose { 617sub verbose {
564 my ($level, $msg) = @_; 618 my ($level, $msg) = @_;
565 warn "$msg\n" if $level <= $verbosity; 619 warn "$msg\n" if $level <= $verbosity;
578 verbose 3, "loading extension '$path' into package '$pkg'"; 632 verbose 3, "loading extension '$path' into package '$pkg'";
579 633
580 open my $fh, "<:raw", $path 634 open my $fh, "<:raw", $path
581 or die "$path: $!"; 635 or die "$path: $!";
582 636
583 my $source = untaint 637 my $source =
584 "package $pkg; use strict; use utf8;\n" 638 "package $pkg; use strict; use utf8;\n"
585 . "use base urxvt::term::extension::;\n" 639 . "use base urxvt::term::extension::;\n"
586 . "#line 1 \"$path\"\n{\n" 640 . "#line 1 \"$path\"\n{\n"
587 . (do { local $/; <$fh> }) 641 . (do { local $/; <$fh> })
588 . "\n};\n1"; 642 . "\n};\n1";
653 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 707 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654 if $verbosity >= 11; 708 if $verbosity >= 11;
655 } 709 }
656 710
657 if ($htype == 1) { # DESTROY 711 if ($htype == 1) { # DESTROY
658 if (my $hook = delete $TERM->{_hook}) {
659 for my $htype (0..$#$hook) {
660 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
661 or set_should_invoke $htype, 0;
662 }
663 }
664
665 # clear package objects 712 # clear package objects
666 %$_ = () for values %{ $TERM->{_pkg} }; 713 %$_ = () for values %{ $TERM->{_pkg} };
667 714
668 # clear package 715 # clear package
669 %$TERM = (); 716 %$TERM = ();
695 while (my ($name, $cb) = each %hook) { 742 while (my ($name, $cb) = each %hook) {
696 my $htype = $HOOKTYPE{uc $name}; 743 my $htype = $HOOKTYPE{uc $name};
697 defined $htype 744 defined $htype
698 or Carp::croak "unsupported hook type '$name'"; 745 or Carp::croak "unsupported hook type '$name'";
699 746
747 $self->set_should_invoke ($htype, +1)
700 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 748 unless exists $self->{term}{_hook}[$htype]{$pkg};
701 $hook_count[$htype]++
702 or urxvt::set_should_invoke $htype, 1;
703 }
704 749
705 $self->{term}{_hook}[$htype]{$pkg} = $cb; 750 $self->{term}{_hook}[$htype]{$pkg} = $cb;
706 } 751 }
707} 752}
708 753
713 for my $name (@hook) { 758 for my $name (@hook) {
714 my $htype = $HOOKTYPE{uc $name}; 759 my $htype = $HOOKTYPE{uc $name};
715 defined $htype 760 defined $htype
716 or Carp::croak "unsupported hook type '$name'"; 761 or Carp::croak "unsupported hook type '$name'";
717 762
763 $self->set_should_invoke ($htype, -1)
718 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 764 if delete $self->{term}{_hook}[$htype]{$pkg};
719 --$hook_count[$htype]
720 or urxvt::set_should_invoke $htype, 0;
721 }
722 } 765 }
723} 766}
724 767
725our $AUTOLOAD; 768our $AUTOLOAD;
726 769
1131 1174
1132=item $windowid = $term->vt 1175=item $windowid = $term->vt
1133 1176
1134Return the window id of the terminal window. 1177Return the window id of the terminal window.
1135 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
1136=item $window_width = $term->width 1186=item $window_width = $term->width
1137 1187
1138=item $window_height = $term->height 1188=item $window_height = $term->height
1139 1189
1140=item $font_width = $term->fwidth 1190=item $font_width = $term->fwidth
1153 1203
1154=item $max_scrollback = $term->saveLines 1204=item $max_scrollback = $term->saveLines
1155 1205
1156=item $nrow_plus_saveLines = $term->total_rows 1206=item $nrow_plus_saveLines = $term->total_rows
1157 1207
1158=item $lines_in_scrollback = $term->nsaved 1208=item $topmost_scrollback_row = $term->top_row
1159 1209
1160Return various integers describing terminal characteristics. 1210Return various integers describing terminal characteristics.
1161 1211
1162=item $x_display = $term->display_id 1212=item $x_display = $term->display_id
1163 1213
1191Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1241Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1192AltGr), 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.
1193 1243
1194=item $view_start = $term->view_start ([$newvalue]) 1244=item $view_start = $term->view_start ([$newvalue])
1195 1245
1196Returns the negative row number of the topmost line. Minimum value is 1246Returns the row number of the topmost displayed line. Maximum value is
1197C<0>, which displays the normal terminal contents. Larger values scroll 1247C<0>, which displays the normal terminal contents. Lower values scroll
1198this many lines into the scrollback buffer. 1248this many lines into the scrollback buffer.
1199 1249
1200=item $term->want_refresh 1250=item $term->want_refresh
1201 1251
1202Requests 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