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.47 by root, Sat Jan 7 21:22:02 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
397 407
398=cut 408=cut
399 409
400package urxvt; 410package urxvt;
401 411
412use utf8;
402use strict; 413use strict;
403use Scalar::Util (); 414use Scalar::Util ();
415use List::Util ();
404 416
417our $VERSION = 1;
405our $TERM; 418our $TERM;
406our @HOOKNAME; 419our @HOOKNAME;
420our %OPTION;
407our $LIBDIR; 421our $LIBDIR;
408 422
409BEGIN { 423BEGIN {
410 urxvt->bootstrap; 424 urxvt->bootstrap;
411 425
414 my $msg = join "", @_; 428 my $msg = join "", @_;
415 $msg .= "\n" 429 $msg .= "\n"
416 unless $msg =~ /\n$/; 430 unless $msg =~ /\n$/;
417 urxvt::warn ($msg); 431 urxvt::warn ($msg);
418 }; 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";
419} 438}
420 439
421my @hook_count; 440my @hook_count;
422my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 441my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
423 442
456 verbose 3, "loading extension '$path' into package '$pkg'"; 475 verbose 3, "loading extension '$path' into package '$pkg'";
457 476
458 open my $fh, "<:raw", $path 477 open my $fh, "<:raw", $path
459 or die "$path: $!"; 478 or die "$path: $!";
460 479
461 my $source = "package $pkg; use strict; use utf8;\n" 480 my $source = untaint "package $pkg; use strict; use utf8;\n"
462 . "use base urxvt::term::proxy::;\n" 481 . "use base urxvt::term::proxy::;\n"
463 . "#line 1 \"$path\"\n{\n" 482 . "#line 1 \"$path\"\n{\n"
464 . (do { local $/; <$fh> }) 483 . (do { local $/; <$fh> })
465 . "\n};\n1"; 484 . "\n};\n1";
466 485
477 local $TERM = shift; 496 local $TERM = shift;
478 my $htype = shift; 497 my $htype = shift;
479 498
480 if ($htype == 0) { # INIT 499 if ($htype == 0) { # INIT
481 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 500 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
501
502 my %want_ext;
482 503
483 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) {
484 my @files = grep -f $_, map "$_/$ext", @dirs; 515 my @files = grep -f $_, map "$_/$ext", @dirs;
485 516
486 if (@files) { 517 if (@files) {
487 register_package extension_package $files[0]; 518 register_package extension_package $files[0];
488 } else { 519 } else {
489 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";
490 } 521 }
491 } 522 }
523
524 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
525 warn $@ if $@;
492 } 526 }
493 527
494 $retval = undef; 528 $retval = undef;
495 529
496 if (my $cb = $TERM->{_hook}[$htype]) { 530 if (my $cb = $TERM->{_hook}[$htype]) {
508 $proxy 542 $proxy
509 }, 543 },
510 @_, 544 @_,
511 ) and last; 545 ) and last;
512 }; 546 };
513 warn $@ if $@;#d# 547 if ($@) {
548 $TERM->ungrab; # better to lose the grab than the session
549 warn $@;
550 }
514 } 551 }
515 } 552 }
516 553
517 if ($htype == 1) { # DESTROY 554 if ($htype == 1) { # DESTROY
518 # remove hooks if unused 555 # remove hooks if unused
531 } 568 }
532 569
533 $retval 570 $retval
534} 571}
535 572
573# urxvt::term::proxy
574
536sub urxvt::term::proxy::AUTOLOAD { 575sub urxvt::term::proxy::AUTOLOAD {
537 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 576 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
538 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 577 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
539 578
540 eval qq{ 579 eval qq{
546 } or die "FATAL: unable to compile method forwarder: $@"; 585 } or die "FATAL: unable to compile method forwarder: $@";
547 586
548 goto &$urxvt::term::proxy::AUTOLOAD; 587 goto &$urxvt::term::proxy::AUTOLOAD;
549} 588}
550 589
590sub urxvt::term::proxy::DESTROY {
591 # nop
592}
593
594# urxvt::destroy_hook
595
551sub urxvt::destroy_hook::DESTROY { 596sub urxvt::destroy_hook::DESTROY {
552 ${$_[0]}->(); 597 ${$_[0]}->();
553} 598}
554 599
555sub urxvt::destroy_hook(&) { 600sub urxvt::destroy_hook(&) {
556 bless \shift, urxvt::destroy_hook:: 601 bless \shift, urxvt::destroy_hook::
557} 602}
558 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
559=head2 The C<urxvt::term> Class 674=head2 The C<urxvt::term> Class
560 675
561=over 4 676=over 4
562 677
563=item $term->destroy 678=item $term->destroy
564 679
565Destroy 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
566 697
567=item $value = $term->resource ($name[, $newval]) 698=item $value = $term->resource ($name[, $newval])
568 699
569Returns the current resource value associated with a given name and 700Returns the current resource value associated with a given name and
570optionally 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>
580 711
581Please note that resource strings will currently only be freed when the 712Please note that resource strings will currently only be freed when the
582terminal is destroyed, so changing options frequently will eat memory. 713terminal is destroyed, so changing options frequently will eat memory.
583 714
584Here 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
585are 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>
586list: 717to see the actual list:
587 718
588 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 719 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
589 borderLess color cursorBlink cursorUnderline cutchars delete_key 720 borderLess color cursorBlink cursorUnderline cutchars delete_key
590 display_name embed ext_bwidth fade font geometry hold iconName 721 display_name embed ext_bwidth fade font geometry hold iconName
591 imFont imLocale inputMethod insecure int_bwidth intensityStyles 722 imFont imLocale inputMethod insecure int_bwidth intensityStyles
598 shade term_name title transparent transparent_all tripleclickwords 729 shade term_name title transparent transparent_all tripleclickwords
599 utmpInhibit visualBell 730 utmpInhibit visualBell
600 731
601=cut 732=cut
602 733
603sub urxvt::term::resource($$;$) { 734sub resource($$;$) {
604 my ($self, $name) = (shift, shift); 735 my ($self, $name) = (shift, shift);
605 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 736 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
606 &urxvt::term::_resource 737 &urxvt::term::_resource
607} 738}
608 739
695C<$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,
696currently). 827currently).
697 828
698=cut 829=cut
699 830
700sub urxvt::term::popup { 831sub popup {
701 my ($self, $event) = @_; 832 my ($self, $event) = @_;
702 833
703 $self->grab ($event->{time}, 1) 834 $self->grab ($event->{time}, 1)
704 or return; 835 or return;
705 836
895 1026
896=back 1027=back
897 1028
898=cut 1029=cut
899 1030
900sub urxvt::term::line { 1031sub line {
901 my ($self, $row) = @_; 1032 my ($self, $row) = @_;
902 1033
903 my $maxrow = $self->nrow - 1; 1034 my $maxrow = $self->nrow - 1;
904 1035
905 my ($beg, $end) = ($row, $row); 1036 my ($beg, $end) = ($row, $row);
983Converts rxvt-unicodes text reprsentation into a perl string. See 1114Converts rxvt-unicodes text reprsentation into a perl string. See
984C<< $term->ROW_t >> for details. 1115C<< $term->ROW_t >> for details.
985 1116
986=back 1117=back
987 1118
1119=cut
1120
1121package urxvt::popup;
1122
988=head2 The C<urxvt::popup> Class 1123=head2 The C<urxvt::popup> Class
989 1124
990=over 4 1125=over 4
991 1126
992=cut 1127=cut
993
994package urxvt::popup;
995 1128
996sub add_item { 1129sub add_item {
997 my ($self, $item) = @_; 1130 my ($self, $item) = @_;
998 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
999 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 });
1000} 1162}
1001 1163
1002sub add_button { 1164sub add_button {
1003 my ($self, $text, $cb) = @_; 1165 my ($self, $text, $cb) = @_;
1004 1166
1005 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); 1167 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1168}
1169
1170sub add_toggle {
1171 my ($self, $text, $cb, $value) = @_;
1172
1173 my $item; $item = {
1174 type => "button",
1175 text => " $text",
1176 value => $value,
1177 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1178 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1179 };
1180
1181 $self->add_item ($item);
1006} 1182}
1007 1183
1008sub show { 1184sub show {
1009 my ($self) = @_; 1185 my ($self) = @_;
1010 1186
1017} 1193}
1018 1194
1019sub DESTROY { 1195sub DESTROY {
1020 my ($self) = @_; 1196 my ($self) = @_;
1021 1197
1198 delete $self->{term}{_destroy}{$self};
1022 $self->{term}->ungrab; 1199 $self->{term}->ungrab;
1023} 1200}
1024 1201
1025=head2 The C<urxvt::timer> Class 1202=head2 The C<urxvt::timer> Class
1026 1203
1130This variable controls the verbosity level of the perl extension. Higher 1307This variable controls the verbosity level of the perl extension. Higher
1131numbers indicate more verbose output. 1308numbers indicate more verbose output.
1132 1309
1133=over 4 1310=over 4
1134 1311
1135=item =0 - only fatal messages 1312=item == 0 - fatal messages
1136 1313
1137=item =3 - script loading and management 1314=item >= 3 - script loading and management
1138 1315
1139=item =10 - all events received 1316=item >=10 - all events received
1140 1317
1141=back 1318=back
1142 1319
1143=head1 AUTHOR 1320=head1 AUTHOR
1144 1321

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines