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.42 by root, Fri Jan 6 21:06:09 2006 UTC vs.
Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, scripts specified via the 22Everytime a terminal object gets created, extension scripts specified via
23C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
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
55Rot-13 the selection when activated. Used via keyboard trigger: 55Rot-13 the selection when activated. Used via keyboard trigger:
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
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.
60 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
77Displays a very simple digital clock in the upper right corner of the 99Displays a very simple digital clock in the upper right corner of the
78window. Illustrates overwriting the refresh callbacks to create your own 100window. Illustrates overwriting the refresh callbacks to create your own
79overlays or changes. 101overlays or changes.
80 102
81=back 103=back
104
105=head1 API DOCUMENTATION
82 106
83=head2 General API Considerations 107=head2 General API Considerations
84 108
85All objects (such as terminals, time watchers etc.) are typical 109All objects (such as terminals, time watchers etc.) are typical
86reference-to-hash objects. The hash can be used to store anything you 110reference-to-hash objects. The hash can be used to store anything you
114Either binary data or - more common - a text string encoded in a 138Either binary data or - more common - a text string encoded in a
115locale-specific way. 139locale-specific way.
116 140
117=back 141=back
118 142
143=head2 Extension Objects
144
145Very perl extension is a perl class. A separate perl object is created
146for each terminal and each extension and passed as the first parameter to
147hooks. So extensions can use their C<$self> object without having to think
148about other extensions, with the exception of methods and members that
149begin with an underscore character C<_>: these are reserved for internal
150use.
151
152Although it isn't a C<urxvt::term> object, you can call all methods of the
153C<urxvt::term> class on this object.
154
155It has the following methods and data members:
156
157=over 4
158
159=item $urxvt_term = $self->{term}
160
161Returns the C<urxvt::term> object associated with this instance of the
162extension. This member I<must not> be changed in any way.
163
164=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
165
166Dynamically enable the given hooks (named without the C<on_> prefix) for
167this extension, replacing any previous hook. This is useful when you want
168to overwrite time-critical hooks only temporarily.
169
170=item $self->disable ($hook_name[, $hook_name..])
171
172Dynamically disable the given hooks.
173
174=back
175
119=head2 Hooks 176=head2 Hooks
120 177
121The following subroutines can be declared in loaded scripts, and will be 178The following subroutines can be declared in extension files, and will be
122called whenever the relevant event happens. 179called whenever the relevant event happens.
123 180
124The first argument passed to them is an object private to each terminal 181The 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 182the 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.
129 183
130All of them must return a boolean value. If it is true, then the event 184B<All> of these hooks must return a boolean value. If it is true, then the
131counts as being I<consumed>, and the invocation of other hooks is skipped, 185event counts as being I<consumed>, and the invocation of other hooks is
132and the relevant action might not be carried out by the C++ code. 186skipped, and the relevant action might not be carried out by the C++ code.
133 187
134When in doubt, return a false value (preferably C<()>). 188I<< When in doubt, return a false value (preferably C<()>). >>
135 189
136=over 4 190=over 4
137 191
138=item on_init $term 192=item on_init $term
139 193
178should extend the selection itelf and return true to suppress the built-in 232should extend the selection itelf and return true to suppress the built-in
179processing. 233processing.
180 234
181See the F<selection> example extension. 235See the F<selection> example extension.
182 236
183=item on_focus_in $term
184
185Called whenever the window gets the keyboard focus, before urxvt does
186focus in processing.
187
188=item on_focus_out $term
189
190Called wheneever the window loses keyboard focus, before urxvt does focus
191out processing.
192
193=item on_view_change $term, $offset 237=item on_view_change $term, $offset
194 238
195Called whenever the view offset changes, i..e the user or program 239Called whenever the view offset changes, i..e the user or program
196scrolls. Offset C<0> means display the normal terminal, positive values 240scrolls. Offset C<0> means display the normal terminal, positive values
197show this many lines of scrollback. 241show this many lines of scrollback.
203than the scroll back buffer or the terminal. 247than the scroll back buffer or the terminal.
204 248
205It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 249It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
206$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 250$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
207number of lines that will be in the scrollback buffer. 251number of lines that will be in the scrollback buffer.
208
209=item on_tty_activity $term *NYI*
210
211Called whenever the program(s) running in the urxvt window send output.
212 252
213=item on_osc_seq $term, $string 253=item on_osc_seq $term, $string
214 254
215Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 255Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
216operating system command) is processed. Cursor position and other state 256operating system command) is processed. Cursor position and other state
229can filter/change and output the text yourself by returning a true value 269can filter/change and output the text yourself by returning a true value
230and calling C<< $term->scr_add_lines >> yourself. Please note that this 270and calling C<< $term->scr_add_lines >> yourself. Please note that this
231might be very slow, however, as your hook is called for B<all> text being 271might be very slow, however, as your hook is called for B<all> text being
232output. 272output.
233 273
274=item on_tt_write $term, $octets
275
276Called whenever some data is written to the tty/pty and can be used to
277suppress or filter tty input.
278
234=item on_line_update $term, $row 279=item on_line_update $term, $row
235 280
236Called whenever a line was updated or changed. Can be used to filter 281Called whenever a line was updated or changed. Can be used to filter
237screen output (e.g. underline urls or other useless stuff). Only lines 282screen output (e.g. underline urls or other useless stuff). Only lines
238that are being shown will be filtered, and, due to performance reasons, 283that are being shown will be filtered, and, due to performance reasons,
260 305
261Called whenever the user presses a key combination that has a 306Called whenever the user presses a key combination that has a
262C<perl:string> action bound to it (see description of the B<keysym> 307C<perl:string> action bound to it (see description of the B<keysym>
263resource in the @@RXVT_NAME@@(1) manpage). 308resource in the @@RXVT_NAME@@(1) manpage).
264 309
310=item on_focus_in $term
311
312Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing.
314
315=item on_focus_out $term
316
317Called wheneever the window loses keyboard focus, before rxvt-unicode does
318focus out processing.
319
265=item on_key_press $term, $event, $octets 320=item on_key_press $term, $event, $keysym, $octets
266 321
267=item on_key_release $term, $event 322=item on_key_release $term, $event, $keysym
268 323
269=item on_button_press $term, $event 324=item on_button_press $term, $event
270 325
271=item on_button_release $term, $event 326=item on_button_release $term, $event
272 327
273=item on_motion_notify $term, $event 328=item on_motion_notify $term, $event
329
330=item on_map_notify $term, $event
331
332=item on_unmap_notify $term, $event
274 333
275Called whenever the corresponding X event is received for the terminal If 334Called whenever the corresponding X event is received for the terminal If
276the hook returns true, then the even will be ignored by rxvt-unicode. 335the hook returns true, then the even will be ignored by rxvt-unicode.
277 336
278The event is a hash with most values as named by Xlib (see the XEvent 337The event is a hash with most values as named by Xlib (see the XEvent
284 343
285subwindow. 344subwindow.
286 345
287=back 346=back
288 347
348=cut
349
350package urxvt;
351
352use utf8;
353use strict;
354use Carp ();
355use Scalar::Util ();
356use List::Util ();
357
358our $VERSION = 1;
359our $TERM;
360our @HOOKNAME;
361our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362our %OPTION;
363
364our $LIBDIR;
365our $RESNAME;
366our $RESCLASS;
367our $RXVTNAME;
368
289=head2 Variables in the C<urxvt> Package 369=head2 Variables in the C<urxvt> Package
290 370
291=over 4 371=over 4
292 372
373=item $urxvt::LIBDIR
374
375The rxvt-unicode library directory, where, among other things, the perl
376modules and scripts are stored.
377
378=item $urxvt::RESCLASS, $urxvt::RESCLASS
379
380The resource class and name rxvt-unicode uses to look up X resources.
381
382=item $urxvt::RXVTNAME
383
384The basename of the installed binaries, usually C<urxvt>.
385
293=item $urxvt::TERM 386=item $urxvt::TERM
294 387
295The current terminal. Whenever a callback/Hook is bein executed, this 388The current terminal. This variable stores the current C<urxvt::term>
296variable stores the current C<urxvt::term> object. 389object, whenever a callback/hook is executing.
390
391=item
297 392
298=back 393=back
299 394
300=head2 Functions in the C<urxvt> Package 395=head2 Functions in the C<urxvt> Package
301 396
302=over 4 397=over 4
303
304=item $term = new urxvt [arg...]
305
306Creates a new terminal, very similar as if you had started it with
307C<system $binfile, arg...>. Croaks (and probably outputs an error message)
308if the new instance couldn't be created. Returns C<undef> if the new
309instance didn't initialise perl, and the terminal object otherwise. The
310C<init> and C<start> hooks will be called during the call.
311 398
312=item urxvt::fatal $errormessage 399=item urxvt::fatal $errormessage
313 400
314Fatally aborts execution with the given error message. Avoid at all 401Fatally aborts execution with the given error message. Avoid at all
315costs! The only time this is acceptable is when the terminal process 402costs! The only time this is acceptable is when the terminal process
322that calls this function. 409that calls this function.
323 410
324Using 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
325correct place, e.g. on stderr of the connecting urxvtc client. 412correct place, e.g. on stderr of the connecting urxvtc client.
326 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
327=item $time = urxvt::NOW 422=item $time = urxvt::NOW
328 423
329Returns the "current time" (as per the event loop). 424Returns the "current time" (as per the event loop).
425
426=item urxvt::CurrentTime
427
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier
431
432Various constants for use in X calls and event processing.
330 433
331=back 434=back
332 435
333=head2 RENDITION 436=head2 RENDITION
334 437
361 464
362=item $background = urxvt::GET_BASEBG $rend 465=item $background = urxvt::GET_BASEBG $rend
363 466
364Return the foreground/background colour index, respectively. 467Return the foreground/background colour index, respectively.
365 468
366=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 469=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
367 470
368=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 471=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
369 472
370Replace the foreground/background colour in the rendition mask with the 473Replace the foreground/background colour in the rendition mask with the
371specified one. 474specified one.
372 475
373=item $value = urxvt::GET_CUSTOM ($rend) 476=item $value = urxvt::GET_CUSTOM $rend
374 477
375Return the "custom" value: Every rendition has 5 bits for use by 478Return the "custom" value: Every rendition has 5 bits for use by
376extensions. 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
377zero. 480zero.
378 481
379=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 482=item $rend = urxvt::SET_CUSTOM $rend, $new_value
380 483
381Change the custom value. 484Change the custom value.
382 485
383=back 486=back
384 487
385=cut 488=cut
386
387package urxvt;
388
389use strict;
390use Scalar::Util ();
391
392our $TERM;
393our @HOOKNAME;
394our $LIBDIR;
395 489
396BEGIN { 490BEGIN {
397 urxvt->bootstrap; 491 urxvt->bootstrap;
398 492
399 # overwrite perl's warn 493 # overwrite perl's warn
401 my $msg = join "", @_; 495 my $msg = join "", @_;
402 $msg .= "\n" 496 $msg .= "\n"
403 unless $msg =~ /\n$/; 497 unless $msg =~ /\n$/;
404 urxvt::warn ($msg); 498 urxvt::warn ($msg);
405 }; 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";
406} 505}
407 506
408my @hook_count; 507my @hook_count;
409my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 508my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
410 509
411sub verbose { 510sub verbose {
412 my ($level, $msg) = @_; 511 my ($level, $msg) = @_;
413 warn "$msg\n" if $level <= $verbosity; 512 warn "$msg\n" if $level <= $verbosity;
414} 513}
415 514
416# find on_xxx subs in the package and register them 515my $extension_pkg = "extension0000";
417# as hooks 516my %extension_pkg;
418sub register_package($) {
419 my ($pkg) = @_;
420
421 for my $htype (0.. $#HOOKNAME) {
422 my $name = $HOOKNAME[$htype];
423
424 my $ref = $pkg->can ("on_" . lc $name)
425 or next;
426
427 $TERM->{_hook}[$htype]{$pkg} = $ref;
428 $hook_count[$htype]++
429 or set_should_invoke $htype, 1;
430 }
431}
432
433my $script_pkg = "script0000";
434my %script_pkg;
435 517
436# load a single script into its own package, once only 518# load a single script into its own package, once only
437sub script_package($) { 519sub extension_package($) {
438 my ($path) = @_; 520 my ($path) = @_;
439 521
440 $script_pkg{$path} ||= do { 522 $extension_pkg{$path} ||= do {
441 my $pkg = "urxvt::" . ($script_pkg++); 523 my $pkg = "urxvt::" . ($extension_pkg++);
442 524
443 verbose 3, "loading script '$path' into package '$pkg'"; 525 verbose 3, "loading extension '$path' into package '$pkg'";
444 526
445 open my $fh, "<:raw", $path 527 open my $fh, "<:raw", $path
446 or die "$path: $!"; 528 or die "$path: $!";
447 529
530 my $source = untaint
448 my $source = "package $pkg; use strict; use utf8;\n" 531 "package $pkg; use strict; use utf8;\n"
532 . "use base urxvt::term::extension::;\n"
449 . "#line 1 \"$path\"\n{\n" 533 . "#line 1 \"$path\"\n{\n"
450 . (do { local $/; <$fh> }) 534 . (do { local $/; <$fh> })
451 . "\n};\n1"; 535 . "\n};\n1";
452 536
537 eval $source
453 eval $source or die "$path: $@"; 538 or die "$path: $@";
454 539
455 $pkg 540 $pkg
456 } 541 }
457} 542}
458 543
463 local $TERM = shift; 548 local $TERM = shift;
464 my $htype = shift; 549 my $htype = shift;
465 550
466 if ($htype == 0) { # INIT 551 if ($htype == 0) { # INIT
467 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 552 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
553
554 my %ext_arg;
468 555
469 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) {
470 my @files = grep -f $_, map "$_/$ext", @dirs; 569 my @files = grep -f $_, map "$_/$ext", @dirs;
471 570
472 if (@files) { 571 if (@files) {
473 register_package script_package $files[0]; 572 $TERM->register_package (extension_package $files[0], $argv);
474 } else { 573 } else {
475 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";
476 } 575 }
477 } 576 }
577
578 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
579 warn $@ if $@;
478 } 580 }
479 581
480 $retval = undef; 582 $retval = undef;
481 583
482 if (my $cb = $TERM->{_hook}[$htype]) { 584 if (my $cb = $TERM->{_hook}[$htype]) {
484 if $verbosity >= 10; 586 if $verbosity >= 10;
485 587
486 keys %$cb; 588 keys %$cb;
487 589
488 while (my ($pkg, $cb) = each %$cb) { 590 while (my ($pkg, $cb) = each %$cb) {
489 $retval = $cb->( 591 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
490 $TERM->{_pkg}{$pkg} ||= do {
491 my $proxy = bless { }, urxvt::term::proxy::;
492 Scalar::Util::weaken ($proxy->{term} = $TERM);
493 $proxy
494 },
495 @_,
496 ) and last; 592 and last;
593
594 if ($@) {
595 $TERM->ungrab; # better to lose the grab than the session
596 warn $@;
597 }
497 } 598 }
498 } 599 }
499 600
500 if ($htype == 1) { # DESTROY 601 if ($htype == 1) { # DESTROY
501 # remove hooks if unused
502 if (my $hook = $TERM->{_hook}) { 602 if (my $hook = delete $TERM->{_hook}) {
503 for my $htype (0..$#$hook) { 603 for my $htype (0..$#$hook) {
504 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 604 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
505 or set_should_invoke $htype, 0; 605 or set_should_invoke $htype, 0;
506 } 606 }
507 } 607 }
514 } 614 }
515 615
516 $retval 616 $retval
517} 617}
518 618
519sub urxvt::term::proxy::AUTOLOAD { 619# urxvt::term::extension
520 $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 =~ /:([^:]+)$/
521 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 661 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
522 662
523 eval qq{ 663 eval qq{
524 sub $urxvt::term::proxy::AUTOLOAD { 664 sub $AUTOLOAD {
525 my \$proxy = shift; 665 my \$proxy = shift;
526 \$proxy->{term}->$1 (\@_) 666 \$proxy->{term}->$1 (\@_)
527 } 667 }
528 1 668 1
529 } or die "FATAL: unable to compile method forwarder: $@"; 669 } or die "FATAL: unable to compile method forwarder: $@";
530 670
531 goto &$urxvt::term::proxy::AUTOLOAD; 671 goto &$AUTOLOAD;
532} 672}
673
674sub DESTROY {
675 # nop
676}
677
678# urxvt::destroy_hook
679
680sub urxvt::destroy_hook::DESTROY {
681 ${$_[0]}->();
682}
683
684sub urxvt::destroy_hook(&) {
685 bless \shift, urxvt::destroy_hook::
686}
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;
533 757
534=head2 The C<urxvt::term> Class 758=head2 The C<urxvt::term> Class
535 759
536=over 4 760=over 4
537 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 %ENV>-like
788C<hash 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
538=item $term->destroy 803=item $term->destroy
539 804
540Destroy 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
541 824
542=item $value = $term->resource ($name[, $newval]) 825=item $value = $term->resource ($name[, $newval])
543 826
544Returns the current resource value associated with a given name and 827Returns the current resource value associated with a given name and
545optionally 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>
555 838
556Please note that resource strings will currently only be freed when the 839Please note that resource strings will currently only be freed when the
557terminal is destroyed, so changing options frequently will eat memory. 840terminal is destroyed, so changing options frequently will eat memory.
558 841
559Here 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
560are 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>
561list: 844to see the actual list:
562 845
563 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 846 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
564 borderLess color cursorBlink cursorUnderline cutchars delete_key 847 borderLess color cursorBlink cursorUnderline cutchars delete_key
565 display_name embed ext_bwidth fade font geometry hold iconName 848 display_name embed ext_bwidth fade font geometry hold iconName
566 imFont imLocale inputMethod insecure int_bwidth intensityStyles 849 imFont imLocale inputMethod insecure int_bwidth intensityStyles
573 shade term_name title transparent transparent_all tripleclickwords 856 shade term_name title transparent transparent_all tripleclickwords
574 utmpInhibit visualBell 857 utmpInhibit visualBell
575 858
576=cut 859=cut
577 860
578sub urxvt::term::resource($$;$) { 861sub resource($$;$) {
579 my ($self, $name) = (shift, shift); 862 my ($self, $name) = (shift, shift);
580 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 863 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
581 goto &urxvt::term::_resource; 864 &urxvt::term::_resource
582} 865}
866
867=item $success = $term->parse_keysym ($keysym_spec, $command_string)
868
869Adds a keymap translation exactly as specified via a resource. See the
870C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
583 871
584=item $rend = $term->rstyle ([$new_rstyle]) 872=item $rend = $term->rstyle ([$new_rstyle])
585 873
586Return and optionally change the current rendition. Text that is output by 874Return and optionally change the current rendition. Text that is output by
587the terminal application will use this style. 875the terminal application will use this style.
607 895
608=item $oldtext = $term->selection ([$newtext]) 896=item $oldtext = $term->selection ([$newtext])
609 897
610Return the current selection text and optionally replace it by C<$newtext>. 898Return the current selection text and optionally replace it by C<$newtext>.
611 899
612#=item $term->overlay ($x, $y, $text) 900=item $term->overlay_simple ($x, $y, $text)
613# 901
614#Create a simple multi-line overlay box. See the next method for details. 902Create a simple multi-line overlay box. See the next method for details.
615# 903
616#=cut 904=cut
617# 905
618#sub urxvt::term::scr_overlay { 906sub overlay_simple {
619# my ($self, $x, $y, $text) = @_; 907 my ($self, $x, $y, $text) = @_;
620# 908
621# my @lines = split /\n/, $text; 909 my @lines = split /\n/, $text;
622# 910
623# my $w = 0; 911 my $w = List::Util::max map $self->strwidth ($_), @lines;
624# for (map $self->strwidth ($_), @lines) { 912
625# $w = $_ if $w < $_;
626# }
627#
628# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 913 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
629# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 914 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
630#} 915
916 $overlay
917}
631 918
632=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 919=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
633 920
634Create a new (empty) overlay at the given position with the given 921Create a new (empty) overlay at the given position with the given
635width/height. C<$rstyle> defines the initial rendition style 922width/height. C<$rstyle> defines the initial rendition style
662 949
663If hidden, display the overlay again. 950If hidden, display the overlay again.
664 951
665=back 952=back
666 953
954=item $popup = $term->popup ($event)
955
956Creates a new C<urxvt::popup> object that implements a popup menu. The
957C<$event> I<must> be the event causing the menu to pop up (a button event,
958currently).
959
960=cut
961
962sub popup {
963 my ($self, $event) = @_;
964
965 $self->grab ($event->{time}, 1)
966 or return;
967
968 my $popup = bless {
969 term => $self,
970 event => $event,
971 }, urxvt::popup::;
972
973 Scalar::Util::weaken $popup->{term};
974
975 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
976 Scalar::Util::weaken $self->{_destroy}{$popup};
977
978 $popup
979}
980
667=item $cellwidth = $term->strwidth ($string) 981=item $cellwidth = $term->strwidth ($string)
668 982
669Returns the number of screen-cells this string would need. Correctly 983Returns the number of screen-cells this string would need. Correctly
670accounts for wide and combining characters. 984accounts for wide and combining characters.
671 985
674Convert the given text string into the corresponding locale encoding. 988Convert the given text string into the corresponding locale encoding.
675 989
676=item $string = $term->locale_decode ($octets) 990=item $string = $term->locale_decode ($octets)
677 991
678Convert the given locale-encoded octets into a perl string. 992Convert the given locale-encoded octets into a perl string.
993
994=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
995
996XORs the rendition values in the given span with the provided value
997(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
998to the selection.
999
1000=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1001
1002Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1003whitespace will additionally be xored with the C<$rstyle2>, which defaults
1004to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1005it instead.
1006
1007=item $term->scr_bell
1008
1009Ring the bell!
679 1010
680=item $term->scr_add_lines ($string) 1011=item $term->scr_add_lines ($string)
681 1012
682Write the given text string to the screen, as if output by the application 1013Write the given text string to the screen, as if output by the application
683running inside the terminal. It may not contain command sequences (escape 1014running inside the terminal. It may not contain command sequences (escape
698 1029
699Write the octets given in C<$data> to the tty (i.e. as program input). To 1030Write the octets given in C<$data> to the tty (i.e. as program input). To
700pass characters instead of octets, you should convert your strings first 1031pass characters instead of octets, you should convert your strings first
701to the locale-specific encoding using C<< $term->locale_encode >>. 1032to the locale-specific encoding using C<< $term->locale_encode >>.
702 1033
1034=item $old_events = $term->pty_ev_events ([$new_events])
1035
1036Replaces the event mask of the pty watcher by the given event mask. Can
1037be used to suppress input and output handling to the pty/tty. See the
1038description of C<< urxvt::timer->events >>. Make sure to always restore
1039the previous value.
1040
703=item $windowid = $term->parent 1041=item $windowid = $term->parent
704 1042
705Return the window id of the toplevel window. 1043Return the window id of the toplevel window.
706 1044
707=item $windowid = $term->vt 1045=item $windowid = $term->vt
731=item $nrow_plus_saveLines = $term->total_rows 1069=item $nrow_plus_saveLines = $term->total_rows
732 1070
733=item $lines_in_scrollback = $term->nsaved 1071=item $lines_in_scrollback = $term->nsaved
734 1072
735Return various integers describing terminal characteristics. 1073Return various integers describing terminal characteristics.
1074
1075=item $x_display = $term->display_id
1076
1077Return the DISPLAY used by rxvt-unicode.
1078
1079=item $lc_ctype = $term->locale
1080
1081Returns the LC_CTYPE category string used by this rxvt-unicode.
1082
1083=item $env = $term->env
1084
1085Returns a copy of the environment in effect for the terminal as a hashref
1086similar to C<\%ENV>.
1087
1088=cut
1089
1090sub env {
1091 if (my $env = $_[0]->_env) {
1092 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1093 } else {
1094 +{ %ENV }
1095 }
1096}
1097
1098=item $modifiermask = $term->ModLevel3Mask
1099
1100=item $modifiermask = $term->ModMetaMask
1101
1102=item $modifiermask = $term->ModNumLockMask
1103
1104Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1105AltGr), the meta key (often Alt) and the num lock key, if applicable.
736 1106
737=item $view_start = $term->view_start ([$newvalue]) 1107=item $view_start = $term->view_start ([$newvalue])
738 1108
739Returns the negative row number of the topmost line. Minimum value is 1109Returns the negative row number of the topmost line. Minimum value is
740C<0>, which displays the normal terminal contents. Larger values scroll 1110C<0>, which displays the normal terminal contents. Larger values scroll
834 1204
835=back 1205=back
836 1206
837=cut 1207=cut
838 1208
839sub urxvt::term::line { 1209sub line {
840 my ($self, $row) = @_; 1210 my ($self, $row) = @_;
841 1211
842 my $maxrow = $self->nrow - 1; 1212 my $maxrow = $self->nrow - 1;
843 1213
844 my ($beg, $end) = ($row, $row); 1214 my ($beg, $end) = ($row, $row);
908 $offset / $self->{ncol} + $self->{beg}, 1278 $offset / $self->{ncol} + $self->{beg},
909 $offset % $self->{ncol} 1279 $offset % $self->{ncol}
910 ) 1280 )
911} 1281}
912 1282
913=item ($row, $col) = $line->coord_of ($offset)
914=item $text = $term->special_encode $string 1283=item $text = $term->special_encode $string
915 1284
916Converts a perl string into the special encoding used by rxvt-unicode, 1285Converts a perl string into the special encoding used by rxvt-unicode,
917where one character corresponds to one screen cell. See 1286where one character corresponds to one screen cell. See
918C<< $term->ROW_t >> for details. 1287C<< $term->ROW_t >> for details.
920=item $string = $term->special_decode $text 1289=item $string = $term->special_decode $text
921 1290
922Converts rxvt-unicodes text reprsentation into a perl string. See 1291Converts rxvt-unicodes text reprsentation into a perl string. See
923C<< $term->ROW_t >> for details. 1292C<< $term->ROW_t >> for details.
924 1293
1294=item $success = $term->grab_button ($button, $modifiermask)
1295
1296Registers a synchronous button grab. See the XGrabButton manpage.
1297
1298=item $success = $term->grab ($eventtime[, $sync])
1299
1300Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1301synchronous (C<$sync> is true). Also remembers the grab timestampe.
1302
1303=item $term->allow_events_async
1304
1305Calls XAllowEvents with AsyncBoth for the most recent grab.
1306
1307=item $term->allow_events_sync
1308
1309Calls XAllowEvents with SyncBoth for the most recent grab.
1310
1311=item $term->allow_events_replay
1312
1313Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1314recent grab.
1315
1316=item $term->ungrab
1317
1318Calls XUngrab for the most recent grab. Is called automatically on
1319evaluation errors, as it is better to lose the grab in the error case as
1320the session.
1321
925=back 1322=back
1323
1324=cut
1325
1326package urxvt::popup;
1327
1328=head2 The C<urxvt::popup> Class
1329
1330=over 4
1331
1332=cut
1333
1334sub add_item {
1335 my ($self, $item) = @_;
1336
1337 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1338 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1339 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1340
1341 $item->{render} ||= sub { $_[0]{text} };
1342
1343 push @{ $self->{item} }, $item;
1344}
1345
1346=item $popup->add_title ($title)
1347
1348Adds a non-clickable title to the popup.
1349
1350=cut
1351
1352sub add_title {
1353 my ($self, $title) = @_;
1354
1355 $self->add_item ({
1356 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1357 text => $title,
1358 activate => sub { },
1359 });
1360}
1361
1362=item $popup->add_separator ([$sepchr])
1363
1364Creates a separator, optionally using the character given as C<$sepchr>.
1365
1366=cut
1367
1368sub add_separator {
1369 my ($self, $sep) = @_;
1370
1371 $sep ||= "=";
1372
1373 $self->add_item ({
1374 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1375 text => "",
1376 render => sub { $sep x $self->{term}->ncol },
1377 activate => sub { },
1378 });
1379}
1380
1381=item $popup->add_button ($text, $cb)
1382
1383Adds a clickable button to the popup. C<$cb> is called whenever it is
1384selected.
1385
1386=cut
1387
1388sub add_button {
1389 my ($self, $text, $cb) = @_;
1390
1391 $self->add_item ({ type => "button", text => $text, activate => $cb});
1392}
1393
1394=item $popup->add_toggle ($text, $cb, $initial_value)
1395
1396Adds a toggle/checkbox item to the popup. Teh callback gets called
1397whenever it gets toggled, with a boolean indicating its value as its first
1398argument.
1399
1400=cut
1401
1402sub add_toggle {
1403 my ($self, $text, $cb, $value) = @_;
1404
1405 my $item; $item = {
1406 type => "button",
1407 text => " $text",
1408 value => $value,
1409 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1410 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1411 };
1412
1413 $self->add_item ($item);
1414}
1415
1416=item $popup->show
1417
1418Displays the popup (which is initially hidden).
1419
1420=cut
1421
1422sub show {
1423 my ($self) = @_;
1424
1425 local $urxvt::popup::self = $self;
1426
1427 my $env = $self->{term}->env;
1428 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1429 delete $env->{LC_ALL};
1430 $env->{LC_CTYPE} = $self->{term}->locale;
1431
1432 urxvt::term->new ($env, $self->{term}->resource ("name"),
1433 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1434 "--transient-for" => $self->{term}->parent,
1435 "-display" => $self->{term}->display_id,
1436 "-pe" => "urxvt-popup")
1437 or die "unable to create popup window\n";
1438}
1439
1440sub DESTROY {
1441 my ($self) = @_;
1442
1443 delete $self->{term}{_destroy}{$self};
1444 $self->{term}->ungrab;
1445}
926 1446
927=head2 The C<urxvt::timer> Class 1447=head2 The C<urxvt::timer> Class
928 1448
929This class implements timer watchers/events. Time is represented as a 1449This class implements timer watchers/events. Time is represented as a
930fractional number of seconds since the epoch. Example: 1450fractional number of seconds since the epoch. Example:
983 1503
984 $term->{socket} = ... 1504 $term->{socket} = ...
985 $term->{iow} = urxvt::iow 1505 $term->{iow} = urxvt::iow
986 ->new 1506 ->new
987 ->fd (fileno $term->{socket}) 1507 ->fd (fileno $term->{socket})
988 ->events (1) # wait for read data 1508 ->events (urxvt::EVENT_READ)
989 ->start 1509 ->start
990 ->cb (sub { 1510 ->cb (sub {
991 my ($iow, $revents) = @_; 1511 my ($iow, $revents) = @_;
992 # $revents must be 1 here, no need to check 1512 # $revents must be 1 here, no need to check
993 sysread $term->{socket}, my $buf, 8192 1513 sysread $term->{socket}, my $buf, 8192
1010 1530
1011Set the filedescriptor (not handle) to watch. 1531Set the filedescriptor (not handle) to watch.
1012 1532
1013=item $iow = $iow->events ($eventmask) 1533=item $iow = $iow->events ($eventmask)
1014 1534
1015Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1535Set the event mask to watch. The only allowed values are
1016data, Bit #1 (value C<2>) enables watching for write data. 1536C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1537together, or C<urxvt::EVENT_NONE>.
1017 1538
1018=item $iow = $iow->start 1539=item $iow = $iow->start
1019 1540
1020Start watching for requested events on the given handle. 1541Start watching for requested events on the given handle.
1021 1542
1032This variable controls the verbosity level of the perl extension. Higher 1553This variable controls the verbosity level of the perl extension. Higher
1033numbers indicate more verbose output. 1554numbers indicate more verbose output.
1034 1555
1035=over 4 1556=over 4
1036 1557
1037=item =0 - only fatal messages 1558=item == 0 - fatal messages
1038 1559
1039=item =3 - script loading and management 1560=item >= 3 - script loading and management
1040 1561
1041=item =10 - all events received 1562=item >=10 - all events received
1042 1563
1043=back 1564=back
1044 1565
1045=head1 AUTHOR 1566=head1 AUTHOR
1046 1567

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines