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.67 by root, Mon Jan 9 19:29:06 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
485 503
486 my %want_ext; 504 my %want_ext;
487 505
488 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 506 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
489 if ($_ eq "default") { 507 if ($_ eq "default") {
490 $want_ext{$_}++ for qw(selection option-popup); 508 $want_ext{$_}++ for qw(selection option-popup selection-popup);
491 } elsif (/^-(.*)$/) { 509 } elsif (/^-(.*)$/) {
492 delete $want_ext{$1}; 510 delete $want_ext{$1};
493 } else { 511 } else {
494 $want_ext{$_}++; 512 $want_ext{$_}++;
495 } 513 }
502 register_package extension_package $files[0]; 520 register_package extension_package $files[0];
503 } else { 521 } else {
504 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";
505 } 523 }
506 } 524 }
525
526 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
527 warn $@ if $@;
507 } 528 }
508 529
509 $retval = undef; 530 $retval = undef;
510 531
511 if (my $cb = $TERM->{_hook}[$htype]) { 532 if (my $cb = $TERM->{_hook}[$htype]) {
523 $proxy 544 $proxy
524 }, 545 },
525 @_, 546 @_,
526 ) and last; 547 ) and last;
527 }; 548 };
528 warn $@ if $@;#d# 549 if ($@) {
550 $TERM->ungrab; # better to lose the grab than the session
551 warn $@;
552 }
529 } 553 }
530 } 554 }
531 555
532 if ($htype == 1) { # DESTROY 556 if ($htype == 1) { # DESTROY
533 # remove hooks if unused 557 # remove hooks if unused
546 } 570 }
547 571
548 $retval 572 $retval
549} 573}
550 574
575# urxvt::term::proxy
576
551sub urxvt::term::proxy::AUTOLOAD { 577sub urxvt::term::proxy::AUTOLOAD {
552 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 578 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
553 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 579 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
554 580
555 eval qq{ 581 eval qq{
561 } or die "FATAL: unable to compile method forwarder: $@"; 587 } or die "FATAL: unable to compile method forwarder: $@";
562 588
563 goto &$urxvt::term::proxy::AUTOLOAD; 589 goto &$urxvt::term::proxy::AUTOLOAD;
564} 590}
565 591
592sub urxvt::term::proxy::DESTROY {
593 # nop
594}
595
596# urxvt::destroy_hook
597
566sub urxvt::destroy_hook::DESTROY { 598sub urxvt::destroy_hook::DESTROY {
567 ${$_[0]}->(); 599 ${$_[0]}->();
568} 600}
569 601
570sub urxvt::destroy_hook(&) { 602sub urxvt::destroy_hook(&) {
571 bless \shift, urxvt::destroy_hook:: 603 bless \shift, urxvt::destroy_hook::
572} 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;
573 675
574=head2 The C<urxvt::term> Class 676=head2 The C<urxvt::term> Class
575 677
576=over 4 678=over 4
577 679
629 shade term_name title transparent transparent_all tripleclickwords 731 shade term_name title transparent transparent_all tripleclickwords
630 utmpInhibit visualBell 732 utmpInhibit visualBell
631 733
632=cut 734=cut
633 735
634sub urxvt::term::resource($$;$) { 736sub resource($$;$) {
635 my ($self, $name) = (shift, shift); 737 my ($self, $name) = (shift, shift);
636 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 738 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
637 &urxvt::term::_resource 739 &urxvt::term::_resource
638} 740}
639 741
726C<$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,
727currently). 829currently).
728 830
729=cut 831=cut
730 832
731sub urxvt::term::popup { 833sub popup {
732 my ($self, $event) = @_; 834 my ($self, $event) = @_;
733 835
734 $self->grab ($event->{time}, 1) 836 $self->grab ($event->{time}, 1)
735 or return; 837 or return;
736 838
814=item $nrow_plus_saveLines = $term->total_rows 916=item $nrow_plus_saveLines = $term->total_rows
815 917
816=item $lines_in_scrollback = $term->nsaved 918=item $lines_in_scrollback = $term->nsaved
817 919
818Return 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.
819 929
820=item $modifiermask = $term->ModLevel3Mask 930=item $modifiermask = $term->ModLevel3Mask
821 931
822=item $modifiermask = $term->ModMetaMask 932=item $modifiermask = $term->ModMetaMask
823 933
926 1036
927=back 1037=back
928 1038
929=cut 1039=cut
930 1040
931sub urxvt::term::line { 1041sub line {
932 my ($self, $row) = @_; 1042 my ($self, $row) = @_;
933 1043
934 my $maxrow = $self->nrow - 1; 1044 my $maxrow = $self->nrow - 1;
935 1045
936 my ($beg, $end) = ($row, $row); 1046 my ($beg, $end) = ($row, $row);
1000 $offset / $self->{ncol} + $self->{beg}, 1110 $offset / $self->{ncol} + $self->{beg},
1001 $offset % $self->{ncol} 1111 $offset % $self->{ncol}
1002 ) 1112 )
1003} 1113}
1004 1114
1005=item ($row, $col) = $line->coord_of ($offset)
1006=item $text = $term->special_encode $string 1115=item $text = $term->special_encode $string
1007 1116
1008Converts a perl string into the special encoding used by rxvt-unicode, 1117Converts a perl string into the special encoding used by rxvt-unicode,
1009where one character corresponds to one screen cell. See 1118where one character corresponds to one screen cell. See
1010C<< $term->ROW_t >> for details. 1119C<< $term->ROW_t >> for details.
1012=item $string = $term->special_decode $text 1121=item $string = $term->special_decode $text
1013 1122
1014Converts rxvt-unicodes text reprsentation into a perl string. See 1123Converts rxvt-unicodes text reprsentation into a perl string. See
1015C<< $term->ROW_t >> for details. 1124C<< $term->ROW_t >> for details.
1016 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
1017=back 1154=back
1018 1155
1156=cut
1157
1158package urxvt::popup;
1159
1019=head2 The C<urxvt::popup> Class 1160=head2 The C<urxvt::popup> Class
1020 1161
1021=over 4 1162=over 4
1022 1163
1023=cut 1164=cut
1024
1025package urxvt::popup;
1026 1165
1027sub add_item { 1166sub add_item {
1028 my ($self, $item) = @_; 1167 my ($self, $item) = @_;
1029 1168
1169 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1170 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1171 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1172
1173 $item->{render} ||= sub { $_[0]{text} };
1174
1030 push @{ $self->{item} }, $item; 1175 push @{ $self->{item} }, $item;
1176}
1177
1178sub add_separator {
1179 my ($self, $sep) = @_;
1180
1181 $sep ||= "=";
1182
1183 $self->add_item ({
1184 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1185 text => "",
1186 render => sub { $sep x $self->{term}->ncol },
1187 activate => sub { },
1188 });
1189}
1190
1191sub add_title {
1192 my ($self, $title) = @_;
1193
1194 $self->add_item ({
1195 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1196 text => $title,
1197 activate => sub { },
1198 });
1031} 1199}
1032 1200
1033sub add_button { 1201sub add_button {
1034 my ($self, $text, $cb) = @_; 1202 my ($self, $text, $cb) = @_;
1035 1203
1036 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, 1204 $self->add_item ({ type => "button", text => $text, activate => $cb});
1037 render => sub { $_[0]{text} },
1038 });
1039} 1205}
1040 1206
1041sub add_toggle { 1207sub add_toggle {
1042 my ($self, $text, $cb, $value) = @_; 1208 my ($self, $text, $cb, $value) = @_;
1043 1209
1044 my $item; $item = { 1210 my $item; $item = {
1045 type => "button", 1211 type => "button",
1046 text => " $text", 1212 text => " $text",
1047 value => $value, 1213 value => $value,
1048 render => sub { ($item->{value} ? "" : " ") . $text }, 1214 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1049 activate => sub { $cb->($item->{value} = !$item->{value}); }, 1215 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1050 }; 1216 };
1051 1217
1052 $self->add_item ($item); 1218 $self->add_item ($item);
1053} 1219}
1054 1220
1055sub show { 1221sub show {
1056 my ($self) = @_; 1222 my ($self) = @_;
1057 1223
1058 local $urxvt::popup::self = $self; 1224 local $urxvt::popup::self = $self;
1059 1225
1226 local $ENV{LC_ALL} = $self->{term}->locale;
1227
1060 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,
1061 "--transient-for" => $self->{term}->parent, 1229 "--transient-for" => $self->{term}->parent,
1230 "-display" => $self->{term}->display_id,
1062 "-pe" => "urxvt-popup") 1231 "-pe" => "urxvt-popup")
1063 or die "unable to create popup window\n"; 1232 or die "unable to create popup window\n";
1064} 1233}
1065 1234
1066sub DESTROY { 1235sub DESTROY {
1067 my ($self) = @_; 1236 my ($self) = @_;
1068 1237
1238 delete $self->{term}{_destroy}{$self};
1069 $self->{term}->ungrab; 1239 $self->{term}->ungrab;
1070} 1240}
1071 1241
1072=head2 The C<urxvt::timer> Class 1242=head2 The C<urxvt::timer> Class
1073 1243
1177This variable controls the verbosity level of the perl extension. Higher 1347This variable controls the verbosity level of the perl extension. Higher
1178numbers indicate more verbose output. 1348numbers indicate more verbose output.
1179 1349
1180=over 4 1350=over 4
1181 1351
1182=item =0 - only fatal messages 1352=item == 0 - fatal messages
1183 1353
1184=item =3 - script loading and management 1354=item >= 3 - script loading and management
1185 1355
1186=item =10 - all events received 1356=item >=10 - all events received
1187 1357
1188=back 1358=back
1189 1359
1190=head1 AUTHOR 1360=head1 AUTHOR
1191 1361

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines