… | |
… | |
58 | |
58 | |
59 | =back |
59 | =back |
60 | |
60 | |
61 | =item option-popup (enabled by default) |
61 | =item option-popup (enabled by default) |
62 | |
62 | |
63 | Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at |
63 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
64 | runtime. |
64 | runtime. |
|
|
65 | |
|
|
66 | =item selection-popup (enabled by default) |
|
|
67 | |
|
|
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
69 | text into various other formats/action. |
|
|
70 | |
|
|
71 | =item searchable-scrollback (enabled by default) |
|
|
72 | |
|
|
73 | Adds regex search functionality to the scrollback buffer, triggered by a |
|
|
74 | hotkey (default: C<M-s>). When in search mode, terminal input/output is |
|
|
75 | suspended, C</> starts an incremental regex search, C<n> searches further, |
|
|
76 | C<p> jumps to the previous match. C<enter> leaves search mode at the |
|
|
77 | current position and C<escape> returns to the original position. |
65 | |
78 | |
66 | =item digital-clock |
79 | =item digital-clock |
67 | |
80 | |
68 | Displays a digital clock using the built-in overlay. |
81 | Displays a digital clock using the built-in overlay. |
69 | |
82 | |
… | |
… | |
119 | Either binary data or - more common - a text string encoded in a |
132 | Either binary data or - more common - a text string encoded in a |
120 | locale-specific way. |
133 | locale-specific way. |
121 | |
134 | |
122 | =back |
135 | =back |
123 | |
136 | |
|
|
137 | =head2 Extension Objects |
|
|
138 | |
|
|
139 | Very perl extension is a perl class. A separate perl object is created |
|
|
140 | for each terminal and each extension and passed as the first parameter to |
|
|
141 | hooks. So extensions can use their C<$self> object without having to think |
|
|
142 | about other extensions, with the exception of methods and members that |
|
|
143 | begin with an underscore character C<_>: these are reserved for internal |
|
|
144 | use. |
|
|
145 | |
|
|
146 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
|
|
147 | C<urxvt::term> class on this object. |
|
|
148 | |
|
|
149 | It has the following methods and data members: |
|
|
150 | |
|
|
151 | =over 4 |
|
|
152 | |
|
|
153 | =item $urxvt_term = $self->{term} |
|
|
154 | |
|
|
155 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
156 | extension. This member I<must not> be changed in any way. |
|
|
157 | |
|
|
158 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
159 | |
|
|
160 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
161 | this extension, replacing any previous hook. This is useful when you want |
|
|
162 | to overwrite time-critical hooks only temporarily. |
|
|
163 | |
|
|
164 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
165 | |
|
|
166 | Dynamically disable the given hooks. |
|
|
167 | |
|
|
168 | =back |
|
|
169 | |
124 | =head2 Hooks |
170 | =head2 Hooks |
125 | |
171 | |
126 | The following subroutines can be declared in extension files, and will be |
172 | The following subroutines can be declared in extension files, and will be |
127 | called whenever the relevant event happens. |
173 | called whenever the relevant event happens. |
128 | |
174 | |
129 | The first argument passed to them is an object private to each terminal |
175 | The first argument passed to them is an extension oject as described in |
130 | and extension package. You can call all C<urxvt::term> methods on it, but |
176 | the in the C<Extension Objects> section. |
131 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
132 | object that is shared between all packages is stored in the C<term> |
|
|
133 | member. It is, however, blessed intot he package of the extension script, |
|
|
134 | so for all practical purposes you can treat an extension script as a class. |
|
|
135 | |
177 | |
136 | All of them must return a boolean value. If it is true, then the event |
178 | B<All> of these hooks must return a boolean value. If it is true, then the |
137 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
179 | event counts as being I<consumed>, and the invocation of other hooks is |
138 | and the relevant action might not be carried out by the C++ code. |
180 | skipped, and the relevant action might not be carried out by the C++ code. |
139 | |
181 | |
140 | When in doubt, return a false value (preferably C<()>). |
182 | I<< When in doubt, return a false value (preferably C<()>). >> |
141 | |
183 | |
142 | =over 4 |
184 | =over 4 |
143 | |
185 | |
144 | =item on_init $term |
186 | =item on_init $term |
145 | |
187 | |
… | |
… | |
199 | than the scroll back buffer or the terminal. |
241 | than the scroll back buffer or the terminal. |
200 | |
242 | |
201 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
243 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
202 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
244 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
203 | number of lines that will be in the scrollback buffer. |
245 | number of lines that will be in the scrollback buffer. |
204 | |
|
|
205 | =item on_tty_activity $term *NYI* |
|
|
206 | |
|
|
207 | Called whenever the program(s) running in the urxvt window send output. |
|
|
208 | |
246 | |
209 | =item on_osc_seq $term, $string |
247 | =item on_osc_seq $term, $string |
210 | |
248 | |
211 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
249 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
212 | operating system command) is processed. Cursor position and other state |
250 | operating system command) is processed. Cursor position and other state |
… | |
… | |
225 | can filter/change and output the text yourself by returning a true value |
263 | can filter/change and output the text yourself by returning a true value |
226 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
264 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
227 | might be very slow, however, as your hook is called for B<all> text being |
265 | might be very slow, however, as your hook is called for B<all> text being |
228 | output. |
266 | output. |
229 | |
267 | |
|
|
268 | =item on_tt_write $term, $octets |
|
|
269 | |
|
|
270 | Called whenever some data is written to the tty/pty and can be used to |
|
|
271 | suppress or filter tty input. |
|
|
272 | |
230 | =item on_line_update $term, $row |
273 | =item on_line_update $term, $row |
231 | |
274 | |
232 | Called whenever a line was updated or changed. Can be used to filter |
275 | Called whenever a line was updated or changed. Can be used to filter |
233 | screen output (e.g. underline urls or other useless stuff). Only lines |
276 | screen output (e.g. underline urls or other useless stuff). Only lines |
234 | that are being shown will be filtered, and, due to performance reasons, |
277 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
266 | =item on_focus_out $term |
309 | =item on_focus_out $term |
267 | |
310 | |
268 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
311 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
269 | focus out processing. |
312 | focus out processing. |
270 | |
313 | |
271 | =item on_key_press $term, $event, $octets |
314 | =item on_key_press $term, $event, $keysym, $octets |
272 | |
315 | |
273 | =item on_key_release $term, $event |
316 | =item on_key_release $term, $event, $keysym |
274 | |
317 | |
275 | =item on_button_press $term, $event |
318 | =item on_button_press $term, $event |
276 | |
319 | |
277 | =item on_button_release $term, $event |
320 | =item on_button_release $term, $event |
278 | |
321 | |
… | |
… | |
332 | that calls this function. |
375 | that calls this function. |
333 | |
376 | |
334 | Using this function has the advantage that its output ends up in the |
377 | Using this function has the advantage that its output ends up in the |
335 | correct place, e.g. on stderr of the connecting urxvtc client. |
378 | correct place, e.g. on stderr of the connecting urxvtc client. |
336 | |
379 | |
|
|
380 | =item $is_safe = urxvt::safe |
|
|
381 | |
|
|
382 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
383 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
384 | started setuid or setgid. |
|
|
385 | |
337 | =item $time = urxvt::NOW |
386 | =item $time = urxvt::NOW |
338 | |
387 | |
339 | Returns the "current time" (as per the event loop). |
388 | Returns the "current time" (as per the event loop). |
340 | |
389 | |
341 | =item urxvt::CurrentTime |
390 | =item urxvt::CurrentTime |
… | |
… | |
404 | |
453 | |
405 | package urxvt; |
454 | package urxvt; |
406 | |
455 | |
407 | use utf8; |
456 | use utf8; |
408 | use strict; |
457 | use strict; |
|
|
458 | use Carp (); |
409 | use Scalar::Util (); |
459 | use Scalar::Util (); |
410 | use List::Util (); |
460 | use List::Util (); |
411 | |
461 | |
412 | our $VERSION = 1; |
462 | our $VERSION = 1; |
413 | our $TERM; |
463 | our $TERM; |
414 | our @HOOKNAME; |
464 | our @HOOKNAME; |
|
|
465 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
415 | our %OPTION; |
466 | our %OPTION; |
|
|
467 | |
416 | our $LIBDIR; |
468 | our $LIBDIR; |
|
|
469 | our $RESNAME; |
|
|
470 | our $RESCLASS; |
|
|
471 | our $RXVTNAME; |
417 | |
472 | |
418 | BEGIN { |
473 | BEGIN { |
419 | urxvt->bootstrap; |
474 | urxvt->bootstrap; |
420 | |
475 | |
421 | # overwrite perl's warn |
476 | # overwrite perl's warn |
… | |
… | |
423 | my $msg = join "", @_; |
478 | my $msg = join "", @_; |
424 | $msg .= "\n" |
479 | $msg .= "\n" |
425 | unless $msg =~ /\n$/; |
480 | unless $msg =~ /\n$/; |
426 | urxvt::warn ($msg); |
481 | urxvt::warn ($msg); |
427 | }; |
482 | }; |
|
|
483 | |
|
|
484 | delete $ENV{IFS}; |
|
|
485 | delete $ENV{CDPATH}; |
|
|
486 | delete $ENV{BASH_ENV}; |
|
|
487 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
428 | } |
488 | } |
429 | |
489 | |
430 | my @hook_count; |
490 | my @hook_count; |
431 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
491 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
432 | |
492 | |
433 | sub verbose { |
493 | sub verbose { |
434 | my ($level, $msg) = @_; |
494 | my ($level, $msg) = @_; |
435 | warn "$msg\n" if $level <= $verbosity; |
495 | warn "$msg\n" if $level <= $verbosity; |
436 | } |
496 | } |
437 | |
497 | |
438 | # find on_xxx subs in the package and register them |
|
|
439 | # as hooks |
|
|
440 | sub register_package($) { |
|
|
441 | my ($pkg) = @_; |
|
|
442 | |
|
|
443 | for my $htype (0.. $#HOOKNAME) { |
|
|
444 | my $name = $HOOKNAME[$htype]; |
|
|
445 | |
|
|
446 | my $ref = $pkg->can ("on_" . lc $name) |
|
|
447 | or next; |
|
|
448 | |
|
|
449 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
|
|
450 | $hook_count[$htype]++ |
|
|
451 | or set_should_invoke $htype, 1; |
|
|
452 | } |
|
|
453 | } |
|
|
454 | |
|
|
455 | my $extension_pkg = "extension0000"; |
498 | my $extension_pkg = "extension0000"; |
456 | my %extension_pkg; |
499 | my %extension_pkg; |
457 | |
500 | |
458 | # load a single script into its own package, once only |
501 | # load a single script into its own package, once only |
459 | sub extension_package($) { |
502 | sub extension_package($) { |
… | |
… | |
465 | verbose 3, "loading extension '$path' into package '$pkg'"; |
508 | verbose 3, "loading extension '$path' into package '$pkg'"; |
466 | |
509 | |
467 | open my $fh, "<:raw", $path |
510 | open my $fh, "<:raw", $path |
468 | or die "$path: $!"; |
511 | or die "$path: $!"; |
469 | |
512 | |
|
|
513 | my $source = untaint |
470 | my $source = "package $pkg; use strict; use utf8;\n" |
514 | "package $pkg; use strict; use utf8;\n" |
471 | . "use base urxvt::term::proxy::;\n" |
515 | . "use base urxvt::term::extension::;\n" |
472 | . "#line 1 \"$path\"\n{\n" |
516 | . "#line 1 \"$path\"\n{\n" |
473 | . (do { local $/; <$fh> }) |
517 | . (do { local $/; <$fh> }) |
474 | . "\n};\n1"; |
518 | . "\n};\n1"; |
475 | |
519 | |
476 | $source =~ /(.*)/s and $source = $1; # untaint |
520 | eval $source |
477 | |
|
|
478 | eval $source or die "$path: $@"; |
521 | or die "$path: $@"; |
479 | |
522 | |
480 | $pkg |
523 | $pkg |
481 | } |
524 | } |
482 | } |
525 | } |
483 | |
526 | |
… | |
… | |
489 | my $htype = shift; |
532 | my $htype = shift; |
490 | |
533 | |
491 | if ($htype == 0) { # INIT |
534 | if ($htype == 0) { # INIT |
492 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
535 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
493 | |
536 | |
494 | my %want_ext; |
537 | my %ext_arg; |
495 | |
538 | |
496 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
539 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
497 | if ($_ eq "default") { |
540 | if ($_ eq "default") { |
498 | $want_ext{$_}++ for qw(selection option-popup); |
541 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
499 | } elsif (/^-(.*)$/) { |
542 | } elsif (/^-(.*)$/) { |
500 | delete $want_ext{$1}; |
543 | delete $ext_arg{$1}; |
|
|
544 | } elsif (/^([^<]+)<(.*)>$/) { |
|
|
545 | push @{ $ext_arg{$1} }, $2; |
501 | } else { |
546 | } else { |
502 | $want_ext{$_}++; |
547 | $ext_arg{$_} ||= []; |
503 | } |
548 | } |
504 | } |
549 | } |
505 | |
550 | |
506 | for my $ext (keys %want_ext) { |
551 | while (my ($ext, $argv) = each %ext_arg) { |
507 | my @files = grep -f $_, map "$_/$ext", @dirs; |
552 | my @files = grep -f $_, map "$_/$ext", @dirs; |
508 | |
553 | |
509 | if (@files) { |
554 | if (@files) { |
510 | register_package extension_package $files[0]; |
555 | $TERM->register_package (extension_package $files[0], $argv); |
511 | } else { |
556 | } else { |
512 | warn "perl extension '$ext' not found in perl library search path\n"; |
557 | warn "perl extension '$ext' not found in perl library search path\n"; |
513 | } |
558 | } |
514 | } |
559 | } |
515 | |
560 | |
… | |
… | |
524 | if $verbosity >= 10; |
569 | if $verbosity >= 10; |
525 | |
570 | |
526 | keys %$cb; |
571 | keys %$cb; |
527 | |
572 | |
528 | while (my ($pkg, $cb) = each %$cb) { |
573 | while (my ($pkg, $cb) = each %$cb) { |
529 | eval { |
574 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
530 | $retval = $cb->( |
|
|
531 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
532 | my $proxy = bless { }, $pkg; |
|
|
533 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
534 | $proxy |
|
|
535 | }, |
|
|
536 | @_, |
|
|
537 | ) and last; |
575 | and last; |
538 | }; |
576 | |
539 | if ($@) { |
577 | if ($@) { |
540 | $TERM->ungrab; # better to lose the grab than the session |
578 | $TERM->ungrab; # better to lose the grab than the session |
541 | warn $@; |
579 | warn $@; |
542 | } |
580 | } |
543 | } |
581 | } |
544 | } |
582 | } |
545 | |
583 | |
546 | if ($htype == 1) { # DESTROY |
584 | if ($htype == 1) { # DESTROY |
547 | # remove hooks if unused |
|
|
548 | if (my $hook = $TERM->{_hook}) { |
585 | if (my $hook = delete $TERM->{_hook}) { |
549 | for my $htype (0..$#$hook) { |
586 | for my $htype (0..$#$hook) { |
550 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
587 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
551 | or set_should_invoke $htype, 0; |
588 | or set_should_invoke $htype, 0; |
552 | } |
589 | } |
553 | } |
590 | } |
… | |
… | |
560 | } |
597 | } |
561 | |
598 | |
562 | $retval |
599 | $retval |
563 | } |
600 | } |
564 | |
601 | |
565 | # urxvt::term::proxy |
602 | # urxvt::term::extension |
566 | |
603 | |
567 | sub urxvt::term::proxy::AUTOLOAD { |
604 | package urxvt::term::extension; |
568 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
605 | |
|
|
606 | sub enable { |
|
|
607 | my ($self, %hook) = @_; |
|
|
608 | my $pkg = $self->{_pkg}; |
|
|
609 | |
|
|
610 | while (my ($name, $cb) = each %hook) { |
|
|
611 | my $htype = $HOOKTYPE{uc $name}; |
|
|
612 | defined $htype |
|
|
613 | or Carp::croak "unsupported hook type '$name'"; |
|
|
614 | |
|
|
615 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
|
|
616 | $hook_count[$htype]++ |
|
|
617 | or urxvt::set_should_invoke $htype, 1; |
|
|
618 | } |
|
|
619 | |
|
|
620 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
621 | } |
|
|
622 | } |
|
|
623 | |
|
|
624 | sub disable { |
|
|
625 | my ($self, @hook) = @_; |
|
|
626 | my $pkg = $self->{_pkg}; |
|
|
627 | |
|
|
628 | for my $name (@hook) { |
|
|
629 | my $htype = $HOOKTYPE{uc $name}; |
|
|
630 | defined $htype |
|
|
631 | or Carp::croak "unsupported hook type '$name'"; |
|
|
632 | |
|
|
633 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
|
|
634 | --$hook_count[$htype] |
|
|
635 | or urxvt::set_should_invoke $htype, 0; |
|
|
636 | } |
|
|
637 | } |
|
|
638 | } |
|
|
639 | |
|
|
640 | our $AUTOLOAD; |
|
|
641 | |
|
|
642 | sub AUTOLOAD { |
|
|
643 | $AUTOLOAD =~ /:([^:]+)$/ |
569 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
644 | or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; |
570 | |
645 | |
571 | eval qq{ |
646 | eval qq{ |
572 | sub $urxvt::term::proxy::AUTOLOAD { |
647 | sub $AUTOLOAD { |
573 | my \$proxy = shift; |
648 | my \$proxy = shift; |
574 | \$proxy->{term}->$1 (\@_) |
649 | \$proxy->{term}->$1 (\@_) |
575 | } |
650 | } |
576 | 1 |
651 | 1 |
577 | } or die "FATAL: unable to compile method forwarder: $@"; |
652 | } or die "FATAL: unable to compile method forwarder: $@"; |
578 | |
653 | |
579 | goto &$urxvt::term::proxy::AUTOLOAD; |
654 | goto &$AUTOLOAD; |
580 | } |
655 | } |
581 | |
656 | |
582 | sub urxvt::term::proxy::DESTROY { |
657 | sub DESTROY { |
583 | # nop |
658 | # nop |
584 | } |
659 | } |
585 | |
660 | |
586 | # urxvt::destroy_hook |
661 | # urxvt::destroy_hook |
587 | |
662 | |
… | |
… | |
654 | ${$_[0]}++; |
729 | ${$_[0]}++; |
655 | } |
730 | } |
656 | |
731 | |
657 | sub urxvt::anyevent::condvar::wait { |
732 | sub urxvt::anyevent::condvar::wait { |
658 | unless (${$_[0]}) { |
733 | unless (${$_[0]}) { |
659 | require Carp; |
|
|
660 | Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); |
734 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
661 | } |
735 | } |
662 | } |
736 | } |
663 | |
737 | |
664 | package urxvt::term; |
738 | package urxvt::term; |
665 | |
739 | |
666 | =head2 The C<urxvt::term> Class |
740 | =head2 The C<urxvt::term> Class |
667 | |
741 | |
668 | =over 4 |
742 | =over 4 |
|
|
743 | |
|
|
744 | =cut |
|
|
745 | |
|
|
746 | # find on_xxx subs in the package and register them |
|
|
747 | # as hooks |
|
|
748 | sub register_package { |
|
|
749 | my ($self, $pkg, $argv) = @_; |
|
|
750 | |
|
|
751 | my $proxy = bless { |
|
|
752 | _pkg => $pkg, |
|
|
753 | argv => $argv, |
|
|
754 | }, $pkg; |
|
|
755 | Scalar::Util::weaken ($proxy->{term} = $self); |
|
|
756 | |
|
|
757 | $self->{_pkg}{$pkg} = $proxy; |
|
|
758 | |
|
|
759 | for my $name (@HOOKNAME) { |
|
|
760 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
|
|
761 | $proxy->enable ($name => $ref); |
|
|
762 | } |
|
|
763 | } |
|
|
764 | } |
669 | |
765 | |
670 | =item $term->destroy |
766 | =item $term->destroy |
671 | |
767 | |
672 | Destroy the terminal object (close the window, free resources etc.). |
768 | Destroy the terminal object (close the window, free resources etc.). |
673 | |
769 | |
… | |
… | |
727 | my ($self, $name) = (shift, shift); |
823 | my ($self, $name) = (shift, shift); |
728 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
824 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
729 | &urxvt::term::_resource |
825 | &urxvt::term::_resource |
730 | } |
826 | } |
731 | |
827 | |
|
|
828 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
829 | |
|
|
830 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
831 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
832 | |
732 | =item $rend = $term->rstyle ([$new_rstyle]) |
833 | =item $rend = $term->rstyle ([$new_rstyle]) |
733 | |
834 | |
734 | Return and optionally change the current rendition. Text that is output by |
835 | Return and optionally change the current rendition. Text that is output by |
735 | the terminal application will use this style. |
836 | the terminal application will use this style. |
736 | |
837 | |
… | |
… | |
755 | |
856 | |
756 | =item $oldtext = $term->selection ([$newtext]) |
857 | =item $oldtext = $term->selection ([$newtext]) |
757 | |
858 | |
758 | Return the current selection text and optionally replace it by C<$newtext>. |
859 | Return the current selection text and optionally replace it by C<$newtext>. |
759 | |
860 | |
760 | #=item $term->overlay ($x, $y, $text) |
861 | =item $term->overlay_simple ($x, $y, $text) |
761 | # |
862 | |
762 | #Create a simple multi-line overlay box. See the next method for details. |
863 | Create a simple multi-line overlay box. See the next method for details. |
763 | # |
864 | |
764 | #=cut |
865 | =cut |
765 | # |
866 | |
766 | #sub urxvt::term::scr_overlay { |
867 | sub overlay_simple { |
767 | # my ($self, $x, $y, $text) = @_; |
868 | my ($self, $x, $y, $text) = @_; |
768 | # |
869 | |
769 | # my @lines = split /\n/, $text; |
870 | my @lines = split /\n/, $text; |
770 | # |
871 | |
771 | # my $w = 0; |
872 | my $w = List::Util::max map $self->strwidth ($_), @lines; |
772 | # for (map $self->strwidth ($_), @lines) { |
873 | |
773 | # $w = $_ if $w < $_; |
|
|
774 | # } |
|
|
775 | # |
|
|
776 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
874 | my $overlay = $self->overlay ($x, $y, $w, scalar @lines); |
777 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
875 | $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; |
778 | #} |
876 | |
|
|
877 | $overlay |
|
|
878 | } |
779 | |
879 | |
780 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
880 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
781 | |
881 | |
782 | Create a new (empty) overlay at the given position with the given |
882 | Create a new (empty) overlay at the given position with the given |
783 | width/height. C<$rstyle> defines the initial rendition style |
883 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
850 | |
950 | |
851 | =item $string = $term->locale_decode ($octets) |
951 | =item $string = $term->locale_decode ($octets) |
852 | |
952 | |
853 | Convert the given locale-encoded octets into a perl string. |
953 | Convert the given locale-encoded octets into a perl string. |
854 | |
954 | |
|
|
955 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
956 | |
|
|
957 | XORs the rendition values in the given span with the provided value |
|
|
958 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
|
|
959 | to the selection. |
|
|
960 | |
|
|
961 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
|
|
962 | |
|
|
963 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
|
|
964 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
|
|
965 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
|
|
966 | it instead. |
|
|
967 | |
|
|
968 | =item $term->scr_bell |
|
|
969 | |
|
|
970 | Ring the bell! |
|
|
971 | |
855 | =item $term->scr_add_lines ($string) |
972 | =item $term->scr_add_lines ($string) |
856 | |
973 | |
857 | Write the given text string to the screen, as if output by the application |
974 | Write the given text string to the screen, as if output by the application |
858 | running inside the terminal. It may not contain command sequences (escape |
975 | running inside the terminal. It may not contain command sequences (escape |
859 | codes), but is free to use line feeds, carriage returns and tabs. The |
976 | codes), but is free to use line feeds, carriage returns and tabs. The |
… | |
… | |
873 | |
990 | |
874 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
991 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
875 | pass characters instead of octets, you should convert your strings first |
992 | pass characters instead of octets, you should convert your strings first |
876 | to the locale-specific encoding using C<< $term->locale_encode >>. |
993 | to the locale-specific encoding using C<< $term->locale_encode >>. |
877 | |
994 | |
|
|
995 | =item $old_events = $term->pty_ev_events ([$new_events]) |
|
|
996 | |
|
|
997 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
998 | be used to suppress input and output handling to the pty/tty. See the |
|
|
999 | description of C<< urxvt::timer->events >>. Make sure to always restore |
|
|
1000 | the previous value. |
|
|
1001 | |
878 | =item $windowid = $term->parent |
1002 | =item $windowid = $term->parent |
879 | |
1003 | |
880 | Return the window id of the toplevel window. |
1004 | Return the window id of the toplevel window. |
881 | |
1005 | |
882 | =item $windowid = $term->vt |
1006 | =item $windowid = $term->vt |
… | |
… | |
906 | =item $nrow_plus_saveLines = $term->total_rows |
1030 | =item $nrow_plus_saveLines = $term->total_rows |
907 | |
1031 | |
908 | =item $lines_in_scrollback = $term->nsaved |
1032 | =item $lines_in_scrollback = $term->nsaved |
909 | |
1033 | |
910 | Return various integers describing terminal characteristics. |
1034 | Return various integers describing terminal characteristics. |
|
|
1035 | |
|
|
1036 | =item $lc_ctype = $term->locale |
|
|
1037 | |
|
|
1038 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1039 | |
|
|
1040 | =item $x_display = $term->display_id |
|
|
1041 | |
|
|
1042 | Return the DISPLAY used by rxvt-unicode. |
911 | |
1043 | |
912 | =item $modifiermask = $term->ModLevel3Mask |
1044 | =item $modifiermask = $term->ModLevel3Mask |
913 | |
1045 | |
914 | =item $modifiermask = $term->ModMetaMask |
1046 | =item $modifiermask = $term->ModMetaMask |
915 | |
1047 | |
… | |
… | |
1092 | $offset / $self->{ncol} + $self->{beg}, |
1224 | $offset / $self->{ncol} + $self->{beg}, |
1093 | $offset % $self->{ncol} |
1225 | $offset % $self->{ncol} |
1094 | ) |
1226 | ) |
1095 | } |
1227 | } |
1096 | |
1228 | |
1097 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
1098 | =item $text = $term->special_encode $string |
1229 | =item $text = $term->special_encode $string |
1099 | |
1230 | |
1100 | Converts a perl string into the special encoding used by rxvt-unicode, |
1231 | Converts a perl string into the special encoding used by rxvt-unicode, |
1101 | where one character corresponds to one screen cell. See |
1232 | where one character corresponds to one screen cell. See |
1102 | C<< $term->ROW_t >> for details. |
1233 | C<< $term->ROW_t >> for details. |
… | |
… | |
1104 | =item $string = $term->special_decode $text |
1235 | =item $string = $term->special_decode $text |
1105 | |
1236 | |
1106 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1237 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1107 | C<< $term->ROW_t >> for details. |
1238 | C<< $term->ROW_t >> for details. |
1108 | |
1239 | |
|
|
1240 | =item $success = $term->grab_button ($button, $modifiermask) |
|
|
1241 | |
|
|
1242 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1243 | |
|
|
1244 | =item $success = $term->grab ($eventtime[, $sync]) |
|
|
1245 | |
|
|
1246 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1247 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
|
|
1248 | |
|
|
1249 | =item $term->allow_events_async |
|
|
1250 | |
|
|
1251 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1252 | |
|
|
1253 | =item $term->allow_events_sync |
|
|
1254 | |
|
|
1255 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1256 | |
|
|
1257 | =item $term->allow_events_replay |
|
|
1258 | |
|
|
1259 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1260 | recent grab. |
|
|
1261 | |
|
|
1262 | =item $term->ungrab |
|
|
1263 | |
|
|
1264 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1265 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1266 | the session. |
|
|
1267 | |
1109 | =back |
1268 | =back |
1110 | |
1269 | |
1111 | =cut |
1270 | =cut |
1112 | |
1271 | |
1113 | package urxvt::popup; |
1272 | package urxvt::popup; |
… | |
… | |
1131 | } |
1290 | } |
1132 | |
1291 | |
1133 | sub add_separator { |
1292 | sub add_separator { |
1134 | my ($self, $sep) = @_; |
1293 | my ($self, $sep) = @_; |
1135 | |
1294 | |
1136 | $sep ||= "═"; |
1295 | $sep ||= "="; |
1137 | |
1296 | |
1138 | $self->add_item ({ |
1297 | $self->add_item ({ |
1139 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
1298 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
1140 | text => "", |
1299 | text => "", |
1141 | render => sub { $sep x $urxvt::TERM->ncol }, |
1300 | render => sub { $sep x $self->{term}->ncol }, |
1142 | activate => sub { }, |
1301 | activate => sub { }, |
1143 | }); |
1302 | }); |
1144 | } |
1303 | } |
1145 | |
1304 | |
1146 | sub add_title { |
1305 | sub add_title { |
… | |
… | |
1154 | } |
1313 | } |
1155 | |
1314 | |
1156 | sub add_button { |
1315 | sub add_button { |
1157 | my ($self, $text, $cb) = @_; |
1316 | my ($self, $text, $cb) = @_; |
1158 | |
1317 | |
1159 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); |
1318 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1160 | } |
1319 | } |
1161 | |
1320 | |
1162 | sub add_toggle { |
1321 | sub add_toggle { |
1163 | my ($self, $text, $cb, $value) = @_; |
1322 | my ($self, $text, $cb, $value) = @_; |
1164 | |
1323 | |
… | |
… | |
1176 | sub show { |
1335 | sub show { |
1177 | my ($self) = @_; |
1336 | my ($self) = @_; |
1178 | |
1337 | |
1179 | local $urxvt::popup::self = $self; |
1338 | local $urxvt::popup::self = $self; |
1180 | |
1339 | |
|
|
1340 | local $ENV{LC_ALL} = $self->{term}->locale; |
|
|
1341 | |
1181 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1342 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1182 | "--transient-for" => $self->{term}->parent, |
1343 | "--transient-for" => $self->{term}->parent, |
|
|
1344 | "-display" => $self->{term}->display_id, |
1183 | "-pe" => "urxvt-popup") |
1345 | "-pe" => "urxvt-popup") |
1184 | or die "unable to create popup window\n"; |
1346 | or die "unable to create popup window\n"; |
1185 | } |
1347 | } |
1186 | |
1348 | |
1187 | sub DESTROY { |
1349 | sub DESTROY { |
… | |
… | |
1250 | |
1412 | |
1251 | $term->{socket} = ... |
1413 | $term->{socket} = ... |
1252 | $term->{iow} = urxvt::iow |
1414 | $term->{iow} = urxvt::iow |
1253 | ->new |
1415 | ->new |
1254 | ->fd (fileno $term->{socket}) |
1416 | ->fd (fileno $term->{socket}) |
1255 | ->events (1) # wait for read data |
1417 | ->events (urxvt::EVENT_READ) |
1256 | ->start |
1418 | ->start |
1257 | ->cb (sub { |
1419 | ->cb (sub { |
1258 | my ($iow, $revents) = @_; |
1420 | my ($iow, $revents) = @_; |
1259 | # $revents must be 1 here, no need to check |
1421 | # $revents must be 1 here, no need to check |
1260 | sysread $term->{socket}, my $buf, 8192 |
1422 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1277 | |
1439 | |
1278 | Set the filedescriptor (not handle) to watch. |
1440 | Set the filedescriptor (not handle) to watch. |
1279 | |
1441 | |
1280 | =item $iow = $iow->events ($eventmask) |
1442 | =item $iow = $iow->events ($eventmask) |
1281 | |
1443 | |
1282 | Set the event mask to watch. Bit #0 (value C<1>) enables watching for read |
1444 | Set the event mask to watch. The only allowed values are |
1283 | data, Bit #1 (value C<2>) enables watching for write data. |
1445 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
|
|
1446 | together, or C<urxvt::EVENT_NONE>. |
1284 | |
1447 | |
1285 | =item $iow = $iow->start |
1448 | =item $iow = $iow->start |
1286 | |
1449 | |
1287 | Start watching for requested events on the given handle. |
1450 | Start watching for requested events on the given handle. |
1288 | |
1451 | |