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.48 by root, Sat Jan 7 21:43:17 2006 UTC vs.
Revision 1.79 by root, Wed Jan 11 02:13:56 2006 UTC

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
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31=head2 Prepackaged Extensions 31=head1 PREPACKAGED EXTENSIONS
32 32
33This section describes the extensiosn delivered with this version. You can 33This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
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 44(More) intelligent selection. This extension tries to be more intelligent
45the user extends selections (double-click). Right now, it tries to select 45when the user extends selections (double-click). Right now, it tries to
46urls and complete shell-quoted arguments, which is very convenient, too, 46select urls and complete shell-quoted arguments, which is very convenient,
47if your F<ls> supports C<--quoting-style=shell>. 47too, if your F<ls> supports C<--quoting-style=shell>.
48 48
49It also offers the following bindable event: 49It also offers the following bindable keyboard command:
50 50
51=over 4 51=over 4
52 52
53=item rot13 53=item rot13
54 54
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 (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content.
71
72=item searchable-scrollback<hotkey> (enabled by default)
73
74Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal
76input/output is suspended.
77
78C</> starts an incremental regex search, C<n> searches further, C<p> or
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the
80history, C<enter> leaves search mode at the current position and C<escape>
81returns to the original position.
82
61=item digital-clock 83=item digital-clock
62 84
63Displays a digital clock using the built-in overlay. 85Displays a digital clock using the built-in overlay.
64 86
65=item mark-urls 87=item mark-urls
66 88
67Uses per-line display filtering (C<on_line_update>) to underline urls. 89Uses per-line display filtering (C<on_line_update>) to underline urls and
90make them clickable. When clicked, the program specified in the resource
91C<urlLauncher> (default C<x-www-browser>) will be started.
68 92
69=item block-graphics-to-ascii 93=item block-graphics-to-ascii
70 94
71A not very useful example of filtering all text output to the terminal, 95A not very useful example of filtering all text output to the terminal,
72by replacing all line-drawing characters (U+2500 .. U+259F) by a 96by replacing all line-drawing characters (U+2500 .. U+259F) by a
77Displays a very simple digital clock in the upper right corner of the 101Displays a very simple digital clock in the upper right corner of the
78window. Illustrates overwriting the refresh callbacks to create your own 102window. Illustrates overwriting the refresh callbacks to create your own
79overlays or changes. 103overlays or changes.
80 104
81=back 105=back
106
107=head1 API DOCUMENTATION
82 108
83=head2 General API Considerations 109=head2 General API Considerations
84 110
85All objects (such as terminals, time watchers etc.) are typical 111All objects (such as terminals, time watchers etc.) are typical
86reference-to-hash objects. The hash can be used to store anything you 112reference-to-hash objects. The hash can be used to store anything you
99=over 4 125=over 4
100 126
101=item $text 127=item $text
102 128
103Rxvt-unicodes special way of encoding text, where one "unicode" character 129Rxvt-unicodes special way of encoding text, where one "unicode" character
104always represents one screen cell. See L<row_t> for a discussion of this format. 130always represents one screen cell. See L<ROW_t> for a discussion of this format.
105 131
106=item $string 132=item $string
107 133
108A perl text string, with an emphasis on I<text>. It can store all unicode 134A perl text string, with an emphasis on I<text>. It can store all unicode
109characters and is to be distinguished with text encoded in a specific 135characters and is to be distinguished with text encoded in a specific
114Either binary data or - more common - a text string encoded in a 140Either binary data or - more common - a text string encoded in a
115locale-specific way. 141locale-specific way.
116 142
117=back 143=back
118 144
145=head2 Extension Objects
146
147Very perl extension is a perl class. A separate perl object is created
148for each terminal and each extension and passed as the first parameter to
149hooks. So extensions can use their C<$self> object without having to think
150about other extensions, with the exception of methods and members that
151begin with an underscore character C<_>: these are reserved for internal
152use.
153
154Although it isn't a C<urxvt::term> object, you can call all methods of the
155C<urxvt::term> class on this object.
156
157It has the following methods and data members:
158
159=over 4
160
161=item $urxvt_term = $self->{term}
162
163Returns the C<urxvt::term> object associated with this instance of the
164extension. This member I<must not> be changed in any way.
165
166=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
167
168Dynamically enable the given hooks (named without the C<on_> prefix) for
169this extension, replacing any previous hook. This is useful when you want
170to overwrite time-critical hooks only temporarily.
171
172=item $self->disable ($hook_name[, $hook_name..])
173
174Dynamically disable the given hooks.
175
176=back
177
119=head2 Hooks 178=head2 Hooks
120 179
121The following subroutines can be declared in extension files, and will be 180The following subroutines can be declared in extension files, and will be
122called whenever the relevant event happens. 181called whenever the relevant event happens.
123 182
124The first argument passed to them is an object private to each terminal 183The first argument passed to them is an extension oject as described in
125and extension package. You can call all C<urxvt::term> methods on it, but 184the in the C<Extension Objects> section.
126its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127object that is shared between all packages is stored in the C<term>
128member. It is, however, blessed intot he package of the extension script,
129so for all practical purposes you can treat an extension script as a class.
130 185
131All of them must return a boolean value. If it is true, then the event 186B<All> of these hooks must return a boolean value. If it is true, then the
132counts as being I<consumed>, and the invocation of other hooks is skipped, 187event counts as being I<consumed>, and the invocation of other hooks is
133and the relevant action might not be carried out by the C++ code. 188skipped, and the relevant action might not be carried out by the C++ code.
134 189
135When in doubt, return a false value (preferably C<()>). 190I<< When in doubt, return a false value (preferably C<()>). >>
136 191
137=over 4 192=over 4
138 193
139=item on_init $term 194=item on_init $term
140 195
194than the scroll back buffer or the terminal. 249than the scroll back buffer or the terminal.
195 250
196It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 251It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
197$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 252$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198number of lines that will be in the scrollback buffer. 253number of lines that will be in the scrollback buffer.
199
200=item on_tty_activity $term *NYI*
201
202Called whenever the program(s) running in the urxvt window send output.
203 254
204=item on_osc_seq $term, $string 255=item on_osc_seq $term, $string
205 256
206Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 257Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207operating system command) is processed. Cursor position and other state 258operating system command) is processed. Cursor position and other state
220can filter/change and output the text yourself by returning a true value 271can filter/change and output the text yourself by returning a true value
221and calling C<< $term->scr_add_lines >> yourself. Please note that this 272and calling C<< $term->scr_add_lines >> yourself. Please note that this
222might be very slow, however, as your hook is called for B<all> text being 273might be very slow, however, as your hook is called for B<all> text being
223output. 274output.
224 275
276=item on_tt_write $term, $octets
277
278Called whenever some data is written to the tty/pty and can be used to
279suppress or filter tty input.
280
225=item on_line_update $term, $row 281=item on_line_update $term, $row
226 282
227Called whenever a line was updated or changed. Can be used to filter 283Called whenever a line was updated or changed. Can be used to filter
228screen output (e.g. underline urls or other useless stuff). Only lines 284screen output (e.g. underline urls or other useless stuff). Only lines
229that are being shown will be filtered, and, due to performance reasons, 285that are being shown will be filtered, and, due to performance reasons,
261=item on_focus_out $term 317=item on_focus_out $term
262 318
263Called wheneever the window loses keyboard focus, before rxvt-unicode does 319Called wheneever the window loses keyboard focus, before rxvt-unicode does
264focus out processing. 320focus out processing.
265 321
266=item on_key_press $term, $event, $octets 322=item on_key_press $term, $event, $keysym, $octets
267 323
268=item on_key_release $term, $event 324=item on_key_release $term, $event, $keysym
269 325
270=item on_button_press $term, $event 326=item on_button_press $term, $event
271 327
272=item on_button_release $term, $event 328=item on_button_release $term, $event
273 329
289 345
290subwindow. 346subwindow.
291 347
292=back 348=back
293 349
350=cut
351
352package urxvt;
353
354use utf8;
355use strict;
356use Carp ();
357use Scalar::Util ();
358use List::Util ();
359
360our $VERSION = 1;
361our $TERM;
362our @HOOKNAME;
363our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364our %OPTION;
365
366our $LIBDIR;
367our $RESNAME;
368our $RESCLASS;
369our $RXVTNAME;
370
294=head2 Variables in the C<urxvt> Package 371=head2 Variables in the C<urxvt> Package
295 372
296=over 4 373=over 4
374
375=item $urxvt::LIBDIR
376
377The rxvt-unicode library directory, where, among other things, the perl
378modules and scripts are stored.
379
380=item $urxvt::RESCLASS, $urxvt::RESCLASS
381
382The resource class and name rxvt-unicode uses to look up X resources.
383
384=item $urxvt::RXVTNAME
385
386The basename of the installed binaries, usually C<urxvt>.
297 387
298=item $urxvt::TERM 388=item $urxvt::TERM
299 389
300The current terminal. This variable stores the current C<urxvt::term> 390The current terminal. This variable stores the current C<urxvt::term>
301object, whenever a callback/hook is executing. 391object, whenever a callback/hook is executing.
303=back 393=back
304 394
305=head2 Functions in the C<urxvt> Package 395=head2 Functions in the C<urxvt> Package
306 396
307=over 4 397=over 4
308
309=item $term = new urxvt [arg...]
310
311Creates a new terminal, very similar as if you had started it with
312C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313if the new instance couldn't be created. Returns C<undef> if the new
314instance didn't initialise perl, and the terminal object otherwise. The
315C<init> and C<start> hooks will be called during the call.
316 398
317=item urxvt::fatal $errormessage 399=item urxvt::fatal $errormessage
318 400
319Fatally aborts execution with the given error message. Avoid at all 401Fatally aborts execution with the given error message. Avoid at all
320costs! The only time this is acceptable is when the terminal process 402costs! The only time this is acceptable is when the terminal process
327that calls this function. 409that calls this function.
328 410
329Using this function has the advantage that its output ends up in the 411Using this function has the advantage that its output ends up in the
330correct place, e.g. on stderr of the connecting urxvtc client. 412correct place, e.g. on stderr of the connecting urxvtc client.
331 413
414Messages have a size limit of 1023 bytes currently.
415
416=item $is_safe = urxvt::safe
417
418Returns true when it is safe to do potentially unsafe things, such as
419evaluating perl code specified by the user. This is true when urxvt was
420started setuid or setgid.
421
332=item $time = urxvt::NOW 422=item $time = urxvt::NOW
333 423
334Returns the "current time" (as per the event loop). 424Returns the "current time" (as per the event loop).
335 425
336=item urxvt::CurrentTime 426=item urxvt::CurrentTime
337 427
338=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340Button4Mask, Button5Mask, AnyModifier 430Button4Mask, Button5Mask, AnyModifier
341 431
342Various constants for use in X events. 432Various constants for use in X calls and event processing.
343 433
344=back 434=back
345 435
346=head2 RENDITION 436=head2 RENDITION
347 437
374 464
375=item $background = urxvt::GET_BASEBG $rend 465=item $background = urxvt::GET_BASEBG $rend
376 466
377Return the foreground/background colour index, respectively. 467Return the foreground/background colour index, respectively.
378 468
379=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 469=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380 470
381=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 471=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
382 472
383Replace the foreground/background colour in the rendition mask with the 473Replace the foreground/background colour in the rendition mask with the
384specified one. 474specified one.
385 475
386=item $value = urxvt::GET_CUSTOM ($rend) 476=item $value = urxvt::GET_CUSTOM $rend
387 477
388Return the "custom" value: Every rendition has 5 bits for use by 478Return the "custom" value: Every rendition has 5 bits for use by
389extensions. They can be set and changed as you like and are initially 479extensions. They can be set and changed as you like and are initially
390zero. 480zero.
391 481
392=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 482=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393 483
394Change the custom value. 484Change the custom value.
395 485
396=back 486=back
397 487
398=cut 488=cut
399
400package urxvt;
401
402use utf8;
403use strict;
404use Scalar::Util ();
405use List::Util ();
406
407our $TERM;
408our @HOOKNAME;
409our $LIBDIR;
410 489
411BEGIN { 490BEGIN {
412 urxvt->bootstrap; 491 urxvt->bootstrap;
413 492
414 # overwrite perl's warn 493 # overwrite perl's warn
416 my $msg = join "", @_; 495 my $msg = join "", @_;
417 $msg .= "\n" 496 $msg .= "\n"
418 unless $msg =~ /\n$/; 497 unless $msg =~ /\n$/;
419 urxvt::warn ($msg); 498 urxvt::warn ($msg);
420 }; 499 };
500
501 delete $ENV{IFS};
502 delete $ENV{CDPATH};
503 delete $ENV{BASH_ENV};
504 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
421} 505}
422 506
423my @hook_count; 507my @hook_count;
424my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 508my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
425 509
426sub verbose { 510sub verbose {
427 my ($level, $msg) = @_; 511 my ($level, $msg) = @_;
428 warn "$msg\n" if $level <= $verbosity; 512 warn "$msg\n" if $level <= $verbosity;
429} 513}
430 514
431# find on_xxx subs in the package and register them
432# as hooks
433sub register_package($) {
434 my ($pkg) = @_;
435
436 for my $htype (0.. $#HOOKNAME) {
437 my $name = $HOOKNAME[$htype];
438
439 my $ref = $pkg->can ("on_" . lc $name)
440 or next;
441
442 $TERM->{_hook}[$htype]{$pkg} = $ref;
443 $hook_count[$htype]++
444 or set_should_invoke $htype, 1;
445 }
446}
447
448my $extension_pkg = "extension0000"; 515my $extension_pkg = "extension0000";
449my %extension_pkg; 516my %extension_pkg;
450 517
451# load a single script into its own package, once only 518# load a single script into its own package, once only
452sub extension_package($) { 519sub extension_package($) {
458 verbose 3, "loading extension '$path' into package '$pkg'"; 525 verbose 3, "loading extension '$path' into package '$pkg'";
459 526
460 open my $fh, "<:raw", $path 527 open my $fh, "<:raw", $path
461 or die "$path: $!"; 528 or die "$path: $!";
462 529
530 my $source = untaint
463 my $source = "package $pkg; use strict; use utf8;\n" 531 "package $pkg; use strict; use utf8;\n"
464 . "use base urxvt::term::proxy::;\n" 532 . "use base urxvt::term::extension::;\n"
465 . "#line 1 \"$path\"\n{\n" 533 . "#line 1 \"$path\"\n{\n"
466 . (do { local $/; <$fh> }) 534 . (do { local $/; <$fh> })
467 . "\n};\n1"; 535 . "\n};\n1";
468 536
537 eval $source
469 eval $source or die "$path: $@"; 538 or die "$path: $@";
470 539
471 $pkg 540 $pkg
472 } 541 }
473} 542}
474 543
479 local $TERM = shift; 548 local $TERM = shift;
480 my $htype = shift; 549 my $htype = shift;
481 550
482 if ($htype == 0) { # INIT 551 if ($htype == 0) { # INIT
483 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 552 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
553
554 my %ext_arg;
484 555
485 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 556 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
557 if ($_ eq "default") {
558 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
559 } elsif (/^-(.*)$/) {
560 delete $ext_arg{$1};
561 } elsif (/^([^<]+)<(.*)>$/) {
562 push @{ $ext_arg{$1} }, $2;
563 } else {
564 $ext_arg{$_} ||= [];
565 }
566 }
567
568 while (my ($ext, $argv) = each %ext_arg) {
486 my @files = grep -f $_, map "$_/$ext", @dirs; 569 my @files = grep -f $_, map "$_/$ext", @dirs;
487 570
488 if (@files) { 571 if (@files) {
489 register_package extension_package $files[0]; 572 $TERM->register_package (extension_package $files[0], $argv);
490 } else { 573 } else {
491 warn "perl extension '$ext' not found in perl library search path\n"; 574 warn "perl extension '$ext' not found in perl library search path\n";
492 } 575 }
493 } 576 }
577
578 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
579 warn $@ if $@;
494 } 580 }
495 581
496 $retval = undef; 582 $retval = undef;
497 583
498 if (my $cb = $TERM->{_hook}[$htype]) { 584 if (my $cb = $TERM->{_hook}[$htype]) {
500 if $verbosity >= 10; 586 if $verbosity >= 10;
501 587
502 keys %$cb; 588 keys %$cb;
503 589
504 while (my ($pkg, $cb) = each %$cb) { 590 while (my ($pkg, $cb) = each %$cb) {
505 eval { 591 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
506 $retval = $cb->(
507 $TERM->{_pkg}{$pkg} ||= do {
508 my $proxy = bless { }, $pkg;
509 Scalar::Util::weaken ($proxy->{term} = $TERM);
510 $proxy
511 },
512 @_,
513 ) and last; 592 and last;
593
594 if ($@) {
595 $TERM->ungrab; # better to lose the grab than the session
596 warn $@;
514 }; 597 }
515 warn $@ if $@;#d#
516 } 598 }
517 } 599 }
518 600
519 if ($htype == 1) { # DESTROY 601 if ($htype == 1) { # DESTROY
520 # remove hooks if unused
521 if (my $hook = $TERM->{_hook}) { 602 if (my $hook = delete $TERM->{_hook}) {
522 for my $htype (0..$#$hook) { 603 for my $htype (0..$#$hook) {
523 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 604 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
524 or set_should_invoke $htype, 0; 605 or set_should_invoke $htype, 0;
525 } 606 }
526 } 607 }
533 } 614 }
534 615
535 $retval 616 $retval
536} 617}
537 618
538sub urxvt::term::proxy::AUTOLOAD { 619# urxvt::term::extension
539 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 620
621package urxvt::term::extension;
622
623sub enable {
624 my ($self, %hook) = @_;
625 my $pkg = $self->{_pkg};
626
627 while (my ($name, $cb) = each %hook) {
628 my $htype = $HOOKTYPE{uc $name};
629 defined $htype
630 or Carp::croak "unsupported hook type '$name'";
631
632 unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
633 $hook_count[$htype]++
634 or urxvt::set_should_invoke $htype, 1;
635 }
636
637 $self->{term}{_hook}[$htype]{$pkg} = $cb;
638 }
639}
640
641sub disable {
642 my ($self, @hook) = @_;
643 my $pkg = $self->{_pkg};
644
645 for my $name (@hook) {
646 my $htype = $HOOKTYPE{uc $name};
647 defined $htype
648 or Carp::croak "unsupported hook type '$name'";
649
650 if (delete $self->{term}{_hook}[$htype]{$pkg}) {
651 --$hook_count[$htype]
652 or urxvt::set_should_invoke $htype, 0;
653 }
654 }
655}
656
657our $AUTOLOAD;
658
659sub AUTOLOAD {
660 $AUTOLOAD =~ /:([^:]+)$/
540 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 661 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
541 662
542 eval qq{ 663 eval qq{
543 sub $urxvt::term::proxy::AUTOLOAD { 664 sub $AUTOLOAD {
544 my \$proxy = shift; 665 my \$proxy = shift;
545 \$proxy->{term}->$1 (\@_) 666 \$proxy->{term}->$1 (\@_)
546 } 667 }
547 1 668 1
548 } or die "FATAL: unable to compile method forwarder: $@"; 669 } or die "FATAL: unable to compile method forwarder: $@";
549 670
550 goto &$urxvt::term::proxy::AUTOLOAD; 671 goto &$AUTOLOAD;
551} 672}
673
674sub DESTROY {
675 # nop
676}
677
678# urxvt::destroy_hook
552 679
553sub urxvt::destroy_hook::DESTROY { 680sub urxvt::destroy_hook::DESTROY {
554 ${$_[0]}->(); 681 ${$_[0]}->();
555} 682}
556 683
557sub urxvt::destroy_hook(&) { 684sub urxvt::destroy_hook(&) {
558 bless \shift, urxvt::destroy_hook:: 685 bless \shift, urxvt::destroy_hook::
559} 686}
560 687
688package urxvt::anyevent;
689
690=head2 The C<urxvt::anyevent> Class
691
692The sole purpose of this class is to deliver an interface to the
693C<AnyEvent> module - any module using it will work inside urxvt without
694further programming. The only exception is that you cannot wait on
695condition variables, but non-blocking condvar use is ok. What this means
696is that you cannot use blocking APIs, but the non-blocking variant should
697work.
698
699=cut
700
701our $VERSION = 1;
702
703$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
704push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
705
706sub timer {
707 my ($class, %arg) = @_;
708
709 my $cb = $arg{cb};
710
711 urxvt::timer
712 ->new
713 ->start (urxvt::NOW + $arg{after})
714 ->cb (sub {
715 $_[0]->stop; # need to cancel manually
716 $cb->();
717 })
718}
719
720sub io {
721 my ($class, %arg) = @_;
722
723 my $cb = $arg{cb};
724
725 bless [$arg{fh}, urxvt::iow
726 ->new
727 ->fd (fileno $arg{fh})
728 ->events (($arg{poll} =~ /r/ ? 1 : 0)
729 | ($arg{poll} =~ /w/ ? 2 : 0))
730 ->start
731 ->cb (sub {
732 $cb->(($_[1] & 1 ? 'r' : '')
733 . ($_[1] & 2 ? 'w' : ''));
734 })],
735 urxvt::anyevent::
736}
737
738sub DESTROY {
739 $_[0][1]->stop;
740}
741
742sub condvar {
743 bless \my $flag, urxvt::anyevent::condvar::
744}
745
746sub urxvt::anyevent::condvar::broadcast {
747 ${$_[0]}++;
748}
749
750sub urxvt::anyevent::condvar::wait {
751 unless (${$_[0]}) {
752 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
753 }
754}
755
756package urxvt::term;
757
561=head2 The C<urxvt::term> Class 758=head2 The C<urxvt::term> Class
562 759
563=over 4 760=over 4
564 761
762=cut
763
764# find on_xxx subs in the package and register them
765# as hooks
766sub register_package {
767 my ($self, $pkg, $argv) = @_;
768
769 my $proxy = bless {
770 _pkg => $pkg,
771 argv => $argv,
772 }, $pkg;
773 Scalar::Util::weaken ($proxy->{term} = $self);
774
775 $self->{_pkg}{$pkg} = $proxy;
776
777 for my $name (@HOOKNAME) {
778 if (my $ref = $pkg->can ("on_" . lc $name)) {
779 $proxy->enable ($name => $ref);
780 }
781 }
782}
783
784=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
785
786Creates a new terminal, very similar as if you had started it with system
787C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
788hash which defines the environment of the new terminal.
789
790Croaks (and probably outputs an error message) if the new instance
791couldn't be created. Returns C<undef> if the new instance didn't
792initialise perl, and the terminal object otherwise. The C<init> and
793C<start> hooks will be called during this call.
794
795=cut
796
797sub new {
798 my ($class, $env, @args) = @_;
799
800 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
801}
802
565=item $term->destroy 803=item $term->destroy
566 804
567Destroy the terminal object (close the window, free resources etc.). 805Destroy the terminal object (close the window, free resources
806etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
807watchers (timers, io watchers) are still active.
808
809=item $isset = $term->option ($optval[, $set])
810
811Returns true if the option specified by C<$optval> is enabled, and
812optionally change it. All option values are stored by name in the hash
813C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
814
815Here is a a likely non-exhaustive list of option names, please see the
816source file F</src/optinc.h> to see the actual list:
817
818 borderLess console cursorBlink cursorUnderline hold iconic insecure
819 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
820 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
821 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
822 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
823 tripleclickwords utmpInhibit visualBell
568 824
569=item $value = $term->resource ($name[, $newval]) 825=item $value = $term->resource ($name[, $newval])
570 826
571Returns the current resource value associated with a given name and 827Returns the current resource value associated with a given name and
572optionally sets a new value. Setting values is most useful in the C<init> 828optionally sets a new value. Setting values is most useful in the C<init>
582 838
583Please note that resource strings will currently only be freed when the 839Please note that resource strings will currently only be freed when the
584terminal is destroyed, so changing options frequently will eat memory. 840terminal is destroyed, so changing options frequently will eat memory.
585 841
586Here is a a likely non-exhaustive list of resource names, not all of which 842Here is a a likely non-exhaustive list of resource names, not all of which
587are supported in every build, please see the source to see the actual 843are supported in every build, please see the source file F</src/rsinc.h>
588list: 844to see the actual list:
589 845
590 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 846 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
591 borderLess color cursorBlink cursorUnderline cutchars delete_key 847 borderLess color cursorBlink cursorUnderline cutchars delete_key
592 display_name embed ext_bwidth fade font geometry hold iconName 848 display_name embed ext_bwidth fade font geometry hold iconName
593 imFont imLocale inputMethod insecure int_bwidth intensityStyles 849 imFont imLocale inputMethod insecure int_bwidth intensityStyles
600 shade term_name title transparent transparent_all tripleclickwords 856 shade term_name title transparent transparent_all tripleclickwords
601 utmpInhibit visualBell 857 utmpInhibit visualBell
602 858
603=cut 859=cut
604 860
605sub urxvt::term::resource($$;$) { 861sub resource($$;$) {
606 my ($self, $name) = (shift, shift); 862 my ($self, $name) = (shift, shift);
607 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 863 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
608 &urxvt::term::_resource 864 &urxvt::term::_resource
609} 865}
610 866
867=item $value = $term->x_resource ($pattern)
868
869Returns the X-Resource for the given pattern, excluding the program or
870class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
871same value as used by this instance of rxvt-unicode. Returns C<undef> if no
872resource with that pattern exists.
873
874This method should only be called during the C<on_start> hook, as there is
875only one resource database per display, and later invocations might return
876the wrong resources.
877
878=item $success = $term->parse_keysym ($keysym_spec, $command_string)
879
880Adds a keymap translation exactly as specified via a resource. See the
881C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
882
611=item $rend = $term->rstyle ([$new_rstyle]) 883=item $rend = $term->rstyle ([$new_rstyle])
612 884
613Return and optionally change the current rendition. Text that is output by 885Return and optionally change the current rendition. Text that is output by
614the terminal application will use this style. 886the terminal application will use this style.
615 887
634 906
635=item $oldtext = $term->selection ([$newtext]) 907=item $oldtext = $term->selection ([$newtext])
636 908
637Return the current selection text and optionally replace it by C<$newtext>. 909Return the current selection text and optionally replace it by C<$newtext>.
638 910
639#=item $term->overlay ($x, $y, $text) 911=item $term->overlay_simple ($x, $y, $text)
640# 912
641#Create a simple multi-line overlay box. See the next method for details. 913Create a simple multi-line overlay box. See the next method for details.
642# 914
643#=cut 915=cut
644# 916
645#sub urxvt::term::scr_overlay { 917sub overlay_simple {
646# my ($self, $x, $y, $text) = @_; 918 my ($self, $x, $y, $text) = @_;
647# 919
648# my @lines = split /\n/, $text; 920 my @lines = split /\n/, $text;
649# 921
650# my $w = 0; 922 my $w = List::Util::max map $self->strwidth ($_), @lines;
651# for (map $self->strwidth ($_), @lines) { 923
652# $w = $_ if $w < $_;
653# }
654#
655# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 924 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
656# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 925 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
657#} 926
927 $overlay
928}
658 929
659=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 930=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
660 931
661Create a new (empty) overlay at the given position with the given 932Create a new (empty) overlay at the given position with the given
662width/height. C<$rstyle> defines the initial rendition style 933width/height. C<$rstyle> defines the initial rendition style
697C<$event> I<must> be the event causing the menu to pop up (a button event, 968C<$event> I<must> be the event causing the menu to pop up (a button event,
698currently). 969currently).
699 970
700=cut 971=cut
701 972
702sub urxvt::term::popup { 973sub popup {
703 my ($self, $event) = @_; 974 my ($self, $event) = @_;
704 975
705 $self->grab ($event->{time}, 1) 976 $self->grab ($event->{time}, 1)
706 or return; 977 or return;
707 978
729 1000
730=item $string = $term->locale_decode ($octets) 1001=item $string = $term->locale_decode ($octets)
731 1002
732Convert the given locale-encoded octets into a perl string. 1003Convert the given locale-encoded octets into a perl string.
733 1004
1005=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1006
1007XORs the rendition values in the given span with the provided value
1008(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
1009to the selection.
1010
1011=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1012
1013Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1014whitespace will additionally be xored with the C<$rstyle2>, which defaults
1015to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1016it instead.
1017
1018=item $term->scr_bell
1019
1020Ring the bell!
1021
734=item $term->scr_add_lines ($string) 1022=item $term->scr_add_lines ($string)
735 1023
736Write the given text string to the screen, as if output by the application 1024Write the given text string to the screen, as if output by the application
737running inside the terminal. It may not contain command sequences (escape 1025running inside the terminal. It may not contain command sequences (escape
738codes), but is free to use line feeds, carriage returns and tabs. The 1026codes), but is free to use line feeds, carriage returns and tabs. The
752 1040
753Write the octets given in C<$data> to the tty (i.e. as program input). To 1041Write the octets given in C<$data> to the tty (i.e. as program input). To
754pass characters instead of octets, you should convert your strings first 1042pass characters instead of octets, you should convert your strings first
755to the locale-specific encoding using C<< $term->locale_encode >>. 1043to the locale-specific encoding using C<< $term->locale_encode >>.
756 1044
1045=item $old_events = $term->pty_ev_events ([$new_events])
1046
1047Replaces the event mask of the pty watcher by the given event mask. Can
1048be used to suppress input and output handling to the pty/tty. See the
1049description of C<< urxvt::timer->events >>. Make sure to always restore
1050the previous value.
1051
757=item $windowid = $term->parent 1052=item $windowid = $term->parent
758 1053
759Return the window id of the toplevel window. 1054Return the window id of the toplevel window.
760 1055
761=item $windowid = $term->vt 1056=item $windowid = $term->vt
785=item $nrow_plus_saveLines = $term->total_rows 1080=item $nrow_plus_saveLines = $term->total_rows
786 1081
787=item $lines_in_scrollback = $term->nsaved 1082=item $lines_in_scrollback = $term->nsaved
788 1083
789Return various integers describing terminal characteristics. 1084Return various integers describing terminal characteristics.
1085
1086=item $x_display = $term->display_id
1087
1088Return the DISPLAY used by rxvt-unicode.
1089
1090=item $lc_ctype = $term->locale
1091
1092Returns the LC_CTYPE category string used by this rxvt-unicode.
1093
1094=item $env = $term->env
1095
1096Returns a copy of the environment in effect for the terminal as a hashref
1097similar to C<\%ENV>.
1098
1099=cut
1100
1101sub env {
1102 if (my $env = $_[0]->_env) {
1103 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1104 } else {
1105 +{ %ENV }
1106 }
1107}
790 1108
791=item $modifiermask = $term->ModLevel3Mask 1109=item $modifiermask = $term->ModLevel3Mask
792 1110
793=item $modifiermask = $term->ModMetaMask 1111=item $modifiermask = $term->ModMetaMask
794 1112
897 1215
898=back 1216=back
899 1217
900=cut 1218=cut
901 1219
902sub urxvt::term::line { 1220sub line {
903 my ($self, $row) = @_; 1221 my ($self, $row) = @_;
904 1222
905 my $maxrow = $self->nrow - 1; 1223 my $maxrow = $self->nrow - 1;
906 1224
907 my ($beg, $end) = ($row, $row); 1225 my ($beg, $end) = ($row, $row);
971 $offset / $self->{ncol} + $self->{beg}, 1289 $offset / $self->{ncol} + $self->{beg},
972 $offset % $self->{ncol} 1290 $offset % $self->{ncol}
973 ) 1291 )
974} 1292}
975 1293
976=item ($row, $col) = $line->coord_of ($offset)
977=item $text = $term->special_encode $string 1294=item $text = $term->special_encode $string
978 1295
979Converts a perl string into the special encoding used by rxvt-unicode, 1296Converts a perl string into the special encoding used by rxvt-unicode,
980where one character corresponds to one screen cell. See 1297where one character corresponds to one screen cell. See
981C<< $term->ROW_t >> for details. 1298C<< $term->ROW_t >> for details.
983=item $string = $term->special_decode $text 1300=item $string = $term->special_decode $text
984 1301
985Converts rxvt-unicodes text reprsentation into a perl string. See 1302Converts rxvt-unicodes text reprsentation into a perl string. See
986C<< $term->ROW_t >> for details. 1303C<< $term->ROW_t >> for details.
987 1304
1305=item $success = $term->grab_button ($button, $modifiermask)
1306
1307Registers a synchronous button grab. See the XGrabButton manpage.
1308
1309=item $success = $term->grab ($eventtime[, $sync])
1310
1311Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1312synchronous (C<$sync> is true). Also remembers the grab timestampe.
1313
1314=item $term->allow_events_async
1315
1316Calls XAllowEvents with AsyncBoth for the most recent grab.
1317
1318=item $term->allow_events_sync
1319
1320Calls XAllowEvents with SyncBoth for the most recent grab.
1321
1322=item $term->allow_events_replay
1323
1324Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1325recent grab.
1326
1327=item $term->ungrab
1328
1329Calls XUngrab for the most recent grab. Is called automatically on
1330evaluation errors, as it is better to lose the grab in the error case as
1331the session.
1332
988=back 1333=back
989 1334
1335=cut
1336
1337package urxvt::popup;
1338
990=head2 The C<urxvt::popup> Class 1339=head2 The C<urxvt::popup> Class
991 1340
992=over 4 1341=over 4
993 1342
994=cut 1343=cut
995
996package urxvt::popup;
997 1344
998sub add_item { 1345sub add_item {
999 my ($self, $item) = @_; 1346 my ($self, $item) = @_;
1000 1347
1348 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1349 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1350 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1351
1352 $item->{render} ||= sub { $_[0]{text} };
1353
1001 push @{ $self->{item} }, $item; 1354 push @{ $self->{item} }, $item;
1002} 1355}
1356
1357=item $popup->add_title ($title)
1358
1359Adds a non-clickable title to the popup.
1360
1361=cut
1362
1363sub add_title {
1364 my ($self, $title) = @_;
1365
1366 $self->add_item ({
1367 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1368 text => $title,
1369 activate => sub { },
1370 });
1371}
1372
1373=item $popup->add_separator ([$sepchr])
1374
1375Creates a separator, optionally using the character given as C<$sepchr>.
1376
1377=cut
1378
1379sub add_separator {
1380 my ($self, $sep) = @_;
1381
1382 $sep ||= "=";
1383
1384 $self->add_item ({
1385 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1386 text => "",
1387 render => sub { $sep x $self->{term}->ncol },
1388 activate => sub { },
1389 });
1390}
1391
1392=item $popup->add_button ($text, $cb)
1393
1394Adds a clickable button to the popup. C<$cb> is called whenever it is
1395selected.
1396
1397=cut
1003 1398
1004sub add_button { 1399sub add_button {
1005 my ($self, $text, $cb) = @_; 1400 my ($self, $text, $cb) = @_;
1006 1401
1007 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, 1402 $self->add_item ({ type => "button", text => $text, activate => $cb});
1008 render => sub { $_[0]{text} },
1009 });
1010} 1403}
1404
1405=item $popup->add_toggle ($text, $cb, $initial_value)
1406
1407Adds a toggle/checkbox item to the popup. Teh callback gets called
1408whenever it gets toggled, with a boolean indicating its value as its first
1409argument.
1410
1411=cut
1011 1412
1012sub add_toggle { 1413sub add_toggle {
1013 my ($self, $text, $cb, $value) = @_; 1414 my ($self, $text, $cb, $value) = @_;
1014 1415
1015 $self->add_item ({ type => "button", text => " $text", value => $value, 1416 my $item; $item = {
1417 type => "button",
1418 text => " $text",
1419 value => $value,
1016 render => sub { ($_[0]{value} ? "" : " ") . substr $_[0]{text}, 1 }, 1420 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1017 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1421 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1018 }); 1422 };
1423
1424 $self->add_item ($item);
1019} 1425}
1426
1427=item $popup->show
1428
1429Displays the popup (which is initially hidden).
1430
1431=cut
1020 1432
1021sub show { 1433sub show {
1022 my ($self) = @_; 1434 my ($self) = @_;
1023 1435
1024 local $urxvt::popup::self = $self; 1436 local $urxvt::popup::self = $self;
1025 1437
1438 my $env = $self->{term}->env;
1439 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1440 delete $env->{LC_ALL};
1441 $env->{LC_CTYPE} = $self->{term}->locale;
1442
1443 urxvt::term->new ($env, $self->{term}->resource ("name"),
1026 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1444 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1027 "--transient-for" => $self->{term}->parent, 1445 "--transient-for" => $self->{term}->parent,
1446 "-display" => $self->{term}->display_id,
1028 "-pe" => "urxvt-popup") 1447 "-pe" => "urxvt-popup")
1029 or die "unable to create popup window\n"; 1448 or die "unable to create popup window\n";
1030} 1449}
1031 1450
1032sub DESTROY { 1451sub DESTROY {
1033 my ($self) = @_; 1452 my ($self) = @_;
1034 1453
1454 delete $self->{term}{_destroy}{$self};
1035 $self->{term}->ungrab; 1455 $self->{term}->ungrab;
1036} 1456}
1457
1458=back
1037 1459
1038=head2 The C<urxvt::timer> Class 1460=head2 The C<urxvt::timer> Class
1039 1461
1040This class implements timer watchers/events. Time is represented as a 1462This class implements timer watchers/events. Time is represented as a
1041fractional number of seconds since the epoch. Example: 1463fractional number of seconds since the epoch. Example:
1094 1516
1095 $term->{socket} = ... 1517 $term->{socket} = ...
1096 $term->{iow} = urxvt::iow 1518 $term->{iow} = urxvt::iow
1097 ->new 1519 ->new
1098 ->fd (fileno $term->{socket}) 1520 ->fd (fileno $term->{socket})
1099 ->events (1) # wait for read data 1521 ->events (urxvt::EVENT_READ)
1100 ->start 1522 ->start
1101 ->cb (sub { 1523 ->cb (sub {
1102 my ($iow, $revents) = @_; 1524 my ($iow, $revents) = @_;
1103 # $revents must be 1 here, no need to check 1525 # $revents must be 1 here, no need to check
1104 sysread $term->{socket}, my $buf, 8192 1526 sysread $term->{socket}, my $buf, 8192
1121 1543
1122Set the filedescriptor (not handle) to watch. 1544Set the filedescriptor (not handle) to watch.
1123 1545
1124=item $iow = $iow->events ($eventmask) 1546=item $iow = $iow->events ($eventmask)
1125 1547
1126Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1548Set the event mask to watch. The only allowed values are
1127data, Bit #1 (value C<2>) enables watching for write data. 1549C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1550together, or C<urxvt::EVENT_NONE>.
1128 1551
1129=item $iow = $iow->start 1552=item $iow = $iow->start
1130 1553
1131Start watching for requested events on the given handle. 1554Start watching for requested events on the given handle.
1132 1555
1143This variable controls the verbosity level of the perl extension. Higher 1566This variable controls the verbosity level of the perl extension. Higher
1144numbers indicate more verbose output. 1567numbers indicate more verbose output.
1145 1568
1146=over 4 1569=over 4
1147 1570
1148=item =0 - only fatal messages 1571=item == 0 - fatal messages
1149 1572
1150=item =3 - script loading and management 1573=item >= 3 - script loading and management
1151 1574
1152=item =10 - all events received 1575=item >=10 - all events received
1153 1576
1154=back 1577=back
1155 1578
1156=head1 AUTHOR 1579=head1 AUTHOR
1157 1580

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines