| … | |
… | |
| 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 |
| … | |
… | |
| 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 |
65 | =item mark-urls |
| 66 | |
66 | |
| 67 | Uses per-line filtering (C<on_line_update>) to underline urls. |
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. |
| 68 | |
74 | |
| 69 | =item example-refresh-hooks |
75 | =item example-refresh-hooks |
| 70 | |
76 | |
| 71 | 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 |
| 72 | window. Illustrates overwriting the refresh callbacks to create your own |
78 | window. Illustrates overwriting the refresh callbacks to create your own |
| 73 | overlays or changes. |
79 | overlays or changes. |
| 74 | |
|
|
| 75 | =item example-filter-input |
|
|
| 76 | |
|
|
| 77 | A not very useful example of filtering all text output to the terminal, by |
|
|
| 78 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
| 79 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
| 80 | when typing them) do not get marked. |
|
|
| 81 | |
80 | |
| 82 | =back |
81 | =back |
| 83 | |
82 | |
| 84 | =head2 General API Considerations |
83 | =head2 General API Considerations |
| 85 | |
84 | |
| … | |
… | |
| 117 | |
116 | |
| 118 | =back |
117 | =back |
| 119 | |
118 | |
| 120 | =head2 Hooks |
119 | =head2 Hooks |
| 121 | |
120 | |
| 122 | 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 |
| 123 | called whenever the relevant event happens. |
122 | called whenever the relevant event happens. |
| 124 | |
123 | |
| 125 | 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 |
| 126 | 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 |
| 127 | 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> |
| 128 | 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> |
| 129 | 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. |
| 130 | |
130 | |
| 131 | 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 |
| 132 | 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, |
| 133 | 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. |
| 134 | |
134 | |
| … | |
… | |
| 271 | |
271 | |
| 272 | =item on_button_release $term, $event |
272 | =item on_button_release $term, $event |
| 273 | |
273 | |
| 274 | =item on_motion_notify $term, $event |
274 | =item on_motion_notify $term, $event |
| 275 | |
275 | |
| 276 | Called whenever the corresponding X event is received for the terminal |
276 | Called whenever the corresponding X event is received for the terminal If |
| 277 | (see the XEvent manpage) If the hook returns true, then the even will be |
277 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 278 | 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. |
| 279 | |
282 | |
| 280 | C<on_key_press> additionally receives the string rxvt-unicode would |
283 | C<on_key_press> additionally receives the string rxvt-unicode would |
| 281 | output, if any, in locale-specific encoding. |
284 | output, if any, in locale-specific encoding. |
| 282 | |
285 | |
| 283 | subwindow. |
286 | subwindow. |
| … | |
… | |
| 288 | |
291 | |
| 289 | =over 4 |
292 | =over 4 |
| 290 | |
293 | |
| 291 | =item $urxvt::TERM |
294 | =item $urxvt::TERM |
| 292 | |
295 | |
| 293 | The current terminal. Whenever a callback/Hook is bein executed, this |
296 | The current terminal. This variable stores the current C<urxvt::term> |
| 294 | variable stores the current C<urxvt::term> object. |
297 | object, whenever a callback/hook is executing. |
| 295 | |
298 | |
| 296 | =back |
299 | =back |
| 297 | |
300 | |
| 298 | =head2 Functions in the C<urxvt> Package |
301 | =head2 Functions in the C<urxvt> Package |
| 299 | |
302 | |
| … | |
… | |
| 426 | $hook_count[$htype]++ |
429 | $hook_count[$htype]++ |
| 427 | or set_should_invoke $htype, 1; |
430 | or set_should_invoke $htype, 1; |
| 428 | } |
431 | } |
| 429 | } |
432 | } |
| 430 | |
433 | |
| 431 | my $script_pkg = "script0000"; |
434 | my $extension_pkg = "extension0000"; |
| 432 | my %script_pkg; |
435 | my %extension_pkg; |
| 433 | |
436 | |
| 434 | # load a single script into its own package, once only |
437 | # load a single script into its own package, once only |
| 435 | sub script_package($) { |
438 | sub extension_package($) { |
| 436 | my ($path) = @_; |
439 | my ($path) = @_; |
| 437 | |
440 | |
| 438 | $script_pkg{$path} ||= do { |
441 | $extension_pkg{$path} ||= do { |
| 439 | my $pkg = "urxvt::" . ($script_pkg++); |
442 | my $pkg = "urxvt::" . ($extension_pkg++); |
| 440 | |
443 | |
| 441 | verbose 3, "loading script '$path' into package '$pkg'"; |
444 | verbose 3, "loading extension '$path' into package '$pkg'"; |
| 442 | |
445 | |
| 443 | open my $fh, "<:raw", $path |
446 | open my $fh, "<:raw", $path |
| 444 | or die "$path: $!"; |
447 | or die "$path: $!"; |
| 445 | |
448 | |
| 446 | 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" |
| 447 | . "#line 1 \"$path\"\n{\n" |
451 | . "#line 1 \"$path\"\n{\n" |
| 448 | . (do { local $/; <$fh> }) |
452 | . (do { local $/; <$fh> }) |
| 449 | . "\n};\n1"; |
453 | . "\n};\n1"; |
| 450 | |
454 | |
| 451 | eval $source or die "$path: $@"; |
455 | eval $source or die "$path: $@"; |
| … | |
… | |
| 462 | my $htype = shift; |
466 | my $htype = shift; |
| 463 | |
467 | |
| 464 | if ($htype == 0) { # INIT |
468 | if ($htype == 0) { # INIT |
| 465 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
469 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
| 466 | |
470 | |
| 467 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
471 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
| 468 | my @files = grep -f $_, map "$_/$ext", @dirs; |
472 | my @files = grep -f $_, map "$_/$ext", @dirs; |
| 469 | |
473 | |
| 470 | if (@files) { |
474 | if (@files) { |
| 471 | register_package script_package $files[0]; |
475 | register_package extension_package $files[0]; |
| 472 | } else { |
476 | } else { |
| 473 | 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"; |
| 474 | } |
478 | } |
| 475 | } |
479 | } |
| 476 | } |
480 | } |
| … | |
… | |
| 482 | if $verbosity >= 10; |
486 | if $verbosity >= 10; |
| 483 | |
487 | |
| 484 | keys %$cb; |
488 | keys %$cb; |
| 485 | |
489 | |
| 486 | while (my ($pkg, $cb) = each %$cb) { |
490 | while (my ($pkg, $cb) = each %$cb) { |
|
|
491 | eval { |
| 487 | $retval = $cb->( |
492 | $retval = $cb->( |
| 488 | $TERM->{_pkg}{$pkg} ||= do { |
493 | $TERM->{_pkg}{$pkg} ||= do { |
| 489 | my $proxy = bless { }, urxvt::term::proxy::; |
494 | my $proxy = bless { }, $pkg; |
| 490 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
495 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
| 491 | $proxy |
496 | $proxy |
| 492 | }, |
497 | }, |
| 493 | @_, |
498 | @_, |
| 494 | ) and last; |
499 | ) and last; |
|
|
500 | }; |
|
|
501 | warn $@ if $@;#d# |
| 495 | } |
502 | } |
| 496 | } |
503 | } |
| 497 | |
504 | |
| 498 | if ($htype == 1) { # DESTROY |
505 | if ($htype == 1) { # DESTROY |
| 499 | # remove hooks if unused |
506 | # remove hooks if unused |
| … | |
… | |
| 660 | |
667 | |
| 661 | If hidden, display the overlay again. |
668 | If hidden, display the overlay again. |
| 662 | |
669 | |
| 663 | =back |
670 | =back |
| 664 | |
671 | |
| 665 | =item $cellwidth = $term->strwidth $string |
672 | =item $cellwidth = $term->strwidth ($string) |
| 666 | |
673 | |
| 667 | Returns the number of screen-cells this string would need. Correctly |
674 | Returns the number of screen-cells this string would need. Correctly |
| 668 | accounts for wide and combining characters. |
675 | accounts for wide and combining characters. |
| 669 | |
676 | |
| 670 | =item $octets = $term->locale_encode $string |
677 | =item $octets = $term->locale_encode ($string) |
| 671 | |
678 | |
| 672 | Convert the given text string into the corresponding locale encoding. |
679 | Convert the given text string into the corresponding locale encoding. |
| 673 | |
680 | |
| 674 | =item $string = $term->locale_decode $octets |
681 | =item $string = $term->locale_decode ($octets) |
| 675 | |
682 | |
| 676 | Convert the given locale-encoded octets into a perl string. |
683 | Convert the given locale-encoded octets into a perl string. |
| 677 | |
684 | |
| 678 | =item $term->scr_add_lines ($string) |
685 | =item $term->scr_add_lines ($string) |
| 679 | |
686 | |
| … | |
… | |
| 695 | =item $term->tt_write ($octets) |
702 | =item $term->tt_write ($octets) |
| 696 | |
703 | |
| 697 | 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 |
| 698 | pass characters instead of octets, you should convert your strings first |
705 | pass characters instead of octets, you should convert your strings first |
| 699 | 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. |
| 700 | |
715 | |
| 701 | =item $window_width = $term->width |
716 | =item $window_width = $term->width |
| 702 | |
717 | |
| 703 | =item $window_height = $term->height |
718 | =item $window_height = $term->height |
| 704 | |
719 | |
