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.60 by root, Mon Jan 9 01:21:43 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 delete $ENV{IFS};
435 delete $ENV{CDPATH};
436 delete $ENV{BASH_ENV};
437 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
411} 438}
412 439
413my @hook_count; 440my @hook_count;
414my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 441my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
415 442
448 verbose 3, "loading extension '$path' into package '$pkg'"; 475 verbose 3, "loading extension '$path' into package '$pkg'";
449 476
450 open my $fh, "<:raw", $path 477 open my $fh, "<:raw", $path
451 or die "$path: $!"; 478 or die "$path: $!";
452 479
453 my $source = "package $pkg; use strict; use utf8;\n" 480 my $source = untaint "package $pkg; use strict; use utf8;\n"
454 . "use base urxvt::term::proxy::;\n" 481 . "use base urxvt::term::proxy::;\n"
455 . "#line 1 \"$path\"\n{\n" 482 . "#line 1 \"$path\"\n{\n"
456 . (do { local $/; <$fh> }) 483 . (do { local $/; <$fh> })
457 . "\n};\n1"; 484 . "\n};\n1";
458 485
469 local $TERM = shift; 496 local $TERM = shift;
470 my $htype = shift; 497 my $htype = shift;
471 498
472 if ($htype == 0) { # INIT 499 if ($htype == 0) { # INIT
473 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 500 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
501
502 my %want_ext;
474 503
475 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 504 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
505 if ($_ eq "default") {
506 $want_ext{$_}++ for qw(selection option-popup selection-popup);
507 } elsif (/^-(.*)$/) {
508 delete $want_ext{$1};
509 } else {
510 $want_ext{$_}++;
511 }
512 }
513
514 for my $ext (keys %want_ext) {
476 my @files = grep -f $_, map "$_/$ext", @dirs; 515 my @files = grep -f $_, map "$_/$ext", @dirs;
477 516
478 if (@files) { 517 if (@files) {
479 register_package extension_package $files[0]; 518 register_package extension_package $files[0];
480 } else { 519 } else {
481 warn "perl extension '$ext' not found in perl library search path\n"; 520 warn "perl extension '$ext' not found in perl library search path\n";
482 } 521 }
483 } 522 }
523
524 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
525 warn $@ if $@;
484 } 526 }
485 527
486 $retval = undef; 528 $retval = undef;
487 529
488 if (my $cb = $TERM->{_hook}[$htype]) { 530 if (my $cb = $TERM->{_hook}[$htype]) {
500 $proxy 542 $proxy
501 }, 543 },
502 @_, 544 @_,
503 ) and last; 545 ) and last;
504 }; 546 };
505 warn $@ if $@;#d# 547 if ($@) {
548 $TERM->ungrab; # better to lose the grab than the session
549 warn $@;
550 }
506 } 551 }
507 } 552 }
508 553
509 if ($htype == 1) { # DESTROY 554 if ($htype == 1) { # DESTROY
510 # remove hooks if unused 555 # remove hooks if unused
523 } 568 }
524 569
525 $retval 570 $retval
526} 571}
527 572
573# urxvt::term::proxy
574
528sub urxvt::term::proxy::AUTOLOAD { 575sub urxvt::term::proxy::AUTOLOAD {
529 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 576 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
530 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 577 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
531 578
532 eval qq{ 579 eval qq{
538 } or die "FATAL: unable to compile method forwarder: $@"; 585 } or die "FATAL: unable to compile method forwarder: $@";
539 586
540 goto &$urxvt::term::proxy::AUTOLOAD; 587 goto &$urxvt::term::proxy::AUTOLOAD;
541} 588}
542 589
590sub urxvt::term::proxy::DESTROY {
591 # nop
592}
593
594# urxvt::destroy_hook
595
543sub urxvt::destroy_hook::DESTROY { 596sub urxvt::destroy_hook::DESTROY {
544 ${$_[0]}->(); 597 ${$_[0]}->();
545} 598}
546 599
547sub urxvt::destroy_hook(&) { 600sub urxvt::destroy_hook(&) {
548 bless \shift, urxvt::destroy_hook:: 601 bless \shift, urxvt::destroy_hook::
549} 602}
550 603
604package urxvt::anyevent;
605
606=head2 The C<urxvt::anyevent> Class
607
608The sole purpose of this class is to deliver an interface to the
609C<AnyEvent> module - any module using it will work inside urxvt without
610further work. The only exception is that you cannot wait on condition
611variables, but non-blocking condvar use is ok. What this means is that you
612cannot use blocking APIs, but the non-blocking variant should work.
613
614=cut
615
616our $VERSION = 1;
617
618$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
619push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
620
621sub timer {
622 my ($class, %arg) = @_;
623
624 my $cb = $arg{cb};
625
626 urxvt::timer
627 ->new
628 ->start (urxvt::NOW + $arg{after})
629 ->cb (sub {
630 $_[0]->stop; # need to cancel manually
631 $cb->();
632 })
633}
634
635sub io {
636 my ($class, %arg) = @_;
637
638 my $cb = $arg{cb};
639
640 bless [$arg{fh}, urxvt::iow
641 ->new
642 ->fd (fileno $arg{fh})
643 ->events (($arg{poll} =~ /r/ ? 1 : 0)
644 | ($arg{poll} =~ /w/ ? 2 : 0))
645 ->start
646 ->cb (sub {
647 $cb->(($_[1] & 1 ? 'r' : '')
648 . ($_[1] & 2 ? 'w' : ''));
649 })],
650 urxvt::anyevent::
651}
652
653sub DESTROY {
654 $_[0][1]->stop;
655}
656
657sub condvar {
658 bless \my $flag, urxvt::anyevent::condvar::
659}
660
661sub urxvt::anyevent::condvar::broadcast {
662 ${$_[0]}++;
663}
664
665sub urxvt::anyevent::condvar::wait {
666 unless (${$_[0]}) {
667 require Carp;
668 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
669 }
670}
671
672package urxvt::term;
673
551=head2 The C<urxvt::term> Class 674=head2 The C<urxvt::term> Class
552 675
553=over 4 676=over 4
554 677
555=item $term->destroy 678=item $term->destroy
556 679
557Destroy the terminal object (close the window, free resources etc.). 680Destroy the terminal object (close the window, free resources etc.).
681
682=item $isset = $term->option ($optval[, $set])
683
684Returns true if the option specified by C<$optval> is enabled, and
685optionally change it. All option values are stored by name in the hash
686C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
687
688Here is a a likely non-exhaustive list of option names, please see the
689source file F</src/optinc.h> to see the actual list:
690
691 borderLess console cursorBlink cursorUnderline hold iconic insecure
692 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
693 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
694 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
695 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
696 tripleclickwords utmpInhibit visualBell
558 697
559=item $value = $term->resource ($name[, $newval]) 698=item $value = $term->resource ($name[, $newval])
560 699
561Returns the current resource value associated with a given name and 700Returns the current resource value associated with a given name and
562optionally sets a new value. Setting values is most useful in the C<init> 701optionally sets a new value. Setting values is most useful in the C<init>
572 711
573Please note that resource strings will currently only be freed when the 712Please note that resource strings will currently only be freed when the
574terminal is destroyed, so changing options frequently will eat memory. 713terminal is destroyed, so changing options frequently will eat memory.
575 714
576Here is a a likely non-exhaustive list of resource names, not all of which 715Here 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 716are supported in every build, please see the source file F</src/rsinc.h>
578list: 717to see the actual list:
579 718
580 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 719 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
581 borderLess color cursorBlink cursorUnderline cutchars delete_key 720 borderLess color cursorBlink cursorUnderline cutchars delete_key
582 display_name embed ext_bwidth fade font geometry hold iconName 721 display_name embed ext_bwidth fade font geometry hold iconName
583 imFont imLocale inputMethod insecure int_bwidth intensityStyles 722 imFont imLocale inputMethod insecure int_bwidth intensityStyles
590 shade term_name title transparent transparent_all tripleclickwords 729 shade term_name title transparent transparent_all tripleclickwords
591 utmpInhibit visualBell 730 utmpInhibit visualBell
592 731
593=cut 732=cut
594 733
595sub urxvt::term::resource($$;$) { 734sub resource($$;$) {
596 my ($self, $name) = (shift, shift); 735 my ($self, $name) = (shift, shift);
597 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 736 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
598 &urxvt::term::_resource 737 &urxvt::term::_resource
599} 738}
600 739
687C<$event> I<must> be the event causing the menu to pop up (a button event, 826C<$event> I<must> be the event causing the menu to pop up (a button event,
688currently). 827currently).
689 828
690=cut 829=cut
691 830
692sub urxvt::term::popup { 831sub popup {
693 my ($self, $event) = @_; 832 my ($self, $event) = @_;
694 833
695 $self->grab ($event->{time}, 1) 834 $self->grab ($event->{time}, 1)
696 or return; 835 or return;
697 836
775=item $nrow_plus_saveLines = $term->total_rows 914=item $nrow_plus_saveLines = $term->total_rows
776 915
777=item $lines_in_scrollback = $term->nsaved 916=item $lines_in_scrollback = $term->nsaved
778 917
779Return various integers describing terminal characteristics. 918Return various integers describing terminal characteristics.
919
920=item $modifiermask = $term->ModLevel3Mask
921
922=item $modifiermask = $term->ModMetaMask
923
924=item $modifiermask = $term->ModNumLockMask
925
926Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
927AltGr), the meta key (often Alt) and the num lock key, if applicable.
780 928
781=item $view_start = $term->view_start ([$newvalue]) 929=item $view_start = $term->view_start ([$newvalue])
782 930
783Returns the negative row number of the topmost line. Minimum value is 931Returns the negative row number of the topmost line. Minimum value is
784C<0>, which displays the normal terminal contents. Larger values scroll 932C<0>, which displays the normal terminal contents. Larger values scroll
878 1026
879=back 1027=back
880 1028
881=cut 1029=cut
882 1030
883sub urxvt::term::line { 1031sub line {
884 my ($self, $row) = @_; 1032 my ($self, $row) = @_;
885 1033
886 my $maxrow = $self->nrow - 1; 1034 my $maxrow = $self->nrow - 1;
887 1035
888 my ($beg, $end) = ($row, $row); 1036 my ($beg, $end) = ($row, $row);
966Converts rxvt-unicodes text reprsentation into a perl string. See 1114Converts rxvt-unicodes text reprsentation into a perl string. See
967C<< $term->ROW_t >> for details. 1115C<< $term->ROW_t >> for details.
968 1116
969=back 1117=back
970 1118
1119=cut
1120
1121package urxvt::popup;
1122
971=head2 The C<urxvt::popup> Class 1123=head2 The C<urxvt::popup> Class
972 1124
973=over 4 1125=over 4
974 1126
975=cut 1127=cut
976
977package urxvt::popup;
978 1128
979sub add_item { 1129sub add_item {
980 my ($self, $item) = @_; 1130 my ($self, $item) = @_;
981 1131
1132 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1133 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1134 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1135
1136 $item->{render} ||= sub { $_[0]{text} };
1137
982 push @{ $self->{item} }, $item; 1138 push @{ $self->{item} }, $item;
1139}
1140
1141sub add_separator {
1142 my ($self, $sep) = @_;
1143
1144 $sep ||= "═";
1145
1146 $self->add_item ({
1147 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1148 text => "",
1149 render => sub { $sep x $urxvt::TERM->ncol },
1150 activate => sub { },
1151 });
1152}
1153
1154sub add_title {
1155 my ($self, $title) = @_;
1156
1157 $self->add_item ({
1158 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1159 text => $title,
1160 activate => sub { },
1161 });
983} 1162}
984 1163
985sub add_button { 1164sub add_button {
986 my ($self, $text, $cb) = @_; 1165 my ($self, $text, $cb) = @_;
987 1166
988 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); 1167 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1168}
1169
1170sub add_toggle {
1171 my ($self, $text, $cb, $value) = @_;
1172
1173 my $item; $item = {
1174 type => "button",
1175 text => " $text",
1176 value => $value,
1177 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1178 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1179 };
1180
1181 $self->add_item ($item);
989} 1182}
990 1183
991sub show { 1184sub show {
992 my ($self) = @_; 1185 my ($self) = @_;
993 1186
1000} 1193}
1001 1194
1002sub DESTROY { 1195sub DESTROY {
1003 my ($self) = @_; 1196 my ($self) = @_;
1004 1197
1198 delete $self->{term}{_destroy}{$self};
1005 $self->{term}->ungrab; 1199 $self->{term}->ungrab;
1006} 1200}
1007 1201
1008=head2 The C<urxvt::timer> Class 1202=head2 The C<urxvt::timer> Class
1009 1203
1113This variable controls the verbosity level of the perl extension. Higher 1307This variable controls the verbosity level of the perl extension. Higher
1114numbers indicate more verbose output. 1308numbers indicate more verbose output.
1115 1309
1116=over 4 1310=over 4
1117 1311
1118=item =0 - only fatal messages 1312=item == 0 - fatal messages
1119 1313
1120=item =3 - script loading and management 1314=item >= 3 - script loading and management
1121 1315
1122=item =10 - all events received 1316=item >=10 - all events received
1123 1317
1124=back 1318=back
1125 1319
1126=head1 AUTHOR 1320=head1 AUTHOR
1127 1321

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines