ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC vs.
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines