… | |
… | |
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 |
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. If |
280 | 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. |
281 | the hook returns true, then the even will be ignored by rxvt-unicode. |
278 | |
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. |
|
|
286 | |
|
|
287 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
288 | output, if any, in locale-specific encoding. |
|
|
289 | |
279 | subwindow. |
290 | subwindow. |
280 | |
291 | |
281 | =back |
292 | =back |
282 | |
293 | |
283 | =head2 Variables in the C<urxvt> Package |
294 | =head2 Variables in the C<urxvt> Package |
284 | |
295 | |
285 | =over 4 |
296 | =over 4 |
286 | |
297 | |
287 | =item $urxvt::TERM |
298 | =item $urxvt::TERM |
288 | |
299 | |
289 | The current terminal. Whenever a callback/Hook is bein executed, this |
300 | The current terminal. This variable stores the current C<urxvt::term> |
290 | variable stores the current C<urxvt::term> object. |
301 | object, whenever a callback/hook is executing. |
291 | |
302 | |
292 | =back |
303 | =back |
293 | |
304 | |
294 | =head2 Functions in the C<urxvt> Package |
305 | =head2 Functions in the C<urxvt> Package |
295 | |
306 | |
… | |
… | |
320 | |
331 | |
321 | =item $time = urxvt::NOW |
332 | =item $time = urxvt::NOW |
322 | |
333 | |
323 | Returns the "current time" (as per the event loop). |
334 | Returns the "current time" (as per the event loop). |
324 | |
335 | |
|
|
336 | =item urxvt::CurrentTime |
|
|
337 | |
|
|
338 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
339 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
340 | Button4Mask, Button5Mask, AnyModifier |
|
|
341 | |
|
|
342 | Various constants for use in X events. |
|
|
343 | |
325 | =back |
344 | =back |
326 | |
345 | |
327 | =head2 RENDITION |
346 | =head2 RENDITION |
328 | |
347 | |
329 | Rendition bitsets contain information about colour, font, font styles and |
348 | Rendition bitsets contain information about colour, font, font styles and |
… | |
… | |
378 | |
397 | |
379 | =cut |
398 | =cut |
380 | |
399 | |
381 | package urxvt; |
400 | package urxvt; |
382 | |
401 | |
|
|
402 | use utf8; |
383 | use strict; |
403 | use strict; |
384 | use Scalar::Util (); |
404 | use Scalar::Util (); |
|
|
405 | use List::Util (); |
385 | |
406 | |
386 | our $TERM; |
407 | our $TERM; |
387 | our @HOOKNAME; |
408 | our @HOOKNAME; |
388 | our $LIBDIR; |
409 | our $LIBDIR; |
389 | |
410 | |
… | |
… | |
422 | $hook_count[$htype]++ |
443 | $hook_count[$htype]++ |
423 | or set_should_invoke $htype, 1; |
444 | or set_should_invoke $htype, 1; |
424 | } |
445 | } |
425 | } |
446 | } |
426 | |
447 | |
427 | my $script_pkg = "script0000"; |
448 | my $extension_pkg = "extension0000"; |
428 | my %script_pkg; |
449 | my %extension_pkg; |
429 | |
450 | |
430 | # load a single script into its own package, once only |
451 | # load a single script into its own package, once only |
431 | sub script_package($) { |
452 | sub extension_package($) { |
432 | my ($path) = @_; |
453 | my ($path) = @_; |
433 | |
454 | |
434 | $script_pkg{$path} ||= do { |
455 | $extension_pkg{$path} ||= do { |
435 | my $pkg = "urxvt::" . ($script_pkg++); |
456 | my $pkg = "urxvt::" . ($extension_pkg++); |
436 | |
457 | |
437 | verbose 3, "loading script '$path' into package '$pkg'"; |
458 | verbose 3, "loading extension '$path' into package '$pkg'"; |
438 | |
459 | |
439 | open my $fh, "<:raw", $path |
460 | open my $fh, "<:raw", $path |
440 | or die "$path: $!"; |
461 | or die "$path: $!"; |
441 | |
462 | |
442 | my $source = "package $pkg; use strict; use utf8;\n" |
463 | my $source = "package $pkg; use strict; use utf8;\n" |
|
|
464 | . "use base urxvt::term::proxy::;\n" |
443 | . "#line 1 \"$path\"\n{\n" |
465 | . "#line 1 \"$path\"\n{\n" |
444 | . (do { local $/; <$fh> }) |
466 | . (do { local $/; <$fh> }) |
445 | . "\n};\n1"; |
467 | . "\n};\n1"; |
446 | |
468 | |
447 | eval $source or die "$path: $@"; |
469 | eval $source or die "$path: $@"; |
… | |
… | |
458 | my $htype = shift; |
480 | my $htype = shift; |
459 | |
481 | |
460 | if ($htype == 0) { # INIT |
482 | if ($htype == 0) { # INIT |
461 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
483 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
462 | |
484 | |
463 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
485 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
464 | my @files = grep -f $_, map "$_/$ext", @dirs; |
486 | my @files = grep -f $_, map "$_/$ext", @dirs; |
465 | |
487 | |
466 | if (@files) { |
488 | if (@files) { |
467 | register_package script_package $files[0]; |
489 | register_package extension_package $files[0]; |
468 | } else { |
490 | } else { |
469 | warn "perl extension '$ext' not found in perl library search path\n"; |
491 | warn "perl extension '$ext' not found in perl library search path\n"; |
470 | } |
492 | } |
471 | } |
493 | } |
472 | } |
494 | } |
… | |
… | |
478 | if $verbosity >= 10; |
500 | if $verbosity >= 10; |
479 | |
501 | |
480 | keys %$cb; |
502 | keys %$cb; |
481 | |
503 | |
482 | while (my ($pkg, $cb) = each %$cb) { |
504 | while (my ($pkg, $cb) = each %$cb) { |
|
|
505 | eval { |
483 | $retval = $cb->( |
506 | $retval = $cb->( |
484 | $TERM->{_pkg}{$pkg} ||= do { |
507 | $TERM->{_pkg}{$pkg} ||= do { |
485 | my $proxy = bless { }, urxvt::term::proxy::; |
508 | my $proxy = bless { }, $pkg; |
486 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
509 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
487 | $proxy |
510 | $proxy |
488 | }, |
511 | }, |
489 | @_, |
512 | @_, |
490 | ) and last; |
513 | ) and last; |
|
|
514 | }; |
|
|
515 | warn $@ if $@;#d# |
491 | } |
516 | } |
492 | } |
517 | } |
493 | |
518 | |
494 | if ($htype == 1) { # DESTROY |
519 | if ($htype == 1) { # DESTROY |
495 | # remove hooks if unused |
520 | # remove hooks if unused |
… | |
… | |
521 | } |
546 | } |
522 | 1 |
547 | 1 |
523 | } or die "FATAL: unable to compile method forwarder: $@"; |
548 | } or die "FATAL: unable to compile method forwarder: $@"; |
524 | |
549 | |
525 | goto &$urxvt::term::proxy::AUTOLOAD; |
550 | goto &$urxvt::term::proxy::AUTOLOAD; |
|
|
551 | } |
|
|
552 | |
|
|
553 | sub urxvt::destroy_hook::DESTROY { |
|
|
554 | ${$_[0]}->(); |
|
|
555 | } |
|
|
556 | |
|
|
557 | sub urxvt::destroy_hook(&) { |
|
|
558 | bless \shift, urxvt::destroy_hook:: |
526 | } |
559 | } |
527 | |
560 | |
528 | =head2 The C<urxvt::term> Class |
561 | =head2 The C<urxvt::term> Class |
529 | |
562 | |
530 | =over 4 |
563 | =over 4 |
… | |
… | |
570 | =cut |
603 | =cut |
571 | |
604 | |
572 | sub urxvt::term::resource($$;$) { |
605 | sub urxvt::term::resource($$;$) { |
573 | my ($self, $name) = (shift, shift); |
606 | my ($self, $name) = (shift, shift); |
574 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
607 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
575 | goto &urxvt::term::_resource; |
608 | &urxvt::term::_resource |
576 | } |
609 | } |
577 | |
610 | |
578 | =item $rend = $term->rstyle ([$new_rstyle]) |
611 | =item $rend = $term->rstyle ([$new_rstyle]) |
579 | |
612 | |
580 | Return and optionally change the current rendition. Text that is output by |
613 | Return and optionally change the current rendition. Text that is output by |
… | |
… | |
656 | |
689 | |
657 | If hidden, display the overlay again. |
690 | If hidden, display the overlay again. |
658 | |
691 | |
659 | =back |
692 | =back |
660 | |
693 | |
|
|
694 | =item $popup = $term->popup ($event) |
|
|
695 | |
|
|
696 | Creates a new C<urxvt::popup> object that implements a popup menu. The |
|
|
697 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
|
|
698 | currently). |
|
|
699 | |
|
|
700 | =cut |
|
|
701 | |
|
|
702 | sub urxvt::term::popup { |
|
|
703 | my ($self, $event) = @_; |
|
|
704 | |
|
|
705 | $self->grab ($event->{time}, 1) |
|
|
706 | or return; |
|
|
707 | |
|
|
708 | my $popup = bless { |
|
|
709 | term => $self, |
|
|
710 | event => $event, |
|
|
711 | }, urxvt::popup::; |
|
|
712 | |
|
|
713 | Scalar::Util::weaken $popup->{term}; |
|
|
714 | |
|
|
715 | $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; |
|
|
716 | Scalar::Util::weaken $self->{_destroy}{$popup}; |
|
|
717 | |
|
|
718 | $popup |
|
|
719 | } |
|
|
720 | |
661 | =item $cellwidth = $term->strwidth $string |
721 | =item $cellwidth = $term->strwidth ($string) |
662 | |
722 | |
663 | Returns the number of screen-cells this string would need. Correctly |
723 | Returns the number of screen-cells this string would need. Correctly |
664 | accounts for wide and combining characters. |
724 | accounts for wide and combining characters. |
665 | |
725 | |
666 | =item $octets = $term->locale_encode $string |
726 | =item $octets = $term->locale_encode ($string) |
667 | |
727 | |
668 | Convert the given text string into the corresponding locale encoding. |
728 | Convert the given text string into the corresponding locale encoding. |
669 | |
729 | |
670 | =item $string = $term->locale_decode $octets |
730 | =item $string = $term->locale_decode ($octets) |
671 | |
731 | |
672 | Convert the given locale-encoded octets into a perl string. |
732 | Convert the given locale-encoded octets into a perl string. |
673 | |
733 | |
674 | =item $term->scr_add_lines ($string) |
734 | =item $term->scr_add_lines ($string) |
675 | |
735 | |
… | |
… | |
692 | |
752 | |
693 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
753 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
694 | pass characters instead of octets, you should convert your strings first |
754 | pass characters instead of octets, you should convert your strings first |
695 | to the locale-specific encoding using C<< $term->locale_encode >>. |
755 | to the locale-specific encoding using C<< $term->locale_encode >>. |
696 | |
756 | |
|
|
757 | =item $windowid = $term->parent |
|
|
758 | |
|
|
759 | Return the window id of the toplevel window. |
|
|
760 | |
|
|
761 | =item $windowid = $term->vt |
|
|
762 | |
|
|
763 | Return the window id of the terminal window. |
|
|
764 | |
697 | =item $window_width = $term->width |
765 | =item $window_width = $term->width |
698 | |
766 | |
699 | =item $window_height = $term->height |
767 | =item $window_height = $term->height |
700 | |
768 | |
701 | =item $font_width = $term->fwidth |
769 | =item $font_width = $term->fwidth |
… | |
… | |
717 | =item $nrow_plus_saveLines = $term->total_rows |
785 | =item $nrow_plus_saveLines = $term->total_rows |
718 | |
786 | |
719 | =item $lines_in_scrollback = $term->nsaved |
787 | =item $lines_in_scrollback = $term->nsaved |
720 | |
788 | |
721 | Return various integers describing terminal characteristics. |
789 | Return various integers describing terminal characteristics. |
|
|
790 | |
|
|
791 | =item $modifiermask = $term->ModLevel3Mask |
|
|
792 | |
|
|
793 | =item $modifiermask = $term->ModMetaMask |
|
|
794 | |
|
|
795 | =item $modifiermask = $term->ModNumLockMask |
|
|
796 | |
|
|
797 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
|
|
798 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
722 | |
799 | |
723 | =item $view_start = $term->view_start ([$newvalue]) |
800 | =item $view_start = $term->view_start ([$newvalue]) |
724 | |
801 | |
725 | Returns the negative row number of the topmost line. Minimum value is |
802 | Returns the negative row number of the topmost line. Minimum value is |
726 | C<0>, which displays the normal terminal contents. Larger values scroll |
803 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
907 | |
984 | |
908 | Converts rxvt-unicodes text reprsentation into a perl string. See |
985 | Converts rxvt-unicodes text reprsentation into a perl string. See |
909 | C<< $term->ROW_t >> for details. |
986 | C<< $term->ROW_t >> for details. |
910 | |
987 | |
911 | =back |
988 | =back |
|
|
989 | |
|
|
990 | =head2 The C<urxvt::popup> Class |
|
|
991 | |
|
|
992 | =over 4 |
|
|
993 | |
|
|
994 | =cut |
|
|
995 | |
|
|
996 | package urxvt::popup; |
|
|
997 | |
|
|
998 | sub add_item { |
|
|
999 | my ($self, $item) = @_; |
|
|
1000 | |
|
|
1001 | push @{ $self->{item} }, $item; |
|
|
1002 | } |
|
|
1003 | |
|
|
1004 | sub add_button { |
|
|
1005 | my ($self, $text, $cb) = @_; |
|
|
1006 | |
|
|
1007 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, |
|
|
1008 | render => sub { $_[0]{text} }, |
|
|
1009 | }); |
|
|
1010 | } |
|
|
1011 | |
|
|
1012 | sub add_toggle { |
|
|
1013 | my ($self, $text, $cb, $value) = @_; |
|
|
1014 | |
|
|
1015 | $self->add_item ({ type => "button", text => " $text", value => $value, |
|
|
1016 | render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 }, |
|
|
1017 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
|
|
1018 | }); |
|
|
1019 | } |
|
|
1020 | |
|
|
1021 | sub show { |
|
|
1022 | my ($self) = @_; |
|
|
1023 | |
|
|
1024 | local $urxvt::popup::self = $self; |
|
|
1025 | |
|
|
1026 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
|
|
1027 | "--transient-for" => $self->{term}->parent, |
|
|
1028 | "-pe" => "urxvt-popup") |
|
|
1029 | or die "unable to create popup window\n"; |
|
|
1030 | } |
|
|
1031 | |
|
|
1032 | sub DESTROY { |
|
|
1033 | my ($self) = @_; |
|
|
1034 | |
|
|
1035 | $self->{term}->ungrab; |
|
|
1036 | } |
912 | |
1037 | |
913 | =head2 The C<urxvt::timer> Class |
1038 | =head2 The C<urxvt::timer> Class |
914 | |
1039 | |
915 | This class implements timer watchers/events. Time is represented as a |
1040 | This class implements timer watchers/events. Time is represented as a |
916 | fractional number of seconds since the epoch. Example: |
1041 | fractional number of seconds since the epoch. Example: |