| … | |
… | |
| 323 | place. |
323 | place. |
| 324 | |
324 | |
| 325 | =item on_start $term |
325 | =item on_start $term |
| 326 | |
326 | |
| 327 | Called at the very end of initialisation of a new terminal, just before |
327 | Called at the very end of initialisation of a new terminal, just before |
| 328 | returning to the mainloop. |
328 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
329 | |
|
|
330 | =item on_destroy $term |
|
|
331 | |
|
|
332 | Called whenever something tries to destroy terminal, before doing anything |
|
|
333 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
334 | rarely a good idea. |
| 329 | |
335 | |
| 330 | =item on_reset $term |
336 | =item on_reset $term |
| 331 | |
337 | |
| 332 | Called after the screen is "reset" for any reason, such as resizing or |
338 | 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 |
339 | 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 |
491 | C<on_key_press> additionally receives the string rxvt-unicode would |
| 486 | output, if any, in locale-specific encoding. |
492 | output, if any, in locale-specific encoding. |
| 487 | |
493 | |
| 488 | subwindow. |
494 | subwindow. |
| 489 | |
495 | |
|
|
496 | =item on_client_message $term, $event |
|
|
497 | |
|
|
498 | =item on_wm_protocols $term, $event |
|
|
499 | |
|
|
500 | =item on_wm_delete_window $term, $event |
|
|
501 | |
|
|
502 | Called when various types of ClientMessage events are received (all with |
|
|
503 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
504 | |
| 490 | =back |
505 | =back |
| 491 | |
506 | |
| 492 | =cut |
507 | =cut |
| 493 | |
508 | |
| 494 | package urxvt; |
509 | package urxvt; |
| … | |
… | |
| 499 | use Scalar::Util (); |
514 | use Scalar::Util (); |
| 500 | use List::Util (); |
515 | use List::Util (); |
| 501 | |
516 | |
| 502 | our $VERSION = 1; |
517 | our $VERSION = 1; |
| 503 | our $TERM; |
518 | our $TERM; |
|
|
519 | our @TERM_INIT; |
|
|
520 | our @TERM_EXT; |
| 504 | our @HOOKNAME; |
521 | our @HOOKNAME; |
| 505 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
522 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
| 506 | our %OPTION; |
523 | our %OPTION; |
| 507 | |
524 | |
| 508 | our $LIBDIR; |
525 | our $LIBDIR; |
| … | |
… | |
| 529 | |
546 | |
| 530 | =item $urxvt::TERM |
547 | =item $urxvt::TERM |
| 531 | |
548 | |
| 532 | The current terminal. This variable stores the current C<urxvt::term> |
549 | The current terminal. This variable stores the current C<urxvt::term> |
| 533 | object, whenever a callback/hook is executing. |
550 | object, whenever a callback/hook is executing. |
|
|
551 | |
|
|
552 | =item @urxvt::TERM_INIT |
|
|
553 | |
|
|
554 | All coderefs in this array will be called as methods of the next newly |
|
|
555 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
556 | gets cleared before the codereferences that were in it are being executed, |
|
|
557 | so coderefs can push themselves onto it again if they so desire. |
|
|
558 | |
|
|
559 | This complements to the perl-eval commandline option, but gets executed |
|
|
560 | first. |
|
|
561 | |
|
|
562 | =item @urxvt::TERM_EXT |
|
|
563 | |
|
|
564 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
565 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
566 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
| 534 | |
567 | |
| 535 | =back |
568 | =back |
| 536 | |
569 | |
| 537 | =head2 Functions in the C<urxvt> Package |
570 | =head2 Functions in the C<urxvt> Package |
| 538 | |
571 | |
| … | |
… | |
| 660 | |
693 | |
| 661 | # load a single script into its own package, once only |
694 | # load a single script into its own package, once only |
| 662 | sub extension_package($) { |
695 | sub extension_package($) { |
| 663 | my ($path) = @_; |
696 | my ($path) = @_; |
| 664 | |
697 | |
| 665 | no strict 'refs'; |
|
|
| 666 | |
|
|
| 667 | $extension_pkg{$path} ||= do { |
698 | $extension_pkg{$path} ||= do { |
| 668 | $path =~ /([^\/\\]+)$/; |
699 | $path =~ /([^\/\\]+)$/; |
| 669 | my $pkg = $1; |
700 | my $pkg = $1; |
| 670 | $pkg =~ s/[^[:word:]]/_/g; |
701 | $pkg =~ s/[^[:word:]]/_/g; |
| 671 | $pkg = "urxvt::ext::$pkg"; |
702 | $pkg = "urxvt::ext::$pkg"; |
| … | |
… | |
| 673 | verbose 3, "loading extension '$path' into package '$pkg'"; |
704 | verbose 3, "loading extension '$path' into package '$pkg'"; |
| 674 | |
705 | |
| 675 | open my $fh, "<:raw", $path |
706 | open my $fh, "<:raw", $path |
| 676 | or die "$path: $!"; |
707 | or die "$path: $!"; |
| 677 | |
708 | |
| 678 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
| 679 | |
|
|
| 680 | my $source = |
709 | my $source = |
| 681 | "package $pkg; use strict; use utf8;\n" |
710 | "package $pkg; use strict; use utf8;\n" |
| 682 | . "#line 1 \"$path\"\n{\n" |
711 | . "#line 1 \"$path\"\n{\n" |
| 683 | . (do { local $/; <$fh> }) |
712 | . (do { local $/; <$fh> }) |
| 684 | . "\n};\n1"; |
713 | . "\n};\n1"; |
| … | |
… | |
| 700 | if ($htype == 0) { # INIT |
729 | if ($htype == 0) { # INIT |
| 701 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
730 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
| 702 | |
731 | |
| 703 | my %ext_arg; |
732 | my %ext_arg; |
| 704 | |
733 | |
|
|
734 | { |
|
|
735 | my @init = @TERM_INIT; |
|
|
736 | @TERM_INIT = (); |
|
|
737 | $_->($TERM) for @init; |
|
|
738 | my @pkg = @TERM_EXT; |
|
|
739 | @TERM_EXT = (); |
|
|
740 | $TERM->register_package ($_) for @pkg; |
|
|
741 | } |
|
|
742 | |
| 705 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
743 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
| 706 | if ($_ eq "default") { |
744 | if ($_ eq "default") { |
| 707 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
745 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
| 708 | } elsif (/^-(.*)$/) { |
746 | } elsif (/^-(.*)$/) { |
| 709 | delete $ext_arg{$1}; |
747 | delete $ext_arg{$1}; |
| 710 | } elsif (/^([^<]+)<(.*)>$/) { |
748 | } elsif (/^([^<]+)<(.*)>$/) { |
| … | |
… | |
| 735 | if $verbosity >= 10; |
773 | if $verbosity >= 10; |
| 736 | |
774 | |
| 737 | keys %$cb; |
775 | keys %$cb; |
| 738 | |
776 | |
| 739 | while (my ($pkg, $cb) = each %$cb) { |
777 | while (my ($pkg, $cb) = each %$cb) { |
| 740 | $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
778 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
|
|
779 | $retval ||= $retval_; |
| 741 | |
780 | |
| 742 | if ($@) { |
781 | if ($@) { |
| 743 | $TERM->ungrab; # better to lose the grab than the session |
782 | $TERM->ungrab; # better to lose the grab than the session |
| 744 | warn $@; |
783 | warn $@; |
| 745 | } |
784 | } |
| … | |
… | |
| 903 | |
942 | |
| 904 | # find on_xxx subs in the package and register them |
943 | # find on_xxx subs in the package and register them |
| 905 | # as hooks |
944 | # as hooks |
| 906 | sub register_package { |
945 | sub register_package { |
| 907 | my ($self, $pkg, $argv) = @_; |
946 | my ($self, $pkg, $argv) = @_; |
|
|
947 | |
|
|
948 | no strict 'refs'; |
|
|
949 | |
|
|
950 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
951 | |
|
|
952 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
| 908 | |
953 | |
| 909 | my $proxy = bless { |
954 | my $proxy = bless { |
| 910 | _pkg => $pkg, |
955 | _pkg => $pkg, |
| 911 | argv => $argv, |
956 | argv => $argv, |
| 912 | }, $pkg; |
957 | }, $pkg; |
| … | |
… | |
| 1639 | $self->{term}->ungrab; |
1684 | $self->{term}->ungrab; |
| 1640 | } |
1685 | } |
| 1641 | |
1686 | |
| 1642 | =back |
1687 | =back |
| 1643 | |
1688 | |
|
|
1689 | =cut |
|
|
1690 | |
|
|
1691 | package urxvt::watcher; |
|
|
1692 | |
|
|
1693 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1694 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1695 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1696 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1697 | |
| 1644 | =head2 The C<urxvt::timer> Class |
1698 | =head2 The C<urxvt::timer> Class |
| 1645 | |
1699 | |
| 1646 | This class implements timer watchers/events. Time is represented as a |
1700 | This class implements timer watchers/events. Time is represented as a |
| 1647 | fractional number of seconds since the epoch. Example: |
1701 | fractional number of seconds since the epoch. Example: |
| 1648 | |
1702 | |
| … | |
… | |
| 1745 | |
1799 | |
| 1746 | Stop watching for events on the given filehandle. |
1800 | Stop watching for events on the given filehandle. |
| 1747 | |
1801 | |
| 1748 | =back |
1802 | =back |
| 1749 | |
1803 | |
|
|
1804 | =head2 The C<urxvt::iw> Class |
|
|
1805 | |
|
|
1806 | This class implements idle watchers, that get called automatically when |
|
|
1807 | the process is idle. They should return as fast as possible, after doing |
|
|
1808 | some useful work. |
|
|
1809 | |
|
|
1810 | =over 4 |
|
|
1811 | |
|
|
1812 | =item $iw = new urxvt::iw |
|
|
1813 | |
|
|
1814 | Create a new idle watcher object in stopped state. |
|
|
1815 | |
|
|
1816 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1817 | |
|
|
1818 | Set the callback to be called when the watcher triggers. |
|
|
1819 | |
|
|
1820 | =item $timer = $timer->start |
|
|
1821 | |
|
|
1822 | Start the watcher. |
|
|
1823 | |
|
|
1824 | =item $timer = $timer->stop |
|
|
1825 | |
|
|
1826 | Stop the watcher. |
|
|
1827 | |
|
|
1828 | =back |
|
|
1829 | |
|
|
1830 | =head2 The C<urxvt::pw> Class |
|
|
1831 | |
|
|
1832 | This class implements process watchers. They create an event whenever a |
|
|
1833 | process exits, after which they stop automatically. |
|
|
1834 | |
|
|
1835 | my $pid = fork; |
|
|
1836 | ... |
|
|
1837 | $term->{pw} = urxvt::pw |
|
|
1838 | ->new |
|
|
1839 | ->start ($pid) |
|
|
1840 | ->cb (sub { |
|
|
1841 | my ($pw, $exit_status) = @_; |
|
|
1842 | ... |
|
|
1843 | }); |
|
|
1844 | |
|
|
1845 | =over 4 |
|
|
1846 | |
|
|
1847 | =item $pw = new urxvt::pw |
|
|
1848 | |
|
|
1849 | Create a new process watcher in stopped state. |
|
|
1850 | |
|
|
1851 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1852 | |
|
|
1853 | Set the callback to be called when the timer triggers. |
|
|
1854 | |
|
|
1855 | =item $pw = $timer->start ($pid) |
|
|
1856 | |
|
|
1857 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1858 | |
|
|
1859 | =item $pw = $pw->stop |
|
|
1860 | |
|
|
1861 | Stop the watcher. |
|
|
1862 | |
|
|
1863 | =back |
|
|
1864 | |
| 1750 | =head1 ENVIRONMENT |
1865 | =head1 ENVIRONMENT |
| 1751 | |
1866 | |
| 1752 | =head2 URXVT_PERL_VERBOSITY |
1867 | =head2 URXVT_PERL_VERBOSITY |
| 1753 | |
1868 | |
| 1754 | This variable controls the verbosity level of the perl extension. Higher |
1869 | This variable controls the verbosity level of the perl extension. Higher |
