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.109 by root, Thu Jan 19 16:07:09 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
89 93
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 96evalution, web-browser starting etc.), depending on content.
93 97
94Other extensions can extend this popup menu by pushing a code reference onto 98Other extensions can extend this popup menu by pushing a code reference
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. 99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
96 101
97It's sole argument is the popup menu, which can be modified. The selection 102It's sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not. 103is in C<$_>, which can be used to decide wether to add something or not.
99It should either return nothing or a string and a code reference. The 104It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called 105string will be used as button text and the code reference will be called
102 107
103The following will add an entry C<a to b> that transforms all C<a>s in 108The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any 109the selection to C<b>s, but only if the selection currently contains any
105C<a>s: 110C<a>s:
106 111
107 push urxvt::ext::selection_popup::hook, sub { 112 push @{ $self->{term}{selection_popup_hook} }, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g } 113 /a/ ? ("a to be" => sub { s/a/b/g }
109 : () 114 : ()
110 }; 115 };
111
112Don't run it in a hook, otherwise the menu will grow and grow. Instead put
113it at the toplevel of your extension.
114 116
115=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
116 118
117Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
118by a hotkey (default: C<M-s>). While in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
301called whenever the relevant event happens. 303called whenever the relevant event happens.
302 304
303The 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
304the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
305 307
306B<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
307event 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
308skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
309 311
310I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
311 313
312=over 4 314=over 4
313 315
314=item on_init $term 316=item on_init $term
315 317
316Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
317windows 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
318call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
319have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
320though. 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.
321 335
322=item on_reset $term 336=item on_reset $term
323 337
324Called 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
325control 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
326variables. 340variables.
327
328=item on_start $term
329
330Called at the very end of initialisation of a new terminal, just before
331returning to the mainloop.
332 341
333=item on_child_start $term, $pid 342=item on_child_start $term, $pid
334 343
335Called just after the child process has been C<fork>ed. 344Called just after the child process has been C<fork>ed.
336 345
496use Scalar::Util (); 505use Scalar::Util ();
497use List::Util (); 506use List::Util ();
498 507
499our $VERSION = 1; 508our $VERSION = 1;
500our $TERM; 509our $TERM;
510our @TERM_INIT;
511our @TERM_EXT;
501our @HOOKNAME; 512our @HOOKNAME;
502our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 513our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
503our %OPTION; 514our %OPTION;
504 515
505our $LIBDIR; 516our $LIBDIR;
526 537
527=item $urxvt::TERM 538=item $urxvt::TERM
528 539
529The current terminal. This variable stores the current C<urxvt::term> 540The current terminal. This variable stores the current C<urxvt::term>
530object, 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>.
531 558
532=back 559=back
533 560
534=head2 Functions in the C<urxvt> Package 561=head2 Functions in the C<urxvt> Package
535 562
657 684
658# load a single script into its own package, once only 685# load a single script into its own package, once only
659sub extension_package($) { 686sub extension_package($) {
660 my ($path) = @_; 687 my ($path) = @_;
661 688
662 no strict 'refs';
663
664 $extension_pkg{$path} ||= do { 689 $extension_pkg{$path} ||= do {
665 $path =~ /([^\/\\]+)$/; 690 $path =~ /([^\/\\]+)$/;
666 my $pkg = $1; 691 my $pkg = $1;
667 $pkg =~ s/[^[:word:]]/_/g; 692 $pkg =~ s/[^[:word:]]/_/g;
668 $pkg = "urxvt::ext::$pkg"; 693 $pkg = "urxvt::ext::$pkg";
670 verbose 3, "loading extension '$path' into package '$pkg'"; 695 verbose 3, "loading extension '$path' into package '$pkg'";
671 696
672 open my $fh, "<:raw", $path 697 open my $fh, "<:raw", $path
673 or die "$path: $!"; 698 or die "$path: $!";
674 699
675 @{"$pkg\::ISA"} = urxvt::term::extension::;
676
677 my $source = 700 my $source =
678 "package $pkg; use strict; use utf8;\n" 701 "package $pkg; use strict; use utf8;\n"
679 . "#line 1 \"$path\"\n{\n" 702 . "#line 1 \"$path\"\n{\n"
680 . (do { local $/; <$fh> }) 703 . (do { local $/; <$fh> })
681 . "\n};\n1"; 704 . "\n};\n1";
697 if ($htype == 0) { # INIT 720 if ($htype == 0) { # INIT
698 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 721 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
699 722
700 my %ext_arg; 723 my %ext_arg;
701 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
702 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 734 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
703 if ($_ eq "default") { 735 if ($_ eq "default") {
704 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 736 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
705 } elsif (/^-(.*)$/) { 737 } elsif (/^-(.*)$/) {
706 delete $ext_arg{$1}; 738 delete $ext_arg{$1};
707 } elsif (/^([^<]+)<(.*)>$/) { 739 } elsif (/^([^<]+)<(.*)>$/) {
732 if $verbosity >= 10; 764 if $verbosity >= 10;
733 765
734 keys %$cb; 766 keys %$cb;
735 767
736 while (my ($pkg, $cb) = each %$cb) { 768 while (my ($pkg, $cb) = each %$cb) {
737 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 769 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
738 and last; 770 $retval ||= $retval_;
739 771
740 if ($@) { 772 if ($@) {
741 $TERM->ungrab; # better to lose the grab than the session 773 $TERM->ungrab; # better to lose the grab than the session
742 warn $@; 774 warn $@;
743 } 775 }
901 933
902# find on_xxx subs in the package and register them 934# find on_xxx subs in the package and register them
903# as hooks 935# as hooks
904sub register_package { 936sub register_package {
905 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::;
906 944
907 my $proxy = bless { 945 my $proxy = bless {
908 _pkg => $pkg, 946 _pkg => $pkg,
909 argv => $argv, 947 argv => $argv,
910 }, $pkg; 948 }, $pkg;
1637 $self->{term}->ungrab; 1675 $self->{term}->ungrab;
1638} 1676}
1639 1677
1640=back 1678=back
1641 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
1642=head2 The C<urxvt::timer> Class 1689=head2 The C<urxvt::timer> Class
1643 1690
1644This class implements timer watchers/events. Time is represented as a 1691This class implements timer watchers/events. Time is represented as a
1645fractional number of seconds since the epoch. Example: 1692fractional number of seconds since the epoch. Example:
1646 1693

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines