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.43 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.46 by root, Sat Jan 7 20:29:28 2006 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, scripts specified via the 22Everytime a terminal object gets created, extension scripts specified via
23C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
120 120
121The following subroutines can be declared in extension files, and will be 121The following subroutines can be declared in extension files, and will be
122called whenever the relevant event happens. 122called whenever the relevant event happens.
123 123
124The first argument passed to them is an object private to each terminal 124The first argument passed to them is an object private to each terminal
125and extension package. You can call all C<urxvt::term> methods on it, but 125and extension package. You can call all C<urxvt::term> methods on it, but
126its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> 126its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127object that is shared between all packages is stored in the C<term> 127object that is shared between all packages is stored in the C<term>
128member. 128member. It is, however, blessed intot he package of the extension script,
129so for all practical purposes you can treat an extension script as a class.
129 130
130All of them must return a boolean value. If it is true, then the event 131All of them must return a boolean value. If it is true, then the event
131counts as being I<consumed>, and the invocation of other hooks is skipped, 132counts as being I<consumed>, and the invocation of other hooks is skipped,
132and the relevant action might not be carried out by the C++ code. 133and the relevant action might not be carried out by the C++ code.
133 134
177click) and is either supposed to return false (normal operation), or 178click) and is either supposed to return false (normal operation), or
178should 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
179processing. 180processing.
180 181
181See the F<selection> example extension. 182See the F<selection> example extension.
182
183=item on_focus_in $term
184
185Called whenever the window gets the keyboard focus, before urxvt does
186focus in processing.
187
188=item on_focus_out $term
189
190Called wheneever the window loses keyboard focus, before urxvt does focus
191out processing.
192 183
193=item on_view_change $term, $offset 184=item on_view_change $term, $offset
194 185
195Called whenever the view offset changes, i..e the user or program 186Called whenever the view offset changes, i..e the user or program
196scrolls. Offset C<0> means display the normal terminal, positive values 187scrolls. Offset C<0> means display the normal terminal, positive values
260 251
261Called whenever the user presses a key combination that has a 252Called whenever the user presses a key combination that has a
262C<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>
263resource in the @@RXVT_NAME@@(1) manpage). 254resource in the @@RXVT_NAME@@(1) manpage).
264 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
265=item on_key_press $term, $event, $octets 266=item on_key_press $term, $event, $octets
266 267
267=item on_key_release $term, $event 268=item on_key_release $term, $event
268 269
269=item on_button_press $term, $event 270=item on_button_press $term, $event
270 271
271=item on_button_release $term, $event 272=item on_button_release $term, $event
272 273
273=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
274 279
275Called whenever the corresponding X event is received for the terminal If 280Called whenever the corresponding X event is received for the terminal If
276the 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.
277 282
278The 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
428 $hook_count[$htype]++ 433 $hook_count[$htype]++
429 or set_should_invoke $htype, 1; 434 or set_should_invoke $htype, 1;
430 } 435 }
431} 436}
432 437
433my $script_pkg = "script0000"; 438my $extension_pkg = "extension0000";
434my %script_pkg; 439my %extension_pkg;
435 440
436# load a single script into its own package, once only 441# load a single script into its own package, once only
437sub script_package($) { 442sub extension_package($) {
438 my ($path) = @_; 443 my ($path) = @_;
439 444
440 $script_pkg{$path} ||= do { 445 $extension_pkg{$path} ||= do {
441 my $pkg = "urxvt::" . ($script_pkg++); 446 my $pkg = "urxvt::" . ($extension_pkg++);
442 447
443 verbose 3, "loading script '$path' into package '$pkg'"; 448 verbose 3, "loading extension '$path' into package '$pkg'";
444 449
445 open my $fh, "<:raw", $path 450 open my $fh, "<:raw", $path
446 or die "$path: $!"; 451 or die "$path: $!";
447 452
448 my $source = "package $pkg; use strict; use utf8;\n" 453 my $source = "package $pkg; use strict; use utf8;\n"
454 . "use base urxvt::term::proxy::;\n"
449 . "#line 1 \"$path\"\n{\n" 455 . "#line 1 \"$path\"\n{\n"
450 . (do { local $/; <$fh> }) 456 . (do { local $/; <$fh> })
451 . "\n};\n1"; 457 . "\n};\n1";
452 458
453 eval $source or die "$path: $@"; 459 eval $source or die "$path: $@";
468 474
469 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 475 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
470 my @files = grep -f $_, map "$_/$ext", @dirs; 476 my @files = grep -f $_, map "$_/$ext", @dirs;
471 477
472 if (@files) { 478 if (@files) {
473 register_package script_package $files[0]; 479 register_package extension_package $files[0];
474 } else { 480 } else {
475 warn "perl extension '$ext' not found in perl library search path\n"; 481 warn "perl extension '$ext' not found in perl library search path\n";
476 } 482 }
477 } 483 }
478 } 484 }
484 if $verbosity >= 10; 490 if $verbosity >= 10;
485 491
486 keys %$cb; 492 keys %$cb;
487 493
488 while (my ($pkg, $cb) = each %$cb) { 494 while (my ($pkg, $cb) = each %$cb) {
495 eval {
489 $retval = $cb->( 496 $retval = $cb->(
490 $TERM->{_pkg}{$pkg} ||= do { 497 $TERM->{_pkg}{$pkg} ||= do {
491 my $proxy = bless { }, urxvt::term::proxy::; 498 my $proxy = bless { }, $pkg;
492 Scalar::Util::weaken ($proxy->{term} = $TERM); 499 Scalar::Util::weaken ($proxy->{term} = $TERM);
493 $proxy 500 $proxy
494 }, 501 },
495 @_, 502 @_,
496 ) and last; 503 ) and last;
504 };
505 warn $@ if $@;#d#
497 } 506 }
498 } 507 }
499 508
500 if ($htype == 1) { # DESTROY 509 if ($htype == 1) { # DESTROY
501 # remove hooks if unused 510 # remove hooks if unused
527 } 536 }
528 1 537 1
529 } or die "FATAL: unable to compile method forwarder: $@"; 538 } or die "FATAL: unable to compile method forwarder: $@";
530 539
531 goto &$urxvt::term::proxy::AUTOLOAD; 540 goto &$urxvt::term::proxy::AUTOLOAD;
541}
542
543sub urxvt::destroy_hook::DESTROY {
544 ${$_[0]}->();
545}
546
547sub urxvt::destroy_hook(&) {
548 bless \shift, urxvt::destroy_hook::
532} 549}
533 550
534=head2 The C<urxvt::term> Class 551=head2 The C<urxvt::term> Class
535 552
536=over 4 553=over 4
576=cut 593=cut
577 594
578sub urxvt::term::resource($$;$) { 595sub urxvt::term::resource($$;$) {
579 my ($self, $name) = (shift, shift); 596 my ($self, $name) = (shift, shift);
580 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 597 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
581 goto &urxvt::term::_resource; 598 &urxvt::term::_resource
582} 599}
583 600
584=item $rend = $term->rstyle ([$new_rstyle]) 601=item $rend = $term->rstyle ([$new_rstyle])
585 602
586Return and optionally change the current rendition. Text that is output by 603Return and optionally change the current rendition. Text that is output by
662 679
663If hidden, display the overlay again. 680If hidden, display the overlay again.
664 681
665=back 682=back
666 683
684=item $popup = $term->popup ($event)
685
686Creates a new C<urxvt::popup> object that implements a popup menu. The
687C<$event> I<must> be the event causing the menu to pop up (a button event,
688currently).
689
690=cut
691
692sub urxvt::term::popup {
693 my ($self, $event) = @_;
694
695 $self->grab ($event->{time}, 1)
696 or return;
697
698 my $popup = bless {
699 term => $self,
700 event => $event,
701 }, urxvt::popup::;
702
703 Scalar::Util::weaken $popup->{term};
704
705 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
706 Scalar::Util::weaken $self->{_destroy}{$popup};
707
708 $popup
709}
710
667=item $cellwidth = $term->strwidth ($string) 711=item $cellwidth = $term->strwidth ($string)
668 712
669Returns the number of screen-cells this string would need. Correctly 713Returns the number of screen-cells this string would need. Correctly
670accounts for wide and combining characters. 714accounts for wide and combining characters.
671 715
921 965
922Converts rxvt-unicodes text reprsentation into a perl string. See 966Converts rxvt-unicodes text reprsentation into a perl string. See
923C<< $term->ROW_t >> for details. 967C<< $term->ROW_t >> for details.
924 968
925=back 969=back
970
971=head2 The C<urxvt::popup> Class
972
973=over 4
974
975=cut
976
977package urxvt::popup;
978
979sub add_item {
980 my ($self, $item) = @_;
981
982 push @{ $self->{item} }, $item;
983}
984
985sub add_button {
986 my ($self, $text, $cb) = @_;
987
988 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb });
989}
990
991sub show {
992 my ($self) = @_;
993
994 local $urxvt::popup::self = $self;
995
996 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
997 "--transient-for" => $self->{term}->parent,
998 "-pe" => "urxvt-popup")
999 or die "unable to create popup window\n";
1000}
1001
1002sub DESTROY {
1003 my ($self) = @_;
1004
1005 $self->{term}->ungrab;
1006}
926 1007
927=head2 The C<urxvt::timer> Class 1008=head2 The C<urxvt::timer> Class
928 1009
929This class implements timer watchers/events. Time is represented as a 1010This class implements timer watchers/events. Time is represented as a
930fractional number of seconds since the epoch. Example: 1011fractional number of seconds since the epoch. Example:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines