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.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
397 403
398=cut 404=cut
399 405
400package urxvt; 406package urxvt;
401 407
408use utf8;
402use strict; 409use strict;
403use Scalar::Util (); 410use Scalar::Util ();
411use List::Util ();
404 412
413our $VERSION = 1;
405our $TERM; 414our $TERM;
406our @HOOKNAME; 415our @HOOKNAME;
416our %OPTION;
407our $LIBDIR; 417our $LIBDIR;
408 418
409BEGIN { 419BEGIN {
410 urxvt->bootstrap; 420 urxvt->bootstrap;
411 421
414 my $msg = join "", @_; 424 my $msg = join "", @_;
415 $msg .= "\n" 425 $msg .= "\n"
416 unless $msg =~ /\n$/; 426 unless $msg =~ /\n$/;
417 urxvt::warn ($msg); 427 urxvt::warn ($msg);
418 }; 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";
419} 434}
420 435
421my @hook_count; 436my @hook_count;
422my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 437my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
423 438
456 verbose 3, "loading extension '$path' into package '$pkg'"; 471 verbose 3, "loading extension '$path' into package '$pkg'";
457 472
458 open my $fh, "<:raw", $path 473 open my $fh, "<:raw", $path
459 or die "$path: $!"; 474 or die "$path: $!";
460 475
461 my $source = "package $pkg; use strict; use utf8;\n" 476 my $source = untaint "package $pkg; use strict; use utf8;\n"
462 . "use base urxvt::term::proxy::;\n" 477 . "use base urxvt::term::proxy::;\n"
463 . "#line 1 \"$path\"\n{\n" 478 . "#line 1 \"$path\"\n{\n"
464 . (do { local $/; <$fh> }) 479 . (do { local $/; <$fh> })
465 . "\n};\n1"; 480 . "\n};\n1";
466 481
477 local $TERM = shift; 492 local $TERM = shift;
478 my $htype = shift; 493 my $htype = shift;
479 494
480 if ($htype == 0) { # INIT 495 if ($htype == 0) { # INIT
481 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 496 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
497
498 my %want_ext;
482 499
483 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) {
484 my @files = grep -f $_, map "$_/$ext", @dirs; 511 my @files = grep -f $_, map "$_/$ext", @dirs;
485 512
486 if (@files) { 513 if (@files) {
487 register_package extension_package $files[0]; 514 register_package extension_package $files[0];
488 } else { 515 } else {
489 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";
490 } 517 }
491 } 518 }
519
520 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
521 warn $@ if $@;
492 } 522 }
493 523
494 $retval = undef; 524 $retval = undef;
495 525
496 if (my $cb = $TERM->{_hook}[$htype]) { 526 if (my $cb = $TERM->{_hook}[$htype]) {
508 $proxy 538 $proxy
509 }, 539 },
510 @_, 540 @_,
511 ) and last; 541 ) and last;
512 }; 542 };
513 warn $@ if $@;#d# 543 if ($@) {
544 $TERM->ungrab; # better to lose the grab than the session
545 warn $@;
546 }
514 } 547 }
515 } 548 }
516 549
517 if ($htype == 1) { # DESTROY 550 if ($htype == 1) { # DESTROY
518 # remove hooks if unused 551 # remove hooks if unused
531 } 564 }
532 565
533 $retval 566 $retval
534} 567}
535 568
569# urxvt::term::proxy
570
536sub urxvt::term::proxy::AUTOLOAD { 571sub urxvt::term::proxy::AUTOLOAD {
537 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 572 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
538 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 573 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
539 574
540 eval qq{ 575 eval qq{
546 } or die "FATAL: unable to compile method forwarder: $@"; 581 } or die "FATAL: unable to compile method forwarder: $@";
547 582
548 goto &$urxvt::term::proxy::AUTOLOAD; 583 goto &$urxvt::term::proxy::AUTOLOAD;
549} 584}
550 585
586sub urxvt::term::proxy::DESTROY {
587 # nop
588}
589
590# urxvt::destroy_hook
591
551sub urxvt::destroy_hook::DESTROY { 592sub urxvt::destroy_hook::DESTROY {
552 ${$_[0]}->(); 593 ${$_[0]}->();
553} 594}
554 595
555sub urxvt::destroy_hook(&) { 596sub urxvt::destroy_hook(&) {
556 bless \shift, urxvt::destroy_hook:: 597 bless \shift, urxvt::destroy_hook::
557} 598}
558 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
559=head2 The C<urxvt::term> Class 670=head2 The C<urxvt::term> Class
560 671
561=over 4 672=over 4
562 673
563=item $term->destroy 674=item $term->destroy
564 675
565Destroy 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
566 693
567=item $value = $term->resource ($name[, $newval]) 694=item $value = $term->resource ($name[, $newval])
568 695
569Returns the current resource value associated with a given name and 696Returns the current resource value associated with a given name and
570optionally 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>
580 707
581Please note that resource strings will currently only be freed when the 708Please note that resource strings will currently only be freed when the
582terminal is destroyed, so changing options frequently will eat memory. 709terminal is destroyed, so changing options frequently will eat memory.
583 710
584Here 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
585are 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>
586list: 713to see the actual list:
587 714
588 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 715 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
589 borderLess color cursorBlink cursorUnderline cutchars delete_key 716 borderLess color cursorBlink cursorUnderline cutchars delete_key
590 display_name embed ext_bwidth fade font geometry hold iconName 717 display_name embed ext_bwidth fade font geometry hold iconName
591 imFont imLocale inputMethod insecure int_bwidth intensityStyles 718 imFont imLocale inputMethod insecure int_bwidth intensityStyles
598 shade term_name title transparent transparent_all tripleclickwords 725 shade term_name title transparent transparent_all tripleclickwords
599 utmpInhibit visualBell 726 utmpInhibit visualBell
600 727
601=cut 728=cut
602 729
603sub urxvt::term::resource($$;$) { 730sub resource($$;$) {
604 my ($self, $name) = (shift, shift); 731 my ($self, $name) = (shift, shift);
605 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 732 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
606 &urxvt::term::_resource 733 &urxvt::term::_resource
607} 734}
608 735
695C<$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,
696currently). 823currently).
697 824
698=cut 825=cut
699 826
700sub urxvt::term::popup { 827sub popup {
701 my ($self, $event) = @_; 828 my ($self, $event) = @_;
702 829
703 $self->grab ($event->{time}, 1) 830 $self->grab ($event->{time}, 1)
704 or return; 831 or return;
705 832
895 1022
896=back 1023=back
897 1024
898=cut 1025=cut
899 1026
900sub urxvt::term::line { 1027sub line {
901 my ($self, $row) = @_; 1028 my ($self, $row) = @_;
902 1029
903 my $maxrow = $self->nrow - 1; 1030 my $maxrow = $self->nrow - 1;
904 1031
905 my ($beg, $end) = ($row, $row); 1032 my ($beg, $end) = ($row, $row);
969 $offset / $self->{ncol} + $self->{beg}, 1096 $offset / $self->{ncol} + $self->{beg},
970 $offset % $self->{ncol} 1097 $offset % $self->{ncol}
971 ) 1098 )
972} 1099}
973 1100
974=item ($row, $col) = $line->coord_of ($offset)
975=item $text = $term->special_encode $string 1101=item $text = $term->special_encode $string
976 1102
977Converts a perl string into the special encoding used by rxvt-unicode, 1103Converts a perl string into the special encoding used by rxvt-unicode,
978where one character corresponds to one screen cell. See 1104where one character corresponds to one screen cell. See
979C<< $term->ROW_t >> for details. 1105C<< $term->ROW_t >> for details.
981=item $string = $term->special_decode $text 1107=item $string = $term->special_decode $text
982 1108
983Converts rxvt-unicodes text reprsentation into a perl string. See 1109Converts rxvt-unicodes text reprsentation into a perl string. See
984C<< $term->ROW_t >> for details. 1110C<< $term->ROW_t >> for details.
985 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
986=back 1140=back
987 1141
1142=cut
1143
1144package urxvt::popup;
1145
988=head2 The C<urxvt::popup> Class 1146=head2 The C<urxvt::popup> Class
989 1147
990=over 4 1148=over 4
991 1149
992=cut 1150=cut
993
994package urxvt::popup;
995 1151
996sub add_item { 1152sub add_item {
997 my ($self, $item) = @_; 1153 my ($self, $item) = @_;
998 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
999 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 });
1000} 1185}
1001 1186
1002sub add_button { 1187sub add_button {
1003 my ($self, $text, $cb) = @_; 1188 my ($self, $text, $cb) = @_;
1004 1189
1005 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); 1190 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1191}
1192
1193sub add_toggle {
1194 my ($self, $text, $cb, $value) = @_;
1195
1196 my $item; $item = {
1197 type => "button",
1198 text => " $text",
1199 value => $value,
1200 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1201 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1202 };
1203
1204 $self->add_item ($item);
1006} 1205}
1007 1206
1008sub show { 1207sub show {
1009 my ($self) = @_; 1208 my ($self) = @_;
1010 1209
1017} 1216}
1018 1217
1019sub DESTROY { 1218sub DESTROY {
1020 my ($self) = @_; 1219 my ($self) = @_;
1021 1220
1221 delete $self->{term}{_destroy}{$self};
1022 $self->{term}->ungrab; 1222 $self->{term}->ungrab;
1023} 1223}
1024 1224
1025=head2 The C<urxvt::timer> Class 1225=head2 The C<urxvt::timer> Class
1026 1226
1130This variable controls the verbosity level of the perl extension. Higher 1330This variable controls the verbosity level of the perl extension. Higher
1131numbers indicate more verbose output. 1331numbers indicate more verbose output.
1132 1332
1133=over 4 1333=over 4
1134 1334
1135=item =0 - only fatal messages 1335=item == 0 - fatal messages
1136 1336
1137=item =3 - script loading and management 1337=item >= 3 - script loading and management
1138 1338
1139=item =10 - all events received 1339=item >=10 - all events received
1140 1340
1141=back 1341=back
1142 1342
1143=head1 AUTHOR 1343=head1 AUTHOR
1144 1344

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines