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.67 by root, Mon Jan 9 19:29:06 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
327that calls this function. 333that calls this function.
328 334
329Using this function has the advantage that its output ends up in the 335Using this function has the advantage that its output ends up in the
330correct place, e.g. on stderr of the connecting urxvtc client. 336correct place, e.g. on stderr of the connecting urxvtc client.
331 337
338=item $is_safe = urxvt::safe
339
340Returns true when it is safe to do potentially unsafe things, such as
341evaluating perl code specified by the user. This is true when urxvt was
342started setuid or setgid.
343
332=item $time = urxvt::NOW 344=item $time = urxvt::NOW
333 345
334Returns the "current time" (as per the event loop). 346Returns the "current time" (as per the event loop).
335 347
336=item urxvt::CurrentTime 348=item urxvt::CurrentTime
337 349
338=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 350=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 351Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340Button4Mask, Button5Mask, AnyModifier 352Button4Mask, Button5Mask, AnyModifier
341 353
342Various constants for use in X events. 354Various constants for use in X calls and event processing.
343 355
344=back 356=back
345 357
346=head2 RENDITION 358=head2 RENDITION
347 359
402use utf8; 414use utf8;
403use strict; 415use strict;
404use Scalar::Util (); 416use Scalar::Util ();
405use List::Util (); 417use List::Util ();
406 418
419our $VERSION = 1;
407our $TERM; 420our $TERM;
408our @HOOKNAME; 421our @HOOKNAME;
422our %OPTION;
409our $LIBDIR; 423our $LIBDIR;
410 424
411BEGIN { 425BEGIN {
412 urxvt->bootstrap; 426 urxvt->bootstrap;
413 427
416 my $msg = join "", @_; 430 my $msg = join "", @_;
417 $msg .= "\n" 431 $msg .= "\n"
418 unless $msg =~ /\n$/; 432 unless $msg =~ /\n$/;
419 urxvt::warn ($msg); 433 urxvt::warn ($msg);
420 }; 434 };
435
436 delete $ENV{IFS};
437 delete $ENV{CDPATH};
438 delete $ENV{BASH_ENV};
439 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
421} 440}
422 441
423my @hook_count; 442my @hook_count;
424my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 443my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
425 444
458 verbose 3, "loading extension '$path' into package '$pkg'"; 477 verbose 3, "loading extension '$path' into package '$pkg'";
459 478
460 open my $fh, "<:raw", $path 479 open my $fh, "<:raw", $path
461 or die "$path: $!"; 480 or die "$path: $!";
462 481
463 my $source = "package $pkg; use strict; use utf8;\n" 482 my $source = untaint "package $pkg; use strict; use utf8;\n"
464 . "use base urxvt::term::proxy::;\n" 483 . "use base urxvt::term::proxy::;\n"
465 . "#line 1 \"$path\"\n{\n" 484 . "#line 1 \"$path\"\n{\n"
466 . (do { local $/; <$fh> }) 485 . (do { local $/; <$fh> })
467 . "\n};\n1"; 486 . "\n};\n1";
468 487
479 local $TERM = shift; 498 local $TERM = shift;
480 my $htype = shift; 499 my $htype = shift;
481 500
482 if ($htype == 0) { # INIT 501 if ($htype == 0) { # INIT
483 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 502 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503
504 my %want_ext;
484 505
485 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 506 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507 if ($_ eq "default") {
508 $want_ext{$_}++ for qw(selection option-popup selection-popup);
509 } elsif (/^-(.*)$/) {
510 delete $want_ext{$1};
511 } else {
512 $want_ext{$_}++;
513 }
514 }
515
516 for my $ext (keys %want_ext) {
486 my @files = grep -f $_, map "$_/$ext", @dirs; 517 my @files = grep -f $_, map "$_/$ext", @dirs;
487 518
488 if (@files) { 519 if (@files) {
489 register_package extension_package $files[0]; 520 register_package extension_package $files[0];
490 } else { 521 } else {
491 warn "perl extension '$ext' not found in perl library search path\n"; 522 warn "perl extension '$ext' not found in perl library search path\n";
492 } 523 }
493 } 524 }
525
526 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
527 warn $@ if $@;
494 } 528 }
495 529
496 $retval = undef; 530 $retval = undef;
497 531
498 if (my $cb = $TERM->{_hook}[$htype]) { 532 if (my $cb = $TERM->{_hook}[$htype]) {
510 $proxy 544 $proxy
511 }, 545 },
512 @_, 546 @_,
513 ) and last; 547 ) and last;
514 }; 548 };
515 warn $@ if $@;#d# 549 if ($@) {
550 $TERM->ungrab; # better to lose the grab than the session
551 warn $@;
552 }
516 } 553 }
517 } 554 }
518 555
519 if ($htype == 1) { # DESTROY 556 if ($htype == 1) { # DESTROY
520 # remove hooks if unused 557 # remove hooks if unused
533 } 570 }
534 571
535 $retval 572 $retval
536} 573}
537 574
575# urxvt::term::proxy
576
538sub urxvt::term::proxy::AUTOLOAD { 577sub urxvt::term::proxy::AUTOLOAD {
539 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 578 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
540 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 579 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
541 580
542 eval qq{ 581 eval qq{
548 } or die "FATAL: unable to compile method forwarder: $@"; 587 } or die "FATAL: unable to compile method forwarder: $@";
549 588
550 goto &$urxvt::term::proxy::AUTOLOAD; 589 goto &$urxvt::term::proxy::AUTOLOAD;
551} 590}
552 591
592sub urxvt::term::proxy::DESTROY {
593 # nop
594}
595
596# urxvt::destroy_hook
597
553sub urxvt::destroy_hook::DESTROY { 598sub urxvt::destroy_hook::DESTROY {
554 ${$_[0]}->(); 599 ${$_[0]}->();
555} 600}
556 601
557sub urxvt::destroy_hook(&) { 602sub urxvt::destroy_hook(&) {
558 bless \shift, urxvt::destroy_hook:: 603 bless \shift, urxvt::destroy_hook::
559} 604}
560 605
606package urxvt::anyevent;
607
608=head2 The C<urxvt::anyevent> Class
609
610The sole purpose of this class is to deliver an interface to the
611C<AnyEvent> module - any module using it will work inside urxvt without
612further work. The only exception is that you cannot wait on condition
613variables, but non-blocking condvar use is ok. What this means is that you
614cannot use blocking APIs, but the non-blocking variant should work.
615
616=cut
617
618our $VERSION = 1;
619
620$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
621push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
622
623sub timer {
624 my ($class, %arg) = @_;
625
626 my $cb = $arg{cb};
627
628 urxvt::timer
629 ->new
630 ->start (urxvt::NOW + $arg{after})
631 ->cb (sub {
632 $_[0]->stop; # need to cancel manually
633 $cb->();
634 })
635}
636
637sub io {
638 my ($class, %arg) = @_;
639
640 my $cb = $arg{cb};
641
642 bless [$arg{fh}, urxvt::iow
643 ->new
644 ->fd (fileno $arg{fh})
645 ->events (($arg{poll} =~ /r/ ? 1 : 0)
646 | ($arg{poll} =~ /w/ ? 2 : 0))
647 ->start
648 ->cb (sub {
649 $cb->(($_[1] & 1 ? 'r' : '')
650 . ($_[1] & 2 ? 'w' : ''));
651 })],
652 urxvt::anyevent::
653}
654
655sub DESTROY {
656 $_[0][1]->stop;
657}
658
659sub condvar {
660 bless \my $flag, urxvt::anyevent::condvar::
661}
662
663sub urxvt::anyevent::condvar::broadcast {
664 ${$_[0]}++;
665}
666
667sub urxvt::anyevent::condvar::wait {
668 unless (${$_[0]}) {
669 require Carp;
670 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
671 }
672}
673
674package urxvt::term;
675
561=head2 The C<urxvt::term> Class 676=head2 The C<urxvt::term> Class
562 677
563=over 4 678=over 4
564 679
565=item $term->destroy 680=item $term->destroy
566 681
567Destroy the terminal object (close the window, free resources etc.). 682Destroy the terminal object (close the window, free resources etc.).
683
684=item $isset = $term->option ($optval[, $set])
685
686Returns true if the option specified by C<$optval> is enabled, and
687optionally change it. All option values are stored by name in the hash
688C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
689
690Here is a a likely non-exhaustive list of option names, please see the
691source file F</src/optinc.h> to see the actual list:
692
693 borderLess console cursorBlink cursorUnderline hold iconic insecure
694 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
695 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
696 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
697 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
698 tripleclickwords utmpInhibit visualBell
568 699
569=item $value = $term->resource ($name[, $newval]) 700=item $value = $term->resource ($name[, $newval])
570 701
571Returns the current resource value associated with a given name and 702Returns the current resource value associated with a given name and
572optionally sets a new value. Setting values is most useful in the C<init> 703optionally sets a new value. Setting values is most useful in the C<init>
582 713
583Please note that resource strings will currently only be freed when the 714Please note that resource strings will currently only be freed when the
584terminal is destroyed, so changing options frequently will eat memory. 715terminal is destroyed, so changing options frequently will eat memory.
585 716
586Here is a a likely non-exhaustive list of resource names, not all of which 717Here 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 718are supported in every build, please see the source file F</src/rsinc.h>
588list: 719to see the actual list:
589 720
590 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 721 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
591 borderLess color cursorBlink cursorUnderline cutchars delete_key 722 borderLess color cursorBlink cursorUnderline cutchars delete_key
592 display_name embed ext_bwidth fade font geometry hold iconName 723 display_name embed ext_bwidth fade font geometry hold iconName
593 imFont imLocale inputMethod insecure int_bwidth intensityStyles 724 imFont imLocale inputMethod insecure int_bwidth intensityStyles
600 shade term_name title transparent transparent_all tripleclickwords 731 shade term_name title transparent transparent_all tripleclickwords
601 utmpInhibit visualBell 732 utmpInhibit visualBell
602 733
603=cut 734=cut
604 735
605sub urxvt::term::resource($$;$) { 736sub resource($$;$) {
606 my ($self, $name) = (shift, shift); 737 my ($self, $name) = (shift, shift);
607 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 738 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
608 &urxvt::term::_resource 739 &urxvt::term::_resource
609} 740}
610 741
697C<$event> I<must> be the event causing the menu to pop up (a button event, 828C<$event> I<must> be the event causing the menu to pop up (a button event,
698currently). 829currently).
699 830
700=cut 831=cut
701 832
702sub urxvt::term::popup { 833sub popup {
703 my ($self, $event) = @_; 834 my ($self, $event) = @_;
704 835
705 $self->grab ($event->{time}, 1) 836 $self->grab ($event->{time}, 1)
706 or return; 837 or return;
707 838
785=item $nrow_plus_saveLines = $term->total_rows 916=item $nrow_plus_saveLines = $term->total_rows
786 917
787=item $lines_in_scrollback = $term->nsaved 918=item $lines_in_scrollback = $term->nsaved
788 919
789Return various integers describing terminal characteristics. 920Return various integers describing terminal characteristics.
921
922=item $lc_ctype = $term->locale
923
924Returns the LC_CTYPE category string used by this rxvt-unicode.
925
926=item $x_display = $term->display_id
927
928Return the DISPLAY used by rxvt-unicode.
790 929
791=item $modifiermask = $term->ModLevel3Mask 930=item $modifiermask = $term->ModLevel3Mask
792 931
793=item $modifiermask = $term->ModMetaMask 932=item $modifiermask = $term->ModMetaMask
794 933
897 1036
898=back 1037=back
899 1038
900=cut 1039=cut
901 1040
902sub urxvt::term::line { 1041sub line {
903 my ($self, $row) = @_; 1042 my ($self, $row) = @_;
904 1043
905 my $maxrow = $self->nrow - 1; 1044 my $maxrow = $self->nrow - 1;
906 1045
907 my ($beg, $end) = ($row, $row); 1046 my ($beg, $end) = ($row, $row);
971 $offset / $self->{ncol} + $self->{beg}, 1110 $offset / $self->{ncol} + $self->{beg},
972 $offset % $self->{ncol} 1111 $offset % $self->{ncol}
973 ) 1112 )
974} 1113}
975 1114
976=item ($row, $col) = $line->coord_of ($offset)
977=item $text = $term->special_encode $string 1115=item $text = $term->special_encode $string
978 1116
979Converts a perl string into the special encoding used by rxvt-unicode, 1117Converts a perl string into the special encoding used by rxvt-unicode,
980where one character corresponds to one screen cell. See 1118where one character corresponds to one screen cell. See
981C<< $term->ROW_t >> for details. 1119C<< $term->ROW_t >> for details.
983=item $string = $term->special_decode $text 1121=item $string = $term->special_decode $text
984 1122
985Converts rxvt-unicodes text reprsentation into a perl string. See 1123Converts rxvt-unicodes text reprsentation into a perl string. See
986C<< $term->ROW_t >> for details. 1124C<< $term->ROW_t >> for details.
987 1125
1126=item $success = $term->grab_button ($button, $modifiermask)
1127
1128Registers a synchronous button grab. See the XGrabButton manpage.
1129
1130=item $success = $term->grab ($eventtime[, $sync])
1131
1132Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1133synchronous (C<$sync> is true). Also remembers the grab timestampe.
1134
1135=item $term->allow_events_async
1136
1137Calls XAllowEvents with AsyncBoth for the most recent grab.
1138
1139=item $term->allow_events_sync
1140
1141Calls XAllowEvents with SyncBoth for the most recent grab.
1142
1143=item $term->allow_events_replay
1144
1145Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1146recent grab.
1147
1148=item $term->ungrab
1149
1150Calls XUngrab for the most recent grab. Is called automatically on
1151evaluation errors, as it is better to lose the grab in the error case as
1152the session.
1153
988=back 1154=back
989 1155
1156=cut
1157
1158package urxvt::popup;
1159
990=head2 The C<urxvt::popup> Class 1160=head2 The C<urxvt::popup> Class
991 1161
992=over 4 1162=over 4
993 1163
994=cut 1164=cut
995
996package urxvt::popup;
997 1165
998sub add_item { 1166sub add_item {
999 my ($self, $item) = @_; 1167 my ($self, $item) = @_;
1000 1168
1169 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1170 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1171 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1172
1173 $item->{render} ||= sub { $_[0]{text} };
1174
1001 push @{ $self->{item} }, $item; 1175 push @{ $self->{item} }, $item;
1176}
1177
1178sub add_separator {
1179 my ($self, $sep) = @_;
1180
1181 $sep ||= "=";
1182
1183 $self->add_item ({
1184 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1185 text => "",
1186 render => sub { $sep x $self->{term}->ncol },
1187 activate => sub { },
1188 });
1189}
1190
1191sub add_title {
1192 my ($self, $title) = @_;
1193
1194 $self->add_item ({
1195 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1196 text => $title,
1197 activate => sub { },
1198 });
1002} 1199}
1003 1200
1004sub add_button { 1201sub add_button {
1005 my ($self, $text, $cb) = @_; 1202 my ($self, $text, $cb) = @_;
1006 1203
1007 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, 1204 $self->add_item ({ type => "button", text => $text, activate => $cb});
1008 render => sub { $_[0]{text} },
1009 });
1010} 1205}
1011 1206
1012sub add_toggle { 1207sub add_toggle {
1013 my ($self, $text, $cb, $value) = @_; 1208 my ($self, $text, $cb, $value) = @_;
1014 1209
1015 $self->add_item ({ type => "button", text => " $text", value => $value, 1210 my $item; $item = {
1211 type => "button",
1212 text => " $text",
1213 value => $value,
1016 render => sub { ($_[0]{value} ? "" : " ") . substr $_[0]{text}, 1 }, 1214 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1017 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1215 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1018 }); 1216 };
1217
1218 $self->add_item ($item);
1019} 1219}
1020 1220
1021sub show { 1221sub show {
1022 my ($self) = @_; 1222 my ($self) = @_;
1023 1223
1024 local $urxvt::popup::self = $self; 1224 local $urxvt::popup::self = $self;
1025 1225
1226 local $ENV{LC_ALL} = $self->{term}->locale;
1227
1026 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1228 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1027 "--transient-for" => $self->{term}->parent, 1229 "--transient-for" => $self->{term}->parent,
1230 "-display" => $self->{term}->display_id,
1028 "-pe" => "urxvt-popup") 1231 "-pe" => "urxvt-popup")
1029 or die "unable to create popup window\n"; 1232 or die "unable to create popup window\n";
1030} 1233}
1031 1234
1032sub DESTROY { 1235sub DESTROY {
1033 my ($self) = @_; 1236 my ($self) = @_;
1034 1237
1238 delete $self->{term}{_destroy}{$self};
1035 $self->{term}->ungrab; 1239 $self->{term}->ungrab;
1036} 1240}
1037 1241
1038=head2 The C<urxvt::timer> Class 1242=head2 The C<urxvt::timer> Class
1039 1243
1143This variable controls the verbosity level of the perl extension. Higher 1347This variable controls the verbosity level of the perl extension. Higher
1144numbers indicate more verbose output. 1348numbers indicate more verbose output.
1145 1349
1146=over 4 1350=over 4
1147 1351
1148=item =0 - only fatal messages 1352=item == 0 - fatal messages
1149 1353
1150=item =3 - script loading and management 1354=item >= 3 - script loading and management
1151 1355
1152=item =10 - all events received 1356=item >=10 - all events received
1153 1357
1154=back 1358=back
1155 1359
1156=head1 AUTHOR 1360=head1 AUTHOR
1157 1361

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines