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.111 by root, Thu Jan 19 19:52:54 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC

303called whenever the relevant event happens. 303called whenever the relevant event happens.
304 304
305The first argument passed to them is an extension oject as described in 305The first argument passed to them is an extension oject as described in
306the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
307 307
308B<All> of these hooks must return a boolean value. If it is true, then the 308B<All> of these hooks must return a boolean value. If any of the called
309event counts as being I<consumed>, and the invocation of other hooks is 309hooks returns true, then the event counts as being I<consumed>, and the
310skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
311 311
312I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
313 313
314=over 4 314=over 4
315 315
316=item on_init $term 316=item on_init $term
317 317
318Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
319windows are created or the command gets run. Most methods are unsafe to 319windows are created or the command gets run. Most methods are unsafe to
320call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
321have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
322though. 322and options, though. For many purposes the C<on_start> hook is a better
323place.
324
325=item on_start $term
326
327Called at the very end of initialisation of a new terminal, just before
328trying to map (display) the toplevel and returning to the mainloop.
329
330=item on_destroy $term
331
332Called whenever something tries to destroy terminal, before doing anything
333yet. If this hook returns true, then destruction is skipped, but this is
334rarely a good idea.
323 335
324=item on_reset $term 336=item on_reset $term
325 337
326Called after the screen is "reset" for any reason, such as resizing or 338Called after the screen is "reset" for any reason, such as resizing or
327control sequences. Here is where you can react on changes to size-related 339control sequences. Here is where you can react on changes to size-related
328variables. 340variables.
329
330=item on_start $term
331
332Called at the very end of initialisation of a new terminal, just before
333returning to the mainloop.
334 341
335=item on_child_start $term, $pid 342=item on_child_start $term, $pid
336 343
337Called just after the child process has been C<fork>ed. 344Called just after the child process has been C<fork>ed.
338 345
498use Scalar::Util (); 505use Scalar::Util ();
499use List::Util (); 506use List::Util ();
500 507
501our $VERSION = 1; 508our $VERSION = 1;
502our $TERM; 509our $TERM;
510our @TERM_INIT;
511our @TERM_EXT;
503our @HOOKNAME; 512our @HOOKNAME;
504our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 513our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
505our %OPTION; 514our %OPTION;
506 515
507our $LIBDIR; 516our $LIBDIR;
528 537
529=item $urxvt::TERM 538=item $urxvt::TERM
530 539
531The current terminal. This variable stores the current C<urxvt::term> 540The current terminal. This variable stores the current C<urxvt::term>
532object, whenever a callback/hook is executing. 541object, whenever a callback/hook is executing.
542
543=item @urxvt::TERM_INIT
544
545All coderefs in this array will be called as methods of the next newly
546created C<urxvt::term> object (during the C<on_init> phase). The array
547gets cleared before the codereferences that were in it are being executed,
548so coderefs can push themselves onto it again if they so desire.
549
550This complements to the perl-eval commandline option, but gets executed
551first.
552
553=item @urxvt::TERM_EXT
554
555Works similar to C<@TERM_INIT>, but contains perl package/class names, which
556get registered as normal extensions after calling the hooks in C<@TERM_INIT>
557but before other extensions. Gets cleared just like C<@TERM_INIT>.
533 558
534=back 559=back
535 560
536=head2 Functions in the C<urxvt> Package 561=head2 Functions in the C<urxvt> Package
537 562
659 684
660# load a single script into its own package, once only 685# load a single script into its own package, once only
661sub extension_package($) { 686sub extension_package($) {
662 my ($path) = @_; 687 my ($path) = @_;
663 688
664 no strict 'refs';
665
666 $extension_pkg{$path} ||= do { 689 $extension_pkg{$path} ||= do {
667 $path =~ /([^\/\\]+)$/; 690 $path =~ /([^\/\\]+)$/;
668 my $pkg = $1; 691 my $pkg = $1;
669 $pkg =~ s/[^[:word:]]/_/g; 692 $pkg =~ s/[^[:word:]]/_/g;
670 $pkg = "urxvt::ext::$pkg"; 693 $pkg = "urxvt::ext::$pkg";
672 verbose 3, "loading extension '$path' into package '$pkg'"; 695 verbose 3, "loading extension '$path' into package '$pkg'";
673 696
674 open my $fh, "<:raw", $path 697 open my $fh, "<:raw", $path
675 or die "$path: $!"; 698 or die "$path: $!";
676 699
677 @{"$pkg\::ISA"} = urxvt::term::extension::;
678
679 my $source = 700 my $source =
680 "package $pkg; use strict; use utf8;\n" 701 "package $pkg; use strict; use utf8;\n"
681 . "#line 1 \"$path\"\n{\n" 702 . "#line 1 \"$path\"\n{\n"
682 . (do { local $/; <$fh> }) 703 . (do { local $/; <$fh> })
683 . "\n};\n1"; 704 . "\n};\n1";
699 if ($htype == 0) { # INIT 720 if ($htype == 0) { # INIT
700 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 721 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
701 722
702 my %ext_arg; 723 my %ext_arg;
703 724
725 {
726 my @init = @TERM_INIT;
727 @TERM_INIT = ();
728 $_->($TERM) for @init;
729 my @pkg = @TERM_EXT;
730 @TERM_EXT = ();
731 $TERM->register_package ($_) for @pkg;
732 }
733
704 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 734 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
705 if ($_ eq "default") { 735 if ($_ eq "default") {
706 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 736 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
707 } elsif (/^-(.*)$/) { 737 } elsif (/^-(.*)$/) {
708 delete $ext_arg{$1}; 738 delete $ext_arg{$1};
709 } elsif (/^([^<]+)<(.*)>$/) { 739 } elsif (/^([^<]+)<(.*)>$/) {
734 if $verbosity >= 10; 764 if $verbosity >= 10;
735 765
736 keys %$cb; 766 keys %$cb;
737 767
738 while (my ($pkg, $cb) = each %$cb) { 768 while (my ($pkg, $cb) = each %$cb) {
739 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 769 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
740 and last; 770 $retval ||= $retval_;
741 771
742 if ($@) { 772 if ($@) {
743 $TERM->ungrab; # better to lose the grab than the session 773 $TERM->ungrab; # better to lose the grab than the session
744 warn $@; 774 warn $@;
745 } 775 }
903 933
904# find on_xxx subs in the package and register them 934# find on_xxx subs in the package and register them
905# as hooks 935# as hooks
906sub register_package { 936sub register_package {
907 my ($self, $pkg, $argv) = @_; 937 my ($self, $pkg, $argv) = @_;
938
939 no strict 'refs';
940
941 urxvt::verbose 6, "register package $pkg to $self";
942
943 @{"$pkg\::ISA"} = urxvt::term::extension::;
908 944
909 my $proxy = bless { 945 my $proxy = bless {
910 _pkg => $pkg, 946 _pkg => $pkg,
911 argv => $argv, 947 argv => $argv,
912 }, $pkg; 948 }, $pkg;
1639 $self->{term}->ungrab; 1675 $self->{term}->ungrab;
1640} 1676}
1641 1677
1642=back 1678=back
1643 1679
1680=cut
1681
1682package urxvt::watcher;
1683
1684@urxvt::timer::ISA = __PACKAGE__;
1685@urxvt::iow::ISA = __PACKAGE__;
1686@urxvt::pw::ISA = __PACKAGE__;
1687@urxvt::iw::ISA = __PACKAGE__;
1688
1644=head2 The C<urxvt::timer> Class 1689=head2 The C<urxvt::timer> Class
1645 1690
1646This class implements timer watchers/events. Time is represented as a 1691This class implements timer watchers/events. Time is represented as a
1647fractional number of seconds since the epoch. Example: 1692fractional number of seconds since the epoch. Example:
1648 1693

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines