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.51 by root, Sun Jan 8 00:27:47 2006 UTC vs.
Revision 1.68 by root, Mon Jan 9 20:00:31 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
427sub verbose { 445sub verbose {
428 my ($level, $msg) = @_; 446 my ($level, $msg) = @_;
429 warn "$msg\n" if $level <= $verbosity; 447 warn "$msg\n" if $level <= $verbosity;
430} 448}
431 449
432# find on_xxx subs in the package and register them
433# as hooks
434sub register_package($) {
435 my ($pkg) = @_;
436
437 for my $htype (0.. $#HOOKNAME) {
438 my $name = $HOOKNAME[$htype];
439
440 my $ref = $pkg->can ("on_" . lc $name)
441 or next;
442
443 $TERM->{_hook}[$htype]{$pkg} = $ref;
444 $hook_count[$htype]++
445 or set_should_invoke $htype, 1;
446 }
447}
448
449my $extension_pkg = "extension0000"; 450my $extension_pkg = "extension0000";
450my %extension_pkg; 451my %extension_pkg;
451 452
452# load a single script into its own package, once only 453# load a single script into its own package, once only
453sub extension_package($) { 454sub extension_package($) {
459 verbose 3, "loading extension '$path' into package '$pkg'"; 460 verbose 3, "loading extension '$path' into package '$pkg'";
460 461
461 open my $fh, "<:raw", $path 462 open my $fh, "<:raw", $path
462 or die "$path: $!"; 463 or die "$path: $!";
463 464
464 my $source = "package $pkg; use strict; use utf8;\n" 465 my $source = untaint "package $pkg; use strict; use utf8;\n"
465 . "use base urxvt::term::proxy::;\n" 466 . "use base urxvt::term::proxy::;\n"
466 . "#line 1 \"$path\"\n{\n" 467 . "#line 1 \"$path\"\n{\n"
467 . (do { local $/; <$fh> }) 468 . (do { local $/; <$fh> })
468 . "\n};\n1"; 469 . "\n};\n1";
469 470
481 my $htype = shift; 482 my $htype = shift;
482 483
483 if ($htype == 0) { # INIT 484 if ($htype == 0) { # INIT
484 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 485 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
485 486
486 my %want_ext; 487 my %ext_arg;
487 488
488 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 489 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
489 if ($_ eq "default") { 490 if ($_ eq "default") {
490 $want_ext{$_}++ for qw(selection option-popup); 491 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup);
491 } elsif (/^-(.*)$/) { 492 } elsif (/^-(.*)$/) {
492 delete $want_ext{$1}; 493 delete $ext_arg{$1};
494 } elsif (/^([^<]+)<(.*)>$/) {
495 push @{ $ext_arg{$1} }, $2;
493 } else { 496 } else {
494 $want_ext{$_}++; 497 $ext_arg{$_} ||= [];
495 } 498 }
496 } 499 }
497 500
498 for my $ext (keys %want_ext) { 501 while (my ($ext, $argv) = each %ext_arg) {
499 my @files = grep -f $_, map "$_/$ext", @dirs; 502 my @files = grep -f $_, map "$_/$ext", @dirs;
500 503
501 if (@files) { 504 if (@files) {
502 register_package extension_package $files[0]; 505 $TERM->register_package (extension_package $files[0], $argv);
503 } else { 506 } else {
504 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";
505 } 508 }
506 } 509 }
510
511 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
512 warn $@ if $@;
507 } 513 }
508 514
509 $retval = undef; 515 $retval = undef;
510 516
511 if (my $cb = $TERM->{_hook}[$htype]) { 517 if (my $cb = $TERM->{_hook}[$htype]) {
513 if $verbosity >= 10; 519 if $verbosity >= 10;
514 520
515 keys %$cb; 521 keys %$cb;
516 522
517 while (my ($pkg, $cb) = each %$cb) { 523 while (my ($pkg, $cb) = each %$cb) {
518 eval { 524 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
519 $retval = $cb->(
520 $TERM->{_pkg}{$pkg} ||= do {
521 my $proxy = bless { }, $pkg;
522 Scalar::Util::weaken ($proxy->{term} = $TERM);
523 $proxy
524 },
525 @_,
526 ) and last; 525 and last;
526
527 if ($@) {
528 $TERM->ungrab; # better to lose the grab than the session
529 warn $@;
527 }; 530 }
528 warn $@ if $@;#d#
529 } 531 }
530 } 532 }
531 533
532 if ($htype == 1) { # DESTROY 534 if ($htype == 1) { # DESTROY
533 # remove hooks if unused 535 # remove hooks if unused
546 } 548 }
547 549
548 $retval 550 $retval
549} 551}
550 552
553# urxvt::term::proxy
554
551sub urxvt::term::proxy::AUTOLOAD { 555sub urxvt::term::proxy::AUTOLOAD {
552 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 556 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
553 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 557 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
554 558
555 eval qq{ 559 eval qq{
561 } or die "FATAL: unable to compile method forwarder: $@"; 565 } or die "FATAL: unable to compile method forwarder: $@";
562 566
563 goto &$urxvt::term::proxy::AUTOLOAD; 567 goto &$urxvt::term::proxy::AUTOLOAD;
564} 568}
565 569
570sub urxvt::term::proxy::DESTROY {
571 # nop
572}
573
574# urxvt::destroy_hook
575
566sub urxvt::destroy_hook::DESTROY { 576sub urxvt::destroy_hook::DESTROY {
567 ${$_[0]}->(); 577 ${$_[0]}->();
568} 578}
569 579
570sub urxvt::destroy_hook(&) { 580sub urxvt::destroy_hook(&) {
571 bless \shift, urxvt::destroy_hook:: 581 bless \shift, urxvt::destroy_hook::
572} 582}
573 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
574=head2 The C<urxvt::term> Class 654=head2 The C<urxvt::term> Class
575 655
576=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}
577 681
578=item $term->destroy 682=item $term->destroy
579 683
580Destroy the terminal object (close the window, free resources etc.). 684Destroy the terminal object (close the window, free resources etc.).
581 685
629 shade term_name title transparent transparent_all tripleclickwords 733 shade term_name title transparent transparent_all tripleclickwords
630 utmpInhibit visualBell 734 utmpInhibit visualBell
631 735
632=cut 736=cut
633 737
634sub urxvt::term::resource($$;$) { 738sub resource($$;$) {
635 my ($self, $name) = (shift, shift); 739 my ($self, $name) = (shift, shift);
636 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 740 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
637 &urxvt::term::_resource 741 &urxvt::term::_resource
638} 742}
639 743
726C<$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,
727currently). 831currently).
728 832
729=cut 833=cut
730 834
731sub urxvt::term::popup { 835sub popup {
732 my ($self, $event) = @_; 836 my ($self, $event) = @_;
733 837
734 $self->grab ($event->{time}, 1) 838 $self->grab ($event->{time}, 1)
735 or return; 839 or return;
736 840
814=item $nrow_plus_saveLines = $term->total_rows 918=item $nrow_plus_saveLines = $term->total_rows
815 919
816=item $lines_in_scrollback = $term->nsaved 920=item $lines_in_scrollback = $term->nsaved
817 921
818Return 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.
819 931
820=item $modifiermask = $term->ModLevel3Mask 932=item $modifiermask = $term->ModLevel3Mask
821 933
822=item $modifiermask = $term->ModMetaMask 934=item $modifiermask = $term->ModMetaMask
823 935
926 1038
927=back 1039=back
928 1040
929=cut 1041=cut
930 1042
931sub urxvt::term::line { 1043sub line {
932 my ($self, $row) = @_; 1044 my ($self, $row) = @_;
933 1045
934 my $maxrow = $self->nrow - 1; 1046 my $maxrow = $self->nrow - 1;
935 1047
936 my ($beg, $end) = ($row, $row); 1048 my ($beg, $end) = ($row, $row);
1000 $offset / $self->{ncol} + $self->{beg}, 1112 $offset / $self->{ncol} + $self->{beg},
1001 $offset % $self->{ncol} 1113 $offset % $self->{ncol}
1002 ) 1114 )
1003} 1115}
1004 1116
1005=item ($row, $col) = $line->coord_of ($offset)
1006=item $text = $term->special_encode $string 1117=item $text = $term->special_encode $string
1007 1118
1008Converts a perl string into the special encoding used by rxvt-unicode, 1119Converts a perl string into the special encoding used by rxvt-unicode,
1009where one character corresponds to one screen cell. See 1120where one character corresponds to one screen cell. See
1010C<< $term->ROW_t >> for details. 1121C<< $term->ROW_t >> for details.
1012=item $string = $term->special_decode $text 1123=item $string = $term->special_decode $text
1013 1124
1014Converts rxvt-unicodes text reprsentation into a perl string. See 1125Converts rxvt-unicodes text reprsentation into a perl string. See
1015C<< $term->ROW_t >> for details. 1126C<< $term->ROW_t >> for details.
1016 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
1017=back 1156=back
1018 1157
1158=cut
1159
1160package urxvt::popup;
1161
1019=head2 The C<urxvt::popup> Class 1162=head2 The C<urxvt::popup> Class
1020 1163
1021=over 4 1164=over 4
1022 1165
1023=cut 1166=cut
1024
1025package urxvt::popup;
1026 1167
1027sub add_item { 1168sub add_item {
1028 my ($self, $item) = @_; 1169 my ($self, $item) = @_;
1029 1170
1171 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1172 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1173 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1174
1175 $item->{render} ||= sub { $_[0]{text} };
1176
1030 push @{ $self->{item} }, $item; 1177 push @{ $self->{item} }, $item;
1178}
1179
1180sub add_separator {
1181 my ($self, $sep) = @_;
1182
1183 $sep ||= "=";
1184
1185 $self->add_item ({
1186 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1187 text => "",
1188 render => sub { $sep x $self->{term}->ncol },
1189 activate => sub { },
1190 });
1191}
1192
1193sub add_title {
1194 my ($self, $title) = @_;
1195
1196 $self->add_item ({
1197 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1198 text => $title,
1199 activate => sub { },
1200 });
1031} 1201}
1032 1202
1033sub add_button { 1203sub add_button {
1034 my ($self, $text, $cb) = @_; 1204 my ($self, $text, $cb) = @_;
1035 1205
1036 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, 1206 $self->add_item ({ type => "button", text => $text, activate => $cb});
1037 render => sub { $_[0]{text} },
1038 });
1039} 1207}
1040 1208
1041sub add_toggle { 1209sub add_toggle {
1042 my ($self, $text, $cb, $value) = @_; 1210 my ($self, $text, $cb, $value) = @_;
1043 1211
1044 my $item; $item = { 1212 my $item; $item = {
1045 type => "button", 1213 type => "button",
1046 text => " $text", 1214 text => " $text",
1047 value => $value, 1215 value => $value,
1048 render => sub { ($item->{value} ? "" : " ") . $text }, 1216 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1049 activate => sub { $cb->($item->{value} = !$item->{value}); }, 1217 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1050 }; 1218 };
1051 1219
1052 $self->add_item ($item); 1220 $self->add_item ($item);
1053} 1221}
1054 1222
1055sub show { 1223sub show {
1056 my ($self) = @_; 1224 my ($self) = @_;
1057 1225
1058 local $urxvt::popup::self = $self; 1226 local $urxvt::popup::self = $self;
1059 1227
1228 local $ENV{LC_ALL} = $self->{term}->locale;
1229
1060 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,
1061 "--transient-for" => $self->{term}->parent, 1231 "--transient-for" => $self->{term}->parent,
1232 "-display" => $self->{term}->display_id,
1062 "-pe" => "urxvt-popup") 1233 "-pe" => "urxvt-popup")
1063 or die "unable to create popup window\n"; 1234 or die "unable to create popup window\n";
1064} 1235}
1065 1236
1066sub DESTROY { 1237sub DESTROY {
1067 my ($self) = @_; 1238 my ($self) = @_;
1068 1239
1240 delete $self->{term}{_destroy}{$self};
1069 $self->{term}->ungrab; 1241 $self->{term}->ungrab;
1070} 1242}
1071 1243
1072=head2 The C<urxvt::timer> Class 1244=head2 The C<urxvt::timer> Class
1073 1245
1177This variable controls the verbosity level of the perl extension. Higher 1349This variable controls the verbosity level of the perl extension. Higher
1178numbers indicate more verbose output. 1350numbers indicate more verbose output.
1179 1351
1180=over 4 1352=over 4
1181 1353
1182=item =0 - only fatal messages 1354=item == 0 - fatal messages
1183 1355
1184=item =3 - script loading and management 1356=item >= 3 - script loading and management
1185 1357
1186=item =10 - all events received 1358=item >=10 - all events received
1187 1359
1188=back 1360=back
1189 1361
1190=head1 AUTHOR 1362=head1 AUTHOR
1191 1363

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines