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.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
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
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/%
154 183
155=back 184=back
156 185
157=head1 API DOCUMENTATION 186=head1 API DOCUMENTATION
158 187
… …
359 388
360Called whenever the user presses a key combination that has a 389Called whenever the user presses a key combination that has a
361C<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>
362resource in the @@RXVT_NAME@@(1) manpage). 391resource in the @@RXVT_NAME@@(1) manpage).
363 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
364=item on_focus_in $term 399=item on_focus_in $term
365 400
366Called whenever the window gets the keyboard focus, before rxvt-unicode 401Called whenever the window gets the keyboard focus, before rxvt-unicode
367does focus in processing. 402does focus in processing.
368 403
… …
463Using 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
464correct place, e.g. on stderr of the connecting urxvtc client. 499correct place, e.g. on stderr of the connecting urxvtc client.
465 500
466Messages have a size limit of 1023 bytes currently. 501Messages have a size limit of 1023 bytes currently.
467 502
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 503=item $time = urxvt::NOW
475 504
476Returns the "current time" (as per the event loop). 505Returns the "current time" (as per the event loop).
477 506
478=item urxvt::CurrentTime 507=item urxvt::CurrentTime
479 508
480=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 509=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 510Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482Button4Mask, 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
483 528
484Various constants for use in X calls and event processing. 529Various constants for use in X calls and event processing.
485 530
486=back 531=back
487 532
… …
555 delete $ENV{CDPATH}; 600 delete $ENV{CDPATH};
556 delete $ENV{BASH_ENV}; 601 delete $ENV{BASH_ENV};
557 $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";
558} 603}
559 604
560my @hook_count;
561my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 605my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562 606
563sub verbose { 607sub verbose {
564 my ($level, $msg) = @_; 608 my ($level, $msg) = @_;
565 warn "$msg\n" if $level <= $verbosity; 609 warn "$msg\n" if $level <= $verbosity;
… …
578 verbose 3, "loading extension '$path' into package '$pkg'"; 622 verbose 3, "loading extension '$path' into package '$pkg'";
579 623
580 open my $fh, "<:raw", $path 624 open my $fh, "<:raw", $path
581 or die "$path: $!"; 625 or die "$path: $!";
582 626
583 my $source = untaint 627 my $source =
584 "package $pkg; use strict; use utf8;\n" 628 "package $pkg; use strict; use utf8;\n"
585 . "use base urxvt::term::extension::;\n" 629 . "use base urxvt::term::extension::;\n"
586 . "#line 1 \"$path\"\n{\n" 630 . "#line 1 \"$path\"\n{\n"
587 . (do { local $/; <$fh> }) 631 . (do { local $/; <$fh> })
588 . "\n};\n1"; 632 . "\n};\n1";
… …
653 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 697 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654 if $verbosity >= 11; 698 if $verbosity >= 11;
655 } 699 }
656 700
657 if ($htype == 1) { # DESTROY 701 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 702 # clear package objects
666 %$_ = () for values %{ $TERM->{_pkg} }; 703 %$_ = () for values %{ $TERM->{_pkg} };
667 704
668 # clear package 705 # clear package
669 %$TERM = (); 706 %$TERM = ();
… …
695 while (my ($name, $cb) = each %hook) { 732 while (my ($name, $cb) = each %hook) {
696 my $htype = $HOOKTYPE{uc $name}; 733 my $htype = $HOOKTYPE{uc $name};
697 defined $htype 734 defined $htype
698 or Carp::croak "unsupported hook type '$name'"; 735 or Carp::croak "unsupported hook type '$name'";
699 736
737 $self->set_should_invoke ($htype, +1)
700 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 738 unless exists $self->{term}{_hook}[$htype]{$pkg};
701 $hook_count[$htype]++
702 or urxvt::set_should_invoke $htype, 1;
703 }
704 739
705 $self->{term}{_hook}[$htype]{$pkg} = $cb; 740 $self->{term}{_hook}[$htype]{$pkg} = $cb;
706 } 741 }
707} 742}
708 743
… …
713 for my $name (@hook) { 748 for my $name (@hook) {
714 my $htype = $HOOKTYPE{uc $name}; 749 my $htype = $HOOKTYPE{uc $name};
715 defined $htype 750 defined $htype
716 or Carp::croak "unsupported hook type '$name'"; 751 or Carp::croak "unsupported hook type '$name'";
717 752
753 $self->set_should_invoke ($htype, -1)
718 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 754 if delete $self->{term}{_hook}[$htype]{$pkg};
719 --$hook_count[$htype]
720 or urxvt::set_should_invoke $htype, 0;
721 }
722 } 755 }
723} 756}
724 757
725our $AUTOLOAD; 758our $AUTOLOAD;
726 759
… …
1131 1164
1132=item $windowid = $term->vt 1165=item $windowid = $term->vt
1133 1166
1134Return the window id of the terminal window. 1167Return the window id of the terminal window.
1135 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
1136=item $window_width = $term->width 1176=item $window_width = $term->width
1137 1177
1138=item $window_height = $term->height 1178=item $window_height = $term->height
1139 1179
1140=item $font_width = $term->fwidth 1180=item $font_width = $term->fwidth
… …
1153 1193
1154=item $max_scrollback = $term->saveLines 1194=item $max_scrollback = $term->saveLines
1155 1195
1156=item $nrow_plus_saveLines = $term->total_rows 1196=item $nrow_plus_saveLines = $term->total_rows
1157 1197
1158=item $lines_in_scrollback = $term->nsaved 1198=item $topmost_scrollback_row = $term->top_row
1159 1199
1160Return various integers describing terminal characteristics. 1200Return various integers describing terminal characteristics.
1161 1201
1162=item $x_display = $term->display_id 1202=item $x_display = $term->display_id
1163 1203
… …
1191Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1231Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1192AltGr), 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.
1193 1233
1194=item $view_start = $term->view_start ([$newvalue]) 1234=item $view_start = $term->view_start ([$newvalue])
1195 1235
1196Returns the negative row number of the topmost line. Minimum value is 1236Returns the row number of the topmost displayed line. Maximum value is
1197C<0>, which displays the normal terminal contents. Larger values scroll 1237C<0>, which displays the normal terminal contents. Lower values scroll
1198this many lines into the scrollback buffer. 1238this many lines into the scrollback buffer.
1199 1239
1200=item $term->want_refresh 1240=item $term->want_refresh
1201 1241
1202Requests 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