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.44 by root, Sat Jan 7 19:29:17 2006 UTC vs.
Revision 1.55 by root, Sun Jan 8 05:50:27 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
179should extend the selection itelf and return true to suppress the built-in 184should extend the selection itelf and return true to suppress the built-in
180processing. 185processing.
181 186
182See the F<selection> example extension. 187See the F<selection> example extension.
183 188
184=item on_focus_in $term
185
186Called whenever the window gets the keyboard focus, before urxvt does
187focus in processing.
188
189=item on_focus_out $term
190
191Called wheneever the window loses keyboard focus, before urxvt does focus
192out processing.
193
194=item on_view_change $term, $offset 189=item on_view_change $term, $offset
195 190
196Called whenever the view offset changes, i..e the user or program 191Called whenever the view offset changes, i..e the user or program
197scrolls. Offset C<0> means display the normal terminal, positive values 192scrolls. Offset C<0> means display the normal terminal, positive values
198show this many lines of scrollback. 193show this many lines of scrollback.
261 256
262Called whenever the user presses a key combination that has a 257Called whenever the user presses a key combination that has a
263C<perl:string> action bound to it (see description of the B<keysym> 258C<perl:string> action bound to it (see description of the B<keysym>
264resource in the @@RXVT_NAME@@(1) manpage). 259resource in the @@RXVT_NAME@@(1) manpage).
265 260
261=item on_focus_in $term
262
263Called whenever the window gets the keyboard focus, before rxvt-unicode
264does focus in processing.
265
266=item on_focus_out $term
267
268Called wheneever the window loses keyboard focus, before rxvt-unicode does
269focus out processing.
270
266=item on_key_press $term, $event, $octets 271=item on_key_press $term, $event, $octets
267 272
268=item on_key_release $term, $event 273=item on_key_release $term, $event
269 274
270=item on_button_press $term, $event 275=item on_button_press $term, $event
271 276
272=item on_button_release $term, $event 277=item on_button_release $term, $event
273 278
274=item on_motion_notify $term, $event 279=item on_motion_notify $term, $event
280
281=item on_map_notify $term, $event
282
283=item on_unmap_notify $term, $event
275 284
276Called whenever the corresponding X event is received for the terminal If 285Called whenever the corresponding X event is received for the terminal If
277the hook returns true, then the even will be ignored by rxvt-unicode. 286the hook returns true, then the even will be ignored by rxvt-unicode.
278 287
279The event is a hash with most values as named by Xlib (see the XEvent 288The event is a hash with most values as named by Xlib (see the XEvent
327 336
328=item $time = urxvt::NOW 337=item $time = urxvt::NOW
329 338
330Returns the "current time" (as per the event loop). 339Returns the "current time" (as per the event loop).
331 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
332=back 349=back
333 350
334=head2 RENDITION 351=head2 RENDITION
335 352
336Rendition bitsets contain information about colour, font, font styles and 353Rendition bitsets contain information about colour, font, font styles and
385 402
386=cut 403=cut
387 404
388package urxvt; 405package urxvt;
389 406
407use utf8;
390use strict; 408use strict;
391use Scalar::Util (); 409use Scalar::Util ();
410use List::Util ();
392 411
412our $VERSION = 1;
393our $TERM; 413our $TERM;
394our @HOOKNAME; 414our @HOOKNAME;
415our %OPTION;
395our $LIBDIR; 416our $LIBDIR;
396 417
397BEGIN { 418BEGIN {
398 urxvt->bootstrap; 419 urxvt->bootstrap;
399 420
465 local $TERM = shift; 486 local $TERM = shift;
466 my $htype = shift; 487 my $htype = shift;
467 488
468 if ($htype == 0) { # INIT 489 if ($htype == 0) { # INIT
469 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 490 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
491
492 my %want_ext;
470 493
471 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) {
472 my @files = grep -f $_, map "$_/$ext", @dirs; 505 my @files = grep -f $_, map "$_/$ext", @dirs;
473 506
474 if (@files) { 507 if (@files) {
475 register_package extension_package $files[0]; 508 register_package extension_package $files[0];
476 } else { 509 } else {
477 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";
478 } 511 }
479 } 512 }
513
514 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
515 warn $@ if $@;
480 } 516 }
481 517
482 $retval = undef; 518 $retval = undef;
483 519
484 if (my $cb = $TERM->{_hook}[$htype]) { 520 if (my $cb = $TERM->{_hook}[$htype]) {
519 } 555 }
520 556
521 $retval 557 $retval
522} 558}
523 559
560# urxvt::term::proxy
561
524sub urxvt::term::proxy::AUTOLOAD { 562sub urxvt::term::proxy::AUTOLOAD {
525 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 563 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
526 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 564 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
527 565
528 eval qq{ 566 eval qq{
534 } or die "FATAL: unable to compile method forwarder: $@"; 572 } or die "FATAL: unable to compile method forwarder: $@";
535 573
536 goto &$urxvt::term::proxy::AUTOLOAD; 574 goto &$urxvt::term::proxy::AUTOLOAD;
537} 575}
538 576
577# urxvt::destroy_hook
578
579sub urxvt::destroy_hook::DESTROY {
580 ${$_[0]}->();
581}
582
583sub urxvt::destroy_hook(&) {
584 bless \shift, urxvt::destroy_hook::
585}
586
587# urxvt::anyevent
588
589package urxvt::anyevent;
590
591our $VERSION = 1;
592
593$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
594push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
595
596sub timer {
597 my ($class, %arg) = @_;
598
599 my $cb = $arg{cb};
600
601 urxvt::timer
602 ->new
603 ->start (urxvt::NOW + $arg{after})
604 ->cb (sub {
605 $_[0]->stop; # need to cancel manually
606 $cb->();
607 })
608}
609
610sub io {
611 my ($class, %arg) = @_;
612
613 my $cb = $arg{cb};
614
615 bless [$arg{fh}, urxvt::iow
616 ->new
617 ->fd (fileno $arg{fh})
618 ->events (($arg{poll} =~ /r/ ? 1 : 0)
619 | ($arg{poll} =~ /w/ ? 2 : 0))
620 ->start
621 ->cb (sub {
622 $cb->(($_[1] & 1 ? 'r' : '')
623 . ($_[1] & 2 ? 'w' : ''));
624 })],
625 urxvt::anyevent::
626}
627
628sub DESTROY {
629 $_[0][1]->stop;
630}
631
632sub condvar {
633 bless \my $flag, urxvt::anyevent::condvar::
634}
635
636sub urxvt::anyevent::condvar::broadcast {
637 ${$_[0]}++;
638}
639
640sub urxvt::anyevent::condvar::wait {
641 unless (${$_[0]}) {
642 require Carp;
643 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
644 }
645}
646
647package urxvt::term;
648
539=head2 The C<urxvt::term> Class 649=head2 The C<urxvt::term> Class
540 650
541=over 4 651=over 4
542 652
543=item $term->destroy 653=item $term->destroy
544 654
545Destroy the terminal object (close the window, free resources etc.). 655Destroy the terminal object (close the window, free resources etc.).
656
657=item $isset = $term->option ($optval[, $set])
658
659Returns true if the option specified by C<$optval> is enabled, and
660optionally change it. All option values are stored by name in the hash
661C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
662
663Here is a a likely non-exhaustive list of option names, please see the
664source file F</src/optinc.h> to see the actual list:
665
666 borderLess console cursorBlink cursorUnderline hold iconic insecure
667 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
668 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
669 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
670 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
671 tripleclickwords utmpInhibit visualBell
546 672
547=item $value = $term->resource ($name[, $newval]) 673=item $value = $term->resource ($name[, $newval])
548 674
549Returns the current resource value associated with a given name and 675Returns the current resource value associated with a given name and
550optionally sets a new value. Setting values is most useful in the C<init> 676optionally sets a new value. Setting values is most useful in the C<init>
560 686
561Please note that resource strings will currently only be freed when the 687Please note that resource strings will currently only be freed when the
562terminal is destroyed, so changing options frequently will eat memory. 688terminal is destroyed, so changing options frequently will eat memory.
563 689
564Here is a a likely non-exhaustive list of resource names, not all of which 690Here is a a likely non-exhaustive list of resource names, not all of which
565are supported in every build, please see the source to see the actual 691are supported in every build, please see the source file F</src/rsinc.h>
566list: 692to see the actual list:
567 693
568 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 694 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
569 borderLess color cursorBlink cursorUnderline cutchars delete_key 695 borderLess color cursorBlink cursorUnderline cutchars delete_key
570 display_name embed ext_bwidth fade font geometry hold iconName 696 display_name embed ext_bwidth fade font geometry hold iconName
571 imFont imLocale inputMethod insecure int_bwidth intensityStyles 697 imFont imLocale inputMethod insecure int_bwidth intensityStyles
578 shade term_name title transparent transparent_all tripleclickwords 704 shade term_name title transparent transparent_all tripleclickwords
579 utmpInhibit visualBell 705 utmpInhibit visualBell
580 706
581=cut 707=cut
582 708
583sub urxvt::term::resource($$;$) { 709sub resource($$;$) {
584 my ($self, $name) = (shift, shift); 710 my ($self, $name) = (shift, shift);
585 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 711 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
586 goto &urxvt::term::_resource; 712 &urxvt::term::_resource
587} 713}
588 714
589=item $rend = $term->rstyle ([$new_rstyle]) 715=item $rend = $term->rstyle ([$new_rstyle])
590 716
591Return and optionally change the current rendition. Text that is output by 717Return and optionally change the current rendition. Text that is output by
667 793
668If hidden, display the overlay again. 794If hidden, display the overlay again.
669 795
670=back 796=back
671 797
798=item $popup = $term->popup ($event)
799
800Creates a new C<urxvt::popup> object that implements a popup menu. The
801C<$event> I<must> be the event causing the menu to pop up (a button event,
802currently).
803
804=cut
805
806sub popup {
807 my ($self, $event) = @_;
808
809 $self->grab ($event->{time}, 1)
810 or return;
811
812 my $popup = bless {
813 term => $self,
814 event => $event,
815 }, urxvt::popup::;
816
817 Scalar::Util::weaken $popup->{term};
818
819 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
820 Scalar::Util::weaken $self->{_destroy}{$popup};
821
822 $popup
823}
824
672=item $cellwidth = $term->strwidth ($string) 825=item $cellwidth = $term->strwidth ($string)
673 826
674Returns the number of screen-cells this string would need. Correctly 827Returns the number of screen-cells this string would need. Correctly
675accounts for wide and combining characters. 828accounts for wide and combining characters.
676 829
736=item $nrow_plus_saveLines = $term->total_rows 889=item $nrow_plus_saveLines = $term->total_rows
737 890
738=item $lines_in_scrollback = $term->nsaved 891=item $lines_in_scrollback = $term->nsaved
739 892
740Return various integers describing terminal characteristics. 893Return various integers describing terminal characteristics.
894
895=item $modifiermask = $term->ModLevel3Mask
896
897=item $modifiermask = $term->ModMetaMask
898
899=item $modifiermask = $term->ModNumLockMask
900
901Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
902AltGr), the meta key (often Alt) and the num lock key, if applicable.
741 903
742=item $view_start = $term->view_start ([$newvalue]) 904=item $view_start = $term->view_start ([$newvalue])
743 905
744Returns the negative row number of the topmost line. Minimum value is 906Returns the negative row number of the topmost line. Minimum value is
745C<0>, which displays the normal terminal contents. Larger values scroll 907C<0>, which displays the normal terminal contents. Larger values scroll
839 1001
840=back 1002=back
841 1003
842=cut 1004=cut
843 1005
844sub urxvt::term::line { 1006sub line {
845 my ($self, $row) = @_; 1007 my ($self, $row) = @_;
846 1008
847 my $maxrow = $self->nrow - 1; 1009 my $maxrow = $self->nrow - 1;
848 1010
849 my ($beg, $end) = ($row, $row); 1011 my ($beg, $end) = ($row, $row);
926 1088
927Converts rxvt-unicodes text reprsentation into a perl string. See 1089Converts rxvt-unicodes text reprsentation into a perl string. See
928C<< $term->ROW_t >> for details. 1090C<< $term->ROW_t >> for details.
929 1091
930=back 1092=back
1093
1094=cut
1095
1096package urxvt::popup;
1097
1098=head2 The C<urxvt::popup> Class
1099
1100=over 4
1101
1102=cut
1103
1104sub add_item {
1105 my ($self, $item) = @_;
1106
1107 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1108 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1109 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1110
1111 $item->{render} ||= sub { $_[0]{text} };
1112
1113 push @{ $self->{item} }, $item;
1114}
1115
1116sub add_separator {
1117 my ($self, $sep) = @_;
1118
1119 $sep ||= "═";
1120
1121 $self->add_item ({
1122 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1123 text => "",
1124 render => sub { $sep x $urxvt::TERM->ncol },
1125 activate => sub { },
1126 });
1127}
1128
1129sub add_title {
1130 my ($self, $title) = @_;
1131
1132 $self->add_item ({
1133 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1134 text => $title,
1135 activate => sub { },
1136 });
1137}
1138
1139sub add_button {
1140 my ($self, $text, $cb) = @_;
1141
1142 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1143}
1144
1145sub add_toggle {
1146 my ($self, $text, $cb, $value) = @_;
1147
1148 my $item; $item = {
1149 type => "button",
1150 text => " $text",
1151 value => $value,
1152 render => sub { ($item->{value} ? "* " : " ") . $text },
1153 activate => sub { $cb->($item->{value} = !$item->{value}); },
1154 };
1155
1156 $self->add_item ($item);
1157}
1158
1159sub show {
1160 my ($self) = @_;
1161
1162 local $urxvt::popup::self = $self;
1163
1164 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1165 "--transient-for" => $self->{term}->parent,
1166 "-pe" => "urxvt-popup")
1167 or die "unable to create popup window\n";
1168}
1169
1170sub DESTROY {
1171 my ($self) = @_;
1172
1173 $self->{term}->ungrab;
1174}
931 1175
932=head2 The C<urxvt::timer> Class 1176=head2 The C<urxvt::timer> Class
933 1177
934This class implements timer watchers/events. Time is represented as a 1178This class implements timer watchers/events. Time is represented as a
935fractional number of seconds since the epoch. Example: 1179fractional number of seconds since the epoch. Example:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines