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.68 by root, Mon Jan 9 20:00:31 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
432sub verbose { 445sub verbose {
433 my ($level, $msg) = @_; 446 my ($level, $msg) = @_;
434 warn "$msg\n" if $level <= $verbosity; 447 warn "$msg\n" if $level <= $verbosity;
435} 448}
436 449
437# find on_xxx subs in the package and register them
438# as hooks
439sub register_package($) {
440 my ($pkg) = @_;
441
442 for my $htype (0.. $#HOOKNAME) {
443 my $name = $HOOKNAME[$htype];
444
445 my $ref = $pkg->can ("on_" . lc $name)
446 or next;
447
448 $TERM->{_hook}[$htype]{$pkg} = $ref;
449 $hook_count[$htype]++
450 or set_should_invoke $htype, 1;
451 }
452}
453
454my $extension_pkg = "extension0000"; 450my $extension_pkg = "extension0000";
455my %extension_pkg; 451my %extension_pkg;
456 452
457# load a single script into its own package, once only 453# load a single script into its own package, once only
458sub extension_package($) { 454sub extension_package($) {
464 verbose 3, "loading extension '$path' into package '$pkg'"; 460 verbose 3, "loading extension '$path' into package '$pkg'";
465 461
466 open my $fh, "<:raw", $path 462 open my $fh, "<:raw", $path
467 or die "$path: $!"; 463 or die "$path: $!";
468 464
469 my $source = "package $pkg; use strict; use utf8;\n" 465 my $source = untaint "package $pkg; use strict; use utf8;\n"
470 . "use base urxvt::term::proxy::;\n" 466 . "use base urxvt::term::proxy::;\n"
471 . "#line 1 \"$path\"\n{\n" 467 . "#line 1 \"$path\"\n{\n"
472 . (do { local $/; <$fh> }) 468 . (do { local $/; <$fh> })
473 . "\n};\n1"; 469 . "\n};\n1";
474 470
486 my $htype = shift; 482 my $htype = shift;
487 483
488 if ($htype == 0) { # INIT 484 if ($htype == 0) { # INIT
489 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 485 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
490 486
491 my %want_ext; 487 my %ext_arg;
492 488
493 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 489 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494 if ($_ eq "default") { 490 if ($_ eq "default") {
495 $want_ext{$_}++ for qw(selection option-popup); 491 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup);
496 } elsif (/^-(.*)$/) { 492 } elsif (/^-(.*)$/) {
497 delete $want_ext{$1}; 493 delete $ext_arg{$1};
494 } elsif (/^([^<]+)<(.*)>$/) {
495 push @{ $ext_arg{$1} }, $2;
498 } else { 496 } else {
499 $want_ext{$_}++; 497 $ext_arg{$_} ||= [];
500 } 498 }
501 } 499 }
502 500
503 for my $ext (keys %want_ext) { 501 while (my ($ext, $argv) = each %ext_arg) {
504 my @files = grep -f $_, map "$_/$ext", @dirs; 502 my @files = grep -f $_, map "$_/$ext", @dirs;
505 503
506 if (@files) { 504 if (@files) {
507 register_package extension_package $files[0]; 505 $TERM->register_package (extension_package $files[0], $argv);
508 } else { 506 } else {
509 warn "perl extension '$ext' not found in perl library search path\n"; 507 warn "perl extension '$ext' not found in perl library search path\n";
510 } 508 }
511 } 509 }
510
511 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
512 warn $@ if $@;
512 } 513 }
513 514
514 $retval = undef; 515 $retval = undef;
515 516
516 if (my $cb = $TERM->{_hook}[$htype]) { 517 if (my $cb = $TERM->{_hook}[$htype]) {
518 if $verbosity >= 10; 519 if $verbosity >= 10;
519 520
520 keys %$cb; 521 keys %$cb;
521 522
522 while (my ($pkg, $cb) = each %$cb) { 523 while (my ($pkg, $cb) = each %$cb) {
523 eval { 524 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
524 $retval = $cb->(
525 $TERM->{_pkg}{$pkg} ||= do {
526 my $proxy = bless { }, $pkg;
527 Scalar::Util::weaken ($proxy->{term} = $TERM);
528 $proxy
529 },
530 @_,
531 ) and last; 525 and last;
526
527 if ($@) {
528 $TERM->ungrab; # better to lose the grab than the session
529 warn $@;
532 }; 530 }
533 warn $@ if $@;#d#
534 } 531 }
535 } 532 }
536 533
537 if ($htype == 1) { # DESTROY 534 if ($htype == 1) { # DESTROY
538 # remove hooks if unused 535 # remove hooks if unused
551 } 548 }
552 549
553 $retval 550 $retval
554} 551}
555 552
553# urxvt::term::proxy
554
556sub urxvt::term::proxy::AUTOLOAD { 555sub urxvt::term::proxy::AUTOLOAD {
557 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 556 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
558 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 557 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
559 558
560 eval qq{ 559 eval qq{
566 } or die "FATAL: unable to compile method forwarder: $@"; 565 } or die "FATAL: unable to compile method forwarder: $@";
567 566
568 goto &$urxvt::term::proxy::AUTOLOAD; 567 goto &$urxvt::term::proxy::AUTOLOAD;
569} 568}
570 569
570sub urxvt::term::proxy::DESTROY {
571 # nop
572}
573
574# urxvt::destroy_hook
575
571sub urxvt::destroy_hook::DESTROY { 576sub urxvt::destroy_hook::DESTROY {
572 ${$_[0]}->(); 577 ${$_[0]}->();
573} 578}
574 579
575sub urxvt::destroy_hook(&) { 580sub urxvt::destroy_hook(&) {
576 bless \shift, urxvt::destroy_hook:: 581 bless \shift, urxvt::destroy_hook::
577} 582}
578 583
584package urxvt::anyevent;
585
586=head2 The C<urxvt::anyevent> Class
587
588The sole purpose of this class is to deliver an interface to the
589C<AnyEvent> module - any module using it will work inside urxvt without
590further work. The only exception is that you cannot wait on condition
591variables, but non-blocking condvar use is ok. What this means is that you
592cannot use blocking APIs, but the non-blocking variant should work.
593
594=cut
595
596our $VERSION = 1;
597
598$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
599push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
600
601sub timer {
602 my ($class, %arg) = @_;
603
604 my $cb = $arg{cb};
605
606 urxvt::timer
607 ->new
608 ->start (urxvt::NOW + $arg{after})
609 ->cb (sub {
610 $_[0]->stop; # need to cancel manually
611 $cb->();
612 })
613}
614
615sub io {
616 my ($class, %arg) = @_;
617
618 my $cb = $arg{cb};
619
620 bless [$arg{fh}, urxvt::iow
621 ->new
622 ->fd (fileno $arg{fh})
623 ->events (($arg{poll} =~ /r/ ? 1 : 0)
624 | ($arg{poll} =~ /w/ ? 2 : 0))
625 ->start
626 ->cb (sub {
627 $cb->(($_[1] & 1 ? 'r' : '')
628 . ($_[1] & 2 ? 'w' : ''));
629 })],
630 urxvt::anyevent::
631}
632
633sub DESTROY {
634 $_[0][1]->stop;
635}
636
637sub condvar {
638 bless \my $flag, urxvt::anyevent::condvar::
639}
640
641sub urxvt::anyevent::condvar::broadcast {
642 ${$_[0]}++;
643}
644
645sub urxvt::anyevent::condvar::wait {
646 unless (${$_[0]}) {
647 require Carp;
648 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
649 }
650}
651
652package urxvt::term;
653
579=head2 The C<urxvt::term> Class 654=head2 The C<urxvt::term> Class
580 655
581=over 4 656=over 4
657
658=cut
659
660# find on_xxx subs in the package and register them
661# as hooks
662sub register_package {
663 my ($self, $pkg, $argv) = @_;
664
665 my $proxy = bless { argv => $argv }, $pkg;
666 Scalar::Util::weaken ($proxy->{term} = $TERM);
667
668 $self->{_pkg}{$pkg} = $proxy;
669
670 for my $htype (0.. $#HOOKNAME) {
671 my $name = $HOOKNAME[$htype];
672
673 my $ref = $pkg->can ("on_" . lc $name)
674 or next;
675
676 $self->{_hook}[$htype]{$pkg} = $ref;
677 $hook_count[$htype]++
678 or urxvt::set_should_invoke $htype, 1;
679 }
680}
582 681
583=item $term->destroy 682=item $term->destroy
584 683
585Destroy the terminal object (close the window, free resources etc.). 684Destroy the terminal object (close the window, free resources etc.).
586 685
634 shade term_name title transparent transparent_all tripleclickwords 733 shade term_name title transparent transparent_all tripleclickwords
635 utmpInhibit visualBell 734 utmpInhibit visualBell
636 735
637=cut 736=cut
638 737
639sub urxvt::term::resource($$;$) { 738sub resource($$;$) {
640 my ($self, $name) = (shift, shift); 739 my ($self, $name) = (shift, shift);
641 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 740 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
642 &urxvt::term::_resource 741 &urxvt::term::_resource
643} 742}
644 743
731C<$event> I<must> be the event causing the menu to pop up (a button event, 830C<$event> I<must> be the event causing the menu to pop up (a button event,
732currently). 831currently).
733 832
734=cut 833=cut
735 834
736sub urxvt::term::popup { 835sub popup {
737 my ($self, $event) = @_; 836 my ($self, $event) = @_;
738 837
739 $self->grab ($event->{time}, 1) 838 $self->grab ($event->{time}, 1)
740 or return; 839 or return;
741 840
819=item $nrow_plus_saveLines = $term->total_rows 918=item $nrow_plus_saveLines = $term->total_rows
820 919
821=item $lines_in_scrollback = $term->nsaved 920=item $lines_in_scrollback = $term->nsaved
822 921
823Return various integers describing terminal characteristics. 922Return various integers describing terminal characteristics.
923
924=item $lc_ctype = $term->locale
925
926Returns the LC_CTYPE category string used by this rxvt-unicode.
927
928=item $x_display = $term->display_id
929
930Return the DISPLAY used by rxvt-unicode.
824 931
825=item $modifiermask = $term->ModLevel3Mask 932=item $modifiermask = $term->ModLevel3Mask
826 933
827=item $modifiermask = $term->ModMetaMask 934=item $modifiermask = $term->ModMetaMask
828 935
931 1038
932=back 1039=back
933 1040
934=cut 1041=cut
935 1042
936sub urxvt::term::line { 1043sub line {
937 my ($self, $row) = @_; 1044 my ($self, $row) = @_;
938 1045
939 my $maxrow = $self->nrow - 1; 1046 my $maxrow = $self->nrow - 1;
940 1047
941 my ($beg, $end) = ($row, $row); 1048 my ($beg, $end) = ($row, $row);
1005 $offset / $self->{ncol} + $self->{beg}, 1112 $offset / $self->{ncol} + $self->{beg},
1006 $offset % $self->{ncol} 1113 $offset % $self->{ncol}
1007 ) 1114 )
1008} 1115}
1009 1116
1010=item ($row, $col) = $line->coord_of ($offset)
1011=item $text = $term->special_encode $string 1117=item $text = $term->special_encode $string
1012 1118
1013Converts a perl string into the special encoding used by rxvt-unicode, 1119Converts a perl string into the special encoding used by rxvt-unicode,
1014where one character corresponds to one screen cell. See 1120where one character corresponds to one screen cell. See
1015C<< $term->ROW_t >> for details. 1121C<< $term->ROW_t >> for details.
1017=item $string = $term->special_decode $text 1123=item $string = $term->special_decode $text
1018 1124
1019Converts rxvt-unicodes text reprsentation into a perl string. See 1125Converts rxvt-unicodes text reprsentation into a perl string. See
1020C<< $term->ROW_t >> for details. 1126C<< $term->ROW_t >> for details.
1021 1127
1128=item $success = $term->grab_button ($button, $modifiermask)
1129
1130Registers a synchronous button grab. See the XGrabButton manpage.
1131
1132=item $success = $term->grab ($eventtime[, $sync])
1133
1134Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1135synchronous (C<$sync> is true). Also remembers the grab timestampe.
1136
1137=item $term->allow_events_async
1138
1139Calls XAllowEvents with AsyncBoth for the most recent grab.
1140
1141=item $term->allow_events_sync
1142
1143Calls XAllowEvents with SyncBoth for the most recent grab.
1144
1145=item $term->allow_events_replay
1146
1147Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1148recent grab.
1149
1150=item $term->ungrab
1151
1152Calls XUngrab for the most recent grab. Is called automatically on
1153evaluation errors, as it is better to lose the grab in the error case as
1154the session.
1155
1022=back 1156=back
1023 1157
1158=cut
1159
1160package urxvt::popup;
1161
1024=head2 The C<urxvt::popup> Class 1162=head2 The C<urxvt::popup> Class
1025 1163
1026=over 4 1164=over 4
1027 1165
1028=cut 1166=cut
1029
1030package urxvt::popup;
1031 1167
1032sub add_item { 1168sub add_item {
1033 my ($self, $item) = @_; 1169 my ($self, $item) = @_;
1034 1170
1035 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; 1171 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1042} 1178}
1043 1179
1044sub add_separator { 1180sub add_separator {
1045 my ($self, $sep) = @_; 1181 my ($self, $sep) = @_;
1046 1182
1047 $sep ||= ""; 1183 $sep ||= "=";
1048 1184
1049 $self->add_item ({ 1185 $self->add_item ({
1050 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, 1186 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051 text => "", 1187 text => "",
1052 render => sub { $sep x $urxvt::TERM->ncol }, 1188 render => sub { $sep x $self->{term}->ncol },
1053 activate => sub { }, 1189 activate => sub { },
1054 }); 1190 });
1055} 1191}
1056 1192
1057sub add_title { 1193sub add_title {
1065} 1201}
1066 1202
1067sub add_button { 1203sub add_button {
1068 my ($self, $text, $cb) = @_; 1204 my ($self, $text, $cb) = @_;
1069 1205
1070 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1206 $self->add_item ({ type => "button", text => $text, activate => $cb});
1071} 1207}
1072 1208
1073sub add_toggle { 1209sub add_toggle {
1074 my ($self, $text, $cb, $value) = @_; 1210 my ($self, $text, $cb, $value) = @_;
1075 1211
1076 my $item; $item = { 1212 my $item; $item = {
1077 type => "button", 1213 type => "button",
1078 text => " $text", 1214 text => " $text",
1079 value => $value, 1215 value => $value,
1080 render => sub { ($item->{value} ? "* " : " ") . $text }, 1216 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1081 activate => sub { $cb->($item->{value} = !$item->{value}); }, 1217 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1082 }; 1218 };
1083 1219
1084 $self->add_item ($item); 1220 $self->add_item ($item);
1085} 1221}
1086 1222
1087sub show { 1223sub show {
1088 my ($self) = @_; 1224 my ($self) = @_;
1089 1225
1090 local $urxvt::popup::self = $self; 1226 local $urxvt::popup::self = $self;
1091 1227
1228 local $ENV{LC_ALL} = $self->{term}->locale;
1229
1092 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1230 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1093 "--transient-for" => $self->{term}->parent, 1231 "--transient-for" => $self->{term}->parent,
1232 "-display" => $self->{term}->display_id,
1094 "-pe" => "urxvt-popup") 1233 "-pe" => "urxvt-popup")
1095 or die "unable to create popup window\n"; 1234 or die "unable to create popup window\n";
1096} 1235}
1097 1236
1098sub DESTROY { 1237sub DESTROY {
1099 my ($self) = @_; 1238 my ($self) = @_;
1100 1239
1240 delete $self->{term}{_destroy}{$self};
1101 $self->{term}->ungrab; 1241 $self->{term}->ungrab;
1102} 1242}
1103 1243
1104=head2 The C<urxvt::timer> Class 1244=head2 The C<urxvt::timer> Class
1105 1245
1209This variable controls the verbosity level of the perl extension. Higher 1349This variable controls the verbosity level of the perl extension. Higher
1210numbers indicate more verbose output. 1350numbers indicate more verbose output.
1211 1351
1212=over 4 1352=over 4
1213 1353
1214=item =0 - only fatal messages 1354=item == 0 - fatal messages
1215 1355
1216=item =3 - script loading and management 1356=item >= 3 - script loading and management
1217 1357
1218=item =10 - all events received 1358=item >=10 - all events received
1219 1359
1220=back 1360=back
1221 1361
1222=head1 AUTHOR 1362=head1 AUTHOR
1223 1363

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines