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.96 by root, Tue Jan 17 16:22:41 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
77Rot-13 the selection when activated. Used via keyboard trigger: 77Rot-13 the selection when activated. Used via keyboard trigger:
78 78
79 URxvt.keysym.C-M-r: perl:selection:rot13 79 URxvt.keysym.C-M-r: perl:selection:rot13
80
81=item remote-pastebin
82
83Upload the selection as textfile to a remote site.
84
85 URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87To set the command to upload the file set this resource:
88
89 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92md5 sum of the selection.
93After an successful upload the selection will be replaced by the following url
94(the % is the placeholder for the filename):
95
96 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
80 97
81=back 98=back
82 99
83=item option-popup (enabled by default) 100=item option-popup (enabled by default)
84 101
117 URxvt.selection-autotransform.0: transform 134 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform 135 URxvt.selection-autotransform.1: transform
119 ... 136 ...
120 137
121For example, the following will transform selections of the form 138For example, the following will transform selections of the form
122C<word:number> into C<vi +$number $word>: 139C<filename:number>, often seen in compiler messages, into C<vi +$filename
140$word>:
123 141
124 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/ 142 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125 143
126And this example matches the same,but replaces it with vi-commands you can 144And this example matches the same,but replaces it with vi-commands you can
127paste directory into your (vi :) editor: 145paste directly into your (vi :) editor:
128 146
129 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/ 147 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
148
149Of course, this can be modified to suit your needs and your editor :)
150
151To expand the example above to typical perl error messages ("XXX at
152FILENAME line YYY."), you need a slightly more elaborate solution:
153
154 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
155 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
156
157The first line tells the selection code to treat the unchanging part of
158every error message as a selection pattern, and the second line transforms
159the message into vi commands to load the file.
130 160
131=item mark-urls 161=item mark-urls
132 162
133Uses per-line display filtering (C<on_line_update>) to underline urls and 163Uses per-line display filtering (C<on_line_update>) to underline urls and
134make them clickable. When middle-clicked, the program specified in the 164make them clickable. When middle-clicked, the program specified in the
358 388
359Called whenever the user presses a key combination that has a 389Called whenever the user presses a key combination that has a
360C<perl:string> action bound to it (see description of the B<keysym> 390C<perl:string> action bound to it (see description of the B<keysym>
361resource in the @@RXVT_NAME@@(1) manpage). 391resource in the @@RXVT_NAME@@(1) manpage).
362 392
393=item on_x_event $term, $event
394
395Called on every X event received on the vt window (and possibly other
396windows). Should only be used as a last resort. Most event structure
397members are not passed.
398
363=item on_focus_in $term 399=item on_focus_in $term
364 400
365Called whenever the window gets the keyboard focus, before rxvt-unicode 401Called whenever the window gets the keyboard focus, before rxvt-unicode
366does focus in processing. 402does focus in processing.
367 403
462Using this function has the advantage that its output ends up in the 498Using this function has the advantage that its output ends up in the
463correct place, e.g. on stderr of the connecting urxvtc client. 499correct place, e.g. on stderr of the connecting urxvtc client.
464 500
465Messages have a size limit of 1023 bytes currently. 501Messages have a size limit of 1023 bytes currently.
466 502
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 503=item $time = urxvt::NOW
474 504
475Returns the "current time" (as per the event loop). 505Returns the "current time" (as per the event loop).
476 506
477=item urxvt::CurrentTime 507=item urxvt::CurrentTime
478 508
479=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 509=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 510Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481Button4Mask, Button5Mask, AnyModifier 511Button4Mask, Button5Mask, AnyModifier
512
513=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
514ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
515PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
516Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
517KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
518ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
519FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
520
521=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
522EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
523GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
524UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
525ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
526CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
527SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
482 528
483Various constants for use in X calls and event processing. 529Various constants for use in X calls and event processing.
484 530
485=back 531=back
486 532
554 delete $ENV{CDPATH}; 600 delete $ENV{CDPATH};
555 delete $ENV{BASH_ENV}; 601 delete $ENV{BASH_ENV};
556 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 602 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
557} 603}
558 604
559my @hook_count;
560my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 605my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561 606
562sub verbose { 607sub verbose {
563 my ($level, $msg) = @_; 608 my ($level, $msg) = @_;
564 warn "$msg\n" if $level <= $verbosity; 609 warn "$msg\n" if $level <= $verbosity;
577 verbose 3, "loading extension '$path' into package '$pkg'"; 622 verbose 3, "loading extension '$path' into package '$pkg'";
578 623
579 open my $fh, "<:raw", $path 624 open my $fh, "<:raw", $path
580 or die "$path: $!"; 625 or die "$path: $!";
581 626
582 my $source = untaint 627 my $source =
583 "package $pkg; use strict; use utf8;\n" 628 "package $pkg; use strict; use utf8;\n"
584 . "use base urxvt::term::extension::;\n" 629 . "use base urxvt::term::extension::;\n"
585 . "#line 1 \"$path\"\n{\n" 630 . "#line 1 \"$path\"\n{\n"
586 . (do { local $/; <$fh> }) 631 . (do { local $/; <$fh> })
587 . "\n};\n1"; 632 . "\n};\n1";
652 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 697 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653 if $verbosity >= 11; 698 if $verbosity >= 11;
654 } 699 }
655 700
656 if ($htype == 1) { # DESTROY 701 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 702 # clear package objects
665 %$_ = () for values %{ $TERM->{_pkg} }; 703 %$_ = () for values %{ $TERM->{_pkg} };
666 704
667 # clear package 705 # clear package
668 %$TERM = (); 706 %$TERM = ();
694 while (my ($name, $cb) = each %hook) { 732 while (my ($name, $cb) = each %hook) {
695 my $htype = $HOOKTYPE{uc $name}; 733 my $htype = $HOOKTYPE{uc $name};
696 defined $htype 734 defined $htype
697 or Carp::croak "unsupported hook type '$name'"; 735 or Carp::croak "unsupported hook type '$name'";
698 736
737 $self->set_should_invoke ($htype, +1)
699 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 738 unless exists $self->{term}{_hook}[$htype]{$pkg};
700 $hook_count[$htype]++
701 or urxvt::set_should_invoke $htype, 1;
702 }
703 739
704 $self->{term}{_hook}[$htype]{$pkg} = $cb; 740 $self->{term}{_hook}[$htype]{$pkg} = $cb;
705 } 741 }
706} 742}
707 743
712 for my $name (@hook) { 748 for my $name (@hook) {
713 my $htype = $HOOKTYPE{uc $name}; 749 my $htype = $HOOKTYPE{uc $name};
714 defined $htype 750 defined $htype
715 or Carp::croak "unsupported hook type '$name'"; 751 or Carp::croak "unsupported hook type '$name'";
716 752
753 $self->set_should_invoke ($htype, -1)
717 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 754 if delete $self->{term}{_hook}[$htype]{$pkg};
718 --$hook_count[$htype]
719 or urxvt::set_should_invoke $htype, 0;
720 }
721 } 755 }
722} 756}
723 757
724our $AUTOLOAD; 758our $AUTOLOAD;
725 759
1130 1164
1131=item $windowid = $term->vt 1165=item $windowid = $term->vt
1132 1166
1133Return the window id of the terminal window. 1167Return the window id of the terminal window.
1134 1168
1169=item $term->vt_emask_add ($x_event_mask)
1170
1171Adds the specified events to the vt event mask. Useful e.g. when you want
1172to receive pointer events all the times:
1173
1174 $term->vt_emask_add (urxvt::PointerMotionMask);
1175
1135=item $window_width = $term->width 1176=item $window_width = $term->width
1136 1177
1137=item $window_height = $term->height 1178=item $window_height = $term->height
1138 1179
1139=item $font_width = $term->fwidth 1180=item $font_width = $term->fwidth
1152 1193
1153=item $max_scrollback = $term->saveLines 1194=item $max_scrollback = $term->saveLines
1154 1195
1155=item $nrow_plus_saveLines = $term->total_rows 1196=item $nrow_plus_saveLines = $term->total_rows
1156 1197
1157=item $lines_in_scrollback = $term->nsaved 1198=item $topmost_scrollback_row = $term->top_row
1158 1199
1159Return various integers describing terminal characteristics. 1200Return various integers describing terminal characteristics.
1160 1201
1161=item $x_display = $term->display_id 1202=item $x_display = $term->display_id
1162 1203
1190Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1231Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1191AltGr), the meta key (often Alt) and the num lock key, if applicable. 1232AltGr), the meta key (often Alt) and the num lock key, if applicable.
1192 1233
1193=item $view_start = $term->view_start ([$newvalue]) 1234=item $view_start = $term->view_start ([$newvalue])
1194 1235
1195Returns the negative row number of the topmost line. Minimum value is 1236Returns the row number of the topmost displayed line. Maximum value is
1196C<0>, which displays the normal terminal contents. Larger values scroll 1237C<0>, which displays the normal terminal contents. Lower values scroll
1197this many lines into the scrollback buffer. 1238this many lines into the scrollback buffer.
1198 1239
1199=item $term->want_refresh 1240=item $term->want_refresh
1200 1241
1201Requests a screen refresh. At the next opportunity, rxvt-unicode will 1242Requests a screen refresh. At the next opportunity, rxvt-unicode will

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines