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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines