… | |
… | |
37 | |
37 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
38 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
39 | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection |
42 | =item selection (enabled by default) |
43 | |
43 | |
44 | Intelligent selection. This extension tries to be more intelligent when |
44 | Intelligent selection. This extension tries to be more intelligent when |
45 | the user extends selections (double-click). Right now, it tries to select |
45 | the user extends selections (double-click). Right now, it tries to select |
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
47 | if your F<ls> supports C<--quoting-style=shell>. |
47 | if your F<ls> supports C<--quoting-style=shell>. |
… | |
… | |
55 | Rot-13 the selection when activated. Used via keyboard trigger: |
55 | Rot-13 the selection when activated. Used via keyboard trigger: |
56 | |
56 | |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
58 | |
58 | |
59 | =back |
59 | =back |
|
|
60 | |
|
|
61 | =item option-popup (enabled by default) |
|
|
62 | |
|
|
63 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
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. |
60 | |
78 | |
61 | =item digital-clock |
79 | =item digital-clock |
62 | |
80 | |
63 | Displays a digital clock using the built-in overlay. |
81 | Displays a digital clock using the built-in overlay. |
64 | |
82 | |
… | |
… | |
114 | 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 |
115 | locale-specific way. |
133 | locale-specific way. |
116 | |
134 | |
117 | =back |
135 | =back |
118 | |
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 | |
119 | =head2 Hooks |
170 | =head2 Hooks |
120 | |
171 | |
121 | 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 |
122 | called whenever the relevant event happens. |
173 | called whenever the relevant event happens. |
123 | |
174 | |
124 | 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 |
125 | and extension package. You can call all C<urxvt::term> methods on it, but |
176 | the in the C<Extension Objects> section. |
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> |
|
|
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 | |
177 | |
131 | 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 |
132 | 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 |
133 | 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. |
134 | |
181 | |
135 | When in doubt, return a false value (preferably C<()>). |
182 | I<< When in doubt, return a false value (preferably C<()>). >> |
136 | |
183 | |
137 | =over 4 |
184 | =over 4 |
138 | |
185 | |
139 | =item on_init $term |
186 | =item on_init $term |
140 | |
187 | |
… | |
… | |
194 | than the scroll back buffer or the terminal. |
241 | than the scroll back buffer or the terminal. |
195 | |
242 | |
196 | 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, |
197 | $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 |
198 | number of lines that will be in the scrollback buffer. |
245 | number of lines that will be in the scrollback buffer. |
199 | |
|
|
200 | =item on_tty_activity $term *NYI* |
|
|
201 | |
|
|
202 | Called whenever the program(s) running in the urxvt window send output. |
|
|
203 | |
246 | |
204 | =item on_osc_seq $term, $string |
247 | =item on_osc_seq $term, $string |
205 | |
248 | |
206 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
249 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
207 | operating system command) is processed. Cursor position and other state |
250 | operating system command) is processed. Cursor position and other state |
… | |
… | |
261 | =item on_focus_out $term |
304 | =item on_focus_out $term |
262 | |
305 | |
263 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
306 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
264 | focus out processing. |
307 | focus out processing. |
265 | |
308 | |
266 | =item on_key_press $term, $event, $octets |
309 | =item on_key_press $term, $event, $keysym, $octets |
267 | |
310 | |
268 | =item on_key_release $term, $event |
311 | =item on_key_release $term, $event, $keysym |
269 | |
312 | |
270 | =item on_button_press $term, $event |
313 | =item on_button_press $term, $event |
271 | |
314 | |
272 | =item on_button_release $term, $event |
315 | =item on_button_release $term, $event |
273 | |
316 | |
… | |
… | |
327 | that calls this function. |
370 | that calls this function. |
328 | |
371 | |
329 | Using this function has the advantage that its output ends up in the |
372 | Using this function has the advantage that its output ends up in the |
330 | correct place, e.g. on stderr of the connecting urxvtc client. |
373 | correct place, e.g. on stderr of the connecting urxvtc client. |
331 | |
374 | |
|
|
375 | =item $is_safe = urxvt::safe |
|
|
376 | |
|
|
377 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
378 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
379 | started setuid or setgid. |
|
|
380 | |
332 | =item $time = urxvt::NOW |
381 | =item $time = urxvt::NOW |
333 | |
382 | |
334 | Returns the "current time" (as per the event loop). |
383 | Returns the "current time" (as per the event loop). |
335 | |
384 | |
336 | =item urxvt::CurrentTime |
385 | =item urxvt::CurrentTime |
337 | |
386 | |
338 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
387 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
339 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
388 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
340 | Button4Mask, Button5Mask, AnyModifier |
389 | Button4Mask, Button5Mask, AnyModifier |
341 | |
390 | |
342 | Various constants for use in X events. |
391 | Various constants for use in X calls and event processing. |
343 | |
392 | |
344 | =back |
393 | =back |
345 | |
394 | |
346 | =head2 RENDITION |
395 | =head2 RENDITION |
347 | |
396 | |
… | |
… | |
399 | |
448 | |
400 | package urxvt; |
449 | package urxvt; |
401 | |
450 | |
402 | use utf8; |
451 | use utf8; |
403 | use strict; |
452 | use strict; |
|
|
453 | use Carp (); |
404 | use Scalar::Util (); |
454 | use Scalar::Util (); |
405 | use List::Util (); |
455 | use List::Util (); |
406 | |
456 | |
|
|
457 | our $VERSION = 1; |
407 | our $TERM; |
458 | our $TERM; |
408 | our @HOOKNAME; |
459 | our @HOOKNAME; |
|
|
460 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
409 | our %OPTION; |
461 | our %OPTION; |
410 | our $LIBDIR; |
462 | our $LIBDIR; |
411 | |
463 | |
412 | BEGIN { |
464 | BEGIN { |
413 | urxvt->bootstrap; |
465 | urxvt->bootstrap; |
… | |
… | |
417 | my $msg = join "", @_; |
469 | my $msg = join "", @_; |
418 | $msg .= "\n" |
470 | $msg .= "\n" |
419 | unless $msg =~ /\n$/; |
471 | unless $msg =~ /\n$/; |
420 | urxvt::warn ($msg); |
472 | urxvt::warn ($msg); |
421 | }; |
473 | }; |
|
|
474 | |
|
|
475 | delete $ENV{IFS}; |
|
|
476 | delete $ENV{CDPATH}; |
|
|
477 | delete $ENV{BASH_ENV}; |
|
|
478 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
422 | } |
479 | } |
423 | |
480 | |
424 | my @hook_count; |
481 | my @hook_count; |
425 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
482 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
426 | |
483 | |
427 | sub verbose { |
484 | sub verbose { |
428 | my ($level, $msg) = @_; |
485 | my ($level, $msg) = @_; |
429 | warn "$msg\n" if $level <= $verbosity; |
486 | warn "$msg\n" if $level <= $verbosity; |
430 | } |
487 | } |
431 | |
488 | |
432 | # find on_xxx subs in the package and register them |
|
|
433 | # as hooks |
|
|
434 | sub register_package($) { |
|
|
435 | my ($pkg) = @_; |
|
|
436 | |
|
|
437 | for my $htype (0.. $#HOOKNAME) { |
|
|
438 | my $name = $HOOKNAME[$htype]; |
|
|
439 | |
|
|
440 | my $ref = $pkg->can ("on_" . lc $name) |
|
|
441 | or next; |
|
|
442 | |
|
|
443 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
|
|
444 | $hook_count[$htype]++ |
|
|
445 | or set_should_invoke $htype, 1; |
|
|
446 | } |
|
|
447 | } |
|
|
448 | |
|
|
449 | my $extension_pkg = "extension0000"; |
489 | my $extension_pkg = "extension0000"; |
450 | my %extension_pkg; |
490 | my %extension_pkg; |
451 | |
491 | |
452 | # load a single script into its own package, once only |
492 | # load a single script into its own package, once only |
453 | sub extension_package($) { |
493 | sub extension_package($) { |
… | |
… | |
459 | verbose 3, "loading extension '$path' into package '$pkg'"; |
499 | verbose 3, "loading extension '$path' into package '$pkg'"; |
460 | |
500 | |
461 | open my $fh, "<:raw", $path |
501 | open my $fh, "<:raw", $path |
462 | or die "$path: $!"; |
502 | or die "$path: $!"; |
463 | |
503 | |
|
|
504 | my $source = untaint |
464 | my $source = "package $pkg; use strict; use utf8;\n" |
505 | "package $pkg; use strict; use utf8;\n" |
465 | . "use base urxvt::term::proxy::;\n" |
506 | . "use base urxvt::term::proxy::;\n" |
466 | . "#line 1 \"$path\"\n{\n" |
507 | . "#line 1 \"$path\"\n{\n" |
467 | . (do { local $/; <$fh> }) |
508 | . (do { local $/; <$fh> }) |
468 | . "\n};\n1"; |
509 | . "\n};\n1"; |
469 | |
510 | |
|
|
511 | eval $source |
470 | eval $source or die "$path: $@"; |
512 | or die "$path: $@"; |
471 | |
513 | |
472 | $pkg |
514 | $pkg |
473 | } |
515 | } |
474 | } |
516 | } |
475 | |
517 | |
… | |
… | |
481 | my $htype = shift; |
523 | my $htype = shift; |
482 | |
524 | |
483 | if ($htype == 0) { # INIT |
525 | if ($htype == 0) { # INIT |
484 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
526 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
485 | |
527 | |
486 | my %want_ext; |
528 | my %ext_arg; |
487 | |
529 | |
488 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
530 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
489 | if ($_ eq "default") { |
531 | if ($_ eq "default") { |
490 | $want_ext{$_}++ for qw(selection option-popup); |
532 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
491 | } elsif (/^-(.*)$/) { |
533 | } elsif (/^-(.*)$/) { |
492 | delete $want_ext{$1}; |
534 | delete $ext_arg{$1}; |
|
|
535 | } elsif (/^([^<]+)<(.*)>$/) { |
|
|
536 | push @{ $ext_arg{$1} }, $2; |
493 | } else { |
537 | } else { |
494 | $want_ext{$_}++; |
538 | $ext_arg{$_} ||= []; |
495 | } |
539 | } |
496 | } |
540 | } |
497 | |
541 | |
498 | for my $ext (keys %want_ext) { |
542 | while (my ($ext, $argv) = each %ext_arg) { |
499 | my @files = grep -f $_, map "$_/$ext", @dirs; |
543 | my @files = grep -f $_, map "$_/$ext", @dirs; |
500 | |
544 | |
501 | if (@files) { |
545 | if (@files) { |
502 | register_package extension_package $files[0]; |
546 | $TERM->register_package (extension_package $files[0], $argv); |
503 | } else { |
547 | } else { |
504 | warn "perl extension '$ext' not found in perl library search path\n"; |
548 | warn "perl extension '$ext' not found in perl library search path\n"; |
505 | } |
549 | } |
506 | } |
550 | } |
|
|
551 | |
|
|
552 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
|
|
553 | warn $@ if $@; |
507 | } |
554 | } |
508 | |
555 | |
509 | $retval = undef; |
556 | $retval = undef; |
510 | |
557 | |
511 | if (my $cb = $TERM->{_hook}[$htype]) { |
558 | if (my $cb = $TERM->{_hook}[$htype]) { |
… | |
… | |
513 | if $verbosity >= 10; |
560 | if $verbosity >= 10; |
514 | |
561 | |
515 | keys %$cb; |
562 | keys %$cb; |
516 | |
563 | |
517 | while (my ($pkg, $cb) = each %$cb) { |
564 | while (my ($pkg, $cb) = each %$cb) { |
518 | eval { |
565 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
519 | $retval = $cb->( |
|
|
520 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
521 | my $proxy = bless { }, $pkg; |
|
|
522 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
523 | $proxy |
|
|
524 | }, |
|
|
525 | @_, |
|
|
526 | ) and last; |
566 | and last; |
|
|
567 | |
|
|
568 | if ($@) { |
|
|
569 | $TERM->ungrab; # better to lose the grab than the session |
|
|
570 | warn $@; |
527 | }; |
571 | } |
528 | warn $@ if $@;#d# |
|
|
529 | } |
572 | } |
530 | } |
573 | } |
531 | |
574 | |
532 | if ($htype == 1) { # DESTROY |
575 | if ($htype == 1) { # DESTROY |
533 | # remove hooks if unused |
|
|
534 | if (my $hook = $TERM->{_hook}) { |
576 | if (my $hook = delete $TERM->{_hook}) { |
535 | for my $htype (0..$#$hook) { |
577 | for my $htype (0..$#$hook) { |
536 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
578 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
537 | or set_should_invoke $htype, 0; |
579 | or set_should_invoke $htype, 0; |
538 | } |
580 | } |
539 | } |
581 | } |
… | |
… | |
546 | } |
588 | } |
547 | |
589 | |
548 | $retval |
590 | $retval |
549 | } |
591 | } |
550 | |
592 | |
551 | sub urxvt::term::proxy::AUTOLOAD { |
593 | # urxvt::term::proxy |
552 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
594 | |
|
|
595 | package urxvt::term::proxy; |
|
|
596 | |
|
|
597 | sub enable { |
|
|
598 | my ($self, %hook) = @_; |
|
|
599 | my $pkg = $self->{_pkg}; |
|
|
600 | |
|
|
601 | while (my ($name, $cb) = each %hook) { |
|
|
602 | my $htype = $HOOKTYPE{uc $name}; |
|
|
603 | defined $htype |
|
|
604 | or Carp::croak "unsupported hook type '$name'"; |
|
|
605 | |
|
|
606 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
|
|
607 | $hook_count[$htype]++ |
|
|
608 | or urxvt::set_should_invoke $htype, 1; |
|
|
609 | } |
|
|
610 | |
|
|
611 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
612 | } |
|
|
613 | } |
|
|
614 | |
|
|
615 | sub disable { |
|
|
616 | my ($self, @hook) = @_; |
|
|
617 | my $pkg = $self->{_pkg}; |
|
|
618 | |
|
|
619 | for my $name (@hook) { |
|
|
620 | my $htype = $HOOKTYPE{uc $name}; |
|
|
621 | defined $htype |
|
|
622 | or Carp::croak "unsupported hook type '$name'"; |
|
|
623 | |
|
|
624 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
|
|
625 | --$hook_count[$htype] |
|
|
626 | or urxvt::set_should_invoke $htype, 0; |
|
|
627 | } |
|
|
628 | } |
|
|
629 | } |
|
|
630 | |
|
|
631 | our $AUTOLOAD; |
|
|
632 | |
|
|
633 | sub AUTOLOAD { |
|
|
634 | $AUTOLOAD =~ /:([^:]+)$/ |
553 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
635 | or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; |
554 | |
636 | |
555 | eval qq{ |
637 | eval qq{ |
556 | sub $urxvt::term::proxy::AUTOLOAD { |
638 | sub $AUTOLOAD { |
557 | my \$proxy = shift; |
639 | my \$proxy = shift; |
558 | \$proxy->{term}->$1 (\@_) |
640 | \$proxy->{term}->$1 (\@_) |
559 | } |
641 | } |
560 | 1 |
642 | 1 |
561 | } or die "FATAL: unable to compile method forwarder: $@"; |
643 | } or die "FATAL: unable to compile method forwarder: $@"; |
562 | |
644 | |
563 | goto &$urxvt::term::proxy::AUTOLOAD; |
645 | goto &$AUTOLOAD; |
564 | } |
646 | } |
|
|
647 | |
|
|
648 | sub DESTROY { |
|
|
649 | # nop |
|
|
650 | } |
|
|
651 | |
|
|
652 | # urxvt::destroy_hook |
565 | |
653 | |
566 | sub urxvt::destroy_hook::DESTROY { |
654 | sub urxvt::destroy_hook::DESTROY { |
567 | ${$_[0]}->(); |
655 | ${$_[0]}->(); |
568 | } |
656 | } |
569 | |
657 | |
570 | sub urxvt::destroy_hook(&) { |
658 | sub urxvt::destroy_hook(&) { |
571 | bless \shift, urxvt::destroy_hook:: |
659 | bless \shift, urxvt::destroy_hook:: |
572 | } |
660 | } |
573 | |
661 | |
|
|
662 | package urxvt::anyevent; |
|
|
663 | |
|
|
664 | =head2 The C<urxvt::anyevent> Class |
|
|
665 | |
|
|
666 | The sole purpose of this class is to deliver an interface to the |
|
|
667 | C<AnyEvent> module - any module using it will work inside urxvt without |
|
|
668 | further work. The only exception is that you cannot wait on condition |
|
|
669 | variables, but non-blocking condvar use is ok. What this means is that you |
|
|
670 | cannot use blocking APIs, but the non-blocking variant should work. |
|
|
671 | |
|
|
672 | =cut |
|
|
673 | |
|
|
674 | our $VERSION = 1; |
|
|
675 | |
|
|
676 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
|
|
677 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
|
|
678 | |
|
|
679 | sub timer { |
|
|
680 | my ($class, %arg) = @_; |
|
|
681 | |
|
|
682 | my $cb = $arg{cb}; |
|
|
683 | |
|
|
684 | urxvt::timer |
|
|
685 | ->new |
|
|
686 | ->start (urxvt::NOW + $arg{after}) |
|
|
687 | ->cb (sub { |
|
|
688 | $_[0]->stop; # need to cancel manually |
|
|
689 | $cb->(); |
|
|
690 | }) |
|
|
691 | } |
|
|
692 | |
|
|
693 | sub io { |
|
|
694 | my ($class, %arg) = @_; |
|
|
695 | |
|
|
696 | my $cb = $arg{cb}; |
|
|
697 | |
|
|
698 | bless [$arg{fh}, urxvt::iow |
|
|
699 | ->new |
|
|
700 | ->fd (fileno $arg{fh}) |
|
|
701 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
|
|
702 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
|
|
703 | ->start |
|
|
704 | ->cb (sub { |
|
|
705 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
706 | . ($_[1] & 2 ? 'w' : '')); |
|
|
707 | })], |
|
|
708 | urxvt::anyevent:: |
|
|
709 | } |
|
|
710 | |
|
|
711 | sub DESTROY { |
|
|
712 | $_[0][1]->stop; |
|
|
713 | } |
|
|
714 | |
|
|
715 | sub condvar { |
|
|
716 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
717 | } |
|
|
718 | |
|
|
719 | sub urxvt::anyevent::condvar::broadcast { |
|
|
720 | ${$_[0]}++; |
|
|
721 | } |
|
|
722 | |
|
|
723 | sub urxvt::anyevent::condvar::wait { |
|
|
724 | unless (${$_[0]}) { |
|
|
725 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
726 | } |
|
|
727 | } |
|
|
728 | |
|
|
729 | package urxvt::term; |
|
|
730 | |
574 | =head2 The C<urxvt::term> Class |
731 | =head2 The C<urxvt::term> Class |
575 | |
732 | |
576 | =over 4 |
733 | =over 4 |
|
|
734 | |
|
|
735 | =cut |
|
|
736 | |
|
|
737 | # find on_xxx subs in the package and register them |
|
|
738 | # as hooks |
|
|
739 | sub register_package { |
|
|
740 | my ($self, $pkg, $argv) = @_; |
|
|
741 | |
|
|
742 | my $proxy = bless { |
|
|
743 | _pkg => $pkg, |
|
|
744 | argv => $argv, |
|
|
745 | }, $pkg; |
|
|
746 | Scalar::Util::weaken ($proxy->{term} = $self); |
|
|
747 | |
|
|
748 | $self->{_pkg}{$pkg} = $proxy; |
|
|
749 | |
|
|
750 | for my $name (@HOOKNAME) { |
|
|
751 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
|
|
752 | $proxy->enable ($name => $ref); |
|
|
753 | } |
|
|
754 | } |
|
|
755 | } |
577 | |
756 | |
578 | =item $term->destroy |
757 | =item $term->destroy |
579 | |
758 | |
580 | Destroy the terminal object (close the window, free resources etc.). |
759 | Destroy the terminal object (close the window, free resources etc.). |
581 | |
760 | |
… | |
… | |
629 | shade term_name title transparent transparent_all tripleclickwords |
808 | shade term_name title transparent transparent_all tripleclickwords |
630 | utmpInhibit visualBell |
809 | utmpInhibit visualBell |
631 | |
810 | |
632 | =cut |
811 | =cut |
633 | |
812 | |
634 | sub urxvt::term::resource($$;$) { |
813 | sub resource($$;$) { |
635 | my ($self, $name) = (shift, shift); |
814 | my ($self, $name) = (shift, shift); |
636 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
815 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
637 | &urxvt::term::_resource |
816 | &urxvt::term::_resource |
638 | } |
817 | } |
639 | |
818 | |
|
|
819 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
820 | |
|
|
821 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
822 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
823 | |
640 | =item $rend = $term->rstyle ([$new_rstyle]) |
824 | =item $rend = $term->rstyle ([$new_rstyle]) |
641 | |
825 | |
642 | Return and optionally change the current rendition. Text that is output by |
826 | Return and optionally change the current rendition. Text that is output by |
643 | the terminal application will use this style. |
827 | the terminal application will use this style. |
644 | |
828 | |
… | |
… | |
663 | |
847 | |
664 | =item $oldtext = $term->selection ([$newtext]) |
848 | =item $oldtext = $term->selection ([$newtext]) |
665 | |
849 | |
666 | Return the current selection text and optionally replace it by C<$newtext>. |
850 | Return the current selection text and optionally replace it by C<$newtext>. |
667 | |
851 | |
668 | #=item $term->overlay ($x, $y, $text) |
852 | =item $term->overlay_simple ($x, $y, $text) |
669 | # |
853 | |
670 | #Create a simple multi-line overlay box. See the next method for details. |
854 | Create a simple multi-line overlay box. See the next method for details. |
671 | # |
855 | |
672 | #=cut |
856 | =cut |
673 | # |
857 | |
674 | #sub urxvt::term::scr_overlay { |
858 | sub overlay_simple { |
675 | # my ($self, $x, $y, $text) = @_; |
859 | my ($self, $x, $y, $text) = @_; |
676 | # |
860 | |
677 | # my @lines = split /\n/, $text; |
861 | my @lines = split /\n/, $text; |
678 | # |
862 | |
679 | # my $w = 0; |
863 | my $w = List::Util::max map $self->strwidth ($_), @lines; |
680 | # for (map $self->strwidth ($_), @lines) { |
864 | |
681 | # $w = $_ if $w < $_; |
|
|
682 | # } |
|
|
683 | # |
|
|
684 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
865 | my $overlay = $self->overlay ($x, $y, $w, scalar @lines); |
685 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
866 | $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; |
686 | #} |
867 | |
|
|
868 | $overlay |
|
|
869 | } |
687 | |
870 | |
688 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
871 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
689 | |
872 | |
690 | Create a new (empty) overlay at the given position with the given |
873 | Create a new (empty) overlay at the given position with the given |
691 | width/height. C<$rstyle> defines the initial rendition style |
874 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
726 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
909 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
727 | currently). |
910 | currently). |
728 | |
911 | |
729 | =cut |
912 | =cut |
730 | |
913 | |
731 | sub urxvt::term::popup { |
914 | sub popup { |
732 | my ($self, $event) = @_; |
915 | my ($self, $event) = @_; |
733 | |
916 | |
734 | $self->grab ($event->{time}, 1) |
917 | $self->grab ($event->{time}, 1) |
735 | or return; |
918 | or return; |
736 | |
919 | |
… | |
… | |
758 | |
941 | |
759 | =item $string = $term->locale_decode ($octets) |
942 | =item $string = $term->locale_decode ($octets) |
760 | |
943 | |
761 | Convert the given locale-encoded octets into a perl string. |
944 | Convert the given locale-encoded octets into a perl string. |
762 | |
945 | |
|
|
946 | =item $term->scr_bell |
|
|
947 | |
|
|
948 | Ring the bell! |
|
|
949 | |
763 | =item $term->scr_add_lines ($string) |
950 | =item $term->scr_add_lines ($string) |
764 | |
951 | |
765 | Write the given text string to the screen, as if output by the application |
952 | Write the given text string to the screen, as if output by the application |
766 | running inside the terminal. It may not contain command sequences (escape |
953 | running inside the terminal. It may not contain command sequences (escape |
767 | codes), but is free to use line feeds, carriage returns and tabs. The |
954 | codes), but is free to use line feeds, carriage returns and tabs. The |
… | |
… | |
781 | |
968 | |
782 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
969 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
783 | pass characters instead of octets, you should convert your strings first |
970 | pass characters instead of octets, you should convert your strings first |
784 | to the locale-specific encoding using C<< $term->locale_encode >>. |
971 | to the locale-specific encoding using C<< $term->locale_encode >>. |
785 | |
972 | |
|
|
973 | =item $old_events = $term->pty_ev_events ([$new_events]) |
|
|
974 | |
|
|
975 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
976 | be used to suppress input and output handling to the pty/tty. See the |
|
|
977 | description of C<< urxvt::timer->events >>. Make sure to always restore |
|
|
978 | the previous value. |
|
|
979 | |
786 | =item $windowid = $term->parent |
980 | =item $windowid = $term->parent |
787 | |
981 | |
788 | Return the window id of the toplevel window. |
982 | Return the window id of the toplevel window. |
789 | |
983 | |
790 | =item $windowid = $term->vt |
984 | =item $windowid = $term->vt |
… | |
… | |
814 | =item $nrow_plus_saveLines = $term->total_rows |
1008 | =item $nrow_plus_saveLines = $term->total_rows |
815 | |
1009 | |
816 | =item $lines_in_scrollback = $term->nsaved |
1010 | =item $lines_in_scrollback = $term->nsaved |
817 | |
1011 | |
818 | Return various integers describing terminal characteristics. |
1012 | Return various integers describing terminal characteristics. |
|
|
1013 | |
|
|
1014 | =item $lc_ctype = $term->locale |
|
|
1015 | |
|
|
1016 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1017 | |
|
|
1018 | =item $x_display = $term->display_id |
|
|
1019 | |
|
|
1020 | Return the DISPLAY used by rxvt-unicode. |
819 | |
1021 | |
820 | =item $modifiermask = $term->ModLevel3Mask |
1022 | =item $modifiermask = $term->ModLevel3Mask |
821 | |
1023 | |
822 | =item $modifiermask = $term->ModMetaMask |
1024 | =item $modifiermask = $term->ModMetaMask |
823 | |
1025 | |
… | |
… | |
926 | |
1128 | |
927 | =back |
1129 | =back |
928 | |
1130 | |
929 | =cut |
1131 | =cut |
930 | |
1132 | |
931 | sub urxvt::term::line { |
1133 | sub line { |
932 | my ($self, $row) = @_; |
1134 | my ($self, $row) = @_; |
933 | |
1135 | |
934 | my $maxrow = $self->nrow - 1; |
1136 | my $maxrow = $self->nrow - 1; |
935 | |
1137 | |
936 | my ($beg, $end) = ($row, $row); |
1138 | my ($beg, $end) = ($row, $row); |
… | |
… | |
1000 | $offset / $self->{ncol} + $self->{beg}, |
1202 | $offset / $self->{ncol} + $self->{beg}, |
1001 | $offset % $self->{ncol} |
1203 | $offset % $self->{ncol} |
1002 | ) |
1204 | ) |
1003 | } |
1205 | } |
1004 | |
1206 | |
1005 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
1006 | =item $text = $term->special_encode $string |
1207 | =item $text = $term->special_encode $string |
1007 | |
1208 | |
1008 | Converts a perl string into the special encoding used by rxvt-unicode, |
1209 | Converts a perl string into the special encoding used by rxvt-unicode, |
1009 | where one character corresponds to one screen cell. See |
1210 | where one character corresponds to one screen cell. See |
1010 | C<< $term->ROW_t >> for details. |
1211 | C<< $term->ROW_t >> for details. |
… | |
… | |
1012 | =item $string = $term->special_decode $text |
1213 | =item $string = $term->special_decode $text |
1013 | |
1214 | |
1014 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1215 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1015 | C<< $term->ROW_t >> for details. |
1216 | C<< $term->ROW_t >> for details. |
1016 | |
1217 | |
|
|
1218 | =item $success = $term->grab_button ($button, $modifiermask) |
|
|
1219 | |
|
|
1220 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1221 | |
|
|
1222 | =item $success = $term->grab ($eventtime[, $sync]) |
|
|
1223 | |
|
|
1224 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1225 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
|
|
1226 | |
|
|
1227 | =item $term->allow_events_async |
|
|
1228 | |
|
|
1229 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1230 | |
|
|
1231 | =item $term->allow_events_sync |
|
|
1232 | |
|
|
1233 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1234 | |
|
|
1235 | =item $term->allow_events_replay |
|
|
1236 | |
|
|
1237 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1238 | recent grab. |
|
|
1239 | |
|
|
1240 | =item $term->ungrab |
|
|
1241 | |
|
|
1242 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1243 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1244 | the session. |
|
|
1245 | |
1017 | =back |
1246 | =back |
1018 | |
1247 | |
|
|
1248 | =cut |
|
|
1249 | |
|
|
1250 | package urxvt::popup; |
|
|
1251 | |
1019 | =head2 The C<urxvt::popup> Class |
1252 | =head2 The C<urxvt::popup> Class |
1020 | |
1253 | |
1021 | =over 4 |
1254 | =over 4 |
1022 | |
1255 | |
1023 | =cut |
1256 | =cut |
1024 | |
|
|
1025 | package urxvt::popup; |
|
|
1026 | |
1257 | |
1027 | sub add_item { |
1258 | sub add_item { |
1028 | my ($self, $item) = @_; |
1259 | my ($self, $item) = @_; |
1029 | |
1260 | |
1030 | $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; |
1261 | $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; |
… | |
… | |
1037 | } |
1268 | } |
1038 | |
1269 | |
1039 | sub add_separator { |
1270 | sub add_separator { |
1040 | my ($self, $sep) = @_; |
1271 | my ($self, $sep) = @_; |
1041 | |
1272 | |
1042 | $sep ||= "═"; |
1273 | $sep ||= "="; |
1043 | |
1274 | |
1044 | $self->add_item ({ |
1275 | $self->add_item ({ |
1045 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
1276 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
1046 | text => "", |
1277 | text => "", |
1047 | render => sub { $sep x $urxvt::TERM->ncol }, |
1278 | render => sub { $sep x $self->{term}->ncol }, |
1048 | activate => sub { }, |
1279 | activate => sub { }, |
1049 | }); |
1280 | }); |
1050 | } |
1281 | } |
1051 | |
1282 | |
1052 | sub add_title { |
1283 | sub add_title { |
… | |
… | |
1060 | } |
1291 | } |
1061 | |
1292 | |
1062 | sub add_button { |
1293 | sub add_button { |
1063 | my ($self, $text, $cb) = @_; |
1294 | my ($self, $text, $cb) = @_; |
1064 | |
1295 | |
1065 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); |
1296 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1066 | } |
1297 | } |
1067 | |
1298 | |
1068 | sub add_toggle { |
1299 | sub add_toggle { |
1069 | my ($self, $text, $cb, $value) = @_; |
1300 | my ($self, $text, $cb, $value) = @_; |
1070 | |
1301 | |
1071 | my $item; $item = { |
1302 | my $item; $item = { |
1072 | type => "button", |
1303 | type => "button", |
1073 | text => " $text", |
1304 | text => " $text", |
1074 | value => $value, |
1305 | value => $value, |
1075 | render => sub { ($item->{value} ? "* " : " ") . $text }, |
1306 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1076 | activate => sub { $cb->($item->{value} = !$item->{value}); }, |
1307 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
1077 | }; |
1308 | }; |
1078 | |
1309 | |
1079 | $self->add_item ($item); |
1310 | $self->add_item ($item); |
1080 | } |
1311 | } |
1081 | |
1312 | |
1082 | sub show { |
1313 | sub show { |
1083 | my ($self) = @_; |
1314 | my ($self) = @_; |
1084 | |
1315 | |
1085 | local $urxvt::popup::self = $self; |
1316 | local $urxvt::popup::self = $self; |
1086 | |
1317 | |
|
|
1318 | local $ENV{LC_ALL} = $self->{term}->locale; |
|
|
1319 | |
1087 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1320 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1088 | "--transient-for" => $self->{term}->parent, |
1321 | "--transient-for" => $self->{term}->parent, |
|
|
1322 | "-display" => $self->{term}->display_id, |
1089 | "-pe" => "urxvt-popup") |
1323 | "-pe" => "urxvt-popup") |
1090 | or die "unable to create popup window\n"; |
1324 | or die "unable to create popup window\n"; |
1091 | } |
1325 | } |
1092 | |
1326 | |
1093 | sub DESTROY { |
1327 | sub DESTROY { |
1094 | my ($self) = @_; |
1328 | my ($self) = @_; |
1095 | |
1329 | |
|
|
1330 | delete $self->{term}{_destroy}{$self}; |
1096 | $self->{term}->ungrab; |
1331 | $self->{term}->ungrab; |
1097 | } |
1332 | } |
1098 | |
1333 | |
1099 | =head2 The C<urxvt::timer> Class |
1334 | =head2 The C<urxvt::timer> Class |
1100 | |
1335 | |
… | |
… | |
1155 | |
1390 | |
1156 | $term->{socket} = ... |
1391 | $term->{socket} = ... |
1157 | $term->{iow} = urxvt::iow |
1392 | $term->{iow} = urxvt::iow |
1158 | ->new |
1393 | ->new |
1159 | ->fd (fileno $term->{socket}) |
1394 | ->fd (fileno $term->{socket}) |
1160 | ->events (1) # wait for read data |
1395 | ->events (urxvt::EVENT_READ) |
1161 | ->start |
1396 | ->start |
1162 | ->cb (sub { |
1397 | ->cb (sub { |
1163 | my ($iow, $revents) = @_; |
1398 | my ($iow, $revents) = @_; |
1164 | # $revents must be 1 here, no need to check |
1399 | # $revents must be 1 here, no need to check |
1165 | sysread $term->{socket}, my $buf, 8192 |
1400 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1182 | |
1417 | |
1183 | Set the filedescriptor (not handle) to watch. |
1418 | Set the filedescriptor (not handle) to watch. |
1184 | |
1419 | |
1185 | =item $iow = $iow->events ($eventmask) |
1420 | =item $iow = $iow->events ($eventmask) |
1186 | |
1421 | |
1187 | Set the event mask to watch. Bit #0 (value C<1>) enables watching for read |
1422 | Set the event mask to watch. The only allowed values are |
1188 | data, Bit #1 (value C<2>) enables watching for write data. |
1423 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
|
|
1424 | together, or C<urxvt::EVENT_NONE>. |
1189 | |
1425 | |
1190 | =item $iow = $iow->start |
1426 | =item $iow = $iow->start |
1191 | |
1427 | |
1192 | Start watching for requested events on the given handle. |
1428 | Start watching for requested events on the given handle. |
1193 | |
1429 | |
… | |
… | |
1204 | This variable controls the verbosity level of the perl extension. Higher |
1440 | This variable controls the verbosity level of the perl extension. Higher |
1205 | numbers indicate more verbose output. |
1441 | numbers indicate more verbose output. |
1206 | |
1442 | |
1207 | =over 4 |
1443 | =over 4 |
1208 | |
1444 | |
1209 | =item =0 - only fatal messages |
1445 | =item == 0 - fatal messages |
1210 | |
1446 | |
1211 | =item =3 - script loading and management |
1447 | =item >= 3 - script loading and management |
1212 | |
1448 | |
1213 | =item =10 - all events received |
1449 | =item >=10 - all events received |
1214 | |
1450 | |
1215 | =back |
1451 | =back |
1216 | |
1452 | |
1217 | =head1 AUTHOR |
1453 | =head1 AUTHOR |
1218 | |
1454 | |