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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines