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 viewed |
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 | |
… | |
… | |
103 | internal use. |
103 | internal use. |
104 | |
104 | |
105 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
105 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
106 | C<urxvt::term> class on this object. |
106 | C<urxvt::term> class on this object. |
107 | |
107 | |
108 | It has the following methods and data members: |
108 | Additional methods only supported for extension objects are described in |
109 | |
109 | 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 | |
110 | |
129 | =head2 Hooks |
111 | =head2 Hooks |
130 | |
112 | |
131 | The following subroutines can be declared in extension files, and will be |
113 | The following subroutines can be declared in extension files, and will be |
132 | called whenever the relevant event happens. |
114 | called whenever the relevant event happens. |
… | |
… | |
299 | |
281 | |
300 | =item on_refresh_end $term |
282 | =item on_refresh_end $term |
301 | |
283 | |
302 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
284 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
303 | |
285 | |
304 | =item on_user_command $term, $string |
286 | =item on_user_command $term, $string *DEPRECATED* |
305 | |
287 | |
306 | Called whenever a user-configured event is being activated (e.g. via |
288 | 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> |
289 | a C<perl:string> action bound to a key, see description of the B<keysym> |
308 | resource in the @@RXVT_NAME@@(1) manpage). |
290 | resource in the urxvt(1) manpage). |
309 | |
291 | |
310 | The event is simply the action string. This interface is assumed to change |
292 | The event is simply the action string. This interface is going away in |
311 | slightly in the future. |
293 | 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 | |
294 | |
320 | =item on_resize_all_windows $term, $new_width, $new_height |
295 | =item on_resize_all_windows $term, $new_width, $new_height |
321 | |
296 | |
322 | Called just after the new window size has been calculated, but before |
297 | 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 |
298 | windows are actually being resized or hints are being set. If this hook |
324 | returns TRUE, setting of the window hints is being skipped. |
299 | returns a true value, setting of the window hints is being skipped. |
325 | |
300 | |
326 | =item on_x_event $term, $event |
301 | =item on_x_event $term, $event |
327 | |
302 | |
328 | Called on every X event received on the vt window (and possibly other |
303 | 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 |
304 | 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 |
343 | 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. |
344 | (real, not screen-based) row and column under the mouse cursor. |
370 | |
345 | |
371 | C<on_key_press> additionally receives the string rxvt-unicode would |
346 | C<on_key_press> additionally receives the string rxvt-unicode would |
372 | output, if any, in locale-specific encoding. |
347 | output, if any, in locale-specific encoding. |
373 | |
|
|
374 | subwindow. |
|
|
375 | |
348 | |
376 | =item on_client_message $term, $event |
349 | =item on_client_message $term, $event |
377 | |
350 | |
378 | =item on_wm_protocols $term, $event |
351 | =item on_wm_protocols $term, $event |
379 | |
352 | |
… | |
… | |
584 | sub parse_resource { |
557 | sub parse_resource { |
585 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
558 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
586 | |
559 | |
587 | $name =~ y/-/./ if $isarg; |
560 | $name =~ y/-/./ if $isarg; |
588 | |
561 | |
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 ($pattern, $v) = each %$r) { |
594 | if ( |
567 | if ( |
595 | $pattern =~ /\.$/ |
568 | $pattern =~ /\.$/ |
596 | ? $pattern eq substr $name, 0, length $pattern |
569 | ? $pattern eq substr $name, 0, length $pattern |
597 | : $pattern eq $name |
570 | : $pattern eq $name |
… | |
… | |
614 | } |
587 | } |
615 | |
588 | |
616 | sub usage { |
589 | sub usage { |
617 | my ($term, $usage_type) = @_; |
590 | my ($term, $usage_type) = @_; |
618 | |
591 | |
619 | $term->scan_meta; |
592 | $term->scan_extensions; |
620 | |
593 | |
621 | my $r = $term->{meta}{resource}; |
594 | my $r = $term->{meta}{resource}; |
622 | |
595 | |
623 | for my $pattern (sort keys %$r) { |
596 | for my $pattern (sort keys %$r) { |
624 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
597 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
… | |
… | |
685 | # called by the rxvt core |
658 | # called by the rxvt core |
686 | sub invoke { |
659 | sub invoke { |
687 | local $TERM = shift; |
660 | local $TERM = shift; |
688 | my $htype = shift; |
661 | my $htype = shift; |
689 | |
662 | |
690 | if ($htype == 0) { # INIT |
663 | if ($htype == HOOK_INIT) { |
691 | my @dirs = $TERM->perl_libdirs; |
664 | my @dirs = $TERM->perl_libdirs; |
|
|
665 | |
|
|
666 | $TERM->scan_extensions; |
692 | |
667 | |
693 | my %ext_arg; |
668 | my %ext_arg; |
694 | |
669 | |
695 | { |
670 | { |
696 | my @init = @TERM_INIT; |
671 | my @init = @TERM_INIT; |
… | |
… | |
734 | |
709 | |
735 | if (my $cb = $TERM->{_hook}[$htype]) { |
710 | if (my $cb = $TERM->{_hook}[$htype]) { |
736 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
711 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
737 | if $verbosity >= 10; |
712 | if $verbosity >= 10; |
738 | |
713 | |
|
|
714 | if ($htype == HOOK_ACTION) { |
|
|
715 | # this hook is only sent to the extension with the name |
|
|
716 | # matching the first arg |
|
|
717 | my $pkg = shift; |
|
|
718 | $pkg =~ y/-/_/; |
|
|
719 | $pkg = "urxvt::ext::$pkg"; |
|
|
720 | |
|
|
721 | $cb = $cb->{$pkg} |
|
|
722 | or return undef; #TODO: maybe warn user? |
|
|
723 | |
|
|
724 | $cb = { $pkg => $cb }; |
|
|
725 | } |
|
|
726 | |
739 | for my $pkg (keys %$cb) { |
727 | for my $pkg (keys %$cb) { |
740 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
728 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
741 | $retval ||= $retval_; |
729 | $retval ||= $retval_; |
742 | |
730 | |
743 | if ($@) { |
731 | if ($@) { |
744 | $TERM->ungrab; # better to lose the grab than the session |
732 | $TERM->ungrab; # better to lose the grab than the session |
745 | warn $@; |
733 | warn $@; |
… | |
… | |
748 | |
736 | |
749 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
737 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
750 | if $verbosity >= 11; |
738 | if $verbosity >= 11; |
751 | } |
739 | } |
752 | |
740 | |
753 | if ($htype == 1) { # DESTROY |
741 | if ($htype == HOOK_DESTROY) { |
754 | # clear package objects |
742 | # clear package objects |
755 | %$_ = () for values %{ $TERM->{_pkg} }; |
743 | %$_ = () for values %{ $TERM->{_pkg} }; |
756 | |
744 | |
757 | # clear package |
745 | # clear package |
758 | %$TERM = (); |
746 | %$TERM = (); |
… | |
… | |
790 | ($mask, @color{qw(fg bg)}, \@failed) |
778 | ($mask, @color{qw(fg bg)}, \@failed) |
791 | } |
779 | } |
792 | |
780 | |
793 | package urxvt::term::extension; |
781 | package urxvt::term::extension; |
794 | |
782 | |
795 | sub enable { |
783 | =head2 The C<urxvt::term::extension> class |
796 | my ($self, %hook) = @_; |
|
|
797 | my $pkg = $self->{_pkg}; |
|
|
798 | |
784 | |
799 | while (my ($name, $cb) = each %hook) { |
785 | Each extension attached to a terminal object is represented by |
800 | my $htype = $HOOKTYPE{uc $name}; |
786 | a C<urxvt::term::extension> object. |
801 | defined $htype |
|
|
802 | or Carp::croak "unsupported hook type '$name'"; |
|
|
803 | |
787 | |
804 | $self->set_should_invoke ($htype, +1) |
788 | You can use these objects, which are passed to all callbacks to store any |
805 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
789 | state related to the terminal and extension instance. |
806 | |
790 | |
807 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
791 | The methods (And data members) documented below can be called on extension |
808 | } |
792 | objects, in addition to call methods documented for the <urxvt::term> |
809 | } |
793 | class. |
810 | |
794 | |
811 | sub disable { |
795 | =over 4 |
812 | my ($self, @hook) = @_; |
|
|
813 | my $pkg = $self->{_pkg}; |
|
|
814 | |
796 | |
815 | for my $name (@hook) { |
797 | =item $urxvt_term = $self->{term} |
816 | my $htype = $HOOKTYPE{uc $name}; |
|
|
817 | defined $htype |
|
|
818 | or Carp::croak "unsupported hook type '$name'"; |
|
|
819 | |
798 | |
820 | $self->set_should_invoke ($htype, -1) |
799 | Returns the C<urxvt::term> object associated with this instance of the |
821 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
800 | extension. This member I<must not> be changed in any way. |
822 | } |
801 | |
823 | } |
802 | =cut |
824 | |
803 | |
825 | our $AUTOLOAD; |
804 | our $AUTOLOAD; |
826 | |
805 | |
827 | sub AUTOLOAD { |
806 | sub AUTOLOAD { |
828 | $AUTOLOAD =~ /:([^:]+)$/ |
807 | $AUTOLOAD =~ /:([^:]+)$/ |
… | |
… | |
841 | |
820 | |
842 | sub DESTROY { |
821 | sub DESTROY { |
843 | # nop |
822 | # nop |
844 | } |
823 | } |
845 | |
824 | |
846 | # urxvt::destroy_hook |
825 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
847 | |
826 | |
848 | sub urxvt::destroy_hook::DESTROY { |
827 | sub urxvt::destroy_hook::DESTROY { |
849 | ${$_[0]}->(); |
828 | ${$_[0]}->(); |
850 | } |
829 | } |
851 | |
830 | |
852 | sub urxvt::destroy_hook(&) { |
831 | sub urxvt::destroy_hook(&) { |
853 | bless \shift, urxvt::destroy_hook:: |
832 | bless \shift, urxvt::destroy_hook:: |
854 | } |
833 | } |
|
|
834 | |
|
|
835 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
836 | |
|
|
837 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
838 | this extension, replacing any hook previously installed via C<enable> in |
|
|
839 | this extension. |
|
|
840 | |
|
|
841 | This is useful when you want to overwrite time-critical hooks only |
|
|
842 | temporarily. |
|
|
843 | |
|
|
844 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
845 | method of the C<urxvt::term> class. |
|
|
846 | |
|
|
847 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
848 | |
|
|
849 | Dynamically disable the given hooks. |
|
|
850 | |
|
|
851 | =cut |
|
|
852 | |
|
|
853 | sub enable { |
|
|
854 | my ($self, %hook) = @_; |
|
|
855 | my $pkg = $self->{_pkg}; |
|
|
856 | |
|
|
857 | while (my ($name, $cb) = each %hook) { |
|
|
858 | my $htype = $HOOKTYPE{uc $name}; |
|
|
859 | defined $htype |
|
|
860 | or Carp::croak "unsupported hook type '$name'"; |
|
|
861 | |
|
|
862 | $self->set_should_invoke ($htype, +1) |
|
|
863 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
864 | |
|
|
865 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
866 | } |
|
|
867 | } |
|
|
868 | |
|
|
869 | sub disable { |
|
|
870 | my ($self, @hook) = @_; |
|
|
871 | my $pkg = $self->{_pkg}; |
|
|
872 | |
|
|
873 | for my $name (@hook) { |
|
|
874 | my $htype = $HOOKTYPE{uc $name}; |
|
|
875 | defined $htype |
|
|
876 | or Carp::croak "unsupported hook type '$name'"; |
|
|
877 | |
|
|
878 | $self->set_should_invoke ($htype, -1) |
|
|
879 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
880 | } |
|
|
881 | } |
|
|
882 | |
|
|
883 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
884 | |
|
|
885 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
886 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
887 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
888 | are disabled again. |
|
|
889 | |
|
|
890 | =cut |
|
|
891 | |
|
|
892 | sub urxvt::extension::on_disable::DESTROY { |
|
|
893 | my $disable = shift; |
|
|
894 | |
|
|
895 | my $term = delete $disable->{""}; |
|
|
896 | |
|
|
897 | while (my ($htype, $id) = each %$disable) { |
|
|
898 | delete $term->{_hook}[$htype]{$id}; |
|
|
899 | $term->set_should_invoke ($htype, -1); |
|
|
900 | } |
|
|
901 | } |
|
|
902 | |
|
|
903 | sub on { |
|
|
904 | my ($self, %hook) = @_; |
|
|
905 | |
|
|
906 | my $term = $self->{term}; |
|
|
907 | |
|
|
908 | my %disable = ( "" => $term ); |
|
|
909 | |
|
|
910 | while (my ($name, $cb) = each %hook) { |
|
|
911 | my $htype = $HOOKTYPE{uc $name}; |
|
|
912 | defined $htype |
|
|
913 | or Carp::croak "unsupported hook type '$name'"; |
|
|
914 | |
|
|
915 | $term->set_should_invoke ($htype, +1); |
|
|
916 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
917 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
918 | } |
|
|
919 | |
|
|
920 | bless \%disable, "urxvt::extension::on_disable" |
|
|
921 | } |
|
|
922 | |
|
|
923 | =item $self->x_resource ($pattern) |
|
|
924 | |
|
|
925 | =item $self->x_resource_boolean ($pattern) |
|
|
926 | |
|
|
927 | These methods support an additional C<%> prefix when called on an |
|
|
928 | extension object - see the description of these methods in the |
|
|
929 | C<urxvt::term> class for details. |
|
|
930 | |
|
|
931 | =cut |
855 | |
932 | |
856 | sub x_resource { |
933 | sub x_resource { |
857 | my ($self, $name) = @_; |
934 | my ($self, $name) = @_; |
858 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
935 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
859 | $self->{term}->x_resource ($name) |
936 | $self->{term}->x_resource ($name) |
… | |
… | |
862 | sub x_resource_boolean { |
939 | sub x_resource_boolean { |
863 | my ($self, $name) = @_; |
940 | my ($self, $name) = @_; |
864 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
941 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
865 | $self->{term}->x_resource_boolean ($name) |
942 | $self->{term}->x_resource_boolean ($name) |
866 | } |
943 | } |
|
|
944 | |
|
|
945 | =back |
|
|
946 | |
|
|
947 | =cut |
867 | |
948 | |
868 | package urxvt::anyevent; |
949 | package urxvt::anyevent; |
869 | |
950 | |
870 | =head2 The C<urxvt::anyevent> Class |
951 | =head2 The C<urxvt::anyevent> Class |
871 | |
952 | |
… | |
… | |
990 | $ENV{URXVT_PERL_LIB}, |
1071 | $ENV{URXVT_PERL_LIB}, |
991 | "$ENV{HOME}/.urxvt/ext", |
1072 | "$ENV{HOME}/.urxvt/ext", |
992 | "$LIBDIR/perl" |
1073 | "$LIBDIR/perl" |
993 | } |
1074 | } |
994 | |
1075 | |
995 | sub scan_meta { |
1076 | # scan for available extensions and collect their metadata |
|
|
1077 | sub scan_extensions { |
996 | my ($self) = @_; |
1078 | my ($self) = @_; |
|
|
1079 | |
|
|
1080 | return if exists $self->{meta}; |
|
|
1081 | |
997 | my @libdirs = perl_libdirs $self; |
1082 | my @libdirs = perl_libdirs $self; |
998 | |
1083 | |
999 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
1084 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
1000 | |
1085 | |
1001 | my %meta; |
1086 | my %meta; |
1002 | |
1087 | |
1003 | $self->{meta_libdirs} = join "\x00", @libdirs; |
1088 | $self->{meta_libdirs} = join "\x00", @libdirs; |
1004 | $self->{meta} = \%meta; |
1089 | $self->{meta} = \%meta; |
1005 | |
1090 | |
|
|
1091 | my %ext; |
|
|
1092 | |
|
|
1093 | # first gather extensions |
1006 | for my $dir (reverse @libdirs) { |
1094 | for my $dir (reverse @libdirs) { |
1007 | opendir my $fh, $dir |
1095 | opendir my $fh, $dir |
1008 | or next; |
1096 | or next; |
1009 | for my $ext (readdir $fh) { |
1097 | for my $ext (readdir $fh) { |
1010 | $ext ne "." |
1098 | $ext !~ /^\./ |
1011 | and $ext ne ".." |
|
|
1012 | and open my $fh, "<", "$dir/$ext" |
1099 | and open my $fh, "<", "$dir/$ext" |
1013 | or next; |
1100 | or next; |
1014 | |
1101 | |
|
|
1102 | my %ext = (dir => $dir); |
|
|
1103 | |
1015 | while (<$fh>) { |
1104 | while (<$fh>) { |
1016 | if (/^#:META:X_RESOURCE:(.*)/) { |
1105 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
1017 | my ($pattern, $type, $desc) = split /:/, $1; |
1106 | my ($pattern, $type, $desc) = split /:/, $1; |
1018 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1107 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1019 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1108 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1020 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1109 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1021 | } else { |
1110 | } else { |
1022 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
1111 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
1023 | } |
1112 | } |
|
|
1113 | } elsif (/^#:META:BINDING:(.*)/) { |
|
|
1114 | my ($keysym, $action) = split /:/, $1; |
|
|
1115 | $ext{binding}{$keysym} = $action; |
1024 | } elsif (/^\s*(?:#|$)/) { |
1116 | } elsif (/^\s*(?:#|$)/) { |
1025 | # skip other comments and empty lines |
1117 | # skip other comments and empty lines |
1026 | } else { |
1118 | } else { |
1027 | last; # stop parsing on first non-empty non-comment line |
1119 | last; # stop parsing on first non-empty non-comment line |
1028 | } |
1120 | } |
1029 | } |
1121 | } |
|
|
1122 | |
|
|
1123 | $meta{$ext} = \%ext; |
1030 | } |
1124 | } |
|
|
1125 | } |
|
|
1126 | |
|
|
1127 | # and now merge resources and bindings |
|
|
1128 | while (my ($k, $v) = each %ext) { |
|
|
1129 | #TODO: should check for extensions overriding each other |
|
|
1130 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
|
|
1131 | %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} }); |
1031 | } |
1132 | } |
1032 | } |
1133 | } |
1033 | |
1134 | |
1034 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1135 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1035 | |
1136 | |
… | |
… | |
1055 | } |
1156 | } |
1056 | |
1157 | |
1057 | =item $term->destroy |
1158 | =item $term->destroy |
1058 | |
1159 | |
1059 | Destroy the terminal object (close the window, free resources |
1160 | Destroy the terminal object (close the window, free resources |
1060 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1161 | etc.). Please note that urxvt will not exit as long as any event |
1061 | watchers (timers, io watchers) are still active. |
1162 | watchers (timers, io watchers) are still active. |
1062 | |
1163 | |
1063 | =item $term->exec_async ($cmd[, @args]) |
1164 | =item $term->exec_async ($cmd[, @args]) |
1064 | |
1165 | |
1065 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1166 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
… | |
… | |
1181 | my $res = &x_resource; |
1282 | my $res = &x_resource; |
1182 | |
1283 | |
1183 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1284 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1184 | } |
1285 | } |
1185 | |
1286 | |
1186 | =item $success = $term->parse_keysym ($key, $octets) |
1287 | =item $success = $term->bind_action ($key, $octets) |
1187 | |
1288 | |
1188 | Adds a key binding exactly as specified via a resource. See the |
1289 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1189 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1290 | 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 | |
1291 | |
1198 | =item $rend = $term->rstyle ([$new_rstyle]) |
1292 | =item $rend = $term->rstyle ([$new_rstyle]) |
1199 | |
1293 | |
1200 | Return and optionally change the current rendition. Text that is output by |
1294 | Return and optionally change the current rendition. Text that is output by |
1201 | the terminal application will use this style. |
1295 | the terminal application will use this style. |
… | |
… | |
1381 | =item $term->tt_write ($octets) |
1475 | =item $term->tt_write ($octets) |
1382 | |
1476 | |
1383 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1477 | 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 |
1478 | pass characters instead of octets, you should convert your strings first |
1385 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1479 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1480 | |
|
|
1481 | =item $term->tt_write_user_input ($octets) |
|
|
1482 | |
|
|
1483 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1484 | the user pressing a key, to invokes the additional actions requested by |
|
|
1485 | the user for that case (C<tt_write> doesn't do that). |
|
|
1486 | |
|
|
1487 | The typical use case would be inside C<on_action> hooks. |
1386 | |
1488 | |
1387 | =item $term->tt_paste ($octets) |
1489 | =item $term->tt_paste ($octets) |
1388 | |
1490 | |
1389 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1491 | 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 |
1492 | CR and bracketing the data with control sequences if bracketed paste mode |
… | |
… | |
1624 | } |
1726 | } |
1625 | |
1727 | |
1626 | sub urxvt::line::t { |
1728 | sub urxvt::line::t { |
1627 | my ($self) = @_; |
1729 | my ($self) = @_; |
1628 | |
1730 | |
1629 | if (@_ > 1) |
1731 | if (@_ > 1) { |
1630 | { |
|
|
1631 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1732 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1632 | for $self->{beg} .. $self->{end}; |
1733 | for $self->{beg} .. $self->{end}; |
1633 | } |
1734 | } |
1634 | |
1735 | |
1635 | defined wantarray && |
1736 | defined wantarray && |
1636 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1737 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1637 | 0, $self->{len} |
1738 | 0, $self->{len} |
1638 | } |
1739 | } |
1639 | |
1740 | |
1640 | sub urxvt::line::r { |
1741 | sub urxvt::line::r { |
1641 | my ($self) = @_; |
1742 | my ($self) = @_; |
1642 | |
1743 | |
1643 | if (@_ > 1) |
1744 | if (@_ > 1) { |
1644 | { |
|
|
1645 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1745 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1646 | for $self->{beg} .. $self->{end}; |
1746 | for $self->{beg} .. $self->{end}; |
1647 | } |
1747 | } |
1648 | |
1748 | |
1649 | if (defined wantarray) { |
1749 | if (defined wantarray) { |
1650 | my $rend = [ |
1750 | my $rend = [ |
1651 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1751 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1652 | ]; |
1752 | ]; |