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.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 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
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/%
166 193
167=back 194=back
168 195
169=head1 API DOCUMENTATION 196=head1 API DOCUMENTATION
170 197
… …
371 398
372Called whenever the user presses a key combination that has a 399Called whenever the user presses a key combination that has a
373C<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>
374resource in the @@RXVT_NAME@@(1) manpage). 401resource in the @@RXVT_NAME@@(1) manpage).
375 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
376=item on_focus_in $term 409=item on_focus_in $term
377 410
378Called whenever the window gets the keyboard focus, before rxvt-unicode 411Called whenever the window gets the keyboard focus, before rxvt-unicode
379does focus in processing. 412does focus in processing.
380 413
… …
475Using 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
476correct place, e.g. on stderr of the connecting urxvtc client. 509correct place, e.g. on stderr of the connecting urxvtc client.
477 510
478Messages have a size limit of 1023 bytes currently. 511Messages have a size limit of 1023 bytes currently.
479 512
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 513=item $time = urxvt::NOW
487 514
488Returns the "current time" (as per the event loop). 515Returns the "current time" (as per the event loop).
489 516
490=item urxvt::CurrentTime 517=item urxvt::CurrentTime
491 518
492=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 519=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 520Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494Button4Mask, 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
495 538
496Various constants for use in X calls and event processing. 539Various constants for use in X calls and event processing.
497 540
498=back 541=back
499 542
… …
567 delete $ENV{CDPATH}; 610 delete $ENV{CDPATH};
568 delete $ENV{BASH_ENV}; 611 delete $ENV{BASH_ENV};
569 $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";
570} 613}
571 614
572my @hook_count;
573my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 615my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
574 616
575sub verbose { 617sub verbose {
576 my ($level, $msg) = @_; 618 my ($level, $msg) = @_;
577 warn "$msg\n" if $level <= $verbosity; 619 warn "$msg\n" if $level <= $verbosity;
… …
590 verbose 3, "loading extension '$path' into package '$pkg'"; 632 verbose 3, "loading extension '$path' into package '$pkg'";
591 633
592 open my $fh, "<:raw", $path 634 open my $fh, "<:raw", $path
593 or die "$path: $!"; 635 or die "$path: $!";
594 636
595 my $source = untaint 637 my $source =
596 "package $pkg; use strict; use utf8;\n" 638 "package $pkg; use strict; use utf8;\n"
597 . "use base urxvt::term::extension::;\n" 639 . "use base urxvt::term::extension::;\n"
598 . "#line 1 \"$path\"\n{\n" 640 . "#line 1 \"$path\"\n{\n"
599 . (do { local $/; <$fh> }) 641 . (do { local $/; <$fh> })
600 . "\n};\n1"; 642 . "\n};\n1";
… …
665 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 707 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666 if $verbosity >= 11; 708 if $verbosity >= 11;
667 } 709 }
668 710
669 if ($htype == 1) { # DESTROY 711 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 712 # clear package objects
678 %$_ = () for values %{ $TERM->{_pkg} }; 713 %$_ = () for values %{ $TERM->{_pkg} };
679 714
680 # clear package 715 # clear package
681 %$TERM = (); 716 %$TERM = ();
… …
707 while (my ($name, $cb) = each %hook) { 742 while (my ($name, $cb) = each %hook) {
708 my $htype = $HOOKTYPE{uc $name}; 743 my $htype = $HOOKTYPE{uc $name};
709 defined $htype 744 defined $htype
710 or Carp::croak "unsupported hook type '$name'"; 745 or Carp::croak "unsupported hook type '$name'";
711 746
747 $self->set_should_invoke ($htype, +1)
712 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 748 unless exists $self->{term}{_hook}[$htype]{$pkg};
713 $hook_count[$htype]++
714 or urxvt::set_should_invoke $htype, 1;
715 }
716 749
717 $self->{term}{_hook}[$htype]{$pkg} = $cb; 750 $self->{term}{_hook}[$htype]{$pkg} = $cb;
718 } 751 }
719} 752}
720 753
… …
725 for my $name (@hook) { 758 for my $name (@hook) {
726 my $htype = $HOOKTYPE{uc $name}; 759 my $htype = $HOOKTYPE{uc $name};
727 defined $htype 760 defined $htype
728 or Carp::croak "unsupported hook type '$name'"; 761 or Carp::croak "unsupported hook type '$name'";
729 762
763 $self->set_should_invoke ($htype, -1)
730 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 764 if delete $self->{term}{_hook}[$htype]{$pkg};
731 --$hook_count[$htype]
732 or urxvt::set_should_invoke $htype, 0;
733 }
734 } 765 }
735} 766}
736 767
737our $AUTOLOAD; 768our $AUTOLOAD;
738 769
… …
1143 1174
1144=item $windowid = $term->vt 1175=item $windowid = $term->vt
1145 1176
1146Return the window id of the terminal window. 1177Return the window id of the terminal window.
1147 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
1148=item $window_width = $term->width 1186=item $window_width = $term->width
1149 1187
1150=item $window_height = $term->height 1188=item $window_height = $term->height
1151 1189
1152=item $font_width = $term->fwidth 1190=item $font_width = $term->fwidth
… …
1165 1203
1166=item $max_scrollback = $term->saveLines 1204=item $max_scrollback = $term->saveLines
1167 1205
1168=item $nrow_plus_saveLines = $term->total_rows 1206=item $nrow_plus_saveLines = $term->total_rows
1169 1207
1170=item $lines_in_scrollback = $term->nsaved 1208=item $topmost_scrollback_row = $term->top_row
1171 1209
1172Return various integers describing terminal characteristics. 1210Return various integers describing terminal characteristics.
1173 1211
1174=item $x_display = $term->display_id 1212=item $x_display = $term->display_id
1175 1213
… …
1203Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1241Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1204AltGr), 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.
1205 1243
1206=item $view_start = $term->view_start ([$newvalue]) 1244=item $view_start = $term->view_start ([$newvalue])
1207 1245
1208Returns the negative row number of the topmost line. Minimum value is 1246Returns the row number of the topmost displayed line. Maximum value is
1209C<0>, which displays the normal terminal contents. Larger values scroll 1247C<0>, which displays the normal terminal contents. Lower values scroll
1210this many lines into the scrollback buffer. 1248this many lines into the scrollback buffer.
1211 1249
1212=item $term->want_refresh 1250=item $term->want_refresh
1213 1251
1214Requests 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