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.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;
416our %OPTION;
409our $LIBDIR; 417our $LIBDIR;
410 418
411BEGIN { 419BEGIN {
412 urxvt->bootstrap; 420 urxvt->bootstrap;
413 421
416 my $msg = join "", @_; 424 my $msg = join "", @_;
417 $msg .= "\n" 425 $msg .= "\n"
418 unless $msg =~ /\n$/; 426 unless $msg =~ /\n$/;
419 urxvt::warn ($msg); 427 urxvt::warn ($msg);
420 }; 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";
421} 434}
422 435
423my @hook_count; 436my @hook_count;
424my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 437my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
425 438
458 verbose 3, "loading extension '$path' into package '$pkg'"; 471 verbose 3, "loading extension '$path' into package '$pkg'";
459 472
460 open my $fh, "<:raw", $path 473 open my $fh, "<:raw", $path
461 or die "$path: $!"; 474 or die "$path: $!";
462 475
463 my $source = "package $pkg; use strict; use utf8;\n" 476 my $source = untaint "package $pkg; use strict; use utf8;\n"
464 . "use base urxvt::term::proxy::;\n" 477 . "use base urxvt::term::proxy::;\n"
465 . "#line 1 \"$path\"\n{\n" 478 . "#line 1 \"$path\"\n{\n"
466 . (do { local $/; <$fh> }) 479 . (do { local $/; <$fh> })
467 . "\n};\n1"; 480 . "\n};\n1";
468 481
479 local $TERM = shift; 492 local $TERM = shift;
480 my $htype = shift; 493 my $htype = shift;
481 494
482 if ($htype == 0) { # INIT 495 if ($htype == 0) { # INIT
483 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 496 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
497
498 my %want_ext;
484 499
485 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 500 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
501 if ($_ eq "default") {
502 $want_ext{$_}++ for qw(selection option-popup selection-popup);
503 } elsif (/^-(.*)$/) {
504 delete $want_ext{$1};
505 } else {
506 $want_ext{$_}++;
507 }
508 }
509
510 for my $ext (keys %want_ext) {
486 my @files = grep -f $_, map "$_/$ext", @dirs; 511 my @files = grep -f $_, map "$_/$ext", @dirs;
487 512
488 if (@files) { 513 if (@files) {
489 register_package extension_package $files[0]; 514 register_package extension_package $files[0];
490 } else { 515 } else {
491 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";
492 } 517 }
493 } 518 }
519
520 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
521 warn $@ if $@;
494 } 522 }
495 523
496 $retval = undef; 524 $retval = undef;
497 525
498 if (my $cb = $TERM->{_hook}[$htype]) { 526 if (my $cb = $TERM->{_hook}[$htype]) {
510 $proxy 538 $proxy
511 }, 539 },
512 @_, 540 @_,
513 ) and last; 541 ) and last;
514 }; 542 };
515 warn $@ if $@;#d# 543 if ($@) {
544 $TERM->ungrab; # better to lose the grab than the session
545 warn $@;
546 }
516 } 547 }
517 } 548 }
518 549
519 if ($htype == 1) { # DESTROY 550 if ($htype == 1) { # DESTROY
520 # remove hooks if unused 551 # remove hooks if unused
533 } 564 }
534 565
535 $retval 566 $retval
536} 567}
537 568
569# urxvt::term::proxy
570
538sub urxvt::term::proxy::AUTOLOAD { 571sub urxvt::term::proxy::AUTOLOAD {
539 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 572 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
540 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 573 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
541 574
542 eval qq{ 575 eval qq{
548 } or die "FATAL: unable to compile method forwarder: $@"; 581 } or die "FATAL: unable to compile method forwarder: $@";
549 582
550 goto &$urxvt::term::proxy::AUTOLOAD; 583 goto &$urxvt::term::proxy::AUTOLOAD;
551} 584}
552 585
586sub urxvt::term::proxy::DESTROY {
587 # nop
588}
589
590# urxvt::destroy_hook
591
553sub urxvt::destroy_hook::DESTROY { 592sub urxvt::destroy_hook::DESTROY {
554 ${$_[0]}->(); 593 ${$_[0]}->();
555} 594}
556 595
557sub urxvt::destroy_hook(&) { 596sub urxvt::destroy_hook(&) {
558 bless \shift, urxvt::destroy_hook:: 597 bless \shift, urxvt::destroy_hook::
559} 598}
560 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;
669
561=head2 The C<urxvt::term> Class 670=head2 The C<urxvt::term> Class
562 671
563=over 4 672=over 4
564 673
565=item $term->destroy 674=item $term->destroy
566 675
567Destroy the terminal object (close the window, free resources etc.). 676Destroy the terminal object (close the window, free resources etc.).
677
678=item $isset = $term->option ($optval[, $set])
679
680Returns true if the option specified by C<$optval> is enabled, and
681optionally change it. All option values are stored by name in the hash
682C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
683
684Here is a a likely non-exhaustive list of option names, please see the
685source file F</src/optinc.h> to see the actual list:
686
687 borderLess console cursorBlink cursorUnderline hold iconic insecure
688 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
689 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
690 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
691 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
692 tripleclickwords utmpInhibit visualBell
568 693
569=item $value = $term->resource ($name[, $newval]) 694=item $value = $term->resource ($name[, $newval])
570 695
571Returns the current resource value associated with a given name and 696Returns the current resource value associated with a given name and
572optionally sets a new value. Setting values is most useful in the C<init> 697optionally sets a new value. Setting values is most useful in the C<init>
582 707
583Please note that resource strings will currently only be freed when the 708Please note that resource strings will currently only be freed when the
584terminal is destroyed, so changing options frequently will eat memory. 709terminal is destroyed, so changing options frequently will eat memory.
585 710
586Here is a a likely non-exhaustive list of resource names, not all of which 711Here 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 712are supported in every build, please see the source file F</src/rsinc.h>
588list: 713to see the actual list:
589 714
590 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 715 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
591 borderLess color cursorBlink cursorUnderline cutchars delete_key 716 borderLess color cursorBlink cursorUnderline cutchars delete_key
592 display_name embed ext_bwidth fade font geometry hold iconName 717 display_name embed ext_bwidth fade font geometry hold iconName
593 imFont imLocale inputMethod insecure int_bwidth intensityStyles 718 imFont imLocale inputMethod insecure int_bwidth intensityStyles
600 shade term_name title transparent transparent_all tripleclickwords 725 shade term_name title transparent transparent_all tripleclickwords
601 utmpInhibit visualBell 726 utmpInhibit visualBell
602 727
603=cut 728=cut
604 729
605sub urxvt::term::resource($$;$) { 730sub resource($$;$) {
606 my ($self, $name) = (shift, shift); 731 my ($self, $name) = (shift, shift);
607 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 732 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
608 &urxvt::term::_resource 733 &urxvt::term::_resource
609} 734}
610 735
697C<$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,
698currently). 823currently).
699 824
700=cut 825=cut
701 826
702sub urxvt::term::popup { 827sub popup {
703 my ($self, $event) = @_; 828 my ($self, $event) = @_;
704 829
705 $self->grab ($event->{time}, 1) 830 $self->grab ($event->{time}, 1)
706 or return; 831 or return;
707 832
897 1022
898=back 1023=back
899 1024
900=cut 1025=cut
901 1026
902sub urxvt::term::line { 1027sub line {
903 my ($self, $row) = @_; 1028 my ($self, $row) = @_;
904 1029
905 my $maxrow = $self->nrow - 1; 1030 my $maxrow = $self->nrow - 1;
906 1031
907 my ($beg, $end) = ($row, $row); 1032 my ($beg, $end) = ($row, $row);
971 $offset / $self->{ncol} + $self->{beg}, 1096 $offset / $self->{ncol} + $self->{beg},
972 $offset % $self->{ncol} 1097 $offset % $self->{ncol}
973 ) 1098 )
974} 1099}
975 1100
976=item ($row, $col) = $line->coord_of ($offset)
977=item $text = $term->special_encode $string 1101=item $text = $term->special_encode $string
978 1102
979Converts a perl string into the special encoding used by rxvt-unicode, 1103Converts a perl string into the special encoding used by rxvt-unicode,
980where one character corresponds to one screen cell. See 1104where one character corresponds to one screen cell. See
981C<< $term->ROW_t >> for details. 1105C<< $term->ROW_t >> for details.
983=item $string = $term->special_decode $text 1107=item $string = $term->special_decode $text
984 1108
985Converts rxvt-unicodes text reprsentation into a perl string. See 1109Converts rxvt-unicodes text reprsentation into a perl string. See
986C<< $term->ROW_t >> for details. 1110C<< $term->ROW_t >> for details.
987 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
988=back 1140=back
989 1141
1142=cut
1143
1144package urxvt::popup;
1145
990=head2 The C<urxvt::popup> Class 1146=head2 The C<urxvt::popup> Class
991 1147
992=over 4 1148=over 4
993 1149
994=cut 1150=cut
995
996package urxvt::popup;
997 1151
998sub add_item { 1152sub add_item {
999 my ($self, $item) = @_; 1153 my ($self, $item) = @_;
1000 1154
1155 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1156 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1157 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1158
1159 $item->{render} ||= sub { $_[0]{text} };
1160
1001 push @{ $self->{item} }, $item; 1161 push @{ $self->{item} }, $item;
1162}
1163
1164sub add_separator {
1165 my ($self, $sep) = @_;
1166
1167 $sep ||= "═";
1168
1169 $self->add_item ({
1170 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1171 text => "",
1172 render => sub { $sep x $urxvt::TERM->ncol },
1173 activate => sub { },
1174 });
1175}
1176
1177sub add_title {
1178 my ($self, $title) = @_;
1179
1180 $self->add_item ({
1181 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1182 text => $title,
1183 activate => sub { },
1184 });
1002} 1185}
1003 1186
1004sub add_button { 1187sub add_button {
1005 my ($self, $text, $cb) = @_; 1188 my ($self, $text, $cb) = @_;
1006 1189
1007 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, 1190 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1008 render => sub { $_[0]{text} },
1009 });
1010} 1191}
1011 1192
1012sub add_toggle { 1193sub add_toggle {
1013 my ($self, $text, $cb, $value) = @_; 1194 my ($self, $text, $cb, $value) = @_;
1014 1195
1015 $self->add_item ({ type => "button", text => " $text", value => $value, 1196 my $item; $item = {
1197 type => "button",
1198 text => " $text",
1199 value => $value,
1016 render => sub { ($_[0]{value} ? "" : " ") . substr $_[0]{text}, 1 }, 1200 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1017 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1201 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1018 }); 1202 };
1203
1204 $self->add_item ($item);
1019} 1205}
1020 1206
1021sub show { 1207sub show {
1022 my ($self) = @_; 1208 my ($self) = @_;
1023 1209
1030} 1216}
1031 1217
1032sub DESTROY { 1218sub DESTROY {
1033 my ($self) = @_; 1219 my ($self) = @_;
1034 1220
1221 delete $self->{term}{_destroy}{$self};
1035 $self->{term}->ungrab; 1222 $self->{term}->ungrab;
1036} 1223}
1037 1224
1038=head2 The C<urxvt::timer> Class 1225=head2 The C<urxvt::timer> Class
1039 1226
1143This variable controls the verbosity level of the perl extension. Higher 1330This variable controls the verbosity level of the perl extension. Higher
1144numbers indicate more verbose output. 1331numbers indicate more verbose output.
1145 1332
1146=over 4 1333=over 4
1147 1334
1148=item =0 - only fatal messages 1335=item == 0 - fatal messages
1149 1336
1150=item =3 - script loading and management 1337=item >= 3 - script loading and management
1151 1338
1152=item =10 - all events received 1339=item >=10 - all events received
1153 1340
1154=back 1341=back
1155 1342
1156=head1 AUTHOR 1343=head1 AUTHOR
1157 1344

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines