… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, scripts specified via the |
22 | Everytime a terminal object gets created, extension scripts specified via |
23 | 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' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' 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 @@RXVT_NAME@@d, where |
… | |
… | |
60 | |
60 | |
61 | =item digital-clock |
61 | =item digital-clock |
62 | |
62 | |
63 | Displays a digital clock using the built-in overlay. |
63 | Displays a digital clock using the built-in overlay. |
64 | |
64 | |
|
|
65 | =item mark-urls |
|
|
66 | |
|
|
67 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
|
|
68 | |
|
|
69 | =item block-graphics-to-ascii |
|
|
70 | |
|
|
71 | A not very useful example of filtering all text output to the terminal, |
|
|
72 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
73 | similar-looking ascii character. |
|
|
74 | |
65 | =item example-refresh-hooks |
75 | =item example-refresh-hooks |
66 | |
76 | |
67 | Displays a very simple digital clock in the upper right corner of the |
77 | Displays a very simple digital clock in the upper right corner of the |
68 | window. Illustrates overwriting the refresh callbacks to create your own |
78 | window. Illustrates overwriting the refresh callbacks to create your own |
69 | overlays or changes. |
79 | overlays or changes. |
70 | |
|
|
71 | =item mark-urls |
|
|
72 | |
|
|
73 | A not very useful example of filtering all text output to the terminal, by |
|
|
74 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
75 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
76 | when typing them) do not get marked. |
|
|
77 | |
80 | |
78 | =back |
81 | =back |
79 | |
82 | |
80 | =head2 General API Considerations |
83 | =head2 General API Considerations |
81 | |
84 | |
… | |
… | |
113 | |
116 | |
114 | =back |
117 | =back |
115 | |
118 | |
116 | =head2 Hooks |
119 | =head2 Hooks |
117 | |
120 | |
118 | The following subroutines can be declared in loaded scripts, and will be |
121 | The following subroutines can be declared in extension files, and will be |
119 | called whenever the relevant event happens. |
122 | called whenever the relevant event happens. |
120 | |
123 | |
121 | The first argument passed to them is an object private to each terminal |
124 | The first argument passed to them is an object private to each terminal |
122 | and extension package. You can call all C<urxvt::term> methods on it, but |
125 | and extension package. You can call all C<urxvt::term> methods on it, but |
123 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
126 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
124 | object that is shared between all packages is stored in the C<term> |
127 | object that is shared between all packages is stored in the C<term> |
125 | member. |
128 | member. It is, however, blessed intot he package of the extension script, |
|
|
129 | so for all practical purposes you can treat an extension script as a class. |
126 | |
130 | |
127 | All of them must return a boolean value. If it is true, then the event |
131 | All of them must return a boolean value. If it is true, then the event |
128 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
132 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
129 | and the relevant action might not be carried out by the C++ code. |
133 | and the relevant action might not be carried out by the C++ code. |
130 | |
134 | |
… | |
… | |
133 | =over 4 |
137 | =over 4 |
134 | |
138 | |
135 | =item on_init $term |
139 | =item on_init $term |
136 | |
140 | |
137 | Called after a new terminal object has been initialized, but before |
141 | Called after a new terminal object has been initialized, but before |
138 | windows are created or the command gets run. |
142 | windows are created or the command gets run. Most methods are unsafe to |
|
|
143 | call or deliver senseless data, as terminal size and other characteristics |
|
|
144 | have not yet been determined. You can safely query and change resources, |
|
|
145 | though. |
139 | |
146 | |
140 | =item on_reset $term |
147 | =item on_reset $term |
141 | |
148 | |
142 | Called after the screen is "reset" for any reason, such as resizing or |
149 | Called after the screen is "reset" for any reason, such as resizing or |
143 | control sequences. Here is where you can react on changes to size-related |
150 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
223 | can filter/change and output the text yourself by returning a true value |
230 | can filter/change and output the text yourself by returning a true value |
224 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
231 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
225 | might be very slow, however, as your hook is called for B<all> text being |
232 | might be very slow, however, as your hook is called for B<all> text being |
226 | output. |
233 | output. |
227 | |
234 | |
|
|
235 | =item on_line_update $term, $row |
|
|
236 | |
|
|
237 | Called whenever a line was updated or changed. Can be used to filter |
|
|
238 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
239 | that are being shown will be filtered, and, due to performance reasons, |
|
|
240 | not always immediately. |
|
|
241 | |
|
|
242 | The row number is always the topmost row of the line if the line spans |
|
|
243 | multiple rows. |
|
|
244 | |
|
|
245 | Please note that, if you change the line, then the hook might get called |
|
|
246 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
247 | you cannot just toggle rendition bits, but only set them. |
|
|
248 | |
228 | =item on_refresh_begin $term |
249 | =item on_refresh_begin $term |
229 | |
250 | |
230 | Called just before the screen gets redrawn. Can be used for overlay |
251 | Called just before the screen gets redrawn. Can be used for overlay |
231 | or similar effects by modify terminal contents in refresh_begin, and |
252 | or similar effects by modify terminal contents in refresh_begin, and |
232 | restoring them in refresh_end. The built-in overlay and selection display |
253 | restoring them in refresh_end. The built-in overlay and selection display |
… | |
… | |
240 | |
261 | |
241 | Called whenever the user presses a key combination that has a |
262 | Called whenever the user presses a key combination that has a |
242 | C<perl:string> action bound to it (see description of the B<keysym> |
263 | C<perl:string> action bound to it (see description of the B<keysym> |
243 | resource in the @@RXVT_NAME@@(1) manpage). |
264 | resource in the @@RXVT_NAME@@(1) manpage). |
244 | |
265 | |
|
|
266 | =item on_key_press $term, $event, $octets |
|
|
267 | |
|
|
268 | =item on_key_release $term, $event |
|
|
269 | |
|
|
270 | =item on_button_press $term, $event |
|
|
271 | |
|
|
272 | =item on_button_release $term, $event |
|
|
273 | |
|
|
274 | =item on_motion_notify $term, $event |
|
|
275 | |
|
|
276 | Called whenever the corresponding X event is received for the terminal If |
|
|
277 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
278 | |
|
|
279 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
280 | manpage), with the additional members C<row> and C<col>, which are the row |
|
|
281 | and column under the mouse cursor. |
|
|
282 | |
|
|
283 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
284 | output, if any, in locale-specific encoding. |
|
|
285 | |
|
|
286 | subwindow. |
|
|
287 | |
245 | =back |
288 | =back |
246 | |
289 | |
247 | =head2 Variables in the C<urxvt> Package |
290 | =head2 Variables in the C<urxvt> Package |
248 | |
291 | |
249 | =over 4 |
292 | =over 4 |
250 | |
293 | |
251 | =item $urxvt::TERM |
294 | =item $urxvt::TERM |
252 | |
295 | |
253 | The current terminal. Whenever a callback/Hook is bein executed, this |
296 | The current terminal. This variable stores the current C<urxvt::term> |
254 | variable stores the current C<urxvt::term> object. |
297 | object, whenever a callback/hook is executing. |
255 | |
298 | |
256 | =back |
299 | =back |
257 | |
300 | |
258 | =head2 Functions in the C<urxvt> Package |
301 | =head2 Functions in the C<urxvt> Package |
259 | |
302 | |
260 | =over 4 |
303 | =over 4 |
|
|
304 | |
|
|
305 | =item $term = new urxvt [arg...] |
|
|
306 | |
|
|
307 | Creates a new terminal, very similar as if you had started it with |
|
|
308 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
309 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
310 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
311 | C<init> and C<start> hooks will be called during the call. |
261 | |
312 | |
262 | =item urxvt::fatal $errormessage |
313 | =item urxvt::fatal $errormessage |
263 | |
314 | |
264 | Fatally aborts execution with the given error message. Avoid at all |
315 | Fatally aborts execution with the given error message. Avoid at all |
265 | costs! The only time this is acceptable is when the terminal process |
316 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
378 | $hook_count[$htype]++ |
429 | $hook_count[$htype]++ |
379 | or set_should_invoke $htype, 1; |
430 | or set_should_invoke $htype, 1; |
380 | } |
431 | } |
381 | } |
432 | } |
382 | |
433 | |
383 | my $script_pkg = "script0000"; |
434 | my $extension_pkg = "extension0000"; |
384 | my %script_pkg; |
435 | my %extension_pkg; |
385 | |
436 | |
386 | # load a single script into its own package, once only |
437 | # load a single script into its own package, once only |
387 | sub script_package($) { |
438 | sub extension_package($) { |
388 | my ($path) = @_; |
439 | my ($path) = @_; |
389 | |
440 | |
390 | $script_pkg{$path} ||= do { |
441 | $extension_pkg{$path} ||= do { |
391 | my $pkg = "urxvt::" . ($script_pkg++); |
442 | my $pkg = "urxvt::" . ($extension_pkg++); |
392 | |
443 | |
393 | verbose 3, "loading script '$path' into package '$pkg'"; |
444 | verbose 3, "loading extension '$path' into package '$pkg'"; |
394 | |
445 | |
395 | open my $fh, "<:raw", $path |
446 | open my $fh, "<:raw", $path |
396 | or die "$path: $!"; |
447 | or die "$path: $!"; |
397 | |
448 | |
398 | my $source = "package $pkg; use strict; use utf8;\n" |
449 | my $source = "package $pkg; use strict; use utf8;\n" |
|
|
450 | . "use base urxvt::term::proxy::;\n" |
399 | . "#line 1 \"$path\"\n{\n" |
451 | . "#line 1 \"$path\"\n{\n" |
400 | . (do { local $/; <$fh> }) |
452 | . (do { local $/; <$fh> }) |
401 | . "\n};\n1"; |
453 | . "\n};\n1"; |
402 | |
454 | |
403 | eval $source or die "$path: $@"; |
455 | eval $source or die "$path: $@"; |
… | |
… | |
414 | my $htype = shift; |
466 | my $htype = shift; |
415 | |
467 | |
416 | if ($htype == 0) { # INIT |
468 | if ($htype == 0) { # INIT |
417 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
469 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
418 | |
470 | |
419 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
471 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
420 | my @files = grep -f $_, map "$_/$ext", @dirs; |
472 | my @files = grep -f $_, map "$_/$ext", @dirs; |
421 | |
473 | |
422 | if (@files) { |
474 | if (@files) { |
423 | register_package script_package $files[0]; |
475 | register_package extension_package $files[0]; |
424 | } else { |
476 | } else { |
425 | warn "perl extension '$ext' not found in perl library search path\n"; |
477 | warn "perl extension '$ext' not found in perl library search path\n"; |
426 | } |
478 | } |
427 | } |
479 | } |
428 | } |
480 | } |
… | |
… | |
434 | if $verbosity >= 10; |
486 | if $verbosity >= 10; |
435 | |
487 | |
436 | keys %$cb; |
488 | keys %$cb; |
437 | |
489 | |
438 | while (my ($pkg, $cb) = each %$cb) { |
490 | while (my ($pkg, $cb) = each %$cb) { |
|
|
491 | eval { |
439 | $retval = $cb->( |
492 | $retval = $cb->( |
440 | $TERM->{_pkg}{$pkg} ||= do { |
493 | $TERM->{_pkg}{$pkg} ||= do { |
441 | my $proxy = bless { }, urxvt::term::proxy::; |
494 | my $proxy = bless { }, $pkg; |
442 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
495 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
443 | $proxy |
496 | $proxy |
444 | }, |
497 | }, |
445 | @_, |
498 | @_, |
446 | ) and last; |
499 | ) and last; |
|
|
500 | }; |
|
|
501 | warn $@ if $@;#d# |
447 | } |
502 | } |
448 | } |
503 | } |
449 | |
504 | |
450 | if ($htype == 1) { # DESTROY |
505 | if ($htype == 1) { # DESTROY |
451 | # remove hooks if unused |
506 | # remove hooks if unused |
… | |
… | |
482 | } |
537 | } |
483 | |
538 | |
484 | =head2 The C<urxvt::term> Class |
539 | =head2 The C<urxvt::term> Class |
485 | |
540 | |
486 | =over 4 |
541 | =over 4 |
|
|
542 | |
|
|
543 | =item $term->destroy |
|
|
544 | |
|
|
545 | Destroy the terminal object (close the window, free resources etc.). |
487 | |
546 | |
488 | =item $value = $term->resource ($name[, $newval]) |
547 | =item $value = $term->resource ($name[, $newval]) |
489 | |
548 | |
490 | Returns the current resource value associated with a given name and |
549 | Returns the current resource value associated with a given name and |
491 | optionally sets a new value. Setting values is most useful in the C<init> |
550 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
608 | |
667 | |
609 | If hidden, display the overlay again. |
668 | If hidden, display the overlay again. |
610 | |
669 | |
611 | =back |
670 | =back |
612 | |
671 | |
613 | =item $cellwidth = $term->strwidth $string |
672 | =item $cellwidth = $term->strwidth ($string) |
614 | |
673 | |
615 | Returns the number of screen-cells this string would need. Correctly |
674 | Returns the number of screen-cells this string would need. Correctly |
616 | accounts for wide and combining characters. |
675 | accounts for wide and combining characters. |
617 | |
676 | |
618 | =item $octets = $term->locale_encode $string |
677 | =item $octets = $term->locale_encode ($string) |
619 | |
678 | |
620 | Convert the given text string into the corresponding locale encoding. |
679 | Convert the given text string into the corresponding locale encoding. |
621 | |
680 | |
622 | =item $string = $term->locale_decode $octets |
681 | =item $string = $term->locale_decode ($octets) |
623 | |
682 | |
624 | Convert the given locale-encoded octets into a perl string. |
683 | Convert the given locale-encoded octets into a perl string. |
625 | |
684 | |
626 | =item $term->scr_add_lines ($string) |
685 | =item $term->scr_add_lines ($string) |
627 | |
686 | |
… | |
… | |
632 | |
691 | |
633 | Normally its not a good idea to use this function, as programs might be |
692 | Normally its not a good idea to use this function, as programs might be |
634 | confused by changes in cursor position or scrolling. Its useful inside a |
693 | confused by changes in cursor position or scrolling. Its useful inside a |
635 | C<on_add_lines> hook, though. |
694 | C<on_add_lines> hook, though. |
636 | |
695 | |
|
|
696 | =item $term->cmd_parse ($octets) |
|
|
697 | |
|
|
698 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
699 | locale-specific encoding of the terminal and can contain command sequences |
|
|
700 | (escape codes) that will be interpreted. |
|
|
701 | |
637 | =item $term->tt_write ($octets) |
702 | =item $term->tt_write ($octets) |
638 | |
703 | |
639 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
704 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
640 | pass characters instead of octets, you should convert your strings first |
705 | pass characters instead of octets, you should convert your strings first |
641 | to the locale-specific encoding using C<< $term->locale_encode >>. |
706 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
707 | |
|
|
708 | =item $windowid = $term->parent |
|
|
709 | |
|
|
710 | Return the window id of the toplevel window. |
|
|
711 | |
|
|
712 | =item $windowid = $term->vt |
|
|
713 | |
|
|
714 | Return the window id of the terminal window. |
642 | |
715 | |
643 | =item $window_width = $term->width |
716 | =item $window_width = $term->width |
644 | |
717 | |
645 | =item $window_height = $term->height |
718 | =item $window_height = $term->height |
646 | |
719 | |
… | |
… | |
735 | about the logical line that row C<$row_number> is part of. It supports the |
808 | about the logical line that row C<$row_number> is part of. It supports the |
736 | following methods: |
809 | following methods: |
737 | |
810 | |
738 | =over 4 |
811 | =over 4 |
739 | |
812 | |
740 | =item $text = $line->t |
813 | =item $text = $line->t ([$new_text]) |
741 | |
814 | |
742 | Returns the full text of the line, similar to C<ROW_t> |
815 | Returns or replaces the full text of the line, similar to C<ROW_t> |
743 | |
816 | |
744 | =item $rend = $line->r |
817 | =item $rend = $line->r ([$new_rend]) |
745 | |
818 | |
746 | Returns the full rendition array of the line, similar to C<ROW_r> |
819 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
747 | |
820 | |
748 | =item $length = $line->l |
821 | =item $length = $line->l |
749 | |
822 | |
750 | Returns the length of the line in cells, similar to C<ROW_l>. |
823 | Returns the length of the line in cells, similar to C<ROW_l>. |
751 | |
824 | |