… | |
… | |
2 | |
2 | |
3 | rxvtperl - rxvt-unicode's embedded perl interpreter |
3 | rxvtperl - rxvt-unicode's embedded perl interpreter |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | * Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically. |
7 | # create a file grab_test in $HOME: |
8 | |
|
|
9 | * Scripts are evaluated in a 'use strict' and 'use utf8' environment, and |
|
|
10 | thus must be encoded as UTF-8. |
|
|
11 | |
8 | |
12 | sub on_sel_grab { |
9 | sub on_sel_grab { |
13 | warn "you selected ", $_[0]->selection; |
10 | warn "you selected ", $_[0]->selection; |
14 | () |
11 | () |
15 | } |
12 | } |
16 | |
13 | |
17 | 1 |
14 | # start a @@RXVT_NAME@@ using it: |
|
|
15 | |
|
|
16 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | |
17 | |
19 | =head1 DESCRIPTION |
18 | =head1 DESCRIPTION |
20 | |
19 | |
21 | On startup, @@RXVT_NAME@@ will scan F<@@RXVT_LIBDIR@@/urxvt/perl-ext/> |
20 | Everytime a terminal object gets created, scripts specified via the |
22 | for files and will load them. Everytime a terminal object gets created, |
21 | C<perl> resource are loaded and associated with it. |
23 | the directory specified by the C<perl-lib> resource will be additionally |
22 | |
24 | scanned. |
23 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
|
|
24 | thus must be encoded as UTF-8. |
25 | |
25 | |
26 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
26 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
27 | scripts will be shared for all terminals. |
27 | scripts will be shared (But not enabled) for all terminals. |
28 | |
|
|
29 | Hooks in scripts specified by C<perl-lib> will only be called for the |
|
|
30 | terminals created with that specific option value. |
|
|
31 | |
28 | |
32 | =head2 General API Considerations |
29 | =head2 General API Considerations |
33 | |
30 | |
34 | All objects (such as terminals, time watchers etc.) are typical |
31 | All objects (such as terminals, time watchers etc.) are typical |
35 | reference-to-hash objects. The hash can be used to store anything you |
32 | reference-to-hash objects. The hash can be used to store anything you |
36 | like. The only reserved member is C<_ptr>, which must not be changed. |
33 | like. All members starting with an underscore (such as C<_ptr> or |
|
|
34 | C<_hook>) are reserved for internal uses and must not be accessed or |
|
|
35 | modified). |
37 | |
36 | |
38 | When objects are destroyed on the C++ side, the perl object hashes are |
37 | When objects are destroyed on the C++ side, the perl object hashes are |
39 | emptied, so its best to store related objects such as time watchers and |
38 | emptied, so its best to store related objects such as time watchers and |
40 | the like inside the terminal object so they get destroyed as soon as the |
39 | the like inside the terminal object so they get destroyed as soon as the |
41 | terminal is destroyed. |
40 | terminal is destroyed. |
… | |
… | |
172 | unless $msg =~ /\n$/; |
171 | unless $msg =~ /\n$/; |
173 | urxvt::warn ($msg); |
172 | urxvt::warn ($msg); |
174 | }; |
173 | }; |
175 | } |
174 | } |
176 | |
175 | |
|
|
176 | my @hook_count; |
177 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY} || 10; |
177 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
178 | |
178 | |
179 | sub verbose { |
179 | sub verbose { |
180 | my ($level, $msg) = @_; |
180 | my ($level, $msg) = @_; |
181 | warn "$msg\n"; #d# |
181 | warn "$msg\n" if $level <= $verbosity; |
182 | } |
182 | } |
183 | |
183 | |
184 | my @invoke_cb; |
184 | # find on_xxx subs in the package and register them |
|
|
185 | # as hooks |
|
|
186 | sub register_package($) { |
|
|
187 | my ($pkg) = @_; |
|
|
188 | |
|
|
189 | for my $htype (0.. $#HOOKNAME) { |
|
|
190 | my $name = $HOOKNAME[$htype]; |
|
|
191 | |
|
|
192 | my $ref = $pkg->can ("on_" . lc $name) |
|
|
193 | or next; |
|
|
194 | |
|
|
195 | $term->{_hook}[$htype]{$ref*1} = $ref; |
|
|
196 | $hook_count[$htype]++ |
|
|
197 | or set_should_invoke $htype, 1; |
|
|
198 | } |
|
|
199 | } |
|
|
200 | |
|
|
201 | my $script_pkg = "script0000"; |
|
|
202 | my %script_pkg; |
|
|
203 | |
|
|
204 | # load a single script into its own package, once only |
|
|
205 | sub script_package($) { |
|
|
206 | my ($path) = @_; |
|
|
207 | |
|
|
208 | $script_pkg{$path} ||= do { |
|
|
209 | my $pkg = "urxvt::" . ($script_pkg++); |
|
|
210 | |
|
|
211 | verbose 3, "loading script '$path' into package '$pkg'"; |
|
|
212 | |
|
|
213 | open my $fh, "<:raw", $path |
|
|
214 | or die "$path: $!"; |
|
|
215 | |
|
|
216 | my $source = "package $pkg; use strict; use utf8;\n" |
|
|
217 | . "#line 1 \"$path\"\n{\n" |
|
|
218 | . (do { local $/; <$fh> }) |
|
|
219 | . "\n};\n1"; |
|
|
220 | |
|
|
221 | eval $source or die "$path: $@"; |
|
|
222 | |
|
|
223 | $pkg |
|
|
224 | } |
|
|
225 | } |
185 | |
226 | |
186 | # called by the rxvt core |
227 | # called by the rxvt core |
187 | sub invoke { |
228 | sub invoke { |
188 | local $term = shift; |
229 | local $term = shift; |
189 | my $htype = shift; |
230 | my $htype = shift; |
190 | |
231 | |
191 | my $cb = $invoke_cb[$htype]; |
232 | if ($htype == 0) { # INIT |
|
|
233 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
|
|
234 | |
|
|
235 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
|
|
236 | my @files = grep -f $_, map "$_/$ext", @dirs; |
|
|
237 | |
|
|
238 | if (@files) { |
|
|
239 | register_package script_package $files[0]; |
|
|
240 | } else { |
|
|
241 | warn "perl extension '$ext' not found in perl library search path\n"; |
|
|
242 | } |
|
|
243 | } |
|
|
244 | |
|
|
245 | } elsif ($htype == 1) { # DESTROY |
|
|
246 | if (my $hook = $term->{_hook}) { |
|
|
247 | for my $htype (0..$#$hook) { |
|
|
248 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
249 | or set_should_invoke $htype, 0; |
|
|
250 | } |
|
|
251 | } |
|
|
252 | } |
|
|
253 | |
|
|
254 | my $cb = $term->{_hook}[$htype] |
|
|
255 | or return; |
192 | |
256 | |
193 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
257 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
194 | if $verbosity >= 10; |
258 | if $verbosity >= 10; |
195 | |
259 | |
196 | while (my ($k, $v) = each %$cb) { |
260 | while (my ($k, $v) = each %$cb) { |
197 | return 1 if $v->($term, @_); |
261 | return 1 if $v->($term, @_); |
198 | } |
262 | } |
199 | |
263 | |
200 | 0 |
264 | 0 |
201 | } |
265 | } |
202 | |
|
|
203 | # find on_xxx subs in the package and register them |
|
|
204 | # as hooks |
|
|
205 | sub register_package($) { |
|
|
206 | my ($pkg) = @_; |
|
|
207 | |
|
|
208 | for my $hook (0.. $#HOOKNAME) { |
|
|
209 | my $name = $HOOKNAME[$hook]; |
|
|
210 | |
|
|
211 | my $ref = $pkg->can ("on_" . lc $name) |
|
|
212 | or next; |
|
|
213 | |
|
|
214 | $invoke_cb[$hook]{$ref*1} = $ref; |
|
|
215 | set_should_invoke $hook, 1; |
|
|
216 | } |
|
|
217 | } |
|
|
218 | |
|
|
219 | my $script_pkg = "script0000"; |
|
|
220 | my %script_pkg; |
|
|
221 | |
|
|
222 | # load a single script into its own package, once only |
|
|
223 | sub load_script($) { |
|
|
224 | my ($path) = @_; |
|
|
225 | |
|
|
226 | $script_pkg{$path} ||= do { |
|
|
227 | my $pkg = $script_pkg++; |
|
|
228 | verbose 3, "loading script '$path' into package '$pkg'"; |
|
|
229 | |
|
|
230 | open my $fh, "<:raw", $path |
|
|
231 | or die "$path: $!"; |
|
|
232 | |
|
|
233 | eval "package $pkg; use strict; use utf8;\n" |
|
|
234 | . "#line 1 \"$path\"\n" |
|
|
235 | . do { local $/; <$fh> } |
|
|
236 | or die "$path: $@"; |
|
|
237 | |
|
|
238 | register_package $pkg; |
|
|
239 | |
|
|
240 | $pkg |
|
|
241 | }; |
|
|
242 | } |
|
|
243 | |
|
|
244 | sub load_scripts($) { |
|
|
245 | my ($dir) = @_; |
|
|
246 | |
|
|
247 | verbose 3, "loading scripts from '$dir'"; |
|
|
248 | |
|
|
249 | load_script $_ |
|
|
250 | for grep -f $_, |
|
|
251 | <$dir/perl-ext/*>; |
|
|
252 | } |
|
|
253 | |
|
|
254 | sub on_init { |
|
|
255 | my ($term) = @_; |
|
|
256 | |
|
|
257 | my $libdir = $term->resource ("perl_lib"); |
|
|
258 | |
|
|
259 | load_scripts $libdir |
|
|
260 | if defined $libdir; |
|
|
261 | } |
|
|
262 | |
|
|
263 | register_package __PACKAGE__; |
|
|
264 | load_scripts $LIBDIR; |
|
|
265 | |
266 | |
266 | =back |
267 | =back |
267 | |
268 | |
268 | =head2 The C<urxvt::term> Class |
269 | =head2 The C<urxvt::term> Class |
269 | |
270 | |
… | |
… | |
292 | |
293 | |
293 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
294 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
294 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
295 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
295 | display_name embed ext_bwidth fade font geometry hold iconName |
296 | display_name embed ext_bwidth fade font geometry hold iconName |
296 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
297 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
297 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 |
298 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
298 | modifier mouseWheelScrollPage name pastableTabs path perl perl_eval |
299 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
299 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
300 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
300 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
301 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
301 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
302 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
302 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
303 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
303 | shade term_name title transparent transparent_all tripleclickwords |
304 | shade term_name title transparent transparent_all tripleclickwords |