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.102 by root, Wed Jan 18 10:31:37 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 :)
133 151
134To expand the example above to typical perl error messages ("XXX at 152To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 153FILENAME line YYY."), you need a slightly more elaborate solution:
161=item example-refresh-hooks 179=item example-refresh-hooks
162 180
163Displays 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
164window. Illustrates overwriting the refresh callbacks to create your own 182window. Illustrates overwriting the refresh callbacks to create your own
165overlays 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/%
166 213
167=back 214=back
168 215
169=head1 API DOCUMENTATION 216=head1 API DOCUMENTATION
170 217
371 418
372Called whenever the user presses a key combination that has a 419Called whenever the user presses a key combination that has a
373C<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>
374resource in the @@RXVT_NAME@@(1) manpage). 421resource in the @@RXVT_NAME@@(1) manpage).
375 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
376=item on_focus_in $term 429=item on_focus_in $term
377 430
378Called whenever the window gets the keyboard focus, before rxvt-unicode 431Called whenever the window gets the keyboard focus, before rxvt-unicode
379does focus in processing. 432does focus in processing.
380 433
381=item on_focus_out $term 434=item on_focus_out $term
382 435
383Called wheneever the window loses keyboard focus, before rxvt-unicode does 436Called wheneever the window loses keyboard focus, before rxvt-unicode does
384focus out processing. 437focus out processing.
438
439=item on_configure_notify $term, $event
385 440
386=item on_key_press $term, $event, $keysym, $octets 441=item on_key_press $term, $event, $keysym, $octets
387 442
388=item on_key_release $term, $event, $keysym 443=item on_key_release $term, $event, $keysym
389 444
475Using this function has the advantage that its output ends up in the 530Using this function has the advantage that its output ends up in the
476correct place, e.g. on stderr of the connecting urxvtc client. 531correct place, e.g. on stderr of the connecting urxvtc client.
477 532
478Messages have a size limit of 1023 bytes currently. 533Messages have a size limit of 1023 bytes currently.
479 534
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 535=item $time = urxvt::NOW
487 536
488Returns the "current time" (as per the event loop). 537Returns the "current time" (as per the event loop).
489 538
490=item urxvt::CurrentTime 539=item urxvt::CurrentTime
491 540
492=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 541=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 542Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494Button4Mask, Button5Mask, AnyModifier 543Button4Mask, Button5Mask, AnyModifier
544
545=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
546ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
547PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
548Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
549KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
550ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
551FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
552
553=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
554EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
555GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
556UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
557ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
558CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
559SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
495 560
496Various constants for use in X calls and event processing. 561Various constants for use in X calls and event processing.
497 562
498=back 563=back
499 564
550=back 615=back
551 616
552=cut 617=cut
553 618
554BEGIN { 619BEGIN {
555 urxvt->bootstrap;
556
557 # overwrite perl's warn 620 # overwrite perl's warn
558 *CORE::GLOBAL::warn = sub { 621 *CORE::GLOBAL::warn = sub {
559 my $msg = join "", @_; 622 my $msg = join "", @_;
560 $msg .= "\n" 623 $msg .= "\n"
561 unless $msg =~ /\n$/; 624 unless $msg =~ /\n$/;
567 delete $ENV{CDPATH}; 630 delete $ENV{CDPATH};
568 delete $ENV{BASH_ENV}; 631 delete $ENV{BASH_ENV};
569 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 632 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
570} 633}
571 634
572my @hook_count;
573my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 635my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
574 636
575sub verbose { 637sub verbose {
576 my ($level, $msg) = @_; 638 my ($level, $msg) = @_;
577 warn "$msg\n" if $level <= $verbosity; 639 warn "$msg\n" if $level <= $verbosity;
578} 640}
579 641
580my $extension_pkg = "extension0000";
581my %extension_pkg; 642my %extension_pkg;
582 643
583# load a single script into its own package, once only 644# load a single script into its own package, once only
584sub extension_package($) { 645sub extension_package($) {
585 my ($path) = @_; 646 my ($path) = @_;
586 647
648 no strict 'refs';
649
587 $extension_pkg{$path} ||= do { 650 $extension_pkg{$path} ||= do {
588 my $pkg = "urxvt::" . ($extension_pkg++); 651 $path =~ /([^\/\\]+)$/;
652 my $pkg = $1;
653 $pkg =~ s/[^[:word:]]/_/g;
654 $pkg = "urxvt::ext::$pkg";
589 655
590 verbose 3, "loading extension '$path' into package '$pkg'"; 656 verbose 3, "loading extension '$path' into package '$pkg'";
591 657
592 open my $fh, "<:raw", $path 658 open my $fh, "<:raw", $path
593 or die "$path: $!"; 659 or die "$path: $!";
594 660
661 @{"$pkg\::ISA"} = urxvt::term::extension::;
662
595 my $source = untaint 663 my $source =
596 "package $pkg; use strict; use utf8;\n" 664 "package $pkg; use strict; use utf8;\n"
597 . "use base urxvt::term::extension::;\n"
598 . "#line 1 \"$path\"\n{\n" 665 . "#line 1 \"$path\"\n{\n"
599 . (do { local $/; <$fh> }) 666 . (do { local $/; <$fh> })
600 . "\n};\n1"; 667 . "\n};\n1";
601 668
602 eval $source 669 eval $source
665 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 732 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666 if $verbosity >= 11; 733 if $verbosity >= 11;
667 } 734 }
668 735
669 if ($htype == 1) { # DESTROY 736 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 737 # clear package objects
678 %$_ = () for values %{ $TERM->{_pkg} }; 738 %$_ = () for values %{ $TERM->{_pkg} };
679 739
680 # clear package 740 # clear package
681 %$TERM = (); 741 %$TERM = ();
707 while (my ($name, $cb) = each %hook) { 767 while (my ($name, $cb) = each %hook) {
708 my $htype = $HOOKTYPE{uc $name}; 768 my $htype = $HOOKTYPE{uc $name};
709 defined $htype 769 defined $htype
710 or Carp::croak "unsupported hook type '$name'"; 770 or Carp::croak "unsupported hook type '$name'";
711 771
772 $self->set_should_invoke ($htype, +1)
712 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 773 unless exists $self->{term}{_hook}[$htype]{$pkg};
713 $hook_count[$htype]++
714 or urxvt::set_should_invoke $htype, 1;
715 }
716 774
717 $self->{term}{_hook}[$htype]{$pkg} = $cb; 775 $self->{term}{_hook}[$htype]{$pkg} = $cb;
718 } 776 }
719} 777}
720 778
725 for my $name (@hook) { 783 for my $name (@hook) {
726 my $htype = $HOOKTYPE{uc $name}; 784 my $htype = $HOOKTYPE{uc $name};
727 defined $htype 785 defined $htype
728 or Carp::croak "unsupported hook type '$name'"; 786 or Carp::croak "unsupported hook type '$name'";
729 787
788 $self->set_should_invoke ($htype, -1)
730 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 789 if delete $self->{term}{_hook}[$htype]{$pkg};
731 --$hook_count[$htype]
732 or urxvt::set_should_invoke $htype, 0;
733 }
734 } 790 }
735} 791}
736 792
737our $AUTOLOAD; 793our $AUTOLOAD;
738 794
1143 1199
1144=item $windowid = $term->vt 1200=item $windowid = $term->vt
1145 1201
1146Return the window id of the terminal window. 1202Return the window id of the terminal window.
1147 1203
1204=item $term->vt_emask_add ($x_event_mask)
1205
1206Adds the specified events to the vt event mask. Useful e.g. when you want
1207to receive pointer events all the times:
1208
1209 $term->vt_emask_add (urxvt::PointerMotionMask);
1210
1148=item $window_width = $term->width 1211=item $window_width = $term->width
1149 1212
1150=item $window_height = $term->height 1213=item $window_height = $term->height
1151 1214
1152=item $font_width = $term->fwidth 1215=item $font_width = $term->fwidth
1165 1228
1166=item $max_scrollback = $term->saveLines 1229=item $max_scrollback = $term->saveLines
1167 1230
1168=item $nrow_plus_saveLines = $term->total_rows 1231=item $nrow_plus_saveLines = $term->total_rows
1169 1232
1170=item $lines_in_scrollback = $term->nsaved 1233=item $topmost_scrollback_row = $term->top_row
1171 1234
1172Return various integers describing terminal characteristics. 1235Return various integers describing terminal characteristics.
1173 1236
1174=item $x_display = $term->display_id 1237=item $x_display = $term->display_id
1175 1238
1203Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1266Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1204AltGr), the meta key (often Alt) and the num lock key, if applicable. 1267AltGr), the meta key (often Alt) and the num lock key, if applicable.
1205 1268
1206=item $view_start = $term->view_start ([$newvalue]) 1269=item $view_start = $term->view_start ([$newvalue])
1207 1270
1208Returns the negative row number of the topmost line. Minimum value is 1271Returns the row number of the topmost displayed line. Maximum value is
1209C<0>, which displays the normal terminal contents. Larger values scroll 1272C<0>, which displays the normal terminal contents. Lower values scroll
1210this many lines into the scrollback buffer. 1273this many lines into the scrollback buffer.
1211 1274
1212=item $term->want_refresh 1275=item $term->want_refresh
1213 1276
1214Requests a screen refresh. At the next opportunity, rxvt-unicode will 1277Requests a screen refresh. At the next opportunity, rxvt-unicode will

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines