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.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.107 by root, Wed Jan 18 21:30:50 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 :)
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.
133 161
134=item mark-urls 162=item mark-urls
135 163
136Uses 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
137make them clickable. When middle-clicked, the program specified in the 165make them clickable. When middle-clicked, the program specified in the
138resource C<urlLauncher> (default C<x-www-browser>) will be started with 166resource C<urlLauncher> (default C<x-www-browser>) will be started with
139the URL as first argument. 167the URL as first argument.
140 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
141=item block-graphics-to-ascii 177=item block-graphics-to-ascii
142 178
143A 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,
144by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
145similar-looking ascii character. 181similar-looking ascii character.
… …
151=item example-refresh-hooks 187=item example-refresh-hooks
152 188
153Displays 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
154window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
155overlays 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/%
156 221
157=back 222=back
158 223
159=head1 API DOCUMENTATION 224=head1 API DOCUMENTATION
160 225
… …
361 426
362Called whenever the user presses a key combination that has a 427Called whenever the user presses a key combination that has a
363C<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>
364resource in the @@RXVT_NAME@@(1) manpage). 429resource in the @@RXVT_NAME@@(1) manpage).
365 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
366=item on_focus_in $term 437=item on_focus_in $term
367 438
368Called whenever the window gets the keyboard focus, before rxvt-unicode 439Called whenever the window gets the keyboard focus, before rxvt-unicode
369does focus in processing. 440does focus in processing.
370 441
371=item on_focus_out $term 442=item on_focus_out $term
372 443
373Called wheneever the window loses keyboard focus, before rxvt-unicode does 444Called wheneever the window loses keyboard focus, before rxvt-unicode does
374focus out processing. 445focus out processing.
446
447=item on_configure_notify $term, $event
375 448
376=item on_key_press $term, $event, $keysym, $octets 449=item on_key_press $term, $event, $keysym, $octets
377 450
378=item on_key_release $term, $event, $keysym 451=item on_key_release $term, $event, $keysym
379 452
… …
465Using 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
466correct place, e.g. on stderr of the connecting urxvtc client. 539correct place, e.g. on stderr of the connecting urxvtc client.
467 540
468Messages have a size limit of 1023 bytes currently. 541Messages have a size limit of 1023 bytes currently.
469 542
470=item $is_safe = urxvt::safe
471
472Returns true when it is safe to do potentially unsafe things, such as
473evaluating perl code specified by the user. This is true when urxvt was
474started setuid or setgid.
475
476=item $time = urxvt::NOW 543=item $time = urxvt::NOW
477 544
478Returns the "current time" (as per the event loop). 545Returns the "current time" (as per the event loop).
479 546
480=item urxvt::CurrentTime 547=item urxvt::CurrentTime
481 548
482=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 549=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 550Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484Button4Mask, 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
485 568
486Various constants for use in X calls and event processing. 569Various constants for use in X calls and event processing.
487 570
488=back 571=back
489 572
… …
540=back 623=back
541 624
542=cut 625=cut
543 626
544BEGIN { 627BEGIN {
545 urxvt->bootstrap;
546
547 # overwrite perl's warn 628 # overwrite perl's warn
548 *CORE::GLOBAL::warn = sub { 629 *CORE::GLOBAL::warn = sub {
549 my $msg = join "", @_; 630 my $msg = join "", @_;
550 $msg .= "\n" 631 $msg .= "\n"
551 unless $msg =~ /\n$/; 632 unless $msg =~ /\n$/;
552 urxvt::warn ($msg); 633 urxvt::warn ($msg);
553 }; 634 };
554
555 # %ENV is the original startup environment
556 delete $ENV{IFS};
557 delete $ENV{CDPATH};
558 delete $ENV{BASH_ENV};
559 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560} 635}
561 636
562my @hook_count;
563my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 637my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564 638
565sub verbose { 639sub verbose {
566 my ($level, $msg) = @_; 640 my ($level, $msg) = @_;
567 warn "$msg\n" if $level <= $verbosity; 641 warn "$msg\n" if $level <= $verbosity;
568} 642}
569 643
570my $extension_pkg = "extension0000";
571my %extension_pkg; 644my %extension_pkg;
572 645
573# load a single script into its own package, once only 646# load a single script into its own package, once only
574sub extension_package($) { 647sub extension_package($) {
575 my ($path) = @_; 648 my ($path) = @_;
576 649
650 no strict 'refs';
651
577 $extension_pkg{$path} ||= do { 652 $extension_pkg{$path} ||= do {
578 my $pkg = "urxvt::" . ($extension_pkg++); 653 $path =~ /([^\/\\]+)$/;
654 my $pkg = $1;
655 $pkg =~ s/[^[:word:]]/_/g;
656 $pkg = "urxvt::ext::$pkg";
579 657
580 verbose 3, "loading extension '$path' into package '$pkg'"; 658 verbose 3, "loading extension '$path' into package '$pkg'";
581 659
582 open my $fh, "<:raw", $path 660 open my $fh, "<:raw", $path
583 or die "$path: $!"; 661 or die "$path: $!";
584 662
663 @{"$pkg\::ISA"} = urxvt::term::extension::;
664
585 my $source = untaint 665 my $source =
586 "package $pkg; use strict; use utf8;\n" 666 "package $pkg; use strict; use utf8;\n"
587 . "use base urxvt::term::extension::;\n"
588 . "#line 1 \"$path\"\n{\n" 667 . "#line 1 \"$path\"\n{\n"
589 . (do { local $/; <$fh> }) 668 . (do { local $/; <$fh> })
590 . "\n};\n1"; 669 . "\n};\n1";
591 670
592 eval $source 671 eval $source
… …
655 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 734 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656 if $verbosity >= 11; 735 if $verbosity >= 11;
657 } 736 }
658 737
659 if ($htype == 1) { # DESTROY 738 if ($htype == 1) { # DESTROY
660 if (my $hook = delete $TERM->{_hook}) {
661 for my $htype (0..$#$hook) {
662 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
663 or set_should_invoke $htype, 0;
664 }
665 }
666
667 # clear package objects 739 # clear package objects
668 %$_ = () for values %{ $TERM->{_pkg} }; 740 %$_ = () for values %{ $TERM->{_pkg} };
669 741
670 # clear package 742 # clear package
671 %$TERM = (); 743 %$TERM = ();
… …
697 while (my ($name, $cb) = each %hook) { 769 while (my ($name, $cb) = each %hook) {
698 my $htype = $HOOKTYPE{uc $name}; 770 my $htype = $HOOKTYPE{uc $name};
699 defined $htype 771 defined $htype
700 or Carp::croak "unsupported hook type '$name'"; 772 or Carp::croak "unsupported hook type '$name'";
701 773
774 $self->set_should_invoke ($htype, +1)
702 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 775 unless exists $self->{term}{_hook}[$htype]{$pkg};
703 $hook_count[$htype]++
704 or urxvt::set_should_invoke $htype, 1;
705 }
706 776
707 $self->{term}{_hook}[$htype]{$pkg} = $cb; 777 $self->{term}{_hook}[$htype]{$pkg} = $cb;
708 } 778 }
709} 779}
710 780
… …
715 for my $name (@hook) { 785 for my $name (@hook) {
716 my $htype = $HOOKTYPE{uc $name}; 786 my $htype = $HOOKTYPE{uc $name};
717 defined $htype 787 defined $htype
718 or Carp::croak "unsupported hook type '$name'"; 788 or Carp::croak "unsupported hook type '$name'";
719 789
790 $self->set_should_invoke ($htype, -1)
720 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 791 if delete $self->{term}{_hook}[$htype]{$pkg};
721 --$hook_count[$htype]
722 or urxvt::set_should_invoke $htype, 0;
723 }
724 } 792 }
725} 793}
726 794
727our $AUTOLOAD; 795our $AUTOLOAD;
728 796
… …
885Here is a a likely non-exhaustive list of option names, please see the 953Here is a a likely non-exhaustive list of option names, please see the
886source file F</src/optinc.h> to see the actual list: 954source file F</src/optinc.h> to see the actual list:
887 955
888 borderLess console cursorBlink cursorUnderline hold iconic insecure 956 borderLess console cursorBlink cursorUnderline hold iconic insecure
889 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 957 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
890 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 958 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
891 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 959 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
892 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 960 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
893 tripleclickwords utmpInhibit visualBell 961 transparent tripleclickwords utmpInhibit visualBell
894 962
895=item $value = $term->resource ($name[, $newval]) 963=item $value = $term->resource ($name[, $newval])
896 964
897Returns the current resource value associated with a given name and 965Returns the current resource value associated with a given name and
898optionally sets a new value. Setting values is most useful in the C<init> 966optionally sets a new value. Setting values is most useful in the C<init>
… …
915 983
916 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 984 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
917 borderLess color cursorBlink cursorUnderline cutchars delete_key 985 borderLess color cursorBlink cursorUnderline cutchars delete_key
918 display_name embed ext_bwidth fade font geometry hold iconName 986 display_name embed ext_bwidth fade font geometry hold iconName
919 imFont imLocale inputMethod insecure int_bwidth intensityStyles 987 imFont imLocale inputMethod insecure int_bwidth intensityStyles
920 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 988 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
921 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 989 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
922 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 990 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
923 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 991 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
924 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 992 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
925 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 993 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
926 shade term_name title transparent transparent_all tripleclickwords 994 secondaryScreen secondaryScroll selectstyle shade term_name title
927 utmpInhibit visualBell 995 transient_for transparent transparent_all tripleclickwords utmpInhibit
996 visualBell
928 997
929=cut 998=cut
930 999
931sub resource($$;$) { 1000sub resource($$;$) {
932 my ($self, $name) = (shift, shift); 1001 my ($self, $name) = (shift, shift);
… …
1133 1202
1134=item $windowid = $term->vt 1203=item $windowid = $term->vt
1135 1204
1136Return the window id of the terminal window. 1205Return the window id of the terminal window.
1137 1206
1207=item $term->vt_emask_add ($x_event_mask)
1208
1209Adds the specified events to the vt event mask. Useful e.g. when you want
1210to receive pointer events all the times:
1211
1212 $term->vt_emask_add (urxvt::PointerMotionMask);
1213
1138=item $window_width = $term->width 1214=item $window_width = $term->width
1139 1215
1140=item $window_height = $term->height 1216=item $window_height = $term->height
1141 1217
1142=item $font_width = $term->fwidth 1218=item $font_width = $term->fwidth
… …
1155 1231
1156=item $max_scrollback = $term->saveLines 1232=item $max_scrollback = $term->saveLines
1157 1233
1158=item $nrow_plus_saveLines = $term->total_rows 1234=item $nrow_plus_saveLines = $term->total_rows
1159 1235
1160=item $lines_in_scrollback = $term->nsaved 1236=item $topmost_scrollback_row = $term->top_row
1161 1237
1162Return various integers describing terminal characteristics. 1238Return various integers describing terminal characteristics.
1163 1239
1164=item $x_display = $term->display_id 1240=item $x_display = $term->display_id
1165 1241
… …
1193Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1269Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194AltGr), the meta key (often Alt) and the num lock key, if applicable. 1270AltGr), the meta key (often Alt) and the num lock key, if applicable.
1195 1271
1196=item $view_start = $term->view_start ([$newvalue]) 1272=item $view_start = $term->view_start ([$newvalue])
1197 1273
1198Returns the negative row number of the topmost line. Minimum value is 1274Returns the row number of the topmost displayed line. Maximum value is
1199C<0>, which displays the normal terminal contents. Larger values scroll 1275C<0>, which displays the normal terminal contents. Lower values scroll
1200this many lines into the scrollback buffer. 1276this many lines into the scrollback buffer.
1201 1277
1202=item $term->want_refresh 1278=item $term->want_refresh
1203 1279
1204Requests a screen refresh. At the next opportunity, rxvt-unicode will 1280Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1517 my $env = $self->{term}->env; 1593 my $env = $self->{term}->env;
1518 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1594 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1519 delete $env->{LC_ALL}; 1595 delete $env->{LC_ALL};
1520 $env->{LC_CTYPE} = $self->{term}->locale; 1596 $env->{LC_CTYPE} = $self->{term}->locale;
1521 1597
1522 urxvt::term->new ($env, $self->{term}->resource ("name"), 1598 urxvt::term->new ($env, "popup",
1523 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1599 "--perl-lib" => "", "--perl-ext-common" => "",
1600 "-pty-fd" => -1, "-sl" => 0,
1601 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1524 "--transient-for" => $self->{term}->parent, 1602 "--transient-for" => $self->{term}->parent,
1525 "-display" => $self->{term}->display_id, 1603 "-display" => $self->{term}->display_id,
1526 "-pe" => "urxvt-popup") 1604 "-pe" => "urxvt-popup")
1527 or die "unable to create popup window\n"; 1605 or die "unable to create popup window\n";
1528} 1606}
… …
1580Start the timer. 1658Start the timer.
1581 1659
1582=item $timer = $timer->start ($tstamp) 1660=item $timer = $timer->start ($tstamp)
1583 1661
1584Set the event trigger time to C<$tstamp> and start the timer. 1662Set the event trigger time to C<$tstamp> and start the timer.
1663
1664=item $timer = $timer->after ($delay)
1665
1666Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1585 1667
1586=item $timer = $timer->stop 1668=item $timer = $timer->stop
1587 1669
1588Stop the timer. 1670Stop the timer.
1589 1671

Diff Legend

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