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.49 by root, Sun Jan 8 00:07:18 2006 UTC vs.
Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC

37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40=over 4 40=over 4
41 41
42=item selection 42=item selection (enabled by default)
43 43
44Intelligent selection. This extension tries to be more intelligent when 44Intelligent selection. This extension tries to be more intelligent when
45the user extends selections (double-click). Right now, it tries to select 45the user extends selections (double-click). Right now, it tries to select
46urls and complete shell-quoted arguments, which is very convenient, too, 46urls and complete shell-quoted arguments, which is very convenient, too,
47if your F<ls> supports C<--quoting-style=shell>. 47if your F<ls> supports C<--quoting-style=shell>.
55Rot-13 the selection when activated. Used via keyboard trigger: 55Rot-13 the selection when activated. Used via keyboard trigger:
56 56
57 URxvt.keysym.C-M-r: perl:selection:rot13 57 URxvt.keysym.C-M-r: perl:selection:rot13
58 58
59=back 59=back
60
61=item option-popup (enabled by default)
62
63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime.
65
66=item selection-popup (enabled by default)
67
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action.
60 70
61=item digital-clock 71=item digital-clock
62 72
63Displays a digital clock using the built-in overlay. 73Displays a digital clock using the built-in overlay.
64 74
195 205
196It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 206It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
197$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 207$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198number of lines that will be in the scrollback buffer. 208number of lines that will be in the scrollback buffer.
199 209
200=item on_tty_activity $term *NYI*
201
202Called whenever the program(s) running in the urxvt window send output.
203
204=item on_osc_seq $term, $string 210=item on_osc_seq $term, $string
205 211
206Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 212Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207operating system command) is processed. Cursor position and other state 213operating system command) is processed. Cursor position and other state
208information is up-to-date when this happens. For interoperability, the 214information is up-to-date when this happens. For interoperability, the
327that calls this function. 333that calls this function.
328 334
329Using this function has the advantage that its output ends up in the 335Using this function has the advantage that its output ends up in the
330correct place, e.g. on stderr of the connecting urxvtc client. 336correct place, e.g. on stderr of the connecting urxvtc client.
331 337
338=item $is_safe = urxvt::safe
339
340Returns true when it is safe to do potentially unsafe things, such as
341evaluating perl code specified by the user. This is true when urxvt was
342started setuid or setgid.
343
332=item $time = urxvt::NOW 344=item $time = urxvt::NOW
333 345
334Returns the "current time" (as per the event loop). 346Returns the "current time" (as per the event loop).
335 347
336=item urxvt::CurrentTime 348=item urxvt::CurrentTime
337 349
338=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 350=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 351Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340Button4Mask, Button5Mask, AnyModifier 352Button4Mask, Button5Mask, AnyModifier
341 353
342Various constants for use in X events. 354Various constants for use in X calls and event processing.
343 355
344=back 356=back
345 357
346=head2 RENDITION 358=head2 RENDITION
347 359
402use utf8; 414use utf8;
403use strict; 415use strict;
404use Scalar::Util (); 416use Scalar::Util ();
405use List::Util (); 417use List::Util ();
406 418
419our $VERSION = 1;
407our $TERM; 420our $TERM;
408our @HOOKNAME; 421our @HOOKNAME;
409our %OPTION; 422our %OPTION;
410our $LIBDIR; 423our $LIBDIR;
411 424
417 my $msg = join "", @_; 430 my $msg = join "", @_;
418 $msg .= "\n" 431 $msg .= "\n"
419 unless $msg =~ /\n$/; 432 unless $msg =~ /\n$/;
420 urxvt::warn ($msg); 433 urxvt::warn ($msg);
421 }; 434 };
435
436 delete $ENV{IFS};
437 delete $ENV{CDPATH};
438 delete $ENV{BASH_ENV};
439 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
422} 440}
423 441
424my @hook_count; 442my @hook_count;
425my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 443my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
426 444
459 verbose 3, "loading extension '$path' into package '$pkg'"; 477 verbose 3, "loading extension '$path' into package '$pkg'";
460 478
461 open my $fh, "<:raw", $path 479 open my $fh, "<:raw", $path
462 or die "$path: $!"; 480 or die "$path: $!";
463 481
464 my $source = "package $pkg; use strict; use utf8;\n" 482 my $source = untaint "package $pkg; use strict; use utf8;\n"
465 . "use base urxvt::term::proxy::;\n" 483 . "use base urxvt::term::proxy::;\n"
466 . "#line 1 \"$path\"\n{\n" 484 . "#line 1 \"$path\"\n{\n"
467 . (do { local $/; <$fh> }) 485 . (do { local $/; <$fh> })
468 . "\n};\n1"; 486 . "\n};\n1";
469 487
481 my $htype = shift; 499 my $htype = shift;
482 500
483 if ($htype == 0) { # INIT 501 if ($htype == 0) { # INIT
484 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 502 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
485 503
504 my %want_ext;
505
486 my @ext = (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2); 506 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
487
488 while (@ext) {
489 my $ext = shift @ext;
490 if ($ext eq "default") { 507 if ($_ eq "default") {
491 unshift @ext, qw(selection); 508 $want_ext{$_}++ for qw(selection option-popup selection-popup);
509 } elsif (/^-(.*)$/) {
510 delete $want_ext{$1};
492 } else { 511 } else {
493 my @files = grep -f $_, map "$_/$ext", @dirs; 512 $want_ext{$_}++;
494
495 if (@files) {
496 register_package extension_package $files[0];
497 } else {
498 warn "perl extension '$ext' not found in perl library search path\n";
499 }
500 } 513 }
501 } 514 }
515
516 for my $ext (keys %want_ext) {
517 my @files = grep -f $_, map "$_/$ext", @dirs;
518
519 if (@files) {
520 register_package extension_package $files[0];
521 } else {
522 warn "perl extension '$ext' not found in perl library search path\n";
523 }
524 }
525
526 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
527 warn $@ if $@;
502 } 528 }
503 529
504 $retval = undef; 530 $retval = undef;
505 531
506 if (my $cb = $TERM->{_hook}[$htype]) { 532 if (my $cb = $TERM->{_hook}[$htype]) {
518 $proxy 544 $proxy
519 }, 545 },
520 @_, 546 @_,
521 ) and last; 547 ) and last;
522 }; 548 };
523 warn $@ if $@;#d# 549 if ($@) {
550 $TERM->ungrab; # better to lose the grab than the session
551 warn $@;
552 }
524 } 553 }
525 } 554 }
526 555
527 if ($htype == 1) { # DESTROY 556 if ($htype == 1) { # DESTROY
528 # remove hooks if unused 557 # remove hooks if unused
541 } 570 }
542 571
543 $retval 572 $retval
544} 573}
545 574
575# urxvt::term::proxy
576
546sub urxvt::term::proxy::AUTOLOAD { 577sub urxvt::term::proxy::AUTOLOAD {
547 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 578 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
548 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 579 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
549 580
550 eval qq{ 581 eval qq{
556 } or die "FATAL: unable to compile method forwarder: $@"; 587 } or die "FATAL: unable to compile method forwarder: $@";
557 588
558 goto &$urxvt::term::proxy::AUTOLOAD; 589 goto &$urxvt::term::proxy::AUTOLOAD;
559} 590}
560 591
592sub urxvt::term::proxy::DESTROY {
593 # nop
594}
595
596# urxvt::destroy_hook
597
561sub urxvt::destroy_hook::DESTROY { 598sub urxvt::destroy_hook::DESTROY {
562 ${$_[0]}->(); 599 ${$_[0]}->();
563} 600}
564 601
565sub urxvt::destroy_hook(&) { 602sub urxvt::destroy_hook(&) {
566 bless \shift, urxvt::destroy_hook:: 603 bless \shift, urxvt::destroy_hook::
567} 604}
605
606package urxvt::anyevent;
607
608=head2 The C<urxvt::anyevent> Class
609
610The sole purpose of this class is to deliver an interface to the
611C<AnyEvent> module - any module using it will work inside urxvt without
612further work. The only exception is that you cannot wait on condition
613variables, but non-blocking condvar use is ok. What this means is that you
614cannot use blocking APIs, but the non-blocking variant should work.
615
616=cut
617
618our $VERSION = 1;
619
620$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
621push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
622
623sub timer {
624 my ($class, %arg) = @_;
625
626 my $cb = $arg{cb};
627
628 urxvt::timer
629 ->new
630 ->start (urxvt::NOW + $arg{after})
631 ->cb (sub {
632 $_[0]->stop; # need to cancel manually
633 $cb->();
634 })
635}
636
637sub io {
638 my ($class, %arg) = @_;
639
640 my $cb = $arg{cb};
641
642 bless [$arg{fh}, urxvt::iow
643 ->new
644 ->fd (fileno $arg{fh})
645 ->events (($arg{poll} =~ /r/ ? 1 : 0)
646 | ($arg{poll} =~ /w/ ? 2 : 0))
647 ->start
648 ->cb (sub {
649 $cb->(($_[1] & 1 ? 'r' : '')
650 . ($_[1] & 2 ? 'w' : ''));
651 })],
652 urxvt::anyevent::
653}
654
655sub DESTROY {
656 $_[0][1]->stop;
657}
658
659sub condvar {
660 bless \my $flag, urxvt::anyevent::condvar::
661}
662
663sub urxvt::anyevent::condvar::broadcast {
664 ${$_[0]}++;
665}
666
667sub urxvt::anyevent::condvar::wait {
668 unless (${$_[0]}) {
669 require Carp;
670 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
671 }
672}
673
674package urxvt::term;
568 675
569=head2 The C<urxvt::term> Class 676=head2 The C<urxvt::term> Class
570 677
571=over 4 678=over 4
572 679
624 shade term_name title transparent transparent_all tripleclickwords 731 shade term_name title transparent transparent_all tripleclickwords
625 utmpInhibit visualBell 732 utmpInhibit visualBell
626 733
627=cut 734=cut
628 735
629sub urxvt::term::resource($$;$) { 736sub resource($$;$) {
630 my ($self, $name) = (shift, shift); 737 my ($self, $name) = (shift, shift);
631 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 738 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
632 &urxvt::term::_resource 739 &urxvt::term::_resource
633} 740}
634 741
721C<$event> I<must> be the event causing the menu to pop up (a button event, 828C<$event> I<must> be the event causing the menu to pop up (a button event,
722currently). 829currently).
723 830
724=cut 831=cut
725 832
726sub urxvt::term::popup { 833sub popup {
727 my ($self, $event) = @_; 834 my ($self, $event) = @_;
728 835
729 $self->grab ($event->{time}, 1) 836 $self->grab ($event->{time}, 1)
730 or return; 837 or return;
731 838
921 1028
922=back 1029=back
923 1030
924=cut 1031=cut
925 1032
926sub urxvt::term::line { 1033sub line {
927 my ($self, $row) = @_; 1034 my ($self, $row) = @_;
928 1035
929 my $maxrow = $self->nrow - 1; 1036 my $maxrow = $self->nrow - 1;
930 1037
931 my ($beg, $end) = ($row, $row); 1038 my ($beg, $end) = ($row, $row);
995 $offset / $self->{ncol} + $self->{beg}, 1102 $offset / $self->{ncol} + $self->{beg},
996 $offset % $self->{ncol} 1103 $offset % $self->{ncol}
997 ) 1104 )
998} 1105}
999 1106
1000=item ($row, $col) = $line->coord_of ($offset)
1001=item $text = $term->special_encode $string 1107=item $text = $term->special_encode $string
1002 1108
1003Converts a perl string into the special encoding used by rxvt-unicode, 1109Converts a perl string into the special encoding used by rxvt-unicode,
1004where one character corresponds to one screen cell. See 1110where one character corresponds to one screen cell. See
1005C<< $term->ROW_t >> for details. 1111C<< $term->ROW_t >> for details.
1007=item $string = $term->special_decode $text 1113=item $string = $term->special_decode $text
1008 1114
1009Converts rxvt-unicodes text reprsentation into a perl string. See 1115Converts rxvt-unicodes text reprsentation into a perl string. See
1010C<< $term->ROW_t >> for details. 1116C<< $term->ROW_t >> for details.
1011 1117
1118=item $success = $term->grab_button ($button, $modifiermask)
1119
1120Registers a synchronous button grab. See the XGrabButton manpage.
1121
1122=item $success = $term->grab ($eventtime[, $sync])
1123
1124Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1125synchronous (C<$sync> is true). Also remembers the grab timestampe.
1126
1127=item $term->allow_events_async
1128
1129Calls XAllowEvents with AsyncBoth for the most recent grab.
1130
1131=item $term->allow_events_sync
1132
1133Calls XAllowEvents with SyncBoth for the most recent grab.
1134
1135=item $term->allow_events_replay
1136
1137Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1138recent grab.
1139
1140=item $term->ungrab
1141
1142Calls XUngrab for the most recent grab. Is called automatically on
1143evaluation errors, as it is better to lose the grab in the error case as
1144the session.
1145
1012=back 1146=back
1013 1147
1148=cut
1149
1150package urxvt::popup;
1151
1014=head2 The C<urxvt::popup> Class 1152=head2 The C<urxvt::popup> Class
1015 1153
1016=over 4 1154=over 4
1017 1155
1018=cut 1156=cut
1019
1020package urxvt::popup;
1021 1157
1022sub add_item { 1158sub add_item {
1023 my ($self, $item) = @_; 1159 my ($self, $item) = @_;
1024 1160
1161 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1162 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1163 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1164
1165 $item->{render} ||= sub { $_[0]{text} };
1166
1025 push @{ $self->{item} }, $item; 1167 push @{ $self->{item} }, $item;
1168}
1169
1170sub add_separator {
1171 my ($self, $sep) = @_;
1172
1173 $sep ||= "═";
1174
1175 $self->add_item ({
1176 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177 text => "",
1178 render => sub { $sep x $self->{term}->ncol },
1179 activate => sub { },
1180 });
1181}
1182
1183sub add_title {
1184 my ($self, $title) = @_;
1185
1186 $self->add_item ({
1187 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1188 text => $title,
1189 activate => sub { },
1190 });
1026} 1191}
1027 1192
1028sub add_button { 1193sub add_button {
1029 my ($self, $text, $cb) = @_; 1194 my ($self, $text, $cb) = @_;
1030 1195
1031 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, 1196 $self->add_item ({ type => "button", text => $text, activate => $cb});
1032 render => sub { $_[0]{text} },
1033 });
1034} 1197}
1035 1198
1036sub add_toggle { 1199sub add_toggle {
1037 my ($self, $text, $cb, $value) = @_; 1200 my ($self, $text, $cb, $value) = @_;
1038 1201
1039 my $item; $item = { 1202 my $item; $item = {
1040 type => "button", 1203 type => "button",
1041 text => " $text", 1204 text => " $text",
1042 value => $value, 1205 value => $value,
1043 render => sub { ($item->{value} ? "" : " ") . $text }, 1206 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1044 activate => sub { $cb->($item->{value} = !$item->{value}); }, 1207 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1045 }; 1208 };
1046 1209
1047 $self->add_item ($item); 1210 $self->add_item ($item);
1048} 1211}
1049 1212
1050sub show { 1213sub show {
1051 my ($self) = @_; 1214 my ($self) = @_;
1052 1215
1053 local $urxvt::popup::self = $self; 1216 local $urxvt::popup::self = $self;
1054 1217
1218 local $ENV{LC_ALL} = $self->{term}->locale;
1219
1055 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1220 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1056 "--transient-for" => $self->{term}->parent, 1221 "--transient-for" => $self->{term}->parent,
1222 "-display" => $self->{term}->display_id,
1057 "-pe" => "urxvt-popup") 1223 "-pe" => "urxvt-popup")
1058 or die "unable to create popup window\n"; 1224 or die "unable to create popup window\n";
1059} 1225}
1060 1226
1061sub DESTROY { 1227sub DESTROY {
1062 my ($self) = @_; 1228 my ($self) = @_;
1063 1229
1230 delete $self->{term}{_destroy}{$self};
1064 $self->{term}->ungrab; 1231 $self->{term}->ungrab;
1065} 1232}
1066 1233
1067=head2 The C<urxvt::timer> Class 1234=head2 The C<urxvt::timer> Class
1068 1235
1172This variable controls the verbosity level of the perl extension. Higher 1339This variable controls the verbosity level of the perl extension. Higher
1173numbers indicate more verbose output. 1340numbers indicate more verbose output.
1174 1341
1175=over 4 1342=over 4
1176 1343
1177=item =0 - only fatal messages 1344=item == 0 - fatal messages
1178 1345
1179=item =3 - script loading and management 1346=item >= 3 - script loading and management
1180 1347
1181=item =10 - all events received 1348=item >=10 - all events received
1182 1349
1183=back 1350=back
1184 1351
1185=head1 AUTHOR 1352=head1 AUTHOR
1186 1353

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines