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.48 by root, Sat Jan 7 21:43:17 2006 UTC vs.
Revision 1.60 by root, Mon Jan 9 01:21:43 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
337 347
338=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 348=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 349Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340Button4Mask, Button5Mask, AnyModifier 350Button4Mask, Button5Mask, AnyModifier
341 351
342Various constants for use in X events. 352Various constants for use in X calls and event processing.
343 353
344=back 354=back
345 355
346=head2 RENDITION 356=head2 RENDITION
347 357
402use utf8; 412use utf8;
403use strict; 413use strict;
404use Scalar::Util (); 414use Scalar::Util ();
405use List::Util (); 415use List::Util ();
406 416
417our $VERSION = 1;
407our $TERM; 418our $TERM;
408our @HOOKNAME; 419our @HOOKNAME;
420our %OPTION;
409our $LIBDIR; 421our $LIBDIR;
410 422
411BEGIN { 423BEGIN {
412 urxvt->bootstrap; 424 urxvt->bootstrap;
413 425
416 my $msg = join "", @_; 428 my $msg = join "", @_;
417 $msg .= "\n" 429 $msg .= "\n"
418 unless $msg =~ /\n$/; 430 unless $msg =~ /\n$/;
419 urxvt::warn ($msg); 431 urxvt::warn ($msg);
420 }; 432 };
433
434 delete $ENV{IFS};
435 delete $ENV{CDPATH};
436 delete $ENV{BASH_ENV};
437 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
421} 438}
422 439
423my @hook_count; 440my @hook_count;
424my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 441my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
425 442
458 verbose 3, "loading extension '$path' into package '$pkg'"; 475 verbose 3, "loading extension '$path' into package '$pkg'";
459 476
460 open my $fh, "<:raw", $path 477 open my $fh, "<:raw", $path
461 or die "$path: $!"; 478 or die "$path: $!";
462 479
463 my $source = "package $pkg; use strict; use utf8;\n" 480 my $source = untaint "package $pkg; use strict; use utf8;\n"
464 . "use base urxvt::term::proxy::;\n" 481 . "use base urxvt::term::proxy::;\n"
465 . "#line 1 \"$path\"\n{\n" 482 . "#line 1 \"$path\"\n{\n"
466 . (do { local $/; <$fh> }) 483 . (do { local $/; <$fh> })
467 . "\n};\n1"; 484 . "\n};\n1";
468 485
479 local $TERM = shift; 496 local $TERM = shift;
480 my $htype = shift; 497 my $htype = shift;
481 498
482 if ($htype == 0) { # INIT 499 if ($htype == 0) { # INIT
483 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 500 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
501
502 my %want_ext;
484 503
485 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 504 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
505 if ($_ eq "default") {
506 $want_ext{$_}++ for qw(selection option-popup selection-popup);
507 } elsif (/^-(.*)$/) {
508 delete $want_ext{$1};
509 } else {
510 $want_ext{$_}++;
511 }
512 }
513
514 for my $ext (keys %want_ext) {
486 my @files = grep -f $_, map "$_/$ext", @dirs; 515 my @files = grep -f $_, map "$_/$ext", @dirs;
487 516
488 if (@files) { 517 if (@files) {
489 register_package extension_package $files[0]; 518 register_package extension_package $files[0];
490 } else { 519 } else {
491 warn "perl extension '$ext' not found in perl library search path\n"; 520 warn "perl extension '$ext' not found in perl library search path\n";
492 } 521 }
493 } 522 }
523
524 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
525 warn $@ if $@;
494 } 526 }
495 527
496 $retval = undef; 528 $retval = undef;
497 529
498 if (my $cb = $TERM->{_hook}[$htype]) { 530 if (my $cb = $TERM->{_hook}[$htype]) {
510 $proxy 542 $proxy
511 }, 543 },
512 @_, 544 @_,
513 ) and last; 545 ) and last;
514 }; 546 };
515 warn $@ if $@;#d# 547 if ($@) {
548 $TERM->ungrab; # better to lose the grab than the session
549 warn $@;
550 }
516 } 551 }
517 } 552 }
518 553
519 if ($htype == 1) { # DESTROY 554 if ($htype == 1) { # DESTROY
520 # remove hooks if unused 555 # remove hooks if unused
533 } 568 }
534 569
535 $retval 570 $retval
536} 571}
537 572
573# urxvt::term::proxy
574
538sub urxvt::term::proxy::AUTOLOAD { 575sub urxvt::term::proxy::AUTOLOAD {
539 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 576 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
540 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 577 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
541 578
542 eval qq{ 579 eval qq{
548 } or die "FATAL: unable to compile method forwarder: $@"; 585 } or die "FATAL: unable to compile method forwarder: $@";
549 586
550 goto &$urxvt::term::proxy::AUTOLOAD; 587 goto &$urxvt::term::proxy::AUTOLOAD;
551} 588}
552 589
590sub urxvt::term::proxy::DESTROY {
591 # nop
592}
593
594# urxvt::destroy_hook
595
553sub urxvt::destroy_hook::DESTROY { 596sub urxvt::destroy_hook::DESTROY {
554 ${$_[0]}->(); 597 ${$_[0]}->();
555} 598}
556 599
557sub urxvt::destroy_hook(&) { 600sub urxvt::destroy_hook(&) {
558 bless \shift, urxvt::destroy_hook:: 601 bless \shift, urxvt::destroy_hook::
559} 602}
560 603
604package urxvt::anyevent;
605
606=head2 The C<urxvt::anyevent> Class
607
608The sole purpose of this class is to deliver an interface to the
609C<AnyEvent> module - any module using it will work inside urxvt without
610further work. The only exception is that you cannot wait on condition
611variables, but non-blocking condvar use is ok. What this means is that you
612cannot use blocking APIs, but the non-blocking variant should work.
613
614=cut
615
616our $VERSION = 1;
617
618$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
619push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
620
621sub timer {
622 my ($class, %arg) = @_;
623
624 my $cb = $arg{cb};
625
626 urxvt::timer
627 ->new
628 ->start (urxvt::NOW + $arg{after})
629 ->cb (sub {
630 $_[0]->stop; # need to cancel manually
631 $cb->();
632 })
633}
634
635sub io {
636 my ($class, %arg) = @_;
637
638 my $cb = $arg{cb};
639
640 bless [$arg{fh}, urxvt::iow
641 ->new
642 ->fd (fileno $arg{fh})
643 ->events (($arg{poll} =~ /r/ ? 1 : 0)
644 | ($arg{poll} =~ /w/ ? 2 : 0))
645 ->start
646 ->cb (sub {
647 $cb->(($_[1] & 1 ? 'r' : '')
648 . ($_[1] & 2 ? 'w' : ''));
649 })],
650 urxvt::anyevent::
651}
652
653sub DESTROY {
654 $_[0][1]->stop;
655}
656
657sub condvar {
658 bless \my $flag, urxvt::anyevent::condvar::
659}
660
661sub urxvt::anyevent::condvar::broadcast {
662 ${$_[0]}++;
663}
664
665sub urxvt::anyevent::condvar::wait {
666 unless (${$_[0]}) {
667 require Carp;
668 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
669 }
670}
671
672package urxvt::term;
673
561=head2 The C<urxvt::term> Class 674=head2 The C<urxvt::term> Class
562 675
563=over 4 676=over 4
564 677
565=item $term->destroy 678=item $term->destroy
566 679
567Destroy the terminal object (close the window, free resources etc.). 680Destroy the terminal object (close the window, free resources etc.).
681
682=item $isset = $term->option ($optval[, $set])
683
684Returns true if the option specified by C<$optval> is enabled, and
685optionally change it. All option values are stored by name in the hash
686C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
687
688Here is a a likely non-exhaustive list of option names, please see the
689source file F</src/optinc.h> to see the actual list:
690
691 borderLess console cursorBlink cursorUnderline hold iconic insecure
692 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
693 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
694 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
695 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
696 tripleclickwords utmpInhibit visualBell
568 697
569=item $value = $term->resource ($name[, $newval]) 698=item $value = $term->resource ($name[, $newval])
570 699
571Returns the current resource value associated with a given name and 700Returns the current resource value associated with a given name and
572optionally sets a new value. Setting values is most useful in the C<init> 701optionally sets a new value. Setting values is most useful in the C<init>
582 711
583Please note that resource strings will currently only be freed when the 712Please note that resource strings will currently only be freed when the
584terminal is destroyed, so changing options frequently will eat memory. 713terminal is destroyed, so changing options frequently will eat memory.
585 714
586Here is a a likely non-exhaustive list of resource names, not all of which 715Here is a a likely non-exhaustive list of resource names, not all of which
587are supported in every build, please see the source to see the actual 716are supported in every build, please see the source file F</src/rsinc.h>
588list: 717to see the actual list:
589 718
590 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 719 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
591 borderLess color cursorBlink cursorUnderline cutchars delete_key 720 borderLess color cursorBlink cursorUnderline cutchars delete_key
592 display_name embed ext_bwidth fade font geometry hold iconName 721 display_name embed ext_bwidth fade font geometry hold iconName
593 imFont imLocale inputMethod insecure int_bwidth intensityStyles 722 imFont imLocale inputMethod insecure int_bwidth intensityStyles
600 shade term_name title transparent transparent_all tripleclickwords 729 shade term_name title transparent transparent_all tripleclickwords
601 utmpInhibit visualBell 730 utmpInhibit visualBell
602 731
603=cut 732=cut
604 733
605sub urxvt::term::resource($$;$) { 734sub resource($$;$) {
606 my ($self, $name) = (shift, shift); 735 my ($self, $name) = (shift, shift);
607 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 736 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
608 &urxvt::term::_resource 737 &urxvt::term::_resource
609} 738}
610 739
697C<$event> I<must> be the event causing the menu to pop up (a button event, 826C<$event> I<must> be the event causing the menu to pop up (a button event,
698currently). 827currently).
699 828
700=cut 829=cut
701 830
702sub urxvt::term::popup { 831sub popup {
703 my ($self, $event) = @_; 832 my ($self, $event) = @_;
704 833
705 $self->grab ($event->{time}, 1) 834 $self->grab ($event->{time}, 1)
706 or return; 835 or return;
707 836
897 1026
898=back 1027=back
899 1028
900=cut 1029=cut
901 1030
902sub urxvt::term::line { 1031sub line {
903 my ($self, $row) = @_; 1032 my ($self, $row) = @_;
904 1033
905 my $maxrow = $self->nrow - 1; 1034 my $maxrow = $self->nrow - 1;
906 1035
907 my ($beg, $end) = ($row, $row); 1036 my ($beg, $end) = ($row, $row);
985Converts rxvt-unicodes text reprsentation into a perl string. See 1114Converts rxvt-unicodes text reprsentation into a perl string. See
986C<< $term->ROW_t >> for details. 1115C<< $term->ROW_t >> for details.
987 1116
988=back 1117=back
989 1118
1119=cut
1120
1121package urxvt::popup;
1122
990=head2 The C<urxvt::popup> Class 1123=head2 The C<urxvt::popup> Class
991 1124
992=over 4 1125=over 4
993 1126
994=cut 1127=cut
995
996package urxvt::popup;
997 1128
998sub add_item { 1129sub add_item {
999 my ($self, $item) = @_; 1130 my ($self, $item) = @_;
1000 1131
1132 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1133 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1134 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1135
1136 $item->{render} ||= sub { $_[0]{text} };
1137
1001 push @{ $self->{item} }, $item; 1138 push @{ $self->{item} }, $item;
1139}
1140
1141sub add_separator {
1142 my ($self, $sep) = @_;
1143
1144 $sep ||= "═";
1145
1146 $self->add_item ({
1147 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1148 text => "",
1149 render => sub { $sep x $urxvt::TERM->ncol },
1150 activate => sub { },
1151 });
1152}
1153
1154sub add_title {
1155 my ($self, $title) = @_;
1156
1157 $self->add_item ({
1158 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1159 text => $title,
1160 activate => sub { },
1161 });
1002} 1162}
1003 1163
1004sub add_button { 1164sub add_button {
1005 my ($self, $text, $cb) = @_; 1165 my ($self, $text, $cb) = @_;
1006 1166
1007 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, 1167 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1008 render => sub { $_[0]{text} },
1009 });
1010} 1168}
1011 1169
1012sub add_toggle { 1170sub add_toggle {
1013 my ($self, $text, $cb, $value) = @_; 1171 my ($self, $text, $cb, $value) = @_;
1014 1172
1015 $self->add_item ({ type => "button", text => " $text", value => $value, 1173 my $item; $item = {
1174 type => "button",
1175 text => " $text",
1176 value => $value,
1016 render => sub { ($_[0]{value} ? "" : " ") . substr $_[0]{text}, 1 }, 1177 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1017 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1178 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1018 }); 1179 };
1180
1181 $self->add_item ($item);
1019} 1182}
1020 1183
1021sub show { 1184sub show {
1022 my ($self) = @_; 1185 my ($self) = @_;
1023 1186
1030} 1193}
1031 1194
1032sub DESTROY { 1195sub DESTROY {
1033 my ($self) = @_; 1196 my ($self) = @_;
1034 1197
1198 delete $self->{term}{_destroy}{$self};
1035 $self->{term}->ungrab; 1199 $self->{term}->ungrab;
1036} 1200}
1037 1201
1038=head2 The C<urxvt::timer> Class 1202=head2 The C<urxvt::timer> Class
1039 1203
1143This variable controls the verbosity level of the perl extension. Higher 1307This variable controls the verbosity level of the perl extension. Higher
1144numbers indicate more verbose output. 1308numbers indicate more verbose output.
1145 1309
1146=over 4 1310=over 4
1147 1311
1148=item =0 - only fatal messages 1312=item == 0 - fatal messages
1149 1313
1150=item =3 - script loading and management 1314=item >= 3 - script loading and management
1151 1315
1152=item =10 - all events received 1316=item >=10 - all events received
1153 1317
1154=back 1318=back
1155 1319
1156=head1 AUTHOR 1320=head1 AUTHOR
1157 1321

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines