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.40 by root, Fri Jan 6 05:37:59 2006 UTC vs.
Revision 1.63 by root, Mon Jan 9 05:08:02 2006 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, scripts specified via the 22Everytime a terminal object gets created, extension scripts specified via
23C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
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
44Intelligent selection. This extension tries to be more intelligent when 44Intelligent selection. This extension tries to be more intelligent when
45the user extends selections (double-click). Right now, it tries to select 45the user extends selections (double-click). Right now, it tries to select
46urls and complete shell-quoted arguments, which is very convenient, too, 46urls and complete shell-quoted arguments, which is very convenient, too,
47if your F<ls> supports C<--quoting-style=shell>. 47if your F<ls> supports C<--quoting-style=shell>.
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 60
61=item option-popup (enabled by default)
62
63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime.
65
66=item selection-popup (enabled by default)
67
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action.
70
61=item digital-clock 71=item digital-clock
62 72
63Displays a digital clock using the built-in overlay. 73Displays a digital clock using the built-in overlay.
64 74
65=item mark-urls 75=item mark-urls
66 76
67Uses per-line filtering (C<on_line_update>) to underline urls. 77Uses per-line display filtering (C<on_line_update>) to underline urls.
78
79=item block-graphics-to-ascii
80
81A not very useful example of filtering all text output to the terminal,
82by replacing all line-drawing characters (U+2500 .. U+259F) by a
83similar-looking ascii character.
68 84
69=item example-refresh-hooks 85=item example-refresh-hooks
70 86
71Displays a very simple digital clock in the upper right corner of the 87Displays a very simple digital clock in the upper right corner of the
72window. Illustrates overwriting the refresh callbacks to create your own 88window. Illustrates overwriting the refresh callbacks to create your own
73overlays or changes. 89overlays or changes.
74
75=item example-filter-input
76
77A not very useful example of filtering all text output to the terminal, by
78underlining all urls that matches a certain regex (i.e. some urls :). It
79is not very useful because urls that are output in multiple steps (e.g.
80when typing them) do not get marked.
81 90
82=back 91=back
83 92
84=head2 General API Considerations 93=head2 General API Considerations
85 94
117 126
118=back 127=back
119 128
120=head2 Hooks 129=head2 Hooks
121 130
122The following subroutines can be declared in loaded scripts, and will be 131The following subroutines can be declared in extension files, and will be
123called whenever the relevant event happens. 132called whenever the relevant event happens.
124 133
125The first argument passed to them is an object private to each terminal 134The first argument passed to them is an object private to each terminal
126and extension package. You can call all C<urxvt::term> methods on it, but 135and extension package. You can call all C<urxvt::term> methods on it, but
127its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> 136its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128object that is shared between all packages is stored in the C<term> 137object that is shared between all packages is stored in the C<term>
129member. 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.
130 140
131All of them must return a boolean value. If it is true, then the event 141All of them must return a boolean value. If it is true, then the event
132counts as being I<consumed>, and the invocation of other hooks is skipped, 142counts as being I<consumed>, and the invocation of other hooks is skipped,
133and the relevant action might not be carried out by the C++ code. 143and the relevant action might not be carried out by the C++ code.
134 144
179should extend the selection itelf and return true to suppress the built-in 189should extend the selection itelf and return true to suppress the built-in
180processing. 190processing.
181 191
182See the F<selection> example extension. 192See the F<selection> example extension.
183 193
184=item on_focus_in $term
185
186Called whenever the window gets the keyboard focus, before urxvt does
187focus in processing.
188
189=item on_focus_out $term
190
191Called wheneever the window loses keyboard focus, before urxvt does focus
192out processing.
193
194=item on_view_change $term, $offset 194=item on_view_change $term, $offset
195 195
196Called whenever the view offset changes, i..e the user or program 196Called whenever the view offset changes, i..e the user or program
197scrolls. Offset C<0> means display the normal terminal, positive values 197scrolls. Offset C<0> means display the normal terminal, positive values
198show this many lines of scrollback. 198show this many lines of scrollback.
204than the scroll back buffer or the terminal. 204than the scroll back buffer or the terminal.
205 205
206It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 206It 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 207$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208number of lines that will be in the scrollback buffer. 208number 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 209
214=item on_osc_seq $term, $string 210=item on_osc_seq $term, $string
215 211
216Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 212Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217operating system command) is processed. Cursor position and other state 213operating system command) is processed. Cursor position and other state
261 257
262Called whenever the user presses a key combination that has a 258Called whenever the user presses a key combination that has a
263C<perl:string> action bound to it (see description of the B<keysym> 259C<perl:string> action bound to it (see description of the B<keysym>
264resource in the @@RXVT_NAME@@(1) manpage). 260resource in the @@RXVT_NAME@@(1) manpage).
265 261
262=item on_focus_in $term
263
264Called whenever the window gets the keyboard focus, before rxvt-unicode
265does focus in processing.
266
267=item on_focus_out $term
268
269Called wheneever the window loses keyboard focus, before rxvt-unicode does
270focus out processing.
271
266=item on_key_press $term, $event, $octets 272=item on_key_press $term, $event, $octets
267 273
268=item on_key_release $term, $event 274=item on_key_release $term, $event
269 275
270=item on_button_press $term, $event 276=item on_button_press $term, $event
271 277
272=item on_button_release $term, $event 278=item on_button_release $term, $event
273 279
274=item on_motion_notify $term, $event 280=item on_motion_notify $term, $event
281
282=item on_map_notify $term, $event
283
284=item on_unmap_notify $term, $event
275 285
276Called whenever the corresponding X event is received for the terminal If 286Called whenever the corresponding X event is received for the terminal If
277the hook returns true, then the even will be ignored by rxvt-unicode. 287the hook returns true, then the even will be ignored by rxvt-unicode.
278 288
279The event is a hash with most values as named by Xlib (see the XEvent 289The event is a hash with most values as named by Xlib (see the XEvent
291 301
292=over 4 302=over 4
293 303
294=item $urxvt::TERM 304=item $urxvt::TERM
295 305
296The current terminal. Whenever a callback/Hook is bein executed, this 306The current terminal. This variable stores the current C<urxvt::term>
297variable stores the current C<urxvt::term> object. 307object, whenever a callback/hook is executing.
298 308
299=back 309=back
300 310
301=head2 Functions in the C<urxvt> Package 311=head2 Functions in the C<urxvt> Package
302 312
323that calls this function. 333that calls this function.
324 334
325Using this function has the advantage that its output ends up in the 335Using this function has the advantage that its output ends up in the
326correct place, e.g. on stderr of the connecting urxvtc client. 336correct place, e.g. on stderr of the connecting urxvtc client.
327 337
338=item $is_safe = urxvt::safe
339
340Returns true when it is safe to do potentially unsafe things, such as
341evaluating perl code specified by the user. This is true when urxvt was
342started setuid or setgid.
343
328=item $time = urxvt::NOW 344=item $time = urxvt::NOW
329 345
330Returns the "current time" (as per the event loop). 346Returns the "current time" (as per the event loop).
347
348=item urxvt::CurrentTime
349
350=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352Button4Mask, Button5Mask, AnyModifier
353
354Various constants for use in X calls and event processing.
331 355
332=back 356=back
333 357
334=head2 RENDITION 358=head2 RENDITION
335 359
385 409
386=cut 410=cut
387 411
388package urxvt; 412package urxvt;
389 413
414use utf8;
390use strict; 415use strict;
391use Scalar::Util (); 416use Scalar::Util ();
417use List::Util ();
392 418
419our $VERSION = 1;
393our $TERM; 420our $TERM;
394our @HOOKNAME; 421our @HOOKNAME;
422our %OPTION;
395our $LIBDIR; 423our $LIBDIR;
396 424
397BEGIN { 425BEGIN {
398 urxvt->bootstrap; 426 urxvt->bootstrap;
399 427
402 my $msg = join "", @_; 430 my $msg = join "", @_;
403 $msg .= "\n" 431 $msg .= "\n"
404 unless $msg =~ /\n$/; 432 unless $msg =~ /\n$/;
405 urxvt::warn ($msg); 433 urxvt::warn ($msg);
406 }; 434 };
435
436 delete $ENV{IFS};
437 delete $ENV{CDPATH};
438 delete $ENV{BASH_ENV};
439 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
407} 440}
408 441
409my @hook_count; 442my @hook_count;
410my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 443my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
411 444
429 $hook_count[$htype]++ 462 $hook_count[$htype]++
430 or set_should_invoke $htype, 1; 463 or set_should_invoke $htype, 1;
431 } 464 }
432} 465}
433 466
434my $script_pkg = "script0000"; 467my $extension_pkg = "extension0000";
435my %script_pkg; 468my %extension_pkg;
436 469
437# load a single script into its own package, once only 470# load a single script into its own package, once only
438sub script_package($) { 471sub extension_package($) {
439 my ($path) = @_; 472 my ($path) = @_;
440 473
441 $script_pkg{$path} ||= do { 474 $extension_pkg{$path} ||= do {
442 my $pkg = "urxvt::" . ($script_pkg++); 475 my $pkg = "urxvt::" . ($extension_pkg++);
443 476
444 verbose 3, "loading script '$path' into package '$pkg'"; 477 verbose 3, "loading extension '$path' into package '$pkg'";
445 478
446 open my $fh, "<:raw", $path 479 open my $fh, "<:raw", $path
447 or die "$path: $!"; 480 or die "$path: $!";
448 481
449 my $source = "package $pkg; use strict; use utf8;\n" 482 my $source = untaint "package $pkg; use strict; use utf8;\n"
483 . "use base urxvt::term::proxy::;\n"
450 . "#line 1 \"$path\"\n{\n" 484 . "#line 1 \"$path\"\n{\n"
451 . (do { local $/; <$fh> }) 485 . (do { local $/; <$fh> })
452 . "\n};\n1"; 486 . "\n};\n1";
453 487
454 eval $source or die "$path: $@"; 488 eval $source or die "$path: $@";
464 local $TERM = shift; 498 local $TERM = shift;
465 my $htype = shift; 499 my $htype = shift;
466 500
467 if ($htype == 0) { # INIT 501 if ($htype == 0) { # INIT
468 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 502 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503
504 my %want_ext;
469 505
470 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { 506 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507 if ($_ eq "default") {
508 $want_ext{$_}++ for qw(selection option-popup selection-popup);
509 } elsif (/^-(.*)$/) {
510 delete $want_ext{$1};
511 } else {
512 $want_ext{$_}++;
513 }
514 }
515
516 for my $ext (keys %want_ext) {
471 my @files = grep -f $_, map "$_/$ext", @dirs; 517 my @files = grep -f $_, map "$_/$ext", @dirs;
472 518
473 if (@files) { 519 if (@files) {
474 register_package script_package $files[0]; 520 register_package extension_package $files[0];
475 } else { 521 } else {
476 warn "perl extension '$ext' not found in perl library search path\n"; 522 warn "perl extension '$ext' not found in perl library search path\n";
477 } 523 }
478 } 524 }
525
526 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
527 warn $@ if $@;
479 } 528 }
480 529
481 $retval = undef; 530 $retval = undef;
482 531
483 if (my $cb = $TERM->{_hook}[$htype]) { 532 if (my $cb = $TERM->{_hook}[$htype]) {
485 if $verbosity >= 10; 534 if $verbosity >= 10;
486 535
487 keys %$cb; 536 keys %$cb;
488 537
489 while (my ($pkg, $cb) = each %$cb) { 538 while (my ($pkg, $cb) = each %$cb) {
539 eval {
490 $retval = $cb->( 540 $retval = $cb->(
491 $TERM->{_pkg}{$pkg} ||= do { 541 $TERM->{_pkg}{$pkg} ||= do {
492 my $proxy = bless { }, urxvt::term::proxy::; 542 my $proxy = bless { }, $pkg;
493 Scalar::Util::weaken ($proxy->{term} = $TERM); 543 Scalar::Util::weaken ($proxy->{term} = $TERM);
494 $proxy 544 $proxy
495 }, 545 },
496 @_, 546 @_,
497 ) and last; 547 ) and last;
548 };
549 if ($@) {
550 $TERM->ungrab; # better to lose the grab than the session
551 warn $@;
552 }
498 } 553 }
499 } 554 }
500 555
501 if ($htype == 1) { # DESTROY 556 if ($htype == 1) { # DESTROY
502 # remove hooks if unused 557 # remove hooks if unused
515 } 570 }
516 571
517 $retval 572 $retval
518} 573}
519 574
575# urxvt::term::proxy
576
520sub urxvt::term::proxy::AUTOLOAD { 577sub urxvt::term::proxy::AUTOLOAD {
521 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 578 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
522 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 579 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
523 580
524 eval qq{ 581 eval qq{
530 } or die "FATAL: unable to compile method forwarder: $@"; 587 } or die "FATAL: unable to compile method forwarder: $@";
531 588
532 goto &$urxvt::term::proxy::AUTOLOAD; 589 goto &$urxvt::term::proxy::AUTOLOAD;
533} 590}
534 591
592sub urxvt::term::proxy::DESTROY {
593 # nop
594}
595
596# urxvt::destroy_hook
597
598sub urxvt::destroy_hook::DESTROY {
599 ${$_[0]}->();
600}
601
602sub urxvt::destroy_hook(&) {
603 bless \shift, urxvt::destroy_hook::
604}
605
606package urxvt::anyevent;
607
608=head2 The C<urxvt::anyevent> Class
609
610The sole purpose of this class is to deliver an interface to the
611C<AnyEvent> module - any module using it will work inside urxvt without
612further work. The only exception is that you cannot wait on condition
613variables, but non-blocking condvar use is ok. What this means is that you
614cannot use blocking APIs, but the non-blocking variant should work.
615
616=cut
617
618our $VERSION = 1;
619
620$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
621push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
622
623sub timer {
624 my ($class, %arg) = @_;
625
626 my $cb = $arg{cb};
627
628 urxvt::timer
629 ->new
630 ->start (urxvt::NOW + $arg{after})
631 ->cb (sub {
632 $_[0]->stop; # need to cancel manually
633 $cb->();
634 })
635}
636
637sub io {
638 my ($class, %arg) = @_;
639
640 my $cb = $arg{cb};
641
642 bless [$arg{fh}, urxvt::iow
643 ->new
644 ->fd (fileno $arg{fh})
645 ->events (($arg{poll} =~ /r/ ? 1 : 0)
646 | ($arg{poll} =~ /w/ ? 2 : 0))
647 ->start
648 ->cb (sub {
649 $cb->(($_[1] & 1 ? 'r' : '')
650 . ($_[1] & 2 ? 'w' : ''));
651 })],
652 urxvt::anyevent::
653}
654
655sub DESTROY {
656 $_[0][1]->stop;
657}
658
659sub condvar {
660 bless \my $flag, urxvt::anyevent::condvar::
661}
662
663sub urxvt::anyevent::condvar::broadcast {
664 ${$_[0]}++;
665}
666
667sub urxvt::anyevent::condvar::wait {
668 unless (${$_[0]}) {
669 require Carp;
670 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
671 }
672}
673
674package urxvt::term;
675
535=head2 The C<urxvt::term> Class 676=head2 The C<urxvt::term> Class
536 677
537=over 4 678=over 4
538 679
539=item $term->destroy 680=item $term->destroy
540 681
541Destroy the terminal object (close the window, free resources etc.). 682Destroy the terminal object (close the window, free resources etc.).
683
684=item $isset = $term->option ($optval[, $set])
685
686Returns true if the option specified by C<$optval> is enabled, and
687optionally change it. All option values are stored by name in the hash
688C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
689
690Here is a a likely non-exhaustive list of option names, please see the
691source file F</src/optinc.h> to see the actual list:
692
693 borderLess console cursorBlink cursorUnderline hold iconic insecure
694 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
695 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
696 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
697 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
698 tripleclickwords utmpInhibit visualBell
542 699
543=item $value = $term->resource ($name[, $newval]) 700=item $value = $term->resource ($name[, $newval])
544 701
545Returns the current resource value associated with a given name and 702Returns the current resource value associated with a given name and
546optionally sets a new value. Setting values is most useful in the C<init> 703optionally sets a new value. Setting values is most useful in the C<init>
556 713
557Please note that resource strings will currently only be freed when the 714Please note that resource strings will currently only be freed when the
558terminal is destroyed, so changing options frequently will eat memory. 715terminal is destroyed, so changing options frequently will eat memory.
559 716
560Here is a a likely non-exhaustive list of resource names, not all of which 717Here is a a likely non-exhaustive list of resource names, not all of which
561are supported in every build, please see the source to see the actual 718are supported in every build, please see the source file F</src/rsinc.h>
562list: 719to see the actual list:
563 720
564 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 721 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
565 borderLess color cursorBlink cursorUnderline cutchars delete_key 722 borderLess color cursorBlink cursorUnderline cutchars delete_key
566 display_name embed ext_bwidth fade font geometry hold iconName 723 display_name embed ext_bwidth fade font geometry hold iconName
567 imFont imLocale inputMethod insecure int_bwidth intensityStyles 724 imFont imLocale inputMethod insecure int_bwidth intensityStyles
574 shade term_name title transparent transparent_all tripleclickwords 731 shade term_name title transparent transparent_all tripleclickwords
575 utmpInhibit visualBell 732 utmpInhibit visualBell
576 733
577=cut 734=cut
578 735
579sub urxvt::term::resource($$;$) { 736sub resource($$;$) {
580 my ($self, $name) = (shift, shift); 737 my ($self, $name) = (shift, shift);
581 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 738 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
582 goto &urxvt::term::_resource; 739 &urxvt::term::_resource
583} 740}
584 741
585=item $rend = $term->rstyle ([$new_rstyle]) 742=item $rend = $term->rstyle ([$new_rstyle])
586 743
587Return and optionally change the current rendition. Text that is output by 744Return and optionally change the current rendition. Text that is output by
663 820
664If hidden, display the overlay again. 821If hidden, display the overlay again.
665 822
666=back 823=back
667 824
825=item $popup = $term->popup ($event)
826
827Creates a new C<urxvt::popup> object that implements a popup menu. The
828C<$event> I<must> be the event causing the menu to pop up (a button event,
829currently).
830
831=cut
832
833sub popup {
834 my ($self, $event) = @_;
835
836 $self->grab ($event->{time}, 1)
837 or return;
838
839 my $popup = bless {
840 term => $self,
841 event => $event,
842 }, urxvt::popup::;
843
844 Scalar::Util::weaken $popup->{term};
845
846 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
847 Scalar::Util::weaken $self->{_destroy}{$popup};
848
849 $popup
850}
851
668=item $cellwidth = $term->strwidth ($string) 852=item $cellwidth = $term->strwidth ($string)
669 853
670Returns the number of screen-cells this string would need. Correctly 854Returns the number of screen-cells this string would need. Correctly
671accounts for wide and combining characters. 855accounts for wide and combining characters.
672 856
732=item $nrow_plus_saveLines = $term->total_rows 916=item $nrow_plus_saveLines = $term->total_rows
733 917
734=item $lines_in_scrollback = $term->nsaved 918=item $lines_in_scrollback = $term->nsaved
735 919
736Return various integers describing terminal characteristics. 920Return various integers describing terminal characteristics.
921
922=item $modifiermask = $term->ModLevel3Mask
923
924=item $modifiermask = $term->ModMetaMask
925
926=item $modifiermask = $term->ModNumLockMask
927
928Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
929AltGr), the meta key (often Alt) and the num lock key, if applicable.
737 930
738=item $view_start = $term->view_start ([$newvalue]) 931=item $view_start = $term->view_start ([$newvalue])
739 932
740Returns the negative row number of the topmost line. Minimum value is 933Returns the negative row number of the topmost line. Minimum value is
741C<0>, which displays the normal terminal contents. Larger values scroll 934C<0>, which displays the normal terminal contents. Larger values scroll
835 1028
836=back 1029=back
837 1030
838=cut 1031=cut
839 1032
840sub urxvt::term::line { 1033sub line {
841 my ($self, $row) = @_; 1034 my ($self, $row) = @_;
842 1035
843 my $maxrow = $self->nrow - 1; 1036 my $maxrow = $self->nrow - 1;
844 1037
845 my ($beg, $end) = ($row, $row); 1038 my ($beg, $end) = ($row, $row);
909 $offset / $self->{ncol} + $self->{beg}, 1102 $offset / $self->{ncol} + $self->{beg},
910 $offset % $self->{ncol} 1103 $offset % $self->{ncol}
911 ) 1104 )
912} 1105}
913 1106
914=item ($row, $col) = $line->coord_of ($offset)
915=item $text = $term->special_encode $string 1107=item $text = $term->special_encode $string
916 1108
917Converts a perl string into the special encoding used by rxvt-unicode, 1109Converts a perl string into the special encoding used by rxvt-unicode,
918where one character corresponds to one screen cell. See 1110where one character corresponds to one screen cell. See
919C<< $term->ROW_t >> for details. 1111C<< $term->ROW_t >> for details.
921=item $string = $term->special_decode $text 1113=item $string = $term->special_decode $text
922 1114
923Converts rxvt-unicodes text reprsentation into a perl string. See 1115Converts rxvt-unicodes text reprsentation into a perl string. See
924C<< $term->ROW_t >> for details. 1116C<< $term->ROW_t >> for details.
925 1117
1118=item $success = $term->grab_button ($button, $modifiermask)
1119
1120Registers a synchronous button grab. See XGrabButton.
1121
1122=item $success = $term->grab ($eventtime[, $sync])
1123
1124Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1125synchronous (C<$sync> is true). Also remembers the grab timestampe.
1126
1127=item $term->allow_events_async
1128
1129Calls XAllowEvents with AsyncBoth for the most recent grab.
1130
1131=item $term->allow_events_sync
1132
1133Calls XAllowEvents with SyncBoth for the most recent grab.
1134
1135=item $term->allow_events_replay
1136
1137Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1138recent grab.
1139
1140=item $term->ungrab
1141
1142Calls XUngrab for the most recent grab. Is called automatically on
1143evaluation errors, as it is better to lose the grab in the error case as
1144the session.
1145
926=back 1146=back
1147
1148=cut
1149
1150package urxvt::popup;
1151
1152=head2 The C<urxvt::popup> Class
1153
1154=over 4
1155
1156=cut
1157
1158sub add_item {
1159 my ($self, $item) = @_;
1160
1161 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1162 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1163 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1164
1165 $item->{render} ||= sub { $_[0]{text} };
1166
1167 push @{ $self->{item} }, $item;
1168}
1169
1170sub add_separator {
1171 my ($self, $sep) = @_;
1172
1173 $sep ||= "═";
1174
1175 $self->add_item ({
1176 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177 text => "",
1178 render => sub { $sep x $urxvt::TERM->ncol },
1179 activate => sub { },
1180 });
1181}
1182
1183sub add_title {
1184 my ($self, $title) = @_;
1185
1186 $self->add_item ({
1187 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1188 text => $title,
1189 activate => sub { },
1190 });
1191}
1192
1193sub add_button {
1194 my ($self, $text, $cb) = @_;
1195
1196 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1197}
1198
1199sub add_toggle {
1200 my ($self, $text, $cb, $value) = @_;
1201
1202 my $item; $item = {
1203 type => "button",
1204 text => " $text",
1205 value => $value,
1206 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1208 };
1209
1210 $self->add_item ($item);
1211}
1212
1213sub show {
1214 my ($self) = @_;
1215
1216 local $urxvt::popup::self = $self;
1217
1218 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1219 "--transient-for" => $self->{term}->parent,
1220 "-display" => $self->{term}->display_id,
1221 "-pe" => "urxvt-popup")
1222 or die "unable to create popup window\n";
1223}
1224
1225sub DESTROY {
1226 my ($self) = @_;
1227
1228 delete $self->{term}{_destroy}{$self};
1229 $self->{term}->ungrab;
1230}
927 1231
928=head2 The C<urxvt::timer> Class 1232=head2 The C<urxvt::timer> Class
929 1233
930This class implements timer watchers/events. Time is represented as a 1234This class implements timer watchers/events. Time is represented as a
931fractional number of seconds since the epoch. Example: 1235fractional number of seconds since the epoch. Example:
1033This variable controls the verbosity level of the perl extension. Higher 1337This variable controls the verbosity level of the perl extension. Higher
1034numbers indicate more verbose output. 1338numbers indicate more verbose output.
1035 1339
1036=over 4 1340=over 4
1037 1341
1038=item =0 - only fatal messages 1342=item == 0 - fatal messages
1039 1343
1040=item =3 - script loading and management 1344=item >= 3 - script loading and management
1041 1345
1042=item =10 - all events received 1346=item >=10 - all events received
1043 1347
1044=back 1348=back
1045 1349
1046=head1 AUTHOR 1350=head1 AUTHOR
1047 1351

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines