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.88 by root, Thu Jan 12 12:05:28 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
117 URxvt.selection-autotransform.0: transform 117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform 118 URxvt.selection-autotransform.1: transform
119 ... 119 ...
120 120
121For example, the following will transform selections of the form 121For example, the following will transform selections of the form
122C<word:number> into C<vi +$number $word>: 122C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>:
123 124
124 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/ 125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125 126
126And 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
127paste directory into your (vi :) editor: 128paste directly into your (vi :) editor:
128 129
129 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\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.
130 143
131=item mark-urls 144=item mark-urls
132 145
133Uses 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
134make them clickable. When middle-clicked, the program specified in the 147make them clickable. When middle-clicked, the program specified in the
148=item example-refresh-hooks 161=item example-refresh-hooks
149 162
150Displays 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
151window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
152overlays 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/%
153 195
154=back 196=back
155 197
156=head1 API DOCUMENTATION 198=head1 API DOCUMENTATION
157 199
358 400
359Called whenever the user presses a key combination that has a 401Called whenever the user presses a key combination that has a
360C<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>
361resource in the @@RXVT_NAME@@(1) manpage). 403resource in the @@RXVT_NAME@@(1) manpage).
362 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
363=item on_focus_in $term 411=item on_focus_in $term
364 412
365Called whenever the window gets the keyboard focus, before rxvt-unicode 413Called whenever the window gets the keyboard focus, before rxvt-unicode
366does focus in processing. 414does focus in processing.
367 415
462Using 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
463correct place, e.g. on stderr of the connecting urxvtc client. 511correct place, e.g. on stderr of the connecting urxvtc client.
464 512
465Messages have a size limit of 1023 bytes currently. 513Messages have a size limit of 1023 bytes currently.
466 514
467=item $is_safe = urxvt::safe
468
469Returns true when it is safe to do potentially unsafe things, such as
470evaluating perl code specified by the user. This is true when urxvt was
471started setuid or setgid.
472
473=item $time = urxvt::NOW 515=item $time = urxvt::NOW
474 516
475Returns the "current time" (as per the event loop). 517Returns the "current time" (as per the event loop).
476 518
477=item urxvt::CurrentTime 519=item urxvt::CurrentTime
478 520
479=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 521=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 522Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481Button4Mask, 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
482 540
483Various constants for use in X calls and event processing. 541Various constants for use in X calls and event processing.
484 542
485=back 543=back
486 544
537=back 595=back
538 596
539=cut 597=cut
540 598
541BEGIN { 599BEGIN {
542 urxvt->bootstrap;
543
544 # overwrite perl's warn 600 # overwrite perl's warn
545 *CORE::GLOBAL::warn = sub { 601 *CORE::GLOBAL::warn = sub {
546 my $msg = join "", @_; 602 my $msg = join "", @_;
547 $msg .= "\n" 603 $msg .= "\n"
548 unless $msg =~ /\n$/; 604 unless $msg =~ /\n$/;
554 delete $ENV{CDPATH}; 610 delete $ENV{CDPATH};
555 delete $ENV{BASH_ENV}; 611 delete $ENV{BASH_ENV};
556 $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";
557} 613}
558 614
559my @hook_count;
560my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 615my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561 616
562sub verbose { 617sub verbose {
563 my ($level, $msg) = @_; 618 my ($level, $msg) = @_;
564 warn "$msg\n" if $level <= $verbosity; 619 warn "$msg\n" if $level <= $verbosity;
565} 620}
566 621
567my $extension_pkg = "extension0000";
568my %extension_pkg; 622my %extension_pkg;
569 623
570# load a single script into its own package, once only 624# load a single script into its own package, once only
571sub extension_package($) { 625sub extension_package($) {
572 my ($path) = @_; 626 my ($path) = @_;
573 627
628 no strict 'refs';
629
574 $extension_pkg{$path} ||= do { 630 $extension_pkg{$path} ||= do {
575 my $pkg = "urxvt::" . ($extension_pkg++); 631 $path =~ /([^\/\\]+)$/;
632 my $pkg = $1;
633 $pkg =~ s/[^[:word:]]/_/g;
634 $pkg = "urxvt::ext::$pkg";
576 635
577 verbose 3, "loading extension '$path' into package '$pkg'"; 636 verbose 3, "loading extension '$path' into package '$pkg'";
578 637
579 open my $fh, "<:raw", $path 638 open my $fh, "<:raw", $path
580 or die "$path: $!"; 639 or die "$path: $!";
581 640
641 @{"$pkg\::ISA"} = urxvt::term::extension::;
642
582 my $source = untaint 643 my $source =
583 "package $pkg; use strict; use utf8;\n" 644 "package $pkg; use strict; use utf8;\n"
584 . "use base urxvt::term::extension::;\n"
585 . "#line 1 \"$path\"\n{\n" 645 . "#line 1 \"$path\"\n{\n"
586 . (do { local $/; <$fh> }) 646 . (do { local $/; <$fh> })
587 . "\n};\n1"; 647 . "\n};\n1";
588 648
589 eval $source 649 eval $source
652 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 712 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653 if $verbosity >= 11; 713 if $verbosity >= 11;
654 } 714 }
655 715
656 if ($htype == 1) { # DESTROY 716 if ($htype == 1) { # DESTROY
657 if (my $hook = delete $TERM->{_hook}) {
658 for my $htype (0..$#$hook) {
659 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
660 or set_should_invoke $htype, 0;
661 }
662 }
663
664 # clear package objects 717 # clear package objects
665 %$_ = () for values %{ $TERM->{_pkg} }; 718 %$_ = () for values %{ $TERM->{_pkg} };
666 719
667 # clear package 720 # clear package
668 %$TERM = (); 721 %$TERM = ();
694 while (my ($name, $cb) = each %hook) { 747 while (my ($name, $cb) = each %hook) {
695 my $htype = $HOOKTYPE{uc $name}; 748 my $htype = $HOOKTYPE{uc $name};
696 defined $htype 749 defined $htype
697 or Carp::croak "unsupported hook type '$name'"; 750 or Carp::croak "unsupported hook type '$name'";
698 751
752 $self->set_should_invoke ($htype, +1)
699 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 753 unless exists $self->{term}{_hook}[$htype]{$pkg};
700 $hook_count[$htype]++
701 or urxvt::set_should_invoke $htype, 1;
702 }
703 754
704 $self->{term}{_hook}[$htype]{$pkg} = $cb; 755 $self->{term}{_hook}[$htype]{$pkg} = $cb;
705 } 756 }
706} 757}
707 758
712 for my $name (@hook) { 763 for my $name (@hook) {
713 my $htype = $HOOKTYPE{uc $name}; 764 my $htype = $HOOKTYPE{uc $name};
714 defined $htype 765 defined $htype
715 or Carp::croak "unsupported hook type '$name'"; 766 or Carp::croak "unsupported hook type '$name'";
716 767
768 $self->set_should_invoke ($htype, -1)
717 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 769 if delete $self->{term}{_hook}[$htype]{$pkg};
718 --$hook_count[$htype]
719 or urxvt::set_should_invoke $htype, 0;
720 }
721 } 770 }
722} 771}
723 772
724our $AUTOLOAD; 773our $AUTOLOAD;
725 774
1130 1179
1131=item $windowid = $term->vt 1180=item $windowid = $term->vt
1132 1181
1133Return the window id of the terminal window. 1182Return the window id of the terminal window.
1134 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
1135=item $window_width = $term->width 1191=item $window_width = $term->width
1136 1192
1137=item $window_height = $term->height 1193=item $window_height = $term->height
1138 1194
1139=item $font_width = $term->fwidth 1195=item $font_width = $term->fwidth
1152 1208
1153=item $max_scrollback = $term->saveLines 1209=item $max_scrollback = $term->saveLines
1154 1210
1155=item $nrow_plus_saveLines = $term->total_rows 1211=item $nrow_plus_saveLines = $term->total_rows
1156 1212
1157=item $lines_in_scrollback = $term->nsaved 1213=item $topmost_scrollback_row = $term->top_row
1158 1214
1159Return various integers describing terminal characteristics. 1215Return various integers describing terminal characteristics.
1160 1216
1161=item $x_display = $term->display_id 1217=item $x_display = $term->display_id
1162 1218
1190Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1246Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1191AltGr), 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.
1192 1248
1193=item $view_start = $term->view_start ([$newvalue]) 1249=item $view_start = $term->view_start ([$newvalue])
1194 1250
1195Returns the negative row number of the topmost line. Minimum value is 1251Returns the row number of the topmost displayed line. Maximum value is
1196C<0>, which displays the normal terminal contents. Larger values scroll 1252C<0>, which displays the normal terminal contents. Lower values scroll
1197this many lines into the scrollback buffer. 1253this many lines into the scrollback buffer.
1198 1254
1199=item $term->want_refresh 1255=item $term->want_refresh
1200 1256
1201Requests 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