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.100 by root, Wed Jan 18 08:33:34 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
… …
70evalution, web-browser starting etc.), depending on content. 92evalution, web-browser starting etc.), depending on content.
71 93
72=item searchable-scrollback<hotkey> (enabled by default) 94=item searchable-scrollback<hotkey> (enabled by default)
73 95
74Adds regex search functionality to the scrollback buffer, triggered 96Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 97by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 98input/output is suspended and a regex is displayed at the bottom of the
99screen.
77 100
78C</> starts an incremental regex search, C<n> searches further, C<p> or 101Inputting 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 102search. 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> 103search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 104bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary
107selection.
82 108
83=item digital-clock 109=item selection-autotransform
84 110
85Displays a digital clock using the built-in overlay. 111This selection allows you to do automatic transforms on a selection
112whenever a selection is made.
113
114It works by specifying perl snippets (most useful is a single C<s///>
115operator) that modify C<$_> as resources:
116
117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform
119 ...
120
121For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>:
124
125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor:
129
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.
86 143
87=item mark-urls 144=item mark-urls
88 145
89Uses 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
90make them clickable. When middle-clicked, the program specified in the 147make them clickable. When middle-clicked, the program specified in the
91resource C<urlLauncher> (default C<x-www-browser>) will be started. 148resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument.
92 150
93=item block-graphics-to-ascii 151=item block-graphics-to-ascii
94 152
95A not very useful example of filtering all text output to the terminal, 153A not very useful example of filtering all text output to the terminal,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 154by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 155similar-looking ascii character.
98 156
157=item digital-clock
158
159Displays a digital clock using the built-in overlay.
160
99=item example-refresh-hooks 161=item example-refresh-hooks
100 162
101Displays 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
102window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
103overlays 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/%
104 195
105=back 196=back
106 197
107=head1 API DOCUMENTATION 198=head1 API DOCUMENTATION
108 199
… …
309 400
310Called whenever the user presses a key combination that has a 401Called whenever the user presses a key combination that has a
311C<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>
312resource in the @@RXVT_NAME@@(1) manpage). 403resource in the @@RXVT_NAME@@(1) manpage).
313 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
314=item on_focus_in $term 411=item on_focus_in $term
315 412
316Called whenever the window gets the keyboard focus, before rxvt-unicode 413Called whenever the window gets the keyboard focus, before rxvt-unicode
317does focus in processing. 414does focus in processing.
318 415
… …
413Using 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
414correct place, e.g. on stderr of the connecting urxvtc client. 511correct place, e.g. on stderr of the connecting urxvtc client.
415 512
416Messages have a size limit of 1023 bytes currently. 513Messages have a size limit of 1023 bytes currently.
417 514
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 515=item $time = urxvt::NOW
425 516
426Returns the "current time" (as per the event loop). 517Returns the "current time" (as per the event loop).
427 518
428=item urxvt::CurrentTime 519=item urxvt::CurrentTime
429 520
430=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 521=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 522Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432Button4Mask, 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
433 540
434Various constants for use in X calls and event processing. 541Various constants for use in X calls and event processing.
435 542
436=back 543=back
437 544
… …
488=back 595=back
489 596
490=cut 597=cut
491 598
492BEGIN { 599BEGIN {
493 urxvt->bootstrap;
494
495 # overwrite perl's warn 600 # overwrite perl's warn
496 *CORE::GLOBAL::warn = sub { 601 *CORE::GLOBAL::warn = sub {
497 my $msg = join "", @_; 602 my $msg = join "", @_;
498 $msg .= "\n" 603 $msg .= "\n"
499 unless $msg =~ /\n$/; 604 unless $msg =~ /\n$/;
… …
505 delete $ENV{CDPATH}; 610 delete $ENV{CDPATH};
506 delete $ENV{BASH_ENV}; 611 delete $ENV{BASH_ENV};
507 $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";
508} 613}
509 614
510my @hook_count;
511my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 615my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512 616
513sub verbose { 617sub verbose {
514 my ($level, $msg) = @_; 618 my ($level, $msg) = @_;
515 warn "$msg\n" if $level <= $verbosity; 619 warn "$msg\n" if $level <= $verbosity;
516} 620}
517 621
518my $extension_pkg = "extension0000";
519my %extension_pkg; 622my %extension_pkg;
520 623
521# load a single script into its own package, once only 624# load a single script into its own package, once only
522sub extension_package($) { 625sub extension_package($) {
523 my ($path) = @_; 626 my ($path) = @_;
524 627
628 no strict 'refs';
629
525 $extension_pkg{$path} ||= do { 630 $extension_pkg{$path} ||= do {
526 my $pkg = "urxvt::" . ($extension_pkg++); 631 $path =~ /([^\/\\]+)$/;
632 my $pkg = $1;
633 $pkg =~ s/[^[:word:]]/_/g;
634 $pkg = "urxvt::ext::$pkg";
527 635
528 verbose 3, "loading extension '$path' into package '$pkg'"; 636 verbose 3, "loading extension '$path' into package '$pkg'";
529 637
530 open my $fh, "<:raw", $path 638 open my $fh, "<:raw", $path
531 or die "$path: $!"; 639 or die "$path: $!";
532 640
641 @{"$pkg\::ISA"} = urxvt::term::extension::;
642
533 my $source = untaint 643 my $source =
534 "package $pkg; use strict; use utf8;\n" 644 "package $pkg; use strict; use utf8;\n"
535 . "use base urxvt::term::extension::;\n"
536 . "#line 1 \"$path\"\n{\n" 645 . "#line 1 \"$path\"\n{\n"
537 . (do { local $/; <$fh> }) 646 . (do { local $/; <$fh> })
538 . "\n};\n1"; 647 . "\n};\n1";
539 648
540 eval $source 649 eval $source
… …
603 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 712 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604 if $verbosity >= 11; 713 if $verbosity >= 11;
605 } 714 }
606 715
607 if ($htype == 1) { # DESTROY 716 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 717 # clear package objects
616 %$_ = () for values %{ $TERM->{_pkg} }; 718 %$_ = () for values %{ $TERM->{_pkg} };
617 719
618 # clear package 720 # clear package
619 %$TERM = (); 721 %$TERM = ();
… …
645 while (my ($name, $cb) = each %hook) { 747 while (my ($name, $cb) = each %hook) {
646 my $htype = $HOOKTYPE{uc $name}; 748 my $htype = $HOOKTYPE{uc $name};
647 defined $htype 749 defined $htype
648 or Carp::croak "unsupported hook type '$name'"; 750 or Carp::croak "unsupported hook type '$name'";
649 751
752 $self->set_should_invoke ($htype, +1)
650 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 753 unless exists $self->{term}{_hook}[$htype]{$pkg};
651 $hook_count[$htype]++
652 or urxvt::set_should_invoke $htype, 1;
653 }
654 754
655 $self->{term}{_hook}[$htype]{$pkg} = $cb; 755 $self->{term}{_hook}[$htype]{$pkg} = $cb;
656 } 756 }
657} 757}
658 758
… …
663 for my $name (@hook) { 763 for my $name (@hook) {
664 my $htype = $HOOKTYPE{uc $name}; 764 my $htype = $HOOKTYPE{uc $name};
665 defined $htype 765 defined $htype
666 or Carp::croak "unsupported hook type '$name'"; 766 or Carp::croak "unsupported hook type '$name'";
667 767
768 $self->set_should_invoke ($htype, -1)
668 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 769 if delete $self->{term}{_hook}[$htype]{$pkg};
669 --$hook_count[$htype]
670 or urxvt::set_should_invoke $htype, 0;
671 }
672 } 770 }
673} 771}
674 772
675our $AUTOLOAD; 773our $AUTOLOAD;
676 774
… …
1081 1179
1082=item $windowid = $term->vt 1180=item $windowid = $term->vt
1083 1181
1084Return the window id of the terminal window. 1182Return the window id of the terminal window.
1085 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
1086=item $window_width = $term->width 1191=item $window_width = $term->width
1087 1192
1088=item $window_height = $term->height 1193=item $window_height = $term->height
1089 1194
1090=item $font_width = $term->fwidth 1195=item $font_width = $term->fwidth
… …
1103 1208
1104=item $max_scrollback = $term->saveLines 1209=item $max_scrollback = $term->saveLines
1105 1210
1106=item $nrow_plus_saveLines = $term->total_rows 1211=item $nrow_plus_saveLines = $term->total_rows
1107 1212
1108=item $lines_in_scrollback = $term->nsaved 1213=item $topmost_scrollback_row = $term->top_row
1109 1214
1110Return various integers describing terminal characteristics. 1215Return various integers describing terminal characteristics.
1111 1216
1112=item $x_display = $term->display_id 1217=item $x_display = $term->display_id
1113 1218
… …
1141Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1246Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1142AltGr), 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.
1143 1248
1144=item $view_start = $term->view_start ([$newvalue]) 1249=item $view_start = $term->view_start ([$newvalue])
1145 1250
1146Returns the negative row number of the topmost line. Minimum value is 1251Returns the row number of the topmost displayed line. Maximum value is
1147C<0>, which displays the normal terminal contents. Larger values scroll 1252C<0>, which displays the normal terminal contents. Lower values scroll
1148this many lines into the scrollback buffer. 1253this many lines into the scrollback buffer.
1149 1254
1150=item $term->want_refresh 1255=item $term->want_refresh
1151 1256
1152Requests 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