… | |
… | |
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 | |
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 | |
|
|
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 |
198 | show this many lines of scrollback. |
188 | show this many lines of scrollback. |
… | |
… | |
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 | |
|
|
276 | =item on_map_notify $term, $event |
|
|
277 | |
|
|
278 | =item on_unmap_notify $term, $event |
275 | |
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 | |
279 | 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 |
… | |
… | |
327 | |
331 | |
328 | =item $time = urxvt::NOW |
332 | =item $time = urxvt::NOW |
329 | |
333 | |
330 | Returns the "current time" (as per the event loop). |
334 | Returns the "current time" (as per the event loop). |
331 | |
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 | |
332 | =back |
344 | =back |
333 | |
345 | |
334 | =head2 RENDITION |
346 | =head2 RENDITION |
335 | |
347 | |
336 | Rendition bitsets contain information about colour, font, font styles and |
348 | Rendition bitsets contain information about colour, font, font styles and |
… | |
… | |
385 | |
397 | |
386 | =cut |
398 | =cut |
387 | |
399 | |
388 | package urxvt; |
400 | package urxvt; |
389 | |
401 | |
|
|
402 | use utf8; |
390 | use strict; |
403 | use strict; |
391 | use Scalar::Util (); |
404 | use Scalar::Util (); |
|
|
405 | use List::Util (); |
392 | |
406 | |
393 | our $TERM; |
407 | our $TERM; |
394 | our @HOOKNAME; |
408 | our @HOOKNAME; |
|
|
409 | our %OPTION; |
395 | our $LIBDIR; |
410 | our $LIBDIR; |
396 | |
411 | |
397 | BEGIN { |
412 | BEGIN { |
398 | urxvt->bootstrap; |
413 | urxvt->bootstrap; |
399 | |
414 | |
… | |
… | |
465 | local $TERM = shift; |
480 | local $TERM = shift; |
466 | my $htype = shift; |
481 | my $htype = shift; |
467 | |
482 | |
468 | if ($htype == 0) { # INIT |
483 | if ($htype == 0) { # INIT |
469 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
484 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
|
|
485 | |
|
|
486 | my %want_ext; |
470 | |
487 | |
471 | 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) { |
472 | my @files = grep -f $_, map "$_/$ext", @dirs; |
499 | my @files = grep -f $_, map "$_/$ext", @dirs; |
473 | |
500 | |
474 | if (@files) { |
501 | if (@files) { |
475 | register_package extension_package $files[0]; |
502 | register_package extension_package $files[0]; |
476 | } else { |
503 | } else { |
… | |
… | |
534 | } or die "FATAL: unable to compile method forwarder: $@"; |
561 | } or die "FATAL: unable to compile method forwarder: $@"; |
535 | |
562 | |
536 | goto &$urxvt::term::proxy::AUTOLOAD; |
563 | goto &$urxvt::term::proxy::AUTOLOAD; |
537 | } |
564 | } |
538 | |
565 | |
|
|
566 | sub urxvt::destroy_hook::DESTROY { |
|
|
567 | ${$_[0]}->(); |
|
|
568 | } |
|
|
569 | |
|
|
570 | sub urxvt::destroy_hook(&) { |
|
|
571 | bless \shift, urxvt::destroy_hook:: |
|
|
572 | } |
|
|
573 | |
539 | =head2 The C<urxvt::term> Class |
574 | =head2 The C<urxvt::term> Class |
540 | |
575 | |
541 | =over 4 |
576 | =over 4 |
542 | |
577 | |
543 | =item $term->destroy |
578 | =item $term->destroy |
544 | |
579 | |
545 | 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 |
546 | |
597 | |
547 | =item $value = $term->resource ($name[, $newval]) |
598 | =item $value = $term->resource ($name[, $newval]) |
548 | |
599 | |
549 | Returns the current resource value associated with a given name and |
600 | Returns the current resource value associated with a given name and |
550 | 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> |
… | |
… | |
560 | |
611 | |
561 | 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 |
562 | terminal is destroyed, so changing options frequently will eat memory. |
613 | terminal is destroyed, so changing options frequently will eat memory. |
563 | |
614 | |
564 | 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 |
565 | 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> |
566 | list: |
617 | to see the actual list: |
567 | |
618 | |
568 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
619 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
569 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
620 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
570 | display_name embed ext_bwidth fade font geometry hold iconName |
621 | display_name embed ext_bwidth fade font geometry hold iconName |
571 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
622 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
… | |
… | |
581 | =cut |
632 | =cut |
582 | |
633 | |
583 | sub urxvt::term::resource($$;$) { |
634 | sub urxvt::term::resource($$;$) { |
584 | my ($self, $name) = (shift, shift); |
635 | my ($self, $name) = (shift, shift); |
585 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
636 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
586 | goto &urxvt::term::_resource; |
637 | &urxvt::term::_resource |
587 | } |
638 | } |
588 | |
639 | |
589 | =item $rend = $term->rstyle ([$new_rstyle]) |
640 | =item $rend = $term->rstyle ([$new_rstyle]) |
590 | |
641 | |
591 | 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 |
… | |
… | |
667 | |
718 | |
668 | If hidden, display the overlay again. |
719 | If hidden, display the overlay again. |
669 | |
720 | |
670 | =back |
721 | =back |
671 | |
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 | |
672 | =item $cellwidth = $term->strwidth ($string) |
750 | =item $cellwidth = $term->strwidth ($string) |
673 | |
751 | |
674 | Returns the number of screen-cells this string would need. Correctly |
752 | Returns the number of screen-cells this string would need. Correctly |
675 | accounts for wide and combining characters. |
753 | accounts for wide and combining characters. |
676 | |
754 | |
… | |
… | |
736 | =item $nrow_plus_saveLines = $term->total_rows |
814 | =item $nrow_plus_saveLines = $term->total_rows |
737 | |
815 | |
738 | =item $lines_in_scrollback = $term->nsaved |
816 | =item $lines_in_scrollback = $term->nsaved |
739 | |
817 | |
740 | 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. |
741 | |
828 | |
742 | =item $view_start = $term->view_start ([$newvalue]) |
829 | =item $view_start = $term->view_start ([$newvalue]) |
743 | |
830 | |
744 | 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 |
745 | C<0>, which displays the normal terminal contents. Larger values scroll |
832 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
926 | |
1013 | |
927 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1014 | Converts rxvt-unicodes text reprsentation into a perl string. See |
928 | C<< $term->ROW_t >> for details. |
1015 | C<< $term->ROW_t >> for details. |
929 | |
1016 | |
930 | =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 | $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; |
|
|
1031 | $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover}; |
|
|
1032 | $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active}; |
|
|
1033 | |
|
|
1034 | $item->{render} ||= sub { $_[0]{text} }; |
|
|
1035 | |
|
|
1036 | push @{ $self->{item} }, $item; |
|
|
1037 | } |
|
|
1038 | |
|
|
1039 | sub add_separator { |
|
|
1040 | my ($self, $sep) = @_; |
|
|
1041 | |
|
|
1042 | $sep ||= "═"; |
|
|
1043 | |
|
|
1044 | $self->add_item ({ |
|
|
1045 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
|
|
1046 | text => "", |
|
|
1047 | render => sub { $sep x $urxvt::TERM->ncol }, |
|
|
1048 | activate => sub { }, |
|
|
1049 | }); |
|
|
1050 | } |
|
|
1051 | |
|
|
1052 | sub add_title { |
|
|
1053 | my ($self, $title) = @_; |
|
|
1054 | |
|
|
1055 | $self->add_item ({ |
|
|
1056 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
|
|
1057 | text => $title, |
|
|
1058 | activate => sub { }, |
|
|
1059 | }); |
|
|
1060 | } |
|
|
1061 | |
|
|
1062 | sub add_button { |
|
|
1063 | my ($self, $text, $cb) = @_; |
|
|
1064 | |
|
|
1065 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); |
|
|
1066 | } |
|
|
1067 | |
|
|
1068 | sub add_toggle { |
|
|
1069 | my ($self, $text, $cb, $value) = @_; |
|
|
1070 | |
|
|
1071 | my $item; $item = { |
|
|
1072 | type => "button", |
|
|
1073 | text => " $text", |
|
|
1074 | value => $value, |
|
|
1075 | render => sub { ($item->{value} ? "* " : " ") . $text }, |
|
|
1076 | activate => sub { $cb->($item->{value} = !$item->{value}); }, |
|
|
1077 | }; |
|
|
1078 | |
|
|
1079 | $self->add_item ($item); |
|
|
1080 | } |
|
|
1081 | |
|
|
1082 | sub show { |
|
|
1083 | my ($self) = @_; |
|
|
1084 | |
|
|
1085 | local $urxvt::popup::self = $self; |
|
|
1086 | |
|
|
1087 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
|
|
1088 | "--transient-for" => $self->{term}->parent, |
|
|
1089 | "-pe" => "urxvt-popup") |
|
|
1090 | or die "unable to create popup window\n"; |
|
|
1091 | } |
|
|
1092 | |
|
|
1093 | sub DESTROY { |
|
|
1094 | my ($self) = @_; |
|
|
1095 | |
|
|
1096 | $self->{term}->ungrab; |
|
|
1097 | } |
931 | |
1098 | |
932 | =head2 The C<urxvt::timer> Class |
1099 | =head2 The C<urxvt::timer> Class |
933 | |
1100 | |
934 | This class implements timer watchers/events. Time is represented as a |
1101 | This class implements timer watchers/events. Time is represented as a |
935 | fractional number of seconds since the epoch. Example: |
1102 | fractional number of seconds since the epoch. Example: |