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.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.103 by root, Wed Jan 18 11:05:09 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
… …
117 URxvt.selection-autotransform.0: transform 135 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform 136 URxvt.selection-autotransform.1: transform
119 ... 137 ...
120 138
121For example, the following will transform selections of the form 139For example, the following will transform selections of the form
122C<word:number> into C<vi +$number $word>: 140C<filename:number>, often seen in compiler messages, into C<vi +$filename
141$word>:
123 142
124 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/ 143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125 144
126And 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
127paste directory into your (vi :) editor: 146paste directly into your (vi :) editor:
128 147
129 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\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.
130 161
131=item mark-urls 162=item mark-urls
132 163
133Uses 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
134make them clickable. When middle-clicked, the program specified in the 165make them clickable. When middle-clicked, the program specified in the
… …
148=item example-refresh-hooks 179=item example-refresh-hooks
149 180
150Displays a very simple digital clock in the upper right corner of the 181Displays a very simple digital clock in the upper right corner of the
151window. Illustrates overwriting the refresh callbacks to create your own 182window. Illustrates overwriting the refresh callbacks to create your own
152overlays or changes. 183overlays or changes.
184
185=item selection-pastebin
186
187This is a little rarely useful extension that Uploads the selection as
188textfile to a remote site (or does other things). (The implementation is
189not currently secure for use in a multiuser environment as it writes to
190F</tmp> directly.).
191
192It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
193i.e.
194
195 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
196
197Pressing this combination runs a command with C<%> replaced by the name of
198the textfile. This command can be set via a resource:
199
200 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
201
202And the default is likely not useful to anybody but the few people around
203here :)
204
205The name of the textfile is the hex encoded md5 sum of the selection, so
206the same content should lead to the same filename.
207
208After a successful upload the selection will be replaced by the text given
209in the C<selection-pastebin-url> resource (again, the % is the placeholder
210for the filename):
211
212 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
153 213
154=back 214=back
155 215
156=head1 API DOCUMENTATION 216=head1 API DOCUMENTATION
157 217
… …
358 418
359Called whenever the user presses a key combination that has a 419Called whenever the user presses a key combination that has a
360C<perl:string> action bound to it (see description of the B<keysym> 420C<perl:string> action bound to it (see description of the B<keysym>
361resource in the @@RXVT_NAME@@(1) manpage). 421resource in the @@RXVT_NAME@@(1) manpage).
362 422
423=item on_x_event $term, $event
424
425Called on every X event received on the vt window (and possibly other
426windows). Should only be used as a last resort. Most event structure
427members are not passed.
428
363=item on_focus_in $term 429=item on_focus_in $term
364 430
365Called whenever the window gets the keyboard focus, before rxvt-unicode 431Called whenever the window gets the keyboard focus, before rxvt-unicode
366does focus in processing. 432does focus in processing.
367 433
368=item on_focus_out $term 434=item on_focus_out $term
369 435
370Called wheneever the window loses keyboard focus, before rxvt-unicode does 436Called wheneever the window loses keyboard focus, before rxvt-unicode does
371focus out processing. 437focus out processing.
438
439=item on_configure_notify $term, $event
372 440
373=item on_key_press $term, $event, $keysym, $octets 441=item on_key_press $term, $event, $keysym, $octets
374 442
375=item on_key_release $term, $event, $keysym 443=item on_key_release $term, $event, $keysym
376 444
… …
462Using this function has the advantage that its output ends up in the 530Using this function has the advantage that its output ends up in the
463correct place, e.g. on stderr of the connecting urxvtc client. 531correct place, e.g. on stderr of the connecting urxvtc client.
464 532
465Messages have a size limit of 1023 bytes currently. 533Messages have a size limit of 1023 bytes currently.
466 534
467=item $is_safe = urxvt::safe
468
469Returns true when it is safe to do potentially unsafe things, such as
470evaluating perl code specified by the user. This is true when urxvt was
471started setuid or setgid.
472
473=item $time = urxvt::NOW 535=item $time = urxvt::NOW
474 536
475Returns the "current time" (as per the event loop). 537Returns the "current time" (as per the event loop).
476 538
477=item urxvt::CurrentTime 539=item urxvt::CurrentTime
478 540
479=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 541=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 542Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481Button4Mask, Button5Mask, AnyModifier 543Button4Mask, Button5Mask, AnyModifier
544
545=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
546ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
547PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
548Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
549KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
550ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
551FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
552
553=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
554EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
555GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
556UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
557ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
558CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
559SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
482 560
483Various constants for use in X calls and event processing. 561Various constants for use in X calls and event processing.
484 562
485=back 563=back
486 564
… …
537=back 615=back
538 616
539=cut 617=cut
540 618
541BEGIN { 619BEGIN {
542 urxvt->bootstrap;
543
544 # overwrite perl's warn 620 # overwrite perl's warn
545 *CORE::GLOBAL::warn = sub { 621 *CORE::GLOBAL::warn = sub {
546 my $msg = join "", @_; 622 my $msg = join "", @_;
547 $msg .= "\n" 623 $msg .= "\n"
548 unless $msg =~ /\n$/; 624 unless $msg =~ /\n$/;
… …
554 delete $ENV{CDPATH}; 630 delete $ENV{CDPATH};
555 delete $ENV{BASH_ENV}; 631 delete $ENV{BASH_ENV};
556 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 632 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
557} 633}
558 634
559my @hook_count;
560my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 635my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561 636
562sub verbose { 637sub verbose {
563 my ($level, $msg) = @_; 638 my ($level, $msg) = @_;
564 warn "$msg\n" if $level <= $verbosity; 639 warn "$msg\n" if $level <= $verbosity;
565} 640}
566 641
567my $extension_pkg = "extension0000";
568my %extension_pkg; 642my %extension_pkg;
569 643
570# load a single script into its own package, once only 644# load a single script into its own package, once only
571sub extension_package($) { 645sub extension_package($) {
572 my ($path) = @_; 646 my ($path) = @_;
573 647
648 no strict 'refs';
649
574 $extension_pkg{$path} ||= do { 650 $extension_pkg{$path} ||= do {
575 my $pkg = "urxvt::" . ($extension_pkg++); 651 $path =~ /([^\/\\]+)$/;
652 my $pkg = $1;
653 $pkg =~ s/[^[:word:]]/_/g;
654 $pkg = "urxvt::ext::$pkg";
576 655
577 verbose 3, "loading extension '$path' into package '$pkg'"; 656 verbose 3, "loading extension '$path' into package '$pkg'";
578 657
579 open my $fh, "<:raw", $path 658 open my $fh, "<:raw", $path
580 or die "$path: $!"; 659 or die "$path: $!";
581 660
661 @{"$pkg\::ISA"} = urxvt::term::extension::;
662
582 my $source = untaint 663 my $source =
583 "package $pkg; use strict; use utf8;\n" 664 "package $pkg; use strict; use utf8;\n"
584 . "use base urxvt::term::extension::;\n"
585 . "#line 1 \"$path\"\n{\n" 665 . "#line 1 \"$path\"\n{\n"
586 . (do { local $/; <$fh> }) 666 . (do { local $/; <$fh> })
587 . "\n};\n1"; 667 . "\n};\n1";
588 668
589 eval $source 669 eval $source
… …
652 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 732 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653 if $verbosity >= 11; 733 if $verbosity >= 11;
654 } 734 }
655 735
656 if ($htype == 1) { # DESTROY 736 if ($htype == 1) { # DESTROY
657 if (my $hook = delete $TERM->{_hook}) {
658 for my $htype (0..$#$hook) {
659 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
660 or set_should_invoke $htype, 0;
661 }
662 }
663
664 # clear package objects 737 # clear package objects
665 %$_ = () for values %{ $TERM->{_pkg} }; 738 %$_ = () for values %{ $TERM->{_pkg} };
666 739
667 # clear package 740 # clear package
668 %$TERM = (); 741 %$TERM = ();
… …
694 while (my ($name, $cb) = each %hook) { 767 while (my ($name, $cb) = each %hook) {
695 my $htype = $HOOKTYPE{uc $name}; 768 my $htype = $HOOKTYPE{uc $name};
696 defined $htype 769 defined $htype
697 or Carp::croak "unsupported hook type '$name'"; 770 or Carp::croak "unsupported hook type '$name'";
698 771
772 $self->set_should_invoke ($htype, +1)
699 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 773 unless exists $self->{term}{_hook}[$htype]{$pkg};
700 $hook_count[$htype]++
701 or urxvt::set_should_invoke $htype, 1;
702 }
703 774
704 $self->{term}{_hook}[$htype]{$pkg} = $cb; 775 $self->{term}{_hook}[$htype]{$pkg} = $cb;
705 } 776 }
706} 777}
707 778
… …
712 for my $name (@hook) { 783 for my $name (@hook) {
713 my $htype = $HOOKTYPE{uc $name}; 784 my $htype = $HOOKTYPE{uc $name};
714 defined $htype 785 defined $htype
715 or Carp::croak "unsupported hook type '$name'"; 786 or Carp::croak "unsupported hook type '$name'";
716 787
788 $self->set_should_invoke ($htype, -1)
717 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 789 if delete $self->{term}{_hook}[$htype]{$pkg};
718 --$hook_count[$htype]
719 or urxvt::set_should_invoke $htype, 0;
720 }
721 } 790 }
722} 791}
723 792
724our $AUTOLOAD; 793our $AUTOLOAD;
725 794
… …
1130 1199
1131=item $windowid = $term->vt 1200=item $windowid = $term->vt
1132 1201
1133Return the window id of the terminal window. 1202Return the window id of the terminal window.
1134 1203
1204=item $term->vt_emask_add ($x_event_mask)
1205
1206Adds the specified events to the vt event mask. Useful e.g. when you want
1207to receive pointer events all the times:
1208
1209 $term->vt_emask_add (urxvt::PointerMotionMask);
1210
1135=item $window_width = $term->width 1211=item $window_width = $term->width
1136 1212
1137=item $window_height = $term->height 1213=item $window_height = $term->height
1138 1214
1139=item $font_width = $term->fwidth 1215=item $font_width = $term->fwidth
… …
1152 1228
1153=item $max_scrollback = $term->saveLines 1229=item $max_scrollback = $term->saveLines
1154 1230
1155=item $nrow_plus_saveLines = $term->total_rows 1231=item $nrow_plus_saveLines = $term->total_rows
1156 1232
1157=item $lines_in_scrollback = $term->nsaved 1233=item $topmost_scrollback_row = $term->top_row
1158 1234
1159Return various integers describing terminal characteristics. 1235Return various integers describing terminal characteristics.
1160 1236
1161=item $x_display = $term->display_id 1237=item $x_display = $term->display_id
1162 1238
… …
1190Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1266Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1191AltGr), the meta key (often Alt) and the num lock key, if applicable. 1267AltGr), the meta key (often Alt) and the num lock key, if applicable.
1192 1268
1193=item $view_start = $term->view_start ([$newvalue]) 1269=item $view_start = $term->view_start ([$newvalue])
1194 1270
1195Returns the negative row number of the topmost line. Minimum value is 1271Returns the row number of the topmost displayed line. Maximum value is
1196C<0>, which displays the normal terminal contents. Larger values scroll 1272C<0>, which displays the normal terminal contents. Lower values scroll
1197this many lines into the scrollback buffer. 1273this many lines into the scrollback buffer.
1198 1274
1199=item $term->want_refresh 1275=item $term->want_refresh
1200 1276
1201Requests a screen refresh. At the next opportunity, rxvt-unicode will 1277Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1514 my $env = $self->{term}->env; 1590 my $env = $self->{term}->env;
1515 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1591 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1516 delete $env->{LC_ALL}; 1592 delete $env->{LC_ALL};
1517 $env->{LC_CTYPE} = $self->{term}->locale; 1593 $env->{LC_CTYPE} = $self->{term}->locale;
1518 1594
1519 urxvt::term->new ($env, $self->{term}->resource ("name"), 1595 urxvt::term->new ($env, "popup",
1520 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1596 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1521 "--transient-for" => $self->{term}->parent, 1597 "--transient-for" => $self->{term}->parent,
1522 "-display" => $self->{term}->display_id, 1598 "-display" => $self->{term}->display_id,
1523 "-pe" => "urxvt-popup") 1599 "-pe" => "urxvt-popup")
1524 or die "unable to create popup window\n"; 1600 or die "unable to create popup window\n";
… …
1577Start the timer. 1653Start the timer.
1578 1654
1579=item $timer = $timer->start ($tstamp) 1655=item $timer = $timer->start ($tstamp)
1580 1656
1581Set the event trigger time to C<$tstamp> and start the timer. 1657Set the event trigger time to C<$tstamp> and start the timer.
1658
1659=item $timer = $timer->after ($delay)
1660
1661Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1582 1662
1583=item $timer = $timer->stop 1663=item $timer = $timer->stop
1584 1664
1585Stop the timer. 1665Stop the timer.
1586 1666

Diff Legend

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