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.86 by root, Thu Jan 12 05:22:47 2006 UTC vs.
Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC

… …
40=over 4 40=over 4
41 41
42=item selection (enabled by default) 42=item selection (enabled by default)
43 43
44(More) intelligent selection. This extension tries to be more intelligent 44(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 45when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 46now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 47arguments, which is very convenient, too, if your F<ls> supports
48C<--quoting-style=shell>.
48 49
50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection.
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
49It also offers the following bindable keyboard command: 71This extension also offers following bindable keyboard commands:
50 72
51=over 4 73=over 4
52 74
53=item rot13 75=item rot13
54 76
… …
67 89
68Binds 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
69text into various other formats/action (such as uri unescaping, perl 91text into various other formats/action (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content. 92evalution, web-browser starting etc.), depending on content.
71 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 };
111
72=item searchable-scrollback<hotkey> (enabled by default) 112=item searchable-scrollback<hotkey> (enabled by default)
73 113
74Adds regex search functionality to the scrollback buffer, triggered 114Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 115by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 116input/output is suspended and a regex is displayed at the bottom of the
117screen.
77 118
78C</> starts an incremental regex search, C<n> searches further, C<p> or 119Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 120search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 121search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 122bottom. C<Escape> leaves search mode and returns to the point where search
123was started, while C<Enter> or C<Return> stay at the current position and
124additionally stores the first match in the current line into the primary
125selection.
82 126
83=item digital-clock 127=item selection-autotransform
84 128
85Displays 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.
86 161
87=item mark-urls 162=item mark-urls
88 163
89Uses 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
90make them clickable. When middle-clicked, the program specified in the 165make them clickable. When middle-clicked, the program specified in the
91resource C<urlLauncher> (default C<x-www-browser>) will be started. 166resource C<urlLauncher> (default C<x-www-browser>) will be started with
167the URL as first argument.
168
169=item automove-background
170
171This is basically a one-line extension that dynamically changes the background pixmap offset
172to the window position, in effect creating the same effect as pseudo transparency with
173a custom pixmap. No scaling is supported in this mode. Exmaple:
174
175 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
92 176
93=item block-graphics-to-ascii 177=item block-graphics-to-ascii
94 178
95A not very useful example of filtering all text output to the terminal, 179A not very useful example of filtering all text output to the terminal,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 181similar-looking ascii character.
98 182
183=item digital-clock
184
185Displays a digital clock using the built-in overlay.
186
99=item example-refresh-hooks 187=item example-refresh-hooks
100 188
101Displays a very simple digital clock in the upper right corner of the 189Displays a very simple digital clock in the upper right corner of the
102window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
103overlays or changes. 191overlays or changes.
192
193=item selection-pastebin
194
195This is a little rarely useful extension that Uploads the selection as
196textfile to a remote site (or does other things). (The implementation is
197not currently secure for use in a multiuser environment as it writes to
198F</tmp> directly.).
199
200It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
201i.e.
202
203 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
204
205Pressing this combination runs a command with C<%> replaced by the name of
206the textfile. This command can be set via a resource:
207
208 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
209
210And the default is likely not useful to anybody but the few people around
211here :)
212
213The name of the textfile is the hex encoded md5 sum of the selection, so
214the same content should lead to the same filename.
215
216After a successful upload the selection will be replaced by the text given
217in the C<selection-pastebin-url> resource (again, the % is the placeholder
218for the filename):
219
220 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
104 221
105=back 222=back
106 223
107=head1 API DOCUMENTATION 224=head1 API DOCUMENTATION
108 225
… …
309 426
310Called whenever the user presses a key combination that has a 427Called whenever the user presses a key combination that has a
311C<perl:string> action bound to it (see description of the B<keysym> 428C<perl:string> action bound to it (see description of the B<keysym>
312resource in the @@RXVT_NAME@@(1) manpage). 429resource in the @@RXVT_NAME@@(1) manpage).
313 430
431=item on_x_event $term, $event
432
433Called on every X event received on the vt window (and possibly other
434windows). Should only be used as a last resort. Most event structure
435members are not passed.
436
314=item on_focus_in $term 437=item on_focus_in $term
315 438
316Called whenever the window gets the keyboard focus, before rxvt-unicode 439Called whenever the window gets the keyboard focus, before rxvt-unicode
317does focus in processing. 440does focus in processing.
318 441
319=item on_focus_out $term 442=item on_focus_out $term
320 443
321Called wheneever the window loses keyboard focus, before rxvt-unicode does 444Called wheneever the window loses keyboard focus, before rxvt-unicode does
322focus out processing. 445focus out processing.
446
447=item on_configure_notify $term, $event
323 448
324=item on_key_press $term, $event, $keysym, $octets 449=item on_key_press $term, $event, $keysym, $octets
325 450
326=item on_key_release $term, $event, $keysym 451=item on_key_release $term, $event, $keysym
327 452
… …
413Using this function has the advantage that its output ends up in the 538Using this function has the advantage that its output ends up in the
414correct place, e.g. on stderr of the connecting urxvtc client. 539correct place, e.g. on stderr of the connecting urxvtc client.
415 540
416Messages have a size limit of 1023 bytes currently. 541Messages have a size limit of 1023 bytes currently.
417 542
418=item $is_safe = urxvt::safe
419
420Returns true when it is safe to do potentially unsafe things, such as
421evaluating perl code specified by the user. This is true when urxvt was
422started setuid or setgid.
423
424=item $time = urxvt::NOW 543=item $time = urxvt::NOW
425 544
426Returns the "current time" (as per the event loop). 545Returns the "current time" (as per the event loop).
427 546
428=item urxvt::CurrentTime 547=item urxvt::CurrentTime
429 548
430=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 549=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 550Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432Button4Mask, Button5Mask, AnyModifier 551Button4Mask, Button5Mask, AnyModifier
552
553=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
554ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
555PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
556Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
557KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
558ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
559FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
560
561=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
562EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
563GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
564UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
565ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
566CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
567SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
433 568
434Various constants for use in X calls and event processing. 569Various constants for use in X calls and event processing.
435 570
436=back 571=back
437 572
… …
488=back 623=back
489 624
490=cut 625=cut
491 626
492BEGIN { 627BEGIN {
493 urxvt->bootstrap;
494
495 # overwrite perl's warn 628 # overwrite perl's warn
496 *CORE::GLOBAL::warn = sub { 629 *CORE::GLOBAL::warn = sub {
497 my $msg = join "", @_; 630 my $msg = join "", @_;
498 $msg .= "\n" 631 $msg .= "\n"
499 unless $msg =~ /\n$/; 632 unless $msg =~ /\n$/;
… …
505 delete $ENV{CDPATH}; 638 delete $ENV{CDPATH};
506 delete $ENV{BASH_ENV}; 639 delete $ENV{BASH_ENV};
507 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 640 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
508} 641}
509 642
510my @hook_count;
511my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 643my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512 644
513sub verbose { 645sub verbose {
514 my ($level, $msg) = @_; 646 my ($level, $msg) = @_;
515 warn "$msg\n" if $level <= $verbosity; 647 warn "$msg\n" if $level <= $verbosity;
516} 648}
517 649
518my $extension_pkg = "extension0000";
519my %extension_pkg; 650my %extension_pkg;
520 651
521# load a single script into its own package, once only 652# load a single script into its own package, once only
522sub extension_package($) { 653sub extension_package($) {
523 my ($path) = @_; 654 my ($path) = @_;
524 655
656 no strict 'refs';
657
525 $extension_pkg{$path} ||= do { 658 $extension_pkg{$path} ||= do {
526 my $pkg = "urxvt::" . ($extension_pkg++); 659 $path =~ /([^\/\\]+)$/;
660 my $pkg = $1;
661 $pkg =~ s/[^[:word:]]/_/g;
662 $pkg = "urxvt::ext::$pkg";
527 663
528 verbose 3, "loading extension '$path' into package '$pkg'"; 664 verbose 3, "loading extension '$path' into package '$pkg'";
529 665
530 open my $fh, "<:raw", $path 666 open my $fh, "<:raw", $path
531 or die "$path: $!"; 667 or die "$path: $!";
532 668
669 @{"$pkg\::ISA"} = urxvt::term::extension::;
670
533 my $source = untaint 671 my $source =
534 "package $pkg; use strict; use utf8;\n" 672 "package $pkg; use strict; use utf8;\n"
535 . "use base urxvt::term::extension::;\n"
536 . "#line 1 \"$path\"\n{\n" 673 . "#line 1 \"$path\"\n{\n"
537 . (do { local $/; <$fh> }) 674 . (do { local $/; <$fh> })
538 . "\n};\n1"; 675 . "\n};\n1";
539 676
540 eval $source 677 eval $source
… …
603 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 740 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604 if $verbosity >= 11; 741 if $verbosity >= 11;
605 } 742 }
606 743
607 if ($htype == 1) { # DESTROY 744 if ($htype == 1) { # DESTROY
608 if (my $hook = delete $TERM->{_hook}) {
609 for my $htype (0..$#$hook) {
610 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
611 or set_should_invoke $htype, 0;
612 }
613 }
614
615 # clear package objects 745 # clear package objects
616 %$_ = () for values %{ $TERM->{_pkg} }; 746 %$_ = () for values %{ $TERM->{_pkg} };
617 747
618 # clear package 748 # clear package
619 %$TERM = (); 749 %$TERM = ();
… …
645 while (my ($name, $cb) = each %hook) { 775 while (my ($name, $cb) = each %hook) {
646 my $htype = $HOOKTYPE{uc $name}; 776 my $htype = $HOOKTYPE{uc $name};
647 defined $htype 777 defined $htype
648 or Carp::croak "unsupported hook type '$name'"; 778 or Carp::croak "unsupported hook type '$name'";
649 779
780 $self->set_should_invoke ($htype, +1)
650 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 781 unless exists $self->{term}{_hook}[$htype]{$pkg};
651 $hook_count[$htype]++
652 or urxvt::set_should_invoke $htype, 1;
653 }
654 782
655 $self->{term}{_hook}[$htype]{$pkg} = $cb; 783 $self->{term}{_hook}[$htype]{$pkg} = $cb;
656 } 784 }
657} 785}
658 786
… …
663 for my $name (@hook) { 791 for my $name (@hook) {
664 my $htype = $HOOKTYPE{uc $name}; 792 my $htype = $HOOKTYPE{uc $name};
665 defined $htype 793 defined $htype
666 or Carp::croak "unsupported hook type '$name'"; 794 or Carp::croak "unsupported hook type '$name'";
667 795
796 $self->set_should_invoke ($htype, -1)
668 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 797 if delete $self->{term}{_hook}[$htype]{$pkg};
669 --$hook_count[$htype]
670 or urxvt::set_should_invoke $htype, 0;
671 }
672 } 798 }
673} 799}
674 800
675our $AUTOLOAD; 801our $AUTOLOAD;
676 802
… …
1081 1207
1082=item $windowid = $term->vt 1208=item $windowid = $term->vt
1083 1209
1084Return the window id of the terminal window. 1210Return the window id of the terminal window.
1085 1211
1212=item $term->vt_emask_add ($x_event_mask)
1213
1214Adds the specified events to the vt event mask. Useful e.g. when you want
1215to receive pointer events all the times:
1216
1217 $term->vt_emask_add (urxvt::PointerMotionMask);
1218
1086=item $window_width = $term->width 1219=item $window_width = $term->width
1087 1220
1088=item $window_height = $term->height 1221=item $window_height = $term->height
1089 1222
1090=item $font_width = $term->fwidth 1223=item $font_width = $term->fwidth
… …
1103 1236
1104=item $max_scrollback = $term->saveLines 1237=item $max_scrollback = $term->saveLines
1105 1238
1106=item $nrow_plus_saveLines = $term->total_rows 1239=item $nrow_plus_saveLines = $term->total_rows
1107 1240
1108=item $lines_in_scrollback = $term->nsaved 1241=item $topmost_scrollback_row = $term->top_row
1109 1242
1110Return various integers describing terminal characteristics. 1243Return various integers describing terminal characteristics.
1111 1244
1112=item $x_display = $term->display_id 1245=item $x_display = $term->display_id
1113 1246
… …
1141Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1274Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1142AltGr), the meta key (often Alt) and the num lock key, if applicable. 1275AltGr), the meta key (often Alt) and the num lock key, if applicable.
1143 1276
1144=item $view_start = $term->view_start ([$newvalue]) 1277=item $view_start = $term->view_start ([$newvalue])
1145 1278
1146Returns the negative row number of the topmost line. Minimum value is 1279Returns the row number of the topmost displayed line. Maximum value is
1147C<0>, which displays the normal terminal contents. Larger values scroll 1280C<0>, which displays the normal terminal contents. Lower values scroll
1148this many lines into the scrollback buffer. 1281this many lines into the scrollback buffer.
1149 1282
1150=item $term->want_refresh 1283=item $term->want_refresh
1151 1284
1152Requests a screen refresh. At the next opportunity, rxvt-unicode will 1285Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1465 my $env = $self->{term}->env; 1598 my $env = $self->{term}->env;
1466 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1599 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1467 delete $env->{LC_ALL}; 1600 delete $env->{LC_ALL};
1468 $env->{LC_CTYPE} = $self->{term}->locale; 1601 $env->{LC_CTYPE} = $self->{term}->locale;
1469 1602
1470 urxvt::term->new ($env, $self->{term}->resource ("name"), 1603 urxvt::term->new ($env, "popup",
1471 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1604 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1472 "--transient-for" => $self->{term}->parent, 1605 "--transient-for" => $self->{term}->parent,
1473 "-display" => $self->{term}->display_id, 1606 "-display" => $self->{term}->display_id,
1474 "-pe" => "urxvt-popup") 1607 "-pe" => "urxvt-popup")
1475 or die "unable to create popup window\n"; 1608 or die "unable to create popup window\n";
… …
1528Start the timer. 1661Start the timer.
1529 1662
1530=item $timer = $timer->start ($tstamp) 1663=item $timer = $timer->start ($tstamp)
1531 1664
1532Set the event trigger time to C<$tstamp> and start the timer. 1665Set the event trigger time to C<$tstamp> and start the timer.
1666
1667=item $timer = $timer->after ($delay)
1668
1669Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1533 1670
1534=item $timer = $timer->stop 1671=item $timer = $timer->stop
1535 1672
1536Stop the timer. 1673Stop the timer.
1537 1674

Diff Legend

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