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.110 by root, Thu Jan 19 16:22:13 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC

… …
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
… …
299called whenever the relevant event happens. 303called whenever the relevant event happens.
300 304
301The 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
302the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
303 307
304B<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
305event 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
306skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
307 311
308I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
309 313
310=over 4 314=over 4
311 315
312=item on_init $term 316=item on_init $term
313 317
314Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
315windows 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
316call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
317have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
318though. 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.
319 335
320=item on_reset $term 336=item on_reset $term
321 337
322Called 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
323control 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
324variables. 340variables.
325
326=item on_start $term
327
328Called at the very end of initialisation of a new terminal, just before
329returning to the mainloop.
330 341
331=item on_child_start $term, $pid 342=item on_child_start $term, $pid
332 343
333Called just after the child process has been C<fork>ed. 344Called just after the child process has been C<fork>ed.
334 345
… …
494use Scalar::Util (); 505use Scalar::Util ();
495use List::Util (); 506use List::Util ();
496 507
497our $VERSION = 1; 508our $VERSION = 1;
498our $TERM; 509our $TERM;
510our @TERM_INIT;
511our @TERM_EXT;
499our @HOOKNAME; 512our @HOOKNAME;
500our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 513our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
501our %OPTION; 514our %OPTION;
502 515
503our $LIBDIR; 516our $LIBDIR;
… …
524 537
525=item $urxvt::TERM 538=item $urxvt::TERM
526 539
527The current terminal. This variable stores the current C<urxvt::term> 540The current terminal. This variable stores the current C<urxvt::term>
528object, 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>.
529 558
530=back 559=back
531 560
532=head2 Functions in the C<urxvt> Package 561=head2 Functions in the C<urxvt> Package
533 562
… …
655 684
656# load a single script into its own package, once only 685# load a single script into its own package, once only
657sub extension_package($) { 686sub extension_package($) {
658 my ($path) = @_; 687 my ($path) = @_;
659 688
660 no strict 'refs';
661
662 $extension_pkg{$path} ||= do { 689 $extension_pkg{$path} ||= do {
663 $path =~ /([^\/\\]+)$/; 690 $path =~ /([^\/\\]+)$/;
664 my $pkg = $1; 691 my $pkg = $1;
665 $pkg =~ s/[^[:word:]]/_/g; 692 $pkg =~ s/[^[:word:]]/_/g;
666 $pkg = "urxvt::ext::$pkg"; 693 $pkg = "urxvt::ext::$pkg";
… …
668 verbose 3, "loading extension '$path' into package '$pkg'"; 695 verbose 3, "loading extension '$path' into package '$pkg'";
669 696
670 open my $fh, "<:raw", $path 697 open my $fh, "<:raw", $path
671 or die "$path: $!"; 698 or die "$path: $!";
672 699
673 @{"$pkg\::ISA"} = urxvt::term::extension::;
674
675 my $source = 700 my $source =
676 "package $pkg; use strict; use utf8;\n" 701 "package $pkg; use strict; use utf8;\n"
677 . "#line 1 \"$path\"\n{\n" 702 . "#line 1 \"$path\"\n{\n"
678 . (do { local $/; <$fh> }) 703 . (do { local $/; <$fh> })
679 . "\n};\n1"; 704 . "\n};\n1";
… …
695 if ($htype == 0) { # INIT 720 if ($htype == 0) { # INIT
696 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 721 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
697 722
698 my %ext_arg; 723 my %ext_arg;
699 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
700 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 734 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
701 if ($_ eq "default") { 735 if ($_ eq "default") {
702 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 736 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
703 } elsif (/^-(.*)$/) { 737 } elsif (/^-(.*)$/) {
704 delete $ext_arg{$1}; 738 delete $ext_arg{$1};
705 } elsif (/^([^<]+)<(.*)>$/) { 739 } elsif (/^([^<]+)<(.*)>$/) {
… …
730 if $verbosity >= 10; 764 if $verbosity >= 10;
731 765
732 keys %$cb; 766 keys %$cb;
733 767
734 while (my ($pkg, $cb) = each %$cb) { 768 while (my ($pkg, $cb) = each %$cb) {
735 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 769 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
736 and last; 770 $retval ||= $retval_;
737 771
738 if ($@) { 772 if ($@) {
739 $TERM->ungrab; # better to lose the grab than the session 773 $TERM->ungrab; # better to lose the grab than the session
740 warn $@; 774 warn $@;
741 } 775 }
… …
899 933
900# find on_xxx subs in the package and register them 934# find on_xxx subs in the package and register them
901# as hooks 935# as hooks
902sub register_package { 936sub register_package {
903 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::;
904 944
905 my $proxy = bless { 945 my $proxy = bless {
906 _pkg => $pkg, 946 _pkg => $pkg,
907 argv => $argv, 947 argv => $argv,
908 }, $pkg; 948 }, $pkg;
… …
1635 $self->{term}->ungrab; 1675 $self->{term}->ungrab;
1636} 1676}
1637 1677
1638=back 1678=back
1639 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
1640=head2 The C<urxvt::timer> Class 1689=head2 The C<urxvt::timer> Class
1641 1690
1642This class implements timer watchers/events. Time is represented as a 1691This class implements timer watchers/events. Time is represented as a
1643fractional number of seconds since the epoch. Example: 1692fractional number of seconds since the epoch. Example:
1644 1693

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines