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.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
… …
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
… …
151=item example-refresh-hooks 179=item example-refresh-hooks
152 180
153Displays 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
154window. Illustrates overwriting the refresh callbacks to create your own 182window. Illustrates overwriting the refresh callbacks to create your own
155overlays 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/%
156 213
157=back 214=back
158 215
159=head1 API DOCUMENTATION 216=head1 API DOCUMENTATION
160 217
… …
361 418
362Called whenever the user presses a key combination that has a 419Called whenever the user presses a key combination that has a
363C<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>
364resource in the @@RXVT_NAME@@(1) manpage). 421resource in the @@RXVT_NAME@@(1) manpage).
365 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
366=item on_focus_in $term 429=item on_focus_in $term
367 430
368Called whenever the window gets the keyboard focus, before rxvt-unicode 431Called whenever the window gets the keyboard focus, before rxvt-unicode
369does focus in processing. 432does focus in processing.
370 433
371=item on_focus_out $term 434=item on_focus_out $term
372 435
373Called wheneever the window loses keyboard focus, before rxvt-unicode does 436Called wheneever the window loses keyboard focus, before rxvt-unicode does
374focus out processing. 437focus out processing.
438
439=item on_configure_notify $term, $event
375 440
376=item on_key_press $term, $event, $keysym, $octets 441=item on_key_press $term, $event, $keysym, $octets
377 442
378=item on_key_release $term, $event, $keysym 443=item on_key_release $term, $event, $keysym
379 444
… …
465Using 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
466correct place, e.g. on stderr of the connecting urxvtc client. 531correct place, e.g. on stderr of the connecting urxvtc client.
467 532
468Messages have a size limit of 1023 bytes currently. 533Messages have a size limit of 1023 bytes currently.
469 534
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 535=item $time = urxvt::NOW
477 536
478Returns the "current time" (as per the event loop). 537Returns the "current time" (as per the event loop).
479 538
480=item urxvt::CurrentTime 539=item urxvt::CurrentTime
481 540
482=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 541=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 542Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484Button4Mask, 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
485 560
486Various constants for use in X calls and event processing. 561Various constants for use in X calls and event processing.
487 562
488=back 563=back
489 564
… …
540=back 615=back
541 616
542=cut 617=cut
543 618
544BEGIN { 619BEGIN {
545 urxvt->bootstrap;
546
547 # overwrite perl's warn 620 # overwrite perl's warn
548 *CORE::GLOBAL::warn = sub { 621 *CORE::GLOBAL::warn = sub {
549 my $msg = join "", @_; 622 my $msg = join "", @_;
550 $msg .= "\n" 623 $msg .= "\n"
551 unless $msg =~ /\n$/; 624 unless $msg =~ /\n$/;
… …
557 delete $ENV{CDPATH}; 630 delete $ENV{CDPATH};
558 delete $ENV{BASH_ENV}; 631 delete $ENV{BASH_ENV};
559 $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";
560} 633}
561 634
562my @hook_count;
563my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 635my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564 636
565sub verbose { 637sub verbose {
566 my ($level, $msg) = @_; 638 my ($level, $msg) = @_;
567 warn "$msg\n" if $level <= $verbosity; 639 warn "$msg\n" if $level <= $verbosity;
568} 640}
569 641
570my $extension_pkg = "extension0000";
571my %extension_pkg; 642my %extension_pkg;
572 643
573# load a single script into its own package, once only 644# load a single script into its own package, once only
574sub extension_package($) { 645sub extension_package($) {
575 my ($path) = @_; 646 my ($path) = @_;
576 647
648 no strict 'refs';
649
577 $extension_pkg{$path} ||= do { 650 $extension_pkg{$path} ||= do {
578 my $pkg = "urxvt::" . ($extension_pkg++); 651 $path =~ /([^\/\\]+)$/;
652 my $pkg = $1;
653 $pkg =~ s/[^[:word:]]/_/g;
654 $pkg = "urxvt::ext::$pkg";
579 655
580 verbose 3, "loading extension '$path' into package '$pkg'"; 656 verbose 3, "loading extension '$path' into package '$pkg'";
581 657
582 open my $fh, "<:raw", $path 658 open my $fh, "<:raw", $path
583 or die "$path: $!"; 659 or die "$path: $!";
584 660
661 @{"$pkg\::ISA"} = urxvt::term::extension::;
662
585 my $source = untaint 663 my $source =
586 "package $pkg; use strict; use utf8;\n" 664 "package $pkg; use strict; use utf8;\n"
587 . "use base urxvt::term::extension::;\n"
588 . "#line 1 \"$path\"\n{\n" 665 . "#line 1 \"$path\"\n{\n"
589 . (do { local $/; <$fh> }) 666 . (do { local $/; <$fh> })
590 . "\n};\n1"; 667 . "\n};\n1";
591 668
592 eval $source 669 eval $source
… …
655 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 732 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656 if $verbosity >= 11; 733 if $verbosity >= 11;
657 } 734 }
658 735
659 if ($htype == 1) { # DESTROY 736 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 737 # clear package objects
668 %$_ = () for values %{ $TERM->{_pkg} }; 738 %$_ = () for values %{ $TERM->{_pkg} };
669 739
670 # clear package 740 # clear package
671 %$TERM = (); 741 %$TERM = ();
… …
697 while (my ($name, $cb) = each %hook) { 767 while (my ($name, $cb) = each %hook) {
698 my $htype = $HOOKTYPE{uc $name}; 768 my $htype = $HOOKTYPE{uc $name};
699 defined $htype 769 defined $htype
700 or Carp::croak "unsupported hook type '$name'"; 770 or Carp::croak "unsupported hook type '$name'";
701 771
772 $self->set_should_invoke ($htype, +1)
702 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 773 unless exists $self->{term}{_hook}[$htype]{$pkg};
703 $hook_count[$htype]++
704 or urxvt::set_should_invoke $htype, 1;
705 }
706 774
707 $self->{term}{_hook}[$htype]{$pkg} = $cb; 775 $self->{term}{_hook}[$htype]{$pkg} = $cb;
708 } 776 }
709} 777}
710 778
… …
715 for my $name (@hook) { 783 for my $name (@hook) {
716 my $htype = $HOOKTYPE{uc $name}; 784 my $htype = $HOOKTYPE{uc $name};
717 defined $htype 785 defined $htype
718 or Carp::croak "unsupported hook type '$name'"; 786 or Carp::croak "unsupported hook type '$name'";
719 787
788 $self->set_should_invoke ($htype, -1)
720 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 789 if delete $self->{term}{_hook}[$htype]{$pkg};
721 --$hook_count[$htype]
722 or urxvt::set_should_invoke $htype, 0;
723 }
724 } 790 }
725} 791}
726 792
727our $AUTOLOAD; 793our $AUTOLOAD;
728 794
… …
1133 1199
1134=item $windowid = $term->vt 1200=item $windowid = $term->vt
1135 1201
1136Return the window id of the terminal window. 1202Return the window id of the terminal window.
1137 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
1138=item $window_width = $term->width 1211=item $window_width = $term->width
1139 1212
1140=item $window_height = $term->height 1213=item $window_height = $term->height
1141 1214
1142=item $font_width = $term->fwidth 1215=item $font_width = $term->fwidth
… …
1155 1228
1156=item $max_scrollback = $term->saveLines 1229=item $max_scrollback = $term->saveLines
1157 1230
1158=item $nrow_plus_saveLines = $term->total_rows 1231=item $nrow_plus_saveLines = $term->total_rows
1159 1232
1160=item $lines_in_scrollback = $term->nsaved 1233=item $topmost_scrollback_row = $term->top_row
1161 1234
1162Return various integers describing terminal characteristics. 1235Return various integers describing terminal characteristics.
1163 1236
1164=item $x_display = $term->display_id 1237=item $x_display = $term->display_id
1165 1238
… …
1193Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1266Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194AltGr), 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.
1195 1268
1196=item $view_start = $term->view_start ([$newvalue]) 1269=item $view_start = $term->view_start ([$newvalue])
1197 1270
1198Returns the negative row number of the topmost line. Minimum value is 1271Returns the row number of the topmost displayed line. Maximum value is
1199C<0>, which displays the normal terminal contents. Larger values scroll 1272C<0>, which displays the normal terminal contents. Lower values scroll
1200this many lines into the scrollback buffer. 1273this many lines into the scrollback buffer.
1201 1274
1202=item $term->want_refresh 1275=item $term->want_refresh
1203 1276
1204Requests a screen refresh. At the next opportunity, rxvt-unicode will 1277Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1517 my $env = $self->{term}->env; 1590 my $env = $self->{term}->env;
1518 # 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.
1519 delete $env->{LC_ALL}; 1592 delete $env->{LC_ALL};
1520 $env->{LC_CTYPE} = $self->{term}->locale; 1593 $env->{LC_CTYPE} = $self->{term}->locale;
1521 1594
1522 urxvt::term->new ($env, $self->{term}->resource ("name"), 1595 urxvt::term->new ($env, "popup",
1523 "--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,
1524 "--transient-for" => $self->{term}->parent, 1597 "--transient-for" => $self->{term}->parent,
1525 "-display" => $self->{term}->display_id, 1598 "-display" => $self->{term}->display_id,
1526 "-pe" => "urxvt-popup") 1599 "-pe" => "urxvt-popup")
1527 or die "unable to create popup window\n"; 1600 or die "unable to create popup window\n";
… …
1580Start the timer. 1653Start the timer.
1581 1654
1582=item $timer = $timer->start ($tstamp) 1655=item $timer = $timer->start ($tstamp)
1583 1656
1584Set 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>.
1585 1662
1586=item $timer = $timer->stop 1663=item $timer = $timer->stop
1587 1664
1588Stop the timer. 1665Stop the timer.
1589 1666

Diff Legend

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