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.46 by root, Sat Jan 7 20:29:28 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
331 341
332=item $time = urxvt::NOW 342=item $time = urxvt::NOW
333 343
334Returns the "current time" (as per the event loop). 344Returns the "current time" (as per the event loop).
335 345
346=item urxvt::CurrentTime
347
348=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
349Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
350Button4Mask, Button5Mask, AnyModifier
351
352Various constants for use in X calls and event processing.
353
336=back 354=back
337 355
338=head2 RENDITION 356=head2 RENDITION
339 357
340Rendition bitsets contain information about colour, font, font styles and 358Rendition bitsets contain information about colour, font, font styles and
389 407
390=cut 408=cut
391 409
392package urxvt; 410package urxvt;
393 411
412use utf8;
394use strict; 413use strict;
395use Scalar::Util (); 414use Scalar::Util ();
415use List::Util ();
396 416
417our $VERSION = 1;
397our $TERM; 418our $TERM;
398our @HOOKNAME; 419our @HOOKNAME;
420our %OPTION;
399our $LIBDIR; 421our $LIBDIR;
400 422
401BEGIN { 423BEGIN {
402 urxvt->bootstrap; 424 urxvt->bootstrap;
403 425
406 my $msg = join "", @_; 428 my $msg = join "", @_;
407 $msg .= "\n" 429 $msg .= "\n"
408 unless $msg =~ /\n$/; 430 unless $msg =~ /\n$/;
409 urxvt::warn ($msg); 431 urxvt::warn ($msg);
410 }; 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};
411} 436}
412 437
413my @hook_count; 438my @hook_count;
414my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 439my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
415 440
448 verbose 3, "loading extension '$path' into package '$pkg'"; 473 verbose 3, "loading extension '$path' into package '$pkg'";
449 474
450 open my $fh, "<:raw", $path 475 open my $fh, "<:raw", $path
451 or die "$path: $!"; 476 or die "$path: $!";
452 477
453 my $source = "package $pkg; use strict; use utf8;\n" 478 my $source = untaint "package $pkg; use strict; use utf8;\n"
454 . "use base urxvt::term::proxy::;\n" 479 . "use base urxvt::term::proxy::;\n"
455 . "#line 1 \"$path\"\n{\n" 480 . "#line 1 \"$path\"\n{\n"
456 . (do { local $/; <$fh> }) 481 . (do { local $/; <$fh> })
457 . "\n};\n1"; 482 . "\n};\n1";
458 483
469 local $TERM = shift; 494 local $TERM = shift;
470 my $htype = shift; 495 my $htype = shift;
471 496
472 if ($htype == 0) { # INIT 497 if ($htype == 0) { # INIT
473 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 498 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499
500 my %want_ext;
474 501
475 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) {
476 my @files = grep -f $_, map "$_/$ext", @dirs; 513 my @files = grep -f $_, map "$_/$ext", @dirs;
477 514
478 if (@files) { 515 if (@files) {
479 register_package extension_package $files[0]; 516 register_package extension_package $files[0];
480 } else { 517 } else {
481 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";
482 } 519 }
483 } 520 }
521
522 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
523 warn $@ if $@;
484 } 524 }
485 525
486 $retval = undef; 526 $retval = undef;
487 527
488 if (my $cb = $TERM->{_hook}[$htype]) { 528 if (my $cb = $TERM->{_hook}[$htype]) {
500 $proxy 540 $proxy
501 }, 541 },
502 @_, 542 @_,
503 ) and last; 543 ) and last;
504 }; 544 };
505 warn $@ if $@;#d# 545 if ($@) {
546 $TERM->ungrab; # better to lose the grab than the session
547 warn $@;
548 }
506 } 549 }
507 } 550 }
508 551
509 if ($htype == 1) { # DESTROY 552 if ($htype == 1) { # DESTROY
510 # remove hooks if unused 553 # remove hooks if unused
523 } 566 }
524 567
525 $retval 568 $retval
526} 569}
527 570
571# urxvt::term::proxy
572
528sub urxvt::term::proxy::AUTOLOAD { 573sub urxvt::term::proxy::AUTOLOAD {
529 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 574 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
530 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 575 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
531 576
532 eval qq{ 577 eval qq{
538 } or die "FATAL: unable to compile method forwarder: $@"; 583 } or die "FATAL: unable to compile method forwarder: $@";
539 584
540 goto &$urxvt::term::proxy::AUTOLOAD; 585 goto &$urxvt::term::proxy::AUTOLOAD;
541} 586}
542 587
588sub urxvt::term::proxy::DESTROY {
589 # nop
590}
591
592# urxvt::destroy_hook
593
543sub urxvt::destroy_hook::DESTROY { 594sub urxvt::destroy_hook::DESTROY {
544 ${$_[0]}->(); 595 ${$_[0]}->();
545} 596}
546 597
547sub urxvt::destroy_hook(&) { 598sub urxvt::destroy_hook(&) {
548 bless \shift, urxvt::destroy_hook:: 599 bless \shift, urxvt::destroy_hook::
549} 600}
550 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
551=head2 The C<urxvt::term> Class 672=head2 The C<urxvt::term> Class
552 673
553=over 4 674=over 4
554 675
555=item $term->destroy 676=item $term->destroy
556 677
557Destroy 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
558 695
559=item $value = $term->resource ($name[, $newval]) 696=item $value = $term->resource ($name[, $newval])
560 697
561Returns the current resource value associated with a given name and 698Returns the current resource value associated with a given name and
562optionally 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>
572 709
573Please note that resource strings will currently only be freed when the 710Please note that resource strings will currently only be freed when the
574terminal is destroyed, so changing options frequently will eat memory. 711terminal is destroyed, so changing options frequently will eat memory.
575 712
576Here 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
577are 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>
578list: 715to see the actual list:
579 716
580 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 717 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
581 borderLess color cursorBlink cursorUnderline cutchars delete_key 718 borderLess color cursorBlink cursorUnderline cutchars delete_key
582 display_name embed ext_bwidth fade font geometry hold iconName 719 display_name embed ext_bwidth fade font geometry hold iconName
583 imFont imLocale inputMethod insecure int_bwidth intensityStyles 720 imFont imLocale inputMethod insecure int_bwidth intensityStyles
590 shade term_name title transparent transparent_all tripleclickwords 727 shade term_name title transparent transparent_all tripleclickwords
591 utmpInhibit visualBell 728 utmpInhibit visualBell
592 729
593=cut 730=cut
594 731
595sub urxvt::term::resource($$;$) { 732sub resource($$;$) {
596 my ($self, $name) = (shift, shift); 733 my ($self, $name) = (shift, shift);
597 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 734 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
598 &urxvt::term::_resource 735 &urxvt::term::_resource
599} 736}
600 737
687C<$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,
688currently). 825currently).
689 826
690=cut 827=cut
691 828
692sub urxvt::term::popup { 829sub popup {
693 my ($self, $event) = @_; 830 my ($self, $event) = @_;
694 831
695 $self->grab ($event->{time}, 1) 832 $self->grab ($event->{time}, 1)
696 or return; 833 or return;
697 834
775=item $nrow_plus_saveLines = $term->total_rows 912=item $nrow_plus_saveLines = $term->total_rows
776 913
777=item $lines_in_scrollback = $term->nsaved 914=item $lines_in_scrollback = $term->nsaved
778 915
779Return various integers describing terminal characteristics. 916Return various integers describing terminal characteristics.
917
918=item $modifiermask = $term->ModLevel3Mask
919
920=item $modifiermask = $term->ModMetaMask
921
922=item $modifiermask = $term->ModNumLockMask
923
924Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
925AltGr), the meta key (often Alt) and the num lock key, if applicable.
780 926
781=item $view_start = $term->view_start ([$newvalue]) 927=item $view_start = $term->view_start ([$newvalue])
782 928
783Returns the negative row number of the topmost line. Minimum value is 929Returns the negative row number of the topmost line. Minimum value is
784C<0>, which displays the normal terminal contents. Larger values scroll 930C<0>, which displays the normal terminal contents. Larger values scroll
878 1024
879=back 1025=back
880 1026
881=cut 1027=cut
882 1028
883sub urxvt::term::line { 1029sub line {
884 my ($self, $row) = @_; 1030 my ($self, $row) = @_;
885 1031
886 my $maxrow = $self->nrow - 1; 1032 my $maxrow = $self->nrow - 1;
887 1033
888 my ($beg, $end) = ($row, $row); 1034 my ($beg, $end) = ($row, $row);
966Converts rxvt-unicodes text reprsentation into a perl string. See 1112Converts rxvt-unicodes text reprsentation into a perl string. See
967C<< $term->ROW_t >> for details. 1113C<< $term->ROW_t >> for details.
968 1114
969=back 1115=back
970 1116
1117=cut
1118
1119package urxvt::popup;
1120
971=head2 The C<urxvt::popup> Class 1121=head2 The C<urxvt::popup> Class
972 1122
973=over 4 1123=over 4
974 1124
975=cut 1125=cut
976
977package urxvt::popup;
978 1126
979sub add_item { 1127sub add_item {
980 my ($self, $item) = @_; 1128 my ($self, $item) = @_;
981 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
982 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 });
983} 1160}
984 1161
985sub add_button { 1162sub add_button {
986 my ($self, $text, $cb) = @_; 1163 my ($self, $text, $cb) = @_;
987 1164
988 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); 1165 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1166}
1167
1168sub add_toggle {
1169 my ($self, $text, $cb, $value) = @_;
1170
1171 my $item; $item = {
1172 type => "button",
1173 text => " $text",
1174 value => $value,
1175 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1176 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1177 };
1178
1179 $self->add_item ($item);
989} 1180}
990 1181
991sub show { 1182sub show {
992 my ($self) = @_; 1183 my ($self) = @_;
993 1184
1000} 1191}
1001 1192
1002sub DESTROY { 1193sub DESTROY {
1003 my ($self) = @_; 1194 my ($self) = @_;
1004 1195
1196 delete $self->{term}{_destroy}{$self};
1005 $self->{term}->ungrab; 1197 $self->{term}->ungrab;
1006} 1198}
1007 1199
1008=head2 The C<urxvt::timer> Class 1200=head2 The C<urxvt::timer> Class
1009 1201
1113This variable controls the verbosity level of the perl extension. Higher 1305This variable controls the verbosity level of the perl extension. Higher
1114numbers indicate more verbose output. 1306numbers indicate more verbose output.
1115 1307
1116=over 4 1308=over 4
1117 1309
1118=item =0 - only fatal messages 1310=item == 0 - fatal messages
1119 1311
1120=item =3 - script loading and management 1312=item >= 3 - script loading and management
1121 1313
1122=item =10 - all events received 1314=item >=10 - all events received
1123 1315
1124=back 1316=back
1125 1317
1126=head1 AUTHOR 1318=head1 AUTHOR
1127 1319

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines