| … | |
… | |
| 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 |
| … | |
… | |
| 323 | place. |
334 | place. |
| 324 | |
335 | |
| 325 | =item on_start $term |
336 | =item on_start $term |
| 326 | |
337 | |
| 327 | Called at the very end of initialisation of a new terminal, just before |
338 | Called at the very end of initialisation of a new terminal, just before |
| 328 | returning to the mainloop. |
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. |
| 329 | |
346 | |
| 330 | =item on_reset $term |
347 | =item on_reset $term |
| 331 | |
348 | |
| 332 | 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 |
| 333 | 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 |
| … | |
… | |
| 485 | C<on_key_press> additionally receives the string rxvt-unicode would |
502 | C<on_key_press> additionally receives the string rxvt-unicode would |
| 486 | output, if any, in locale-specific encoding. |
503 | output, if any, in locale-specific encoding. |
| 487 | |
504 | |
| 488 | subwindow. |
505 | subwindow. |
| 489 | |
506 | |
|
|
507 | =item on_client_message $term, $event |
|
|
508 | |
|
|
509 | =item on_wm_protocols $term, $event |
|
|
510 | |
|
|
511 | =item on_wm_delete_window $term, $event |
|
|
512 | |
|
|
513 | Called when various types of ClientMessage events are received (all with |
|
|
514 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
515 | |
| 490 | =back |
516 | =back |
| 491 | |
517 | |
| 492 | =cut |
518 | =cut |
| 493 | |
519 | |
| 494 | package urxvt; |
520 | package urxvt; |
| … | |
… | |
| 499 | use Scalar::Util (); |
525 | use Scalar::Util (); |
| 500 | use List::Util (); |
526 | use List::Util (); |
| 501 | |
527 | |
| 502 | our $VERSION = 1; |
528 | our $VERSION = 1; |
| 503 | our $TERM; |
529 | our $TERM; |
|
|
530 | our @TERM_INIT; |
|
|
531 | our @TERM_EXT; |
| 504 | our @HOOKNAME; |
532 | our @HOOKNAME; |
| 505 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
533 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
| 506 | our %OPTION; |
534 | our %OPTION; |
| 507 | |
535 | |
| 508 | our $LIBDIR; |
536 | our $LIBDIR; |
| … | |
… | |
| 529 | |
557 | |
| 530 | =item $urxvt::TERM |
558 | =item $urxvt::TERM |
| 531 | |
559 | |
| 532 | The current terminal. This variable stores the current C<urxvt::term> |
560 | The current terminal. This variable stores the current C<urxvt::term> |
| 533 | object, whenever a callback/hook is executing. |
561 | object, whenever a callback/hook is executing. |
|
|
562 | |
|
|
563 | =item @urxvt::TERM_INIT |
|
|
564 | |
|
|
565 | All coderefs in this array will be called as methods of the next newly |
|
|
566 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
567 | gets cleared before the codereferences that were in it are being executed, |
|
|
568 | so coderefs can push themselves onto it again if they so desire. |
|
|
569 | |
|
|
570 | This complements to the perl-eval commandline option, but gets executed |
|
|
571 | first. |
|
|
572 | |
|
|
573 | =item @urxvt::TERM_EXT |
|
|
574 | |
|
|
575 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
576 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
577 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
| 534 | |
578 | |
| 535 | =back |
579 | =back |
| 536 | |
580 | |
| 537 | =head2 Functions in the C<urxvt> Package |
581 | =head2 Functions in the C<urxvt> Package |
| 538 | |
582 | |
| … | |
… | |
| 660 | |
704 | |
| 661 | # load a single script into its own package, once only |
705 | # load a single script into its own package, once only |
| 662 | sub extension_package($) { |
706 | sub extension_package($) { |
| 663 | my ($path) = @_; |
707 | my ($path) = @_; |
| 664 | |
708 | |
| 665 | no strict 'refs'; |
|
|
| 666 | |
|
|
| 667 | $extension_pkg{$path} ||= do { |
709 | $extension_pkg{$path} ||= do { |
| 668 | $path =~ /([^\/\\]+)$/; |
710 | $path =~ /([^\/\\]+)$/; |
| 669 | my $pkg = $1; |
711 | my $pkg = $1; |
| 670 | $pkg =~ s/[^[:word:]]/_/g; |
712 | $pkg =~ s/[^[:word:]]/_/g; |
| 671 | $pkg = "urxvt::ext::$pkg"; |
713 | $pkg = "urxvt::ext::$pkg"; |
| … | |
… | |
| 673 | verbose 3, "loading extension '$path' into package '$pkg'"; |
715 | verbose 3, "loading extension '$path' into package '$pkg'"; |
| 674 | |
716 | |
| 675 | open my $fh, "<:raw", $path |
717 | open my $fh, "<:raw", $path |
| 676 | or die "$path: $!"; |
718 | or die "$path: $!"; |
| 677 | |
719 | |
| 678 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
| 679 | |
|
|
| 680 | my $source = |
720 | my $source = |
| 681 | "package $pkg; use strict; use utf8;\n" |
721 | "package $pkg; use strict; use utf8;\n" |
| 682 | . "#line 1 \"$path\"\n{\n" |
722 | . "#line 1 \"$path\"\n{\n" |
| 683 | . (do { local $/; <$fh> }) |
723 | . (do { local $/; <$fh> }) |
| 684 | . "\n};\n1"; |
724 | . "\n};\n1"; |
| … | |
… | |
| 700 | if ($htype == 0) { # INIT |
740 | if ($htype == 0) { # INIT |
| 701 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
741 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
| 702 | |
742 | |
| 703 | my %ext_arg; |
743 | my %ext_arg; |
| 704 | |
744 | |
|
|
745 | { |
|
|
746 | my @init = @TERM_INIT; |
|
|
747 | @TERM_INIT = (); |
|
|
748 | $_->($TERM) for @init; |
|
|
749 | my @pkg = @TERM_EXT; |
|
|
750 | @TERM_EXT = (); |
|
|
751 | $TERM->register_package ($_) for @pkg; |
|
|
752 | } |
|
|
753 | |
| 705 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
754 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
| 706 | if ($_ eq "default") { |
755 | if ($_ eq "default") { |
| 707 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
756 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
| 708 | } elsif (/^-(.*)$/) { |
757 | } elsif (/^-(.*)$/) { |
| 709 | delete $ext_arg{$1}; |
758 | delete $ext_arg{$1}; |
| 710 | } elsif (/^([^<]+)<(.*)>$/) { |
759 | } elsif (/^([^<]+)<(.*)>$/) { |
| … | |
… | |
| 735 | if $verbosity >= 10; |
784 | if $verbosity >= 10; |
| 736 | |
785 | |
| 737 | keys %$cb; |
786 | keys %$cb; |
| 738 | |
787 | |
| 739 | while (my ($pkg, $cb) = each %$cb) { |
788 | while (my ($pkg, $cb) = each %$cb) { |
| 740 | $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
789 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
|
|
790 | $retval ||= $retval_; |
| 741 | |
791 | |
| 742 | if ($@) { |
792 | if ($@) { |
| 743 | $TERM->ungrab; # better to lose the grab than the session |
793 | $TERM->ungrab; # better to lose the grab than the session |
| 744 | warn $@; |
794 | warn $@; |
| 745 | } |
795 | } |
| … | |
… | |
| 903 | |
953 | |
| 904 | # find on_xxx subs in the package and register them |
954 | # find on_xxx subs in the package and register them |
| 905 | # as hooks |
955 | # as hooks |
| 906 | sub register_package { |
956 | sub register_package { |
| 907 | my ($self, $pkg, $argv) = @_; |
957 | my ($self, $pkg, $argv) = @_; |
|
|
958 | |
|
|
959 | no strict 'refs'; |
|
|
960 | |
|
|
961 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
962 | |
|
|
963 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
| 908 | |
964 | |
| 909 | my $proxy = bless { |
965 | my $proxy = bless { |
| 910 | _pkg => $pkg, |
966 | _pkg => $pkg, |
| 911 | argv => $argv, |
967 | argv => $argv, |
| 912 | }, $pkg; |
968 | }, $pkg; |
| … | |
… | |
| 1639 | $self->{term}->ungrab; |
1695 | $self->{term}->ungrab; |
| 1640 | } |
1696 | } |
| 1641 | |
1697 | |
| 1642 | =back |
1698 | =back |
| 1643 | |
1699 | |
|
|
1700 | =cut |
|
|
1701 | |
|
|
1702 | package urxvt::watcher; |
|
|
1703 | |
|
|
1704 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1705 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1706 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1707 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1708 | |
| 1644 | =head2 The C<urxvt::timer> Class |
1709 | =head2 The C<urxvt::timer> Class |
| 1645 | |
1710 | |
| 1646 | This class implements timer watchers/events. Time is represented as a |
1711 | This class implements timer watchers/events. Time is represented as a |
| 1647 | fractional number of seconds since the epoch. Example: |
1712 | fractional number of seconds since the epoch. Example: |
| 1648 | |
1713 | |
| … | |
… | |
| 1745 | |
1810 | |
| 1746 | Stop watching for events on the given filehandle. |
1811 | Stop watching for events on the given filehandle. |
| 1747 | |
1812 | |
| 1748 | =back |
1813 | =back |
| 1749 | |
1814 | |
|
|
1815 | =head2 The C<urxvt::iw> Class |
|
|
1816 | |
|
|
1817 | This class implements idle watchers, that get called automatically when |
|
|
1818 | the process is idle. They should return as fast as possible, after doing |
|
|
1819 | some useful work. |
|
|
1820 | |
|
|
1821 | =over 4 |
|
|
1822 | |
|
|
1823 | =item $iw = new urxvt::iw |
|
|
1824 | |
|
|
1825 | Create a new idle watcher object in stopped state. |
|
|
1826 | |
|
|
1827 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1828 | |
|
|
1829 | Set the callback to be called when the watcher triggers. |
|
|
1830 | |
|
|
1831 | =item $timer = $timer->start |
|
|
1832 | |
|
|
1833 | Start the watcher. |
|
|
1834 | |
|
|
1835 | =item $timer = $timer->stop |
|
|
1836 | |
|
|
1837 | Stop the watcher. |
|
|
1838 | |
|
|
1839 | =back |
|
|
1840 | |
|
|
1841 | =head2 The C<urxvt::pw> Class |
|
|
1842 | |
|
|
1843 | This class implements process watchers. They create an event whenever a |
|
|
1844 | process exits, after which they stop automatically. |
|
|
1845 | |
|
|
1846 | my $pid = fork; |
|
|
1847 | ... |
|
|
1848 | $term->{pw} = urxvt::pw |
|
|
1849 | ->new |
|
|
1850 | ->start ($pid) |
|
|
1851 | ->cb (sub { |
|
|
1852 | my ($pw, $exit_status) = @_; |
|
|
1853 | ... |
|
|
1854 | }); |
|
|
1855 | |
|
|
1856 | =over 4 |
|
|
1857 | |
|
|
1858 | =item $pw = new urxvt::pw |
|
|
1859 | |
|
|
1860 | Create a new process watcher in stopped state. |
|
|
1861 | |
|
|
1862 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1863 | |
|
|
1864 | Set the callback to be called when the timer triggers. |
|
|
1865 | |
|
|
1866 | =item $pw = $timer->start ($pid) |
|
|
1867 | |
|
|
1868 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1869 | |
|
|
1870 | =item $pw = $pw->stop |
|
|
1871 | |
|
|
1872 | Stop the watcher. |
|
|
1873 | |
|
|
1874 | =back |
|
|
1875 | |
| 1750 | =head1 ENVIRONMENT |
1876 | =head1 ENVIRONMENT |
| 1751 | |
1877 | |
| 1752 | =head2 URXVT_PERL_VERBOSITY |
1878 | =head2 URXVT_PERL_VERBOSITY |
| 1753 | |
1879 | |
| 1754 | This variable controls the verbosity level of the perl extension. Higher |
1880 | This variable controls the verbosity level of the perl extension. Higher |
