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.54 by root, Sun Jan 8 01:59:29 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 (enabled by default) 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
58 58
59=back 59=back
60 60
61=item option-popup (enabled by default) 61=item option-popup (enabled by default)
62 62
63Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at 63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime. 64runtime.
65 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
66=item digital-clock 83=item digital-clock
67 84
68Displays a digital clock using the built-in overlay. 85Displays a digital clock using the built-in overlay.
69 86
70=item mark-urls 87=item mark-urls
71 88
72Uses 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.
73 92
74=item block-graphics-to-ascii 93=item block-graphics-to-ascii
75 94
76A 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,
77by replacing all line-drawing characters (U+2500 .. U+259F) by a 96by replacing all line-drawing characters (U+2500 .. U+259F) by a
82Displays 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
83window. Illustrates overwriting the refresh callbacks to create your own 102window. Illustrates overwriting the refresh callbacks to create your own
84overlays or changes. 103overlays or changes.
85 104
86=back 105=back
106
107=head1 API DOCUMENTATION
87 108
88=head2 General API Considerations 109=head2 General API Considerations
89 110
90All objects (such as terminals, time watchers etc.) are typical 111All objects (such as terminals, time watchers etc.) are typical
91reference-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
104=over 4 125=over 4
105 126
106=item $text 127=item $text
107 128
108Rxvt-unicodes special way of encoding text, where one "unicode" character 129Rxvt-unicodes special way of encoding text, where one "unicode" character
109always 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.
110 131
111=item $string 132=item $string
112 133
113A 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
114characters and is to be distinguished with text encoded in a specific 135characters and is to be distinguished with text encoded in a specific
119Either binary data or - more common - a text string encoded in a 140Either binary data or - more common - a text string encoded in a
120locale-specific way. 141locale-specific way.
121 142
122=back 143=back
123 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
124=head2 Hooks 178=head2 Hooks
125 179
126The following subroutines can be declared in extension files, and will be 180The following subroutines can be declared in extension files, and will be
127called whenever the relevant event happens. 181called whenever the relevant event happens.
128 182
129The 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
130and extension package. You can call all C<urxvt::term> methods on it, but 184the in the C<Extension Objects> section.
131its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132object that is shared between all packages is stored in the C<term>
133member. It is, however, blessed intot he package of the extension script,
134so for all practical purposes you can treat an extension script as a class.
135 185
136All 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
137counts 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
138and 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.
139 189
140When in doubt, return a false value (preferably C<()>). 190I<< When in doubt, return a false value (preferably C<()>). >>
141 191
142=over 4 192=over 4
143 193
144=item on_init $term 194=item on_init $term
145 195
180=item on_sel_extend $term 230=item on_sel_extend $term
181 231
182Called 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
183click) and is either supposed to return false (normal operation), or 233click) and is either supposed to return false (normal operation), or
184should 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
185processing. 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.
186 238
187See the F<selection> example extension. 239See the F<selection> example extension.
188 240
189=item on_view_change $term, $offset 241=item on_view_change $term, $offset
190 242
199than the scroll back buffer or the terminal. 251than the scroll back buffer or the terminal.
200 252
201It 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,
202$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
203number of lines that will be in the scrollback buffer. 255number of lines that will be in the scrollback buffer.
204
205=item on_tty_activity $term *NYI*
206
207Called whenever the program(s) running in the urxvt window send output.
208 256
209=item on_osc_seq $term, $string 257=item on_osc_seq $term, $string
210 258
211Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 259Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212operating system command) is processed. Cursor position and other state 260operating system command) is processed. Cursor position and other state
225can 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
226and calling C<< $term->scr_add_lines >> yourself. Please note that this 274and calling C<< $term->scr_add_lines >> yourself. Please note that this
227might 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
228output. 276output.
229 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
230=item on_line_update $term, $row 283=item on_line_update $term, $row
231 284
232Called 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
233screen output (e.g. underline urls or other useless stuff). Only lines 286screen output (e.g. underline urls or other useless stuff). Only lines
234that are being shown will be filtered, and, due to performance reasons, 287that are being shown will be filtered, and, due to performance reasons,
266=item on_focus_out $term 319=item on_focus_out $term
267 320
268Called wheneever the window loses keyboard focus, before rxvt-unicode does 321Called wheneever the window loses keyboard focus, before rxvt-unicode does
269focus out processing. 322focus out processing.
270 323
271=item on_key_press $term, $event, $octets 324=item on_key_press $term, $event, $keysym, $octets
272 325
273=item on_key_release $term, $event 326=item on_key_release $term, $event, $keysym
274 327
275=item on_button_press $term, $event 328=item on_button_press $term, $event
276 329
277=item on_button_release $term, $event 330=item on_button_release $term, $event
278 331
294 347
295subwindow. 348subwindow.
296 349
297=back 350=back
298 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
299=head2 Variables in the C<urxvt> Package 373=head2 Variables in the C<urxvt> Package
300 374
301=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>.
302 389
303=item $urxvt::TERM 390=item $urxvt::TERM
304 391
305The current terminal. This variable stores the current C<urxvt::term> 392The current terminal. This variable stores the current C<urxvt::term>
306object, whenever a callback/hook is executing. 393object, whenever a callback/hook is executing.
308=back 395=back
309 396
310=head2 Functions in the C<urxvt> Package 397=head2 Functions in the C<urxvt> Package
311 398
312=over 4 399=over 4
313
314=item $term = new urxvt [arg...]
315
316Creates a new terminal, very similar as if you had started it with
317C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318if the new instance couldn't be created. Returns C<undef> if the new
319instance didn't initialise perl, and the terminal object otherwise. The
320C<init> and C<start> hooks will be called during the call.
321 400
322=item urxvt::fatal $errormessage 401=item urxvt::fatal $errormessage
323 402
324Fatally aborts execution with the given error message. Avoid at all 403Fatally aborts execution with the given error message. Avoid at all
325costs! The only time this is acceptable is when the terminal process 404costs! The only time this is acceptable is when the terminal process
332that calls this function. 411that calls this function.
333 412
334Using 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
335correct place, e.g. on stderr of the connecting urxvtc client. 414correct place, e.g. on stderr of the connecting urxvtc client.
336 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
337=item $time = urxvt::NOW 424=item $time = urxvt::NOW
338 425
339Returns the "current time" (as per the event loop). 426Returns the "current time" (as per the event loop).
340 427
341=item urxvt::CurrentTime 428=item urxvt::CurrentTime
342 429
343=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 430=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 431Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345Button4Mask, Button5Mask, AnyModifier 432Button4Mask, Button5Mask, AnyModifier
346 433
347Various constants for use in X events. 434Various constants for use in X calls and event processing.
348 435
349=back 436=back
350 437
351=head2 RENDITION 438=head2 RENDITION
352 439
379 466
380=item $background = urxvt::GET_BASEBG $rend 467=item $background = urxvt::GET_BASEBG $rend
381 468
382Return the foreground/background colour index, respectively. 469Return the foreground/background colour index, respectively.
383 470
384=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 471=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385 472
386=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 473=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387 474
388Replace the foreground/background colour in the rendition mask with the 475Replace the foreground/background colour in the rendition mask with the
389specified one. 476specified one.
390 477
391=item $value = urxvt::GET_CUSTOM ($rend) 478=item $value = urxvt::GET_CUSTOM $rend
392 479
393Return the "custom" value: Every rendition has 5 bits for use by 480Return the "custom" value: Every rendition has 5 bits for use by
394extensions. 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
395zero. 482zero.
396 483
397=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 484=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398 485
399Change the custom value. 486Change the custom value.
400 487
401=back 488=back
402 489
403=cut 490=cut
404
405package urxvt;
406
407use utf8;
408use strict;
409use Scalar::Util ();
410use List::Util ();
411
412our $TERM;
413our @HOOKNAME;
414our %OPTION;
415our $LIBDIR;
416 491
417BEGIN { 492BEGIN {
418 urxvt->bootstrap; 493 urxvt->bootstrap;
419 494
420 # overwrite perl's warn 495 # overwrite perl's warn
422 my $msg = join "", @_; 497 my $msg = join "", @_;
423 $msg .= "\n" 498 $msg .= "\n"
424 unless $msg =~ /\n$/; 499 unless $msg =~ /\n$/;
425 urxvt::warn ($msg); 500 urxvt::warn ($msg);
426 }; 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";
427} 508}
428 509
429my @hook_count; 510my @hook_count;
430my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 511my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
431 512
432sub verbose { 513sub verbose {
433 my ($level, $msg) = @_; 514 my ($level, $msg) = @_;
434 warn "$msg\n" if $level <= $verbosity; 515 warn "$msg\n" if $level <= $verbosity;
435} 516}
436 517
437# find on_xxx subs in the package and register them
438# as hooks
439sub register_package($) {
440 my ($pkg) = @_;
441
442 for my $htype (0.. $#HOOKNAME) {
443 my $name = $HOOKNAME[$htype];
444
445 my $ref = $pkg->can ("on_" . lc $name)
446 or next;
447
448 $TERM->{_hook}[$htype]{$pkg} = $ref;
449 $hook_count[$htype]++
450 or set_should_invoke $htype, 1;
451 }
452}
453
454my $extension_pkg = "extension0000"; 518my $extension_pkg = "extension0000";
455my %extension_pkg; 519my %extension_pkg;
456 520
457# load a single script into its own package, once only 521# load a single script into its own package, once only
458sub extension_package($) { 522sub extension_package($) {
464 verbose 3, "loading extension '$path' into package '$pkg'"; 528 verbose 3, "loading extension '$path' into package '$pkg'";
465 529
466 open my $fh, "<:raw", $path 530 open my $fh, "<:raw", $path
467 or die "$path: $!"; 531 or die "$path: $!";
468 532
533 my $source = untaint
469 my $source = "package $pkg; use strict; use utf8;\n" 534 "package $pkg; use strict; use utf8;\n"
470 . "use base urxvt::term::proxy::;\n" 535 . "use base urxvt::term::extension::;\n"
471 . "#line 1 \"$path\"\n{\n" 536 . "#line 1 \"$path\"\n{\n"
472 . (do { local $/; <$fh> }) 537 . (do { local $/; <$fh> })
473 . "\n};\n1"; 538 . "\n};\n1";
474 539
540 eval $source
475 eval $source or die "$path: $@"; 541 or die "$path: $@";
476 542
477 $pkg 543 $pkg
478 } 544 }
479} 545}
480 546
486 my $htype = shift; 552 my $htype = shift;
487 553
488 if ($htype == 0) { # INIT 554 if ($htype == 0) { # INIT
489 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 555 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
490 556
491 my %want_ext; 557 my %ext_arg;
492 558
493 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 559 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494 if ($_ eq "default") { 560 if ($_ eq "default") {
495 $want_ext{$_}++ for qw(selection option-popup); 561 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
496 } elsif (/^-(.*)$/) { 562 } elsif (/^-(.*)$/) {
497 delete $want_ext{$1}; 563 delete $ext_arg{$1};
564 } elsif (/^([^<]+)<(.*)>$/) {
565 push @{ $ext_arg{$1} }, $2;
498 } else { 566 } else {
499 $want_ext{$_}++; 567 $ext_arg{$_} ||= [];
500 } 568 }
501 } 569 }
502 570
503 for my $ext (keys %want_ext) { 571 while (my ($ext, $argv) = each %ext_arg) {
504 my @files = grep -f $_, map "$_/$ext", @dirs; 572 my @files = grep -f $_, map "$_/$ext", @dirs;
505 573
506 if (@files) { 574 if (@files) {
507 register_package extension_package $files[0]; 575 $TERM->register_package (extension_package $files[0], $argv);
508 } else { 576 } else {
509 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";
510 } 578 }
511 } 579 }
580
581 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
582 warn $@ if $@;
512 } 583 }
513 584
514 $retval = undef; 585 $retval = undef;
515 586
516 if (my $cb = $TERM->{_hook}[$htype]) { 587 if (my $cb = $TERM->{_hook}[$htype]) {
518 if $verbosity >= 10; 589 if $verbosity >= 10;
519 590
520 keys %$cb; 591 keys %$cb;
521 592
522 while (my ($pkg, $cb) = each %$cb) { 593 while (my ($pkg, $cb) = each %$cb) {
523 eval { 594 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
524 $retval = $cb->(
525 $TERM->{_pkg}{$pkg} ||= do {
526 my $proxy = bless { }, $pkg;
527 Scalar::Util::weaken ($proxy->{term} = $TERM);
528 $proxy
529 },
530 @_,
531 ) and last; 595 and last;
596
597 if ($@) {
598 $TERM->ungrab; # better to lose the grab than the session
599 warn $@;
532 }; 600 }
533 warn $@ if $@;#d#
534 } 601 }
602
603 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604 if $verbosity >= 11;
535 } 605 }
536 606
537 if ($htype == 1) { # DESTROY 607 if ($htype == 1) { # DESTROY
538 # remove hooks if unused
539 if (my $hook = $TERM->{_hook}) { 608 if (my $hook = delete $TERM->{_hook}) {
540 for my $htype (0..$#$hook) { 609 for my $htype (0..$#$hook) {
541 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 610 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
542 or set_should_invoke $htype, 0; 611 or set_should_invoke $htype, 0;
543 } 612 }
544 } 613 }
551 } 620 }
552 621
553 $retval 622 $retval
554} 623}
555 624
556sub urxvt::term::proxy::AUTOLOAD { 625sub exec_async(@) {
557 $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 =~ /:([^:]+)$/
558 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 679 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
559 680
560 eval qq{ 681 eval qq{
561 sub $urxvt::term::proxy::AUTOLOAD { 682 sub $AUTOLOAD {
562 my \$proxy = shift; 683 my \$proxy = shift;
563 \$proxy->{term}->$1 (\@_) 684 \$proxy->{term}->$1 (\@_)
564 } 685 }
565 1 686 1
566 } or die "FATAL: unable to compile method forwarder: $@"; 687 } or die "FATAL: unable to compile method forwarder: $@";
567 688
568 goto &$urxvt::term::proxy::AUTOLOAD; 689 goto &$AUTOLOAD;
569} 690}
691
692sub DESTROY {
693 # nop
694}
695
696# urxvt::destroy_hook
570 697
571sub urxvt::destroy_hook::DESTROY { 698sub urxvt::destroy_hook::DESTROY {
572 ${$_[0]}->(); 699 ${$_[0]}->();
573} 700}
574 701
575sub urxvt::destroy_hook(&) { 702sub urxvt::destroy_hook(&) {
576 bless \shift, urxvt::destroy_hook:: 703 bless \shift, urxvt::destroy_hook::
577} 704}
578 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
579=head2 The C<urxvt::term> Class 776=head2 The C<urxvt::term> Class
580 777
581=over 4 778=over 4
582 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
583=item $term->destroy 821=item $term->destroy
584 822
585Destroy 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.
586 826
587=item $isset = $term->option ($optval[, $set]) 827=item $isset = $term->option ($optval[, $set])
588 828
589Returns true if the option specified by C<$optval> is enabled, and 829Returns true if the option specified by C<$optval> is enabled, and
590optionally change it. All option values are stored by name in the hash 830optionally change it. All option values are stored by name in the hash
634 shade term_name title transparent transparent_all tripleclickwords 874 shade term_name title transparent transparent_all tripleclickwords
635 utmpInhibit visualBell 875 utmpInhibit visualBell
636 876
637=cut 877=cut
638 878
639sub urxvt::term::resource($$;$) { 879sub resource($$;$) {
640 my ($self, $name) = (shift, shift); 880 my ($self, $name) = (shift, shift);
641 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 881 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
642 &urxvt::term::_resource 882 &urxvt::term::_resource
643} 883}
644 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
645=item $rend = $term->rstyle ([$new_rstyle]) 901=item $rend = $term->rstyle ([$new_rstyle])
646 902
647Return and optionally change the current rendition. Text that is output by 903Return and optionally change the current rendition. Text that is output by
648the terminal application will use this style. 904the terminal application will use this style.
649 905
668 924
669=item $oldtext = $term->selection ([$newtext]) 925=item $oldtext = $term->selection ([$newtext])
670 926
671Return the current selection text and optionally replace it by C<$newtext>. 927Return the current selection text and optionally replace it by C<$newtext>.
672 928
673#=item $term->overlay ($x, $y, $text) 929=item $term->overlay_simple ($x, $y, $text)
674# 930
675#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.
676# 932
677#=cut 933=cut
678# 934
679#sub urxvt::term::scr_overlay { 935sub overlay_simple {
680# my ($self, $x, $y, $text) = @_; 936 my ($self, $x, $y, $text) = @_;
681# 937
682# my @lines = split /\n/, $text; 938 my @lines = split /\n/, $text;
683# 939
684# my $w = 0; 940 my $w = List::Util::max map $self->strwidth ($_), @lines;
685# for (map $self->strwidth ($_), @lines) { 941
686# $w = $_ if $w < $_;
687# }
688#
689# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 942 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
690# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 943 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
691#} 944
945 $overlay
946}
692 947
693=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 948=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
694 949
695Create a new (empty) overlay at the given position with the given 950Create a new (empty) overlay at the given position with the given
696width/height. C<$rstyle> defines the initial rendition style 951width/height. C<$rstyle> defines the initial rendition style
731C<$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,
732currently). 987currently).
733 988
734=cut 989=cut
735 990
736sub urxvt::term::popup { 991sub popup {
737 my ($self, $event) = @_; 992 my ($self, $event) = @_;
738 993
739 $self->grab ($event->{time}, 1) 994 $self->grab ($event->{time}, 1)
740 or return; 995 or return;
741 996
763 1018
764=item $string = $term->locale_decode ($octets) 1019=item $string = $term->locale_decode ($octets)
765 1020
766Convert the given locale-encoded octets into a perl string. 1021Convert the given locale-encoded octets into a perl string.
767 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
768=item $term->scr_add_lines ($string) 1040=item $term->scr_add_lines ($string)
769 1041
770Write 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
771running inside the terminal. It may not contain command sequences (escape 1043running inside the terminal. It may not contain command sequences (escape
772codes), 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
786 1058
787Write 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
788pass characters instead of octets, you should convert your strings first 1060pass characters instead of octets, you should convert your strings first
789to the locale-specific encoding using C<< $term->locale_encode >>. 1061to the locale-specific encoding using C<< $term->locale_encode >>.
790 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
791=item $windowid = $term->parent 1070=item $windowid = $term->parent
792 1071
793Return the window id of the toplevel window. 1072Return the window id of the toplevel window.
794 1073
795=item $windowid = $term->vt 1074=item $windowid = $term->vt
819=item $nrow_plus_saveLines = $term->total_rows 1098=item $nrow_plus_saveLines = $term->total_rows
820 1099
821=item $lines_in_scrollback = $term->nsaved 1100=item $lines_in_scrollback = $term->nsaved
822 1101
823Return 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}
824 1126
825=item $modifiermask = $term->ModLevel3Mask 1127=item $modifiermask = $term->ModLevel3Mask
826 1128
827=item $modifiermask = $term->ModMetaMask 1129=item $modifiermask = $term->ModMetaMask
828 1130
921Return 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.
922 1224
923=item $offset = $line->offset_of ($row, $col) 1225=item $offset = $line->offset_of ($row, $col)
924 1226
925Returns 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
926line. 1228line. Works for rows outside the line, too, and returns corresponding
1229offsets outside the string.
927 1230
928=item ($row, $col) = $line->coord_of ($offset) 1231=item ($row, $col) = $line->coord_of ($offset)
929 1232
930Translates a string offset into terminal coordinates again. 1233Translates a string offset into terminal coordinates again.
931 1234
932=back 1235=back
933 1236
934=cut 1237=cut
935 1238
936sub urxvt::term::line { 1239sub line {
937 my ($self, $row) = @_; 1240 my ($self, $row) = @_;
938 1241
939 my $maxrow = $self->nrow - 1; 1242 my $maxrow = $self->nrow - 1;
940 1243
941 my ($beg, $end) = ($row, $row); 1244 my ($beg, $end) = ($row, $row);
1005 $offset / $self->{ncol} + $self->{beg}, 1308 $offset / $self->{ncol} + $self->{beg},
1006 $offset % $self->{ncol} 1309 $offset % $self->{ncol}
1007 ) 1310 )
1008} 1311}
1009 1312
1010=item ($row, $col) = $line->coord_of ($offset)
1011=item $text = $term->special_encode $string 1313=item $text = $term->special_encode $string
1012 1314
1013Converts a perl string into the special encoding used by rxvt-unicode, 1315Converts a perl string into the special encoding used by rxvt-unicode,
1014where one character corresponds to one screen cell. See 1316where one character corresponds to one screen cell. See
1015C<< $term->ROW_t >> for details. 1317C<< $term->ROW_t >> for details.
1017=item $string = $term->special_decode $text 1319=item $string = $term->special_decode $text
1018 1320
1019Converts rxvt-unicodes text reprsentation into a perl string. See 1321Converts rxvt-unicodes text reprsentation into a perl string. See
1020C<< $term->ROW_t >> for details. 1322C<< $term->ROW_t >> for details.
1021 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
1022=back 1352=back
1023 1353
1354=cut
1355
1356package urxvt::popup;
1357
1024=head2 The C<urxvt::popup> Class 1358=head2 The C<urxvt::popup> Class
1025 1359
1026=over 4 1360=over 4
1027 1361
1028=cut 1362=cut
1029
1030package urxvt::popup;
1031 1363
1032sub add_item { 1364sub add_item {
1033 my ($self, $item) = @_; 1365 my ($self, $item) = @_;
1034 1366
1035 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; 1367 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1039 $item->{render} ||= sub { $_[0]{text} }; 1371 $item->{render} ||= sub { $_[0]{text} };
1040 1372
1041 push @{ $self->{item} }, $item; 1373 push @{ $self->{item} }, $item;
1042} 1374}
1043 1375
1044sub add_separator { 1376=item $popup->add_title ($title)
1045 my ($self, $sep) = @_;
1046 1377
1047 $sep ||= "═"; 1378Adds a non-clickable title to the popup.
1048 1379
1049 $self->add_item ({ 1380=cut
1050 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051 text => "",
1052 render => sub { $sep x $urxvt::TERM->ncol },
1053 activate => sub { },
1054 });
1055}
1056 1381
1057sub add_title { 1382sub add_title {
1058 my ($self, $title) = @_; 1383 my ($self, $title) = @_;
1059 1384
1060 $self->add_item ({ 1385 $self->add_item ({
1062 text => $title, 1387 text => $title,
1063 activate => sub { }, 1388 activate => sub { },
1064 }); 1389 });
1065} 1390}
1066 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
1417
1067sub add_button { 1418sub add_button {
1068 my ($self, $text, $cb) = @_; 1419 my ($self, $text, $cb) = @_;
1069 1420
1070 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1421 $self->add_item ({ type => "button", text => $text, activate => $cb});
1071} 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
1072 1431
1073sub add_toggle { 1432sub add_toggle {
1074 my ($self, $text, $cb, $value) = @_; 1433 my ($self, $text, $cb, $value) = @_;
1075 1434
1076 my $item; $item = { 1435 my $item; $item = {
1077 type => "button", 1436 type => "button",
1078 text => " $text", 1437 text => " $text",
1079 value => $value, 1438 value => $value,
1080 render => sub { ($item->{value} ? "* " : " ") . $text }, 1439 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1081 activate => sub { $cb->($item->{value} = !$item->{value}); }, 1440 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1082 }; 1441 };
1083 1442
1084 $self->add_item ($item); 1443 $self->add_item ($item);
1085} 1444}
1445
1446=item $popup->show
1447
1448Displays the popup (which is initially hidden).
1449
1450=cut
1086 1451
1087sub show { 1452sub show {
1088 my ($self) = @_; 1453 my ($self) = @_;
1089 1454
1090 local $urxvt::popup::self = $self; 1455 local $urxvt::popup::self = $self;
1091 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"),
1092 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,
1093 "--transient-for" => $self->{term}->parent, 1464 "--transient-for" => $self->{term}->parent,
1465 "-display" => $self->{term}->display_id,
1094 "-pe" => "urxvt-popup") 1466 "-pe" => "urxvt-popup")
1095 or die "unable to create popup window\n"; 1467 or die "unable to create popup window\n";
1096} 1468}
1097 1469
1098sub DESTROY { 1470sub DESTROY {
1099 my ($self) = @_; 1471 my ($self) = @_;
1100 1472
1473 delete $self->{term}{_destroy}{$self};
1101 $self->{term}->ungrab; 1474 $self->{term}->ungrab;
1102} 1475}
1476
1477=back
1103 1478
1104=head2 The C<urxvt::timer> Class 1479=head2 The C<urxvt::timer> Class
1105 1480
1106This class implements timer watchers/events. Time is represented as a 1481This class implements timer watchers/events. Time is represented as a
1107fractional number of seconds since the epoch. Example: 1482fractional number of seconds since the epoch. Example:
1160 1535
1161 $term->{socket} = ... 1536 $term->{socket} = ...
1162 $term->{iow} = urxvt::iow 1537 $term->{iow} = urxvt::iow
1163 ->new 1538 ->new
1164 ->fd (fileno $term->{socket}) 1539 ->fd (fileno $term->{socket})
1165 ->events (1) # wait for read data 1540 ->events (urxvt::EVENT_READ)
1166 ->start 1541 ->start
1167 ->cb (sub { 1542 ->cb (sub {
1168 my ($iow, $revents) = @_; 1543 my ($iow, $revents) = @_;
1169 # $revents must be 1 here, no need to check 1544 # $revents must be 1 here, no need to check
1170 sysread $term->{socket}, my $buf, 8192 1545 sysread $term->{socket}, my $buf, 8192
1187 1562
1188Set the filedescriptor (not handle) to watch. 1563Set the filedescriptor (not handle) to watch.
1189 1564
1190=item $iow = $iow->events ($eventmask) 1565=item $iow = $iow->events ($eventmask)
1191 1566
1192Set 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
1193data, 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>.
1194 1570
1195=item $iow = $iow->start 1571=item $iow = $iow->start
1196 1572
1197Start watching for requested events on the given handle. 1573Start watching for requested events on the given handle.
1198 1574
1209This variable controls the verbosity level of the perl extension. Higher 1585This variable controls the verbosity level of the perl extension. Higher
1210numbers indicate more verbose output. 1586numbers indicate more verbose output.
1211 1587
1212=over 4 1588=over 4
1213 1589
1214=item =0 - only fatal messages 1590=item == 0 - fatal messages
1215 1591
1216=item =3 - script loading and management 1592=item >= 3 - script loading and management
1217 1593
1218=item =10 - all events received 1594=item >=10 - all called hooks
1595
1596=item >=11 - hook reutrn values
1219 1597
1220=back 1598=back
1221 1599
1222=head1 AUTHOR 1600=head1 AUTHOR
1223 1601

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines