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.49 by root, Sun Jan 8 00:07:18 2006 UTC

179should extend the selection itelf and return true to suppress the built-in 179should extend the selection itelf and return true to suppress the built-in
180processing. 180processing.
181 181
182See the F<selection> example extension. 182See the F<selection> example extension.
183 183
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 184=item on_view_change $term, $offset
195 185
196Called whenever the view offset changes, i..e the user or program 186Called whenever the view offset changes, i..e the user or program
197scrolls. Offset C<0> means display the normal terminal, positive values 187scrolls. Offset C<0> means display the normal terminal, positive values
198show this many lines of scrollback. 188show this many lines of scrollback.
261 251
262Called whenever the user presses a key combination that has a 252Called whenever the user presses a key combination that has a
263C<perl:string> action bound to it (see description of the B<keysym> 253C<perl:string> action bound to it (see description of the B<keysym>
264resource in the @@RXVT_NAME@@(1) manpage). 254resource in the @@RXVT_NAME@@(1) manpage).
265 255
256=item on_focus_in $term
257
258Called whenever the window gets the keyboard focus, before rxvt-unicode
259does focus in processing.
260
261=item on_focus_out $term
262
263Called wheneever the window loses keyboard focus, before rxvt-unicode does
264focus out processing.
265
266=item on_key_press $term, $event, $octets 266=item on_key_press $term, $event, $octets
267 267
268=item on_key_release $term, $event 268=item on_key_release $term, $event
269 269
270=item on_button_press $term, $event 270=item on_button_press $term, $event
271 271
272=item on_button_release $term, $event 272=item on_button_release $term, $event
273 273
274=item on_motion_notify $term, $event 274=item on_motion_notify $term, $event
275
276=item on_map_notify $term, $event
277
278=item on_unmap_notify $term, $event
275 279
276Called whenever the corresponding X event is received for the terminal If 280Called whenever the corresponding X event is received for the terminal If
277the hook returns true, then the even will be ignored by rxvt-unicode. 281the hook returns true, then the even will be ignored by rxvt-unicode.
278 282
279The event is a hash with most values as named by Xlib (see the XEvent 283The event is a hash with most values as named by Xlib (see the XEvent
327 331
328=item $time = urxvt::NOW 332=item $time = urxvt::NOW
329 333
330Returns the "current time" (as per the event loop). 334Returns the "current time" (as per the event loop).
331 335
336=item urxvt::CurrentTime
337
338=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340Button4Mask, Button5Mask, AnyModifier
341
342Various constants for use in X events.
343
332=back 344=back
333 345
334=head2 RENDITION 346=head2 RENDITION
335 347
336Rendition bitsets contain information about colour, font, font styles and 348Rendition bitsets contain information about colour, font, font styles and
385 397
386=cut 398=cut
387 399
388package urxvt; 400package urxvt;
389 401
402use utf8;
390use strict; 403use strict;
391use Scalar::Util (); 404use Scalar::Util ();
405use List::Util ();
392 406
393our $TERM; 407our $TERM;
394our @HOOKNAME; 408our @HOOKNAME;
409our %OPTION;
395our $LIBDIR; 410our $LIBDIR;
396 411
397BEGIN { 412BEGIN {
398 urxvt->bootstrap; 413 urxvt->bootstrap;
399 414
465 local $TERM = shift; 480 local $TERM = shift;
466 my $htype = shift; 481 my $htype = shift;
467 482
468 if ($htype == 0) { # INIT 483 if ($htype == 0) { # INIT
469 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 484 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
470 485
471 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 486 my @ext = (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2);
472 my @files = grep -f $_, map "$_/$ext", @dirs;
473 487
474 if (@files) { 488 while (@ext) {
475 register_package extension_package $files[0]; 489 my $ext = shift @ext;
490 if ($ext eq "default") {
491 unshift @ext, qw(selection);
476 } else { 492 } else {
493 my @files = grep -f $_, map "$_/$ext", @dirs;
494
495 if (@files) {
496 register_package extension_package $files[0];
497 } else {
477 warn "perl extension '$ext' not found in perl library search path\n"; 498 warn "perl extension '$ext' not found in perl library search path\n";
499 }
478 } 500 }
479 } 501 }
480 } 502 }
481 503
482 $retval = undef; 504 $retval = undef;
534 } or die "FATAL: unable to compile method forwarder: $@"; 556 } or die "FATAL: unable to compile method forwarder: $@";
535 557
536 goto &$urxvt::term::proxy::AUTOLOAD; 558 goto &$urxvt::term::proxy::AUTOLOAD;
537} 559}
538 560
561sub urxvt::destroy_hook::DESTROY {
562 ${$_[0]}->();
563}
564
565sub urxvt::destroy_hook(&) {
566 bless \shift, urxvt::destroy_hook::
567}
568
539=head2 The C<urxvt::term> Class 569=head2 The C<urxvt::term> Class
540 570
541=over 4 571=over 4
542 572
543=item $term->destroy 573=item $term->destroy
544 574
545Destroy the terminal object (close the window, free resources etc.). 575Destroy the terminal object (close the window, free resources etc.).
576
577=item $isset = $term->option ($optval[, $set])
578
579Returns true if the option specified by C<$optval> is enabled, and
580optionally change it. All option values are stored by name in the hash
581C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
582
583Here is a a likely non-exhaustive list of option names, please see the
584source file F</src/optinc.h> to see the actual list:
585
586 borderLess console cursorBlink cursorUnderline hold iconic insecure
587 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
588 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
589 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
590 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
591 tripleclickwords utmpInhibit visualBell
546 592
547=item $value = $term->resource ($name[, $newval]) 593=item $value = $term->resource ($name[, $newval])
548 594
549Returns the current resource value associated with a given name and 595Returns the current resource value associated with a given name and
550optionally sets a new value. Setting values is most useful in the C<init> 596optionally sets a new value. Setting values is most useful in the C<init>
560 606
561Please note that resource strings will currently only be freed when the 607Please note that resource strings will currently only be freed when the
562terminal is destroyed, so changing options frequently will eat memory. 608terminal is destroyed, so changing options frequently will eat memory.
563 609
564Here is a a likely non-exhaustive list of resource names, not all of which 610Here 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 611are supported in every build, please see the source file F</src/rsinc.h>
566list: 612to see the actual list:
567 613
568 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 614 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
569 borderLess color cursorBlink cursorUnderline cutchars delete_key 615 borderLess color cursorBlink cursorUnderline cutchars delete_key
570 display_name embed ext_bwidth fade font geometry hold iconName 616 display_name embed ext_bwidth fade font geometry hold iconName
571 imFont imLocale inputMethod insecure int_bwidth intensityStyles 617 imFont imLocale inputMethod insecure int_bwidth intensityStyles
581=cut 627=cut
582 628
583sub urxvt::term::resource($$;$) { 629sub urxvt::term::resource($$;$) {
584 my ($self, $name) = (shift, shift); 630 my ($self, $name) = (shift, shift);
585 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 631 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
586 goto &urxvt::term::_resource; 632 &urxvt::term::_resource
587} 633}
588 634
589=item $rend = $term->rstyle ([$new_rstyle]) 635=item $rend = $term->rstyle ([$new_rstyle])
590 636
591Return and optionally change the current rendition. Text that is output by 637Return and optionally change the current rendition. Text that is output by
667 713
668If hidden, display the overlay again. 714If hidden, display the overlay again.
669 715
670=back 716=back
671 717
718=item $popup = $term->popup ($event)
719
720Creates a new C<urxvt::popup> object that implements a popup menu. The
721C<$event> I<must> be the event causing the menu to pop up (a button event,
722currently).
723
724=cut
725
726sub urxvt::term::popup {
727 my ($self, $event) = @_;
728
729 $self->grab ($event->{time}, 1)
730 or return;
731
732 my $popup = bless {
733 term => $self,
734 event => $event,
735 }, urxvt::popup::;
736
737 Scalar::Util::weaken $popup->{term};
738
739 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
740 Scalar::Util::weaken $self->{_destroy}{$popup};
741
742 $popup
743}
744
672=item $cellwidth = $term->strwidth ($string) 745=item $cellwidth = $term->strwidth ($string)
673 746
674Returns the number of screen-cells this string would need. Correctly 747Returns the number of screen-cells this string would need. Correctly
675accounts for wide and combining characters. 748accounts for wide and combining characters.
676 749
736=item $nrow_plus_saveLines = $term->total_rows 809=item $nrow_plus_saveLines = $term->total_rows
737 810
738=item $lines_in_scrollback = $term->nsaved 811=item $lines_in_scrollback = $term->nsaved
739 812
740Return various integers describing terminal characteristics. 813Return various integers describing terminal characteristics.
814
815=item $modifiermask = $term->ModLevel3Mask
816
817=item $modifiermask = $term->ModMetaMask
818
819=item $modifiermask = $term->ModNumLockMask
820
821Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
822AltGr), the meta key (often Alt) and the num lock key, if applicable.
741 823
742=item $view_start = $term->view_start ([$newvalue]) 824=item $view_start = $term->view_start ([$newvalue])
743 825
744Returns the negative row number of the topmost line. Minimum value is 826Returns the negative row number of the topmost line. Minimum value is
745C<0>, which displays the normal terminal contents. Larger values scroll 827C<0>, which displays the normal terminal contents. Larger values scroll
926 1008
927Converts rxvt-unicodes text reprsentation into a perl string. See 1009Converts rxvt-unicodes text reprsentation into a perl string. See
928C<< $term->ROW_t >> for details. 1010C<< $term->ROW_t >> for details.
929 1011
930=back 1012=back
1013
1014=head2 The C<urxvt::popup> Class
1015
1016=over 4
1017
1018=cut
1019
1020package urxvt::popup;
1021
1022sub add_item {
1023 my ($self, $item) = @_;
1024
1025 push @{ $self->{item} }, $item;
1026}
1027
1028sub add_button {
1029 my ($self, $text, $cb) = @_;
1030
1031 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,
1032 render => sub { $_[0]{text} },
1033 });
1034}
1035
1036sub add_toggle {
1037 my ($self, $text, $cb, $value) = @_;
1038
1039 my $item; $item = {
1040 type => "button",
1041 text => " $text",
1042 value => $value,
1043 render => sub { ($item->{value} ? "✔" : " ") . $text },
1044 activate => sub { $cb->($item->{value} = !$item->{value}); },
1045 };
1046
1047 $self->add_item ($item);
1048}
1049
1050sub show {
1051 my ($self) = @_;
1052
1053 local $urxvt::popup::self = $self;
1054
1055 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1056 "--transient-for" => $self->{term}->parent,
1057 "-pe" => "urxvt-popup")
1058 or die "unable to create popup window\n";
1059}
1060
1061sub DESTROY {
1062 my ($self) = @_;
1063
1064 $self->{term}->ungrab;
1065}
931 1066
932=head2 The C<urxvt::timer> Class 1067=head2 The C<urxvt::timer> Class
933 1068
934This class implements timer watchers/events. Time is represented as a 1069This class implements timer watchers/events. Time is represented as a
935fractional number of seconds since the epoch. Example: 1070fractional number of seconds since the epoch. Example:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines