1 | =encoding utf8 |
1 | =encoding utf8 |
2 | |
2 | |
3 | =head1 NAME |
3 | =head1 NAME |
4 | |
4 | |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
5 | urxvtperl - rxvt-unicode's embedded perl interpreter |
6 | |
6 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | # create a file grab_test in $HOME: |
9 | # create a file grab_test in $HOME: |
10 | |
10 | |
11 | sub on_sel_grab { |
11 | sub on_sel_grab { |
12 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
13 | () |
13 | () |
14 | } |
14 | } |
15 | |
15 | |
16 | # start a @@RXVT_NAME@@ using it: |
16 | # start a urxvt using it: |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | urxvt --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Every time a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in urxvtd, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
32 | and "perl-ext-common" resources to the empty string. |
32 | and "perl-ext-common" resources to the empty string. |
33 | |
33 | |
34 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
35 | |
35 | |
36 | A number of extensions are delivered with this release. You can find them |
36 | A number of extensions are delivered with this release. You can find them |
37 | in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be vewiwed |
37 | in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using |
38 | using F<< man urxvt-<EXTENSIONNAME> >>. |
38 | F<< man urxvt-<EXTENSIONNAME> >>. |
39 | |
39 | |
40 | You can activate them like this: |
40 | You can activate them like this: |
41 | |
41 | |
42 | @@RXVT_NAME@@ -pe <extensionname> |
42 | urxvt -pe <extensionname> |
43 | |
43 | |
44 | Or by adding them to the resource for extensions loaded by default: |
44 | Or by adding them to the resource for extensions loaded by default: |
45 | |
45 | |
46 | URxvt.perl-ext-common: default,selection-autotransform |
46 | URxvt.perl-ext-common: default,selection-autotransform |
47 | |
47 | |
48 | Extensions that add command line parameters or resources on their own are |
48 | Extensions may add resources on their own. Similarly to builtin |
49 | laoded automatically when used. |
49 | resources, these resources can also be specified on the command line |
|
|
50 | as long options (with '.' replaced by '-'), in which case the |
|
|
51 | corresponding extension is loaded automatically. |
50 | |
52 | |
51 | =head1 API DOCUMENTATION |
53 | =head1 API DOCUMENTATION |
52 | |
54 | |
53 | =head2 General API Considerations |
55 | =head2 General API Considerations |
54 | |
56 | |
… | |
… | |
103 | internal use. |
105 | internal use. |
104 | |
106 | |
105 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
107 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
106 | C<urxvt::term> class on this object. |
108 | C<urxvt::term> class on this object. |
107 | |
109 | |
108 | It has the following methods and data members: |
110 | Additional methods only supported for extension objects are described in |
109 | |
111 | the C<urxvt::extension> section below. |
110 | =over 4 |
|
|
111 | |
|
|
112 | =item $urxvt_term = $self->{term} |
|
|
113 | |
|
|
114 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
115 | extension. This member I<must not> be changed in any way. |
|
|
116 | |
|
|
117 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
118 | |
|
|
119 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
120 | this extension, replacing any previous hook. This is useful when you want |
|
|
121 | to overwrite time-critical hooks only temporarily. |
|
|
122 | |
|
|
123 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
124 | |
|
|
125 | Dynamically disable the given hooks. |
|
|
126 | |
|
|
127 | =back |
|
|
128 | |
112 | |
129 | =head2 Hooks |
113 | =head2 Hooks |
130 | |
114 | |
131 | The following subroutines can be declared in extension files, and will be |
115 | The following subroutines can be declared in extension files, and will be |
132 | called whenever the relevant event happens. |
116 | called whenever the relevant event happens. |
… | |
… | |
299 | |
283 | |
300 | =item on_refresh_end $term |
284 | =item on_refresh_end $term |
301 | |
285 | |
302 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
286 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
303 | |
287 | |
304 | =item on_user_command $term, $string |
288 | =item on_user_command $term, $string *DEPRECATED* |
305 | |
289 | |
306 | Called whenever a user-configured event is being activated (e.g. via |
290 | Called whenever a user-configured event is being activated (e.g. via |
307 | a C<perl:string> action bound to a key, see description of the B<keysym> |
291 | a C<perl:string> action bound to a key, see description of the B<keysym> |
308 | resource in the @@RXVT_NAME@@(1) manpage). |
292 | resource in the urxvt(1) manpage). |
309 | |
293 | |
310 | The event is simply the action string. This interface is assumed to change |
294 | The event is simply the action string. This interface is going away in |
311 | slightly in the future. |
295 | preference to the C<on_action> hook. |
312 | |
|
|
313 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
314 | |
|
|
315 | Called after parsing a keysym resource but before registering the |
|
|
316 | associated binding. If this hook returns TRUE the binding is not |
|
|
317 | registered. It can be used to modify a binding by calling |
|
|
318 | C<register_command>. |
|
|
319 | |
296 | |
320 | =item on_resize_all_windows $term, $new_width, $new_height |
297 | =item on_resize_all_windows $term, $new_width, $new_height |
321 | |
298 | |
322 | Called just after the new window size has been calculated, but before |
299 | Called just after the new window size has been calculated, but before |
323 | windows are actually being resized or hints are being set. If this hook |
300 | windows are actually being resized or hints are being set. If this hook |
324 | returns TRUE, setting of the window hints is being skipped. |
301 | returns a true value, setting of the window hints is being skipped. |
325 | |
302 | |
326 | =item on_x_event $term, $event |
303 | =item on_x_event $term, $event |
327 | |
304 | |
328 | Called on every X event received on the vt window (and possibly other |
305 | Called on every X event received on the vt window (and possibly other |
329 | windows). Should only be used as a last resort. Most event structure |
306 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
368 | manpage), with the additional members C<row> and C<col>, which are the |
345 | manpage), with the additional members C<row> and C<col>, which are the |
369 | (real, not screen-based) row and column under the mouse cursor. |
346 | (real, not screen-based) row and column under the mouse cursor. |
370 | |
347 | |
371 | C<on_key_press> additionally receives the string rxvt-unicode would |
348 | C<on_key_press> additionally receives the string rxvt-unicode would |
372 | output, if any, in locale-specific encoding. |
349 | output, if any, in locale-specific encoding. |
373 | |
|
|
374 | subwindow. |
|
|
375 | |
350 | |
376 | =item on_client_message $term, $event |
351 | =item on_client_message $term, $event |
377 | |
352 | |
378 | =item on_wm_protocols $term, $event |
353 | =item on_wm_protocols $term, $event |
379 | |
354 | |
… | |
… | |
582 | no warnings 'utf8'; |
557 | no warnings 'utf8'; |
583 | |
558 | |
584 | sub parse_resource { |
559 | sub parse_resource { |
585 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
560 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
586 | |
561 | |
587 | $name =~ y/-/./ if $isarg; |
|
|
588 | |
|
|
589 | $term->scan_meta; |
562 | $term->scan_extensions; |
590 | |
563 | |
591 | my $r = $term->{meta}{resource}; |
564 | my $r = $term->{meta}{resource}; |
592 | keys %$r; # reste iterator |
565 | keys %$r; # reset iterator |
593 | while (my ($pattern, $v) = each %$r) { |
566 | while (my ($k, $v) = each %$r) { |
594 | if ( |
567 | my $pattern = $k; |
|
|
568 | $pattern =~ y/./-/ if $isarg; |
|
|
569 | my $prefix = $name; |
|
|
570 | my $suffix; |
595 | $pattern =~ /\.$/ |
571 | if ($pattern =~ /\-$/) { |
596 | ? $pattern eq substr $name, 0, length $pattern |
572 | $prefix = substr $name, 0, length $pattern; |
597 | : $pattern eq $name |
573 | $suffix = substr $name, length $pattern; |
598 | ) { |
574 | } |
|
|
575 | if ($pattern eq $prefix) { |
599 | $name = "$urxvt::RESCLASS.$name"; |
576 | $name = "$urxvt::RESCLASS.$k$suffix"; |
600 | |
577 | |
601 | push @{ $term->{perl_ext_3} }, $v->[0]; |
578 | push @{ $term->{perl_ext_3} }, $v->[0]; |
602 | |
579 | |
603 | if ($v->[1] eq "boolean") { |
580 | if ($v->[1] eq "boolean") { |
604 | $term->put_option_db ($name, $flag ? "true" : "false"); |
581 | $term->put_option_db ($name, $flag ? "true" : "false"); |
… | |
… | |
614 | } |
591 | } |
615 | |
592 | |
616 | sub usage { |
593 | sub usage { |
617 | my ($term, $usage_type) = @_; |
594 | my ($term, $usage_type) = @_; |
618 | |
595 | |
619 | $term->scan_meta; |
596 | $term->scan_extensions; |
620 | |
597 | |
621 | my $r = $term->{meta}{resource}; |
598 | my $r = $term->{meta}{resource}; |
622 | |
599 | |
623 | for my $pattern (sort keys %$r) { |
600 | for my $pattern (sort keys %$r) { |
624 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
601 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
… | |
… | |
685 | # called by the rxvt core |
662 | # called by the rxvt core |
686 | sub invoke { |
663 | sub invoke { |
687 | local $TERM = shift; |
664 | local $TERM = shift; |
688 | my $htype = shift; |
665 | my $htype = shift; |
689 | |
666 | |
690 | if ($htype == 0) { # INIT |
667 | if ($htype == HOOK_INIT) { |
691 | my @dirs = $TERM->perl_libdirs; |
668 | my @dirs = $TERM->perl_libdirs; |
|
|
669 | |
|
|
670 | $TERM->scan_extensions; |
692 | |
671 | |
693 | my %ext_arg; |
672 | my %ext_arg; |
694 | |
673 | |
695 | { |
674 | { |
696 | my @init = @TERM_INIT; |
675 | my @init = @TERM_INIT; |
… | |
… | |
700 | @TERM_EXT = (); |
679 | @TERM_EXT = (); |
701 | $TERM->register_package ($_) for @pkg; |
680 | $TERM->register_package ($_) for @pkg; |
702 | } |
681 | } |
703 | |
682 | |
704 | for ( |
683 | for ( |
|
|
684 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
705 | @{ delete $TERM->{perl_ext_3} }, |
685 | @{ delete $TERM->{perl_ext_3} } |
706 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
|
|
707 | ) { |
686 | ) { |
708 | if ($_ eq "default") { |
687 | if ($_ eq "default") { |
709 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
688 | |
|
|
689 | $ext_arg{$_} = [] |
|
|
690 | for |
|
|
691 | qw(selection option-popup selection-popup readline), |
|
|
692 | map $_->[0], values %{ $TERM->{meta}{binding} }; |
|
|
693 | |
|
|
694 | for ($TERM->_keysym_resources) { |
|
|
695 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
696 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
697 | |
|
|
698 | my $ext = $1; |
|
|
699 | |
|
|
700 | $ext_arg{$ext} = []; |
|
|
701 | } |
|
|
702 | |
710 | } elsif (/^-(.*)$/) { |
703 | } elsif (/^-(.*)$/) { |
711 | delete $ext_arg{$1}; |
704 | delete $ext_arg{$1}; |
|
|
705 | |
712 | } elsif (/^([^<]+)<(.*)>$/) { |
706 | } elsif (/^([^<]+)<(.*)>$/) { |
713 | push @{ $ext_arg{$1} }, $2; |
707 | push @{ $ext_arg{$1} }, $2; |
|
|
708 | |
714 | } else { |
709 | } else { |
715 | $ext_arg{$_} ||= []; |
710 | $ext_arg{$_} ||= []; |
|
|
711 | } |
|
|
712 | } |
|
|
713 | |
|
|
714 | # now register default key bindings |
|
|
715 | for my $ext (sort keys %ext_arg) { |
|
|
716 | while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) { |
|
|
717 | $TERM->bind_action ($k, "$v->[0]:$v->[1]"); |
716 | } |
718 | } |
717 | } |
719 | } |
718 | |
720 | |
719 | for my $ext (sort keys %ext_arg) { |
721 | for my $ext (sort keys %ext_arg) { |
720 | my @files = grep -f $_, map "$_/$ext", @dirs; |
722 | my @files = grep -f $_, map "$_/$ext", @dirs; |
… | |
… | |
734 | |
736 | |
735 | if (my $cb = $TERM->{_hook}[$htype]) { |
737 | if (my $cb = $TERM->{_hook}[$htype]) { |
736 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
738 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
737 | if $verbosity >= 10; |
739 | if $verbosity >= 10; |
738 | |
740 | |
|
|
741 | if ($htype == HOOK_ACTION) { |
|
|
742 | # this hook is only sent to the extension with the name |
|
|
743 | # matching the first arg |
|
|
744 | my $pkg = shift; |
|
|
745 | $pkg =~ y/-/_/; |
|
|
746 | $pkg = "urxvt::ext::$pkg"; |
|
|
747 | |
|
|
748 | $cb = $cb->{$pkg} |
|
|
749 | or return undef; #TODO: maybe warn user? |
|
|
750 | |
|
|
751 | $cb = { $pkg => $cb }; |
|
|
752 | } |
|
|
753 | |
739 | for my $pkg (keys %$cb) { |
754 | for my $pkg (keys %$cb) { |
740 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
755 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
741 | $retval ||= $retval_; |
756 | $retval ||= $retval_; |
742 | |
757 | |
743 | if ($@) { |
758 | if ($@) { |
744 | $TERM->ungrab; # better to lose the grab than the session |
759 | $TERM->ungrab; # better to lose the grab than the session |
745 | warn $@; |
760 | warn $@; |
… | |
… | |
748 | |
763 | |
749 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
764 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
750 | if $verbosity >= 11; |
765 | if $verbosity >= 11; |
751 | } |
766 | } |
752 | |
767 | |
753 | if ($htype == 1) { # DESTROY |
768 | if ($htype == HOOK_DESTROY) { |
754 | # clear package objects |
769 | # clear package objects |
755 | %$_ = () for values %{ $TERM->{_pkg} }; |
770 | %$_ = () for values %{ $TERM->{_pkg} }; |
756 | |
771 | |
757 | # clear package |
772 | # clear package |
758 | %$TERM = (); |
773 | %$TERM = (); |
… | |
… | |
790 | ($mask, @color{qw(fg bg)}, \@failed) |
805 | ($mask, @color{qw(fg bg)}, \@failed) |
791 | } |
806 | } |
792 | |
807 | |
793 | package urxvt::term::extension; |
808 | package urxvt::term::extension; |
794 | |
809 | |
795 | sub enable { |
810 | =head2 The C<urxvt::term::extension> class |
796 | my ($self, %hook) = @_; |
|
|
797 | my $pkg = $self->{_pkg}; |
|
|
798 | |
811 | |
799 | while (my ($name, $cb) = each %hook) { |
812 | Each extension attached to a terminal object is represented by |
800 | my $htype = $HOOKTYPE{uc $name}; |
813 | a C<urxvt::term::extension> object. |
801 | defined $htype |
|
|
802 | or Carp::croak "unsupported hook type '$name'"; |
|
|
803 | |
814 | |
804 | $self->set_should_invoke ($htype, +1) |
815 | You can use these objects, which are passed to all callbacks to store any |
805 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
816 | state related to the terminal and extension instance. |
806 | |
817 | |
807 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
818 | The methods (And data members) documented below can be called on extension |
808 | } |
819 | objects, in addition to call methods documented for the <urxvt::term> |
809 | } |
820 | class. |
810 | |
821 | |
811 | sub disable { |
822 | =over 4 |
812 | my ($self, @hook) = @_; |
|
|
813 | my $pkg = $self->{_pkg}; |
|
|
814 | |
823 | |
815 | for my $name (@hook) { |
824 | =item $urxvt_term = $self->{term} |
816 | my $htype = $HOOKTYPE{uc $name}; |
|
|
817 | defined $htype |
|
|
818 | or Carp::croak "unsupported hook type '$name'"; |
|
|
819 | |
825 | |
820 | $self->set_should_invoke ($htype, -1) |
826 | Returns the C<urxvt::term> object associated with this instance of the |
821 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
827 | extension. This member I<must not> be changed in any way. |
822 | } |
828 | |
823 | } |
829 | =cut |
824 | |
830 | |
825 | our $AUTOLOAD; |
831 | our $AUTOLOAD; |
826 | |
832 | |
827 | sub AUTOLOAD { |
833 | sub AUTOLOAD { |
828 | $AUTOLOAD =~ /:([^:]+)$/ |
834 | $AUTOLOAD =~ /:([^:]+)$/ |
… | |
… | |
841 | |
847 | |
842 | sub DESTROY { |
848 | sub DESTROY { |
843 | # nop |
849 | # nop |
844 | } |
850 | } |
845 | |
851 | |
846 | # urxvt::destroy_hook |
852 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
847 | |
853 | |
848 | sub urxvt::destroy_hook::DESTROY { |
854 | sub urxvt::destroy_hook::DESTROY { |
849 | ${$_[0]}->(); |
855 | ${$_[0]}->(); |
850 | } |
856 | } |
851 | |
857 | |
852 | sub urxvt::destroy_hook(&) { |
858 | sub urxvt::destroy_hook(&) { |
853 | bless \shift, urxvt::destroy_hook:: |
859 | bless \shift, urxvt::destroy_hook:: |
854 | } |
860 | } |
|
|
861 | |
|
|
862 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
863 | |
|
|
864 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
865 | this extension, replacing any hook previously installed via C<enable> in |
|
|
866 | this extension. |
|
|
867 | |
|
|
868 | This is useful when you want to overwrite time-critical hooks only |
|
|
869 | temporarily. |
|
|
870 | |
|
|
871 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
872 | method of the C<urxvt::term> class. |
|
|
873 | |
|
|
874 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
875 | |
|
|
876 | Dynamically disable the given hooks. |
|
|
877 | |
|
|
878 | =cut |
|
|
879 | |
|
|
880 | sub enable { |
|
|
881 | my ($self, %hook) = @_; |
|
|
882 | my $pkg = $self->{_pkg}; |
|
|
883 | |
|
|
884 | while (my ($name, $cb) = each %hook) { |
|
|
885 | my $htype = $HOOKTYPE{uc $name}; |
|
|
886 | defined $htype |
|
|
887 | or Carp::croak "unsupported hook type '$name'"; |
|
|
888 | |
|
|
889 | $self->set_should_invoke ($htype, +1) |
|
|
890 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
891 | |
|
|
892 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
893 | } |
|
|
894 | } |
|
|
895 | |
|
|
896 | sub disable { |
|
|
897 | my ($self, @hook) = @_; |
|
|
898 | my $pkg = $self->{_pkg}; |
|
|
899 | |
|
|
900 | for my $name (@hook) { |
|
|
901 | my $htype = $HOOKTYPE{uc $name}; |
|
|
902 | defined $htype |
|
|
903 | or Carp::croak "unsupported hook type '$name'"; |
|
|
904 | |
|
|
905 | $self->set_should_invoke ($htype, -1) |
|
|
906 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
907 | } |
|
|
908 | } |
|
|
909 | |
|
|
910 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
911 | |
|
|
912 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
913 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
914 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
915 | are disabled again. |
|
|
916 | |
|
|
917 | =cut |
|
|
918 | |
|
|
919 | sub urxvt::extension::on_disable::DESTROY { |
|
|
920 | my $disable = shift; |
|
|
921 | |
|
|
922 | my $term = delete $disable->{""}; |
|
|
923 | |
|
|
924 | while (my ($htype, $id) = each %$disable) { |
|
|
925 | delete $term->{_hook}[$htype]{$id}; |
|
|
926 | $term->set_should_invoke ($htype, -1); |
|
|
927 | } |
|
|
928 | } |
|
|
929 | |
|
|
930 | sub on { |
|
|
931 | my ($self, %hook) = @_; |
|
|
932 | |
|
|
933 | my $term = $self->{term}; |
|
|
934 | |
|
|
935 | my %disable = ( "" => $term ); |
|
|
936 | |
|
|
937 | while (my ($name, $cb) = each %hook) { |
|
|
938 | my $htype = $HOOKTYPE{uc $name}; |
|
|
939 | defined $htype |
|
|
940 | or Carp::croak "unsupported hook type '$name'"; |
|
|
941 | |
|
|
942 | $term->set_should_invoke ($htype, +1); |
|
|
943 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
944 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
945 | } |
|
|
946 | |
|
|
947 | bless \%disable, "urxvt::extension::on_disable" |
|
|
948 | } |
|
|
949 | |
|
|
950 | =item $self->x_resource ($pattern) |
|
|
951 | |
|
|
952 | =item $self->x_resource_boolean ($pattern) |
|
|
953 | |
|
|
954 | These methods support an additional C<%> prefix when called on an |
|
|
955 | extension object - see the description of these methods in the |
|
|
956 | C<urxvt::term> class for details. |
|
|
957 | |
|
|
958 | =cut |
855 | |
959 | |
856 | sub x_resource { |
960 | sub x_resource { |
857 | my ($self, $name) = @_; |
961 | my ($self, $name) = @_; |
858 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
962 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
859 | $self->{term}->x_resource ($name) |
963 | $self->{term}->x_resource ($name) |
… | |
… | |
862 | sub x_resource_boolean { |
966 | sub x_resource_boolean { |
863 | my ($self, $name) = @_; |
967 | my ($self, $name) = @_; |
864 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
968 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
865 | $self->{term}->x_resource_boolean ($name) |
969 | $self->{term}->x_resource_boolean ($name) |
866 | } |
970 | } |
|
|
971 | |
|
|
972 | =back |
|
|
973 | |
|
|
974 | =cut |
867 | |
975 | |
868 | package urxvt::anyevent; |
976 | package urxvt::anyevent; |
869 | |
977 | |
870 | =head2 The C<urxvt::anyevent> Class |
978 | =head2 The C<urxvt::anyevent> Class |
871 | |
979 | |
… | |
… | |
990 | $ENV{URXVT_PERL_LIB}, |
1098 | $ENV{URXVT_PERL_LIB}, |
991 | "$ENV{HOME}/.urxvt/ext", |
1099 | "$ENV{HOME}/.urxvt/ext", |
992 | "$LIBDIR/perl" |
1100 | "$LIBDIR/perl" |
993 | } |
1101 | } |
994 | |
1102 | |
995 | sub scan_meta { |
1103 | # scan for available extensions and collect their metadata |
|
|
1104 | sub scan_extensions { |
996 | my ($self) = @_; |
1105 | my ($self) = @_; |
|
|
1106 | |
|
|
1107 | return if exists $self->{meta}; |
|
|
1108 | |
997 | my @libdirs = perl_libdirs $self; |
1109 | my @libdirs = perl_libdirs $self; |
998 | |
1110 | |
999 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
1111 | # return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d# |
1000 | |
1112 | |
1001 | my %meta; |
|
|
1002 | |
|
|
1003 | $self->{meta_libdirs} = join "\x00", @libdirs; |
1113 | # $self->{meta_libdirs} = join "\x00", @libdirs;#d# |
1004 | $self->{meta} = \%meta; |
1114 | $self->{meta} = \my %meta; |
1005 | |
1115 | |
|
|
1116 | # first gather extensions |
1006 | for my $dir (reverse @libdirs) { |
1117 | for my $dir (reverse @libdirs) { |
1007 | opendir my $fh, $dir |
1118 | opendir my $fh, $dir |
1008 | or next; |
1119 | or next; |
1009 | for my $ext (readdir $fh) { |
1120 | for my $ext (readdir $fh) { |
1010 | $ext ne "." |
1121 | $ext !~ /^\./ |
1011 | and $ext ne ".." |
|
|
1012 | and open my $fh, "<", "$dir/$ext" |
1122 | and open my $fh, "<", "$dir/$ext" |
1013 | or next; |
1123 | or next; |
1014 | |
1124 | |
|
|
1125 | my %ext = (dir => $dir); |
|
|
1126 | |
1015 | while (<$fh>) { |
1127 | while (<$fh>) { |
1016 | if (/^#:META:X_RESOURCE:(.*)/) { |
1128 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
1017 | my ($pattern, $type, $desc) = split /:/, $1; |
1129 | my ($pattern, $type, $desc) = split /:/, $1; |
1018 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1130 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1019 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1131 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1020 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1132 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1021 | } else { |
1133 | } else { |
1022 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
1134 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
1023 | } |
1135 | } |
|
|
1136 | } elsif (/^#:META:BINDING:(.*)/) { |
|
|
1137 | my ($keysym, $action) = split /:/, $1; |
|
|
1138 | $ext{binding}{$keysym} = [$ext, $action]; |
1024 | } elsif (/^\s*(?:#|$)/) { |
1139 | } elsif (/^\s*(?:#|$)/) { |
1025 | # skip other comments and empty lines |
1140 | # skip other comments and empty lines |
1026 | } else { |
1141 | } else { |
1027 | last; # stop parsing on first non-empty non-comment line |
1142 | last; # stop parsing on first non-empty non-comment line |
1028 | } |
1143 | } |
1029 | } |
1144 | } |
|
|
1145 | |
|
|
1146 | $meta{ext}{$ext} = \%ext; |
1030 | } |
1147 | } |
|
|
1148 | } |
|
|
1149 | |
|
|
1150 | # and now merge resources and bindings |
|
|
1151 | while (my ($k, $v) = each %{ $meta{ext} }) { |
|
|
1152 | #TODO: should check for extensions overriding each other |
|
|
1153 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
|
|
1154 | %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} }); |
1031 | } |
1155 | } |
1032 | } |
1156 | } |
1033 | |
1157 | |
1034 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1158 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1035 | |
1159 | |
… | |
… | |
1055 | } |
1179 | } |
1056 | |
1180 | |
1057 | =item $term->destroy |
1181 | =item $term->destroy |
1058 | |
1182 | |
1059 | Destroy the terminal object (close the window, free resources |
1183 | Destroy the terminal object (close the window, free resources |
1060 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1184 | etc.). Please note that urxvt will not exit as long as any event |
1061 | watchers (timers, io watchers) are still active. |
1185 | watchers (timers, io watchers) are still active. |
1062 | |
1186 | |
1063 | =item $term->exec_async ($cmd[, @args]) |
1187 | =item $term->exec_async ($cmd[, @args]) |
1064 | |
1188 | |
1065 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1189 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
… | |
… | |
1121 | |
1245 | |
1122 | Here is a likely non-exhaustive list of resource names, not all of which |
1246 | Here is a likely non-exhaustive list of resource names, not all of which |
1123 | are supported in every build, please see the source file F</src/rsinc.h> |
1247 | are supported in every build, please see the source file F</src/rsinc.h> |
1124 | to see the actual list: |
1248 | to see the actual list: |
1125 | |
1249 | |
1126 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1250 | answerbackstring backgroundPixmap backspace_key blurradius |
1127 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1251 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1128 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1252 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1129 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1253 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1130 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1254 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1131 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1255 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
… | |
… | |
1151 | Returns the X-Resource for the given pattern, excluding the program or |
1275 | Returns the X-Resource for the given pattern, excluding the program or |
1152 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1276 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1153 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1277 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1154 | resource with that pattern exists. |
1278 | resource with that pattern exists. |
1155 | |
1279 | |
1156 | Extensions that define extra resource or command line arguments also need |
1280 | Extensions that define extra resources also need to call this method |
1157 | to call this method to access their values. |
1281 | to access their values. |
1158 | |
1282 | |
1159 | If the method is called on an extension object (basically, from an |
1283 | If the method is called on an extension object (basically, from an |
1160 | extension), then the special prefix C<%.> will be replaced by the name of |
1284 | extension), then the special prefix C<%.> will be replaced by the name of |
1161 | the extension and a dot, and the lone string C<%> will be replcaed by the |
1285 | the extension and a dot, and the lone string C<%> will be replaced by the |
1162 | extension name itself. This makes it possible to code extensions so you |
1286 | extension name itself. This makes it possible to code extensions so you |
1163 | can rename them and get a new set of commandline switches and resources |
1287 | can rename them and get a new set of commandline switches and resources |
1164 | without having to change the actual code. |
1288 | without having to change the actual code. |
1165 | |
1289 | |
1166 | This method should only be called during the C<on_start> hook, as there is |
1290 | This method should only be called during the C<on_start> hook, as there is |
… | |
… | |
1181 | my $res = &x_resource; |
1305 | my $res = &x_resource; |
1182 | |
1306 | |
1183 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1307 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1184 | } |
1308 | } |
1185 | |
1309 | |
1186 | =item $success = $term->parse_keysym ($key, $octets) |
1310 | =item $success = $term->bind_action ($key, $octets) |
1187 | |
1311 | |
1188 | Adds a key binding exactly as specified via a resource. See the |
1312 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1189 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1313 | C<keysym> resource in the urxvt(1) manpage. |
1190 | |
|
|
1191 | =item $term->register_command ($keysym, $modifiermask, $string) |
|
|
1192 | |
|
|
1193 | Adds a key binding. This is a lower level api compared to |
|
|
1194 | C<parse_keysym>, as it expects a parsed key description, and can be |
|
|
1195 | used only inside either the C<on_init> hook, to add a binding, or the |
|
|
1196 | C<on_register_command> hook, to modify a parsed binding. |
|
|
1197 | |
1314 | |
1198 | =item $rend = $term->rstyle ([$new_rstyle]) |
1315 | =item $rend = $term->rstyle ([$new_rstyle]) |
1199 | |
1316 | |
1200 | Return and optionally change the current rendition. Text that is output by |
1317 | Return and optionally change the current rendition. Text that is output by |
1201 | the terminal application will use this style. |
1318 | the terminal application will use this style. |
… | |
… | |
1381 | =item $term->tt_write ($octets) |
1498 | =item $term->tt_write ($octets) |
1382 | |
1499 | |
1383 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1500 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1384 | pass characters instead of octets, you should convert your strings first |
1501 | pass characters instead of octets, you should convert your strings first |
1385 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1502 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1503 | |
|
|
1504 | =item $term->tt_write_user_input ($octets) |
|
|
1505 | |
|
|
1506 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1507 | the user pressing a key, to invoke the additional actions requested by |
|
|
1508 | the user for that case (C<tt_write> doesn't do that). |
|
|
1509 | |
|
|
1510 | The typical use case would be inside C<on_action> hooks. |
1386 | |
1511 | |
1387 | =item $term->tt_paste ($octets) |
1512 | =item $term->tt_paste ($octets) |
1388 | |
1513 | |
1389 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1514 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1390 | CR and bracketing the data with control sequences if bracketed paste mode |
1515 | CR and bracketing the data with control sequences if bracketed paste mode |
… | |
… | |
1624 | } |
1749 | } |
1625 | |
1750 | |
1626 | sub urxvt::line::t { |
1751 | sub urxvt::line::t { |
1627 | my ($self) = @_; |
1752 | my ($self) = @_; |
1628 | |
1753 | |
1629 | if (@_ > 1) |
1754 | if (@_ > 1) { |
1630 | { |
|
|
1631 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1755 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1632 | for $self->{beg} .. $self->{end}; |
1756 | for $self->{beg} .. $self->{end}; |
1633 | } |
1757 | } |
1634 | |
1758 | |
1635 | defined wantarray && |
1759 | defined wantarray && |
1636 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1760 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1637 | 0, $self->{len} |
1761 | 0, $self->{len} |
1638 | } |
1762 | } |
1639 | |
1763 | |
1640 | sub urxvt::line::r { |
1764 | sub urxvt::line::r { |
1641 | my ($self) = @_; |
1765 | my ($self) = @_; |
1642 | |
1766 | |
1643 | if (@_ > 1) |
1767 | if (@_ > 1) { |
1644 | { |
|
|
1645 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1768 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1646 | for $self->{beg} .. $self->{end}; |
1769 | for $self->{beg} .. $self->{end}; |
1647 | } |
1770 | } |
1648 | |
1771 | |
1649 | if (defined wantarray) { |
1772 | if (defined wantarray) { |
1650 | my $rend = [ |
1773 | my $rend = [ |
1651 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1774 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1652 | ]; |
1775 | ]; |