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.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC

… …
48C<--quoting-style=shell>. 48C<--quoting-style=shell>.
49 49
50A double-click usually selects the word under the cursor, further clicks 50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection. 51will enlarge the selection.
52 52
53The selection works by trying to match a number of regexes and displaying
54them in increasing order of length. You can add your own regexes by
55specifying resources of the form:
56
57 URxvt.selection.pattern-0: perl-regex
58 URxvt.selection.pattern-1: perl-regex
59 ...
60
61The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything
64between two vertical bars:
65
66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end.
70
53It also offers the following bindable keyboard command: 71This extension also offers following bindable keyboard commands:
54 72
55=over 4 73=over 4
56 74
57=item rot13 75=item rot13
58 76
… …
70=item selection-popup (enabled by default) 88=item selection-popup (enabled by default)
71 89
72Binds 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
73text into various other formats/action (such as uri unescaping, perl 91text into various other formats/action (such as uri unescaping, perl
74evalution, 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 };
75 111
76=item searchable-scrollback<hotkey> (enabled by default) 112=item searchable-scrollback<hotkey> (enabled by default)
77 113
78Adds regex search functionality to the scrollback buffer, triggered 114Adds regex search functionality to the scrollback buffer, triggered
79by 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
… …
86bottom. C<Escape> leaves search mode and returns to the point where search 122bottom. C<Escape> leaves search mode and returns to the point where search
87was started, while C<Enter> or C<Return> stay at the current position and 123was started, while C<Enter> or C<Return> stay at the current position and
88additionally stores the first match in the current line into the primary 124additionally stores the first match in the current line into the primary
89selection. 125selection.
90 126
91=item digital-clock 127=item selection-autotransform
92 128
93Displays a digital clock using the built-in overlay. 129This selection allows you to do automatic transforms on a selection
130whenever a selection is made.
131
132It works by specifying perl snippets (most useful is a single C<s///>
133operator) that modify C<$_> as resources:
134
135 URxvt.selection-autotransform.0: transform
136 URxvt.selection-autotransform.1: transform
137 ...
138
139For example, the following will transform selections of the form
140C<filename:number>, often seen in compiler messages, into C<vi +$filename
141$word>:
142
143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144
145And this example matches the same,but replaces it with vi-commands you can
146paste directly into your (vi :) editor:
147
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
149
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.
94 161
95=item mark-urls 162=item mark-urls
96 163
97Uses 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
98make them clickable. When middle-clicked, the program specified in the 165make them clickable. When middle-clicked, the program specified in the
… …
103 170
104A not very useful example of filtering all text output to the terminal, 171A not very useful example of filtering all text output to the terminal,
105by replacing all line-drawing characters (U+2500 .. U+259F) by a 172by replacing all line-drawing characters (U+2500 .. U+259F) by a
106similar-looking ascii character. 173similar-looking ascii character.
107 174
175=item digital-clock
176
177Displays a digital clock using the built-in overlay.
178
108=item example-refresh-hooks 179=item example-refresh-hooks
109 180
110Displays 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
111window. Illustrates overwriting the refresh callbacks to create your own 182window. Illustrates overwriting the refresh callbacks to create your own
112overlays 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/%
113 213
114=back 214=back
115 215
116=head1 API DOCUMENTATION 216=head1 API DOCUMENTATION
117 217
… …
318 418
319Called whenever the user presses a key combination that has a 419Called whenever the user presses a key combination that has a
320C<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>
321resource in the @@RXVT_NAME@@(1) manpage). 421resource in the @@RXVT_NAME@@(1) manpage).
322 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
323=item on_focus_in $term 429=item on_focus_in $term
324 430
325Called whenever the window gets the keyboard focus, before rxvt-unicode 431Called whenever the window gets the keyboard focus, before rxvt-unicode
326does focus in processing. 432does focus in processing.
327 433
328=item on_focus_out $term 434=item on_focus_out $term
329 435
330Called wheneever the window loses keyboard focus, before rxvt-unicode does 436Called wheneever the window loses keyboard focus, before rxvt-unicode does
331focus out processing. 437focus out processing.
438
439=item on_configure_notify $term, $event
332 440
333=item on_key_press $term, $event, $keysym, $octets 441=item on_key_press $term, $event, $keysym, $octets
334 442
335=item on_key_release $term, $event, $keysym 443=item on_key_release $term, $event, $keysym
336 444
… …
422Using 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
423correct place, e.g. on stderr of the connecting urxvtc client. 531correct place, e.g. on stderr of the connecting urxvtc client.
424 532
425Messages have a size limit of 1023 bytes currently. 533Messages have a size limit of 1023 bytes currently.
426 534
427=item $is_safe = urxvt::safe
428
429Returns true when it is safe to do potentially unsafe things, such as
430evaluating perl code specified by the user. This is true when urxvt was
431started setuid or setgid.
432
433=item $time = urxvt::NOW 535=item $time = urxvt::NOW
434 536
435Returns the "current time" (as per the event loop). 537Returns the "current time" (as per the event loop).
436 538
437=item urxvt::CurrentTime 539=item urxvt::CurrentTime
438 540
439=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 541=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 542Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441Button4Mask, 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
442 560
443Various constants for use in X calls and event processing. 561Various constants for use in X calls and event processing.
444 562
445=back 563=back
446 564
… …
497=back 615=back
498 616
499=cut 617=cut
500 618
501BEGIN { 619BEGIN {
502 urxvt->bootstrap;
503
504 # overwrite perl's warn 620 # overwrite perl's warn
505 *CORE::GLOBAL::warn = sub { 621 *CORE::GLOBAL::warn = sub {
506 my $msg = join "", @_; 622 my $msg = join "", @_;
507 $msg .= "\n" 623 $msg .= "\n"
508 unless $msg =~ /\n$/; 624 unless $msg =~ /\n$/;
… …
514 delete $ENV{CDPATH}; 630 delete $ENV{CDPATH};
515 delete $ENV{BASH_ENV}; 631 delete $ENV{BASH_ENV};
516 $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";
517} 633}
518 634
519my @hook_count;
520my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 635my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521 636
522sub verbose { 637sub verbose {
523 my ($level, $msg) = @_; 638 my ($level, $msg) = @_;
524 warn "$msg\n" if $level <= $verbosity; 639 warn "$msg\n" if $level <= $verbosity;
525} 640}
526 641
527my $extension_pkg = "extension0000";
528my %extension_pkg; 642my %extension_pkg;
529 643
530# load a single script into its own package, once only 644# load a single script into its own package, once only
531sub extension_package($) { 645sub extension_package($) {
532 my ($path) = @_; 646 my ($path) = @_;
533 647
648 no strict 'refs';
649
534 $extension_pkg{$path} ||= do { 650 $extension_pkg{$path} ||= do {
535 my $pkg = "urxvt::" . ($extension_pkg++); 651 $path =~ /([^\/\\]+)$/;
652 my $pkg = $1;
653 $pkg =~ s/[^[:word:]]/_/g;
654 $pkg = "urxvt::ext::$pkg";
536 655
537 verbose 3, "loading extension '$path' into package '$pkg'"; 656 verbose 3, "loading extension '$path' into package '$pkg'";
538 657
539 open my $fh, "<:raw", $path 658 open my $fh, "<:raw", $path
540 or die "$path: $!"; 659 or die "$path: $!";
541 660
661 @{"$pkg\::ISA"} = urxvt::term::extension::;
662
542 my $source = untaint 663 my $source =
543 "package $pkg; use strict; use utf8;\n" 664 "package $pkg; use strict; use utf8;\n"
544 . "use base urxvt::term::extension::;\n"
545 . "#line 1 \"$path\"\n{\n" 665 . "#line 1 \"$path\"\n{\n"
546 . (do { local $/; <$fh> }) 666 . (do { local $/; <$fh> })
547 . "\n};\n1"; 667 . "\n};\n1";
548 668
549 eval $source 669 eval $source
… …
612 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 732 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613 if $verbosity >= 11; 733 if $verbosity >= 11;
614 } 734 }
615 735
616 if ($htype == 1) { # DESTROY 736 if ($htype == 1) { # DESTROY
617 if (my $hook = delete $TERM->{_hook}) {
618 for my $htype (0..$#$hook) {
619 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
620 or set_should_invoke $htype, 0;
621 }
622 }
623
624 # clear package objects 737 # clear package objects
625 %$_ = () for values %{ $TERM->{_pkg} }; 738 %$_ = () for values %{ $TERM->{_pkg} };
626 739
627 # clear package 740 # clear package
628 %$TERM = (); 741 %$TERM = ();
… …
654 while (my ($name, $cb) = each %hook) { 767 while (my ($name, $cb) = each %hook) {
655 my $htype = $HOOKTYPE{uc $name}; 768 my $htype = $HOOKTYPE{uc $name};
656 defined $htype 769 defined $htype
657 or Carp::croak "unsupported hook type '$name'"; 770 or Carp::croak "unsupported hook type '$name'";
658 771
772 $self->set_should_invoke ($htype, +1)
659 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 773 unless exists $self->{term}{_hook}[$htype]{$pkg};
660 $hook_count[$htype]++
661 or urxvt::set_should_invoke $htype, 1;
662 }
663 774
664 $self->{term}{_hook}[$htype]{$pkg} = $cb; 775 $self->{term}{_hook}[$htype]{$pkg} = $cb;
665 } 776 }
666} 777}
667 778
… …
672 for my $name (@hook) { 783 for my $name (@hook) {
673 my $htype = $HOOKTYPE{uc $name}; 784 my $htype = $HOOKTYPE{uc $name};
674 defined $htype 785 defined $htype
675 or Carp::croak "unsupported hook type '$name'"; 786 or Carp::croak "unsupported hook type '$name'";
676 787
788 $self->set_should_invoke ($htype, -1)
677 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 789 if delete $self->{term}{_hook}[$htype]{$pkg};
678 --$hook_count[$htype]
679 or urxvt::set_should_invoke $htype, 0;
680 }
681 } 790 }
682} 791}
683 792
684our $AUTOLOAD; 793our $AUTOLOAD;
685 794
… …
1090 1199
1091=item $windowid = $term->vt 1200=item $windowid = $term->vt
1092 1201
1093Return the window id of the terminal window. 1202Return the window id of the terminal window.
1094 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
1095=item $window_width = $term->width 1211=item $window_width = $term->width
1096 1212
1097=item $window_height = $term->height 1213=item $window_height = $term->height
1098 1214
1099=item $font_width = $term->fwidth 1215=item $font_width = $term->fwidth
… …
1112 1228
1113=item $max_scrollback = $term->saveLines 1229=item $max_scrollback = $term->saveLines
1114 1230
1115=item $nrow_plus_saveLines = $term->total_rows 1231=item $nrow_plus_saveLines = $term->total_rows
1116 1232
1117=item $lines_in_scrollback = $term->nsaved 1233=item $topmost_scrollback_row = $term->top_row
1118 1234
1119Return various integers describing terminal characteristics. 1235Return various integers describing terminal characteristics.
1120 1236
1121=item $x_display = $term->display_id 1237=item $x_display = $term->display_id
1122 1238
… …
1150Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1266Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151AltGr), 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.
1152 1268
1153=item $view_start = $term->view_start ([$newvalue]) 1269=item $view_start = $term->view_start ([$newvalue])
1154 1270
1155Returns the negative row number of the topmost line. Minimum value is 1271Returns the row number of the topmost displayed line. Maximum value is
1156C<0>, which displays the normal terminal contents. Larger values scroll 1272C<0>, which displays the normal terminal contents. Lower values scroll
1157this many lines into the scrollback buffer. 1273this many lines into the scrollback buffer.
1158 1274
1159=item $term->want_refresh 1275=item $term->want_refresh
1160 1276
1161Requests 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