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.58 by root, Sun Jan 8 22:58:13 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-Button3 that lets you toggle (some) options at
64runtime.
60 65
61=item digital-clock 66=item digital-clock
62 67
63Displays a digital clock using the built-in overlay. 68Displays a digital clock using the built-in overlay.
64 69
331 336
332=item $time = urxvt::NOW 337=item $time = urxvt::NOW
333 338
334Returns the "current time" (as per the event loop). 339Returns the "current time" (as per the event loop).
335 340
341=item urxvt::CurrentTime
342
343=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345Button4Mask, Button5Mask, AnyModifier
346
347Various constants for use in X calls and event processing.
348
336=back 349=back
337 350
338=head2 RENDITION 351=head2 RENDITION
339 352
340Rendition bitsets contain information about colour, font, font styles and 353Rendition bitsets contain information about colour, font, font styles and
389 402
390=cut 403=cut
391 404
392package urxvt; 405package urxvt;
393 406
407use utf8;
394use strict; 408use strict;
395use Scalar::Util (); 409use Scalar::Util ();
410use List::Util ();
396 411
412our $VERSION = 1;
397our $TERM; 413our $TERM;
398our @HOOKNAME; 414our @HOOKNAME;
415our %OPTION;
399our $LIBDIR; 416our $LIBDIR;
400 417
401BEGIN { 418BEGIN {
402 urxvt->bootstrap; 419 urxvt->bootstrap;
403 420
454 . "use base urxvt::term::proxy::;\n" 471 . "use base urxvt::term::proxy::;\n"
455 . "#line 1 \"$path\"\n{\n" 472 . "#line 1 \"$path\"\n{\n"
456 . (do { local $/; <$fh> }) 473 . (do { local $/; <$fh> })
457 . "\n};\n1"; 474 . "\n};\n1";
458 475
476 $source =~ /(.*)/s and $source = $1; # untaint
477
459 eval $source or die "$path: $@"; 478 eval $source or die "$path: $@";
460 479
461 $pkg 480 $pkg
462 } 481 }
463} 482}
469 local $TERM = shift; 488 local $TERM = shift;
470 my $htype = shift; 489 my $htype = shift;
471 490
472 if ($htype == 0) { # INIT 491 if ($htype == 0) { # INIT
473 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 492 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
493
494 my %want_ext;
474 495
475 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 496 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
497 if ($_ eq "default") {
498 $want_ext{$_}++ for qw(selection option-popup);
499 } elsif (/^-(.*)$/) {
500 delete $want_ext{$1};
501 } else {
502 $want_ext{$_}++;
503 }
504 }
505
506 for my $ext (keys %want_ext) {
476 my @files = grep -f $_, map "$_/$ext", @dirs; 507 my @files = grep -f $_, map "$_/$ext", @dirs;
477 508
478 if (@files) { 509 if (@files) {
479 register_package extension_package $files[0]; 510 register_package extension_package $files[0];
480 } else { 511 } else {
481 warn "perl extension '$ext' not found in perl library search path\n"; 512 warn "perl extension '$ext' not found in perl library search path\n";
482 } 513 }
483 } 514 }
515
516 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
517 warn $@ if $@;
484 } 518 }
485 519
486 $retval = undef; 520 $retval = undef;
487 521
488 if (my $cb = $TERM->{_hook}[$htype]) { 522 if (my $cb = $TERM->{_hook}[$htype]) {
500 $proxy 534 $proxy
501 }, 535 },
502 @_, 536 @_,
503 ) and last; 537 ) and last;
504 }; 538 };
505 warn $@ if $@;#d# 539 if ($@) {
540 $TERM->ungrab; # better to lose the grab than the session
541 warn $@;
542 }
506 } 543 }
507 } 544 }
508 545
509 if ($htype == 1) { # DESTROY 546 if ($htype == 1) { # DESTROY
510 # remove hooks if unused 547 # remove hooks if unused
523 } 560 }
524 561
525 $retval 562 $retval
526} 563}
527 564
565# urxvt::term::proxy
566
528sub urxvt::term::proxy::AUTOLOAD { 567sub urxvt::term::proxy::AUTOLOAD {
529 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 568 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
530 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 569 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
531 570
532 eval qq{ 571 eval qq{
538 } or die "FATAL: unable to compile method forwarder: $@"; 577 } or die "FATAL: unable to compile method forwarder: $@";
539 578
540 goto &$urxvt::term::proxy::AUTOLOAD; 579 goto &$urxvt::term::proxy::AUTOLOAD;
541} 580}
542 581
582sub urxvt::term::proxy::DESTROY {
583 # nop
584}
585
586# urxvt::destroy_hook
587
543sub urxvt::destroy_hook::DESTROY { 588sub urxvt::destroy_hook::DESTROY {
544 ${$_[0]}->(); 589 ${$_[0]}->();
545} 590}
546 591
547sub urxvt::destroy_hook(&) { 592sub urxvt::destroy_hook(&) {
548 bless \shift, urxvt::destroy_hook:: 593 bless \shift, urxvt::destroy_hook::
549} 594}
550 595
596package urxvt::anyevent;
597
598=head2 The C<urxvt::anyevent> Class
599
600The sole purpose of this class is to deliver an interface to the
601C<AnyEvent> module - any module using it will work inside urxvt without
602further work. The only exception is that you cannot wait on condition
603variables, but non-blocking condvar use is ok. What this means is that you
604cannot use blocking APIs, but the non-blocking variant should work.
605
606=cut
607
608our $VERSION = 1;
609
610$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
611push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
612
613sub timer {
614 my ($class, %arg) = @_;
615
616 my $cb = $arg{cb};
617
618 urxvt::timer
619 ->new
620 ->start (urxvt::NOW + $arg{after})
621 ->cb (sub {
622 $_[0]->stop; # need to cancel manually
623 $cb->();
624 })
625}
626
627sub io {
628 my ($class, %arg) = @_;
629
630 my $cb = $arg{cb};
631
632 bless [$arg{fh}, urxvt::iow
633 ->new
634 ->fd (fileno $arg{fh})
635 ->events (($arg{poll} =~ /r/ ? 1 : 0)
636 | ($arg{poll} =~ /w/ ? 2 : 0))
637 ->start
638 ->cb (sub {
639 $cb->(($_[1] & 1 ? 'r' : '')
640 . ($_[1] & 2 ? 'w' : ''));
641 })],
642 urxvt::anyevent::
643}
644
645sub DESTROY {
646 $_[0][1]->stop;
647}
648
649sub condvar {
650 bless \my $flag, urxvt::anyevent::condvar::
651}
652
653sub urxvt::anyevent::condvar::broadcast {
654 ${$_[0]}++;
655}
656
657sub urxvt::anyevent::condvar::wait {
658 unless (${$_[0]}) {
659 require Carp;
660 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
661 }
662}
663
664package urxvt::term;
665
551=head2 The C<urxvt::term> Class 666=head2 The C<urxvt::term> Class
552 667
553=over 4 668=over 4
554 669
555=item $term->destroy 670=item $term->destroy
556 671
557Destroy the terminal object (close the window, free resources etc.). 672Destroy the terminal object (close the window, free resources etc.).
673
674=item $isset = $term->option ($optval[, $set])
675
676Returns true if the option specified by C<$optval> is enabled, and
677optionally change it. All option values are stored by name in the hash
678C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
679
680Here is a a likely non-exhaustive list of option names, please see the
681source file F</src/optinc.h> to see the actual list:
682
683 borderLess console cursorBlink cursorUnderline hold iconic insecure
684 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
685 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
686 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
687 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
688 tripleclickwords utmpInhibit visualBell
558 689
559=item $value = $term->resource ($name[, $newval]) 690=item $value = $term->resource ($name[, $newval])
560 691
561Returns the current resource value associated with a given name and 692Returns the current resource value associated with a given name and
562optionally sets a new value. Setting values is most useful in the C<init> 693optionally sets a new value. Setting values is most useful in the C<init>
572 703
573Please note that resource strings will currently only be freed when the 704Please note that resource strings will currently only be freed when the
574terminal is destroyed, so changing options frequently will eat memory. 705terminal is destroyed, so changing options frequently will eat memory.
575 706
576Here is a a likely non-exhaustive list of resource names, not all of which 707Here 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 708are supported in every build, please see the source file F</src/rsinc.h>
578list: 709to see the actual list:
579 710
580 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 711 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
581 borderLess color cursorBlink cursorUnderline cutchars delete_key 712 borderLess color cursorBlink cursorUnderline cutchars delete_key
582 display_name embed ext_bwidth fade font geometry hold iconName 713 display_name embed ext_bwidth fade font geometry hold iconName
583 imFont imLocale inputMethod insecure int_bwidth intensityStyles 714 imFont imLocale inputMethod insecure int_bwidth intensityStyles
590 shade term_name title transparent transparent_all tripleclickwords 721 shade term_name title transparent transparent_all tripleclickwords
591 utmpInhibit visualBell 722 utmpInhibit visualBell
592 723
593=cut 724=cut
594 725
595sub urxvt::term::resource($$;$) { 726sub resource($$;$) {
596 my ($self, $name) = (shift, shift); 727 my ($self, $name) = (shift, shift);
597 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 728 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
598 &urxvt::term::_resource 729 &urxvt::term::_resource
599} 730}
600 731
687C<$event> I<must> be the event causing the menu to pop up (a button event, 818C<$event> I<must> be the event causing the menu to pop up (a button event,
688currently). 819currently).
689 820
690=cut 821=cut
691 822
692sub urxvt::term::popup { 823sub popup {
693 my ($self, $event) = @_; 824 my ($self, $event) = @_;
694 825
695 $self->grab ($event->{time}, 1) 826 $self->grab ($event->{time}, 1)
696 or return; 827 or return;
697 828
775=item $nrow_plus_saveLines = $term->total_rows 906=item $nrow_plus_saveLines = $term->total_rows
776 907
777=item $lines_in_scrollback = $term->nsaved 908=item $lines_in_scrollback = $term->nsaved
778 909
779Return various integers describing terminal characteristics. 910Return various integers describing terminal characteristics.
911
912=item $modifiermask = $term->ModLevel3Mask
913
914=item $modifiermask = $term->ModMetaMask
915
916=item $modifiermask = $term->ModNumLockMask
917
918Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
919AltGr), the meta key (often Alt) and the num lock key, if applicable.
780 920
781=item $view_start = $term->view_start ([$newvalue]) 921=item $view_start = $term->view_start ([$newvalue])
782 922
783Returns the negative row number of the topmost line. Minimum value is 923Returns the negative row number of the topmost line. Minimum value is
784C<0>, which displays the normal terminal contents. Larger values scroll 924C<0>, which displays the normal terminal contents. Larger values scroll
878 1018
879=back 1019=back
880 1020
881=cut 1021=cut
882 1022
883sub urxvt::term::line { 1023sub line {
884 my ($self, $row) = @_; 1024 my ($self, $row) = @_;
885 1025
886 my $maxrow = $self->nrow - 1; 1026 my $maxrow = $self->nrow - 1;
887 1027
888 my ($beg, $end) = ($row, $row); 1028 my ($beg, $end) = ($row, $row);
966Converts rxvt-unicodes text reprsentation into a perl string. See 1106Converts rxvt-unicodes text reprsentation into a perl string. See
967C<< $term->ROW_t >> for details. 1107C<< $term->ROW_t >> for details.
968 1108
969=back 1109=back
970 1110
1111=cut
1112
1113package urxvt::popup;
1114
971=head2 The C<urxvt::popup> Class 1115=head2 The C<urxvt::popup> Class
972 1116
973=over 4 1117=over 4
974 1118
975=cut 1119=cut
976
977package urxvt::popup;
978 1120
979sub add_item { 1121sub add_item {
980 my ($self, $item) = @_; 1122 my ($self, $item) = @_;
981 1123
1124 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1125 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1126 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1127
1128 $item->{render} ||= sub { $_[0]{text} };
1129
982 push @{ $self->{item} }, $item; 1130 push @{ $self->{item} }, $item;
1131}
1132
1133sub add_separator {
1134 my ($self, $sep) = @_;
1135
1136 $sep ||= "═";
1137
1138 $self->add_item ({
1139 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1140 text => "",
1141 render => sub { $sep x $urxvt::TERM->ncol },
1142 activate => sub { },
1143 });
1144}
1145
1146sub add_title {
1147 my ($self, $title) = @_;
1148
1149 $self->add_item ({
1150 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1151 text => $title,
1152 activate => sub { },
1153 });
983} 1154}
984 1155
985sub add_button { 1156sub add_button {
986 my ($self, $text, $cb) = @_; 1157 my ($self, $text, $cb) = @_;
987 1158
988 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); 1159 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1160}
1161
1162sub add_toggle {
1163 my ($self, $text, $cb, $value) = @_;
1164
1165 my $item; $item = {
1166 type => "button",
1167 text => " $text",
1168 value => $value,
1169 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1170 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1171 };
1172
1173 $self->add_item ($item);
989} 1174}
990 1175
991sub show { 1176sub show {
992 my ($self) = @_; 1177 my ($self) = @_;
993 1178
1000} 1185}
1001 1186
1002sub DESTROY { 1187sub DESTROY {
1003 my ($self) = @_; 1188 my ($self) = @_;
1004 1189
1190 delete $self->{term}{_destroy}{$self};
1005 $self->{term}->ungrab; 1191 $self->{term}->ungrab;
1006} 1192}
1007 1193
1008=head2 The C<urxvt::timer> Class 1194=head2 The C<urxvt::timer> Class
1009 1195
1113This variable controls the verbosity level of the perl extension. Higher 1299This variable controls the verbosity level of the perl extension. Higher
1114numbers indicate more verbose output. 1300numbers indicate more verbose output.
1115 1301
1116=over 4 1302=over 4
1117 1303
1118=item =0 - only fatal messages 1304=item == 0 - fatal messages
1119 1305
1120=item =3 - script loading and management 1306=item >= 3 - script loading and management
1121 1307
1122=item =10 - all events received 1308=item >=10 - all events received
1123 1309
1124=back 1310=back
1125 1311
1126=head1 AUTHOR 1312=head1 AUTHOR
1127 1313

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines