… | |
… | |
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 |
… | |
… | |
120 | |
120 | |
121 | The following subroutines can be declared in extension files, and will be |
121 | The following subroutines can be declared in extension files, and will be |
122 | called whenever the relevant event happens. |
122 | called whenever the relevant event happens. |
123 | |
123 | |
124 | 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 |
125 | 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 |
126 | 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> |
127 | 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> |
128 | 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. |
129 | |
130 | |
130 | 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 |
131 | 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, |
132 | 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. |
133 | |
134 | |
… | |
… | |
177 | click) and is either supposed to return false (normal operation), or |
178 | click) and is either supposed to return false (normal operation), or |
178 | 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 |
179 | processing. |
180 | processing. |
180 | |
181 | |
181 | See the F<selection> example extension. |
182 | See the F<selection> example extension. |
182 | |
|
|
183 | =item on_focus_in $term |
|
|
184 | |
|
|
185 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
186 | focus in processing. |
|
|
187 | |
|
|
188 | =item on_focus_out $term |
|
|
189 | |
|
|
190 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
191 | out processing. |
|
|
192 | |
183 | |
193 | =item on_view_change $term, $offset |
184 | =item on_view_change $term, $offset |
194 | |
185 | |
195 | 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 |
196 | scrolls. Offset C<0> means display the normal terminal, positive values |
187 | scrolls. Offset C<0> means display the normal terminal, positive values |
… | |
… | |
260 | |
251 | |
261 | Called whenever the user presses a key combination that has a |
252 | Called whenever the user presses a key combination that has a |
262 | 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> |
263 | resource in the @@RXVT_NAME@@(1) manpage). |
254 | resource in the @@RXVT_NAME@@(1) manpage). |
264 | |
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 | |
265 | =item on_key_press $term, $event, $octets |
266 | =item on_key_press $term, $event, $octets |
266 | |
267 | |
267 | =item on_key_release $term, $event |
268 | =item on_key_release $term, $event |
268 | |
269 | |
269 | =item on_button_press $term, $event |
270 | =item on_button_press $term, $event |
270 | |
271 | |
271 | =item on_button_release $term, $event |
272 | =item on_button_release $term, $event |
272 | |
273 | |
273 | =item on_motion_notify $term, $event |
274 | =item on_motion_notify $term, $event |
|
|
275 | |
|
|
276 | =item on_map_notify $term, $event |
|
|
277 | |
|
|
278 | =item on_unmap_notify $term, $event |
274 | |
279 | |
275 | 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 |
276 | 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. |
277 | |
282 | |
278 | The event is a hash with most values as named by Xlib (see the XEvent |
283 | The event is a hash with most values as named by Xlib (see the XEvent |
… | |
… | |
326 | |
331 | |
327 | =item $time = urxvt::NOW |
332 | =item $time = urxvt::NOW |
328 | |
333 | |
329 | Returns the "current time" (as per the event loop). |
334 | Returns the "current time" (as per the event loop). |
330 | |
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 | |
331 | =back |
344 | =back |
332 | |
345 | |
333 | =head2 RENDITION |
346 | =head2 RENDITION |
334 | |
347 | |
335 | Rendition bitsets contain information about colour, font, font styles and |
348 | Rendition bitsets contain information about colour, font, font styles and |
… | |
… | |
384 | |
397 | |
385 | =cut |
398 | =cut |
386 | |
399 | |
387 | package urxvt; |
400 | package urxvt; |
388 | |
401 | |
|
|
402 | use utf8; |
389 | use strict; |
403 | use strict; |
390 | use Scalar::Util (); |
404 | use Scalar::Util (); |
|
|
405 | use List::Util (); |
391 | |
406 | |
392 | our $TERM; |
407 | our $TERM; |
393 | our @HOOKNAME; |
408 | our @HOOKNAME; |
|
|
409 | our %OPTION; |
394 | our $LIBDIR; |
410 | our $LIBDIR; |
395 | |
411 | |
396 | BEGIN { |
412 | BEGIN { |
397 | urxvt->bootstrap; |
413 | urxvt->bootstrap; |
398 | |
414 | |
… | |
… | |
428 | $hook_count[$htype]++ |
444 | $hook_count[$htype]++ |
429 | or set_should_invoke $htype, 1; |
445 | or set_should_invoke $htype, 1; |
430 | } |
446 | } |
431 | } |
447 | } |
432 | |
448 | |
433 | my $script_pkg = "script0000"; |
449 | my $extension_pkg = "extension0000"; |
434 | my %script_pkg; |
450 | my %extension_pkg; |
435 | |
451 | |
436 | # load a single script into its own package, once only |
452 | # load a single script into its own package, once only |
437 | sub script_package($) { |
453 | sub extension_package($) { |
438 | my ($path) = @_; |
454 | my ($path) = @_; |
439 | |
455 | |
440 | $script_pkg{$path} ||= do { |
456 | $extension_pkg{$path} ||= do { |
441 | my $pkg = "urxvt::" . ($script_pkg++); |
457 | my $pkg = "urxvt::" . ($extension_pkg++); |
442 | |
458 | |
443 | verbose 3, "loading script '$path' into package '$pkg'"; |
459 | verbose 3, "loading extension '$path' into package '$pkg'"; |
444 | |
460 | |
445 | open my $fh, "<:raw", $path |
461 | open my $fh, "<:raw", $path |
446 | or die "$path: $!"; |
462 | or die "$path: $!"; |
447 | |
463 | |
448 | my $source = "package $pkg; use strict; use utf8;\n" |
464 | my $source = "package $pkg; use strict; use utf8;\n" |
|
|
465 | . "use base urxvt::term::proxy::;\n" |
449 | . "#line 1 \"$path\"\n{\n" |
466 | . "#line 1 \"$path\"\n{\n" |
450 | . (do { local $/; <$fh> }) |
467 | . (do { local $/; <$fh> }) |
451 | . "\n};\n1"; |
468 | . "\n};\n1"; |
452 | |
469 | |
453 | eval $source or die "$path: $@"; |
470 | eval $source or die "$path: $@"; |
… | |
… | |
463 | local $TERM = shift; |
480 | local $TERM = shift; |
464 | my $htype = shift; |
481 | my $htype = shift; |
465 | |
482 | |
466 | if ($htype == 0) { # INIT |
483 | if ($htype == 0) { # INIT |
467 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
484 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
|
|
485 | |
|
|
486 | my %want_ext; |
468 | |
487 | |
469 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
488 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
|
|
489 | if ($_ eq "default") { |
|
|
490 | $want_ext{$_}++ for qw(selection option-popup); |
|
|
491 | } elsif (/^-(.*)$/) { |
|
|
492 | delete $want_ext{$1}; |
|
|
493 | } else { |
|
|
494 | $want_ext{$_}++; |
|
|
495 | } |
|
|
496 | } |
|
|
497 | |
|
|
498 | for my $ext (keys %want_ext) { |
470 | my @files = grep -f $_, map "$_/$ext", @dirs; |
499 | my @files = grep -f $_, map "$_/$ext", @dirs; |
471 | |
500 | |
472 | if (@files) { |
501 | if (@files) { |
473 | register_package script_package $files[0]; |
502 | register_package extension_package $files[0]; |
474 | } else { |
503 | } else { |
475 | warn "perl extension '$ext' not found in perl library search path\n"; |
504 | warn "perl extension '$ext' not found in perl library search path\n"; |
476 | } |
505 | } |
477 | } |
506 | } |
478 | } |
507 | } |
… | |
… | |
484 | if $verbosity >= 10; |
513 | if $verbosity >= 10; |
485 | |
514 | |
486 | keys %$cb; |
515 | keys %$cb; |
487 | |
516 | |
488 | while (my ($pkg, $cb) = each %$cb) { |
517 | while (my ($pkg, $cb) = each %$cb) { |
|
|
518 | eval { |
489 | $retval = $cb->( |
519 | $retval = $cb->( |
490 | $TERM->{_pkg}{$pkg} ||= do { |
520 | $TERM->{_pkg}{$pkg} ||= do { |
491 | my $proxy = bless { }, urxvt::term::proxy::; |
521 | my $proxy = bless { }, $pkg; |
492 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
522 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
493 | $proxy |
523 | $proxy |
494 | }, |
524 | }, |
495 | @_, |
525 | @_, |
496 | ) and last; |
526 | ) and last; |
|
|
527 | }; |
|
|
528 | warn $@ if $@;#d# |
497 | } |
529 | } |
498 | } |
530 | } |
499 | |
531 | |
500 | if ($htype == 1) { # DESTROY |
532 | if ($htype == 1) { # DESTROY |
501 | # remove hooks if unused |
533 | # remove hooks if unused |
… | |
… | |
529 | } or die "FATAL: unable to compile method forwarder: $@"; |
561 | } or die "FATAL: unable to compile method forwarder: $@"; |
530 | |
562 | |
531 | goto &$urxvt::term::proxy::AUTOLOAD; |
563 | goto &$urxvt::term::proxy::AUTOLOAD; |
532 | } |
564 | } |
533 | |
565 | |
|
|
566 | sub urxvt::destroy_hook::DESTROY { |
|
|
567 | ${$_[0]}->(); |
|
|
568 | } |
|
|
569 | |
|
|
570 | sub urxvt::destroy_hook(&) { |
|
|
571 | bless \shift, urxvt::destroy_hook:: |
|
|
572 | } |
|
|
573 | |
534 | =head2 The C<urxvt::term> Class |
574 | =head2 The C<urxvt::term> Class |
535 | |
575 | |
536 | =over 4 |
576 | =over 4 |
537 | |
577 | |
538 | =item $term->destroy |
578 | =item $term->destroy |
539 | |
579 | |
540 | Destroy the terminal object (close the window, free resources etc.). |
580 | Destroy the terminal object (close the window, free resources etc.). |
|
|
581 | |
|
|
582 | =item $isset = $term->option ($optval[, $set]) |
|
|
583 | |
|
|
584 | Returns true if the option specified by C<$optval> is enabled, and |
|
|
585 | optionally change it. All option values are stored by name in the hash |
|
|
586 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
|
|
587 | |
|
|
588 | Here is a a likely non-exhaustive list of option names, please see the |
|
|
589 | source file F</src/optinc.h> to see the actual list: |
|
|
590 | |
|
|
591 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
592 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
593 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
594 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
595 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
596 | tripleclickwords utmpInhibit visualBell |
541 | |
597 | |
542 | =item $value = $term->resource ($name[, $newval]) |
598 | =item $value = $term->resource ($name[, $newval]) |
543 | |
599 | |
544 | Returns the current resource value associated with a given name and |
600 | Returns the current resource value associated with a given name and |
545 | optionally sets a new value. Setting values is most useful in the C<init> |
601 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
555 | |
611 | |
556 | Please note that resource strings will currently only be freed when the |
612 | Please note that resource strings will currently only be freed when the |
557 | terminal is destroyed, so changing options frequently will eat memory. |
613 | terminal is destroyed, so changing options frequently will eat memory. |
558 | |
614 | |
559 | Here is a a likely non-exhaustive list of resource names, not all of which |
615 | Here is a a likely non-exhaustive list of resource names, not all of which |
560 | are supported in every build, please see the source to see the actual |
616 | are supported in every build, please see the source file F</src/rsinc.h> |
561 | list: |
617 | to see the actual list: |
562 | |
618 | |
563 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
619 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
564 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
620 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
565 | display_name embed ext_bwidth fade font geometry hold iconName |
621 | display_name embed ext_bwidth fade font geometry hold iconName |
566 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
622 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
… | |
… | |
576 | =cut |
632 | =cut |
577 | |
633 | |
578 | sub urxvt::term::resource($$;$) { |
634 | sub urxvt::term::resource($$;$) { |
579 | my ($self, $name) = (shift, shift); |
635 | my ($self, $name) = (shift, shift); |
580 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
636 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
581 | goto &urxvt::term::_resource; |
637 | &urxvt::term::_resource |
582 | } |
638 | } |
583 | |
639 | |
584 | =item $rend = $term->rstyle ([$new_rstyle]) |
640 | =item $rend = $term->rstyle ([$new_rstyle]) |
585 | |
641 | |
586 | Return and optionally change the current rendition. Text that is output by |
642 | Return and optionally change the current rendition. Text that is output by |
… | |
… | |
662 | |
718 | |
663 | If hidden, display the overlay again. |
719 | If hidden, display the overlay again. |
664 | |
720 | |
665 | =back |
721 | =back |
666 | |
722 | |
|
|
723 | =item $popup = $term->popup ($event) |
|
|
724 | |
|
|
725 | Creates a new C<urxvt::popup> object that implements a popup menu. The |
|
|
726 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
|
|
727 | currently). |
|
|
728 | |
|
|
729 | =cut |
|
|
730 | |
|
|
731 | sub urxvt::term::popup { |
|
|
732 | my ($self, $event) = @_; |
|
|
733 | |
|
|
734 | $self->grab ($event->{time}, 1) |
|
|
735 | or return; |
|
|
736 | |
|
|
737 | my $popup = bless { |
|
|
738 | term => $self, |
|
|
739 | event => $event, |
|
|
740 | }, urxvt::popup::; |
|
|
741 | |
|
|
742 | Scalar::Util::weaken $popup->{term}; |
|
|
743 | |
|
|
744 | $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; |
|
|
745 | Scalar::Util::weaken $self->{_destroy}{$popup}; |
|
|
746 | |
|
|
747 | $popup |
|
|
748 | } |
|
|
749 | |
667 | =item $cellwidth = $term->strwidth ($string) |
750 | =item $cellwidth = $term->strwidth ($string) |
668 | |
751 | |
669 | Returns the number of screen-cells this string would need. Correctly |
752 | Returns the number of screen-cells this string would need. Correctly |
670 | accounts for wide and combining characters. |
753 | accounts for wide and combining characters. |
671 | |
754 | |
… | |
… | |
731 | =item $nrow_plus_saveLines = $term->total_rows |
814 | =item $nrow_plus_saveLines = $term->total_rows |
732 | |
815 | |
733 | =item $lines_in_scrollback = $term->nsaved |
816 | =item $lines_in_scrollback = $term->nsaved |
734 | |
817 | |
735 | Return various integers describing terminal characteristics. |
818 | Return various integers describing terminal characteristics. |
|
|
819 | |
|
|
820 | =item $modifiermask = $term->ModLevel3Mask |
|
|
821 | |
|
|
822 | =item $modifiermask = $term->ModMetaMask |
|
|
823 | |
|
|
824 | =item $modifiermask = $term->ModNumLockMask |
|
|
825 | |
|
|
826 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
|
|
827 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
736 | |
828 | |
737 | =item $view_start = $term->view_start ([$newvalue]) |
829 | =item $view_start = $term->view_start ([$newvalue]) |
738 | |
830 | |
739 | Returns the negative row number of the topmost line. Minimum value is |
831 | Returns the negative row number of the topmost line. Minimum value is |
740 | C<0>, which displays the normal terminal contents. Larger values scroll |
832 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
921 | |
1013 | |
922 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1014 | Converts rxvt-unicodes text reprsentation into a perl string. See |
923 | C<< $term->ROW_t >> for details. |
1015 | C<< $term->ROW_t >> for details. |
924 | |
1016 | |
925 | =back |
1017 | =back |
|
|
1018 | |
|
|
1019 | =head2 The C<urxvt::popup> Class |
|
|
1020 | |
|
|
1021 | =over 4 |
|
|
1022 | |
|
|
1023 | =cut |
|
|
1024 | |
|
|
1025 | package urxvt::popup; |
|
|
1026 | |
|
|
1027 | sub add_item { |
|
|
1028 | my ($self, $item) = @_; |
|
|
1029 | |
|
|
1030 | push @{ $self->{item} }, $item; |
|
|
1031 | } |
|
|
1032 | |
|
|
1033 | sub add_button { |
|
|
1034 | my ($self, $text, $cb) = @_; |
|
|
1035 | |
|
|
1036 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, |
|
|
1037 | render => sub { $_[0]{text} }, |
|
|
1038 | }); |
|
|
1039 | } |
|
|
1040 | |
|
|
1041 | sub add_toggle { |
|
|
1042 | my ($self, $text, $cb, $value) = @_; |
|
|
1043 | |
|
|
1044 | my $item; $item = { |
|
|
1045 | type => "button", |
|
|
1046 | text => " $text", |
|
|
1047 | value => $value, |
|
|
1048 | render => sub { ($item->{value} ? "✔" : " ") . $text }, |
|
|
1049 | activate => sub { $cb->($item->{value} = !$item->{value}); }, |
|
|
1050 | }; |
|
|
1051 | |
|
|
1052 | $self->add_item ($item); |
|
|
1053 | } |
|
|
1054 | |
|
|
1055 | sub show { |
|
|
1056 | my ($self) = @_; |
|
|
1057 | |
|
|
1058 | local $urxvt::popup::self = $self; |
|
|
1059 | |
|
|
1060 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
|
|
1061 | "--transient-for" => $self->{term}->parent, |
|
|
1062 | "-pe" => "urxvt-popup") |
|
|
1063 | or die "unable to create popup window\n"; |
|
|
1064 | } |
|
|
1065 | |
|
|
1066 | sub DESTROY { |
|
|
1067 | my ($self) = @_; |
|
|
1068 | |
|
|
1069 | $self->{term}->ungrab; |
|
|
1070 | } |
926 | |
1071 | |
927 | =head2 The C<urxvt::timer> Class |
1072 | =head2 The C<urxvt::timer> Class |
928 | |
1073 | |
929 | This class implements timer watchers/events. Time is represented as a |
1074 | This class implements timer watchers/events. Time is represented as a |
930 | fractional number of seconds since the epoch. Example: |
1075 | fractional number of seconds since the epoch. Example: |