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.105 by root, Wed Jan 18 19:43:51 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:
… …
146Uses 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
147make them clickable. When middle-clicked, the program specified in the 165make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 166resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 167the URL as first argument.
150 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
176
151=item block-graphics-to-ascii 177=item block-graphics-to-ascii
152 178
153A 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,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 181similar-looking ascii character.
… …
161=item example-refresh-hooks 187=item example-refresh-hooks
162 188
163Displays 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
164window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
165overlays 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/%
166 221
167=back 222=back
168 223
169=head1 API DOCUMENTATION 224=head1 API DOCUMENTATION
170 225
… …
371 426
372Called whenever the user presses a key combination that has a 427Called whenever the user presses a key combination that has a
373C<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>
374resource in the @@RXVT_NAME@@(1) manpage). 429resource in the @@RXVT_NAME@@(1) manpage).
375 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
376=item on_focus_in $term 437=item on_focus_in $term
377 438
378Called whenever the window gets the keyboard focus, before rxvt-unicode 439Called whenever the window gets the keyboard focus, before rxvt-unicode
379does focus in processing. 440does focus in processing.
380 441
381=item on_focus_out $term 442=item on_focus_out $term
382 443
383Called wheneever the window loses keyboard focus, before rxvt-unicode does 444Called wheneever the window loses keyboard focus, before rxvt-unicode does
384focus out processing. 445focus out processing.
446
447=item on_configure_notify $term, $event
385 448
386=item on_key_press $term, $event, $keysym, $octets 449=item on_key_press $term, $event, $keysym, $octets
387 450
388=item on_key_release $term, $event, $keysym 451=item on_key_release $term, $event, $keysym
389 452
… …
475Using 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
476correct place, e.g. on stderr of the connecting urxvtc client. 539correct place, e.g. on stderr of the connecting urxvtc client.
477 540
478Messages have a size limit of 1023 bytes currently. 541Messages have a size limit of 1023 bytes currently.
479 542
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 543=item $time = urxvt::NOW
487 544
488Returns the "current time" (as per the event loop). 545Returns the "current time" (as per the event loop).
489 546
490=item urxvt::CurrentTime 547=item urxvt::CurrentTime
491 548
492=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 549=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 550Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494Button4Mask, 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
495 568
496Various constants for use in X calls and event processing. 569Various constants for use in X calls and event processing.
497 570
498=back 571=back
499 572
… …
550=back 623=back
551 624
552=cut 625=cut
553 626
554BEGIN { 627BEGIN {
555 urxvt->bootstrap;
556
557 # overwrite perl's warn 628 # overwrite perl's warn
558 *CORE::GLOBAL::warn = sub { 629 *CORE::GLOBAL::warn = sub {
559 my $msg = join "", @_; 630 my $msg = join "", @_;
560 $msg .= "\n" 631 $msg .= "\n"
561 unless $msg =~ /\n$/; 632 unless $msg =~ /\n$/;
… …
567 delete $ENV{CDPATH}; 638 delete $ENV{CDPATH};
568 delete $ENV{BASH_ENV}; 639 delete $ENV{BASH_ENV};
569 $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";
570} 641}
571 642
572my @hook_count;
573my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 643my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
574 644
575sub verbose { 645sub verbose {
576 my ($level, $msg) = @_; 646 my ($level, $msg) = @_;
577 warn "$msg\n" if $level <= $verbosity; 647 warn "$msg\n" if $level <= $verbosity;
578} 648}
579 649
580my $extension_pkg = "extension0000";
581my %extension_pkg; 650my %extension_pkg;
582 651
583# load a single script into its own package, once only 652# load a single script into its own package, once only
584sub extension_package($) { 653sub extension_package($) {
585 my ($path) = @_; 654 my ($path) = @_;
586 655
656 no strict 'refs';
657
587 $extension_pkg{$path} ||= do { 658 $extension_pkg{$path} ||= do {
588 my $pkg = "urxvt::" . ($extension_pkg++); 659 $path =~ /([^\/\\]+)$/;
660 my $pkg = $1;
661 $pkg =~ s/[^[:word:]]/_/g;
662 $pkg = "urxvt::ext::$pkg";
589 663
590 verbose 3, "loading extension '$path' into package '$pkg'"; 664 verbose 3, "loading extension '$path' into package '$pkg'";
591 665
592 open my $fh, "<:raw", $path 666 open my $fh, "<:raw", $path
593 or die "$path: $!"; 667 or die "$path: $!";
594 668
669 @{"$pkg\::ISA"} = urxvt::term::extension::;
670
595 my $source = untaint 671 my $source =
596 "package $pkg; use strict; use utf8;\n" 672 "package $pkg; use strict; use utf8;\n"
597 . "use base urxvt::term::extension::;\n"
598 . "#line 1 \"$path\"\n{\n" 673 . "#line 1 \"$path\"\n{\n"
599 . (do { local $/; <$fh> }) 674 . (do { local $/; <$fh> })
600 . "\n};\n1"; 675 . "\n};\n1";
601 676
602 eval $source 677 eval $source
… …
665 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 740 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666 if $verbosity >= 11; 741 if $verbosity >= 11;
667 } 742 }
668 743
669 if ($htype == 1) { # DESTROY 744 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 745 # clear package objects
678 %$_ = () for values %{ $TERM->{_pkg} }; 746 %$_ = () for values %{ $TERM->{_pkg} };
679 747
680 # clear package 748 # clear package
681 %$TERM = (); 749 %$TERM = ();
… …
707 while (my ($name, $cb) = each %hook) { 775 while (my ($name, $cb) = each %hook) {
708 my $htype = $HOOKTYPE{uc $name}; 776 my $htype = $HOOKTYPE{uc $name};
709 defined $htype 777 defined $htype
710 or Carp::croak "unsupported hook type '$name'"; 778 or Carp::croak "unsupported hook type '$name'";
711 779
780 $self->set_should_invoke ($htype, +1)
712 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 781 unless exists $self->{term}{_hook}[$htype]{$pkg};
713 $hook_count[$htype]++
714 or urxvt::set_should_invoke $htype, 1;
715 }
716 782
717 $self->{term}{_hook}[$htype]{$pkg} = $cb; 783 $self->{term}{_hook}[$htype]{$pkg} = $cb;
718 } 784 }
719} 785}
720 786
… …
725 for my $name (@hook) { 791 for my $name (@hook) {
726 my $htype = $HOOKTYPE{uc $name}; 792 my $htype = $HOOKTYPE{uc $name};
727 defined $htype 793 defined $htype
728 or Carp::croak "unsupported hook type '$name'"; 794 or Carp::croak "unsupported hook type '$name'";
729 795
796 $self->set_should_invoke ($htype, -1)
730 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 797 if delete $self->{term}{_hook}[$htype]{$pkg};
731 --$hook_count[$htype]
732 or urxvt::set_should_invoke $htype, 0;
733 }
734 } 798 }
735} 799}
736 800
737our $AUTOLOAD; 801our $AUTOLOAD;
738 802
… …
895Here is a a likely non-exhaustive list of option names, please see the 959Here is a a likely non-exhaustive list of option names, please see the
896source file F</src/optinc.h> to see the actual list: 960source file F</src/optinc.h> to see the actual list:
897 961
898 borderLess console cursorBlink cursorUnderline hold iconic insecure 962 borderLess console cursorBlink cursorUnderline hold iconic insecure
899 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 963 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
900 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 964 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
901 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 965 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
902 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 966 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
903 tripleclickwords utmpInhibit visualBell 967 transparent tripleclickwords utmpInhibit visualBell
904 968
905=item $value = $term->resource ($name[, $newval]) 969=item $value = $term->resource ($name[, $newval])
906 970
907Returns the current resource value associated with a given name and 971Returns the current resource value associated with a given name and
908optionally sets a new value. Setting values is most useful in the C<init> 972optionally sets a new value. Setting values is most useful in the C<init>
… …
925 989
926 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 990 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
927 borderLess color cursorBlink cursorUnderline cutchars delete_key 991 borderLess color cursorBlink cursorUnderline cutchars delete_key
928 display_name embed ext_bwidth fade font geometry hold iconName 992 display_name embed ext_bwidth fade font geometry hold iconName
929 imFont imLocale inputMethod insecure int_bwidth intensityStyles 993 imFont imLocale inputMethod insecure int_bwidth intensityStyles
930 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 994 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
931 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 995 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
932 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 996 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
933 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 997 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
934 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 998 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
935 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 999 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
936 shade term_name title transparent transparent_all tripleclickwords 1000 secondaryScreen secondaryScroll selectstyle shade term_name title
937 utmpInhibit visualBell 1001 transient_for transparent transparent_all tripleclickwords utmpInhibit
1002 visualBell
938 1003
939=cut 1004=cut
940 1005
941sub resource($$;$) { 1006sub resource($$;$) {
942 my ($self, $name) = (shift, shift); 1007 my ($self, $name) = (shift, shift);
… …
1143 1208
1144=item $windowid = $term->vt 1209=item $windowid = $term->vt
1145 1210
1146Return the window id of the terminal window. 1211Return the window id of the terminal window.
1147 1212
1213=item $term->vt_emask_add ($x_event_mask)
1214
1215Adds the specified events to the vt event mask. Useful e.g. when you want
1216to receive pointer events all the times:
1217
1218 $term->vt_emask_add (urxvt::PointerMotionMask);
1219
1148=item $window_width = $term->width 1220=item $window_width = $term->width
1149 1221
1150=item $window_height = $term->height 1222=item $window_height = $term->height
1151 1223
1152=item $font_width = $term->fwidth 1224=item $font_width = $term->fwidth
… …
1165 1237
1166=item $max_scrollback = $term->saveLines 1238=item $max_scrollback = $term->saveLines
1167 1239
1168=item $nrow_plus_saveLines = $term->total_rows 1240=item $nrow_plus_saveLines = $term->total_rows
1169 1241
1170=item $lines_in_scrollback = $term->nsaved 1242=item $topmost_scrollback_row = $term->top_row
1171 1243
1172Return various integers describing terminal characteristics. 1244Return various integers describing terminal characteristics.
1173 1245
1174=item $x_display = $term->display_id 1246=item $x_display = $term->display_id
1175 1247
… …
1203Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1275Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1204AltGr), the meta key (often Alt) and the num lock key, if applicable. 1276AltGr), the meta key (often Alt) and the num lock key, if applicable.
1205 1277
1206=item $view_start = $term->view_start ([$newvalue]) 1278=item $view_start = $term->view_start ([$newvalue])
1207 1279
1208Returns the negative row number of the topmost line. Minimum value is 1280Returns the row number of the topmost displayed line. Maximum value is
1209C<0>, which displays the normal terminal contents. Larger values scroll 1281C<0>, which displays the normal terminal contents. Lower values scroll
1210this many lines into the scrollback buffer. 1282this many lines into the scrollback buffer.
1211 1283
1212=item $term->want_refresh 1284=item $term->want_refresh
1213 1285
1214Requests a screen refresh. At the next opportunity, rxvt-unicode will 1286Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1527 my $env = $self->{term}->env; 1599 my $env = $self->{term}->env;
1528 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1600 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1529 delete $env->{LC_ALL}; 1601 delete $env->{LC_ALL};
1530 $env->{LC_CTYPE} = $self->{term}->locale; 1602 $env->{LC_CTYPE} = $self->{term}->locale;
1531 1603
1532 urxvt::term->new ($env, $self->{term}->resource ("name"), 1604 urxvt::term->new ($env, "popup",
1533 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1605 "--perl-lib" => "", "--perl-ext-common" => "",
1606 "-pty-fd" => -1, "-sl" => 0, "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1534 "--transient-for" => $self->{term}->parent, 1607 "--transient-for" => $self->{term}->parent,
1535 "-display" => $self->{term}->display_id, 1608 "-display" => $self->{term}->display_id,
1536 "-pe" => "urxvt-popup") 1609 "-pe" => "urxvt-popup")
1537 or die "unable to create popup window\n"; 1610 or die "unable to create popup window\n";
1538} 1611}
… …
1590Start the timer. 1663Start the timer.
1591 1664
1592=item $timer = $timer->start ($tstamp) 1665=item $timer = $timer->start ($tstamp)
1593 1666
1594Set the event trigger time to C<$tstamp> and start the timer. 1667Set the event trigger time to C<$tstamp> and start the timer.
1668
1669=item $timer = $timer->after ($delay)
1670
1671Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1595 1672
1596=item $timer = $timer->stop 1673=item $timer = $timer->stop
1597 1674
1598Stop the timer. 1675Stop the timer.
1599 1676

Diff Legend

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