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 that add command line parameters or resources on their own are |
49 | laoded automatically when used. |
49 | loaded automatically when used. |
50 | |
50 | |
51 | =head1 API DOCUMENTATION |
51 | =head1 API DOCUMENTATION |
52 | |
52 | |
53 | =head2 General API Considerations |
53 | =head2 General API Considerations |
54 | |
54 | |
… | |
… | |
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. |
… | |
… | |
303 | |
285 | |
304 | =item on_user_command $term, $string |
286 | =item on_user_command $term, $string |
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 assumed to change |
311 | slightly in the future. |
293 | slightly in the future. |
312 | |
294 | |
313 | =item on_register_command $term, $keysym, $modifiermask, $string |
295 | =item on_register_command $term, $keysym, $modifiermask, $string |
… | |
… | |
735 | if (my $cb = $TERM->{_hook}[$htype]) { |
717 | if (my $cb = $TERM->{_hook}[$htype]) { |
736 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
718 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
737 | if $verbosity >= 10; |
719 | if $verbosity >= 10; |
738 | |
720 | |
739 | for my $pkg (keys %$cb) { |
721 | for my $pkg (keys %$cb) { |
740 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
722 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
741 | $retval ||= $retval_; |
723 | $retval ||= $retval_; |
742 | |
724 | |
743 | if ($@) { |
725 | if ($@) { |
744 | $TERM->ungrab; # better to lose the grab than the session |
726 | $TERM->ungrab; # better to lose the grab than the session |
745 | warn $@; |
727 | warn $@; |
… | |
… | |
790 | ($mask, @color{qw(fg bg)}, \@failed) |
772 | ($mask, @color{qw(fg bg)}, \@failed) |
791 | } |
773 | } |
792 | |
774 | |
793 | package urxvt::term::extension; |
775 | package urxvt::term::extension; |
794 | |
776 | |
795 | sub enable { |
777 | =head2 The C<urxvt::term::extension> class |
796 | my ($self, %hook) = @_; |
|
|
797 | my $pkg = $self->{_pkg}; |
|
|
798 | |
778 | |
799 | while (my ($name, $cb) = each %hook) { |
779 | Each extension attached to a terminal object is represented by |
800 | my $htype = $HOOKTYPE{uc $name}; |
780 | a C<urxvt::term::extension> object. |
801 | defined $htype |
|
|
802 | or Carp::croak "unsupported hook type '$name'"; |
|
|
803 | |
781 | |
804 | $self->set_should_invoke ($htype, +1) |
782 | You can use these objects, which are passed to all callbacks to store any |
805 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
783 | state related to the terminal and extension instance. |
806 | |
784 | |
807 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
785 | The methods (And data members) documented below can be called on extension |
808 | } |
786 | objects, in addition to call methods documented for the <urxvt::term> |
809 | } |
787 | class. |
810 | |
788 | |
811 | sub disable { |
789 | =over 4 |
812 | my ($self, @hook) = @_; |
|
|
813 | my $pkg = $self->{_pkg}; |
|
|
814 | |
790 | |
815 | for my $name (@hook) { |
791 | =item $urxvt_term = $self->{term} |
816 | my $htype = $HOOKTYPE{uc $name}; |
|
|
817 | defined $htype |
|
|
818 | or Carp::croak "unsupported hook type '$name'"; |
|
|
819 | |
792 | |
820 | $self->set_should_invoke ($htype, -1) |
793 | Returns the C<urxvt::term> object associated with this instance of the |
821 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
794 | extension. This member I<must not> be changed in any way. |
822 | } |
795 | |
823 | } |
796 | =cut |
824 | |
797 | |
825 | our $AUTOLOAD; |
798 | our $AUTOLOAD; |
826 | |
799 | |
827 | sub AUTOLOAD { |
800 | sub AUTOLOAD { |
828 | $AUTOLOAD =~ /:([^:]+)$/ |
801 | $AUTOLOAD =~ /:([^:]+)$/ |
… | |
… | |
841 | |
814 | |
842 | sub DESTROY { |
815 | sub DESTROY { |
843 | # nop |
816 | # nop |
844 | } |
817 | } |
845 | |
818 | |
846 | # urxvt::destroy_hook |
819 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
847 | |
820 | |
848 | sub urxvt::destroy_hook::DESTROY { |
821 | sub urxvt::destroy_hook::DESTROY { |
849 | ${$_[0]}->(); |
822 | ${$_[0]}->(); |
850 | } |
823 | } |
851 | |
824 | |
852 | sub urxvt::destroy_hook(&) { |
825 | sub urxvt::destroy_hook(&) { |
853 | bless \shift, urxvt::destroy_hook:: |
826 | bless \shift, urxvt::destroy_hook:: |
854 | } |
827 | } |
|
|
828 | |
|
|
829 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
830 | |
|
|
831 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
832 | this extension, replacing any previous hook. This is useful when you want |
|
|
833 | to overwrite time-critical hooks only temporarily. |
|
|
834 | |
|
|
835 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
836 | method of the C<urxvt::term> class. |
|
|
837 | |
|
|
838 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
839 | |
|
|
840 | Dynamically disable the given hooks. |
|
|
841 | |
|
|
842 | =cut |
|
|
843 | |
|
|
844 | sub enable { |
|
|
845 | my ($self, %hook) = @_; |
|
|
846 | my $pkg = $self->{_pkg}; |
|
|
847 | |
|
|
848 | while (my ($name, $cb) = each %hook) { |
|
|
849 | my $htype = $HOOKTYPE{uc $name}; |
|
|
850 | defined $htype |
|
|
851 | or Carp::croak "unsupported hook type '$name'"; |
|
|
852 | |
|
|
853 | $self->set_should_invoke ($htype, +1) |
|
|
854 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
855 | |
|
|
856 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
857 | } |
|
|
858 | } |
|
|
859 | |
|
|
860 | sub disable { |
|
|
861 | my ($self, @hook) = @_; |
|
|
862 | my $pkg = $self->{_pkg}; |
|
|
863 | |
|
|
864 | for my $name (@hook) { |
|
|
865 | my $htype = $HOOKTYPE{uc $name}; |
|
|
866 | defined $htype |
|
|
867 | or Carp::croak "unsupported hook type '$name'"; |
|
|
868 | |
|
|
869 | $self->set_should_invoke ($htype, -1) |
|
|
870 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
871 | } |
|
|
872 | } |
|
|
873 | |
|
|
874 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
875 | |
|
|
876 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
877 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
878 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
879 | are disabled again. |
|
|
880 | |
|
|
881 | =cut |
|
|
882 | |
|
|
883 | sub urxvt::extension::on_disable::DESTROY { |
|
|
884 | my $disable = shift; |
|
|
885 | |
|
|
886 | my $term = delete $disable->{""}; |
|
|
887 | |
|
|
888 | while (my ($htype, $id) = each %$disable) { |
|
|
889 | delete $term->{_hook}[$htype]{$id}; |
|
|
890 | $term->set_should_invoke ($htype, -1); |
|
|
891 | } |
|
|
892 | } |
|
|
893 | |
|
|
894 | sub on { |
|
|
895 | my ($self, %hook) = @_; |
|
|
896 | |
|
|
897 | my $term = $self->{term}; |
|
|
898 | |
|
|
899 | my %disable = ( "" => $term ); |
|
|
900 | |
|
|
901 | while (my ($name, $cb) = each %hook) { |
|
|
902 | my $htype = $HOOKTYPE{uc $name}; |
|
|
903 | defined $htype |
|
|
904 | or Carp::croak "unsupported hook type '$name'"; |
|
|
905 | |
|
|
906 | $term->set_should_invoke ($htype, +1); |
|
|
907 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
908 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
909 | } |
|
|
910 | |
|
|
911 | bless \%disable, "urxvt::extension::on_disable" |
|
|
912 | } |
|
|
913 | |
|
|
914 | =item $self->x_resource ($pattern) |
|
|
915 | |
|
|
916 | =item $self->x_resource_boolean ($pattern) |
|
|
917 | |
|
|
918 | These methods support an additional C<%> prefix when called on an |
|
|
919 | extension object - see the description of these methods in the |
|
|
920 | C<urxvt::term> class for details. |
|
|
921 | |
|
|
922 | =cut |
855 | |
923 | |
856 | sub x_resource { |
924 | sub x_resource { |
857 | my ($self, $name) = @_; |
925 | my ($self, $name) = @_; |
858 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
926 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
859 | $self->{term}->x_resource ($name) |
927 | $self->{term}->x_resource ($name) |
… | |
… | |
862 | sub x_resource_boolean { |
930 | sub x_resource_boolean { |
863 | my ($self, $name) = @_; |
931 | my ($self, $name) = @_; |
864 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
932 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
865 | $self->{term}->x_resource_boolean ($name) |
933 | $self->{term}->x_resource_boolean ($name) |
866 | } |
934 | } |
|
|
935 | |
|
|
936 | =back |
|
|
937 | |
|
|
938 | =cut |
867 | |
939 | |
868 | package urxvt::anyevent; |
940 | package urxvt::anyevent; |
869 | |
941 | |
870 | =head2 The C<urxvt::anyevent> Class |
942 | =head2 The C<urxvt::anyevent> Class |
871 | |
943 | |
… | |
… | |
1005 | |
1077 | |
1006 | for my $dir (reverse @libdirs) { |
1078 | for my $dir (reverse @libdirs) { |
1007 | opendir my $fh, $dir |
1079 | opendir my $fh, $dir |
1008 | or next; |
1080 | or next; |
1009 | for my $ext (readdir $fh) { |
1081 | for my $ext (readdir $fh) { |
1010 | $ext ne "." |
1082 | $ext !~ /^\./ |
1011 | and $ext ne ".." |
|
|
1012 | and open my $fh, "<", "$dir/$ext" |
1083 | and open my $fh, "<", "$dir/$ext" |
1013 | or next; |
1084 | or next; |
1014 | |
1085 | |
1015 | while (<$fh>) { |
1086 | while (<$fh>) { |
1016 | if (/^#:META:X_RESOURCE:(.*)/) { |
1087 | if (/^#:META:X_RESOURCE:(.*)/) { |
… | |
… | |
1055 | } |
1126 | } |
1056 | |
1127 | |
1057 | =item $term->destroy |
1128 | =item $term->destroy |
1058 | |
1129 | |
1059 | Destroy the terminal object (close the window, free resources |
1130 | Destroy the terminal object (close the window, free resources |
1060 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1131 | etc.). Please note that urxvt will not exit as long as any event |
1061 | watchers (timers, io watchers) are still active. |
1132 | watchers (timers, io watchers) are still active. |
1062 | |
1133 | |
1063 | =item $term->exec_async ($cmd[, @args]) |
1134 | =item $term->exec_async ($cmd[, @args]) |
1064 | |
1135 | |
1065 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1136 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
… | |
… | |
1121 | |
1192 | |
1122 | Here is a likely non-exhaustive list of resource names, not all of which |
1193 | 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> |
1194 | are supported in every build, please see the source file F</src/rsinc.h> |
1124 | to see the actual list: |
1195 | to see the actual list: |
1125 | |
1196 | |
1126 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1197 | answerbackstring backgroundPixmap backspace_key blurradius |
1127 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1198 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1128 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1199 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1129 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1200 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1130 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1201 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1131 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1202 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
… | |
… | |
1156 | Extensions that define extra resource or command line arguments also need |
1227 | Extensions that define extra resource or command line arguments also need |
1157 | to call this method to access their values. |
1228 | to call this method to access their values. |
1158 | |
1229 | |
1159 | If the method is called on an extension object (basically, from an |
1230 | 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 |
1231 | 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 |
1232 | 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 |
1233 | 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 |
1234 | can rename them and get a new set of commandline switches and resources |
1164 | without having to change the actual code. |
1235 | without having to change the actual code. |
1165 | |
1236 | |
1166 | This method should only be called during the C<on_start> hook, as there is |
1237 | This method should only be called during the C<on_start> hook, as there is |
… | |
… | |
1184 | } |
1255 | } |
1185 | |
1256 | |
1186 | =item $success = $term->parse_keysym ($key, $octets) |
1257 | =item $success = $term->parse_keysym ($key, $octets) |
1187 | |
1258 | |
1188 | Adds a key binding exactly as specified via a resource. See the |
1259 | Adds a key binding exactly as specified via a resource. See the |
1189 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1260 | C<keysym> resource in the urxvt(1) manpage. |
1190 | |
1261 | |
1191 | =item $term->register_command ($keysym, $modifiermask, $string) |
1262 | =item $term->register_command ($keysym, $modifiermask, $string) |
1192 | |
1263 | |
1193 | Adds a key binding. This is a lower level api compared to |
1264 | 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 |
1265 | C<parse_keysym>, as it expects a parsed key description, and can be |