| … | |
… | |
| 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 | |
| … | |
… | |
| 178 | click) and is either supposed to return false (normal operation), or |
178 | click) and is either supposed to return false (normal operation), or |
| 179 | should extend the selection itelf and return true to suppress the built-in |
179 | should extend the selection itelf and return true to suppress the built-in |
| 180 | processing. |
180 | processing. |
| 181 | |
181 | |
| 182 | See the F<selection> example extension. |
182 | See the F<selection> example extension. |
| 183 | |
|
|
| 184 | =item on_focus_in $term |
|
|
| 185 | |
|
|
| 186 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
| 187 | focus in processing. |
|
|
| 188 | |
|
|
| 189 | =item on_focus_out $term |
|
|
| 190 | |
|
|
| 191 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
| 192 | out processing. |
|
|
| 193 | |
183 | |
| 194 | =item on_view_change $term, $offset |
184 | =item on_view_change $term, $offset |
| 195 | |
185 | |
| 196 | Called whenever the view offset changes, i..e the user or program |
186 | Called whenever the view offset changes, i..e the user or program |
| 197 | scrolls. Offset C<0> means display the normal terminal, positive values |
187 | scrolls. Offset C<0> means display the normal terminal, positive values |
| … | |
… | |
| 261 | |
251 | |
| 262 | Called whenever the user presses a key combination that has a |
252 | Called whenever the user presses a key combination that has a |
| 263 | C<perl:string> action bound to it (see description of the B<keysym> |
253 | C<perl:string> action bound to it (see description of the B<keysym> |
| 264 | resource in the @@RXVT_NAME@@(1) manpage). |
254 | resource in the @@RXVT_NAME@@(1) manpage). |
| 265 | |
255 | |
|
|
256 | =item on_focus_in $term |
|
|
257 | |
|
|
258 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
259 | does focus in processing. |
|
|
260 | |
|
|
261 | =item on_focus_out $term |
|
|
262 | |
|
|
263 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
264 | focus out processing. |
|
|
265 | |
| 266 | =item on_key_press $term, $event, $octets |
266 | =item on_key_press $term, $event, $octets |
| 267 | |
267 | |
| 268 | =item on_key_release $term, $event |
268 | =item on_key_release $term, $event |
| 269 | |
269 | |
| 270 | =item on_button_press $term, $event |
270 | =item on_button_press $term, $event |
| 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 | =item on_map_notify $term, $event |
|
|
277 | |
|
|
278 | =item on_unmap_notify $term, $event |
|
|
279 | |
| 276 | Called whenever the corresponding X event is received for the terminal |
280 | 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 |
281 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 278 | ignored by rxvt-unicode. |
282 | |
|
|
283 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
284 | manpage), with the additional members C<row> and C<col>, which are the row |
|
|
285 | and column under the mouse cursor. |
| 279 | |
286 | |
| 280 | C<on_key_press> additionally receives the string rxvt-unicode would |
287 | C<on_key_press> additionally receives the string rxvt-unicode would |
| 281 | output, if any, in locale-specific encoding. |
288 | output, if any, in locale-specific encoding. |
| 282 | |
289 | |
| 283 | subwindow. |
290 | subwindow. |
| … | |
… | |
| 288 | |
295 | |
| 289 | =over 4 |
296 | =over 4 |
| 290 | |
297 | |
| 291 | =item $urxvt::TERM |
298 | =item $urxvt::TERM |
| 292 | |
299 | |
| 293 | The current terminal. Whenever a callback/Hook is bein executed, this |
300 | The current terminal. This variable stores the current C<urxvt::term> |
| 294 | variable stores the current C<urxvt::term> object. |
301 | object, whenever a callback/hook is executing. |
| 295 | |
302 | |
| 296 | =back |
303 | =back |
| 297 | |
304 | |
| 298 | =head2 Functions in the C<urxvt> Package |
305 | =head2 Functions in the C<urxvt> Package |
| 299 | |
306 | |
| … | |
… | |
| 426 | $hook_count[$htype]++ |
433 | $hook_count[$htype]++ |
| 427 | or set_should_invoke $htype, 1; |
434 | or set_should_invoke $htype, 1; |
| 428 | } |
435 | } |
| 429 | } |
436 | } |
| 430 | |
437 | |
| 431 | my $script_pkg = "script0000"; |
438 | my $extension_pkg = "extension0000"; |
| 432 | my %script_pkg; |
439 | my %extension_pkg; |
| 433 | |
440 | |
| 434 | # load a single script into its own package, once only |
441 | # load a single script into its own package, once only |
| 435 | sub script_package($) { |
442 | sub extension_package($) { |
| 436 | my ($path) = @_; |
443 | my ($path) = @_; |
| 437 | |
444 | |
| 438 | $script_pkg{$path} ||= do { |
445 | $extension_pkg{$path} ||= do { |
| 439 | my $pkg = "urxvt::" . ($script_pkg++); |
446 | my $pkg = "urxvt::" . ($extension_pkg++); |
| 440 | |
447 | |
| 441 | verbose 3, "loading script '$path' into package '$pkg'"; |
448 | verbose 3, "loading extension '$path' into package '$pkg'"; |
| 442 | |
449 | |
| 443 | open my $fh, "<:raw", $path |
450 | open my $fh, "<:raw", $path |
| 444 | or die "$path: $!"; |
451 | or die "$path: $!"; |
| 445 | |
452 | |
| 446 | my $source = "package $pkg; use strict; use utf8;\n" |
453 | my $source = "package $pkg; use strict; use utf8;\n" |
|
|
454 | . "use base urxvt::term::proxy::;\n" |
| 447 | . "#line 1 \"$path\"\n{\n" |
455 | . "#line 1 \"$path\"\n{\n" |
| 448 | . (do { local $/; <$fh> }) |
456 | . (do { local $/; <$fh> }) |
| 449 | . "\n};\n1"; |
457 | . "\n};\n1"; |
| 450 | |
458 | |
| 451 | eval $source or die "$path: $@"; |
459 | eval $source or die "$path: $@"; |
| … | |
… | |
| 462 | my $htype = shift; |
470 | my $htype = shift; |
| 463 | |
471 | |
| 464 | if ($htype == 0) { # INIT |
472 | if ($htype == 0) { # INIT |
| 465 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
473 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
| 466 | |
474 | |
| 467 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
475 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
| 468 | my @files = grep -f $_, map "$_/$ext", @dirs; |
476 | my @files = grep -f $_, map "$_/$ext", @dirs; |
| 469 | |
477 | |
| 470 | if (@files) { |
478 | if (@files) { |
| 471 | register_package script_package $files[0]; |
479 | register_package extension_package $files[0]; |
| 472 | } else { |
480 | } else { |
| 473 | warn "perl extension '$ext' not found in perl library search path\n"; |
481 | warn "perl extension '$ext' not found in perl library search path\n"; |
| 474 | } |
482 | } |
| 475 | } |
483 | } |
| 476 | } |
484 | } |
| … | |
… | |
| 482 | if $verbosity >= 10; |
490 | if $verbosity >= 10; |
| 483 | |
491 | |
| 484 | keys %$cb; |
492 | keys %$cb; |
| 485 | |
493 | |
| 486 | while (my ($pkg, $cb) = each %$cb) { |
494 | while (my ($pkg, $cb) = each %$cb) { |
|
|
495 | eval { |
| 487 | $retval = $cb->( |
496 | $retval = $cb->( |
| 488 | $TERM->{_pkg}{$pkg} ||= do { |
497 | $TERM->{_pkg}{$pkg} ||= do { |
| 489 | my $proxy = bless { }, urxvt::term::proxy::; |
498 | my $proxy = bless { }, $pkg; |
| 490 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
499 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
| 491 | $proxy |
500 | $proxy |
| 492 | }, |
501 | }, |
| 493 | @_, |
502 | @_, |
| 494 | ) and last; |
503 | ) and last; |
|
|
504 | }; |
|
|
505 | warn $@ if $@;#d# |
| 495 | } |
506 | } |
| 496 | } |
507 | } |
| 497 | |
508 | |
| 498 | if ($htype == 1) { # DESTROY |
509 | if ($htype == 1) { # DESTROY |
| 499 | # remove hooks if unused |
510 | # remove hooks if unused |
| … | |
… | |
| 525 | } |
536 | } |
| 526 | 1 |
537 | 1 |
| 527 | } or die "FATAL: unable to compile method forwarder: $@"; |
538 | } or die "FATAL: unable to compile method forwarder: $@"; |
| 528 | |
539 | |
| 529 | goto &$urxvt::term::proxy::AUTOLOAD; |
540 | goto &$urxvt::term::proxy::AUTOLOAD; |
|
|
541 | } |
|
|
542 | |
|
|
543 | sub urxvt::destroy_hook::DESTROY { |
|
|
544 | ${$_[0]}->(); |
|
|
545 | } |
|
|
546 | |
|
|
547 | sub urxvt::destroy_hook(&) { |
|
|
548 | bless \shift, urxvt::destroy_hook:: |
| 530 | } |
549 | } |
| 531 | |
550 | |
| 532 | =head2 The C<urxvt::term> Class |
551 | =head2 The C<urxvt::term> Class |
| 533 | |
552 | |
| 534 | =over 4 |
553 | =over 4 |
| … | |
… | |
| 574 | =cut |
593 | =cut |
| 575 | |
594 | |
| 576 | sub urxvt::term::resource($$;$) { |
595 | sub urxvt::term::resource($$;$) { |
| 577 | my ($self, $name) = (shift, shift); |
596 | my ($self, $name) = (shift, shift); |
| 578 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
597 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
| 579 | goto &urxvt::term::_resource; |
598 | &urxvt::term::_resource |
| 580 | } |
599 | } |
| 581 | |
600 | |
| 582 | =item $rend = $term->rstyle ([$new_rstyle]) |
601 | =item $rend = $term->rstyle ([$new_rstyle]) |
| 583 | |
602 | |
| 584 | Return and optionally change the current rendition. Text that is output by |
603 | Return and optionally change the current rendition. Text that is output by |
| … | |
… | |
| 660 | |
679 | |
| 661 | If hidden, display the overlay again. |
680 | If hidden, display the overlay again. |
| 662 | |
681 | |
| 663 | =back |
682 | =back |
| 664 | |
683 | |
|
|
684 | =item $popup = $term->popup ($event) |
|
|
685 | |
|
|
686 | Creates a new C<urxvt::popup> object that implements a popup menu. The |
|
|
687 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
|
|
688 | currently). |
|
|
689 | |
|
|
690 | =cut |
|
|
691 | |
|
|
692 | sub urxvt::term::popup { |
|
|
693 | my ($self, $event) = @_; |
|
|
694 | |
|
|
695 | $self->grab ($event->{time}, 1) |
|
|
696 | or return; |
|
|
697 | |
|
|
698 | my $popup = bless { |
|
|
699 | term => $self, |
|
|
700 | event => $event, |
|
|
701 | }, urxvt::popup::; |
|
|
702 | |
|
|
703 | Scalar::Util::weaken $popup->{term}; |
|
|
704 | |
|
|
705 | $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; |
|
|
706 | Scalar::Util::weaken $self->{_destroy}{$popup}; |
|
|
707 | |
|
|
708 | $popup |
|
|
709 | } |
|
|
710 | |
| 665 | =item $cellwidth = $term->strwidth $string |
711 | =item $cellwidth = $term->strwidth ($string) |
| 666 | |
712 | |
| 667 | Returns the number of screen-cells this string would need. Correctly |
713 | Returns the number of screen-cells this string would need. Correctly |
| 668 | accounts for wide and combining characters. |
714 | accounts for wide and combining characters. |
| 669 | |
715 | |
| 670 | =item $octets = $term->locale_encode $string |
716 | =item $octets = $term->locale_encode ($string) |
| 671 | |
717 | |
| 672 | Convert the given text string into the corresponding locale encoding. |
718 | Convert the given text string into the corresponding locale encoding. |
| 673 | |
719 | |
| 674 | =item $string = $term->locale_decode $octets |
720 | =item $string = $term->locale_decode ($octets) |
| 675 | |
721 | |
| 676 | Convert the given locale-encoded octets into a perl string. |
722 | Convert the given locale-encoded octets into a perl string. |
| 677 | |
723 | |
| 678 | =item $term->scr_add_lines ($string) |
724 | =item $term->scr_add_lines ($string) |
| 679 | |
725 | |
| … | |
… | |
| 695 | =item $term->tt_write ($octets) |
741 | =item $term->tt_write ($octets) |
| 696 | |
742 | |
| 697 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
743 | 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 |
744 | pass characters instead of octets, you should convert your strings first |
| 699 | to the locale-specific encoding using C<< $term->locale_encode >>. |
745 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
746 | |
|
|
747 | =item $windowid = $term->parent |
|
|
748 | |
|
|
749 | Return the window id of the toplevel window. |
|
|
750 | |
|
|
751 | =item $windowid = $term->vt |
|
|
752 | |
|
|
753 | Return the window id of the terminal window. |
| 700 | |
754 | |
| 701 | =item $window_width = $term->width |
755 | =item $window_width = $term->width |
| 702 | |
756 | |
| 703 | =item $window_height = $term->height |
757 | =item $window_height = $term->height |
| 704 | |
758 | |
| … | |
… | |
| 911 | |
965 | |
| 912 | Converts rxvt-unicodes text reprsentation into a perl string. See |
966 | Converts rxvt-unicodes text reprsentation into a perl string. See |
| 913 | C<< $term->ROW_t >> for details. |
967 | C<< $term->ROW_t >> for details. |
| 914 | |
968 | |
| 915 | =back |
969 | =back |
|
|
970 | |
|
|
971 | =head2 The C<urxvt::popup> Class |
|
|
972 | |
|
|
973 | =over 4 |
|
|
974 | |
|
|
975 | =cut |
|
|
976 | |
|
|
977 | package urxvt::popup; |
|
|
978 | |
|
|
979 | sub add_item { |
|
|
980 | my ($self, $item) = @_; |
|
|
981 | |
|
|
982 | push @{ $self->{item} }, $item; |
|
|
983 | } |
|
|
984 | |
|
|
985 | sub add_button { |
|
|
986 | my ($self, $text, $cb) = @_; |
|
|
987 | |
|
|
988 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); |
|
|
989 | } |
|
|
990 | |
|
|
991 | sub show { |
|
|
992 | my ($self) = @_; |
|
|
993 | |
|
|
994 | local $urxvt::popup::self = $self; |
|
|
995 | |
|
|
996 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
|
|
997 | "--transient-for" => $self->{term}->parent, |
|
|
998 | "-pe" => "urxvt_popup") |
|
|
999 | or die "unable to create popup window\n"; |
|
|
1000 | } |
|
|
1001 | |
|
|
1002 | sub DESTROY { |
|
|
1003 | my ($self) = @_; |
|
|
1004 | |
|
|
1005 | $self->{term}->ungrab; |
|
|
1006 | } |
| 916 | |
1007 | |
| 917 | =head2 The C<urxvt::timer> Class |
1008 | =head2 The C<urxvt::timer> Class |
| 918 | |
1009 | |
| 919 | This class implements timer watchers/events. Time is represented as a |
1010 | This class implements timer watchers/events. Time is represented as a |
| 920 | fractional number of seconds since the epoch. Example: |
1011 | fractional number of seconds since the epoch. Example: |
