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.45 by root, Sat Jan 7 20:23:52 2006 UTC vs.
Revision 1.85 by root, Thu Jan 12 03:32: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 middle-clicked, the program specified in the
91resource C<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
175=item on_sel_extend $term 230=item on_sel_extend $term
176 231
177Called whenever the user tries to extend the selection (e.g. with a double 232Called whenever the user tries to extend the selection (e.g. with a double
178click) and is either supposed to return false (normal operation), or 233click) and is either supposed to return false (normal operation), or
179should extend the selection itelf and return true to suppress the built-in 234should extend the selection itelf and return true to suppress the built-in
180processing. 235processing. This can happen multiple times, as long as the callback
236returns true, it will be called on every further click by the user and is
237supposed to enlarge the selection more and more, if possible.
181 238
182See the F<selection> example extension. 239See the F<selection> example extension.
183 240
184=item on_view_change $term, $offset 241=item on_view_change $term, $offset
185 242
194than the scroll back buffer or the terminal. 251than the scroll back buffer or the terminal.
195 252
196It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 253It 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 254$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198number of lines that will be in the scrollback buffer. 255number 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 256
204=item on_osc_seq $term, $string 257=item on_osc_seq $term, $string
205 258
206Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 259Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207operating system command) is processed. Cursor position and other state 260operating system command) is processed. Cursor position and other state
220can filter/change and output the text yourself by returning a true value 273can filter/change and output the text yourself by returning a true value
221and calling C<< $term->scr_add_lines >> yourself. Please note that this 274and 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 275might be very slow, however, as your hook is called for B<all> text being
223output. 276output.
224 277
278=item on_tt_write $term, $octets
279
280Called whenever some data is written to the tty/pty and can be used to
281suppress or filter tty input.
282
225=item on_line_update $term, $row 283=item on_line_update $term, $row
226 284
227Called whenever a line was updated or changed. Can be used to filter 285Called whenever a line was updated or changed. Can be used to filter
228screen output (e.g. underline urls or other useless stuff). Only lines 286screen output (e.g. underline urls or other useless stuff). Only lines
229that are being shown will be filtered, and, due to performance reasons, 287that are being shown will be filtered, and, due to performance reasons,
261=item on_focus_out $term 319=item on_focus_out $term
262 320
263Called wheneever the window loses keyboard focus, before rxvt-unicode does 321Called wheneever the window loses keyboard focus, before rxvt-unicode does
264focus out processing. 322focus out processing.
265 323
266=item on_key_press $term, $event, $octets 324=item on_key_press $term, $event, $keysym, $octets
267 325
268=item on_key_release $term, $event 326=item on_key_release $term, $event, $keysym
269 327
270=item on_button_press $term, $event 328=item on_button_press $term, $event
271 329
272=item on_button_release $term, $event 330=item on_button_release $term, $event
273 331
289 347
290subwindow. 348subwindow.
291 349
292=back 350=back
293 351
352=cut
353
354package urxvt;
355
356use utf8;
357use strict;
358use Carp ();
359use Scalar::Util ();
360use List::Util ();
361
362our $VERSION = 1;
363our $TERM;
364our @HOOKNAME;
365our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
366our %OPTION;
367
368our $LIBDIR;
369our $RESNAME;
370our $RESCLASS;
371our $RXVTNAME;
372
294=head2 Variables in the C<urxvt> Package 373=head2 Variables in the C<urxvt> Package
295 374
296=over 4 375=over 4
376
377=item $urxvt::LIBDIR
378
379The rxvt-unicode library directory, where, among other things, the perl
380modules and scripts are stored.
381
382=item $urxvt::RESCLASS, $urxvt::RESCLASS
383
384The resource class and name rxvt-unicode uses to look up X resources.
385
386=item $urxvt::RXVTNAME
387
388The basename of the installed binaries, usually C<urxvt>.
297 389
298=item $urxvt::TERM 390=item $urxvt::TERM
299 391
300The current terminal. This variable stores the current C<urxvt::term> 392The current terminal. This variable stores the current C<urxvt::term>
301object, whenever a callback/hook is executing. 393object, whenever a callback/hook is executing.
303=back 395=back
304 396
305=head2 Functions in the C<urxvt> Package 397=head2 Functions in the C<urxvt> Package
306 398
307=over 4 399=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 400
317=item urxvt::fatal $errormessage 401=item urxvt::fatal $errormessage
318 402
319Fatally aborts execution with the given error message. Avoid at all 403Fatally aborts execution with the given error message. Avoid at all
320costs! The only time this is acceptable is when the terminal process 404costs! The only time this is acceptable is when the terminal process
327that calls this function. 411that calls this function.
328 412
329Using this function has the advantage that its output ends up in the 413Using this function has the advantage that its output ends up in the
330correct place, e.g. on stderr of the connecting urxvtc client. 414correct place, e.g. on stderr of the connecting urxvtc client.
331 415
416Messages have a size limit of 1023 bytes currently.
417
418=item $is_safe = urxvt::safe
419
420Returns true when it is safe to do potentially unsafe things, such as
421evaluating perl code specified by the user. This is true when urxvt was
422started setuid or setgid.
423
332=item $time = urxvt::NOW 424=item $time = urxvt::NOW
333 425
334Returns the "current time" (as per the event loop). 426Returns the "current time" (as per the event loop).
427
428=item urxvt::CurrentTime
429
430=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432Button4Mask, Button5Mask, AnyModifier
433
434Various constants for use in X calls and event processing.
335 435
336=back 436=back
337 437
338=head2 RENDITION 438=head2 RENDITION
339 439
366 466
367=item $background = urxvt::GET_BASEBG $rend 467=item $background = urxvt::GET_BASEBG $rend
368 468
369Return the foreground/background colour index, respectively. 469Return the foreground/background colour index, respectively.
370 470
371=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 471=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
372 472
373=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 473=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
374 474
375Replace the foreground/background colour in the rendition mask with the 475Replace the foreground/background colour in the rendition mask with the
376specified one. 476specified one.
377 477
378=item $value = urxvt::GET_CUSTOM ($rend) 478=item $value = urxvt::GET_CUSTOM $rend
379 479
380Return the "custom" value: Every rendition has 5 bits for use by 480Return the "custom" value: Every rendition has 5 bits for use by
381extensions. They can be set and changed as you like and are initially 481extensions. They can be set and changed as you like and are initially
382zero. 482zero.
383 483
384=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 484=item $rend = urxvt::SET_CUSTOM $rend, $new_value
385 485
386Change the custom value. 486Change the custom value.
387 487
388=back 488=back
389 489
390=cut 490=cut
391
392package urxvt;
393
394use strict;
395use Scalar::Util ();
396
397our $TERM;
398our @HOOKNAME;
399our $LIBDIR;
400 491
401BEGIN { 492BEGIN {
402 urxvt->bootstrap; 493 urxvt->bootstrap;
403 494
404 # overwrite perl's warn 495 # overwrite perl's warn
406 my $msg = join "", @_; 497 my $msg = join "", @_;
407 $msg .= "\n" 498 $msg .= "\n"
408 unless $msg =~ /\n$/; 499 unless $msg =~ /\n$/;
409 urxvt::warn ($msg); 500 urxvt::warn ($msg);
410 }; 501 };
502
503 # %ENV is the original startup environment
504 delete $ENV{IFS};
505 delete $ENV{CDPATH};
506 delete $ENV{BASH_ENV};
507 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
411} 508}
412 509
413my @hook_count; 510my @hook_count;
414my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 511my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
415 512
416sub verbose { 513sub verbose {
417 my ($level, $msg) = @_; 514 my ($level, $msg) = @_;
418 warn "$msg\n" if $level <= $verbosity; 515 warn "$msg\n" if $level <= $verbosity;
419} 516}
420 517
421# find on_xxx subs in the package and register them
422# as hooks
423sub register_package($) {
424 my ($pkg) = @_;
425
426 for my $htype (0.. $#HOOKNAME) {
427 my $name = $HOOKNAME[$htype];
428
429 my $ref = $pkg->can ("on_" . lc $name)
430 or next;
431
432 $TERM->{_hook}[$htype]{$pkg} = $ref;
433 $hook_count[$htype]++
434 or set_should_invoke $htype, 1;
435 }
436}
437
438my $extension_pkg = "extension0000"; 518my $extension_pkg = "extension0000";
439my %extension_pkg; 519my %extension_pkg;
440 520
441# load a single script into its own package, once only 521# load a single script into its own package, once only
442sub extension_package($) { 522sub extension_package($) {
448 verbose 3, "loading extension '$path' into package '$pkg'"; 528 verbose 3, "loading extension '$path' into package '$pkg'";
449 529
450 open my $fh, "<:raw", $path 530 open my $fh, "<:raw", $path
451 or die "$path: $!"; 531 or die "$path: $!";
452 532
533 my $source = untaint
453 my $source = "package $pkg; use strict; use utf8;\n" 534 "package $pkg; use strict; use utf8;\n"
454 . "use base urxvt::term::proxy::;\n" 535 . "use base urxvt::term::extension::;\n"
455 . "#line 1 \"$path\"\n{\n" 536 . "#line 1 \"$path\"\n{\n"
456 . (do { local $/; <$fh> }) 537 . (do { local $/; <$fh> })
457 . "\n};\n1"; 538 . "\n};\n1";
458 539
540 eval $source
459 eval $source or die "$path: $@"; 541 or die "$path: $@";
460 542
461 $pkg 543 $pkg
462 } 544 }
463} 545}
464 546
469 local $TERM = shift; 551 local $TERM = shift;
470 my $htype = shift; 552 my $htype = shift;
471 553
472 if ($htype == 0) { # INIT 554 if ($htype == 0) { # INIT
473 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 555 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
556
557 my %ext_arg;
474 558
475 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 559 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
560 if ($_ eq "default") {
561 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
562 } elsif (/^-(.*)$/) {
563 delete $ext_arg{$1};
564 } elsif (/^([^<]+)<(.*)>$/) {
565 push @{ $ext_arg{$1} }, $2;
566 } else {
567 $ext_arg{$_} ||= [];
568 }
569 }
570
571 while (my ($ext, $argv) = each %ext_arg) {
476 my @files = grep -f $_, map "$_/$ext", @dirs; 572 my @files = grep -f $_, map "$_/$ext", @dirs;
477 573
478 if (@files) { 574 if (@files) {
479 register_package extension_package $files[0]; 575 $TERM->register_package (extension_package $files[0], $argv);
480 } else { 576 } else {
481 warn "perl extension '$ext' not found in perl library search path\n"; 577 warn "perl extension '$ext' not found in perl library search path\n";
482 } 578 }
483 } 579 }
580
581 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
582 warn $@ if $@;
484 } 583 }
485 584
486 $retval = undef; 585 $retval = undef;
487 586
488 if (my $cb = $TERM->{_hook}[$htype]) { 587 if (my $cb = $TERM->{_hook}[$htype]) {
490 if $verbosity >= 10; 589 if $verbosity >= 10;
491 590
492 keys %$cb; 591 keys %$cb;
493 592
494 while (my ($pkg, $cb) = each %$cb) { 593 while (my ($pkg, $cb) = each %$cb) {
495 eval { 594 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
496 $retval = $cb->(
497 $TERM->{_pkg}{$pkg} ||= do {
498 my $proxy = bless { }, $pkg;
499 Scalar::Util::weaken ($proxy->{term} = $TERM);
500 $proxy
501 },
502 @_,
503 ) and last; 595 and last;
596
597 if ($@) {
598 $TERM->ungrab; # better to lose the grab than the session
599 warn $@;
504 }; 600 }
505 warn $@ if $@;#d#
506 } 601 }
602
603 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604 if $verbosity >= 11;
507 } 605 }
508 606
509 if ($htype == 1) { # DESTROY 607 if ($htype == 1) { # DESTROY
510 # remove hooks if unused
511 if (my $hook = $TERM->{_hook}) { 608 if (my $hook = delete $TERM->{_hook}) {
512 for my $htype (0..$#$hook) { 609 for my $htype (0..$#$hook) {
513 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 610 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
514 or set_should_invoke $htype, 0; 611 or set_should_invoke $htype, 0;
515 } 612 }
516 } 613 }
523 } 620 }
524 621
525 $retval 622 $retval
526} 623}
527 624
528sub urxvt::term::proxy::AUTOLOAD { 625sub exec_async(@) {
529 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 626 my $pid = fork;
627
628 return
629 if !defined $pid or $pid;
630
631 %ENV = %{ $TERM->env };
632
633 exec @_;
634 _exit 255;
635}
636
637# urxvt::term::extension
638
639package urxvt::term::extension;
640
641sub enable {
642 my ($self, %hook) = @_;
643 my $pkg = $self->{_pkg};
644
645 while (my ($name, $cb) = each %hook) {
646 my $htype = $HOOKTYPE{uc $name};
647 defined $htype
648 or Carp::croak "unsupported hook type '$name'";
649
650 unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
651 $hook_count[$htype]++
652 or urxvt::set_should_invoke $htype, 1;
653 }
654
655 $self->{term}{_hook}[$htype]{$pkg} = $cb;
656 }
657}
658
659sub disable {
660 my ($self, @hook) = @_;
661 my $pkg = $self->{_pkg};
662
663 for my $name (@hook) {
664 my $htype = $HOOKTYPE{uc $name};
665 defined $htype
666 or Carp::croak "unsupported hook type '$name'";
667
668 if (delete $self->{term}{_hook}[$htype]{$pkg}) {
669 --$hook_count[$htype]
670 or urxvt::set_should_invoke $htype, 0;
671 }
672 }
673}
674
675our $AUTOLOAD;
676
677sub AUTOLOAD {
678 $AUTOLOAD =~ /:([^:]+)$/
530 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 679 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
531 680
532 eval qq{ 681 eval qq{
533 sub $urxvt::term::proxy::AUTOLOAD { 682 sub $AUTOLOAD {
534 my \$proxy = shift; 683 my \$proxy = shift;
535 \$proxy->{term}->$1 (\@_) 684 \$proxy->{term}->$1 (\@_)
536 } 685 }
537 1 686 1
538 } or die "FATAL: unable to compile method forwarder: $@"; 687 } or die "FATAL: unable to compile method forwarder: $@";
539 688
540 goto &$urxvt::term::proxy::AUTOLOAD; 689 goto &$AUTOLOAD;
541} 690}
691
692sub DESTROY {
693 # nop
694}
695
696# urxvt::destroy_hook
542 697
543sub urxvt::destroy_hook::DESTROY { 698sub urxvt::destroy_hook::DESTROY {
544 ${$_[0]}->(); 699 ${$_[0]}->();
545} 700}
546 701
547sub urxvt::destroy_hook(&) { 702sub urxvt::destroy_hook(&) {
548 bless \shift, urxvt::destroy_hook:: 703 bless \shift, urxvt::destroy_hook::
549} 704}
550 705
706package urxvt::anyevent;
707
708=head2 The C<urxvt::anyevent> Class
709
710The sole purpose of this class is to deliver an interface to the
711C<AnyEvent> module - any module using it will work inside urxvt without
712further programming. The only exception is that you cannot wait on
713condition variables, but non-blocking condvar use is ok. What this means
714is that you cannot use blocking APIs, but the non-blocking variant should
715work.
716
717=cut
718
719our $VERSION = 1;
720
721$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
722push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
723
724sub timer {
725 my ($class, %arg) = @_;
726
727 my $cb = $arg{cb};
728
729 urxvt::timer
730 ->new
731 ->start (urxvt::NOW + $arg{after})
732 ->cb (sub {
733 $_[0]->stop; # need to cancel manually
734 $cb->();
735 })
736}
737
738sub io {
739 my ($class, %arg) = @_;
740
741 my $cb = $arg{cb};
742
743 bless [$arg{fh}, urxvt::iow
744 ->new
745 ->fd (fileno $arg{fh})
746 ->events (($arg{poll} =~ /r/ ? 1 : 0)
747 | ($arg{poll} =~ /w/ ? 2 : 0))
748 ->start
749 ->cb (sub {
750 $cb->(($_[1] & 1 ? 'r' : '')
751 . ($_[1] & 2 ? 'w' : ''));
752 })],
753 urxvt::anyevent::
754}
755
756sub DESTROY {
757 $_[0][1]->stop;
758}
759
760sub condvar {
761 bless \my $flag, urxvt::anyevent::condvar::
762}
763
764sub urxvt::anyevent::condvar::broadcast {
765 ${$_[0]}++;
766}
767
768sub urxvt::anyevent::condvar::wait {
769 unless (${$_[0]}) {
770 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
771 }
772}
773
774package urxvt::term;
775
551=head2 The C<urxvt::term> Class 776=head2 The C<urxvt::term> Class
552 777
553=over 4 778=over 4
554 779
780=cut
781
782# find on_xxx subs in the package and register them
783# as hooks
784sub register_package {
785 my ($self, $pkg, $argv) = @_;
786
787 my $proxy = bless {
788 _pkg => $pkg,
789 argv => $argv,
790 }, $pkg;
791 Scalar::Util::weaken ($proxy->{term} = $self);
792
793 $self->{_pkg}{$pkg} = $proxy;
794
795 for my $name (@HOOKNAME) {
796 if (my $ref = $pkg->can ("on_" . lc $name)) {
797 $proxy->enable ($name => $ref);
798 }
799 }
800}
801
802=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
803
804Creates a new terminal, very similar as if you had started it with system
805C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
806hash which defines the environment of the new terminal.
807
808Croaks (and probably outputs an error message) if the new instance
809couldn't be created. Returns C<undef> if the new instance didn't
810initialise perl, and the terminal object otherwise. The C<init> and
811C<start> hooks will be called during this call.
812
813=cut
814
815sub new {
816 my ($class, $env, @args) = @_;
817
818 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
819}
820
555=item $term->destroy 821=item $term->destroy
556 822
557Destroy the terminal object (close the window, free resources etc.). 823Destroy the terminal object (close the window, free resources
824etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
825watchers (timers, io watchers) are still active.
826
827=item $isset = $term->option ($optval[, $set])
828
829Returns true if the option specified by C<$optval> is enabled, and
830optionally change it. All option values are stored by name in the hash
831C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
832
833Here is a a likely non-exhaustive list of option names, please see the
834source file F</src/optinc.h> to see the actual list:
835
836 borderLess console cursorBlink cursorUnderline hold iconic insecure
837 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
838 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
839 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
840 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
841 tripleclickwords utmpInhibit visualBell
558 842
559=item $value = $term->resource ($name[, $newval]) 843=item $value = $term->resource ($name[, $newval])
560 844
561Returns the current resource value associated with a given name and 845Returns the current resource value associated with a given name and
562optionally sets a new value. Setting values is most useful in the C<init> 846optionally sets a new value. Setting values is most useful in the C<init>
572 856
573Please note that resource strings will currently only be freed when the 857Please note that resource strings will currently only be freed when the
574terminal is destroyed, so changing options frequently will eat memory. 858terminal is destroyed, so changing options frequently will eat memory.
575 859
576Here is a a likely non-exhaustive list of resource names, not all of which 860Here is a a likely non-exhaustive list of resource names, not all of which
577are supported in every build, please see the source to see the actual 861are supported in every build, please see the source file F</src/rsinc.h>
578list: 862to see the actual list:
579 863
580 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 864 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
581 borderLess color cursorBlink cursorUnderline cutchars delete_key 865 borderLess color cursorBlink cursorUnderline cutchars delete_key
582 display_name embed ext_bwidth fade font geometry hold iconName 866 display_name embed ext_bwidth fade font geometry hold iconName
583 imFont imLocale inputMethod insecure int_bwidth intensityStyles 867 imFont imLocale inputMethod insecure int_bwidth intensityStyles
590 shade term_name title transparent transparent_all tripleclickwords 874 shade term_name title transparent transparent_all tripleclickwords
591 utmpInhibit visualBell 875 utmpInhibit visualBell
592 876
593=cut 877=cut
594 878
595sub urxvt::term::resource($$;$) { 879sub resource($$;$) {
596 my ($self, $name) = (shift, shift); 880 my ($self, $name) = (shift, shift);
597 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 881 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
598 &urxvt::term::_resource 882 &urxvt::term::_resource
599} 883}
600 884
885=item $value = $term->x_resource ($pattern)
886
887Returns the X-Resource for the given pattern, excluding the program or
888class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
889same value as used by this instance of rxvt-unicode. Returns C<undef> if no
890resource with that pattern exists.
891
892This method should only be called during the C<on_start> hook, as there is
893only one resource database per display, and later invocations might return
894the wrong resources.
895
896=item $success = $term->parse_keysym ($keysym_spec, $command_string)
897
898Adds a keymap translation exactly as specified via a resource. See the
899C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
900
601=item $rend = $term->rstyle ([$new_rstyle]) 901=item $rend = $term->rstyle ([$new_rstyle])
602 902
603Return and optionally change the current rendition. Text that is output by 903Return and optionally change the current rendition. Text that is output by
604the terminal application will use this style. 904the terminal application will use this style.
605 905
624 924
625=item $oldtext = $term->selection ([$newtext]) 925=item $oldtext = $term->selection ([$newtext])
626 926
627Return the current selection text and optionally replace it by C<$newtext>. 927Return the current selection text and optionally replace it by C<$newtext>.
628 928
629#=item $term->overlay ($x, $y, $text) 929=item $term->overlay_simple ($x, $y, $text)
630# 930
631#Create a simple multi-line overlay box. See the next method for details. 931Create a simple multi-line overlay box. See the next method for details.
632# 932
633#=cut 933=cut
634# 934
635#sub urxvt::term::scr_overlay { 935sub overlay_simple {
636# my ($self, $x, $y, $text) = @_; 936 my ($self, $x, $y, $text) = @_;
637# 937
638# my @lines = split /\n/, $text; 938 my @lines = split /\n/, $text;
639# 939
640# my $w = 0; 940 my $w = List::Util::max map $self->strwidth ($_), @lines;
641# for (map $self->strwidth ($_), @lines) { 941
642# $w = $_ if $w < $_;
643# }
644#
645# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 942 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
646# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 943 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
647#} 944
945 $overlay
946}
648 947
649=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 948=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
650 949
651Create a new (empty) overlay at the given position with the given 950Create a new (empty) overlay at the given position with the given
652width/height. C<$rstyle> defines the initial rendition style 951width/height. C<$rstyle> defines the initial rendition style
687C<$event> I<must> be the event causing the menu to pop up (a button event, 986C<$event> I<must> be the event causing the menu to pop up (a button event,
688currently). 987currently).
689 988
690=cut 989=cut
691 990
692sub urxvt::term::popup { 991sub popup {
693 my ($self, $event) = @_; 992 my ($self, $event) = @_;
694 993
695 $self->grab ($event->{time}, 1) 994 $self->grab ($event->{time}, 1)
696 or return; 995 or return;
697 996
719 1018
720=item $string = $term->locale_decode ($octets) 1019=item $string = $term->locale_decode ($octets)
721 1020
722Convert the given locale-encoded octets into a perl string. 1021Convert the given locale-encoded octets into a perl string.
723 1022
1023=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1024
1025XORs the rendition values in the given span with the provided value
1026(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
1027to the selection.
1028
1029=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1030
1031Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1032whitespace will additionally be xored with the C<$rstyle2>, which defaults
1033to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1034it instead.
1035
1036=item $term->scr_bell
1037
1038Ring the bell!
1039
724=item $term->scr_add_lines ($string) 1040=item $term->scr_add_lines ($string)
725 1041
726Write the given text string to the screen, as if output by the application 1042Write the given text string to the screen, as if output by the application
727running inside the terminal. It may not contain command sequences (escape 1043running inside the terminal. It may not contain command sequences (escape
728codes), but is free to use line feeds, carriage returns and tabs. The 1044codes), but is free to use line feeds, carriage returns and tabs. The
742 1058
743Write the octets given in C<$data> to the tty (i.e. as program input). To 1059Write the octets given in C<$data> to the tty (i.e. as program input). To
744pass characters instead of octets, you should convert your strings first 1060pass characters instead of octets, you should convert your strings first
745to the locale-specific encoding using C<< $term->locale_encode >>. 1061to the locale-specific encoding using C<< $term->locale_encode >>.
746 1062
1063=item $old_events = $term->pty_ev_events ([$new_events])
1064
1065Replaces the event mask of the pty watcher by the given event mask. Can
1066be used to suppress input and output handling to the pty/tty. See the
1067description of C<< urxvt::timer->events >>. Make sure to always restore
1068the previous value.
1069
747=item $windowid = $term->parent 1070=item $windowid = $term->parent
748 1071
749Return the window id of the toplevel window. 1072Return the window id of the toplevel window.
750 1073
751=item $windowid = $term->vt 1074=item $windowid = $term->vt
775=item $nrow_plus_saveLines = $term->total_rows 1098=item $nrow_plus_saveLines = $term->total_rows
776 1099
777=item $lines_in_scrollback = $term->nsaved 1100=item $lines_in_scrollback = $term->nsaved
778 1101
779Return various integers describing terminal characteristics. 1102Return various integers describing terminal characteristics.
1103
1104=item $x_display = $term->display_id
1105
1106Return the DISPLAY used by rxvt-unicode.
1107
1108=item $lc_ctype = $term->locale
1109
1110Returns the LC_CTYPE category string used by this rxvt-unicode.
1111
1112=item $env = $term->env
1113
1114Returns a copy of the environment in effect for the terminal as a hashref
1115similar to C<\%ENV>.
1116
1117=cut
1118
1119sub env {
1120 if (my $env = $_[0]->_env) {
1121 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1122 } else {
1123 +{ %ENV }
1124 }
1125}
1126
1127=item $modifiermask = $term->ModLevel3Mask
1128
1129=item $modifiermask = $term->ModMetaMask
1130
1131=item $modifiermask = $term->ModNumLockMask
1132
1133Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1134AltGr), the meta key (often Alt) and the num lock key, if applicable.
780 1135
781=item $view_start = $term->view_start ([$newvalue]) 1136=item $view_start = $term->view_start ([$newvalue])
782 1137
783Returns the negative row number of the topmost line. Minimum value is 1138Returns the negative row number of the topmost line. Minimum value is
784C<0>, which displays the normal terminal contents. Larger values scroll 1139C<0>, which displays the normal terminal contents. Larger values scroll
868Return the row number of the first/last row of the line, respectively. 1223Return the row number of the first/last row of the line, respectively.
869 1224
870=item $offset = $line->offset_of ($row, $col) 1225=item $offset = $line->offset_of ($row, $col)
871 1226
872Returns the character offset of the given row|col pair within the logical 1227Returns the character offset of the given row|col pair within the logical
873line. 1228line. Works for rows outside the line, too, and returns corresponding
1229offsets outside the string.
874 1230
875=item ($row, $col) = $line->coord_of ($offset) 1231=item ($row, $col) = $line->coord_of ($offset)
876 1232
877Translates a string offset into terminal coordinates again. 1233Translates a string offset into terminal coordinates again.
878 1234
879=back 1235=back
880 1236
881=cut 1237=cut
882 1238
883sub urxvt::term::line { 1239sub line {
884 my ($self, $row) = @_; 1240 my ($self, $row) = @_;
885 1241
886 my $maxrow = $self->nrow - 1; 1242 my $maxrow = $self->nrow - 1;
887 1243
888 my ($beg, $end) = ($row, $row); 1244 my ($beg, $end) = ($row, $row);
952 $offset / $self->{ncol} + $self->{beg}, 1308 $offset / $self->{ncol} + $self->{beg},
953 $offset % $self->{ncol} 1309 $offset % $self->{ncol}
954 ) 1310 )
955} 1311}
956 1312
957=item ($row, $col) = $line->coord_of ($offset)
958=item $text = $term->special_encode $string 1313=item $text = $term->special_encode $string
959 1314
960Converts a perl string into the special encoding used by rxvt-unicode, 1315Converts a perl string into the special encoding used by rxvt-unicode,
961where one character corresponds to one screen cell. See 1316where one character corresponds to one screen cell. See
962C<< $term->ROW_t >> for details. 1317C<< $term->ROW_t >> for details.
964=item $string = $term->special_decode $text 1319=item $string = $term->special_decode $text
965 1320
966Converts rxvt-unicodes text reprsentation into a perl string. See 1321Converts rxvt-unicodes text reprsentation into a perl string. See
967C<< $term->ROW_t >> for details. 1322C<< $term->ROW_t >> for details.
968 1323
1324=item $success = $term->grab_button ($button, $modifiermask)
1325
1326Registers a synchronous button grab. See the XGrabButton manpage.
1327
1328=item $success = $term->grab ($eventtime[, $sync])
1329
1330Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1331synchronous (C<$sync> is true). Also remembers the grab timestampe.
1332
1333=item $term->allow_events_async
1334
1335Calls XAllowEvents with AsyncBoth for the most recent grab.
1336
1337=item $term->allow_events_sync
1338
1339Calls XAllowEvents with SyncBoth for the most recent grab.
1340
1341=item $term->allow_events_replay
1342
1343Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1344recent grab.
1345
1346=item $term->ungrab
1347
1348Calls XUngrab for the most recent grab. Is called automatically on
1349evaluation errors, as it is better to lose the grab in the error case as
1350the session.
1351
969=back 1352=back
970 1353
1354=cut
1355
1356package urxvt::popup;
1357
971=head2 The C<urxvt::popup> Class 1358=head2 The C<urxvt::popup> Class
972 1359
973=over 4 1360=over 4
974 1361
975=cut 1362=cut
976
977package urxvt::popup;
978 1363
979sub add_item { 1364sub add_item {
980 my ($self, $item) = @_; 1365 my ($self, $item) = @_;
981 1366
1367 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1368 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1369 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1370
1371 $item->{render} ||= sub { $_[0]{text} };
1372
982 push @{ $self->{item} }, $item; 1373 push @{ $self->{item} }, $item;
983} 1374}
1375
1376=item $popup->add_title ($title)
1377
1378Adds a non-clickable title to the popup.
1379
1380=cut
1381
1382sub add_title {
1383 my ($self, $title) = @_;
1384
1385 $self->add_item ({
1386 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1387 text => $title,
1388 activate => sub { },
1389 });
1390}
1391
1392=item $popup->add_separator ([$sepchr])
1393
1394Creates a separator, optionally using the character given as C<$sepchr>.
1395
1396=cut
1397
1398sub add_separator {
1399 my ($self, $sep) = @_;
1400
1401 $sep ||= "=";
1402
1403 $self->add_item ({
1404 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1405 text => "",
1406 render => sub { $sep x $self->{term}->ncol },
1407 activate => sub { },
1408 });
1409}
1410
1411=item $popup->add_button ($text, $cb)
1412
1413Adds a clickable button to the popup. C<$cb> is called whenever it is
1414selected.
1415
1416=cut
984 1417
985sub add_button { 1418sub add_button {
986 my ($self, $text, $cb) = @_; 1419 my ($self, $text, $cb) = @_;
987 1420
988 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); 1421 $self->add_item ({ type => "button", text => $text, activate => $cb});
989} 1422}
1423
1424=item $popup->add_toggle ($text, $cb, $initial_value)
1425
1426Adds a toggle/checkbox item to the popup. Teh callback gets called
1427whenever it gets toggled, with a boolean indicating its value as its first
1428argument.
1429
1430=cut
1431
1432sub add_toggle {
1433 my ($self, $text, $cb, $value) = @_;
1434
1435 my $item; $item = {
1436 type => "button",
1437 text => " $text",
1438 value => $value,
1439 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1440 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1441 };
1442
1443 $self->add_item ($item);
1444}
1445
1446=item $popup->show
1447
1448Displays the popup (which is initially hidden).
1449
1450=cut
990 1451
991sub show { 1452sub show {
992 my ($self) = @_; 1453 my ($self) = @_;
993 1454
994 local $urxvt::popup::self = $self; 1455 local $urxvt::popup::self = $self;
995 1456
1457 my $env = $self->{term}->env;
1458 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1459 delete $env->{LC_ALL};
1460 $env->{LC_CTYPE} = $self->{term}->locale;
1461
1462 urxvt::term->new ($env, $self->{term}->resource ("name"),
996 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1463 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
997 "--transient-for" => $self->{term}->parent, 1464 "--transient-for" => $self->{term}->parent,
1465 "-display" => $self->{term}->display_id,
998 "-pe" => "urxvt_popup") 1466 "-pe" => "urxvt-popup")
999 or die "unable to create popup window\n"; 1467 or die "unable to create popup window\n";
1000} 1468}
1001 1469
1002sub DESTROY { 1470sub DESTROY {
1003 my ($self) = @_; 1471 my ($self) = @_;
1004 1472
1473 delete $self->{term}{_destroy}{$self};
1005 $self->{term}->ungrab; 1474 $self->{term}->ungrab;
1006} 1475}
1476
1477=back
1007 1478
1008=head2 The C<urxvt::timer> Class 1479=head2 The C<urxvt::timer> Class
1009 1480
1010This class implements timer watchers/events. Time is represented as a 1481This class implements timer watchers/events. Time is represented as a
1011fractional number of seconds since the epoch. Example: 1482fractional number of seconds since the epoch. Example:
1064 1535
1065 $term->{socket} = ... 1536 $term->{socket} = ...
1066 $term->{iow} = urxvt::iow 1537 $term->{iow} = urxvt::iow
1067 ->new 1538 ->new
1068 ->fd (fileno $term->{socket}) 1539 ->fd (fileno $term->{socket})
1069 ->events (1) # wait for read data 1540 ->events (urxvt::EVENT_READ)
1070 ->start 1541 ->start
1071 ->cb (sub { 1542 ->cb (sub {
1072 my ($iow, $revents) = @_; 1543 my ($iow, $revents) = @_;
1073 # $revents must be 1 here, no need to check 1544 # $revents must be 1 here, no need to check
1074 sysread $term->{socket}, my $buf, 8192 1545 sysread $term->{socket}, my $buf, 8192
1091 1562
1092Set the filedescriptor (not handle) to watch. 1563Set the filedescriptor (not handle) to watch.
1093 1564
1094=item $iow = $iow->events ($eventmask) 1565=item $iow = $iow->events ($eventmask)
1095 1566
1096Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1567Set the event mask to watch. The only allowed values are
1097data, Bit #1 (value C<2>) enables watching for write data. 1568C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1569together, or C<urxvt::EVENT_NONE>.
1098 1570
1099=item $iow = $iow->start 1571=item $iow = $iow->start
1100 1572
1101Start watching for requested events on the given handle. 1573Start watching for requested events on the given handle.
1102 1574
1113This variable controls the verbosity level of the perl extension. Higher 1585This variable controls the verbosity level of the perl extension. Higher
1114numbers indicate more verbose output. 1586numbers indicate more verbose output.
1115 1587
1116=over 4 1588=over 4
1117 1589
1118=item =0 - only fatal messages 1590=item == 0 - fatal messages
1119 1591
1120=item =3 - script loading and management 1592=item >= 3 - script loading and management
1121 1593
1122=item =10 - all events received 1594=item >=10 - all called hooks
1595
1596=item >=11 - hook reutrn values
1123 1597
1124=back 1598=back
1125 1599
1126=head1 AUTHOR 1600=head1 AUTHOR
1127 1601

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines