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.97 by elmex, Tue Jan 17 16:53:47 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
169Uploads the selection as textfile to a remote site.
170
171 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
172
173To set the command to upload the file set this resource:
174
175 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
176
177The % is the placeholder for the textfile. The name of the textfile is the hex encoded
178md5 sum of the selection.
179After an successful upload the selection will be replaced by the following url
180(the % is the placeholder for the filename):
181
182 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
156 183
157=back 184=back
158 185
159=head1 API DOCUMENTATION 186=head1 API DOCUMENTATION
160 187
… …
361 388
362Called whenever the user presses a key combination that has a 389Called whenever the user presses a key combination that has a
363C<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>
364resource in the @@RXVT_NAME@@(1) manpage). 391resource in the @@RXVT_NAME@@(1) manpage).
365 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
366=item on_focus_in $term 399=item on_focus_in $term
367 400
368Called whenever the window gets the keyboard focus, before rxvt-unicode 401Called whenever the window gets the keyboard focus, before rxvt-unicode
369does focus in processing. 402does focus in processing.
370 403
… …
465Using 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
466correct place, e.g. on stderr of the connecting urxvtc client. 499correct place, e.g. on stderr of the connecting urxvtc client.
467 500
468Messages have a size limit of 1023 bytes currently. 501Messages have a size limit of 1023 bytes currently.
469 502
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 503=item $time = urxvt::NOW
477 504
478Returns the "current time" (as per the event loop). 505Returns the "current time" (as per the event loop).
479 506
480=item urxvt::CurrentTime 507=item urxvt::CurrentTime
481 508
482=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 509=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 510Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484Button4Mask, 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
485 528
486Various constants for use in X calls and event processing. 529Various constants for use in X calls and event processing.
487 530
488=back 531=back
489 532
… …
557 delete $ENV{CDPATH}; 600 delete $ENV{CDPATH};
558 delete $ENV{BASH_ENV}; 601 delete $ENV{BASH_ENV};
559 $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";
560} 603}
561 604
562my @hook_count;
563my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 605my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564 606
565sub verbose { 607sub verbose {
566 my ($level, $msg) = @_; 608 my ($level, $msg) = @_;
567 warn "$msg\n" if $level <= $verbosity; 609 warn "$msg\n" if $level <= $verbosity;
… …
580 verbose 3, "loading extension '$path' into package '$pkg'"; 622 verbose 3, "loading extension '$path' into package '$pkg'";
581 623
582 open my $fh, "<:raw", $path 624 open my $fh, "<:raw", $path
583 or die "$path: $!"; 625 or die "$path: $!";
584 626
585 my $source = untaint 627 my $source =
586 "package $pkg; use strict; use utf8;\n" 628 "package $pkg; use strict; use utf8;\n"
587 . "use base urxvt::term::extension::;\n" 629 . "use base urxvt::term::extension::;\n"
588 . "#line 1 \"$path\"\n{\n" 630 . "#line 1 \"$path\"\n{\n"
589 . (do { local $/; <$fh> }) 631 . (do { local $/; <$fh> })
590 . "\n};\n1"; 632 . "\n};\n1";
… …
655 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 697 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656 if $verbosity >= 11; 698 if $verbosity >= 11;
657 } 699 }
658 700
659 if ($htype == 1) { # DESTROY 701 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 702 # clear package objects
668 %$_ = () for values %{ $TERM->{_pkg} }; 703 %$_ = () for values %{ $TERM->{_pkg} };
669 704
670 # clear package 705 # clear package
671 %$TERM = (); 706 %$TERM = ();
… …
697 while (my ($name, $cb) = each %hook) { 732 while (my ($name, $cb) = each %hook) {
698 my $htype = $HOOKTYPE{uc $name}; 733 my $htype = $HOOKTYPE{uc $name};
699 defined $htype 734 defined $htype
700 or Carp::croak "unsupported hook type '$name'"; 735 or Carp::croak "unsupported hook type '$name'";
701 736
737 $self->set_should_invoke ($htype, +1)
702 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 738 unless exists $self->{term}{_hook}[$htype]{$pkg};
703 $hook_count[$htype]++
704 or urxvt::set_should_invoke $htype, 1;
705 }
706 739
707 $self->{term}{_hook}[$htype]{$pkg} = $cb; 740 $self->{term}{_hook}[$htype]{$pkg} = $cb;
708 } 741 }
709} 742}
710 743
… …
715 for my $name (@hook) { 748 for my $name (@hook) {
716 my $htype = $HOOKTYPE{uc $name}; 749 my $htype = $HOOKTYPE{uc $name};
717 defined $htype 750 defined $htype
718 or Carp::croak "unsupported hook type '$name'"; 751 or Carp::croak "unsupported hook type '$name'";
719 752
753 $self->set_should_invoke ($htype, -1)
720 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 754 if delete $self->{term}{_hook}[$htype]{$pkg};
721 --$hook_count[$htype]
722 or urxvt::set_should_invoke $htype, 0;
723 }
724 } 755 }
725} 756}
726 757
727our $AUTOLOAD; 758our $AUTOLOAD;
728 759
… …
1133 1164
1134=item $windowid = $term->vt 1165=item $windowid = $term->vt
1135 1166
1136Return the window id of the terminal window. 1167Return the window id of the terminal window.
1137 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
1138=item $window_width = $term->width 1176=item $window_width = $term->width
1139 1177
1140=item $window_height = $term->height 1178=item $window_height = $term->height
1141 1179
1142=item $font_width = $term->fwidth 1180=item $font_width = $term->fwidth
… …
1155 1193
1156=item $max_scrollback = $term->saveLines 1194=item $max_scrollback = $term->saveLines
1157 1195
1158=item $nrow_plus_saveLines = $term->total_rows 1196=item $nrow_plus_saveLines = $term->total_rows
1159 1197
1160=item $lines_in_scrollback = $term->nsaved 1198=item $topmost_scrollback_row = $term->top_row
1161 1199
1162Return various integers describing terminal characteristics. 1200Return various integers describing terminal characteristics.
1163 1201
1164=item $x_display = $term->display_id 1202=item $x_display = $term->display_id
1165 1203
… …
1193Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1231Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194AltGr), 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.
1195 1233
1196=item $view_start = $term->view_start ([$newvalue]) 1234=item $view_start = $term->view_start ([$newvalue])
1197 1235
1198Returns the negative row number of the topmost line. Minimum value is 1236Returns the row number of the topmost displayed line. Maximum value is
1199C<0>, which displays the normal terminal contents. Larger values scroll 1237C<0>, which displays the normal terminal contents. Lower values scroll
1200this many lines into the scrollback buffer. 1238this many lines into the scrollback buffer.
1201 1239
1202=item $term->want_refresh 1240=item $term->want_refresh
1203 1241
1204Requests 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