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.112 by root, Thu Jan 19 21:02:06 2006 UTC vs.
Revision 1.118 by root, Fri Jan 20 18:50:49 2006 UTC

91 91
92=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
93 93
94Binds 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
95text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
96evalution, web-browser starting etc.), depending on content. 96evaluation, web-browser starting etc.), depending on content.
97 97
98Other extensions can extend this popup menu by pushing a code reference 98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed. 100popup is displayed.
101 101
162 162
163The first line tells the selection code to treat the unchanging part of 163The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms 164every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file. 165the message into vi commands to load the file.
166 166
167=item tabbed
168
169This transforms the terminal into a tabbar with additional terminals, that
170is, it implements what is commonly refered to as "tabbed terminal". The topmost line
171displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
172button per tab.
173
174Clicking a button will activate that tab. Pressing B<Shift-Left> and
175B<Shift-Right> will switch to the tab left or right of the current one,
176while B<Shift-Down> creates a new tab.
177
167=item mark-urls 178=item mark-urls
168 179
169Uses per-line display filtering (C<on_line_update>) to underline urls and 180Uses per-line display filtering (C<on_line_update>) to underline urls and
170make them clickable. When middle-clicked, the program specified in the 181make them clickable. When middle-clicked, the program specified in the
171resource C<urlLauncher> (default C<x-www-browser>) will be started with 182resource C<urlLauncher> (default C<x-www-browser>) will be started with
323place. 334place.
324 335
325=item on_start $term 336=item on_start $term
326 337
327Called at the very end of initialisation of a new terminal, just before 338Called at the very end of initialisation of a new terminal, just before
328returning to the mainloop. 339trying to map (display) the toplevel and returning to the mainloop.
340
341=item on_destroy $term
342
343Called whenever something tries to destroy terminal, before doing anything
344yet. If this hook returns true, then destruction is skipped, but this is
345rarely a good idea.
329 346
330=item on_reset $term 347=item on_reset $term
331 348
332Called after the screen is "reset" for any reason, such as resizing or 349Called after the screen is "reset" for any reason, such as resizing or
333control sequences. Here is where you can react on changes to size-related 350control sequences. Here is where you can react on changes to size-related
459Called wheneever the window loses keyboard focus, before rxvt-unicode does 476Called wheneever the window loses keyboard focus, before rxvt-unicode does
460focus out processing. 477focus out processing.
461 478
462=item on_configure_notify $term, $event 479=item on_configure_notify $term, $event
463 480
481=item on_property_notify $term, $event
482
464=item on_key_press $term, $event, $keysym, $octets 483=item on_key_press $term, $event, $keysym, $octets
465 484
466=item on_key_release $term, $event, $keysym 485=item on_key_release $term, $event, $keysym
467 486
468=item on_button_press $term, $event 487=item on_button_press $term, $event
484 503
485C<on_key_press> additionally receives the string rxvt-unicode would 504C<on_key_press> additionally receives the string rxvt-unicode would
486output, if any, in locale-specific encoding. 505output, if any, in locale-specific encoding.
487 506
488subwindow. 507subwindow.
508
509=item on_client_message $term, $event
510
511=item on_wm_protocols $term, $event
512
513=item on_wm_delete_window $term, $event
514
515Called when various types of ClientMessage events are received (all with
516format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
489 517
490=back 518=back
491 519
492=cut 520=cut
493 521
499use Scalar::Util (); 527use Scalar::Util ();
500use List::Util (); 528use List::Util ();
501 529
502our $VERSION = 1; 530our $VERSION = 1;
503our $TERM; 531our $TERM;
532our @TERM_INIT;
533our @TERM_EXT;
504our @HOOKNAME; 534our @HOOKNAME;
505our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 535our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
506our %OPTION; 536our %OPTION;
507 537
508our $LIBDIR; 538our $LIBDIR;
529 559
530=item $urxvt::TERM 560=item $urxvt::TERM
531 561
532The current terminal. This variable stores the current C<urxvt::term> 562The current terminal. This variable stores the current C<urxvt::term>
533object, whenever a callback/hook is executing. 563object, whenever a callback/hook is executing.
564
565=item @urxvt::TERM_INIT
566
567All coderefs in this array will be called as methods of the next newly
568created C<urxvt::term> object (during the C<on_init> phase). The array
569gets cleared before the codereferences that were in it are being executed,
570so coderefs can push themselves onto it again if they so desire.
571
572This complements to the perl-eval commandline option, but gets executed
573first.
574
575=item @urxvt::TERM_EXT
576
577Works similar to C<@TERM_INIT>, but contains perl package/class names, which
578get registered as normal extensions after calling the hooks in C<@TERM_INIT>
579but before other extensions. Gets cleared just like C<@TERM_INIT>.
534 580
535=back 581=back
536 582
537=head2 Functions in the C<urxvt> Package 583=head2 Functions in the C<urxvt> Package
538 584
660 706
661# load a single script into its own package, once only 707# load a single script into its own package, once only
662sub extension_package($) { 708sub extension_package($) {
663 my ($path) = @_; 709 my ($path) = @_;
664 710
665 no strict 'refs';
666
667 $extension_pkg{$path} ||= do { 711 $extension_pkg{$path} ||= do {
668 $path =~ /([^\/\\]+)$/; 712 $path =~ /([^\/\\]+)$/;
669 my $pkg = $1; 713 my $pkg = $1;
670 $pkg =~ s/[^[:word:]]/_/g; 714 $pkg =~ s/[^[:word:]]/_/g;
671 $pkg = "urxvt::ext::$pkg"; 715 $pkg = "urxvt::ext::$pkg";
673 verbose 3, "loading extension '$path' into package '$pkg'"; 717 verbose 3, "loading extension '$path' into package '$pkg'";
674 718
675 open my $fh, "<:raw", $path 719 open my $fh, "<:raw", $path
676 or die "$path: $!"; 720 or die "$path: $!";
677 721
678 @{"$pkg\::ISA"} = urxvt::term::extension::;
679
680 my $source = 722 my $source =
681 "package $pkg; use strict; use utf8;\n" 723 "package $pkg; use strict; use utf8;\n"
682 . "#line 1 \"$path\"\n{\n" 724 . "#line 1 \"$path\"\n{\n"
683 . (do { local $/; <$fh> }) 725 . (do { local $/; <$fh> })
684 . "\n};\n1"; 726 . "\n};\n1";
700 if ($htype == 0) { # INIT 742 if ($htype == 0) { # INIT
701 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 743 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
702 744
703 my %ext_arg; 745 my %ext_arg;
704 746
747 {
748 my @init = @TERM_INIT;
749 @TERM_INIT = ();
750 $_->($TERM) for @init;
751 my @pkg = @TERM_EXT;
752 @TERM_EXT = ();
753 $TERM->register_package ($_) for @pkg;
754 }
755
705 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 756 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
706 if ($_ eq "default") { 757 if ($_ eq "default") {
707 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 758 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
708 } elsif (/^-(.*)$/) { 759 } elsif (/^-(.*)$/) {
709 delete $ext_arg{$1}; 760 delete $ext_arg{$1};
710 } elsif (/^([^<]+)<(.*)>$/) { 761 } elsif (/^([^<]+)<(.*)>$/) {
735 if $verbosity >= 10; 786 if $verbosity >= 10;
736 787
737 keys %$cb; 788 keys %$cb;
738 789
739 while (my ($pkg, $cb) = each %$cb) { 790 while (my ($pkg, $cb) = each %$cb) {
740 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 791 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
792 $retval ||= $retval_;
741 793
742 if ($@) { 794 if ($@) {
743 $TERM->ungrab; # better to lose the grab than the session 795 $TERM->ungrab; # better to lose the grab than the session
744 warn $@; 796 warn $@;
745 } 797 }
903 955
904# find on_xxx subs in the package and register them 956# find on_xxx subs in the package and register them
905# as hooks 957# as hooks
906sub register_package { 958sub register_package {
907 my ($self, $pkg, $argv) = @_; 959 my ($self, $pkg, $argv) = @_;
960
961 no strict 'refs';
962
963 urxvt::verbose 6, "register package $pkg to $self";
964
965 @{"$pkg\::ISA"} = urxvt::term::extension::;
908 966
909 my $proxy = bless { 967 my $proxy = bless {
910 _pkg => $pkg, 968 _pkg => $pkg,
911 argv => $argv, 969 argv => $argv,
912 }, $pkg; 970 }, $pkg;
1639 $self->{term}->ungrab; 1697 $self->{term}->ungrab;
1640} 1698}
1641 1699
1642=back 1700=back
1643 1701
1702=cut
1703
1704package urxvt::watcher;
1705
1706@urxvt::timer::ISA = __PACKAGE__;
1707@urxvt::iow::ISA = __PACKAGE__;
1708@urxvt::pw::ISA = __PACKAGE__;
1709@urxvt::iw::ISA = __PACKAGE__;
1710
1644=head2 The C<urxvt::timer> Class 1711=head2 The C<urxvt::timer> Class
1645 1712
1646This class implements timer watchers/events. Time is represented as a 1713This class implements timer watchers/events. Time is represented as a
1647fractional number of seconds since the epoch. Example: 1714fractional number of seconds since the epoch. Example:
1648 1715
1745 1812
1746Stop watching for events on the given filehandle. 1813Stop watching for events on the given filehandle.
1747 1814
1748=back 1815=back
1749 1816
1817=head2 The C<urxvt::iw> Class
1818
1819This class implements idle watchers, that get called automatically when
1820the process is idle. They should return as fast as possible, after doing
1821some useful work.
1822
1823=over 4
1824
1825=item $iw = new urxvt::iw
1826
1827Create a new idle watcher object in stopped state.
1828
1829=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1830
1831Set the callback to be called when the watcher triggers.
1832
1833=item $timer = $timer->start
1834
1835Start the watcher.
1836
1837=item $timer = $timer->stop
1838
1839Stop the watcher.
1840
1841=back
1842
1843=head2 The C<urxvt::pw> Class
1844
1845This class implements process watchers. They create an event whenever a
1846process exits, after which they stop automatically.
1847
1848 my $pid = fork;
1849 ...
1850 $term->{pw} = urxvt::pw
1851 ->new
1852 ->start ($pid)
1853 ->cb (sub {
1854 my ($pw, $exit_status) = @_;
1855 ...
1856 });
1857
1858=over 4
1859
1860=item $pw = new urxvt::pw
1861
1862Create a new process watcher in stopped state.
1863
1864=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1865
1866Set the callback to be called when the timer triggers.
1867
1868=item $pw = $timer->start ($pid)
1869
1870Tells the wqtcher to start watching for process C<$pid>.
1871
1872=item $pw = $pw->stop
1873
1874Stop the watcher.
1875
1876=back
1877
1750=head1 ENVIRONMENT 1878=head1 ENVIRONMENT
1751 1879
1752=head2 URXVT_PERL_VERBOSITY 1880=head2 URXVT_PERL_VERBOSITY
1753 1881
1754This variable controls the verbosity level of the perl extension. Higher 1882This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines