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.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC

58 58
59=back 59=back
60 60
61=item option-popup (enabled by default) 61=item option-popup (enabled by default)
62 62
63Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at 63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime. 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.
65 70
66=item digital-clock 71=item digital-clock
67 72
68Displays a digital clock using the built-in overlay. 73Displays a digital clock using the built-in overlay.
69 74
200 205
201It 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,
202$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
203number of lines that will be in the scrollback buffer. 208number of lines that will be in the scrollback buffer.
204 209
205=item on_tty_activity $term *NYI*
206
207Called whenever the program(s) running in the urxvt window send output.
208
209=item on_osc_seq $term, $string 210=item on_osc_seq $term, $string
210 211
211Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 212Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212operating system command) is processed. Cursor position and other state 213operating system command) is processed. Cursor position and other state
213information is up-to-date when this happens. For interoperability, the 214information is up-to-date when this happens. For interoperability, the
332that calls this function. 333that calls this function.
333 334
334Using 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
335correct place, e.g. on stderr of the connecting urxvtc client. 336correct place, e.g. on stderr of the connecting urxvtc client.
336 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
337=item $time = urxvt::NOW 344=item $time = urxvt::NOW
338 345
339Returns the "current time" (as per the event loop). 346Returns the "current time" (as per the event loop).
340 347
341=item urxvt::CurrentTime 348=item urxvt::CurrentTime
342 349
343=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 350=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 351Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345Button4Mask, Button5Mask, AnyModifier 352Button4Mask, Button5Mask, AnyModifier
346 353
347Various constants for use in X events. 354Various constants for use in X calls and event processing.
348 355
349=back 356=back
350 357
351=head2 RENDITION 358=head2 RENDITION
352 359
407use utf8; 414use utf8;
408use strict; 415use strict;
409use Scalar::Util (); 416use Scalar::Util ();
410use List::Util (); 417use List::Util ();
411 418
419our $VERSION = 1;
412our $TERM; 420our $TERM;
413our @HOOKNAME; 421our @HOOKNAME;
414our %OPTION; 422our %OPTION;
415our $LIBDIR; 423our $LIBDIR;
416 424
422 my $msg = join "", @_; 430 my $msg = join "", @_;
423 $msg .= "\n" 431 $msg .= "\n"
424 unless $msg =~ /\n$/; 432 unless $msg =~ /\n$/;
425 urxvt::warn ($msg); 433 urxvt::warn ($msg);
426 }; 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";
427} 440}
428 441
429my @hook_count; 442my @hook_count;
430my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 443my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
431 444
464 verbose 3, "loading extension '$path' into package '$pkg'"; 477 verbose 3, "loading extension '$path' into package '$pkg'";
465 478
466 open my $fh, "<:raw", $path 479 open my $fh, "<:raw", $path
467 or die "$path: $!"; 480 or die "$path: $!";
468 481
469 my $source = "package $pkg; use strict; use utf8;\n" 482 my $source = untaint "package $pkg; use strict; use utf8;\n"
470 . "use base urxvt::term::proxy::;\n" 483 . "use base urxvt::term::proxy::;\n"
471 . "#line 1 \"$path\"\n{\n" 484 . "#line 1 \"$path\"\n{\n"
472 . (do { local $/; <$fh> }) 485 . (do { local $/; <$fh> })
473 . "\n};\n1"; 486 . "\n};\n1";
474 487
490 503
491 my %want_ext; 504 my %want_ext;
492 505
493 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 506 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494 if ($_ eq "default") { 507 if ($_ eq "default") {
495 $want_ext{$_}++ for qw(selection option-popup); 508 $want_ext{$_}++ for qw(selection option-popup selection-popup);
496 } elsif (/^-(.*)$/) { 509 } elsif (/^-(.*)$/) {
497 delete $want_ext{$1}; 510 delete $want_ext{$1};
498 } else { 511 } else {
499 $want_ext{$_}++; 512 $want_ext{$_}++;
500 } 513 }
507 register_package extension_package $files[0]; 520 register_package extension_package $files[0];
508 } else { 521 } else {
509 warn "perl extension '$ext' not found in perl library search path\n"; 522 warn "perl extension '$ext' not found in perl library search path\n";
510 } 523 }
511 } 524 }
525
526 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
527 warn $@ if $@;
512 } 528 }
513 529
514 $retval = undef; 530 $retval = undef;
515 531
516 if (my $cb = $TERM->{_hook}[$htype]) { 532 if (my $cb = $TERM->{_hook}[$htype]) {
528 $proxy 544 $proxy
529 }, 545 },
530 @_, 546 @_,
531 ) and last; 547 ) and last;
532 }; 548 };
533 warn $@ if $@;#d# 549 if ($@) {
550 $TERM->ungrab; # better to lose the grab than the session
551 warn $@;
552 }
534 } 553 }
535 } 554 }
536 555
537 if ($htype == 1) { # DESTROY 556 if ($htype == 1) { # DESTROY
538 # remove hooks if unused 557 # remove hooks if unused
551 } 570 }
552 571
553 $retval 572 $retval
554} 573}
555 574
575# urxvt::term::proxy
576
556sub urxvt::term::proxy::AUTOLOAD { 577sub urxvt::term::proxy::AUTOLOAD {
557 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 578 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
558 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 579 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
559 580
560 eval qq{ 581 eval qq{
566 } or die "FATAL: unable to compile method forwarder: $@"; 587 } or die "FATAL: unable to compile method forwarder: $@";
567 588
568 goto &$urxvt::term::proxy::AUTOLOAD; 589 goto &$urxvt::term::proxy::AUTOLOAD;
569} 590}
570 591
592sub urxvt::term::proxy::DESTROY {
593 # nop
594}
595
596# urxvt::destroy_hook
597
571sub urxvt::destroy_hook::DESTROY { 598sub urxvt::destroy_hook::DESTROY {
572 ${$_[0]}->(); 599 ${$_[0]}->();
573} 600}
574 601
575sub urxvt::destroy_hook(&) { 602sub urxvt::destroy_hook(&) {
576 bless \shift, urxvt::destroy_hook:: 603 bless \shift, urxvt::destroy_hook::
577} 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;
578 675
579=head2 The C<urxvt::term> Class 676=head2 The C<urxvt::term> Class
580 677
581=over 4 678=over 4
582 679
634 shade term_name title transparent transparent_all tripleclickwords 731 shade term_name title transparent transparent_all tripleclickwords
635 utmpInhibit visualBell 732 utmpInhibit visualBell
636 733
637=cut 734=cut
638 735
639sub urxvt::term::resource($$;$) { 736sub resource($$;$) {
640 my ($self, $name) = (shift, shift); 737 my ($self, $name) = (shift, shift);
641 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 738 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
642 &urxvt::term::_resource 739 &urxvt::term::_resource
643} 740}
644 741
731C<$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,
732currently). 829currently).
733 830
734=cut 831=cut
735 832
736sub urxvt::term::popup { 833sub popup {
737 my ($self, $event) = @_; 834 my ($self, $event) = @_;
738 835
739 $self->grab ($event->{time}, 1) 836 $self->grab ($event->{time}, 1)
740 or return; 837 or return;
741 838
819=item $nrow_plus_saveLines = $term->total_rows 916=item $nrow_plus_saveLines = $term->total_rows
820 917
821=item $lines_in_scrollback = $term->nsaved 918=item $lines_in_scrollback = $term->nsaved
822 919
823Return various integers describing terminal characteristics. 920Return various integers describing terminal characteristics.
921
922=item $lc_ctype = $term->locale
923
924Returns the LC_CTYPE category string used by this rxvt-unicode.
925
926=item $x_display = $term->display_id
927
928Return the DISPLAY used by rxvt-unicode.
824 929
825=item $modifiermask = $term->ModLevel3Mask 930=item $modifiermask = $term->ModLevel3Mask
826 931
827=item $modifiermask = $term->ModMetaMask 932=item $modifiermask = $term->ModMetaMask
828 933
931 1036
932=back 1037=back
933 1038
934=cut 1039=cut
935 1040
936sub urxvt::term::line { 1041sub line {
937 my ($self, $row) = @_; 1042 my ($self, $row) = @_;
938 1043
939 my $maxrow = $self->nrow - 1; 1044 my $maxrow = $self->nrow - 1;
940 1045
941 my ($beg, $end) = ($row, $row); 1046 my ($beg, $end) = ($row, $row);
1005 $offset / $self->{ncol} + $self->{beg}, 1110 $offset / $self->{ncol} + $self->{beg},
1006 $offset % $self->{ncol} 1111 $offset % $self->{ncol}
1007 ) 1112 )
1008} 1113}
1009 1114
1010=item ($row, $col) = $line->coord_of ($offset)
1011=item $text = $term->special_encode $string 1115=item $text = $term->special_encode $string
1012 1116
1013Converts a perl string into the special encoding used by rxvt-unicode, 1117Converts a perl string into the special encoding used by rxvt-unicode,
1014where one character corresponds to one screen cell. See 1118where one character corresponds to one screen cell. See
1015C<< $term->ROW_t >> for details. 1119C<< $term->ROW_t >> for details.
1017=item $string = $term->special_decode $text 1121=item $string = $term->special_decode $text
1018 1122
1019Converts rxvt-unicodes text reprsentation into a perl string. See 1123Converts rxvt-unicodes text reprsentation into a perl string. See
1020C<< $term->ROW_t >> for details. 1124C<< $term->ROW_t >> for details.
1021 1125
1126=item $success = $term->grab_button ($button, $modifiermask)
1127
1128Registers a synchronous button grab. See the XGrabButton manpage.
1129
1130=item $success = $term->grab ($eventtime[, $sync])
1131
1132Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1133synchronous (C<$sync> is true). Also remembers the grab timestampe.
1134
1135=item $term->allow_events_async
1136
1137Calls XAllowEvents with AsyncBoth for the most recent grab.
1138
1139=item $term->allow_events_sync
1140
1141Calls XAllowEvents with SyncBoth for the most recent grab.
1142
1143=item $term->allow_events_replay
1144
1145Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1146recent grab.
1147
1148=item $term->ungrab
1149
1150Calls XUngrab for the most recent grab. Is called automatically on
1151evaluation errors, as it is better to lose the grab in the error case as
1152the session.
1153
1022=back 1154=back
1023 1155
1156=cut
1157
1158package urxvt::popup;
1159
1024=head2 The C<urxvt::popup> Class 1160=head2 The C<urxvt::popup> Class
1025 1161
1026=over 4 1162=over 4
1027 1163
1028=cut 1164=cut
1029
1030package urxvt::popup;
1031 1165
1032sub add_item { 1166sub add_item {
1033 my ($self, $item) = @_; 1167 my ($self, $item) = @_;
1034 1168
1035 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; 1169 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1047 $sep ||= "═"; 1181 $sep ||= "═";
1048 1182
1049 $self->add_item ({ 1183 $self->add_item ({
1050 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, 1184 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051 text => "", 1185 text => "",
1052 render => sub { $sep x $urxvt::TERM->ncol }, 1186 render => sub { $sep x $self->{term}->ncol },
1053 activate => sub { }, 1187 activate => sub { },
1054 }); 1188 });
1055} 1189}
1056 1190
1057sub add_title { 1191sub add_title {
1065} 1199}
1066 1200
1067sub add_button { 1201sub add_button {
1068 my ($self, $text, $cb) = @_; 1202 my ($self, $text, $cb) = @_;
1069 1203
1070 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1204 $self->add_item ({ type => "button", text => $text, activate => $cb});
1071} 1205}
1072 1206
1073sub add_toggle { 1207sub add_toggle {
1074 my ($self, $text, $cb, $value) = @_; 1208 my ($self, $text, $cb, $value) = @_;
1075 1209
1076 my $item; $item = { 1210 my $item; $item = {
1077 type => "button", 1211 type => "button",
1078 text => " $text", 1212 text => " $text",
1079 value => $value, 1213 value => $value,
1080 render => sub { ($item->{value} ? "* " : " ") . $text }, 1214 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1081 activate => sub { $cb->($item->{value} = !$item->{value}); }, 1215 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1082 }; 1216 };
1083 1217
1084 $self->add_item ($item); 1218 $self->add_item ($item);
1085} 1219}
1086 1220
1087sub show { 1221sub show {
1088 my ($self) = @_; 1222 my ($self) = @_;
1089 1223
1090 local $urxvt::popup::self = $self; 1224 local $urxvt::popup::self = $self;
1091 1225
1226 local $ENV{LC_ALL} = $self->{term}->locale;
1227
1092 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1228 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1093 "--transient-for" => $self->{term}->parent, 1229 "--transient-for" => $self->{term}->parent,
1230 "-display" => $self->{term}->display_id,
1094 "-pe" => "urxvt-popup") 1231 "-pe" => "urxvt-popup")
1095 or die "unable to create popup window\n"; 1232 or die "unable to create popup window\n";
1096} 1233}
1097 1234
1098sub DESTROY { 1235sub DESTROY {
1099 my ($self) = @_; 1236 my ($self) = @_;
1100 1237
1238 delete $self->{term}{_destroy}{$self};
1101 $self->{term}->ungrab; 1239 $self->{term}->ungrab;
1102} 1240}
1103 1241
1104=head2 The C<urxvt::timer> Class 1242=head2 The C<urxvt::timer> Class
1105 1243
1209This variable controls the verbosity level of the perl extension. Higher 1347This variable controls the verbosity level of the perl extension. Higher
1210numbers indicate more verbose output. 1348numbers indicate more verbose output.
1211 1349
1212=over 4 1350=over 4
1213 1351
1214=item =0 - only fatal messages 1352=item == 0 - fatal messages
1215 1353
1216=item =3 - script loading and management 1354=item >= 3 - script loading and management
1217 1355
1218=item =10 - all events received 1356=item >=10 - all events received
1219 1357
1220=back 1358=back
1221 1359
1222=head1 AUTHOR 1360=head1 AUTHOR
1223 1361

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines