… | |
… | |
91 | |
91 | |
92 | =item selection-popup (enabled by default) |
92 | =item selection-popup (enabled by default) |
93 | |
93 | |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
95 | text into various other formats/action (such as uri unescaping, perl |
95 | text into various other formats/action (such as uri unescaping, perl |
96 | evalution, web-browser starting etc.), depending on content. |
96 | evaluation, web-browser starting etc.), depending on content. |
97 | |
97 | |
98 | Other extensions can extend this popup menu by pushing a code reference |
98 | Other extensions can extend this popup menu by pushing a code reference |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
100 | popup is displayed. |
100 | popup is displayed. |
101 | |
101 | |
… | |
… | |
162 | |
162 | |
163 | The first line tells the selection code to treat the unchanging part of |
163 | The first line tells the selection code to treat the unchanging part of |
164 | every error message as a selection pattern, and the second line transforms |
164 | every error message as a selection pattern, and the second line transforms |
165 | the message into vi commands to load the file. |
165 | the message into vi commands to load the file. |
166 | |
166 | |
|
|
167 | =item tabbed |
|
|
168 | |
|
|
169 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
170 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
171 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
172 | button per tab. |
|
|
173 | |
|
|
174 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
175 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
176 | while B<Shift-Down> creates a new tab. |
|
|
177 | |
167 | =item mark-urls |
178 | =item mark-urls |
168 | |
179 | |
169 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
180 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
170 | make them clickable. When middle-clicked, the program specified in the |
181 | make them clickable. When middle-clicked, the program specified in the |
171 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
182 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
… | |
… | |
303 | called whenever the relevant event happens. |
314 | called whenever the relevant event happens. |
304 | |
315 | |
305 | The first argument passed to them is an extension oject as described in |
316 | The first argument passed to them is an extension oject as described in |
306 | the in the C<Extension Objects> section. |
317 | the in the C<Extension Objects> section. |
307 | |
318 | |
308 | B<All> of these hooks must return a boolean value. If it is true, then the |
319 | B<All> of these hooks must return a boolean value. If any of the called |
309 | event counts as being I<consumed>, and the invocation of other hooks is |
320 | hooks returns true, then the event counts as being I<consumed>, and the |
310 | skipped, and the relevant action might not be carried out by the C++ code. |
321 | relevant action might not be carried out by the C++ code. |
311 | |
322 | |
312 | I<< When in doubt, return a false value (preferably C<()>). >> |
323 | I<< When in doubt, return a false value (preferably C<()>). >> |
313 | |
324 | |
314 | =over 4 |
325 | =over 4 |
315 | |
326 | |
316 | =item on_init $term |
327 | =item on_init $term |
317 | |
328 | |
318 | Called after a new terminal object has been initialized, but before |
329 | Called after a new terminal object has been initialized, but before |
319 | windows are created or the command gets run. Most methods are unsafe to |
330 | windows are created or the command gets run. Most methods are unsafe to |
320 | call or deliver senseless data, as terminal size and other characteristics |
331 | call or deliver senseless data, as terminal size and other characteristics |
321 | have not yet been determined. You can safely query and change resources, |
332 | have not yet been determined. You can safely query and change resources |
322 | though. |
333 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
334 | place. |
|
|
335 | |
|
|
336 | =item on_start $term |
|
|
337 | |
|
|
338 | Called at the very end of initialisation of a new terminal, just before |
|
|
339 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
340 | |
|
|
341 | =item on_destroy $term |
|
|
342 | |
|
|
343 | Called whenever something tries to destroy terminal, before doing anything |
|
|
344 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
345 | rarely a good idea. |
323 | |
346 | |
324 | =item on_reset $term |
347 | =item on_reset $term |
325 | |
348 | |
326 | Called after the screen is "reset" for any reason, such as resizing or |
349 | Called after the screen is "reset" for any reason, such as resizing or |
327 | control sequences. Here is where you can react on changes to size-related |
350 | control sequences. Here is where you can react on changes to size-related |
328 | variables. |
351 | variables. |
329 | |
|
|
330 | =item on_start $term |
|
|
331 | |
|
|
332 | Called at the very end of initialisation of a new terminal, just before |
|
|
333 | returning to the mainloop. |
|
|
334 | |
352 | |
335 | =item on_child_start $term, $pid |
353 | =item on_child_start $term, $pid |
336 | |
354 | |
337 | Called just after the child process has been C<fork>ed. |
355 | Called just after the child process has been C<fork>ed. |
338 | |
356 | |
… | |
… | |
458 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
476 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
459 | focus out processing. |
477 | focus out processing. |
460 | |
478 | |
461 | =item on_configure_notify $term, $event |
479 | =item on_configure_notify $term, $event |
462 | |
480 | |
|
|
481 | =item on_property_notify $term, $event |
|
|
482 | |
463 | =item on_key_press $term, $event, $keysym, $octets |
483 | =item on_key_press $term, $event, $keysym, $octets |
464 | |
484 | |
465 | =item on_key_release $term, $event, $keysym |
485 | =item on_key_release $term, $event, $keysym |
466 | |
486 | |
467 | =item on_button_press $term, $event |
487 | =item on_button_press $term, $event |
… | |
… | |
483 | |
503 | |
484 | C<on_key_press> additionally receives the string rxvt-unicode would |
504 | C<on_key_press> additionally receives the string rxvt-unicode would |
485 | output, if any, in locale-specific encoding. |
505 | output, if any, in locale-specific encoding. |
486 | |
506 | |
487 | subwindow. |
507 | subwindow. |
|
|
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 | |
|
|
515 | Called when various types of ClientMessage events are received (all with |
|
|
516 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
488 | |
517 | |
489 | =back |
518 | =back |
490 | |
519 | |
491 | =cut |
520 | =cut |
492 | |
521 | |
… | |
… | |
498 | use Scalar::Util (); |
527 | use Scalar::Util (); |
499 | use List::Util (); |
528 | use List::Util (); |
500 | |
529 | |
501 | our $VERSION = 1; |
530 | our $VERSION = 1; |
502 | our $TERM; |
531 | our $TERM; |
|
|
532 | our @TERM_INIT; |
|
|
533 | our @TERM_EXT; |
503 | our @HOOKNAME; |
534 | our @HOOKNAME; |
504 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
535 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
505 | our %OPTION; |
536 | our %OPTION; |
506 | |
537 | |
507 | our $LIBDIR; |
538 | our $LIBDIR; |
… | |
… | |
528 | |
559 | |
529 | =item $urxvt::TERM |
560 | =item $urxvt::TERM |
530 | |
561 | |
531 | The current terminal. This variable stores the current C<urxvt::term> |
562 | The current terminal. This variable stores the current C<urxvt::term> |
532 | object, whenever a callback/hook is executing. |
563 | object, whenever a callback/hook is executing. |
|
|
564 | |
|
|
565 | =item @urxvt::TERM_INIT |
|
|
566 | |
|
|
567 | All coderefs in this array will be called as methods of the next newly |
|
|
568 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
569 | gets cleared before the codereferences that were in it are being executed, |
|
|
570 | so coderefs can push themselves onto it again if they so desire. |
|
|
571 | |
|
|
572 | This complements to the perl-eval commandline option, but gets executed |
|
|
573 | first. |
|
|
574 | |
|
|
575 | =item @urxvt::TERM_EXT |
|
|
576 | |
|
|
577 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
578 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
579 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
533 | |
580 | |
534 | =back |
581 | =back |
535 | |
582 | |
536 | =head2 Functions in the C<urxvt> Package |
583 | =head2 Functions in the C<urxvt> Package |
537 | |
584 | |
… | |
… | |
659 | |
706 | |
660 | # load a single script into its own package, once only |
707 | # load a single script into its own package, once only |
661 | sub extension_package($) { |
708 | sub extension_package($) { |
662 | my ($path) = @_; |
709 | my ($path) = @_; |
663 | |
710 | |
664 | no strict 'refs'; |
|
|
665 | |
|
|
666 | $extension_pkg{$path} ||= do { |
711 | $extension_pkg{$path} ||= do { |
667 | $path =~ /([^\/\\]+)$/; |
712 | $path =~ /([^\/\\]+)$/; |
668 | my $pkg = $1; |
713 | my $pkg = $1; |
669 | $pkg =~ s/[^[:word:]]/_/g; |
714 | $pkg =~ s/[^[:word:]]/_/g; |
670 | $pkg = "urxvt::ext::$pkg"; |
715 | $pkg = "urxvt::ext::$pkg"; |
… | |
… | |
672 | verbose 3, "loading extension '$path' into package '$pkg'"; |
717 | verbose 3, "loading extension '$path' into package '$pkg'"; |
673 | |
718 | |
674 | open my $fh, "<:raw", $path |
719 | open my $fh, "<:raw", $path |
675 | or die "$path: $!"; |
720 | or die "$path: $!"; |
676 | |
721 | |
677 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
678 | |
|
|
679 | my $source = |
722 | my $source = |
680 | "package $pkg; use strict; use utf8;\n" |
723 | "package $pkg; use strict; use utf8;\n" |
681 | . "#line 1 \"$path\"\n{\n" |
724 | . "#line 1 \"$path\"\n{\n" |
682 | . (do { local $/; <$fh> }) |
725 | . (do { local $/; <$fh> }) |
683 | . "\n};\n1"; |
726 | . "\n};\n1"; |
… | |
… | |
699 | if ($htype == 0) { # INIT |
742 | if ($htype == 0) { # INIT |
700 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
743 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
701 | |
744 | |
702 | my %ext_arg; |
745 | my %ext_arg; |
703 | |
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 | |
704 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
756 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
705 | if ($_ eq "default") { |
757 | if ($_ eq "default") { |
706 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
758 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
707 | } elsif (/^-(.*)$/) { |
759 | } elsif (/^-(.*)$/) { |
708 | delete $ext_arg{$1}; |
760 | delete $ext_arg{$1}; |
709 | } elsif (/^([^<]+)<(.*)>$/) { |
761 | } elsif (/^([^<]+)<(.*)>$/) { |
… | |
… | |
734 | if $verbosity >= 10; |
786 | if $verbosity >= 10; |
735 | |
787 | |
736 | keys %$cb; |
788 | keys %$cb; |
737 | |
789 | |
738 | while (my ($pkg, $cb) = each %$cb) { |
790 | while (my ($pkg, $cb) = each %$cb) { |
739 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
791 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
740 | and last; |
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 |
906 | sub register_package { |
958 | sub 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 | |
|
|
1704 | package 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 | |
1646 | This class implements timer watchers/events. Time is represented as a |
1713 | This class implements timer watchers/events. Time is represented as a |
1647 | fractional number of seconds since the epoch. Example: |
1714 | fractional number of seconds since the epoch. Example: |
1648 | |
1715 | |
… | |
… | |
1745 | |
1812 | |
1746 | Stop watching for events on the given filehandle. |
1813 | Stop watching for events on the given filehandle. |
1747 | |
1814 | |
1748 | =back |
1815 | =back |
1749 | |
1816 | |
|
|
1817 | =head2 The C<urxvt::iw> Class |
|
|
1818 | |
|
|
1819 | This class implements idle watchers, that get called automatically when |
|
|
1820 | the process is idle. They should return as fast as possible, after doing |
|
|
1821 | some useful work. |
|
|
1822 | |
|
|
1823 | =over 4 |
|
|
1824 | |
|
|
1825 | =item $iw = new urxvt::iw |
|
|
1826 | |
|
|
1827 | Create a new idle watcher object in stopped state. |
|
|
1828 | |
|
|
1829 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1830 | |
|
|
1831 | Set the callback to be called when the watcher triggers. |
|
|
1832 | |
|
|
1833 | =item $timer = $timer->start |
|
|
1834 | |
|
|
1835 | Start the watcher. |
|
|
1836 | |
|
|
1837 | =item $timer = $timer->stop |
|
|
1838 | |
|
|
1839 | Stop the watcher. |
|
|
1840 | |
|
|
1841 | =back |
|
|
1842 | |
|
|
1843 | =head2 The C<urxvt::pw> Class |
|
|
1844 | |
|
|
1845 | This class implements process watchers. They create an event whenever a |
|
|
1846 | process 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 | |
|
|
1862 | Create a new process watcher in stopped state. |
|
|
1863 | |
|
|
1864 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1865 | |
|
|
1866 | Set the callback to be called when the timer triggers. |
|
|
1867 | |
|
|
1868 | =item $pw = $timer->start ($pid) |
|
|
1869 | |
|
|
1870 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1871 | |
|
|
1872 | =item $pw = $pw->stop |
|
|
1873 | |
|
|
1874 | Stop 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 | |
1754 | This variable controls the verbosity level of the perl extension. Higher |
1882 | This variable controls the verbosity level of the perl extension. Higher |