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.65 by root, Mon Jan 9 19:25:57 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
397 409
398=cut 410=cut
399 411
400package urxvt; 412package urxvt;
401 413
414use utf8;
402use strict; 415use strict;
403use Scalar::Util (); 416use Scalar::Util ();
417use List::Util ();
404 418
419our $VERSION = 1;
405our $TERM; 420our $TERM;
406our @HOOKNAME; 421our @HOOKNAME;
422our %OPTION;
407our $LIBDIR; 423our $LIBDIR;
408 424
409BEGIN { 425BEGIN {
410 urxvt->bootstrap; 426 urxvt->bootstrap;
411 427
414 my $msg = join "", @_; 430 my $msg = join "", @_;
415 $msg .= "\n" 431 $msg .= "\n"
416 unless $msg =~ /\n$/; 432 unless $msg =~ /\n$/;
417 urxvt::warn ($msg); 433 urxvt::warn ($msg);
418 }; 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";
419} 440}
420 441
421my @hook_count; 442my @hook_count;
422my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 443my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
423 444
456 verbose 3, "loading extension '$path' into package '$pkg'"; 477 verbose 3, "loading extension '$path' into package '$pkg'";
457 478
458 open my $fh, "<:raw", $path 479 open my $fh, "<:raw", $path
459 or die "$path: $!"; 480 or die "$path: $!";
460 481
461 my $source = "package $pkg; use strict; use utf8;\n" 482 my $source = untaint "package $pkg; use strict; use utf8;\n"
462 . "use base urxvt::term::proxy::;\n" 483 . "use base urxvt::term::proxy::;\n"
463 . "#line 1 \"$path\"\n{\n" 484 . "#line 1 \"$path\"\n{\n"
464 . (do { local $/; <$fh> }) 485 . (do { local $/; <$fh> })
465 . "\n};\n1"; 486 . "\n};\n1";
466 487
477 local $TERM = shift; 498 local $TERM = shift;
478 my $htype = shift; 499 my $htype = shift;
479 500
480 if ($htype == 0) { # INIT 501 if ($htype == 0) { # INIT
481 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 502 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503
504 my %want_ext;
482 505
483 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) {
484 my @files = grep -f $_, map "$_/$ext", @dirs; 517 my @files = grep -f $_, map "$_/$ext", @dirs;
485 518
486 if (@files) { 519 if (@files) {
487 register_package extension_package $files[0]; 520 register_package extension_package $files[0];
488 } else { 521 } else {
489 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";
490 } 523 }
491 } 524 }
525
526 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
527 warn $@ if $@;
492 } 528 }
493 529
494 $retval = undef; 530 $retval = undef;
495 531
496 if (my $cb = $TERM->{_hook}[$htype]) { 532 if (my $cb = $TERM->{_hook}[$htype]) {
508 $proxy 544 $proxy
509 }, 545 },
510 @_, 546 @_,
511 ) and last; 547 ) and last;
512 }; 548 };
513 warn $@ if $@;#d# 549 if ($@) {
550 $TERM->ungrab; # better to lose the grab than the session
551 warn $@;
552 }
514 } 553 }
515 } 554 }
516 555
517 if ($htype == 1) { # DESTROY 556 if ($htype == 1) { # DESTROY
518 # remove hooks if unused 557 # remove hooks if unused
531 } 570 }
532 571
533 $retval 572 $retval
534} 573}
535 574
575# urxvt::term::proxy
576
536sub urxvt::term::proxy::AUTOLOAD { 577sub urxvt::term::proxy::AUTOLOAD {
537 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 578 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
538 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 579 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
539 580
540 eval qq{ 581 eval qq{
546 } or die "FATAL: unable to compile method forwarder: $@"; 587 } or die "FATAL: unable to compile method forwarder: $@";
547 588
548 goto &$urxvt::term::proxy::AUTOLOAD; 589 goto &$urxvt::term::proxy::AUTOLOAD;
549} 590}
550 591
592sub urxvt::term::proxy::DESTROY {
593 # nop
594}
595
596# urxvt::destroy_hook
597
551sub urxvt::destroy_hook::DESTROY { 598sub urxvt::destroy_hook::DESTROY {
552 ${$_[0]}->(); 599 ${$_[0]}->();
553} 600}
554 601
555sub urxvt::destroy_hook(&) { 602sub urxvt::destroy_hook(&) {
556 bless \shift, urxvt::destroy_hook:: 603 bless \shift, urxvt::destroy_hook::
557} 604}
558 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
559=head2 The C<urxvt::term> Class 676=head2 The C<urxvt::term> Class
560 677
561=over 4 678=over 4
562 679
563=item $term->destroy 680=item $term->destroy
564 681
565Destroy 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
566 699
567=item $value = $term->resource ($name[, $newval]) 700=item $value = $term->resource ($name[, $newval])
568 701
569Returns the current resource value associated with a given name and 702Returns the current resource value associated with a given name and
570optionally 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>
580 713
581Please note that resource strings will currently only be freed when the 714Please note that resource strings will currently only be freed when the
582terminal is destroyed, so changing options frequently will eat memory. 715terminal is destroyed, so changing options frequently will eat memory.
583 716
584Here 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
585are 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>
586list: 719to see the actual list:
587 720
588 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 721 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
589 borderLess color cursorBlink cursorUnderline cutchars delete_key 722 borderLess color cursorBlink cursorUnderline cutchars delete_key
590 display_name embed ext_bwidth fade font geometry hold iconName 723 display_name embed ext_bwidth fade font geometry hold iconName
591 imFont imLocale inputMethod insecure int_bwidth intensityStyles 724 imFont imLocale inputMethod insecure int_bwidth intensityStyles
598 shade term_name title transparent transparent_all tripleclickwords 731 shade term_name title transparent transparent_all tripleclickwords
599 utmpInhibit visualBell 732 utmpInhibit visualBell
600 733
601=cut 734=cut
602 735
603sub urxvt::term::resource($$;$) { 736sub resource($$;$) {
604 my ($self, $name) = (shift, shift); 737 my ($self, $name) = (shift, shift);
605 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 738 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
606 &urxvt::term::_resource 739 &urxvt::term::_resource
607} 740}
608 741
695C<$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,
696currently). 829currently).
697 830
698=cut 831=cut
699 832
700sub urxvt::term::popup { 833sub popup {
701 my ($self, $event) = @_; 834 my ($self, $event) = @_;
702 835
703 $self->grab ($event->{time}, 1) 836 $self->grab ($event->{time}, 1)
704 or return; 837 or return;
705 838
895 1028
896=back 1029=back
897 1030
898=cut 1031=cut
899 1032
900sub urxvt::term::line { 1033sub line {
901 my ($self, $row) = @_; 1034 my ($self, $row) = @_;
902 1035
903 my $maxrow = $self->nrow - 1; 1036 my $maxrow = $self->nrow - 1;
904 1037
905 my ($beg, $end) = ($row, $row); 1038 my ($beg, $end) = ($row, $row);
969 $offset / $self->{ncol} + $self->{beg}, 1102 $offset / $self->{ncol} + $self->{beg},
970 $offset % $self->{ncol} 1103 $offset % $self->{ncol}
971 ) 1104 )
972} 1105}
973 1106
974=item ($row, $col) = $line->coord_of ($offset)
975=item $text = $term->special_encode $string 1107=item $text = $term->special_encode $string
976 1108
977Converts a perl string into the special encoding used by rxvt-unicode, 1109Converts a perl string into the special encoding used by rxvt-unicode,
978where one character corresponds to one screen cell. See 1110where one character corresponds to one screen cell. See
979C<< $term->ROW_t >> for details. 1111C<< $term->ROW_t >> for details.
981=item $string = $term->special_decode $text 1113=item $string = $term->special_decode $text
982 1114
983Converts rxvt-unicodes text reprsentation into a perl string. See 1115Converts rxvt-unicodes text reprsentation into a perl string. See
984C<< $term->ROW_t >> for details. 1116C<< $term->ROW_t >> for details.
985 1117
1118=item $success = $term->grab_button ($button, $modifiermask)
1119
1120Registers a synchronous button grab. See the XGrabButton manpage.
1121
1122=item $success = $term->grab ($eventtime[, $sync])
1123
1124Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1125synchronous (C<$sync> is true). Also remembers the grab timestampe.
1126
1127=item $term->allow_events_async
1128
1129Calls XAllowEvents with AsyncBoth for the most recent grab.
1130
1131=item $term->allow_events_sync
1132
1133Calls XAllowEvents with SyncBoth for the most recent grab.
1134
1135=item $term->allow_events_replay
1136
1137Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1138recent grab.
1139
1140=item $term->ungrab
1141
1142Calls XUngrab for the most recent grab. Is called automatically on
1143evaluation errors, as it is better to lose the grab in the error case as
1144the session.
1145
986=back 1146=back
987 1147
1148=cut
1149
1150package urxvt::popup;
1151
988=head2 The C<urxvt::popup> Class 1152=head2 The C<urxvt::popup> Class
989 1153
990=over 4 1154=over 4
991 1155
992=cut 1156=cut
993
994package urxvt::popup;
995 1157
996sub add_item { 1158sub add_item {
997 my ($self, $item) = @_; 1159 my ($self, $item) = @_;
998 1160
1161 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1162 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1163 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1164
1165 $item->{render} ||= sub { $_[0]{text} };
1166
999 push @{ $self->{item} }, $item; 1167 push @{ $self->{item} }, $item;
1168}
1169
1170sub add_separator {
1171 my ($self, $sep) = @_;
1172
1173 $sep ||= "═";
1174
1175 $self->add_item ({
1176 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177 text => "",
1178 render => sub { $sep x $self->{term}->ncol },
1179 activate => sub { },
1180 });
1181}
1182
1183sub add_title {
1184 my ($self, $title) = @_;
1185
1186 $self->add_item ({
1187 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1188 text => $title,
1189 activate => sub { },
1190 });
1000} 1191}
1001 1192
1002sub add_button { 1193sub add_button {
1003 my ($self, $text, $cb) = @_; 1194 my ($self, $text, $cb) = @_;
1004 1195
1005 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); 1196 $self->add_item ({ type => "button", text => $text, activate => $cb});
1197}
1198
1199sub add_toggle {
1200 my ($self, $text, $cb, $value) = @_;
1201
1202 my $item; $item = {
1203 type => "button",
1204 text => " $text",
1205 value => $value,
1206 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1208 };
1209
1210 $self->add_item ($item);
1006} 1211}
1007 1212
1008sub show { 1213sub show {
1009 my ($self) = @_; 1214 my ($self) = @_;
1010 1215
1011 local $urxvt::popup::self = $self; 1216 local $urxvt::popup::self = $self;
1012 1217
1218 local $ENV{LC_ALL} = $self->{term}->locale;
1219
1013 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1220 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1014 "--transient-for" => $self->{term}->parent, 1221 "--transient-for" => $self->{term}->parent,
1222 "-display" => $self->{term}->display_id,
1015 "-pe" => "urxvt-popup") 1223 "-pe" => "urxvt-popup")
1016 or die "unable to create popup window\n"; 1224 or die "unable to create popup window\n";
1017} 1225}
1018 1226
1019sub DESTROY { 1227sub DESTROY {
1020 my ($self) = @_; 1228 my ($self) = @_;
1021 1229
1230 delete $self->{term}{_destroy}{$self};
1022 $self->{term}->ungrab; 1231 $self->{term}->ungrab;
1023} 1232}
1024 1233
1025=head2 The C<urxvt::timer> Class 1234=head2 The C<urxvt::timer> Class
1026 1235
1130This variable controls the verbosity level of the perl extension. Higher 1339This variable controls the verbosity level of the perl extension. Higher
1131numbers indicate more verbose output. 1340numbers indicate more verbose output.
1132 1341
1133=over 4 1342=over 4
1134 1343
1135=item =0 - only fatal messages 1344=item == 0 - fatal messages
1136 1345
1137=item =3 - script loading and management 1346=item >= 3 - script loading and management
1138 1347
1139=item =10 - all events received 1348=item >=10 - all events received
1140 1349
1141=back 1350=back
1142 1351
1143=head1 AUTHOR 1352=head1 AUTHOR
1144 1353

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines