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.101 by root, Wed Jan 18 10:11:03 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
… …
88=item selection-popup (enabled by default) 88=item selection-popup (enabled by default)
89 89
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 90Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 91text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 92evalution, web-browser starting etc.), depending on content.
93
94Other extensions can extend this popup menu by pushing a code reference onto
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
96
97It's sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not.
99It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called
101when the button gets activated and should transform C<$_>.
102
103The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any
105C<a>s:
106
107 push urxvt::ext::selection_popup::hook, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g }
109 : ()
110 };
93 111
94=item searchable-scrollback<hotkey> (enabled by default) 112=item searchable-scrollback<hotkey> (enabled by default)
95 113
96Adds regex search functionality to the scrollback buffer, triggered 114Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 115by a hotkey (default: C<M-s>). While in search mode, normal terminal
… …
120 138
121For example, the following will transform selections of the form 139For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename 140C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>: 141$word>:
124 142
125 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 144
127And this example matches the same,but replaces it with vi-commands you can 145And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 146paste directly into your (vi :) editor:
129 147
130 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131 149
132Of course, this can be modified to suit your needs and your editor :) 150Of course, this can be modified to suit your needs and your editor :)
151
152To expand the example above to typical perl error messages ("XXX at
153FILENAME line YYY."), you need a slightly more elaborate solution:
154
155 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
156 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
157
158The first line tells the selection code to treat the unchanging part of
159every error message as a selection pattern, and the second line transforms
160the message into vi commands to load the file.
133 161
134=item mark-urls 162=item mark-urls
135 163
136Uses per-line display filtering (C<on_line_update>) to underline urls and 164Uses per-line display filtering (C<on_line_update>) to underline urls and
137make them clickable. When middle-clicked, the program specified in the 165make them clickable. When middle-clicked, the program specified in the
… …
151=item example-refresh-hooks 179=item example-refresh-hooks
152 180
153Displays a very simple digital clock in the upper right corner of the 181Displays a very simple digital clock in the upper right corner of the
154window. Illustrates overwriting the refresh callbacks to create your own 182window. Illustrates overwriting the refresh callbacks to create your own
155overlays or changes. 183overlays or changes.
184
185=item selection-pastebin
186
187This is a little rarely useful extension that Uploads the selection as
188textfile to a remote site (or does other things). (The implementation is
189not currently secure for use in a multiuser environment as it writes to
190F</tmp> directly.).
191
192It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
193i.e.
194
195 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
196
197Pressing this combination runs a command with C<%> replaced by the name of
198the textfile. This command can be set via a resource:
199
200 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
201
202And the default is likely not useful to anybody but the few people around
203here :)
204
205The name of the textfile is the hex encoded md5 sum of the selection, so
206the same content should lead to the same filename.
207
208After a successful upload the selection will be replaced by the text given
209in the C<selection-pastebin-url> resource (again, the % is the placeholder
210for the filename):
211
212 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
156 213
157=back 214=back
158 215
159=head1 API DOCUMENTATION 216=head1 API DOCUMENTATION
160 217
… …
361 418
362Called whenever the user presses a key combination that has a 419Called whenever the user presses a key combination that has a
363C<perl:string> action bound to it (see description of the B<keysym> 420C<perl:string> action bound to it (see description of the B<keysym>
364resource in the @@RXVT_NAME@@(1) manpage). 421resource in the @@RXVT_NAME@@(1) manpage).
365 422
423=item on_x_event $term, $event
424
425Called on every X event received on the vt window (and possibly other
426windows). Should only be used as a last resort. Most event structure
427members are not passed.
428
366=item on_focus_in $term 429=item on_focus_in $term
367 430
368Called whenever the window gets the keyboard focus, before rxvt-unicode 431Called whenever the window gets the keyboard focus, before rxvt-unicode
369does focus in processing. 432does focus in processing.
370 433
… …
465Using this function has the advantage that its output ends up in the 528Using this function has the advantage that its output ends up in the
466correct place, e.g. on stderr of the connecting urxvtc client. 529correct place, e.g. on stderr of the connecting urxvtc client.
467 530
468Messages have a size limit of 1023 bytes currently. 531Messages have a size limit of 1023 bytes currently.
469 532
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 533=item $time = urxvt::NOW
477 534
478Returns the "current time" (as per the event loop). 535Returns the "current time" (as per the event loop).
479 536
480=item urxvt::CurrentTime 537=item urxvt::CurrentTime
481 538
482=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 539=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 540Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484Button4Mask, Button5Mask, AnyModifier 541Button4Mask, Button5Mask, AnyModifier
542
543=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
544ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
545PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
546Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
547KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
548ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
549FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
550
551=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
552EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
553GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
554UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
555ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
556CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
557SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485 558
486Various constants for use in X calls and event processing. 559Various constants for use in X calls and event processing.
487 560
488=back 561=back
489 562
… …
540=back 613=back
541 614
542=cut 615=cut
543 616
544BEGIN { 617BEGIN {
545 urxvt->bootstrap;
546
547 # overwrite perl's warn 618 # overwrite perl's warn
548 *CORE::GLOBAL::warn = sub { 619 *CORE::GLOBAL::warn = sub {
549 my $msg = join "", @_; 620 my $msg = join "", @_;
550 $msg .= "\n" 621 $msg .= "\n"
551 unless $msg =~ /\n$/; 622 unless $msg =~ /\n$/;
… …
557 delete $ENV{CDPATH}; 628 delete $ENV{CDPATH};
558 delete $ENV{BASH_ENV}; 629 delete $ENV{BASH_ENV};
559 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 630 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560} 631}
561 632
562my @hook_count;
563my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 633my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564 634
565sub verbose { 635sub verbose {
566 my ($level, $msg) = @_; 636 my ($level, $msg) = @_;
567 warn "$msg\n" if $level <= $verbosity; 637 warn "$msg\n" if $level <= $verbosity;
568} 638}
569 639
570my $extension_pkg = "extension0000";
571my %extension_pkg; 640my %extension_pkg;
572 641
573# load a single script into its own package, once only 642# load a single script into its own package, once only
574sub extension_package($) { 643sub extension_package($) {
575 my ($path) = @_; 644 my ($path) = @_;
576 645
646 no strict 'refs';
647
577 $extension_pkg{$path} ||= do { 648 $extension_pkg{$path} ||= do {
578 my $pkg = "urxvt::" . ($extension_pkg++); 649 $path =~ /([^\/\\]+)$/;
650 my $pkg = $1;
651 $pkg =~ s/[^[:word:]]/_/g;
652 $pkg = "urxvt::ext::$pkg";
579 653
580 verbose 3, "loading extension '$path' into package '$pkg'"; 654 verbose 3, "loading extension '$path' into package '$pkg'";
581 655
582 open my $fh, "<:raw", $path 656 open my $fh, "<:raw", $path
583 or die "$path: $!"; 657 or die "$path: $!";
584 658
659 @{"$pkg\::ISA"} = urxvt::term::extension::;
660
585 my $source = untaint 661 my $source =
586 "package $pkg; use strict; use utf8;\n" 662 "package $pkg; use strict; use utf8;\n"
587 . "use base urxvt::term::extension::;\n"
588 . "#line 1 \"$path\"\n{\n" 663 . "#line 1 \"$path\"\n{\n"
589 . (do { local $/; <$fh> }) 664 . (do { local $/; <$fh> })
590 . "\n};\n1"; 665 . "\n};\n1";
591 666
592 eval $source 667 eval $source
… …
655 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 730 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656 if $verbosity >= 11; 731 if $verbosity >= 11;
657 } 732 }
658 733
659 if ($htype == 1) { # DESTROY 734 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 735 # clear package objects
668 %$_ = () for values %{ $TERM->{_pkg} }; 736 %$_ = () for values %{ $TERM->{_pkg} };
669 737
670 # clear package 738 # clear package
671 %$TERM = (); 739 %$TERM = ();
… …
697 while (my ($name, $cb) = each %hook) { 765 while (my ($name, $cb) = each %hook) {
698 my $htype = $HOOKTYPE{uc $name}; 766 my $htype = $HOOKTYPE{uc $name};
699 defined $htype 767 defined $htype
700 or Carp::croak "unsupported hook type '$name'"; 768 or Carp::croak "unsupported hook type '$name'";
701 769
770 $self->set_should_invoke ($htype, +1)
702 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 771 unless exists $self->{term}{_hook}[$htype]{$pkg};
703 $hook_count[$htype]++
704 or urxvt::set_should_invoke $htype, 1;
705 }
706 772
707 $self->{term}{_hook}[$htype]{$pkg} = $cb; 773 $self->{term}{_hook}[$htype]{$pkg} = $cb;
708 } 774 }
709} 775}
710 776
… …
715 for my $name (@hook) { 781 for my $name (@hook) {
716 my $htype = $HOOKTYPE{uc $name}; 782 my $htype = $HOOKTYPE{uc $name};
717 defined $htype 783 defined $htype
718 or Carp::croak "unsupported hook type '$name'"; 784 or Carp::croak "unsupported hook type '$name'";
719 785
786 $self->set_should_invoke ($htype, -1)
720 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 787 if delete $self->{term}{_hook}[$htype]{$pkg};
721 --$hook_count[$htype]
722 or urxvt::set_should_invoke $htype, 0;
723 }
724 } 788 }
725} 789}
726 790
727our $AUTOLOAD; 791our $AUTOLOAD;
728 792
… …
1133 1197
1134=item $windowid = $term->vt 1198=item $windowid = $term->vt
1135 1199
1136Return the window id of the terminal window. 1200Return the window id of the terminal window.
1137 1201
1202=item $term->vt_emask_add ($x_event_mask)
1203
1204Adds the specified events to the vt event mask. Useful e.g. when you want
1205to receive pointer events all the times:
1206
1207 $term->vt_emask_add (urxvt::PointerMotionMask);
1208
1138=item $window_width = $term->width 1209=item $window_width = $term->width
1139 1210
1140=item $window_height = $term->height 1211=item $window_height = $term->height
1141 1212
1142=item $font_width = $term->fwidth 1213=item $font_width = $term->fwidth
… …
1155 1226
1156=item $max_scrollback = $term->saveLines 1227=item $max_scrollback = $term->saveLines
1157 1228
1158=item $nrow_plus_saveLines = $term->total_rows 1229=item $nrow_plus_saveLines = $term->total_rows
1159 1230
1160=item $lines_in_scrollback = $term->nsaved 1231=item $topmost_scrollback_row = $term->top_row
1161 1232
1162Return various integers describing terminal characteristics. 1233Return various integers describing terminal characteristics.
1163 1234
1164=item $x_display = $term->display_id 1235=item $x_display = $term->display_id
1165 1236
… …
1193Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1264Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194AltGr), the meta key (often Alt) and the num lock key, if applicable. 1265AltGr), the meta key (often Alt) and the num lock key, if applicable.
1195 1266
1196=item $view_start = $term->view_start ([$newvalue]) 1267=item $view_start = $term->view_start ([$newvalue])
1197 1268
1198Returns the negative row number of the topmost line. Minimum value is 1269Returns the row number of the topmost displayed line. Maximum value is
1199C<0>, which displays the normal terminal contents. Larger values scroll 1270C<0>, which displays the normal terminal contents. Lower values scroll
1200this many lines into the scrollback buffer. 1271this many lines into the scrollback buffer.
1201 1272
1202=item $term->want_refresh 1273=item $term->want_refresh
1203 1274
1204Requests a screen refresh. At the next opportunity, rxvt-unicode will 1275Requests a screen refresh. At the next opportunity, rxvt-unicode will

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines