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.91 by root, Fri Jan 13 01:09:37 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 133
134To expand the example above to typical perl error messages ("XXX at 134To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 135FILENAME line YYY."), you need a slightly more elaborate solution:
… …
161=item example-refresh-hooks 161=item example-refresh-hooks
162 162
163Displays 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
164window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
165overlays 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/%
166 183
167=back 184=back
168 185
169=head1 API DOCUMENTATION 186=head1 API DOCUMENTATION
170 187
… …
371 388
372Called whenever the user presses a key combination that has a 389Called whenever the user presses a key combination that has a
373C<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>
374resource in the @@RXVT_NAME@@(1) manpage). 391resource in the @@RXVT_NAME@@(1) manpage).
375 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
376=item on_focus_in $term 399=item on_focus_in $term
377 400
378Called whenever the window gets the keyboard focus, before rxvt-unicode 401Called whenever the window gets the keyboard focus, before rxvt-unicode
379does focus in processing. 402does focus in processing.
380 403
… …
475Using 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
476correct place, e.g. on stderr of the connecting urxvtc client. 499correct place, e.g. on stderr of the connecting urxvtc client.
477 500
478Messages have a size limit of 1023 bytes currently. 501Messages have a size limit of 1023 bytes currently.
479 502
480=item $is_safe = urxvt::safe
481
482Returns true when it is safe to do potentially unsafe things, such as
483evaluating perl code specified by the user. This is true when urxvt was
484started setuid or setgid.
485
486=item $time = urxvt::NOW 503=item $time = urxvt::NOW
487 504
488Returns the "current time" (as per the event loop). 505Returns the "current time" (as per the event loop).
489 506
490=item urxvt::CurrentTime 507=item urxvt::CurrentTime
491 508
492=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 509=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 510Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494Button4Mask, 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
495 528
496Various constants for use in X calls and event processing. 529Various constants for use in X calls and event processing.
497 530
498=back 531=back
499 532
… …
567 delete $ENV{CDPATH}; 600 delete $ENV{CDPATH};
568 delete $ENV{BASH_ENV}; 601 delete $ENV{BASH_ENV};
569 $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";
570} 603}
571 604
572my @hook_count;
573my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 605my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
574 606
575sub verbose { 607sub verbose {
576 my ($level, $msg) = @_; 608 my ($level, $msg) = @_;
577 warn "$msg\n" if $level <= $verbosity; 609 warn "$msg\n" if $level <= $verbosity;
… …
590 verbose 3, "loading extension '$path' into package '$pkg'"; 622 verbose 3, "loading extension '$path' into package '$pkg'";
591 623
592 open my $fh, "<:raw", $path 624 open my $fh, "<:raw", $path
593 or die "$path: $!"; 625 or die "$path: $!";
594 626
595 my $source = untaint 627 my $source =
596 "package $pkg; use strict; use utf8;\n" 628 "package $pkg; use strict; use utf8;\n"
597 . "use base urxvt::term::extension::;\n" 629 . "use base urxvt::term::extension::;\n"
598 . "#line 1 \"$path\"\n{\n" 630 . "#line 1 \"$path\"\n{\n"
599 . (do { local $/; <$fh> }) 631 . (do { local $/; <$fh> })
600 . "\n};\n1"; 632 . "\n};\n1";
… …
665 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 697 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666 if $verbosity >= 11; 698 if $verbosity >= 11;
667 } 699 }
668 700
669 if ($htype == 1) { # DESTROY 701 if ($htype == 1) { # DESTROY
670 if (my $hook = delete $TERM->{_hook}) {
671 for my $htype (0..$#$hook) {
672 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
673 or set_should_invoke $htype, 0;
674 }
675 }
676
677 # clear package objects 702 # clear package objects
678 %$_ = () for values %{ $TERM->{_pkg} }; 703 %$_ = () for values %{ $TERM->{_pkg} };
679 704
680 # clear package 705 # clear package
681 %$TERM = (); 706 %$TERM = ();
… …
707 while (my ($name, $cb) = each %hook) { 732 while (my ($name, $cb) = each %hook) {
708 my $htype = $HOOKTYPE{uc $name}; 733 my $htype = $HOOKTYPE{uc $name};
709 defined $htype 734 defined $htype
710 or Carp::croak "unsupported hook type '$name'"; 735 or Carp::croak "unsupported hook type '$name'";
711 736
737 $self->set_should_invoke ($htype, +1)
712 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 738 unless exists $self->{term}{_hook}[$htype]{$pkg};
713 $hook_count[$htype]++
714 or urxvt::set_should_invoke $htype, 1;
715 }
716 739
717 $self->{term}{_hook}[$htype]{$pkg} = $cb; 740 $self->{term}{_hook}[$htype]{$pkg} = $cb;
718 } 741 }
719} 742}
720 743
… …
725 for my $name (@hook) { 748 for my $name (@hook) {
726 my $htype = $HOOKTYPE{uc $name}; 749 my $htype = $HOOKTYPE{uc $name};
727 defined $htype 750 defined $htype
728 or Carp::croak "unsupported hook type '$name'"; 751 or Carp::croak "unsupported hook type '$name'";
729 752
753 $self->set_should_invoke ($htype, -1)
730 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 754 if delete $self->{term}{_hook}[$htype]{$pkg};
731 --$hook_count[$htype]
732 or urxvt::set_should_invoke $htype, 0;
733 }
734 } 755 }
735} 756}
736 757
737our $AUTOLOAD; 758our $AUTOLOAD;
738 759
… …
1143 1164
1144=item $windowid = $term->vt 1165=item $windowid = $term->vt
1145 1166
1146Return the window id of the terminal window. 1167Return the window id of the terminal window.
1147 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
1148=item $window_width = $term->width 1176=item $window_width = $term->width
1149 1177
1150=item $window_height = $term->height 1178=item $window_height = $term->height
1151 1179
1152=item $font_width = $term->fwidth 1180=item $font_width = $term->fwidth
… …
1165 1193
1166=item $max_scrollback = $term->saveLines 1194=item $max_scrollback = $term->saveLines
1167 1195
1168=item $nrow_plus_saveLines = $term->total_rows 1196=item $nrow_plus_saveLines = $term->total_rows
1169 1197
1170=item $lines_in_scrollback = $term->nsaved 1198=item $topmost_scrollback_row = $term->top_row
1171 1199
1172Return various integers describing terminal characteristics. 1200Return various integers describing terminal characteristics.
1173 1201
1174=item $x_display = $term->display_id 1202=item $x_display = $term->display_id
1175 1203
… …
1203Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1231Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1204AltGr), 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.
1205 1233
1206=item $view_start = $term->view_start ([$newvalue]) 1234=item $view_start = $term->view_start ([$newvalue])
1207 1235
1208Returns the negative row number of the topmost line. Minimum value is 1236Returns the row number of the topmost displayed line. Maximum value is
1209C<0>, which displays the normal terminal contents. Larger values scroll 1237C<0>, which displays the normal terminal contents. Lower values scroll
1210this many lines into the scrollback buffer. 1238this many lines into the scrollback buffer.
1211 1239
1212=item $term->want_refresh 1240=item $term->want_refresh
1213 1241
1214Requests 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