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.100 by root, Wed Jan 18 08:33:34 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). (The implementation is
171not currently secure for use in a multiuser environment as it writes to
172F</tmp> directly.).
173
174It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
175i.e.
176
177 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
178
179Pressing this combination runs a command with C<%> replaced by the name of
180the textfile. This command can be set via a resource:
181
182 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
183
184And the default is likely not useful to anybody but the few people around
185here :)
186
187The name of the textfile is the hex encoded md5 sum of the selection, so
188the same content should lead to the same filename.
189
190After a successful upload the selection will be replaced by the text given
191in the C<selection-pastebin-url> resource (again, the % is the placeholder
192for the filename):
193
194 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166 195
167=back 196=back
168 197
169=head1 API DOCUMENTATION 198=head1 API DOCUMENTATION
170 199
371 400
372Called whenever the user presses a key combination that has a 401Called whenever the user presses a key combination that has a
373C<perl:string> action bound to it (see description of the B<keysym> 402C<perl:string> action bound to it (see description of the B<keysym>
374resource in the @@RXVT_NAME@@(1) manpage). 403resource in the @@RXVT_NAME@@(1) manpage).
375 404
405=item on_x_event $term, $event
406
407Called on every X event received on the vt window (and possibly other
408windows). Should only be used as a last resort. Most event structure
409members are not passed.
410
376=item on_focus_in $term 411=item on_focus_in $term
377 412
378Called whenever the window gets the keyboard focus, before rxvt-unicode 413Called whenever the window gets the keyboard focus, before rxvt-unicode
379does focus in processing. 414does focus in processing.
380 415
475Using this function has the advantage that its output ends up in the 510Using this function has the advantage that its output ends up in the
476correct place, e.g. on stderr of the connecting urxvtc client. 511correct place, e.g. on stderr of the connecting urxvtc client.
477 512
478Messages have a size limit of 1023 bytes currently. 513Messages have a size limit of 1023 bytes currently.
479 514
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 515=item $time = urxvt::NOW
487 516
488Returns the "current time" (as per the event loop). 517Returns the "current time" (as per the event loop).
489 518
490=item urxvt::CurrentTime 519=item urxvt::CurrentTime
491 520
492=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 521=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 522Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494Button4Mask, Button5Mask, AnyModifier 523Button4Mask, Button5Mask, AnyModifier
524
525=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
526ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
527PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
528Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
529KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
530ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
531FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
532
533=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
534EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
535GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
536UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
537ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
538CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
539SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
495 540
496Various constants for use in X calls and event processing. 541Various constants for use in X calls and event processing.
497 542
498=back 543=back
499 544
550=back 595=back
551 596
552=cut 597=cut
553 598
554BEGIN { 599BEGIN {
555 urxvt->bootstrap;
556
557 # overwrite perl's warn 600 # overwrite perl's warn
558 *CORE::GLOBAL::warn = sub { 601 *CORE::GLOBAL::warn = sub {
559 my $msg = join "", @_; 602 my $msg = join "", @_;
560 $msg .= "\n" 603 $msg .= "\n"
561 unless $msg =~ /\n$/; 604 unless $msg =~ /\n$/;
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;
578} 620}
579 621
580my $extension_pkg = "extension0000";
581my %extension_pkg; 622my %extension_pkg;
582 623
583# load a single script into its own package, once only 624# load a single script into its own package, once only
584sub extension_package($) { 625sub extension_package($) {
585 my ($path) = @_; 626 my ($path) = @_;
586 627
628 no strict 'refs';
629
587 $extension_pkg{$path} ||= do { 630 $extension_pkg{$path} ||= do {
588 my $pkg = "urxvt::" . ($extension_pkg++); 631 $path =~ /([^\/\\]+)$/;
632 my $pkg = $1;
633 $pkg =~ s/[^[:word:]]/_/g;
634 $pkg = "urxvt::ext::$pkg";
589 635
590 verbose 3, "loading extension '$path' into package '$pkg'"; 636 verbose 3, "loading extension '$path' into package '$pkg'";
591 637
592 open my $fh, "<:raw", $path 638 open my $fh, "<:raw", $path
593 or die "$path: $!"; 639 or die "$path: $!";
594 640
641 @{"$pkg\::ISA"} = urxvt::term::extension::;
642
595 my $source = untaint 643 my $source =
596 "package $pkg; use strict; use utf8;\n" 644 "package $pkg; use strict; use utf8;\n"
597 . "use base urxvt::term::extension::;\n"
598 . "#line 1 \"$path\"\n{\n" 645 . "#line 1 \"$path\"\n{\n"
599 . (do { local $/; <$fh> }) 646 . (do { local $/; <$fh> })
600 . "\n};\n1"; 647 . "\n};\n1";
601 648
602 eval $source 649 eval $source
665 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 712 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666 if $verbosity >= 11; 713 if $verbosity >= 11;
667 } 714 }
668 715
669 if ($htype == 1) { # DESTROY 716 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 717 # clear package objects
678 %$_ = () for values %{ $TERM->{_pkg} }; 718 %$_ = () for values %{ $TERM->{_pkg} };
679 719
680 # clear package 720 # clear package
681 %$TERM = (); 721 %$TERM = ();
707 while (my ($name, $cb) = each %hook) { 747 while (my ($name, $cb) = each %hook) {
708 my $htype = $HOOKTYPE{uc $name}; 748 my $htype = $HOOKTYPE{uc $name};
709 defined $htype 749 defined $htype
710 or Carp::croak "unsupported hook type '$name'"; 750 or Carp::croak "unsupported hook type '$name'";
711 751
752 $self->set_should_invoke ($htype, +1)
712 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 753 unless exists $self->{term}{_hook}[$htype]{$pkg};
713 $hook_count[$htype]++
714 or urxvt::set_should_invoke $htype, 1;
715 }
716 754
717 $self->{term}{_hook}[$htype]{$pkg} = $cb; 755 $self->{term}{_hook}[$htype]{$pkg} = $cb;
718 } 756 }
719} 757}
720 758
725 for my $name (@hook) { 763 for my $name (@hook) {
726 my $htype = $HOOKTYPE{uc $name}; 764 my $htype = $HOOKTYPE{uc $name};
727 defined $htype 765 defined $htype
728 or Carp::croak "unsupported hook type '$name'"; 766 or Carp::croak "unsupported hook type '$name'";
729 767
768 $self->set_should_invoke ($htype, -1)
730 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 769 if delete $self->{term}{_hook}[$htype]{$pkg};
731 --$hook_count[$htype]
732 or urxvt::set_should_invoke $htype, 0;
733 }
734 } 770 }
735} 771}
736 772
737our $AUTOLOAD; 773our $AUTOLOAD;
738 774
1143 1179
1144=item $windowid = $term->vt 1180=item $windowid = $term->vt
1145 1181
1146Return the window id of the terminal window. 1182Return the window id of the terminal window.
1147 1183
1184=item $term->vt_emask_add ($x_event_mask)
1185
1186Adds the specified events to the vt event mask. Useful e.g. when you want
1187to receive pointer events all the times:
1188
1189 $term->vt_emask_add (urxvt::PointerMotionMask);
1190
1148=item $window_width = $term->width 1191=item $window_width = $term->width
1149 1192
1150=item $window_height = $term->height 1193=item $window_height = $term->height
1151 1194
1152=item $font_width = $term->fwidth 1195=item $font_width = $term->fwidth
1165 1208
1166=item $max_scrollback = $term->saveLines 1209=item $max_scrollback = $term->saveLines
1167 1210
1168=item $nrow_plus_saveLines = $term->total_rows 1211=item $nrow_plus_saveLines = $term->total_rows
1169 1212
1170=item $lines_in_scrollback = $term->nsaved 1213=item $topmost_scrollback_row = $term->top_row
1171 1214
1172Return various integers describing terminal characteristics. 1215Return various integers describing terminal characteristics.
1173 1216
1174=item $x_display = $term->display_id 1217=item $x_display = $term->display_id
1175 1218
1203Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1246Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1204AltGr), the meta key (often Alt) and the num lock key, if applicable. 1247AltGr), the meta key (often Alt) and the num lock key, if applicable.
1205 1248
1206=item $view_start = $term->view_start ([$newvalue]) 1249=item $view_start = $term->view_start ([$newvalue])
1207 1250
1208Returns the negative row number of the topmost line. Minimum value is 1251Returns the row number of the topmost displayed line. Maximum value is
1209C<0>, which displays the normal terminal contents. Larger values scroll 1252C<0>, which displays the normal terminal contents. Lower values scroll
1210this many lines into the scrollback buffer. 1253this many lines into the scrollback buffer.
1211 1254
1212=item $term->want_refresh 1255=item $term->want_refresh
1213 1256
1214Requests a screen refresh. At the next opportunity, rxvt-unicode will 1257Requests a screen refresh. At the next opportunity, rxvt-unicode will

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines