|
|
1 | =encoding utf8 |
|
|
2 | |
1 | =head1 NAME |
3 | =head1 NAME |
2 | |
4 | |
3 | rxvtperl - rxvt-unicode's embedded perl interpreter |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
4 | |
6 | |
5 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
6 | |
8 | |
7 | * Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically. |
9 | # 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 | |
10 | |
12 | sub on_sel_grab { |
11 | sub on_sel_grab { |
13 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
14 | () |
13 | () |
15 | } |
14 | } |
16 | |
15 | |
17 | 1 |
16 | # start a @@RXVT_NAME@@ using it: |
|
|
17 | |
|
|
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | |
19 | |
19 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
20 | |
21 | |
21 | On startup, @@RXVT_NAME@@ will scan F<@@RXVT_LIBDIR@@/urxvt/perl-ext/> |
22 | Everytime a terminal object gets created, scripts specified via the |
22 | for files and will load them. Everytime a terminal object gets created, |
23 | C<perl> resource are loaded and associated with it. |
23 | the directory specified by the C<perl-lib> resource will be additionally |
24 | |
24 | scanned. |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
|
|
26 | thus must be encoded as UTF-8. |
25 | |
27 | |
26 | 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 @@RXVT_NAME@@d, where |
27 | scripts will be shared for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
28 | |
30 | |
29 | Hooks in scripts specified by C<perl-lib> will only be called for the |
31 | =head2 Prepackaged Extensions |
30 | terminals created with that specific option value. |
32 | |
|
|
33 | This section describes the extensiosn delivered with this version. You can |
|
|
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
|
|
35 | |
|
|
36 | You can activate them like this: |
|
|
37 | |
|
|
38 | @@RXVT_NAME@@ -pe <extensionname> |
|
|
39 | |
|
|
40 | =over 4 |
|
|
41 | |
|
|
42 | =item selection |
|
|
43 | |
|
|
44 | Miscellaneous selection modifications. |
|
|
45 | |
|
|
46 | =over 4 |
|
|
47 | |
|
|
48 | =item rot13 |
|
|
49 | |
|
|
50 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
51 | |
|
|
52 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
53 | |
|
|
54 | =back |
|
|
55 | |
|
|
56 | =item digital-clock |
|
|
57 | |
|
|
58 | Displays a very simple digital clock in the upper right corner of the |
|
|
59 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
60 | overlays or changes. |
|
|
61 | |
|
|
62 | =item simple-overlay-clock |
|
|
63 | |
|
|
64 | Displays a digital clock using the built-in overlay (colourful, useless). |
|
|
65 | |
|
|
66 | =back |
31 | |
67 | |
32 | =head2 General API Considerations |
68 | =head2 General API Considerations |
33 | |
69 | |
34 | All objects (such as terminals, time watchers etc.) are typical |
70 | All objects (such as terminals, time watchers etc.) are typical |
35 | reference-to-hash objects. The hash can be used to store anything you |
71 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
127 | |
163 | |
128 | =item on_refresh_end $term |
164 | =item on_refresh_end $term |
129 | |
165 | |
130 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
166 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
131 | |
167 | |
|
|
168 | =item on_keyboard_command $term, $string |
|
|
169 | |
|
|
170 | Called whenever the user presses a key combination that has a |
|
|
171 | C<perl:string> action bound to it (see description of the B<keysym> |
|
|
172 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
173 | |
132 | =back |
174 | =back |
133 | |
175 | |
134 | =head2 Functions in the C<urxvt> Package |
176 | =head2 Functions in the C<urxvt> Package |
135 | |
177 | |
136 | =over 4 |
178 | =over 4 |
… | |
… | |
151 | correct place, e.g. on stderr of the connecting urxvtc client. |
193 | correct place, e.g. on stderr of the connecting urxvtc client. |
152 | |
194 | |
153 | =item $time = urxvt::NOW |
195 | =item $time = urxvt::NOW |
154 | |
196 | |
155 | Returns the "current time" (as per the event loop). |
197 | Returns the "current time" (as per the event loop). |
|
|
198 | |
|
|
199 | =head2 RENDITION |
|
|
200 | |
|
|
201 | Rendition bitsets contain information about colour, font, font styles and |
|
|
202 | similar information for each screen cell. |
|
|
203 | |
|
|
204 | The following "macros" deal with changes in rendition sets. You should |
|
|
205 | never just create a bitset, you should always modify an existing one, |
|
|
206 | as they contain important information required for correct operation of |
|
|
207 | rxvt-unicode. |
|
|
208 | |
|
|
209 | =over 4 |
|
|
210 | |
|
|
211 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
212 | |
|
|
213 | Returns the default rendition, as used when the terminal is starting up or |
|
|
214 | being reset. Useful as a base to start when creating renditions. |
|
|
215 | |
|
|
216 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
217 | |
|
|
218 | Return the rendition mask used for overlays by default. |
|
|
219 | |
|
|
220 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
221 | |
|
|
222 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
223 | underline, respectively. To enable such a style, just or it onto the |
|
|
224 | bitset. |
|
|
225 | |
|
|
226 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
227 | |
|
|
228 | =item $background = urxvt::GET_BASEBG $rend |
|
|
229 | |
|
|
230 | Return the foreground/background colour index, respectively. |
|
|
231 | |
|
|
232 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
233 | |
|
|
234 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
235 | |
|
|
236 | Replace the foreground/background colour in the rendition mask with the |
|
|
237 | specified one. |
|
|
238 | |
|
|
239 | =back |
156 | |
240 | |
157 | =cut |
241 | =cut |
158 | |
242 | |
159 | package urxvt; |
243 | package urxvt; |
160 | |
244 | |
… | |
… | |
174 | unless $msg =~ /\n$/; |
258 | unless $msg =~ /\n$/; |
175 | urxvt::warn ($msg); |
259 | urxvt::warn ($msg); |
176 | }; |
260 | }; |
177 | } |
261 | } |
178 | |
262 | |
|
|
263 | my @hook_count; |
179 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
264 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
180 | |
265 | |
181 | sub verbose { |
266 | sub verbose { |
182 | my ($level, $msg) = @_; |
267 | my ($level, $msg) = @_; |
183 | warn "$msg\n" if $level < $verbosity; |
268 | warn "$msg\n" if $level <= $verbosity; |
184 | } |
|
|
185 | |
|
|
186 | my %hook_global; |
|
|
187 | my @hook_count; |
|
|
188 | |
|
|
189 | # called by the rxvt core |
|
|
190 | sub invoke { |
|
|
191 | local $term = shift; |
|
|
192 | my $htype = shift; |
|
|
193 | |
|
|
194 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
|
|
195 | if $verbosity >= 10; |
|
|
196 | |
|
|
197 | for my $cb ($hook_global{_hook}[$htype], $term->{_hook}[$htype]) { |
|
|
198 | $cb or next; |
|
|
199 | |
|
|
200 | while (my ($k, $v) = each %$cb) { |
|
|
201 | return 1 if $v->($term, @_); |
|
|
202 | } |
|
|
203 | } |
|
|
204 | |
|
|
205 | 0 |
|
|
206 | } |
269 | } |
207 | |
270 | |
208 | # find on_xxx subs in the package and register them |
271 | # find on_xxx subs in the package and register them |
209 | # as hooks |
272 | # as hooks |
210 | sub register_package($) { |
273 | sub register_package($) { |
… | |
… | |
228 | # load a single script into its own package, once only |
291 | # load a single script into its own package, once only |
229 | sub script_package($) { |
292 | sub script_package($) { |
230 | my ($path) = @_; |
293 | my ($path) = @_; |
231 | |
294 | |
232 | $script_pkg{$path} ||= do { |
295 | $script_pkg{$path} ||= do { |
233 | my $pkg = $script_pkg++; |
296 | my $pkg = "urxvt::" . ($script_pkg++); |
|
|
297 | |
234 | verbose 3, "loading script '$path' into package '$pkg'"; |
298 | verbose 3, "loading script '$path' into package '$pkg'"; |
235 | |
299 | |
236 | open my $fh, "<:raw", $path |
300 | open my $fh, "<:raw", $path |
237 | or die "$path: $!"; |
301 | or die "$path: $!"; |
238 | |
302 | |
239 | eval "package $pkg; use strict; use utf8;\n" |
303 | my $source = "package $pkg; use strict; use utf8;\n" |
240 | . "#line 1 \"$path\"\n" |
304 | . "#line 1 \"$path\"\n{\n" |
241 | . do { local $/; <$fh> } |
305 | . (do { local $/; <$fh> }) |
|
|
306 | . "\n};\n1"; |
|
|
307 | |
242 | or die "$path: $@"; |
308 | eval $source or die "$path: $@"; |
243 | |
309 | |
244 | $pkg |
310 | $pkg |
245 | } |
311 | } |
246 | } |
312 | } |
247 | |
313 | |
248 | sub load_scripts($) { |
314 | # called by the rxvt core |
249 | my ($dir) = @_; |
315 | sub invoke { |
|
|
316 | local $term = shift; |
|
|
317 | my $htype = shift; |
250 | |
318 | |
251 | verbose 3, "loading scripts from '$dir'"; |
319 | if ($htype == 0) { # INIT |
|
|
320 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
252 | |
321 | |
|
|
322 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
|
|
323 | my @files = grep -f $_, map "$_/$ext", @dirs; |
|
|
324 | |
|
|
325 | if (@files) { |
253 | register_package script_package $_ |
326 | register_package script_package $files[0]; |
254 | for grep -f $_, |
327 | } else { |
255 | <$dir/*>; |
328 | warn "perl extension '$ext' not found in perl library search path\n"; |
256 | } |
329 | } |
|
|
330 | } |
257 | |
331 | |
258 | sub on_init { |
332 | } elsif ($htype == 1) { # DESTROY |
259 | my ($term) = @_; |
|
|
260 | |
|
|
261 | my $libdir = $term->resource ("perl_lib"); |
|
|
262 | |
|
|
263 | load_scripts $libdir |
|
|
264 | if defined $libdir; |
|
|
265 | } |
|
|
266 | |
|
|
267 | sub on_destroy { |
|
|
268 | my ($term) = @_; |
|
|
269 | |
|
|
270 | my $hook = $term->{_hook} |
333 | if (my $hook = $term->{_hook}) { |
|
|
334 | for my $htype (0..$#$hook) { |
|
|
335 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
336 | or set_should_invoke $htype, 0; |
|
|
337 | } |
|
|
338 | } |
|
|
339 | } |
|
|
340 | |
|
|
341 | my $cb = $term->{_hook}[$htype] |
271 | or return; |
342 | or return; |
272 | |
343 | |
273 | for my $htype (0..$#$hook) { |
344 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
274 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
345 | if $verbosity >= 10; |
275 | or set_should_invoke $htype, 0; |
346 | |
|
|
347 | while (my ($k, $v) = each %$cb) { |
|
|
348 | return 1 if $v->($term, @_); |
276 | } |
349 | } |
277 | } |
|
|
278 | |
350 | |
279 | { |
351 | 0 |
280 | local $term = \%hook_global; |
|
|
281 | |
|
|
282 | register_package __PACKAGE__; |
|
|
283 | load_scripts "$LIBDIR/perl-ext"; |
|
|
284 | } |
352 | } |
285 | |
353 | |
286 | =back |
354 | =back |
287 | |
355 | |
288 | =head2 The C<urxvt::term> Class |
356 | =head2 The C<urxvt::term> Class |
… | |
… | |
312 | |
380 | |
313 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
381 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
314 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
382 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
315 | display_name embed ext_bwidth fade font geometry hold iconName |
383 | display_name embed ext_bwidth fade font geometry hold iconName |
316 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
384 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
317 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 |
385 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
318 | modifier mouseWheelScrollPage name pastableTabs path perl perl_eval |
386 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
319 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
387 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
320 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
388 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
321 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
389 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
322 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
390 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
323 | shade term_name title transparent transparent_all tripleclickwords |
391 | shade term_name title transparent transparent_all tripleclickwords |
… | |
… | |
403 | Convert the given locale-encoded octets into a perl string. |
471 | Convert the given locale-encoded octets into a perl string. |
404 | |
472 | |
405 | =item $term->tt_write ($octets) |
473 | =item $term->tt_write ($octets) |
406 | |
474 | |
407 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
475 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
408 | pass characters instead of octets, you should convetr you strings first to |
476 | pass characters instead of octets, you should convert your strings first |
409 | the locale-specific encoding using C<< $term->locale_encode >>. |
477 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
478 | |
|
|
479 | =item $nrow = $term->nrow |
|
|
480 | |
|
|
481 | =item $ncol = $term->ncol |
|
|
482 | |
|
|
483 | Return the number of rows/columns of the terminal window (i.e. as |
|
|
484 | specified by C<-geometry>, excluding any scrollback). |
|
|
485 | |
|
|
486 | =item $nsaved = $term->nsaved |
|
|
487 | |
|
|
488 | Returns the number of lines in the scrollback buffer. |
|
|
489 | |
|
|
490 | =item $view_start = $term->view_start ([$newvalue]) |
|
|
491 | |
|
|
492 | Returns the negative row number of the topmost line. Minimum value is |
|
|
493 | C<0>, which displays the normal terminal contents. Larger values scroll |
|
|
494 | this many lines into the scrollback buffer. |
|
|
495 | |
|
|
496 | =item $term->want_refresh |
|
|
497 | |
|
|
498 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
|
|
499 | compare the on-screen display with its stored representation. If they |
|
|
500 | differ, it redraws the differences. |
|
|
501 | |
|
|
502 | Used after changing terminal contents to display them. |
|
|
503 | |
|
|
504 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
|
|
505 | |
|
|
506 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
|
|
507 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
|
|
508 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
509 | line C<< -$term->nsaved >>. |
|
|
510 | |
|
|
511 | If C<$new_text> is specified, it will replace characters in the current |
|
|
512 | line, starting at column C<$start_col> (default C<0>), which is useful |
|
|
513 | to replace only parts of a line. The font index in the rendition will |
|
|
514 | automatically be updated. |
|
|
515 | |
|
|
516 | C<$text> is in a special encoding: tabs and wide characters that use more |
|
|
517 | than one cell when displayed are padded with urxvt::NOCHAR characters |
|
|
518 | (C<chr 65535>). Characters with combining characters and other characters |
|
|
519 | that do not fit into the normal tetx encoding will be replaced with |
|
|
520 | characters in the private use area. |
|
|
521 | |
|
|
522 | You have to obey this encoding when changing text. The advantage is |
|
|
523 | that C<substr> and similar functions work on screen cells and not on |
|
|
524 | characters. |
|
|
525 | |
|
|
526 | The methods C<< $term->special_encode >> and C<< $term->special_decode >> |
|
|
527 | can be used to convert normal strings into this encoding and vice versa. |
|
|
528 | |
|
|
529 | =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) |
|
|
530 | |
|
|
531 | Like C<< $term->ROW_t >>, but returns an arrayref with rendition |
|
|
532 | bitsets. Rendition bitsets contain information about colour, font, font |
|
|
533 | styles and similar information. See also C<< $term->ROW_t >>. |
|
|
534 | |
|
|
535 | When setting rendition, the font mask will be ignored. |
|
|
536 | |
|
|
537 | See the section on RENDITION, above. |
|
|
538 | |
|
|
539 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
|
|
540 | |
|
|
541 | Returns the number of screen cells that are in use ("the line length"). If |
|
|
542 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
|
|
543 | means all characters are in use and it is continued on the next row. |
|
|
544 | |
|
|
545 | =item $text = $term->special_encode $string |
|
|
546 | |
|
|
547 | Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
548 | where one character corresponds to one screen cell. See |
|
|
549 | C<< $term->ROW_t >> for details. |
|
|
550 | |
|
|
551 | =item $string = $term->special_decode $text |
|
|
552 | |
|
|
553 | Converts rxvt-unicodes text reprsentation into a perl string. See |
|
|
554 | C<< $term->ROW_t >> for details. |
410 | |
555 | |
411 | =back |
556 | =back |
412 | |
557 | |
413 | =head2 The C<urxvt::timer> Class |
558 | =head2 The C<urxvt::timer> Class |
414 | |
559 | |