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.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.67 by root, Mon Jan 9 19:29:06 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.
74
75=item mark-urls
76
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.
64 84
65=item example-refresh-hooks 85=item example-refresh-hooks
66 86
67Displays 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
68window. Illustrates overwriting the refresh callbacks to create your own 88window. Illustrates overwriting the refresh callbacks to create your own
69overlays or changes. 89overlays or changes.
70
71=item mark-urls
72
73A not very useful example of filtering all text output to the terminal, by
74underlining all urls that matches a certain regex (i.e. some urls :). It
75is not very useful because urls that are output in multiple steps (e.g.
76when typing them) do not get marked.
77 90
78=back 91=back
79 92
80=head2 General API Considerations 93=head2 General API Considerations
81 94
113 126
114=back 127=back
115 128
116=head2 Hooks 129=head2 Hooks
117 130
118The following subroutines can be declared in loaded scripts, and will be 131The following subroutines can be declared in extension files, and will be
119called whenever the relevant event happens. 132called whenever the relevant event happens.
120 133
121The 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
122and 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
123its 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>
124object 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>
125member. 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.
126 140
127All 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
128counts 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,
129and 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.
130 144
133=over 4 147=over 4
134 148
135=item on_init $term 149=item on_init $term
136 150
137Called after a new terminal object has been initialized, but before 151Called after a new terminal object has been initialized, but before
138windows are created or the command gets run. 152windows are created or the command gets run. Most methods are unsafe to
153call or deliver senseless data, as terminal size and other characteristics
154have not yet been determined. You can safely query and change resources,
155though.
139 156
140=item on_reset $term 157=item on_reset $term
141 158
142Called after the screen is "reset" for any reason, such as resizing or 159Called after the screen is "reset" for any reason, such as resizing or
143control sequences. Here is where you can react on changes to size-related 160control sequences. Here is where you can react on changes to size-related
172should 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
173processing. 190processing.
174 191
175See the F<selection> example extension. 192See the F<selection> example extension.
176 193
177=item on_focus_in $term
178
179Called whenever the window gets the keyboard focus, before urxvt does
180focus in processing.
181
182=item on_focus_out $term
183
184Called wheneever the window loses keyboard focus, before urxvt does focus
185out processing.
186
187=item on_view_change $term, $offset 194=item on_view_change $term, $offset
188 195
189Called whenever the view offset changes, i..e the user or program 196Called whenever the view offset changes, i..e the user or program
190scrolls. Offset C<0> means display the normal terminal, positive values 197scrolls. Offset C<0> means display the normal terminal, positive values
191show this many lines of scrollback. 198show this many lines of scrollback.
197than the scroll back buffer or the terminal. 204than the scroll back buffer or the terminal.
198 205
199It 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,
200$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
201number of lines that will be in the scrollback buffer. 208number of lines that will be in the scrollback buffer.
202
203=item on_tty_activity $term *NYI*
204
205Called whenever the program(s) running in the urxvt window send output.
206 209
207=item on_osc_seq $term, $string 210=item on_osc_seq $term, $string
208 211
209Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 212Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
210operating system command) is processed. Cursor position and other state 213operating system command) is processed. Cursor position and other state
223can filter/change and output the text yourself by returning a true value 226can filter/change and output the text yourself by returning a true value
224and calling C<< $term->scr_add_lines >> yourself. Please note that this 227and calling C<< $term->scr_add_lines >> yourself. Please note that this
225might be very slow, however, as your hook is called for B<all> text being 228might be very slow, however, as your hook is called for B<all> text being
226output. 229output.
227 230
231=item on_line_update $term, $row
232
233Called whenever a line was updated or changed. Can be used to filter
234screen output (e.g. underline urls or other useless stuff). Only lines
235that are being shown will be filtered, and, due to performance reasons,
236not always immediately.
237
238The row number is always the topmost row of the line if the line spans
239multiple rows.
240
241Please note that, if you change the line, then the hook might get called
242later with the already-modified line (e.g. if unrelated parts change), so
243you cannot just toggle rendition bits, but only set them.
244
228=item on_refresh_begin $term 245=item on_refresh_begin $term
229 246
230Called just before the screen gets redrawn. Can be used for overlay 247Called just before the screen gets redrawn. Can be used for overlay
231or similar effects by modify terminal contents in refresh_begin, and 248or similar effects by modify terminal contents in refresh_begin, and
232restoring them in refresh_end. The built-in overlay and selection display 249restoring them in refresh_end. The built-in overlay and selection display
240 257
241Called whenever the user presses a key combination that has a 258Called whenever the user presses a key combination that has a
242C<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>
243resource in the @@RXVT_NAME@@(1) manpage). 260resource in the @@RXVT_NAME@@(1) manpage).
244 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
272=item on_key_press $term, $event, $octets
273
274=item on_key_release $term, $event
275
276=item on_button_press $term, $event
277
278=item on_button_release $term, $event
279
280=item on_motion_notify $term, $event
281
282=item on_map_notify $term, $event
283
284=item on_unmap_notify $term, $event
285
286Called whenever the corresponding X event is received for the terminal If
287the hook returns true, then the even will be ignored by rxvt-unicode.
288
289The event is a hash with most values as named by Xlib (see the XEvent
290manpage), with the additional members C<row> and C<col>, which are the row
291and column under the mouse cursor.
292
293C<on_key_press> additionally receives the string rxvt-unicode would
294output, if any, in locale-specific encoding.
295
296subwindow.
297
245=back 298=back
246 299
247=head2 Variables in the C<urxvt> Package 300=head2 Variables in the C<urxvt> Package
248 301
249=over 4 302=over 4
250 303
251=item $urxvt::TERM 304=item $urxvt::TERM
252 305
253The current terminal. Whenever a callback/Hook is bein executed, this 306The current terminal. This variable stores the current C<urxvt::term>
254variable stores the current C<urxvt::term> object. 307object, whenever a callback/hook is executing.
255 308
256=back 309=back
257 310
258=head2 Functions in the C<urxvt> Package 311=head2 Functions in the C<urxvt> Package
259 312
260=over 4 313=over 4
314
315=item $term = new urxvt [arg...]
316
317Creates a new terminal, very similar as if you had started it with
318C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319if the new instance couldn't be created. Returns C<undef> if the new
320instance didn't initialise perl, and the terminal object otherwise. The
321C<init> and C<start> hooks will be called during the call.
261 322
262=item urxvt::fatal $errormessage 323=item urxvt::fatal $errormessage
263 324
264Fatally aborts execution with the given error message. Avoid at all 325Fatally aborts execution with the given error message. Avoid at all
265costs! The only time this is acceptable is when the terminal process 326costs! The only time this is acceptable is when the terminal process
272that calls this function. 333that calls this function.
273 334
274Using 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
275correct place, e.g. on stderr of the connecting urxvtc client. 336correct place, e.g. on stderr of the connecting urxvtc client.
276 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
277=item $time = urxvt::NOW 344=item $time = urxvt::NOW
278 345
279Returns 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.
280 355
281=back 356=back
282 357
283=head2 RENDITION 358=head2 RENDITION
284 359
334 409
335=cut 410=cut
336 411
337package urxvt; 412package urxvt;
338 413
414use utf8;
339use strict; 415use strict;
340use Scalar::Util (); 416use Scalar::Util ();
417use List::Util ();
341 418
419our $VERSION = 1;
342our $TERM; 420our $TERM;
343our @HOOKNAME; 421our @HOOKNAME;
422our %OPTION;
344our $LIBDIR; 423our $LIBDIR;
345 424
346BEGIN { 425BEGIN {
347 urxvt->bootstrap; 426 urxvt->bootstrap;
348 427
351 my $msg = join "", @_; 430 my $msg = join "", @_;
352 $msg .= "\n" 431 $msg .= "\n"
353 unless $msg =~ /\n$/; 432 unless $msg =~ /\n$/;
354 urxvt::warn ($msg); 433 urxvt::warn ($msg);
355 }; 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";
356} 440}
357 441
358my @hook_count; 442my @hook_count;
359my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 443my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
360 444
378 $hook_count[$htype]++ 462 $hook_count[$htype]++
379 or set_should_invoke $htype, 1; 463 or set_should_invoke $htype, 1;
380 } 464 }
381} 465}
382 466
383my $script_pkg = "script0000"; 467my $extension_pkg = "extension0000";
384my %script_pkg; 468my %extension_pkg;
385 469
386# load a single script into its own package, once only 470# load a single script into its own package, once only
387sub script_package($) { 471sub extension_package($) {
388 my ($path) = @_; 472 my ($path) = @_;
389 473
390 $script_pkg{$path} ||= do { 474 $extension_pkg{$path} ||= do {
391 my $pkg = "urxvt::" . ($script_pkg++); 475 my $pkg = "urxvt::" . ($extension_pkg++);
392 476
393 verbose 3, "loading script '$path' into package '$pkg'"; 477 verbose 3, "loading extension '$path' into package '$pkg'";
394 478
395 open my $fh, "<:raw", $path 479 open my $fh, "<:raw", $path
396 or die "$path: $!"; 480 or die "$path: $!";
397 481
398 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"
399 . "#line 1 \"$path\"\n{\n" 484 . "#line 1 \"$path\"\n{\n"
400 . (do { local $/; <$fh> }) 485 . (do { local $/; <$fh> })
401 . "\n};\n1"; 486 . "\n};\n1";
402 487
403 eval $source or die "$path: $@"; 488 eval $source or die "$path: $@";
413 local $TERM = shift; 498 local $TERM = shift;
414 my $htype = shift; 499 my $htype = shift;
415 500
416 if ($htype == 0) { # INIT 501 if ($htype == 0) { # INIT
417 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 502 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503
504 my %want_ext;
418 505
419 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) {
420 my @files = grep -f $_, map "$_/$ext", @dirs; 517 my @files = grep -f $_, map "$_/$ext", @dirs;
421 518
422 if (@files) { 519 if (@files) {
423 register_package script_package $files[0]; 520 register_package extension_package $files[0];
424 } else { 521 } else {
425 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";
426 } 523 }
427 } 524 }
525
526 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
527 warn $@ if $@;
428 } 528 }
429 529
430 $retval = undef; 530 $retval = undef;
431 531
432 if (my $cb = $TERM->{_hook}[$htype]) { 532 if (my $cb = $TERM->{_hook}[$htype]) {
434 if $verbosity >= 10; 534 if $verbosity >= 10;
435 535
436 keys %$cb; 536 keys %$cb;
437 537
438 while (my ($pkg, $cb) = each %$cb) { 538 while (my ($pkg, $cb) = each %$cb) {
539 eval {
439 $retval = $cb->( 540 $retval = $cb->(
440 $TERM->{_pkg}{$pkg} ||= do { 541 $TERM->{_pkg}{$pkg} ||= do {
441 my $proxy = bless { }, urxvt::term::proxy::; 542 my $proxy = bless { }, $pkg;
442 Scalar::Util::weaken ($proxy->{term} = $TERM); 543 Scalar::Util::weaken ($proxy->{term} = $TERM);
443 $proxy 544 $proxy
444 }, 545 },
445 @_, 546 @_,
446 ) and last; 547 ) and last;
548 };
549 if ($@) {
550 $TERM->ungrab; # better to lose the grab than the session
551 warn $@;
552 }
447 } 553 }
448 } 554 }
449 555
450 if ($htype == 1) { # DESTROY 556 if ($htype == 1) { # DESTROY
451 # remove hooks if unused 557 # remove hooks if unused
464 } 570 }
465 571
466 $retval 572 $retval
467} 573}
468 574
575# urxvt::term::proxy
576
469sub urxvt::term::proxy::AUTOLOAD { 577sub urxvt::term::proxy::AUTOLOAD {
470 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 578 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
471 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 579 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
472 580
473 eval qq{ 581 eval qq{
479 } or die "FATAL: unable to compile method forwarder: $@"; 587 } or die "FATAL: unable to compile method forwarder: $@";
480 588
481 goto &$urxvt::term::proxy::AUTOLOAD; 589 goto &$urxvt::term::proxy::AUTOLOAD;
482} 590}
483 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
484=head2 The C<urxvt::term> Class 676=head2 The C<urxvt::term> Class
485 677
486=over 4 678=over 4
679
680=item $term->destroy
681
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
487 699
488=item $value = $term->resource ($name[, $newval]) 700=item $value = $term->resource ($name[, $newval])
489 701
490Returns the current resource value associated with a given name and 702Returns the current resource value associated with a given name and
491optionally 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>
501 713
502Please note that resource strings will currently only be freed when the 714Please note that resource strings will currently only be freed when the
503terminal is destroyed, so changing options frequently will eat memory. 715terminal is destroyed, so changing options frequently will eat memory.
504 716
505Here 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
506are 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>
507list: 719to see the actual list:
508 720
509 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 721 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
510 borderLess color cursorBlink cursorUnderline cutchars delete_key 722 borderLess color cursorBlink cursorUnderline cutchars delete_key
511 display_name embed ext_bwidth fade font geometry hold iconName 723 display_name embed ext_bwidth fade font geometry hold iconName
512 imFont imLocale inputMethod insecure int_bwidth intensityStyles 724 imFont imLocale inputMethod insecure int_bwidth intensityStyles
519 shade term_name title transparent transparent_all tripleclickwords 731 shade term_name title transparent transparent_all tripleclickwords
520 utmpInhibit visualBell 732 utmpInhibit visualBell
521 733
522=cut 734=cut
523 735
524sub urxvt::term::resource($$;$) { 736sub resource($$;$) {
525 my ($self, $name) = (shift, shift); 737 my ($self, $name) = (shift, shift);
526 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 738 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
527 goto &urxvt::term::_resource; 739 &urxvt::term::_resource
528} 740}
529 741
530=item $rend = $term->rstyle ([$new_rstyle]) 742=item $rend = $term->rstyle ([$new_rstyle])
531 743
532Return and optionally change the current rendition. Text that is output by 744Return and optionally change the current rendition. Text that is output by
608 820
609If hidden, display the overlay again. 821If hidden, display the overlay again.
610 822
611=back 823=back
612 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
613=item $cellwidth = $term->strwidth $string 852=item $cellwidth = $term->strwidth ($string)
614 853
615Returns the number of screen-cells this string would need. Correctly 854Returns the number of screen-cells this string would need. Correctly
616accounts for wide and combining characters. 855accounts for wide and combining characters.
617 856
618=item $octets = $term->locale_encode $string 857=item $octets = $term->locale_encode ($string)
619 858
620Convert the given text string into the corresponding locale encoding. 859Convert the given text string into the corresponding locale encoding.
621 860
622=item $string = $term->locale_decode $octets 861=item $string = $term->locale_decode ($octets)
623 862
624Convert the given locale-encoded octets into a perl string. 863Convert the given locale-encoded octets into a perl string.
625 864
626=item $term->scr_add_lines ($string) 865=item $term->scr_add_lines ($string)
627 866
632 871
633Normally its not a good idea to use this function, as programs might be 872Normally its not a good idea to use this function, as programs might be
634confused by changes in cursor position or scrolling. Its useful inside a 873confused by changes in cursor position or scrolling. Its useful inside a
635C<on_add_lines> hook, though. 874C<on_add_lines> hook, though.
636 875
876=item $term->cmd_parse ($octets)
877
878Similar to C<scr_add_lines>, but the argument must be in the
879locale-specific encoding of the terminal and can contain command sequences
880(escape codes) that will be interpreted.
881
637=item $term->tt_write ($octets) 882=item $term->tt_write ($octets)
638 883
639Write the octets given in C<$data> to the tty (i.e. as program input). To 884Write the octets given in C<$data> to the tty (i.e. as program input). To
640pass characters instead of octets, you should convert your strings first 885pass characters instead of octets, you should convert your strings first
641to the locale-specific encoding using C<< $term->locale_encode >>. 886to the locale-specific encoding using C<< $term->locale_encode >>.
642 887
888=item $windowid = $term->parent
889
890Return the window id of the toplevel window.
891
892=item $windowid = $term->vt
893
894Return the window id of the terminal window.
895
643=item $window_width = $term->width 896=item $window_width = $term->width
644 897
645=item $window_height = $term->height 898=item $window_height = $term->height
646 899
647=item $font_width = $term->fwidth 900=item $font_width = $term->fwidth
663=item $nrow_plus_saveLines = $term->total_rows 916=item $nrow_plus_saveLines = $term->total_rows
664 917
665=item $lines_in_scrollback = $term->nsaved 918=item $lines_in_scrollback = $term->nsaved
666 919
667Return various integers describing terminal characteristics. 920Return various integers describing terminal characteristics.
921
922=item $lc_ctype = $term->locale
923
924Returns the LC_CTYPE category string used by this rxvt-unicode.
925
926=item $x_display = $term->display_id
927
928Return the DISPLAY used by rxvt-unicode.
929
930=item $modifiermask = $term->ModLevel3Mask
931
932=item $modifiermask = $term->ModMetaMask
933
934=item $modifiermask = $term->ModNumLockMask
935
936Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
937AltGr), the meta key (often Alt) and the num lock key, if applicable.
668 938
669=item $view_start = $term->view_start ([$newvalue]) 939=item $view_start = $term->view_start ([$newvalue])
670 940
671Returns the negative row number of the topmost line. Minimum value is 941Returns the negative row number of the topmost line. Minimum value is
672C<0>, which displays the normal terminal contents. Larger values scroll 942C<0>, which displays the normal terminal contents. Larger values scroll
735about the logical line that row C<$row_number> is part of. It supports the 1005about the logical line that row C<$row_number> is part of. It supports the
736following methods: 1006following methods:
737 1007
738=over 4 1008=over 4
739 1009
740=item $text = $line->t 1010=item $text = $line->t ([$new_text])
741 1011
742Returns the full text of the line, similar to C<ROW_t> 1012Returns or replaces the full text of the line, similar to C<ROW_t>
743 1013
744=item $rend = $line->r 1014=item $rend = $line->r ([$new_rend])
745 1015
746Returns the full rendition array of the line, similar to C<ROW_r> 1016Returns or replaces the full rendition array of the line, similar to C<ROW_r>
747 1017
748=item $length = $line->l 1018=item $length = $line->l
749 1019
750Returns the length of the line in cells, similar to C<ROW_l>. 1020Returns the length of the line in cells, similar to C<ROW_l>.
751 1021
766 1036
767=back 1037=back
768 1038
769=cut 1039=cut
770 1040
771sub urxvt::term::line { 1041sub line {
772 my ($self, $row) = @_; 1042 my ($self, $row) = @_;
773 1043
774 my $maxrow = $self->nrow - 1; 1044 my $maxrow = $self->nrow - 1;
775 1045
776 my ($beg, $end) = ($row, $row); 1046 my ($beg, $end) = ($row, $row);
780 1050
781 bless { 1051 bless {
782 term => $self, 1052 term => $self,
783 beg => $beg, 1053 beg => $beg,
784 end => $end, 1054 end => $end,
1055 ncol => $self->ncol,
785 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), 1056 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
786 }, urxvt::line:: 1057 }, urxvt::line::
787} 1058}
788 1059
789sub urxvt::line::t { 1060sub urxvt::line::t {
790 my ($self) = @_; 1061 my ($self) = @_;
791 1062
1063 if (@_ > 1)
1064 {
1065 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1066 for $self->{beg} .. $self->{end};
1067 }
1068
1069 defined wantarray &&
792 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1070 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
793 0, $self->{len} 1071 0, $self->{len}
794} 1072}
795 1073
796sub urxvt::line::r { 1074sub urxvt::line::r {
797 my ($self) = @_; 1075 my ($self) = @_;
798 1076
1077 if (@_ > 1)
1078 {
1079 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1080 for $self->{beg} .. $self->{end};
1081 }
1082
1083 if (defined wantarray) {
799 my $rend = [ 1084 my $rend = [
800 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1085 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
801 ]; 1086 ];
802 $#$rend = $self->{len} - 1; 1087 $#$rend = $self->{len} - 1;
803 $rend 1088 return $rend;
1089 }
1090
1091 ()
804} 1092}
805 1093
806sub urxvt::line::beg { $_[0]{beg} } 1094sub urxvt::line::beg { $_[0]{beg} }
807sub urxvt::line::end { $_[0]{end} } 1095sub urxvt::line::end { $_[0]{end} }
808sub urxvt::line::l { $_[0]{len} } 1096sub urxvt::line::l { $_[0]{len} }
809 1097
810sub urxvt::line::offset_of { 1098sub urxvt::line::offset_of {
811 my ($self, $row, $col) = @_; 1099 my ($self, $row, $col) = @_;
812 1100
813 ($row - $self->{beg}) * $self->{term}->ncol + $col 1101 ($row - $self->{beg}) * $self->{ncol} + $col
814} 1102}
815 1103
816sub urxvt::line::coord_of { 1104sub urxvt::line::coord_of {
817 my ($self, $offset) = @_; 1105 my ($self, $offset) = @_;
818 1106
819 use integer; 1107 use integer;
820 1108
821 ( 1109 (
822 $offset / $self->{term}->ncol + $self->{beg}, 1110 $offset / $self->{ncol} + $self->{beg},
823 $offset % $self->{term}->ncol 1111 $offset % $self->{ncol}
824 ) 1112 )
825} 1113}
826 1114
827=item ($row, $col) = $line->coord_of ($offset)
828=item $text = $term->special_encode $string 1115=item $text = $term->special_encode $string
829 1116
830Converts a perl string into the special encoding used by rxvt-unicode, 1117Converts a perl string into the special encoding used by rxvt-unicode,
831where one character corresponds to one screen cell. See 1118where one character corresponds to one screen cell. See
832C<< $term->ROW_t >> for details. 1119C<< $term->ROW_t >> for details.
834=item $string = $term->special_decode $text 1121=item $string = $term->special_decode $text
835 1122
836Converts rxvt-unicodes text reprsentation into a perl string. See 1123Converts rxvt-unicodes text reprsentation into a perl string. See
837C<< $term->ROW_t >> for details. 1124C<< $term->ROW_t >> for details.
838 1125
1126=item $success = $term->grab_button ($button, $modifiermask)
1127
1128Registers a synchronous button grab. See the XGrabButton manpage.
1129
1130=item $success = $term->grab ($eventtime[, $sync])
1131
1132Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1133synchronous (C<$sync> is true). Also remembers the grab timestampe.
1134
1135=item $term->allow_events_async
1136
1137Calls XAllowEvents with AsyncBoth for the most recent grab.
1138
1139=item $term->allow_events_sync
1140
1141Calls XAllowEvents with SyncBoth for the most recent grab.
1142
1143=item $term->allow_events_replay
1144
1145Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1146recent grab.
1147
1148=item $term->ungrab
1149
1150Calls XUngrab for the most recent grab. Is called automatically on
1151evaluation errors, as it is better to lose the grab in the error case as
1152the session.
1153
839=back 1154=back
1155
1156=cut
1157
1158package urxvt::popup;
1159
1160=head2 The C<urxvt::popup> Class
1161
1162=over 4
1163
1164=cut
1165
1166sub add_item {
1167 my ($self, $item) = @_;
1168
1169 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1170 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1171 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1172
1173 $item->{render} ||= sub { $_[0]{text} };
1174
1175 push @{ $self->{item} }, $item;
1176}
1177
1178sub add_separator {
1179 my ($self, $sep) = @_;
1180
1181 $sep ||= "=";
1182
1183 $self->add_item ({
1184 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1185 text => "",
1186 render => sub { $sep x $self->{term}->ncol },
1187 activate => sub { },
1188 });
1189}
1190
1191sub add_title {
1192 my ($self, $title) = @_;
1193
1194 $self->add_item ({
1195 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1196 text => $title,
1197 activate => sub { },
1198 });
1199}
1200
1201sub add_button {
1202 my ($self, $text, $cb) = @_;
1203
1204 $self->add_item ({ type => "button", text => $text, activate => $cb});
1205}
1206
1207sub add_toggle {
1208 my ($self, $text, $cb, $value) = @_;
1209
1210 my $item; $item = {
1211 type => "button",
1212 text => " $text",
1213 value => $value,
1214 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1215 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1216 };
1217
1218 $self->add_item ($item);
1219}
1220
1221sub show {
1222 my ($self) = @_;
1223
1224 local $urxvt::popup::self = $self;
1225
1226 local $ENV{LC_ALL} = $self->{term}->locale;
1227
1228 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1229 "--transient-for" => $self->{term}->parent,
1230 "-display" => $self->{term}->display_id,
1231 "-pe" => "urxvt-popup")
1232 or die "unable to create popup window\n";
1233}
1234
1235sub DESTROY {
1236 my ($self) = @_;
1237
1238 delete $self->{term}{_destroy}{$self};
1239 $self->{term}->ungrab;
1240}
840 1241
841=head2 The C<urxvt::timer> Class 1242=head2 The C<urxvt::timer> Class
842 1243
843This class implements timer watchers/events. Time is represented as a 1244This class implements timer watchers/events. Time is represented as a
844fractional number of seconds since the epoch. Example: 1245fractional number of seconds since the epoch. Example:
946This variable controls the verbosity level of the perl extension. Higher 1347This variable controls the verbosity level of the perl extension. Higher
947numbers indicate more verbose output. 1348numbers indicate more verbose output.
948 1349
949=over 4 1350=over 4
950 1351
951=item =0 - only fatal messages 1352=item == 0 - fatal messages
952 1353
953=item =3 - script loading and management 1354=item >= 3 - script loading and management
954 1355
955=item =10 - all events received 1356=item >=10 - all events received
956 1357
957=back 1358=back
958 1359
959=head1 AUTHOR 1360=head1 AUTHOR
960 1361

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines