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.45 by root, Sat Jan 7 20:23:52 2006 UTC vs.
Revision 1.57 by root, Sun Jan 8 08:43:11 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]) {
523 } 557 }
524 558
525 $retval 559 $retval
526} 560}
527 561
562# urxvt::term::proxy
563
528sub urxvt::term::proxy::AUTOLOAD { 564sub urxvt::term::proxy::AUTOLOAD {
529 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 565 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
530 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 566 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
531 567
532 eval qq{ 568 eval qq{
538 } or die "FATAL: unable to compile method forwarder: $@"; 574 } or die "FATAL: unable to compile method forwarder: $@";
539 575
540 goto &$urxvt::term::proxy::AUTOLOAD; 576 goto &$urxvt::term::proxy::AUTOLOAD;
541} 577}
542 578
579# urxvt::destroy_hook
580
543sub urxvt::destroy_hook::DESTROY { 581sub urxvt::destroy_hook::DESTROY {
544 ${$_[0]}->(); 582 ${$_[0]}->();
545} 583}
546 584
547sub urxvt::destroy_hook(&) { 585sub urxvt::destroy_hook(&) {
548 bless \shift, urxvt::destroy_hook:: 586 bless \shift, urxvt::destroy_hook::
549} 587}
550 588
589package urxvt::anyevent;
590
591=head2 The C<urxvt::anyevent> Class
592
593The sole purpose of this class is to deliver an interface to the
594C<AnyEvent> module - any module using it will work inside urxvt without
595further work. The only exception is that you cannot wait on condition
596variables, but non-blocking condvar use is ok. What this means is that you
597cannot use blocking APIs, but the non-blocking variant should work.
598
599=cut
600
601our $VERSION = 1;
602
603$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
604push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
605
606sub timer {
607 my ($class, %arg) = @_;
608
609 my $cb = $arg{cb};
610
611 urxvt::timer
612 ->new
613 ->start (urxvt::NOW + $arg{after})
614 ->cb (sub {
615 $_[0]->stop; # need to cancel manually
616 $cb->();
617 })
618}
619
620sub io {
621 my ($class, %arg) = @_;
622
623 my $cb = $arg{cb};
624
625 bless [$arg{fh}, urxvt::iow
626 ->new
627 ->fd (fileno $arg{fh})
628 ->events (($arg{poll} =~ /r/ ? 1 : 0)
629 | ($arg{poll} =~ /w/ ? 2 : 0))
630 ->start
631 ->cb (sub {
632 $cb->(($_[1] & 1 ? 'r' : '')
633 . ($_[1] & 2 ? 'w' : ''));
634 })],
635 urxvt::anyevent::
636}
637
638sub DESTROY {
639 $_[0][1]->stop;
640}
641
642sub condvar {
643 bless \my $flag, urxvt::anyevent::condvar::
644}
645
646sub urxvt::anyevent::condvar::broadcast {
647 ${$_[0]}++;
648}
649
650sub urxvt::anyevent::condvar::wait {
651 unless (${$_[0]}) {
652 require Carp;
653 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
654 }
655}
656
657package urxvt::term;
658
551=head2 The C<urxvt::term> Class 659=head2 The C<urxvt::term> Class
552 660
553=over 4 661=over 4
554 662
555=item $term->destroy 663=item $term->destroy
556 664
557Destroy the terminal object (close the window, free resources etc.). 665Destroy the terminal object (close the window, free resources etc.).
666
667=item $isset = $term->option ($optval[, $set])
668
669Returns true if the option specified by C<$optval> is enabled, and
670optionally change it. All option values are stored by name in the hash
671C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
672
673Here is a a likely non-exhaustive list of option names, please see the
674source file F</src/optinc.h> to see the actual list:
675
676 borderLess console cursorBlink cursorUnderline hold iconic insecure
677 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
678 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
679 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
680 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
681 tripleclickwords utmpInhibit visualBell
558 682
559=item $value = $term->resource ($name[, $newval]) 683=item $value = $term->resource ($name[, $newval])
560 684
561Returns the current resource value associated with a given name and 685Returns the current resource value associated with a given name and
562optionally sets a new value. Setting values is most useful in the C<init> 686optionally sets a new value. Setting values is most useful in the C<init>
572 696
573Please note that resource strings will currently only be freed when the 697Please note that resource strings will currently only be freed when the
574terminal is destroyed, so changing options frequently will eat memory. 698terminal is destroyed, so changing options frequently will eat memory.
575 699
576Here is a a likely non-exhaustive list of resource names, not all of which 700Here 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 701are supported in every build, please see the source file F</src/rsinc.h>
578list: 702to see the actual list:
579 703
580 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 704 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
581 borderLess color cursorBlink cursorUnderline cutchars delete_key 705 borderLess color cursorBlink cursorUnderline cutchars delete_key
582 display_name embed ext_bwidth fade font geometry hold iconName 706 display_name embed ext_bwidth fade font geometry hold iconName
583 imFont imLocale inputMethod insecure int_bwidth intensityStyles 707 imFont imLocale inputMethod insecure int_bwidth intensityStyles
590 shade term_name title transparent transparent_all tripleclickwords 714 shade term_name title transparent transparent_all tripleclickwords
591 utmpInhibit visualBell 715 utmpInhibit visualBell
592 716
593=cut 717=cut
594 718
595sub urxvt::term::resource($$;$) { 719sub resource($$;$) {
596 my ($self, $name) = (shift, shift); 720 my ($self, $name) = (shift, shift);
597 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 721 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
598 &urxvt::term::_resource 722 &urxvt::term::_resource
599} 723}
600 724
687C<$event> I<must> be the event causing the menu to pop up (a button event, 811C<$event> I<must> be the event causing the menu to pop up (a button event,
688currently). 812currently).
689 813
690=cut 814=cut
691 815
692sub urxvt::term::popup { 816sub popup {
693 my ($self, $event) = @_; 817 my ($self, $event) = @_;
694 818
695 $self->grab ($event->{time}, 1) 819 $self->grab ($event->{time}, 1)
696 or return; 820 or return;
697 821
775=item $nrow_plus_saveLines = $term->total_rows 899=item $nrow_plus_saveLines = $term->total_rows
776 900
777=item $lines_in_scrollback = $term->nsaved 901=item $lines_in_scrollback = $term->nsaved
778 902
779Return various integers describing terminal characteristics. 903Return various integers describing terminal characteristics.
904
905=item $modifiermask = $term->ModLevel3Mask
906
907=item $modifiermask = $term->ModMetaMask
908
909=item $modifiermask = $term->ModNumLockMask
910
911Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
912AltGr), the meta key (often Alt) and the num lock key, if applicable.
780 913
781=item $view_start = $term->view_start ([$newvalue]) 914=item $view_start = $term->view_start ([$newvalue])
782 915
783Returns the negative row number of the topmost line. Minimum value is 916Returns the negative row number of the topmost line. Minimum value is
784C<0>, which displays the normal terminal contents. Larger values scroll 917C<0>, which displays the normal terminal contents. Larger values scroll
878 1011
879=back 1012=back
880 1013
881=cut 1014=cut
882 1015
883sub urxvt::term::line { 1016sub line {
884 my ($self, $row) = @_; 1017 my ($self, $row) = @_;
885 1018
886 my $maxrow = $self->nrow - 1; 1019 my $maxrow = $self->nrow - 1;
887 1020
888 my ($beg, $end) = ($row, $row); 1021 my ($beg, $end) = ($row, $row);
966Converts rxvt-unicodes text reprsentation into a perl string. See 1099Converts rxvt-unicodes text reprsentation into a perl string. See
967C<< $term->ROW_t >> for details. 1100C<< $term->ROW_t >> for details.
968 1101
969=back 1102=back
970 1103
1104=cut
1105
1106package urxvt::popup;
1107
971=head2 The C<urxvt::popup> Class 1108=head2 The C<urxvt::popup> Class
972 1109
973=over 4 1110=over 4
974 1111
975=cut 1112=cut
976
977package urxvt::popup;
978 1113
979sub add_item { 1114sub add_item {
980 my ($self, $item) = @_; 1115 my ($self, $item) = @_;
981 1116
1117 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1118 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1119 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1120
1121 $item->{render} ||= sub { $_[0]{text} };
1122
982 push @{ $self->{item} }, $item; 1123 push @{ $self->{item} }, $item;
1124}
1125
1126sub add_separator {
1127 my ($self, $sep) = @_;
1128
1129 $sep ||= "═";
1130
1131 $self->add_item ({
1132 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1133 text => "",
1134 render => sub { $sep x $urxvt::TERM->ncol },
1135 activate => sub { },
1136 });
1137}
1138
1139sub add_title {
1140 my ($self, $title) = @_;
1141
1142 $self->add_item ({
1143 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1144 text => $title,
1145 activate => sub { },
1146 });
983} 1147}
984 1148
985sub add_button { 1149sub add_button {
986 my ($self, $text, $cb) = @_; 1150 my ($self, $text, $cb) = @_;
987 1151
988 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); 1152 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1153}
1154
1155sub add_toggle {
1156 my ($self, $text, $cb, $value) = @_;
1157
1158 my $item; $item = {
1159 type => "button",
1160 text => " $text",
1161 value => $value,
1162 render => sub { ($item->{value} ? "* " : " ") . $text },
1163 activate => sub { $cb->($item->{value} = !$item->{value}); },
1164 };
1165
1166 $self->add_item ($item);
989} 1167}
990 1168
991sub show { 1169sub show {
992 my ($self) = @_; 1170 my ($self) = @_;
993 1171
994 local $urxvt::popup::self = $self; 1172 local $urxvt::popup::self = $self;
995 1173
996 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1174 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
997 "--transient-for" => $self->{term}->parent, 1175 "--transient-for" => $self->{term}->parent,
998 "-pe" => "urxvt_popup") 1176 "-pe" => "urxvt-popup")
999 or die "unable to create popup window\n"; 1177 or die "unable to create popup window\n";
1000} 1178}
1001 1179
1002sub DESTROY { 1180sub DESTROY {
1003 my ($self) = @_; 1181 my ($self) = @_;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines