… | |
… | |
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 |
|
|
267 | |
|
|
268 | =item on_key_release $term, $event |
|
|
269 | |
|
|
270 | =item on_button_press $term, $event |
|
|
271 | |
|
|
272 | =item on_button_release $term, $event |
|
|
273 | |
|
|
274 | =item on_motion_notify $term, $event |
|
|
275 | |
|
|
276 | =item on_map_notify $term, $event |
|
|
277 | |
|
|
278 | =item on_unmap_notify $term, $event |
|
|
279 | |
|
|
280 | Called whenever the corresponding X event is received for the terminal If |
|
|
281 | the hook returns true, then the even will be 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. |
|
|
286 | |
|
|
287 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
288 | output, if any, in locale-specific encoding. |
|
|
289 | |
|
|
290 | subwindow. |
|
|
291 | |
266 | =back |
292 | =back |
267 | |
293 | |
268 | =head2 Variables in the C<urxvt> Package |
294 | =head2 Variables in the C<urxvt> Package |
269 | |
295 | |
270 | =over 4 |
296 | =over 4 |
271 | |
297 | |
272 | =item $urxvt::TERM |
298 | =item $urxvt::TERM |
273 | |
299 | |
274 | The current terminal. Whenever a callback/Hook is bein executed, this |
300 | The current terminal. This variable stores the current C<urxvt::term> |
275 | variable stores the current C<urxvt::term> object. |
301 | object, whenever a callback/hook is executing. |
276 | |
302 | |
277 | =back |
303 | =back |
278 | |
304 | |
279 | =head2 Functions in the C<urxvt> Package |
305 | =head2 Functions in the C<urxvt> Package |
280 | |
306 | |
… | |
… | |
305 | |
331 | |
306 | =item $time = urxvt::NOW |
332 | =item $time = urxvt::NOW |
307 | |
333 | |
308 | Returns the "current time" (as per the event loop). |
334 | Returns the "current time" (as per the event loop). |
309 | |
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 | |
310 | =back |
344 | =back |
311 | |
345 | |
312 | =head2 RENDITION |
346 | =head2 RENDITION |
313 | |
347 | |
314 | Rendition bitsets contain information about colour, font, font styles and |
348 | Rendition bitsets contain information about colour, font, font styles and |
… | |
… | |
363 | |
397 | |
364 | =cut |
398 | =cut |
365 | |
399 | |
366 | package urxvt; |
400 | package urxvt; |
367 | |
401 | |
|
|
402 | use utf8; |
368 | use strict; |
403 | use strict; |
369 | use Scalar::Util (); |
404 | use Scalar::Util (); |
|
|
405 | use List::Util (); |
370 | |
406 | |
371 | our $TERM; |
407 | our $TERM; |
372 | our @HOOKNAME; |
408 | our @HOOKNAME; |
|
|
409 | our %OPTION; |
373 | our $LIBDIR; |
410 | our $LIBDIR; |
374 | |
411 | |
375 | BEGIN { |
412 | BEGIN { |
376 | urxvt->bootstrap; |
413 | urxvt->bootstrap; |
377 | |
414 | |
… | |
… | |
407 | $hook_count[$htype]++ |
444 | $hook_count[$htype]++ |
408 | or set_should_invoke $htype, 1; |
445 | or set_should_invoke $htype, 1; |
409 | } |
446 | } |
410 | } |
447 | } |
411 | |
448 | |
412 | my $script_pkg = "script0000"; |
449 | my $extension_pkg = "extension0000"; |
413 | my %script_pkg; |
450 | my %extension_pkg; |
414 | |
451 | |
415 | # load a single script into its own package, once only |
452 | # load a single script into its own package, once only |
416 | sub script_package($) { |
453 | sub extension_package($) { |
417 | my ($path) = @_; |
454 | my ($path) = @_; |
418 | |
455 | |
419 | $script_pkg{$path} ||= do { |
456 | $extension_pkg{$path} ||= do { |
420 | my $pkg = "urxvt::" . ($script_pkg++); |
457 | my $pkg = "urxvt::" . ($extension_pkg++); |
421 | |
458 | |
422 | verbose 3, "loading script '$path' into package '$pkg'"; |
459 | verbose 3, "loading extension '$path' into package '$pkg'"; |
423 | |
460 | |
424 | open my $fh, "<:raw", $path |
461 | open my $fh, "<:raw", $path |
425 | or die "$path: $!"; |
462 | or die "$path: $!"; |
426 | |
463 | |
427 | 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" |
428 | . "#line 1 \"$path\"\n{\n" |
466 | . "#line 1 \"$path\"\n{\n" |
429 | . (do { local $/; <$fh> }) |
467 | . (do { local $/; <$fh> }) |
430 | . "\n};\n1"; |
468 | . "\n};\n1"; |
431 | |
469 | |
432 | eval $source or die "$path: $@"; |
470 | eval $source or die "$path: $@"; |
… | |
… | |
442 | local $TERM = shift; |
480 | local $TERM = shift; |
443 | my $htype = shift; |
481 | my $htype = shift; |
444 | |
482 | |
445 | if ($htype == 0) { # INIT |
483 | if ($htype == 0) { # INIT |
446 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
484 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
|
|
485 | |
|
|
486 | my %want_ext; |
447 | |
487 | |
448 | 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) { |
449 | my @files = grep -f $_, map "$_/$ext", @dirs; |
499 | my @files = grep -f $_, map "$_/$ext", @dirs; |
450 | |
500 | |
451 | if (@files) { |
501 | if (@files) { |
452 | register_package script_package $files[0]; |
502 | register_package extension_package $files[0]; |
453 | } else { |
503 | } else { |
454 | 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"; |
455 | } |
505 | } |
456 | } |
506 | } |
457 | } |
507 | } |
… | |
… | |
463 | if $verbosity >= 10; |
513 | if $verbosity >= 10; |
464 | |
514 | |
465 | keys %$cb; |
515 | keys %$cb; |
466 | |
516 | |
467 | while (my ($pkg, $cb) = each %$cb) { |
517 | while (my ($pkg, $cb) = each %$cb) { |
|
|
518 | eval { |
468 | $retval = $cb->( |
519 | $retval = $cb->( |
469 | $TERM->{_pkg}{$pkg} ||= do { |
520 | $TERM->{_pkg}{$pkg} ||= do { |
470 | my $proxy = bless { }, urxvt::term::proxy::; |
521 | my $proxy = bless { }, $pkg; |
471 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
522 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
472 | $proxy |
523 | $proxy |
473 | }, |
524 | }, |
474 | @_, |
525 | @_, |
475 | ) and last; |
526 | ) and last; |
|
|
527 | }; |
|
|
528 | warn $@ if $@;#d# |
476 | } |
529 | } |
477 | } |
530 | } |
478 | |
531 | |
479 | if ($htype == 1) { # DESTROY |
532 | if ($htype == 1) { # DESTROY |
480 | # remove hooks if unused |
533 | # remove hooks if unused |
… | |
… | |
508 | } or die "FATAL: unable to compile method forwarder: $@"; |
561 | } or die "FATAL: unable to compile method forwarder: $@"; |
509 | |
562 | |
510 | goto &$urxvt::term::proxy::AUTOLOAD; |
563 | goto &$urxvt::term::proxy::AUTOLOAD; |
511 | } |
564 | } |
512 | |
565 | |
|
|
566 | sub urxvt::destroy_hook::DESTROY { |
|
|
567 | ${$_[0]}->(); |
|
|
568 | } |
|
|
569 | |
|
|
570 | sub urxvt::destroy_hook(&) { |
|
|
571 | bless \shift, urxvt::destroy_hook:: |
|
|
572 | } |
|
|
573 | |
513 | =head2 The C<urxvt::term> Class |
574 | =head2 The C<urxvt::term> Class |
514 | |
575 | |
515 | =over 4 |
576 | =over 4 |
516 | |
577 | |
517 | =item $term->destroy |
578 | =item $term->destroy |
518 | |
579 | |
519 | 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 |
520 | |
597 | |
521 | =item $value = $term->resource ($name[, $newval]) |
598 | =item $value = $term->resource ($name[, $newval]) |
522 | |
599 | |
523 | Returns the current resource value associated with a given name and |
600 | Returns the current resource value associated with a given name and |
524 | 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> |
… | |
… | |
534 | |
611 | |
535 | 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 |
536 | terminal is destroyed, so changing options frequently will eat memory. |
613 | terminal is destroyed, so changing options frequently will eat memory. |
537 | |
614 | |
538 | 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 |
539 | 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> |
540 | list: |
617 | to see the actual list: |
541 | |
618 | |
542 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
619 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
543 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
620 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
544 | display_name embed ext_bwidth fade font geometry hold iconName |
621 | display_name embed ext_bwidth fade font geometry hold iconName |
545 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
622 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
… | |
… | |
555 | =cut |
632 | =cut |
556 | |
633 | |
557 | sub urxvt::term::resource($$;$) { |
634 | sub urxvt::term::resource($$;$) { |
558 | my ($self, $name) = (shift, shift); |
635 | my ($self, $name) = (shift, shift); |
559 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
636 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
560 | goto &urxvt::term::_resource; |
637 | &urxvt::term::_resource |
561 | } |
638 | } |
562 | |
639 | |
563 | =item $rend = $term->rstyle ([$new_rstyle]) |
640 | =item $rend = $term->rstyle ([$new_rstyle]) |
564 | |
641 | |
565 | 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 |
… | |
… | |
641 | |
718 | |
642 | If hidden, display the overlay again. |
719 | If hidden, display the overlay again. |
643 | |
720 | |
644 | =back |
721 | =back |
645 | |
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 | |
646 | =item $cellwidth = $term->strwidth $string |
750 | =item $cellwidth = $term->strwidth ($string) |
647 | |
751 | |
648 | Returns the number of screen-cells this string would need. Correctly |
752 | Returns the number of screen-cells this string would need. Correctly |
649 | accounts for wide and combining characters. |
753 | accounts for wide and combining characters. |
650 | |
754 | |
651 | =item $octets = $term->locale_encode $string |
755 | =item $octets = $term->locale_encode ($string) |
652 | |
756 | |
653 | Convert the given text string into the corresponding locale encoding. |
757 | Convert the given text string into the corresponding locale encoding. |
654 | |
758 | |
655 | =item $string = $term->locale_decode $octets |
759 | =item $string = $term->locale_decode ($octets) |
656 | |
760 | |
657 | Convert the given locale-encoded octets into a perl string. |
761 | Convert the given locale-encoded octets into a perl string. |
658 | |
762 | |
659 | =item $term->scr_add_lines ($string) |
763 | =item $term->scr_add_lines ($string) |
660 | |
764 | |
… | |
… | |
677 | |
781 | |
678 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
782 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
679 | pass characters instead of octets, you should convert your strings first |
783 | pass characters instead of octets, you should convert your strings first |
680 | to the locale-specific encoding using C<< $term->locale_encode >>. |
784 | to the locale-specific encoding using C<< $term->locale_encode >>. |
681 | |
785 | |
|
|
786 | =item $windowid = $term->parent |
|
|
787 | |
|
|
788 | Return the window id of the toplevel window. |
|
|
789 | |
|
|
790 | =item $windowid = $term->vt |
|
|
791 | |
|
|
792 | Return the window id of the terminal window. |
|
|
793 | |
682 | =item $window_width = $term->width |
794 | =item $window_width = $term->width |
683 | |
795 | |
684 | =item $window_height = $term->height |
796 | =item $window_height = $term->height |
685 | |
797 | |
686 | =item $font_width = $term->fwidth |
798 | =item $font_width = $term->fwidth |
… | |
… | |
702 | =item $nrow_plus_saveLines = $term->total_rows |
814 | =item $nrow_plus_saveLines = $term->total_rows |
703 | |
815 | |
704 | =item $lines_in_scrollback = $term->nsaved |
816 | =item $lines_in_scrollback = $term->nsaved |
705 | |
817 | |
706 | 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. |
707 | |
828 | |
708 | =item $view_start = $term->view_start ([$newvalue]) |
829 | =item $view_start = $term->view_start ([$newvalue]) |
709 | |
830 | |
710 | 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 |
711 | C<0>, which displays the normal terminal contents. Larger values scroll |
832 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
892 | |
1013 | |
893 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1014 | Converts rxvt-unicodes text reprsentation into a perl string. See |
894 | C<< $term->ROW_t >> for details. |
1015 | C<< $term->ROW_t >> for details. |
895 | |
1016 | |
896 | =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 | } |
897 | |
1098 | |
898 | =head2 The C<urxvt::timer> Class |
1099 | =head2 The C<urxvt::timer> Class |
899 | |
1100 | |
900 | This class implements timer watchers/events. Time is represented as a |
1101 | This class implements timer watchers/events. Time is represented as a |
901 | fractional number of seconds since the epoch. Example: |
1102 | fractional number of seconds since the epoch. Example: |