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.53 by root, Sun Jan 8 01:16:09 2006 UTC vs.
Revision 1.61 by root, Mon Jan 9 01:36:56 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
337 343
338=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 344=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 345Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340Button4Mask, Button5Mask, AnyModifier 346Button4Mask, Button5Mask, AnyModifier
341 347
342Various constants for use in X events. 348Various constants for use in X calls and event processing.
343 349
344=back 350=back
345 351
346=head2 RENDITION 352=head2 RENDITION
347 353
402use utf8; 408use utf8;
403use strict; 409use strict;
404use Scalar::Util (); 410use Scalar::Util ();
405use List::Util (); 411use List::Util ();
406 412
413our $VERSION = 1;
407our $TERM; 414our $TERM;
408our @HOOKNAME; 415our @HOOKNAME;
409our %OPTION; 416our %OPTION;
410our $LIBDIR; 417our $LIBDIR;
411 418
417 my $msg = join "", @_; 424 my $msg = join "", @_;
418 $msg .= "\n" 425 $msg .= "\n"
419 unless $msg =~ /\n$/; 426 unless $msg =~ /\n$/;
420 urxvt::warn ($msg); 427 urxvt::warn ($msg);
421 }; 428 };
429
430 delete $ENV{IFS};
431 delete $ENV{CDPATH};
432 delete $ENV{BASH_ENV};
433 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
422} 434}
423 435
424my @hook_count; 436my @hook_count;
425my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 437my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
426 438
459 verbose 3, "loading extension '$path' into package '$pkg'"; 471 verbose 3, "loading extension '$path' into package '$pkg'";
460 472
461 open my $fh, "<:raw", $path 473 open my $fh, "<:raw", $path
462 or die "$path: $!"; 474 or die "$path: $!";
463 475
464 my $source = "package $pkg; use strict; use utf8;\n" 476 my $source = untaint "package $pkg; use strict; use utf8;\n"
465 . "use base urxvt::term::proxy::;\n" 477 . "use base urxvt::term::proxy::;\n"
466 . "#line 1 \"$path\"\n{\n" 478 . "#line 1 \"$path\"\n{\n"
467 . (do { local $/; <$fh> }) 479 . (do { local $/; <$fh> })
468 . "\n};\n1"; 480 . "\n};\n1";
469 481
485 497
486 my %want_ext; 498 my %want_ext;
487 499
488 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 500 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
489 if ($_ eq "default") { 501 if ($_ eq "default") {
490 $want_ext{$_}++ for qw(selection option-popup); 502 $want_ext{$_}++ for qw(selection option-popup selection-popup);
491 } elsif (/^-(.*)$/) { 503 } elsif (/^-(.*)$/) {
492 delete $want_ext{$1}; 504 delete $want_ext{$1};
493 } else { 505 } else {
494 $want_ext{$_}++; 506 $want_ext{$_}++;
495 } 507 }
502 register_package extension_package $files[0]; 514 register_package extension_package $files[0];
503 } else { 515 } else {
504 warn "perl extension '$ext' not found in perl library search path\n"; 516 warn "perl extension '$ext' not found in perl library search path\n";
505 } 517 }
506 } 518 }
519
520 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
521 warn $@ if $@;
507 } 522 }
508 523
509 $retval = undef; 524 $retval = undef;
510 525
511 if (my $cb = $TERM->{_hook}[$htype]) { 526 if (my $cb = $TERM->{_hook}[$htype]) {
523 $proxy 538 $proxy
524 }, 539 },
525 @_, 540 @_,
526 ) and last; 541 ) and last;
527 }; 542 };
528 warn $@ if $@;#d# 543 if ($@) {
544 $TERM->ungrab; # better to lose the grab than the session
545 warn $@;
546 }
529 } 547 }
530 } 548 }
531 549
532 if ($htype == 1) { # DESTROY 550 if ($htype == 1) { # DESTROY
533 # remove hooks if unused 551 # remove hooks if unused
546 } 564 }
547 565
548 $retval 566 $retval
549} 567}
550 568
569# urxvt::term::proxy
570
551sub urxvt::term::proxy::AUTOLOAD { 571sub urxvt::term::proxy::AUTOLOAD {
552 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 572 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
553 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 573 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
554 574
555 eval qq{ 575 eval qq{
561 } or die "FATAL: unable to compile method forwarder: $@"; 581 } or die "FATAL: unable to compile method forwarder: $@";
562 582
563 goto &$urxvt::term::proxy::AUTOLOAD; 583 goto &$urxvt::term::proxy::AUTOLOAD;
564} 584}
565 585
586sub urxvt::term::proxy::DESTROY {
587 # nop
588}
589
590# urxvt::destroy_hook
591
566sub urxvt::destroy_hook::DESTROY { 592sub urxvt::destroy_hook::DESTROY {
567 ${$_[0]}->(); 593 ${$_[0]}->();
568} 594}
569 595
570sub urxvt::destroy_hook(&) { 596sub urxvt::destroy_hook(&) {
571 bless \shift, urxvt::destroy_hook:: 597 bless \shift, urxvt::destroy_hook::
572} 598}
599
600package urxvt::anyevent;
601
602=head2 The C<urxvt::anyevent> Class
603
604The sole purpose of this class is to deliver an interface to the
605C<AnyEvent> module - any module using it will work inside urxvt without
606further work. The only exception is that you cannot wait on condition
607variables, but non-blocking condvar use is ok. What this means is that you
608cannot use blocking APIs, but the non-blocking variant should work.
609
610=cut
611
612our $VERSION = 1;
613
614$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
615push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
616
617sub timer {
618 my ($class, %arg) = @_;
619
620 my $cb = $arg{cb};
621
622 urxvt::timer
623 ->new
624 ->start (urxvt::NOW + $arg{after})
625 ->cb (sub {
626 $_[0]->stop; # need to cancel manually
627 $cb->();
628 })
629}
630
631sub io {
632 my ($class, %arg) = @_;
633
634 my $cb = $arg{cb};
635
636 bless [$arg{fh}, urxvt::iow
637 ->new
638 ->fd (fileno $arg{fh})
639 ->events (($arg{poll} =~ /r/ ? 1 : 0)
640 | ($arg{poll} =~ /w/ ? 2 : 0))
641 ->start
642 ->cb (sub {
643 $cb->(($_[1] & 1 ? 'r' : '')
644 . ($_[1] & 2 ? 'w' : ''));
645 })],
646 urxvt::anyevent::
647}
648
649sub DESTROY {
650 $_[0][1]->stop;
651}
652
653sub condvar {
654 bless \my $flag, urxvt::anyevent::condvar::
655}
656
657sub urxvt::anyevent::condvar::broadcast {
658 ${$_[0]}++;
659}
660
661sub urxvt::anyevent::condvar::wait {
662 unless (${$_[0]}) {
663 require Carp;
664 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
665 }
666}
667
668package urxvt::term;
573 669
574=head2 The C<urxvt::term> Class 670=head2 The C<urxvt::term> Class
575 671
576=over 4 672=over 4
577 673
629 shade term_name title transparent transparent_all tripleclickwords 725 shade term_name title transparent transparent_all tripleclickwords
630 utmpInhibit visualBell 726 utmpInhibit visualBell
631 727
632=cut 728=cut
633 729
634sub urxvt::term::resource($$;$) { 730sub resource($$;$) {
635 my ($self, $name) = (shift, shift); 731 my ($self, $name) = (shift, shift);
636 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 732 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
637 &urxvt::term::_resource 733 &urxvt::term::_resource
638} 734}
639 735
726C<$event> I<must> be the event causing the menu to pop up (a button event, 822C<$event> I<must> be the event causing the menu to pop up (a button event,
727currently). 823currently).
728 824
729=cut 825=cut
730 826
731sub urxvt::term::popup { 827sub popup {
732 my ($self, $event) = @_; 828 my ($self, $event) = @_;
733 829
734 $self->grab ($event->{time}, 1) 830 $self->grab ($event->{time}, 1)
735 or return; 831 or return;
736 832
926 1022
927=back 1023=back
928 1024
929=cut 1025=cut
930 1026
931sub urxvt::term::line { 1027sub line {
932 my ($self, $row) = @_; 1028 my ($self, $row) = @_;
933 1029
934 my $maxrow = $self->nrow - 1; 1030 my $maxrow = $self->nrow - 1;
935 1031
936 my ($beg, $end) = ($row, $row); 1032 my ($beg, $end) = ($row, $row);
1000 $offset / $self->{ncol} + $self->{beg}, 1096 $offset / $self->{ncol} + $self->{beg},
1001 $offset % $self->{ncol} 1097 $offset % $self->{ncol}
1002 ) 1098 )
1003} 1099}
1004 1100
1005=item ($row, $col) = $line->coord_of ($offset)
1006=item $text = $term->special_encode $string 1101=item $text = $term->special_encode $string
1007 1102
1008Converts a perl string into the special encoding used by rxvt-unicode, 1103Converts a perl string into the special encoding used by rxvt-unicode,
1009where one character corresponds to one screen cell. See 1104where one character corresponds to one screen cell. See
1010C<< $term->ROW_t >> for details. 1105C<< $term->ROW_t >> for details.
1012=item $string = $term->special_decode $text 1107=item $string = $term->special_decode $text
1013 1108
1014Converts rxvt-unicodes text reprsentation into a perl string. See 1109Converts rxvt-unicodes text reprsentation into a perl string. See
1015C<< $term->ROW_t >> for details. 1110C<< $term->ROW_t >> for details.
1016 1111
1112=item $success = $term->grab_button ($button, $modifiermask)
1113
1114Registers a synchronous button grab. See XGrabButton.
1115
1116=item $success = $term->grab ($eventtime[, $sync])
1117
1118Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1119synchronous (C<$sync> is true). Also remembers the grab timestampe.
1120
1121=item $term->allow_events_async
1122
1123Calls XAllowEvents with AsyncBoth for the most recent grab.
1124
1125=item $term->allow_events_sync
1126
1127Calls XAllowEvents with SyncBoth for the most recent grab.
1128
1129=item $term->allow_events_replay
1130
1131Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1132recent grab.
1133
1134=item $term->ungrab
1135
1136Calls XUngrab for the most recent grab. Is called automatically on
1137evaluation errors, as it is better to lose the grab in the error case as
1138the session.
1139
1017=back 1140=back
1018 1141
1142=cut
1143
1144package urxvt::popup;
1145
1019=head2 The C<urxvt::popup> Class 1146=head2 The C<urxvt::popup> Class
1020 1147
1021=over 4 1148=over 4
1022 1149
1023=cut 1150=cut
1024
1025package urxvt::popup;
1026 1151
1027sub add_item { 1152sub add_item {
1028 my ($self, $item) = @_; 1153 my ($self, $item) = @_;
1029 1154
1030 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; 1155 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1070 1195
1071 my $item; $item = { 1196 my $item; $item = {
1072 type => "button", 1197 type => "button",
1073 text => " $text", 1198 text => " $text",
1074 value => $value, 1199 value => $value,
1075 render => sub { ($item->{value} ? "* " : " ") . $text }, 1200 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1076 activate => sub { $cb->($item->{value} = !$item->{value}); }, 1201 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1077 }; 1202 };
1078 1203
1079 $self->add_item ($item); 1204 $self->add_item ($item);
1080} 1205}
1081 1206
1091} 1216}
1092 1217
1093sub DESTROY { 1218sub DESTROY {
1094 my ($self) = @_; 1219 my ($self) = @_;
1095 1220
1221 delete $self->{term}{_destroy}{$self};
1096 $self->{term}->ungrab; 1222 $self->{term}->ungrab;
1097} 1223}
1098 1224
1099=head2 The C<urxvt::timer> Class 1225=head2 The C<urxvt::timer> Class
1100 1226
1204This variable controls the verbosity level of the perl extension. Higher 1330This variable controls the verbosity level of the perl extension. Higher
1205numbers indicate more verbose output. 1331numbers indicate more verbose output.
1206 1332
1207=over 4 1333=over 4
1208 1334
1209=item =0 - only fatal messages 1335=item == 0 - fatal messages
1210 1336
1211=item =3 - script loading and management 1337=item >= 3 - script loading and management
1212 1338
1213=item =10 - all events received 1339=item >=10 - all events received
1214 1340
1215=back 1341=back
1216 1342
1217=head1 AUTHOR 1343=head1 AUTHOR
1218 1344

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines