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

Diff Legend

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