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.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
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
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/%
156 195
157=back 196=back
158 197
159=head1 API DOCUMENTATION 198=head1 API DOCUMENTATION
160 199
361 400
362Called whenever the user presses a key combination that has a 401Called whenever the user presses a key combination that has a
363C<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>
364resource in the @@RXVT_NAME@@(1) manpage). 403resource in the @@RXVT_NAME@@(1) manpage).
365 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
366=item on_focus_in $term 411=item on_focus_in $term
367 412
368Called whenever the window gets the keyboard focus, before rxvt-unicode 413Called whenever the window gets the keyboard focus, before rxvt-unicode
369does focus in processing. 414does focus in processing.
370 415
465Using 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
466correct place, e.g. on stderr of the connecting urxvtc client. 511correct place, e.g. on stderr of the connecting urxvtc client.
467 512
468Messages have a size limit of 1023 bytes currently. 513Messages have a size limit of 1023 bytes currently.
469 514
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 515=item $time = urxvt::NOW
477 516
478Returns the "current time" (as per the event loop). 517Returns the "current time" (as per the event loop).
479 518
480=item urxvt::CurrentTime 519=item urxvt::CurrentTime
481 520
482=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 521=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 522Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484Button4Mask, 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
485 540
486Various constants for use in X calls and event processing. 541Various constants for use in X calls and event processing.
487 542
488=back 543=back
489 544
540=back 595=back
541 596
542=cut 597=cut
543 598
544BEGIN { 599BEGIN {
545 urxvt->bootstrap;
546
547 # overwrite perl's warn 600 # overwrite perl's warn
548 *CORE::GLOBAL::warn = sub { 601 *CORE::GLOBAL::warn = sub {
549 my $msg = join "", @_; 602 my $msg = join "", @_;
550 $msg .= "\n" 603 $msg .= "\n"
551 unless $msg =~ /\n$/; 604 unless $msg =~ /\n$/;
557 delete $ENV{CDPATH}; 610 delete $ENV{CDPATH};
558 delete $ENV{BASH_ENV}; 611 delete $ENV{BASH_ENV};
559 $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";
560} 613}
561 614
562my @hook_count;
563my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 615my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564 616
565sub verbose { 617sub verbose {
566 my ($level, $msg) = @_; 618 my ($level, $msg) = @_;
567 warn "$msg\n" if $level <= $verbosity; 619 warn "$msg\n" if $level <= $verbosity;
568} 620}
569 621
570my $extension_pkg = "extension0000";
571my %extension_pkg; 622my %extension_pkg;
572 623
573# load a single script into its own package, once only 624# load a single script into its own package, once only
574sub extension_package($) { 625sub extension_package($) {
575 my ($path) = @_; 626 my ($path) = @_;
576 627
628 no strict 'refs';
629
577 $extension_pkg{$path} ||= do { 630 $extension_pkg{$path} ||= do {
578 my $pkg = "urxvt::" . ($extension_pkg++); 631 $path =~ /([^\/\\]+)$/;
632 my $pkg = $1;
633 $pkg =~ s/[^[:word:]]/_/g;
634 $pkg = "urxvt::ext::$pkg";
579 635
580 verbose 3, "loading extension '$path' into package '$pkg'"; 636 verbose 3, "loading extension '$path' into package '$pkg'";
581 637
582 open my $fh, "<:raw", $path 638 open my $fh, "<:raw", $path
583 or die "$path: $!"; 639 or die "$path: $!";
584 640
641 @{"$pkg\::ISA"} = urxvt::term::extension::;
642
585 my $source = untaint 643 my $source =
586 "package $pkg; use strict; use utf8;\n" 644 "package $pkg; use strict; use utf8;\n"
587 . "use base urxvt::term::extension::;\n"
588 . "#line 1 \"$path\"\n{\n" 645 . "#line 1 \"$path\"\n{\n"
589 . (do { local $/; <$fh> }) 646 . (do { local $/; <$fh> })
590 . "\n};\n1"; 647 . "\n};\n1";
591 648
592 eval $source 649 eval $source
655 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 712 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656 if $verbosity >= 11; 713 if $verbosity >= 11;
657 } 714 }
658 715
659 if ($htype == 1) { # DESTROY 716 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 717 # clear package objects
668 %$_ = () for values %{ $TERM->{_pkg} }; 718 %$_ = () for values %{ $TERM->{_pkg} };
669 719
670 # clear package 720 # clear package
671 %$TERM = (); 721 %$TERM = ();
697 while (my ($name, $cb) = each %hook) { 747 while (my ($name, $cb) = each %hook) {
698 my $htype = $HOOKTYPE{uc $name}; 748 my $htype = $HOOKTYPE{uc $name};
699 defined $htype 749 defined $htype
700 or Carp::croak "unsupported hook type '$name'"; 750 or Carp::croak "unsupported hook type '$name'";
701 751
752 $self->set_should_invoke ($htype, +1)
702 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 753 unless exists $self->{term}{_hook}[$htype]{$pkg};
703 $hook_count[$htype]++
704 or urxvt::set_should_invoke $htype, 1;
705 }
706 754
707 $self->{term}{_hook}[$htype]{$pkg} = $cb; 755 $self->{term}{_hook}[$htype]{$pkg} = $cb;
708 } 756 }
709} 757}
710 758
715 for my $name (@hook) { 763 for my $name (@hook) {
716 my $htype = $HOOKTYPE{uc $name}; 764 my $htype = $HOOKTYPE{uc $name};
717 defined $htype 765 defined $htype
718 or Carp::croak "unsupported hook type '$name'"; 766 or Carp::croak "unsupported hook type '$name'";
719 767
768 $self->set_should_invoke ($htype, -1)
720 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 769 if delete $self->{term}{_hook}[$htype]{$pkg};
721 --$hook_count[$htype]
722 or urxvt::set_should_invoke $htype, 0;
723 }
724 } 770 }
725} 771}
726 772
727our $AUTOLOAD; 773our $AUTOLOAD;
728 774
1133 1179
1134=item $windowid = $term->vt 1180=item $windowid = $term->vt
1135 1181
1136Return the window id of the terminal window. 1182Return the window id of the terminal window.
1137 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
1138=item $window_width = $term->width 1191=item $window_width = $term->width
1139 1192
1140=item $window_height = $term->height 1193=item $window_height = $term->height
1141 1194
1142=item $font_width = $term->fwidth 1195=item $font_width = $term->fwidth
1155 1208
1156=item $max_scrollback = $term->saveLines 1209=item $max_scrollback = $term->saveLines
1157 1210
1158=item $nrow_plus_saveLines = $term->total_rows 1211=item $nrow_plus_saveLines = $term->total_rows
1159 1212
1160=item $lines_in_scrollback = $term->nsaved 1213=item $topmost_scrollback_row = $term->top_row
1161 1214
1162Return various integers describing terminal characteristics. 1215Return various integers describing terminal characteristics.
1163 1216
1164=item $x_display = $term->display_id 1217=item $x_display = $term->display_id
1165 1218
1193Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1246Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194AltGr), 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.
1195 1248
1196=item $view_start = $term->view_start ([$newvalue]) 1249=item $view_start = $term->view_start ([$newvalue])
1197 1250
1198Returns the negative row number of the topmost line. Minimum value is 1251Returns the row number of the topmost displayed line. Maximum value is
1199C<0>, which displays the normal terminal contents. Larger values scroll 1252C<0>, which displays the normal terminal contents. Lower values scroll
1200this many lines into the scrollback buffer. 1253this many lines into the scrollback buffer.
1201 1254
1202=item $term->want_refresh 1255=item $term->want_refresh
1203 1256
1204Requests 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